-
Server <string>
A Provider server FQDN or IP address.
In case of Azure, it is a name under which this provider will be diplayed in list.
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
-
Type <HypervisorType>
The hypervisor type installed of the Provider.
To get the list of available types, execute [System.Enum]::GetNames('RASAdminEngine.Core.OutputModels.HypervisorType')
From the returned list, choose your hypervisor type and then use it as a value for this parameter.
Possible values: HyperVUnknown, HyperVWin2012R2Std, HyperVWin2012R2Dtc, HyperVWin2012R2Srv, HyperVWin2016Std, HyperVWin2016Dtc, HyperVWin2016Srv, HyperVWin2019Std, HyperVWin2019Dtc, HyperVWin2019Srv, HyperVWin2022Std, HyperVWin2022Dtc, HyperVFailoverClusterUnknown, HyperVFailoverClusterEnt, HyperVFailoverClusterDtc, HyperVFailoverClusterWin2012, HyperVFailoverClusterWin2012R2, HyperVFailoverClusterWin2016, HyperVFailoverClusterWin2019, HyperVFailoverClusterWin2022, VmwareESXUnknown, VmwareESXi4_0, VmwareESX4_0, VmwareESXi4_1, VmwareESX4_1, VmwareESXi5_0, VmwareESXi5_1, VmwareESXi5_5, VmwareESXi6_0, VmwareESXi6_5, VmwareESXi6_7, VmwareESXi7_0, VmwareVCenterUnknown, VmwareVCenter4_0, VmwareVCenter4_1, VmwareVCenter5_0, VmwareVCenter5_1, VmwareVCenter5_5, VmwareVCenter6_0, VmwareVCenter6_5, VmwareVCenter6_7, VmwareVCenter7_0, NutanixUnknown, Nutanix5_10, Nutanix5_15, Nutanix5_20, RemotePCUnknown, RemotePCStatic, RemotePCDynamic, ScaleUnknown, Scale8_6_5, Scale8_8, Scale8_9, Azure
Required? true
Position? 2
Default value 0
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 the Username and Password parameters.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-
NoRestart <SwitchParameter>
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent.
If this parameter is omitted, the server will be restarted if required.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-
NoFireWallRules <SwitchParameter>
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent.
If this parameter is omitted, the firewall rules will not be added.
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).
In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
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.
In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
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.
.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Port <uint>
The port to communicate with the Provider specified in Server parameter.
In case of Azure, it is not required.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
PreferredPAObj <PA>
The preferred Publishing Agent server.
To obtain an object of type PA representing the preferred Publishing Agent, use the Get-PA cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
PreferredPAId <uint>
The preferred Publishing Agent server ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SubscriptionID <string>
Azure Subscription ID.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
TenantID <string>
Azure Tenant ID.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AuthenticationURL <string>
Azure Authentication URL.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ManagementURL <string>
Azure Management URL.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ResourceURI <string>
Azure Resource URI.
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.