New-RASSession

NAME

New-RASSession

SYNOPSIS

Creates a connection with a Parallels RAS farm.

SYNTAX

New-RASSession [-Username] <string> [-Password] <SecureString> [[-Server] <string>] [-Force <SwitchParameter>] [-Retries <uint>] [<CommonParameters>]

New-RASSession [<CommonParameters>]

DESCRIPTION

Connects to a Parallels RAS farm and creates a new RAS session.

A connection with Parallels RAS must be established before you can execute any other commands.

PARAMETERS


-Username <string>
Parallels RAS administrator username. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Password <SecureString>
Parallels RAS administrator password. 

        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Server <string>
FQDN or IP address of the server where your have Parallels RAS installed. 

        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Retries <uint>
Number of reconnections to do if the first one fails. Default is 0. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Force <SwitchParameter>
Force connection with specified server (or with local host if server not specified). 

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

RASSession

EXAMPLES


---------- EXAMPLE 1 ----------

New-RASSession "username"

Creates a new RAS session with the Parallels RAS farm deployed on the local server.

When you execute the command, you will get a prompt to enter a password.

---------- EXAMPLE 2 ----------

New-RASSession -Username "administrator@domain.dom" -Password $SecretPassword -Server "192.168.10.200"

Connects to the specified server using specified credentials and creates a new RAS session.

The -Username value must be specified using the UPN format.

The $SecretPassword variable must contain a valid password as SecureString.

---------- EXAMPLE 3 ----------

New-RASSession -Username "administrator@domain.dom" -Password $SecretPassword -Server "192.168.10.200" -Retries 3

Connects to the specified server using specified credentials and creates a new RAS session.

The -Retires value specifies how many retries to do, in case connection is not established the first time.

The -Username value must be specified using the UPN format.

The $SecretPassword variable must contain a valid password as SecureString.

RELATED LINKS