-
Server <string>
The name of the target VDI Host server.
This must be the actual server name used in the RAS farm.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SiteId <uint>
Site ID in which to modify the specified VDI Host server.
If the parameter is omitted, the site ID of the Licensing Server will be used.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-
Id <uint>
The ID of the VDI Host server to modify. To obtain the ID, use the Get-VDIHost cmdlet.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-
InputObject <VDIHost>
An object representing the VDI Host server to modify.
To obtain the object, use the Get-VDIHost cmdlet.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-
Enabled <bool>
Enables or disables the specified VDI Host server in a site.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Enable <bool>
Enables or disables the specified VDI Host server in a site.
This is an alias of the Enabled parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
NewServer <string>
A new server name. This must be the server FQDN or IP address.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Description <string>
A user-defined VDI Host server description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
DirectAddress <string>
Specifies the VDI Host server direct address.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Port <uint>
Specifies the port number for the RAS VDI Agent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
MaxGuests <uint>
Specifies the 'Maximum Sessions' property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
VDIType <HypervisorType>
Specifies the VDI Host type.
To get the list of available types, execute [System.Enum]::GetNames('RASAdminEngine.Core.OuputModels.HypervisorType')
From the returned list, choose a 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, HyperVWin2019Std, HyperVWin2019Dtc, HyperVWin2019Srv, HyperVFailoverClusterUnknown, HyperVFailoverClusterEnt, HyperVFailoverClusterDtc, HyperVFailoverClusterWin2012, HyperVFailoverClusterWin2012R2, HyperVFailoverClusterWin2016, HyperVFailoverClusterWin2019, 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, CitrixXen7_1, CitrixXen7_2, QemuKvmUnknown, QemuKvm1_2_14, NutanixUnknown, Nutanix5_0, RemotePCUnknown, RemotePCStatic, RemotePCDynamic, ScaleUnknown, Scale7_4, Azure
Required? false
Position? named
Default value
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? false
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? false
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
-
VDIPort <uint>
The port to communicate with the appliance specified in the VDIAgent parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowURLAndMailRedirection <AllowURLAndMailRedirection>
The port to communicate with the appliance specified in the VDIAgent parameter.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowFileTransfer <bool>
Enables or disables the 'Allow file transfer' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveClientNameFromPrinterName <bool>
Enables or disables the 'Remove client name from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveClientName <bool>
Enables or disables the 'Remove client name from printer name' option.
This is an alias of the RemoveClientNameFromPrinterName parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveSessionNumberFromPrinterName <bool>
Enables or disables the 'Remove session number from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveSessionNumber <bool>
Enables or disables the 'Remove session number from printer name' option.
This is an alias of the RemoveSessionNumberFromPrinterName parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
PrinterNameFormat <PrnNameFormat>
Specifies the 'RDP Printer Name Format' option.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AutoPreferredPA <SwitchParameter>
Sets the 'Preferred Publishing Agent' option to 'Automatically". If number of PAs is less than 3 then preferred PA is not allowed to choose automatic
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-
PreferredPAObj <PA>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
PreferredPAId <uint>
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.