New-VDIGuest

NAME

New-VDIGuest

SYNOPSIS

Installs the RAS Guest Agent in a VM, which makes it ready to host published resources in Parallels RAS.

SYNTAX

New-VDIGuest [-VDIHostId] <uint> [-Id] <string> [-ComputerName <string>] [-NoInstall <SwitchParameter>] [<CommonParameters>]

New-VDIGuest [-VDIHostId] <uint> [-Id] <string> -Password <SecureString> -Username <string> [-ComputerName <string>] [<CommonParameters>]

New-VDIGuest [-InputObject] <VM> [-ComputerName <string>] [-NoInstall <SwitchParameter>] [<CommonParameters>]

New-VDIGuest [-InputObject] <VM> -Password <SecureString> -Username <string> [-ComputerName <string>] [<CommonParameters>]

DESCRIPTION

Installs the RAS Guest Agent in a VM, which makes it ready to host published resources in Parallels RAS.

PARAMETERS


-VDIHostId <uint>
The ID of the VDI Host server on which the target VM resides.

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

-Id <string>
The ID of the target VM.

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

-ComputerName <string>
The FQDN or IP address of the target VM.

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

-InputObject <VM>
On object of type VM representing the target VM.

To obtain the object, use the Get-VM cmdlet.

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

-NoInstall <SwitchParameter>
Specifies NOT to install the RAS Guest Agent on the server.

If this parameter is omitted, the agent will be push installed in the VM using your RAS admin credentials.

To specify different credentials for push installation, use the Username and Password parameters.

This parameter can be used in situations when the RAS Guest Agent is already installed in a VM, but the VM is powered down.

By including this parameter, you will simply power up the VM and make it available for Parallels RAS operations.

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

-Username <string>
An administrator account for push installing the RAS Guest Agent in the VM.

If this parameter is omitted, your RAS admin username (and password) will be used.

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

-Password <SecureString>
The password of the account specified in the Username parameter.

        Required?                    true
        Position?                    named
        Default value                
        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

VM

OUTPUTS

VDIGuest

EXAMPLES


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

New-VDIGuest -VDIHostId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0

Installs the RAS Guest Agent in a VM specified by the VDI Host ID and the VM ID.

The RAS Guest Agent will be installed on the server using your RAS admin credentials (default).

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

New-VDIGuest $VM

Installs the RAS Guest Agent in a VM specified by the $VM variable, which is an object of type VM.

The object is obtained using the Get-VM cmdlet.

The RAS Guest Agent will be installed on the server using your RAS admin credentials (default).

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

Get-VM -VDIHostId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0 | New-VDIGuest -NoInstall

Install the RAS Guest Agent in a VM represented by a VM object obtained from the pipeline output.

The RAS Guest Agent will NOT be installed on the server.

You can skip the agent installation if it's already installed on the server.

RELATED LINKS