NAME

Add-RASAppPackageAssigned

SYNOPSIS

Assigns an application package to an object type.

SYNTAX

Add-RASAppPackageAssigned -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -PackageName <string> -Version <string> [-SiteId <uint>] [<CommonParameters>]

Add-RASAppPackageAssigned [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -PackageName <string> -Version <string> [<CommonParameters>]

Add-RASAppPackageAssigned [-InputObject] <RASSerilazableObj> -PackageName <string> -Version <string> [<CommonParameters>]

Add-RASAppPackageAssigned [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -PackageName <string> -Version <string> [<CommonParameters>]

DESCRIPTION

Adds assigned application package to an object type.

PARAMETERS

-Name <string> The name for which to modify the application package assigned settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the application package assigned settings.

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

-Id <uint> The ID for which to modify the Application Package assigned settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <AppPackageAssignedObjType> The Object Type for which to modify the assigned application package settings.

Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <ServerDefObjType> The Default Object Type for which to modify the application package settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASSerilazableObj> An object of type RDS, RDSHostPool or VDIHostPool for which to modify the Assigned Application settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PackageName <string> The application package name.

This must be the actual application package name used in the RAS farm.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Version <string> The version of the application package.

This must be the actual application package version used in the RAS farm.

        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

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASAppPackageAssigned -Id 3 -ObjType VDIPool -PackageName Mozilla.MozillaFireFox -Version 99.0.0.0

Adds the assigned application package to the object type VDIPool.

RELATED LINKS

• Remove-RASAppPackageAssigned

• Get-RASAppPackageAssigned

• Set-RASAppPackageAssigned

• Invoke-RASAppPackageAssigned

NAME

Add-RASClientPolicyConnection

SYNOPSIS

Adds a new connection to the Connection List.

SYNTAX

Add-RASClientPolicyConnection [-Id] <uint> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]

Add-RASClientPolicyConnection [-InputObject] <ClientRules> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]

Add-RASClientPolicyConnection [-Name] <string> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]

DESCRIPTION

Adds a new connection to the Connection List

PARAMETERS

-Mode <Mode> The mode type of connection.

Possible values: GatewayMode, GatewaySSLMode, DirectMode, DirectSSLMode

        Required?                    true

        Position?                    named

        Default value                GatewayMode

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Server <string> The Server which the user is going to connect to.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ServerPort <uint> The port of the Server.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> Name of the client policy to modify.

This must be the actual client policy name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of the client policy to modify. To obtain the ID, use the Get-RASClientPolicy cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <ClientRules> The client policy object to modify.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

ClientRules

OUTPUTS

-none-

EXAMPLES

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

Add-RASClientPolicyConnection -Id 1 -Mode "Gateway Mode" -Server "xyz" -ServerPort "80"

Adds the client policy connection with the following settings with Id=1.

RELATED LINKS

• Set-RASClientPolicy

• Get-RASClientPolicy

• Get-RASClientPolicyConnection

• Remove-RASClientPolicyConnection

NAME

Add-RASCriteriaGatewayIP

SYNOPSIS

Adds a Gateway IP to the Criteria Gateway List.

SYNTAX

Add-RASCriteriaGatewayIP [-DefObjType] {MFA} [[-SiteId] <uint>] [-GatewayId <uint>] [-IP <string>] [<CommonParameters>]

Add-RASCriteriaGatewayIP [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-GatewayId <uint>] [-IP <string>] [-RuleId <uint>] [<CommonParameters>]

Add-RASCriteriaGatewayIP [-InputObject] <RASListObj> [-GatewayId <uint>] [-IP <string>] [-RuleId <uint>] [<CommonParameters>]

Add-RASCriteriaGatewayIP [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-GatewayId <uint>] [-IP <string>] [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Adds a Gateway IP to the Criteria Gateway List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-IP <string> The IP of the gateway to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GatewayId <uint> The ID of the gateway to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

-Id <uint> The ID of a server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleId <uint> The ID of the Rule to modify.

        Required?                    false

        Position?                    named

        Default value                0

        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

-none-

EXAMPLES

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

Add-RASCriteriaGatewayIP -Id 1 -ObjType MFA -IP "1.2.3.4"

Adds the specified Gateway IP to the Criteria Gateway List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Add-RASCriteriaGatewayIP -Name "Logon1" -ObjType MFA -GatewayId 1

Adds the IP from the Gateway with specified ID to the Criteria Gateway List within the Criteria Settings of the specified MFA by Name.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaGatewayIP

• Remove-RASCriteriaGatewayIP

NAME

Add-RASCriteriaDevice

SYNOPSIS

Adds a Client Device to the Criteria Device List.

SYNTAX

Add-RASCriteriaDevice [-DefObjType] {MFA} [[-SiteId] <uint>] -ClientDeviceName <string> [<CommonParameters>]

Add-RASCriteriaDevice [-Id] <uint> -ClientDeviceName <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

Add-RASCriteriaDevice [-InputObject] <RASListObj> -ClientDeviceName <string> [-RuleId <uint>] [<CommonParameters>]

Add-RASCriteriaDevice [-Name] <string> [[-SiteId] <uint>] -ClientDeviceName <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Adds a Client Device to the Criteria Device List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-ClientDeviceName <string> The name of the client device to add to the Criteria.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

-Id <uint> The ID of a server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleId <uint> The ID of the Rule to modify.

        Required?                    false

        Position?                    named

        Default value                0

        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

-none-

EXAMPLES

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

Add-RASCriteriaDevice -Id 1 -ObjType LogonHours -ClientDeviceName "Device1"

Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ----------

Add-RASCriteriaDevice -Name "Logon1" -ObjType LogonHours -ClientDeviceName "Device1"

Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by Name.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaDevice

• Remove-RASCriteriaDevice

NAME

Add-RASAutoUpgradeMessage

SYNOPSIS

Adds schedule message information within Auto-upgrade settings.

SYNTAX

Add-RASAutoUpgradeMessage - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <string> - <string> [- <bool>] [- <uint>] [- {Before | After}] [- <uint>] [<>]

Add-RASAutoUpgradeMessage [-] <uint> - <string> - <string> - {RDSHostPool | VDIHostPool | AVDHostPool} [- <bool>] [- <uint>] [- {Before | After}] [<>]

Add-RASAutoUpgradeMessage [-] <> - <string> - <string> [- <bool>] [- <uint>] [- {Before | After}] [<>]

Add-RASAutoUpgradeMessage [-] <string> [[-] <uint>] - <string> - <string> - {RDSHostPool | VDIHostPool | AVDHostPool} [- <bool>] [- <uint>] [- {Before | After}] [<>]

DESCRIPTION

Adds schedule message information within Auto-upgrade settings.

PARAMETERS

-Enabled <bool> Whether to enable or disable the message.

-MessageTitle <string> The title of the message.

-Message <string> A message that should be sent to users before the job starts.

-SendMsgSecs <uint> Time interval in seconds before the job starts when the message to users should be sent.

Send Message When can only be set to After in the case of Reboot.

Possible values: Before, After

-Name <string> The name or server for which to modify the Auto-upgrade settings.

-SiteId <uint> Site ID from which to modify the Auto-upgrade settings.

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

-Id <uint> The ID of a server for which to modify the Auto-upgrade settings.

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASAutoUpgradeMessage -DefObjType RDSDef -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Add-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------

Add-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the specified AVDHostPool by Id.

RELATED LINKS

NAME

Add-RASCriteriaSecurityPrincipal

SYNOPSIS

Adds a user, group or machine to the Criteria Security Principal List.

SYNTAX

Add-RASCriteriaSecurityPrincipal [-] {MFA} [[-] <uint>] [- <string>] [- <string>] [<>]

Add-RASCriteriaSecurityPrincipal [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <string>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaSecurityPrincipal [-] <> [- <string>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaSecurityPrincipal [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <string>] [- <uint>] [- <string>] [<>]

DESCRIPTION

Adds a user, group or machine to the Criteria Security Principal List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-Account <string> The name of the account to add to the Criteria.

-SID <string> The SID of the account to add to the Criteria.

-Name <string> The name or server for which to modify the Criteria settings.

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

-Id <uint> The ID of a server for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

Possible values: MFA

-RuleId <uint> The ID of the Rule to modify.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASCriteriaSecurityPrincipal -Id 1 -ObjType MFA -Account "JaneDoe"

Adds a user to the Criteria Security Principal List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Add-RASCriteriaSecurityPrincipal -Name "Logon1" -ObjType MFA -Account "SID://DOMAIN/JaneDoe"

Adds a user to the Criteria Security Principal List within the Criteria Settings of the specified MFA by Name.

RELATED LINKS

NAME

Add-RASHALBDevice

SYNOPSIS

Add a new HALB Device to the specific HALB Virtual Server instance.

SYNTAX

Add-RASHALBDevice [[-HALBId] <uint>] [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

Add-RASHALBDevice [-InputObject] <HALBSettings> [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

Add-RASHALBDevice [-HALBName] <string> [[-SiteId] <uint>] [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Add a new HALB Device to the specific HALB Virtual Server instance.

PARAMETERS

-HALBName <string>

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HALBId <uint>

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DeviceIP <string>

        Required?                    true

        Position?                    2

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NoInstall <SwitchParameter>

        Required?                    false

        Position?                    3

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <HALBSettings> An object of type HALBSettings.

The object is obtained using the Get-RASHALB cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

HALBSettings

OUTPUTS

-none-

EXAMPLES

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

Add-RASHALBDevice -HALBId 1 -DeviceIP "1.2.3.4"

Adds the HALB Device to a specific HALB Virtual Server instance by id. ---------- EXAMPLE 2 ----------

Add-RASHALBDevice -HALBName "HALB-VS" -SiteId 1 -DeviceIP "1.2.3.4"

Adds the HALB Device to a specific HALB Virtual Server instance by name.

RELATED LINKS

• Remove-RASHALBDevice

• Get-RASHALBDevice

• Set-RASHALBDevicePriority

NAME

Add-RASImageOptimizationRegistry

SYNOPSIS

Adds Registry property to the list.

SYNTAX

Add-RASImageOptimizationRegistry - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <string> - <string> [- {Add | Modify | Delete}] [- <uint>] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [- <string>] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [- <uint>] [- <string>] [<>]

Add-RASImageOptimizationRegistry [-] <uint> - <string> - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} - <string> [- {Add | Modify | Delete}] [- <uint>] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [- <string>] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [- <string>] [<>]

Add-RASImageOptimizationRegistry [-] <> - <string> - <string> [- {Add | Modify | Delete}] [- <uint>] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [- <string>] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [- <string>] [<>]

Add-RASImageOptimizationRegistry [-] <string> [[-] <uint>] - <string> - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} - <string> [- {Add | Modify | Delete}] [- <uint>] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [- <string>] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [- <string>] [<>]

DESCRIPTION

Adds Registry to the following list.

PARAMETERS

Possible values: Add, Modify, Delete

-RegistryName <string>

-DWORDValue <uint>

-DisplayName <string>

Possible values: HKEY_CURRENT_CONFIG, HKEY_USERS, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT

-Path <string>

Possible values: REG_SZ, REG_DWORD, REG_QWORD, REG_MULTI_SZ, REG_EXPAND_SZ

-StringValue <string>

-Name <string> The name or server for which to modify the Image Optimization settings.

-SiteId <uint> Site ID from which to modify the Image Optimization settings.

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

-Id <uint> The ID of a server for which to modify the Image Optimization settings.

Possible values: RDSHost, RDS, VDIHostPool, AVDHostPool, RDSTemplate, VDITemplate, AVDTemplate

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASImageOptimizationRegistry -Id 30 -ObjType RDS -Action Add -RegistryName "Name" -DWORDValue 1 -DisplayName HKEY_test -HiveType HKEY_CURRENT_CONFIG -Path System\CurrentControlSet\Services\Disk -RegType REG_SZ

Adds the Image Optimization Registry of the Object Type 'RDS'.

RELATED LINKS

NAME

Add-RASMFARadiusAuto

SYNOPSIS

Adds automation settings to Radius provider settings.

SYNTAX

Add-RASMFARadiusAuto [-Id] <uint> -Command <string> -Title <string> [-ActionMessage <string>] [-Description <string>] [-Enabled <bool>] [-Image {Alert | Message | Email | Call | Chat | Flag}] [<CommonParameters>]

Add-RASMFARadiusAuto [-InputObject] <MFA> -Command <string> -Title <string> [-ActionMessage <string>] [-Description <string>] [-Enabled <bool>] [-Image {Alert | Message | Email | Call | Chat | Flag}] [<CommonParameters>]

Add-RASMFARadiusAuto [-Name] <string> [[-SiteId] <uint>] -Command <string> -Title <string> [-ActionMessage <string>] [-Description <string>] [-Enabled <bool>] [-Image {Alert | Message | Email | Call | Chat | Flag}] [<CommonParameters>]

DESCRIPTION

The cmdlet appends new attribute settings to existing ones. All parameters are mandatory.

PARAMETERS

-Command <string> RADIUS Automation command

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Whether the RADIUS Automation is enabled/disabled

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Image <ImageType> RADIUS Automation image

Possible values: Alert, Message, Email, Call, Chat, Flag

        Required?                    false

        Position?                    named

        Default value                Alert

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Title <string> RADIUS Automation title

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ActionMessage <string> RADIUS Automation action message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> RADIUS Automation description

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name of the target multi-factor authentication .

This must be the actual multi-factor authentication 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 multi-factor authentication .

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 multi-factor authentication to modify. To obtain the ID, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <MFA> The multi factor authentication to modify.

To obtain an object of type MFA, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

MFA

OUTPUTS

-none-

EXAMPLES

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

Add-RASMFARadiusAuto -SiteId 2 -Command Test -Title Test

Adds a new entry to the Radius automation list on Site 2. [Radius Setting]

RELATED LINKS

• Get-RASMFARadiusAuto

• Set-RASMFARadiusAuto

• Remove-RASMFARadiusAuto

NAME

Add-RASImageOptimizationWindowsService

SYNOPSIS

Adds Windows Custom Services.

SYNTAX

Add-RASImageOptimizationWindowsService -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [-SiteId <uint>] [<CommonParameters>]

Add-RASImageOptimizationWindowsService [-Id] <uint> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [<CommonParameters>]

Add-RASImageOptimizationWindowsService [-InputObject] <RASSerilazableObj> [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [<CommonParameters>]

Add-RASImageOptimizationWindowsService [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [<CommonParameters>]

DESCRIPTION

Adds Windows Custom Service to the following list.

PARAMETERS

-Aliases <string>

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DisplayName <string>

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ServiceName <string>

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the Image Optimization settings.

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

-Id <uint> The ID of a server for which to modify the Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASSerilazableObj> An object of type RDS, VDITemplate or VDIDesktop for which to modify the Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <OptimizationServerObjType> The Object Type for which to modify the Image Optimization settings.

Possible values: RDSHost, RDS, VDIHostPool, AVDHostPool, RDSTemplate, VDITemplate, AVDTemplate

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <ServerDefObjType> The Default Object Type for which to modify the Image Optimization settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

        Required?                    true

        Position?                    named

        Default value                0

        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

-none-

EXAMPLES

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

Add-RASImageOptimizationWindowsService -Id 30 -ObjType RDS -DisplayName Name -Aliases alias -ServiceName "Service Name"

Adds the Windows Custom Services to the object type RDS.

RELATED LINKS

• Remove-RASImageOptimizationWindowsService

• Get-RASImageOptimizationWindowsService

NAME

Add-RASMFARadiusAttr

SYNOPSIS

Adds attribute settings to Radius provider settings.

SYNTAX

Add-RASMFARadiusAttr [-AttributeType] {Number | String | IP | Time} [-Id] <uint> -AttributeID <uint> -RadiusAttrName <string> -Value <string> -Vendor <string> -VendorID <uint> [<CommonParameters>]

Add-RASMFARadiusAttr [-AttributeType] {Number | String | IP | Time} [-InputObject] <MFA> -AttributeID <uint> -RadiusAttrName <string> -Value <string> -Vendor <string> -VendorID <uint> [<CommonParameters>]

Add-RASMFARadiusAttr [-AttributeType] {Number | String | IP | Time} [-Name] <string> [[-SiteId] <uint>] -AttributeID <uint> -RadiusAttrName <string> -Value <string> -Vendor <string> -VendorID <uint> [<CommonParameters>]

DESCRIPTION

The cmdlet appends new attribute settings to existing ones. All parameters are mandatory.

PARAMETERS

-VendorID <uint> RADIUS attribute vendor ID

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AttributeID <uint> RADIUS attribute ID

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Value <string> RADIUS attribute value

The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RadiusAttrName <string> RADIUS attribute name

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Vendor <string> RADIUS attribute vendor name

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AttributeType <RadiusAttrType> RADIUS attribute type. IP, string, number, or time

Possible values: Number, String, IP, Time

        Required?                    true

        Position?                    0

        Default value                String

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name of the target multi-factor authentication .

This must be the actual multi-factor authentication 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 multi-factor authentication .

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 multi-factor authentication to modify. To obtain the ID, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <MFA> The multi factor authentication to modify.

To obtain an object of type MFA, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

MFA

OUTPUTS

-none-

EXAMPLES

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

Add-RASMFARadiusAttr -AttributeType IP -VendorID 1 -AttributeID 1 -Value 127.0.0.1 -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type IP. The "Value" parameter must be in a valid IP format (IPv4 only). ---------- EXAMPLE 2 ----------

Add-RASMFARadiusAttr -AttributeType String -VendorID 1 -AttributeID 1 -Value "This is a string" -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type String. The "Value" parameter can contain a character of any type, but cannot be empty. ---------- EXAMPLE 3 ----------

Add-RASMFARadiusAttr -AttributeType Number -VendorID 1 -AttributeID 1 -Value 42 -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type Number. The "Value" parameter must contain numbers. The input can also be a string but must contain numbers only. ---------- EXAMPLE 4 ----------

Add-RASMFARadiusAttr -AttributeType Time -VendorID 1 -AttributeID 1 -Value 1500892318 -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type Time. The "Value" parameter represents the date using the epoch time format.

RELATED LINKS

• Get-RASMFARadiusAttr

• Remove-RASMFARadiusAttr

NAME

Add-RASPrintingAutoInstallFont

SYNOPSIS

Adds an Auto install font to Parallels RAS Universal Printing settings.

SYNTAX

Add-RASPrintingAutoInstallFont -FontFilePath <string> [-ExcludeFont <SwitchParameter>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Adds an Auto install font to Parallels RAS Universal Printing settings.

PARAMETERS

-SiteId <uint> The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-FontFilePath <string> Auto Install Font Path.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ExcludeFont <SwitchParameter> Automatically Exclude Font from embedding.

        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

-none-

EXAMPLES

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

Add-RASPrintingAutoInstallFont -FontFilePath "C:\Windows\Fonts\arialbd.ttf"

Adds the font to RAS Universal Printing Auto install fonts settings. ---------- EXAMPLE 2 ----------

Add-RASPrintingAutoInstallFont -FontFilePath "C:\Windows\Fonts\arialbd.ttf" -ExcludeFont

Adds the font to RAS Universal Printing Auto install fonts settings and adds the font to the embedding exclusion list.

RELATED LINKS

• Get-RASPrintingSettings

• Set-RASPrintingSettings

• Get-RASPrintingAutoInstallFont

• Remove-RASPrintingAutoInstallFont

NAME

Add-RASProviderRemotePCStatic

SYNOPSIS

Adds a Remote PC Static to a Provider.

SYNTAX

Add-RASProviderRemotePCStatic [-Id] <uint> -MAC <string> -RemotePCStaticName <string> [-Subnet <string>] [<CommonParameters>]

Add-RASProviderRemotePCStatic [-InputObject] <RemotePCStaticProvider> -MAC <string> -RemotePCStaticName <string> [-Subnet <string>] [<CommonParameters>]

Add-RASProviderRemotePCStatic [-Server] <string> [[-SiteId] <uint>] -MAC <string> -RemotePCStaticName <string> [-Subnet <string>] [<CommonParameters>]

DESCRIPTION

Adds a Remote PC Static to a Provider.

PARAMETERS

-RemotePCStaticName <string> Remote PC Static Name.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MAC <string> Remote PC Static MAC Address.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Subnet <string> Remote PC Static Subnet. Default: 0.0.0.0

        Required?                    false

        Position?                    named

        Default value                0.0.0.0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Server <string> The name of the target Provider 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 Provider 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 Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RemotePCStaticProvider> An object representing the Provider server to modify.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

RemotePCStaticProvider

OUTPUTS

-none-

EXAMPLES

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

Add-RASProviderRemotePCStatic -Id 1 -RemotePCStaticName Test0 -MAC 00-11-22-33-44-00

Adds a Remote PC Static Test0 to the Remote PC Static List of the Provider with Id 1.

RELATED LINKS

• Get-RASProvider

• Set-RASProvider

• Get-RASProviderRemotePCStatic

• Set-RASProviderRemotePCStatic

• Remove-RASProviderRemotePCStatic

• Invoke-RASImportProviderRemotePCStatic

NAME

Add-RASProviderAdminCredentials

SYNOPSIS

Adds Admin Credential property to the list.

SYNTAX

Add-RASProviderAdminCredentials [-Id] <uint> [-Enabled <bool>] [-Password <string>] [-Username <string>] [<CommonParameters>]

Add-RASProviderAdminCredentials [-Name] <string> [[-SiteId] <uint>] [-Enabled <bool>] [-Password <string>] [-Username <string>] [<CommonParameters>]

DESCRIPTION

Adds Admin Credential to the following list.

PARAMETERS

-Name <string> The name of the Provider.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to modify the specified Provider 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 Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Whether credentials are enabled or not

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Username <string> Username

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Password <string> Password

        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

-none-

EXAMPLES

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

Add-RASProviderAdminCredential -Id 1 -Enabled $true -Username "Administrator"

Adds the Admin Credentials to the property list

RELATED LINKS

• Get-RASProviderAdminCredentials

• Set-RASProviderAdminCredentials

• Remove-RASProviderAdminCredentials

NAME

Add-RASMFAUsers

SYNOPSIS

Import MFA TOTP/EmailOTP users from a CSV file.

SYNTAX

Add-RASMFAUsers -FilePath <string> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

DESCRIPTION

Import MFA TOTP/EmailOTP users from a CSV file.

PARAMETERS

-FilePath <string> File path to CSV containing user and secret.

Must be in the format "user,secret".

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in where the users will be imported.

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> The ID of the MFA Provider to be modified.

In case of TOTP Provider, the ID will always be 0. Default: 0.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Type <MFAUsersType> The MFA Provider Type to be modified.

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

Possible values: GAuthTOTP, TOTP, MicrosoftTOTP, EmailOTP

        Required?                    false

        Position?                    named

        Default value                TOTP

        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

-none-

EXAMPLES

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

Add-RASMFAUsers -FilePath "users.csv" -Type TOTP

Imports MFA TOTP users from file. Operation is done on licensing site. ---------- EXAMPLE 2 ----------

Add-RASMFAUsers -FilePath "users.csv" -Type EmailOTP -MFAId 1

Imports MFA EmailOTP users from file in MFA with Id 1. ---------- EXAMPLE 3 ----------

Add-RASMFAUsers -FilePath "users.csv" -SiteId 2 -Type TOTP

Imports MFA TOTP users from file. Operation is done on site 2.

RELATED LINKS

• Find-RASMFAUsers

• Reset-RASMFAUsers

NAME

Add-RASPubRDSAppServerAttr

SYNOPSIS

Adds RDS application attributes to specific server from where the application is hosted.

SYNTAX

Add-RASPubRDSAppServerAttr [-Id] <uint> -ServerID <uint> [-Parameters <string>] [-SiteId <uint>] [-StartIn <string>] [-Target <string>] [<CommonParameters>]

Add-RASPubRDSAppServerAttr [-InputObject] <PubItem> -ServerID <uint> [-Parameters <string>] [-SiteId <uint>] [-StartIn <string>] [-Target <string>] [<CommonParameters>]

DESCRIPTION

Adds RDS application attributes to a specific server from where the application is hosted.

PARAMETERS

-ServerID <uint> RDS server ID on which the attributes will be updated.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Target <string> Application target file. (i.e. calc.exe, file.txt, etc.)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-StartIn <string> Application working directory.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Parameters <string> Application parameters.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <PubItem> An object specifying the published resource.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-SiteId <uint> Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        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

PubItem

OUTPUTS

-none-

EXAMPLES

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

Add-RASPubRDSAppServerAtt -Id 2 -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"

Adds an existing per server application attribute settings by application Id. ---------- EXAMPLE 2 ----------

Add-RASPubRDSAppServerAtt -InputObject $RDSApp -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"

Adds an existing per server application attribute settings by input object. ---------- EXAMPLE 3 ----------

Get-RASPubRDSApp -Id 2 | Add-RASPubRDSAppServerAtt -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"

Adds an existing per server application attribute settings by input object from pipeline.

RELATED LINKS

• Get-RASPubRDSAppServerAttr

• Set-RASPubRDSAppServerAttr

• Remove-RASPubRDSAppServerAttr

• Get-RASRDSHost

• Get-RASPubRDSApp

NAME

Add-RASScheduleTarget

SYNOPSIS

Adds a new Schedule target.

SYNTAX

Add-RASScheduleTarget [-Id] <uint> -ObjType {RDS | VDI | AVD} -TargetID <uint> [-TargetType {Host | HostPool}] [<CommonParameters>]

Add-RASScheduleTarget [-Id] <uint> -HostAzureID <string> -ObjType {RDS | VDI | AVD} -PoolId <uint> [-TargetType {Host | HostPool}] [<CommonParameters>]

Add-RASScheduleTarget [-Id] <uint> -GuestName <string> -GUID <string> -ObjType {RDS | VDI | AVD} -PoolId <uint> [-TargetType {Host | HostPool}] [<CommonParameters>]

Add-RASScheduleTarget [-Name] <string> [[-SiteId] <uint>] -ObjType {RDS | VDI | AVD} -TargetID <uint> [-TargetType {Host | HostPool}] [<CommonParameters>]

Add-RASScheduleTarget [-Name] <string> [-SiteId] <uint> -HostAzureID <string> -ObjType {RDS | VDI | AVD} -PoolId <uint> [-TargetType {Host | HostPool}] [<CommonParameters>]

Add-RASScheduleTarget [-Name] <string> [-SiteId] <uint> -GuestName <string> -GUID <string> -ObjType {RDS | VDI | AVD} -PoolId <uint> [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

Creates a new Schedule property.

PARAMETERS

-Name <string> Scheduler job name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID to modify the schedule job.

        Required?                    true

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Scheduler job ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <ScheduleObjType> Schedule object type.

Possible values: RDS, VDI, AVD

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TargetType <ScheduleTargetType> Schedule target type.

Possible values: Host, HostPool

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TargetID <uint> The target RD Session Host server or server group Ids depending on the TargetType parameter.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PoolId <uint>

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GUID <string>

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GuestName <string>

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HostAzureID <string>

        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

-none-

OUTPUTS

Schedule

EXAMPLES

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

Add-RASScheduleTarget -ObjType VDI -Id 1 -TargetID 1

Adds a schedule target id to the schedule item specified by id. ---------- EXAMPLE 2 ----------

Add-RASScheduleTarget -ObjType VDI -Name "My Schedule" -TargetID 1

Adds a schedule target id to the schedule item specified by name. ---------- EXAMPLE 3 ----------

Add-RASScheduleTarget -ObjType VDI -Id 1 -PoolID 1 -GUID "SampleGUID" -GuestName "SampleGuestName"

Adds a schedule target native host to the schedule item specified by id. ---------- EXAMPLE 4 ----------

Add-RASScheduleTarget -ObjType VDI -Name "My Schedule" -PoolID 1 -HostAzureID "SampleAzureID"

Adds a schedule target native host to the schedule item specified by name.

RELATED LINKS

• Remove-RASScheduleTarget

• Get-RASScheduleTarget

NAME

Add-RASScheduleMessage

SYNOPSIS

Adds schedule message information for a Schedule.

SYNTAX

Add-RASScheduleMessage [-Id] <uint> -Message <string> -MessageTitle <string> -ObjType {RDS | VDI | AVD} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]

Add-RASScheduleMessage [-Name] <string> [[-SiteId] <uint>] -Message <string> -MessageTitle <string> -ObjType {RDS | VDI | AVD} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]

DESCRIPTION

Adds schedule message information for a Schedule.

PARAMETERS

-Enabled <bool> Whether to enable or disable the message.

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MessageTitle <string> The title of the message.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Message <string> A message that should be sent to users before the job starts.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SendMsgSecs <uint> Time interval in seconds before the job starts when the message to users should be sent.

        Required?                    false

        Position?                    named

        Default value                900

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SendMsgWhen <SendMsgWhen> Whether the message is sent Before/After the schedule is triggered.

Send Message When can only be set to After in the case of Reboot.

Possible values: Before, After

        Required?                    false

        Position?                    named

        Default value                Before

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> Scheduler job name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID to modify the schedule job.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Scheduler job ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <ScheduleObjType> Schedule message object type.

Possible values: RDS, VDI, AVD

        Required?                    true

        Position?                    named

        Default value                0

        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

ScheduleMessage

EXAMPLES

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

Add-RASScheduleMessage -ObjType VDI -Name "SchedItem" -Enabled 0 -SendMsgSecs 60 -MessageTitle "messageTitle" -Message "messageBody"

Adds a Message to the schedule item specified by name, set to send 1 minute before schedule trigger. ---------- EXAMPLE 2 ----------

Add-RASScheduleMessage -ObjType VDI -Id 2 -Enabled 1 -SendMsgSecs 120 -MessageTitle "messageTitle" -Message "messageBody"

Adds a Message to the schedule item specified by id, set to send 2 minutes before schedule trigger.

RELATED LINKS

• Get-RASSchedule

• Get-RASScheduleMessage

• Set-RASScheduleMessage

• Remove-RASScheduleMessage

NAME

Add-RASPubItemPreferredRoute

SYNOPSIS

Adds a preferred route to the specified published resource.

SYNTAX

Add-RASPubItemPreferredRoute [-Id] <uint> -Name <string> -ReferenceId <uint> -ReferenceType {Gateway | HALB | Custom} [-Description <string>] [-Enabled <bool>] [-SiteId <uint>] [<CommonParameters>]

Add-RASPubItemPreferredRoute [-InputObject] <PubItem> -Name <string> -ReferenceId <uint> -ReferenceType {Gateway | HALB | Custom} [-Description <string>] [-Enabled <bool>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

This cmdlet allows you to add a preferred route to the specified published resource.

To modify preferred route options, use the Set-RASPubItemPreferredRoute cmdlet.

PARAMETERS

-Name <string> The Name of the Preferred Route

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> Description of the Preferred Route

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Whether the Preferred Route is enabled or not

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ReferenceType <RoutingType> Reference Type of the Preferred Route

Possible values: Gateway, HALB, Custom

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ReferenceId <uint> Reference ID of the Preferred Route

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <PubItem> An object specifying the published resource.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-SiteId <uint> Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        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

PubItem

OUTPUTS

-none-

EXAMPLES

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

Add-RASPubItemPreferredRoute -Id 12 -Name Route1 -ReferenceType Gateway -ReferenceId 1

Adds a preferred route with Name Route1 that routes connections through the Gateway with ID 1.

The target published resource is specified by ID 12. ---------- EXAMPLE 2 ----------

Add-RASPubItemPreferredRoute -Id 12 -Name Route2 -ReferenceType HALB -ReferenceId 1

Adds a preferred route with Name Route2 that routes connections through the HALB with ID 1.

The target published resource is specified by ID 12.

RELATED LINKS

• Get-RASPubItem

• Get-RASPubItemPreferredRoute

• Set-RASPubItemPreferredRoute

• Remove-RASPubItemPreferredRoute

• New-RASCustomRoute

• Get-RASCustomRoute

• Set-RASCustomRoute

• Remove-RASCustomRoute

• Get-RASGateway

• Get-RASHALB

NAME

Add-RASThemeGroupFilter

SYNOPSIS

Adds a new group filter to the theme group filters.

SYNTAX

Add-RASThemeGroupFilter [-] <uint> [- <string>] [- <string>] [<>]

Add-RASThemeGroupFilter [-] <string> [[-] <uint>] [- <string>] [- <string>] [<>]

DESCRIPTION

Adds a new group filter to the theme group filters.

PARAMETERS

-GroupName <string> The name of the group list

-GroupSID <string> The group SID

-Name <string> Name of the Theme policy to modify.

This must be the actual Theme policy name used in the RAS farm.

-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.

-Id <uint> The ID of the Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASThemeGroupFilter -Id 1 -GroupName GroupListName

Adds a group filter with name GroupListName for theme with Id 1.

RELATED LINKS

NAME

Add-RASPubAppFileExt

SYNOPSIS

Adds a file extension for the specified published application.

SYNTAX

Add-RASPubAppFileExt [-] <uint> - <string> [- <uint>] [<>]

Add-RASPubAppFileExt [-] <> - <string> [- <uint>] [<>]

DESCRIPTION

This cmdlet only allows you to add a file extension.

To modify other file extensions, use the Set-RASPubAppFileExt cmdlet.

PARAMETERS

-Extension <string> The file extension that will be added/modified.

-Id <uint> Published resource ID.

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

-SiteId <uint> Site ID.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

Add-RASPubAppFileExt -Id 3 -Extension "txt"

Adds the specified file extension for the resource specified by ID.

RELATED LINKS

NAME

Add-RASTemplateLicenseKey

SYNOPSIS

Modifies properties of a RAS Template license key.

SYNTAX

Add-RASTemplateLicenseKey [-] <uint> - <string> - <uint> - {RDSTemplate | VDITemplate | AVDTemplate} [<>]

Add-RASTemplateLicenseKey [-] <> - <string> - <uint> [<>]

DESCRIPTION

Modifies properties of a license key used by a RAS Template.

PARAMETERS

-Id <uint> The ID of a RAS Template to modify.

Possible values: RDSTemplate, VDITemplate, AVDTemplate

The object is obtained using the Get-Template cmdlet.

-Key <string> The license key.