New-VDIHost

NAME

New-VDIHost

SYNOPSIS

Adds a VDI Host server to a site.

SYNTAX

New-VDIHost [-Server] <string> [[-SiteId] <uint>] [-VDIType] <HypervisorType> {HyperVUnknown | HyperVWin2008Std | HyperVWin2008Ent | HyperVWin2008Dtc | HyperV | HyperVWin2012Std | HyperVWin2012Dtc | HyperVWin2012Srv | HyperVWin2008R2Std | HyperVWin2008R2Ent | HyperVWin2008R2Dtc | HyperVWin2012R2Std | HyperVWin2012R2Dtc | HyperVWin2012R2Srv | HyperVWin2016Std | HyperVWin2016Dtc | HyperVWin2016Srv | HyperVFailoverClusterUnknown | HyperVFailoverClusterEnt | HyperVFailoverClusterDtc | HyperVFailoverClusterWin2012 | HyperVFailoverClusterWin2012R2 | VmwareESXUnknown | VmwareESXi4_0 | VmwareESX4_0 | VmwareESXi4_1 | VmwareESX4_1 | VmwareESXi5_0 | VmwareESXi5_1 | VmwareESXi5_5 | VmwareESXi6_0 | VmwareESXi6_5 | VmwareESXi6_7 | VmwareVCenterUnknown | VmwareVCenter4_0 | VmwareVCenter4_1 | VmwareVCenter5_0 | VmwareVCenter5_1 | VmwareVCenter5_5 | VmwareVCenter6_0 | VmwareVCenter6_5 | VmwareVCenter6_7 | CitrixXenUnknown | CitrixXen5_0 | CitrixXen5_5 | CitrixXen5_6 | CitrixXen5_6_1 | CitrixXen6_0 | CitrixXen6_1 | CitrixXen6_2 | CitrixXen6_5 | CitrixXen7_0 | QemuKvmUnknown | QemuKvm1_2_14 | NutanixUnknown | Nutanix5_0} -VDIPassword <SecureString> -VDIUsername <string> [-NoInstall <SwitchParameter>] [-VDIAgent <string>] [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [-VDIPort <uint>] [<CommonParameters>]

New-VDIHost [-Server] <string> [[-SiteId] <uint>] [-VDIType] <HypervisorType> {HyperVUnknown | HyperVWin2008Std | HyperVWin2008Ent | HyperVWin2008Dtc | HyperV | HyperVWin2012Std | HyperVWin2012Dtc | HyperVWin2012Srv | HyperVWin2008R2Std | HyperVWin2008R2Ent | HyperVWin2008R2Dtc | HyperVWin2012R2Std | HyperVWin2012R2Dtc | HyperVWin2012R2Srv | HyperVWin2016Std | HyperVWin2016Dtc | HyperVWin2016Srv | HyperVFailoverClusterUnknown | HyperVFailoverClusterEnt | HyperVFailoverClusterDtc | HyperVFailoverClusterWin2012 | HyperVFailoverClusterWin2012R2 | VmwareESXUnknown | VmwareESXi4_0 | VmwareESX4_0 | VmwareESXi4_1 | VmwareESX4_1 | VmwareESXi5_0 | VmwareESXi5_1 | VmwareESXi5_5 | VmwareESXi6_0 | VmwareESXi6_5 | VmwareESXi6_7 | VmwareVCenterUnknown | VmwareVCenter4_0 | VmwareVCenter4_1 | VmwareVCenter5_0 | VmwareVCenter5_1 | VmwareVCenter5_5 | VmwareVCenter6_0 | VmwareVCenter6_5 | VmwareVCenter6_7 | CitrixXenUnknown | CitrixXen5_0 | CitrixXen5_5 | CitrixXen5_6 | CitrixXen5_6_1 | CitrixXen6_0 | CitrixXen6_1 | CitrixXen6_2 | CitrixXen6_5 | CitrixXen7_0 | QemuKvmUnknown | QemuKvm1_2_14 | NutanixUnknown | Nutanix5_0} -Password <SecureString> -Username <string> -VDIPassword <SecureString> -VDIUsername <string> [-VDIAgent <string>] [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [-VDIPort <uint>] [<CommonParameters>]

DESCRIPTION

The New-VDIHost cmdlet is used to add a VDI Host server to a site.

The RAS VDI Agent will be installed on the server by default. You can optionally skip the agent installation by including the -NoInstall parameter.

PARAMETERS


-Server <string>
A VDI Host server FQDN or IP address.

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

-SiteId <uint>
The site ID to which to add the specified server.

If the parameter is omitted, the Licensing Server site ID will be used.

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

-VDIType <HypervisorType>
The hypervisor type installed on the VDI Host.

To get the list of available types, execute [System.Enum]::GetNames('PSAdmin.HypervisorType')

From the returned list, choose your hypervisor type and then use it as a value for this parameter.

Possible values: HyperVUnknown, HyperVWin2008Std, HyperVWin2008Ent, HyperVWin2008Dtc, HyperV, HyperVWin2012Std, HyperVWin2012Dtc, HyperVWin2012Srv, HyperVWin2008R2Std, HyperVWin2008R2Ent, HyperVWin2008R2Dtc, HyperVWin2012R2Std, HyperVWin2012R2Dtc, HyperVWin2012R2Srv, HyperVWin2016Std, HyperVWin2016Dtc, HyperVWin2016Srv, HyperVFailoverClusterUnknown, HyperVFailoverClusterEnt, HyperVFailoverClusterDtc, HyperVFailoverClusterWin2012, HyperVFailoverClusterWin2012R2, VmwareESXUnknown, VmwareESXi4_0, VmwareESX4_0, VmwareESXi4_1, VmwareESX4_1, VmwareESXi5_0, VmwareESXi5_1, VmwareESXi5_5, VmwareESXi6_0, VmwareESXi6_5, VmwareESXi6_7, VmwareVCenterUnknown, VmwareVCenter4_0, VmwareVCenter4_1, VmwareVCenter5_0, VmwareVCenter5_1, VmwareVCenter5_5, VmwareVCenter6_0, VmwareVCenter6_5, VmwareVCenter6_7, CitrixXenUnknown, CitrixXen5_0, CitrixXen5_5, CitrixXen5_6, CitrixXen5_6_1, CitrixXen6_0, CitrixXen6_1, CitrixXen6_2, CitrixXen6_5, CitrixXen7_0, QemuKvmUnknown, QemuKvm1_2_14, NutanixUnknown, Nutanix5_0

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

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

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

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

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

-VDIUsername <string>
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).

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

-VDIPassword <SecureString>
The password of the account specified in the -VDIUsername parameter.

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

-Username <string>
An administrator account for push installing the RAS VDI Agent on the server.

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

-VDIAgent <string>
FQDN or IP address of the server where the RAS VDI Agent is running.

You only need to specify this parameter if the RAS VDI Agent is running on an appliance.

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

-VDIAgentOStype <RASAgentOSType>
OS type of the server where the RAS VDI Agent is running.

Possible values: Win32, Win64, Appliance

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

-VDIPort <uint>
The port to communicate with the appliance specified in -VDIAgent parameter.

        Required?                    false
        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

-none-

OUTPUTS

PSAdmin.VDIHost

EXAMPLES


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

New-VDIHost "server.company.dom"

Adds the specified VDI Host server to the Licensing Server site (default).

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

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

New-VDIHost -Server "server.company.dom" -SiteId 2 -Username "myname" -Password $pass

Adds the specified VDI Host server to the specified site.

The -Username and -Password parameters specify credentials which will be used to push install the RAS VDI Agent on the server.

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

New-VDIHost "server.company.dom" -NoInstall

Adds the specified VDI Host server to the Licensing Server site (default).

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

You may want to skip the agent installation if a proper version of it is already installed on the server.

RELATED LINKS