Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Retrieve a list of all the Trusted Domains.
Site ID for which to retrieve all the Trusted Domains (optional)
OK
Retrieve a list of all the settings for RAS authentication
Site ID for which to retrieve all the settings for RAS authentication (optional)
OK
Authentication Type
Whether to use all trusted domains.
Domain name.
Whether to use the client domain, if specified.
Whether to force clients to use NetBIOS credentials.
Whether to replicate settings to other sites.
Enable use custom link for the "Change domain password" option.
Custom link for the "Change domain password" option.
The site ID to which the RAS authentication settings refer.
Update RAS authentication settings
ID of the site for which the RAS authentication settings will be updated
RAS allowed device settings
Authentication Type
Whether to use all trusted domains.
Domain name.
Whether to use the client domain, if specified.
Whether to force clients to use NetBIOS credentials.
Whether to replicate settings to other sites.
Enable use custom link for the "Change domain password" option.
Custom link for the "Change domain password" option.
No Content
Update the Email OTP MFA Site Settings.
The ID for which to modify the MFA settings.
MFA settings.
The new name of the target multi-factor authentication .
A user-defined multi-factor authentication description.
Enable or disable the specified multi-factor authentication in a site.
If true default criteria settings will be inherited.
No Content
Update the TOTP MFA Site Settings.
The ID for which to modify the MFA settings.
MFA settings.
The new name of the target multi-factor authentication .
A user-defined multi-factor authentication description.
Enable or disable the specified multi-factor authentication in a site.
If true default criteria settings will be inherited.
No Content
Create a new TOTP MFA.
MFA settings
The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.
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.
A user-defined Multi Factor Authentication description.
Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.
RADIUS type name.
User Enrollment
Show information for unenrolled users
Allow User Enrollment until date/time
TOTP tolerance in seconds. Accepted values are 0 (None), 30, 60, 90 and 120
User message prompt
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Authentication method type
User message prompt
User Enrollment
Show information for unenrolled users
Allow User Enrollment until date/time
TOTP tolerance in seconds. Accepted values are 0 (None), 30, 60, 90 and 120
Create a new Email OTP MFA.
MFA settings
The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.
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.
A user-defined Multi Factor Authentication description.
Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.
RADIUS type name.
User Enrollment
Show information for unenrolled users
Allow User Enrollment until date/time
The lifespan of the OTP (seconds)
External email storage
The content of the email. Possible variables: %OTP%, %DURATION%
The subject of the email. Possible variables: %OTP%
User message prompt
AD Custom Attribute
Allow enrollment of external email
The length of the OTP generated
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Display name
User Enrollment
Show information for unenrolled users
Allow User Enrollment until date/time
The lifespan of the OTP (seconds)
External email storage
The content of the email. Possible variables: %OTP%, %DURATION%
The subject of the email. Possible variables: %OTP%
User message prompt
AD Custom Attribute
Allow enrollment of external email
The length of the OTP generated
Clear the cached sessions for authenticated RAS Clients, and they're forced to reauthenticate on the next connection.
No Content
Upload an FSLogix Installer file to the FSLogix Profile Containers Feature Site Settings.
The Site ID for which to modify the FSLogix Profile Containers Feature settings.
Upload File
No Content
Add a new RAS Printing settings font to a site.
ID of the site to which the font will be added (optional)
Upload File
Created
Checks Connection of the Multi Factor Authentication.
The server of the second level authentication provider.
The backup server of the second level authentication provider.
The port number of the second level authentication provider..
High Availability Mode
Connection timeout (in seconds).
Number of retries.
Password Encoding
Success
Validate AD Access of the Multi Factor Authentication.
The Site Id to validate the AD Access.
AD Custom Attribute
The User Principal Name
Success
Delete a notification by ID.
Notification ID
No Content
Delete an event notification by ID.
Event notification ID
No Content
Delete a script notification by ID.
Script notification ID
No Content
Remove a MFA from a site.
The ID of a MFA to remove from the site.
No Content
Remove a custom route from a site.
The ID of a custom route to remove from the site.
No Content
Delete a Radius Auto Info from a site.
The ID of a MFA to remove a RadiusAutoInfo from the site.
The ID of a RadiusAutoInfo to remove from the site.
No Content
Remove a logon hours setting from a Site.
The ID of a logon hours setting to remove from the Site.
No Content
Delete a resource notification by ID.
Resource notification ID
No Content
Retrieve Criteria Hardware ID List of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).
Success
The hardware ID.
Retrieve Criteria Device List of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).
Success
The name of the client device.
Retrieve Criteria Gateway IP List of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).
Success
The gateway IP.
Retrieve Criteria Gateway IP List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The gateway IP.
Retrieve Criteria Device List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The name of the client device.
Retrieve Criteria Hardware ID List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The hardware ID.
Retrieve Criteria Device List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The name of the client device.
Retrieve Criteria Hardware ID List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The hardware ID.
Retrieve Criteria Gateway IP List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The gateway IP.
Retrieve information about RAS printing settings font of a site.
Site ID for which to retrieve the RAS printing settings font (optional)
Success
Remove a gateway IP from the Gateway IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Gateway IP configuration.
The IP of the gateway to remove from the Criteria.
No Content
Remove a device from the Device List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Device configuration.
The name of the client device to remove from the Criteria.
No Content
Remove a hardware ID from the Hardware ID List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Hardware ID configuration.
The hardware ID to remove from the Criteria.
No Content
Retrieve Criteria Theme List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
Remove a hardware ID from the Hardware ID List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
Hardware ID configuration.
The hardware ID to remove from the Criteria.
No Content
Remove a device from the Device List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
Device configuration.
The name of the client device to remove from the Criteria.
No Content
Remove a gateway IP from the Gateway IP List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
Gateway IP configuration.
The IP of the gateway to remove from the Criteria.
No Content
Retrieve Criteria Security Principal List of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Retrieve Criteria Security Principal List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Remove a device from the Device List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Device configuration.
The name of the client device to remove from the Criteria.
No Content
Remove a hardware ID from the Hardware ID List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Hardware ID configuration.
The hardware ID to remove from the Criteria.
No Content
Remove a gateway IP from the Gateway IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Gateway IP configuration.
The IP of the gateway to remove from the Criteria.
No Content
Remove an IP from the IP List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
IP configuration.
Value that represents the IP
IP Version
No Content
Retrieve Criteria IP List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
IPv4 criteria list
IPv6 criteria list
Remove an IP from the IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
IP configuration.
Value that represents the IP
IP Version
No Content
Remove a theme from the Theme List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Theme configuration.
The ID of the theme to remove from the Criteria.
No Content
Delete a RAS Printing settings font from a site.
ID of the site from which the font will be deleted (optional)
RAS Printing settings font
Auto Install Font Name.
No Content
Modify application package settings tags.
The ID of the application settings tag to modify.
The Site ID for which to modify the application package settings tags (optional).
Application package settings tags.
The name of the application package settings tags to be modified.
No Content
Modify application package settings.
The Site ID for which to modify the application package settings. (optional).
Application package settings.
Enable or disable the application packages.
Enable or Disable automatic provision of application package certificates.
No Content
Remove a user, group or machine from the Security Principal List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
SecurityPrincipal configuration.
The name of the account to remove from the Criteria.
The SID of the account to remove from the Criteria.
No Content
Remove a user, group or machine from the Security Principal List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
SecurityPrincipal configuration.
The name of the account to remove from the Criteria.
The SID of the account to remove from the Criteria.
No Content
Remove a user, group or machine from the Security Principal List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
SecurityPrincipal configuration.
The name of the account to remove from the Criteria.
The SID of the account to remove from the Criteria.
No Content
Retrieve AD Integration Settings.
The Site ID for which to retrieve the AD Integration Settings. (optional)
Success
The site ID to which the AD integration settings refer to.
Certificate authority
Principal name in UPN format that will enroll certificates on behalf of other users.
Username of the network level authentication
Add a device to the Device List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Device configuration.
The name of the client device to add to the Criteria.
Created
Add a hardware ID to the Hardware ID List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Hardware ID configuration.
The hardware ID to add to the Criteria.
Created
Modify properties of a logon hours setting.
The ID of the logon hours setting to modify.
Logon hours settings
Enable or disable the specified logon hours rule in a Site.
The new name of the target logon hours rule.
A user-defined LogonHours description.
No Content
Move the specified RAS logon hours setting up or down.
RAS Logon Hour ID
RAS Logon Hours
Move Direction.
No Content
Add a hardware ID to the Hardware ID List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
Hardware ID configuration.
The hardware ID to add to the Criteria.
Created
Add a device to the Device List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
Device configuration.
The name of the client device to add to the Criteria.
Created
Add a device to the Device List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Device configuration.
The name of the client device to add to the Criteria.
Created
Add a hardware ID to the Hardware ID List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Hardware ID configuration.
The hardware ID to add to the Criteria.
Created
Remove an IP from the IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
IP configuration.
Value that represents the IP
IP Version
No Content
Retrieve Criteria Security Principal List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Retrieve Criteria IP List of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).
Success
IPv4 criteria list
IPv6 criteria list
Add an IP to the IP List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
IP configuration.
Value that represents the IP
IP Version
Created
Retrieve Criteria IP List of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
IPv4 criteria list
IPv6 criteria list
Add an IP to the IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
IP configuration.
Value that represents the IP
IP Version
Created
Add a gateway IP to the Gateway IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Gateway IP configuration.
The IP of the gateway to add to the Criteria.
The ID of the gateway to add to the Criteria.
Created
Add a gateway IP to the Gateway IP List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
Gateway IP configuration.
The IP of the gateway to add to the Criteria.
The ID of the gateway to add to the Criteria.
Created
Add a gateway IP to the Gateway IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Gateway IP configuration.
The IP of the gateway to add to the Criteria.
The ID of the gateway to add to the Criteria.
Created
Add a user, group or machine to the Security Principal List of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
SecurityPrincipal configuration.
The name of the account to add to the Criteria.
The SID of the account to add to the Criteria.
Created
Add a user, group or machine to the Security Principal List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
SecurityPrincipal configuration.
The name of the account to add to the Criteria.
The SID of the account to add to the Criteria.
Created
Add a user, group or machine to the Security Principal List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
SecurityPrincipal configuration.
The name of the account to add to the Criteria.
The SID of the account to add to the Criteria.
Created
Retrieve Criteria OS of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
Update the MFA Deepnet settings.
The id for which to modify the MFA settings.
MFA settings.
The new name of the target multi-factor authentication .
A user-defined multi-factor authentication description.
Enable or disable the specified multi-factor authentication in a site.
If true default criteria settings will be inherited.
No Content
Update the Radius MFA Site Settings.
The ID for which to modify the MFA Radius settings.
MFA settings.
The new name of the target multi-factor authentication .
A user-defined multi-factor authentication description.
Enable or disable the specified multi-factor authentication in a site.
If true default criteria settings will be inherited.
No Content
Update the MFA Safenet settings.
The id for which to modify the MFA settings.
MFA settings.
The new name of the target multi-factor authentication .
A user-defined multi-factor authentication description.
Enable or disable the specified multi-factor authentication in a site.
If true default criteria settings will be inherited.
No Content
Retrieve Criteria OS of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).
Success
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
Retrieve Criteria OS of a session server with the specified ID.
The ID of a session server for which to retrieve the Criteria settings.
Success
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
Add a theme to the Theme List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
Theme configuration.
The name of the theme to add to the Criteria.
The ID of the theme to add to the Criteria.
Created
Retrieve an Application Package Version by Name.
Application Package Name
Site ID from which to retrieve the Application Package version (optional).
Success
Application version
Application version tag name
Application version tag ID
Update settings of a remote session
ID of the site for which the remote session settings will be updated
Remote session settings
Set the session idle timeout (in seconds).
Set the client logoff timeout (in seconds).
Set the cached session timeout (in seconds).
FIPS Mode Setting
Whether to replicate settings to other sites.
No Content
Modify properties of a custom route.
The ID of the custom route to modify.
Custom route settings
The new name of the Custom Route.
A user-defined Custom Route description.
Public Address of the Custom Route
Port of the Custom Route
SSL Port of the Custom Route
No Content
Modify AD Integration Settings.
The Site ID for which to modify the AD Integration Settings. (optional)
AD Integration Settings.
Certificate authority
Username of the enrollment agent
Password of the account specified in the EnrollmentAgentUsername parameter.
Principal name in UPN format used to initialize the RDP session.
Password of the account specified in the NLAUsername parameter.
No Content
Modify the OS of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
OS configuration.
Allow Chrome OS clients.
Allow Android clients.
Allow Web clients.
Allow IOS clients.
Allow Linux clients.
Allow Mac clients.
Allow Windows clients.
Allow Wyse clients.
No Content
Modify the OS of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
OS configuration.
Allow Chrome OS clients.
Allow Android clients.
Allow Web clients.
Allow IOS clients.
Allow Linux clients.
Allow Mac clients.
Allow Windows clients.
Allow Wyse clients.
No Content
Add an IP to the IP List of the Criteria settings.
The ID of a session server for which to modify the Criteria settings.
IP configuration.
Value that represents the IP
IP Version
Created
Retrieve Parallels RAS CPU Optimization Settings.
The Site ID for which to retrieve the Parallels RAS CPU Optimization settings. (optional)
Success
Whether the "CPU Optimization" option is enabled or disabled.
The CPU usage percentage above which the CPU Optimization will start working.
The CPU usage percentage above which a process will be set to idle priority.
The CPU usage percentage below which a process will be set to realtime priority.
Whether the "Replicate settings" option (replicate settings to all sites) is enabled or disabled.
Specifies items in the CPUExclude list
The site ID to which the RAS CPU Optimization settings refer.
Modify the OS of the Criteria settings.
The Site ID of an object for which to modify the Criteria settings (optional).
OS configuration.
Allow Chrome OS clients.
Allow Android clients.
Allow Web clients.
Allow IOS clients.
Allow Linux clients.
Allow Mac clients.
Allow Windows clients.
Allow Wyse clients.
No Content
Retrieves a notification script by ID
Notification script ID
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Retrieve the FSLogix Profile Containers Feature Site Settings.
The Site ID for which to retrieve the FSLogix Profile Containers Feature settings.
Success
Site ID to which the FSLogix settings are applied
Install Type values.
URL for Online installation
Path for the Network Drive
Name of the Installer file
Whether the replication of the settings to other sites is enabled or not
Retrieves a list of notification script information
Site ID for which to retrieve notification scripts (optional)
Filter the result by notification name (optional)
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Update the FSLogix Profile Containers Feature Site Settings.
The Site ID for which to modify the FSLogix Profile Containers Feature settings.
FSLogix Features settings.
Install Type values.
Specifies the 'Install Online URL Online'.
Specifies the 'Network Drive Path'.
Specifies the 'Installer File Path'.
Enable or disable replication of settings to other sites.
No Content
Update Parallels RAS CPU Optimization Settings.
The Site ID for which to modify the Parallels RAS CPU Optimization settings (optional).
CPU Optimization settings.
Specifies items in the CPUExclude list.
The CPU usage percentage above which the CPU Optimization will start working.
The CPU usage percentage above which a process will be set to idle priority.
The CPU usage percentage below which a process will be set to realtime priority.
Enables or disables the "CPU Optimization" option.
Enables or disables the "Replicate settings" option (replicate settings to all sites).
No Content
Validate the AD Integration Settings
RAS Agent Server name
Site ID in which to modify the specified server.
RAS Agent server
Certificate authority
Username of the enrollment agent
Password of the account specified in the EnrollmentAgentUsername parameter.
Principal name in UPN format used to initialize the RDP session.
Password of the account specified in the NLAUsername parameter.
Success
The site ID to which the AD integration settings refer to.
Certificate authority
Principal name in UPN format that will enroll certificates on behalf of other users.
Username of the network level authentication
Retrieve a list of all remote session settings.
Site ID for which to retrieve all remote session settings (optional).
Success
FIPS Mode Setting
The session idle timeout (in seconds).
The client logoff timeout (in seconds).
The cached session timeout (in seconds).
Whether to replicate settings to other sites.
ID of the Site.
Retrieve application package settings.
The Site ID for which to retrieve the application package settings. (optional)
Success
ID of the Site for application packages settings
Whether the application packages feature is enabled or not
Application version tags
Application version tag ID
Application version tag name
Provision package certificates automatically
Update script notification by ID.
Script notification ID
Set script notification
A new script name to assign.
Command to execute when invoked.
Command arguments.
Script base directory.
Execute script as this system user.
System user password.
No Content
Retrieve a Radius Attribute List.
The ID of a MFA for which to retrieve the Radius Attribute.
Success
RADIUS attribute vendor ID
RADIUS attribute ID
RADIUS attribute type
RADIUS attribute name
RADIUS attribute vendor name
RADIUS attribute Value
Delete a Radius Attribute from a site.
The ID of a RadiusAttr to remove from the site.
The MFA Radius Attr Proc Model.
RADIUS attribute vendor ID
RADIUS attribute ID
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.
RADIUS attribute name
RADIUS attribute vendor name
RADIUS attribute type
No Content
Creates a new notification script
A script can be attached to any of the notifications.
Script name.
Site ID If the parameter is omitted, the site ID of the Licensing Server will be used.
Command to execute when invoked.
Command arguments. Possible values: ($CA), ($ENROLLMENTMETHOD), ($FARM-NAME), ($HOSTPOOL), ($LOCATION), ($NOTIFICATION-TIME), ($NOTIFICATION-TYPE), ($PROVIDER), ($RESOURCEGROUP), ($SERVER-ADDRESS), ($SITE-NAME), ($TENANTBROKER), ($TENANTNAME), ($THRESHOLD-DIRECTION), ($THRESHOLD-VALUE), ($TRIGGER-ADDRESS), ($WORKSPACE)
Script base directory
Execute script as this system user.
System user password.
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Retrieve information about one or multiple MFA.
Site ID from which to retrieve the Multi Factor Authentication information (optional).
The name of the multi factor authentication for which to retrieve the information. This must be the actual MFA name used in the RAS farm.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Retrieve information about one or multiple logon hours setting.
Site ID from which to retrieve the logon hours setting (optional).
The name of the logon hours setting for which to retrieve the information. This must be the actual logon hours setting name used in the RAS connections.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the logon hours rule
Site ID
Description of the logon hours rule
Whether the logon hours rule is enabled or not
Order of the logon hours rule
Logon Hours Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Themes Criteria
Whether the Themes Criteria is enabled or not
Matching mode type options
Theme criteria list
Permitted Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Retrieve information about one custom route by ID.
The ID of a custom route for which to retrieve the information.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the Custom Route
Site ID
Description of the Custom Route
Public Address of the Custom Route
Port of the Custom Route
SSL Port of the Custom Route
Retrieve information about one or multiple custom routes.
Site ID from which to retrieve the custom route information (optional).
The name of the custom route for which to retrieve the information.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the Custom Route
Site ID
Description of the Custom Route
Public Address of the Custom Route
Port of the Custom Route
SSL Port of the Custom Route
Modify printing settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Site ID (optional)
RAS Printing settings
Printer Drivers string array.
Excluded Fonts string array.
Printer Name Pattern. Default pattern: %PRINTERNAME% for %USERNAME% by Parallels Valid pattern variables: %PRINTERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Printer
Embed Fonts.
Replicate Printer Font Settings.
Replicate Printer Name Pattern Settings.
Replicate Printer Drivers Settings.
Printer Driver Allow Mode.
No Content
Retrieve the client settings
Site ID from which to retrieve the Client settings (optional).
Success
Exclude Direct RDP Connections for terminal servers.
Exclude Direct RDP Connections for VDI.
Enable or disable Sending HD Icons.
Enable replicate Sending HD Icons.
Enable or disable Overlay Icons (deprecated).
Overlay Icon Type.
Show or hide Password Expiry reminder.
Enable or disable Force sessions reset when client performs a logoff.
Token Validation Time. The time for a validation token to expire in minutes.
Add a new Radius Attribute.
MFA settings
MFA Radius Attribute settings
RADIUS attribute vendor ID
RADIUS attribute ID
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.
RADIUS attribute name
RADIUS attribute vendor name
RADIUS attribute type
Created
RADIUS attribute vendor ID
RADIUS attribute ID
RADIUS attribute type
RADIUS attribute name
RADIUS attribute vendor name
RADIUS attribute Value
Read and return MFA Vendor details from an ini file.
Vendor Details file to be uploaded.
Success
Vendor Id.
Vendor Name.
Vendor Attributes.
Vendor Attribute Id.
Vendor Attribute Name.
RADIUS attribute type
Retrieve information about day plan properties from the logon hours setting.
The ID for which to retrieve the Day Plan settings.
Success
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Retrieve information about MFA Radius Auto Info List.
The ID of a MFA for which to retrieve the MFA Radius Auto Info List.
Success
ID of the object.
Priority of the object.
Whether the RADIUS Automation autoSend is enabled or not
RADIUS Automation command
Whether RADIUS Automation is enabled/disabled
Image Type
RADIUS Description
RADIUS Action Message
RADIUS Automation title
Duplicate a Multi Factor Authentication.
The ID of the Multi Factor Authentication to duplicate
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Retrieves a notification configuration.
Notification ID
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Update Radius Auto Info from a site.
The ID of a MFA to update a RadiusAutoInfo from the site.
The ID of a RadiusAutoInfo to update.
Radius Auto Info entry.
Whether the RADIUS Automation autoSend is enabled or not
RADIUS Automation command
Whether the RADIUS Automation is enabled/disabled
Image Type
RADIUS Automation description
RADIUS Automation action message
RADIUS Automation title
Move Direction.
No Content
Modify properties of day plan properties from the logon hours setting.
The ID for which to modify the Day Plan.
Day Plan Settings.
RAS Day Plan Object Types
Permit Or Deny
Week Days
Hour Plan
No Content
Retrieve information about RAS printing settings.
Site ID for which to retrieve the RAS universal printing settings (optional)
Success
Whether Embed Fonts is enabled or not.
Whether the option "Replicate Printer Font Settings" is enabled or not..
Whether the option "Replicate Printer Name Pattern Settings" is enabled or not.
Whether the option "Replicate Printer Drivers Settings" is enabled or not.
Printer Driver Allow Mode.
Printer Drivers string array.
Excluded Fonts string array.
Auto Installed Fonts.
Printer Name Pattern.
Retrieve the criteria settings of a logon hours setting with the specified ID.
The ID of a logon hours setting for which to retrieve the criteria settings.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the logon hours rule
Site ID
Description of the logon hours rule
Whether the logon hours rule is enabled or not
Order of the logon hours rule
Logon Hours Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Themes Criteria
Whether the Themes Criteria is enabled or not
Matching mode type options
Theme criteria list
Permitted Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Update the Criteria settings of an MFA with the specified ID.
The ID of an MFA for which to modify the Criteria settings.
Criteria settings.
Access type options
Whether the Security Principals criteria is enabled or not
Matching mode type options
Whether the Gateways criteria is enabled or not
Matching mode type options
Whether the Devices criteria is enabled or not
Matching mode type options
Whether the OSs criteria is enabled or not
Matching mode type options
Whether the IPs criteria is enabled or not
Matching mode type options
Whether the HardwareIDs criteria is enabled or not
Matching mode type options
No Content
Add a new Radius Auto Info to a site.
MFA settings
MFA Radius Auto Info
RADIUS Automation command
Whether the RADIUS Automation is enabled/disabled
Image Type
RADIUS Automation title
RADIUS Automation action message
RADIUS Automation description
Created
ID of the object.
Priority of the object.
Whether the RADIUS Automation autoSend is enabled or not
RADIUS Automation command
Whether RADIUS Automation is enabled/disabled
Image Type
RADIUS Description
RADIUS Action Message
RADIUS Automation title
Modify Client Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
The Site ID for which to modify the Client settings (optional).
Client Settings
The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.
Exclude Direct RDP Connections for terminal servers.
Exclude Direct RDP Connections for VDI.
Enable or disable Sending HD Icons.
Enable or disable replicate Sending HD Icons.
Overlay Icon Type.
Show or hide Password Expiry reminder.
Enable or disable Force sessions reset when client performs a logoff.
Token Validation Time. The time for a validation token to expire in minutes.
No Content
Update the Criteria settings of a MFA Default object.
The SiteId of a MFA Default object for which to modify the Criteria settings (optional).
MFA Criteria settings (optional).
Access type options
Whether the Security Principals criteria is enabled or not
Matching mode type options
Whether the Gateways criteria is enabled or not
Matching mode type options
Whether the Devices criteria is enabled or not
Matching mode type options
Whether the OSs criteria is enabled or not
Matching mode type options
Whether the IPs criteria is enabled or not
Matching mode type options
Whether the HardwareIDs criteria is enabled or not
Matching mode type options
No Content
Retrieves a notification event by ID
Notification event ID
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Create a new logon hours setting.
Logon hours settings
The name of the target logon hours rule. This must be the actual logon hours rule name used in the RAS Farm.
Enable or disable the logon hours rule upon creation. If the parameter is omitted, the logon hours rule is initialised as disabled.
A user-defined logon hours rule description.
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the logon hours rule
Site ID
Description of the logon hours rule
Whether the logon hours rule is enabled or not
Order of the logon hours rule
Logon Hours Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Themes Criteria
Whether the Themes Criteria is enabled or not
Matching mode type options
Theme criteria list
Permitted Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Retrieves all notification events configurations
Site ID for which to retrieve notification events (optional)
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Retrieve Parallels RAS LB Settings.
The Site ID for which to retrieve the Parallels RAS LB settings. (optional)
Success
LBMethod
Whether the CPU counter is enabled or disabled.
Whether the Memory counter is enabled or disabled.
Whether the Sessions counter is enabled or disabled.
Whether the "Reconnect to disconnected sessions" option is enabled or disabled.
Whether the "Reconnect sessions using client's IP address only" option is enabled or disabled.
Whether the "Limit user to one session per desktop" option is enabled or disabled.
Whether the "Disable Microsoft RD Connection Broker" option is enabled or disabled.
The value (in number of seconds) of the "Declare Agent dead if not responding for" property.
The value (in number of seconds) of the "Agent Refresh Time" property.
Maximum number of connection requests for an Agent.
Whether the "Replicate settings" option (replicate settings to all sites) is enabled or disabled.
The site ID to which the RAS LB settings refer.
Retrieve the Criteria settings of a MFA Default object.
The SiteId of a MFA Default object for which to retrieve the Criteria settings (optional).
Success
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Retrieves all resource notifications configurations.
Site ID for which to retrieve notifications (optional)
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Threshold direction
Retrieve the Criteria settings of an MFA with the specified ID.
The ID of an MFA for which to retrieve the Criteria settings.
Success
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Update event notification by ID.
Event notification ID
Set event notification
Enable/Disable notification.
Notification grace period (minutes).
Enable/Disable grace period.
Notification recipients.
Enable/Disable email notification.
Use script of given ID.
Enable/Disable notification scripts.
Notification interval (minutes).
Enable/Disable notification intervals.
Wait until recovered.
All servers in site.
Target Type
Target IDs.
No Content
Retrieves all notification configurations.
Site ID for which to retrieve notifications (optional)
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Modify Parallels RAS LB Settings.
The Site ID for which to modify the Parallels RAS LB settings. (optional)
LB settings.
LBMethod
Enable or disable the CPU counter.
Enable or disable the Memory counter.
Enable or disable the Sessions counter.
Enable or disable the "Reconnect to disconnected sessions" option.
Enable or disable the "Reconnect sessions using client's IP address only" option.
Enable or disable the "Limit user to one session per desktop" option.
Enable or disable the "Disable Microsoft RD Connection Broker" option.
Set the value (number of seconds) of the "Declare Agent dead if not responding for" property.
Set the value (number of seconds) of the "Agent Refresh Time" property.
Enable or disable the "Replicate settings" option (replicate settings to all sites).
Maximum number of connection requests for an Agent.
No Content
Retrieve a specific resource notification by ID.
Notification resource ID
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Threshold direction
Retrieve the MFA Default settings.
Site ID for which to retrieve MFA Default settings (optional)
Success
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Site ID
Create a new custom route.
Custom route settings
The name of the Custom Route.
Site ID in which to add the specified Custom Route. If the parameter is omitted, the site ID of the Licensing Server will be used.
A user-defined Custom Route description.
Public Address of the Custom Route
Port of the Custom Route. Default: 80
SSL Port of the Custom Route. Default: 443
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the Custom Route
Site ID
Description of the Custom Route
Public Address of the Custom Route
Port of the Custom Route
SSL Port of the Custom Route
Update the criteria settings of a logon hours setting with the specified ID.
The ID of a logon hours setting for which to modify the criteria settings.
Criteria settings.
Whether the Security Principals criteria is enabled or not
Matching mode type options
Whether the Gateways criteria is enabled or not
Matching mode type options
Whether the Themes criteria is enabled or not
Matching mode type options
Whether the Devices criteria is enabled or not
Matching mode type options
Whether the OSs criteria is enabled or not
Matching mode type options
Whether the IPs criteria is enabled or not
Matching mode type options
Whether the HardwareIDs criteria is enabled or not
Matching mode type options
No Content
Update resource notification by ID.
Resource notification ID
Set resource notification
Enable/Disable notification.
Notification grace period (minutes).
Enable/Disable grace period.
Notification recipients.
Enable/Disable email notification.
Use script of given ID.
Enable/Disable notification scripts.
Notification interval (minutes).
Enable/Disable notification intervals.
Wait until recovered.
All servers in site.
Target Type
Target IDs.
Tolerance value which triggers notification.
Threshold direction
No Content
A configuration of an event notification such as license activation, agent disconnect/connect etc
Creates notifications for events such as license activation, agent disconect/connect etc.
Site ID where notification event is setup. Current site ID is used if siteId is omitted.
Grace period after the notification was done (minutes).
Enable/Disable grace period.
Recipients to notify of the event.
Enable/Disable email notification.
Script to execute which has this ID.
Invocation interval (minutes).
Enable/Disable notification intervals.
Wait until recovered.
All servers in site.
Target Type
Target Ids.
RAS Notification Event Type
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Retrieve information about one MFA by ID.
The ID of a MFA for which to retrieve the information.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Retrieve a list of all the settings for RAS allowed devices
Site ID for which to retrieve all the settings for RAS allowed devices (optional)
Success
Whether clients with security patches installed are only allowed to connect.
Whether ChromeApp clients are allowed or not
Whether Android clients are allowed or not.
Whether Web clients are allowed or not.
Whether IOS clients are allowed or not.
Whether Linux clients are allowed or not.
Whether MAC clients are allowed or not.
Allow Mode
Whether Windows clients are allowed or not.
Whether Wyse clients are allowed or not.
Whether replication of settings to other sites is enabled or not.
The site ID to which the allowed device settings refer.
Represents the minimum build required for the ChromeApp client.
Represents the minimum build required for the Android client.
Represents the minimum build required for the Web client.
Represents the minimum build required for the IOS client.
Represents the minimum build required for the Linux client.
Represents the minimum build required for the MAC client.
Represents the minimum build required for the Windows client.
Represents the minimum build required for the Wyse client.
A configuration of a resource notification such as high/low RAM/CPU usage etc.
Creates a resource notification such as high/low RAM/CPU usage etc.
Site ID where notification event is setup. Current site ID is used if siteId is omitted.
Grace period after the notification was done (minutes).
Enable/Disable grace period.
Recipients to notify of the event.
Enable/Disable email notification.
Script to execute which has this ID.
Invocation interval (minutes).
Enable/Disable notification intervals.
Wait until recovered.
All servers in site.
Target Type
Target Ids.
RAS Notification Type
Tolerance value which triggers notification.
Threshold direction
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Type of notification
Target Type
Threshold direction
Update settings of a RAS allowed device
ID of the site for which the RAS Allowed device settings will be updated
RAS allowed device settings
Allow clients with security patches only.
Allow Mode
Allow ChromeApp clients.
Allow Android clients.
Allow Web clients.
Allow IOS clients.
Allow Linux clients.
Allow Mac clients.
Allow Windows clients.
Allow Wyse clients.
Enable/disable replication of settings to other sites.
Represents the minimum build required for the Chromeapp client.
Represents the minimum build required for the Droid client.
Represents the minimum build required for the Web client.
Represents the minimum build required for the IOS client.
Represents the minimum build required for the Linux client.
Represents the minimum build required for the Mac client.
Represents the minimum build required for the Windows client.
Represents the minimum build required for the Wyse client.
No Content
Retrieve information about a particular logon hours setting by ID.
The ID of the logon hours setting for which to retrieve the information.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name of the logon hours rule
Site ID
Description of the logon hours rule
Whether the logon hours rule is enabled or not
Order of the logon hours rule
Logon Hours Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Themes Criteria
Whether the Themes Criteria is enabled or not
Matching mode type options
Theme criteria list
Permitted Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Hour Plan
Create a new Safenet MFA.
MFA settings
The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.
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.
A user-defined Multi Factor Authentication description.
Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.
SafeNet Authentication Mode
OTP Service URL
A value representing User Store
The URL of the web service
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
SafeNet Authentication Mode
OTP Service URL
A value representing User Store
The URL of the web service
Create a new Deepnet MFA.
MFA settings
The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.
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.
A user-defined Multi Factor Authentication description.
Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.
Whether the activation email is enabled or disabled.
Whether the activation SMS is enabled or disabled.
A value that represents the application name.
A value that represents the application ID.
Deepnet Authentication Mode
A value that represents the name of Deepnet Agent.
A value that represents the Default Domain.
Whether SSL is allowed or not.
The server of the second level authentication provider.
The port number of the second level authentication provider.
Token Type
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
Whether the activation email is enabled or disabled.
Whether the activation SMS is enabled or disabled.
A value that represents the application name.
A value that represents the application ID.
Deepnet Authentication Mode
A value that represents the name of Deepnet Agent.
A value that represents the Default Domain.
Whether SSL is allowed or not.
The server of the second level authentication provider.
The port number of the second level authentication provider.
Token Type
Create a new Radius MFA.
RADIUS Type
MFA settings
The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.
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.
A user-defined Multi Factor Authentication description.
Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.
The server of the second level authentication provider.
The port number of the second level authentication provider.
Password Encoding
Number of retries.
Connection timeout (in seconds).
RADIUS type name.
Specifies if forwarding of only the Username to RADIUS Server is enabled or not.
Specifies if forwarding of first password to Windows authentication provider is enabled or not.
The backup server of the second level authentication provider.
High Availability Mode
RADIUS setting. The secret key.
User message prompt
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
MFA Criteria
Security Principals Criteria
Whether the Security Principals Criteria is enabled or not
Matching mode type options
User criteria list
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Gateways Criteria
Whether the Gateways Criteria is enabled or not
Matching mode type options
Gateway criteria list
The gateway IP.
OS Criteria Settings
Whether the OSs Criteria is enabled or not
Matching mode type options
Allowed Operating Systems
Whether Chrome is allowed or not.
Whether Android is allowed or not.
Whether Web Client is allowed or not.
Whether iOS is allowed or not.
Whether Linux is allowed or not.
Whether MAC OS is allowed or not.
Whether Wyse is allowed or not.
Whether Windows is allowed or not.
IPs Criteria
Whether the IPs Criteria is enabled or not
Matching mode type options
Allowed IPs Criteria
IPv4 criteria list
IPv6 criteria list
Hardware IDs Criteria
Whether the Hardware IDs Criteria is enabled or not
Matching mode type options
Hardware IDs criteria list
The hardware ID.
Access type options
Devices Criteria
Whether the Devices Criteria is enabled or not
Matching mode type options
Client criteria list
The name of the client device.
The server of the second level authentication provider.
The port number of the second level authentication provider.
Password Encoding
Number of retries.
Connection timeout (in seconds).
RADIUS type name.
Specifies if forwarding of only the Username to RADIUS Server is enabled or not.
Specifies if forwarding of first password to Windows authentication provider is enabled or not.
The backup server of the second level authentication provider.
High Availability Mode
List of the RADIUS attribute information.
RADIUS attribute vendor ID
RADIUS attribute ID
RADIUS attribute type
RADIUS attribute name
RADIUS attribute vendor name
RADIUS attribute Value
List of the RADIUS Automation information.
ID of the object.
Priority of the object.
Whether the RADIUS Automation autoSend is enabled or not
RADIUS Automation command
Whether RADIUS Automation is enabled/disabled
Image Type
RADIUS Description
RADIUS Action Message
RADIUS Automation title
List of Ignored Errors.
User message prompt
Retrieve the proxy settings
Success
HTTP Proxy Mode
The HTTP Proxy Address.
The HTTP Proxy User.
The HTTP Proxy Port.
Whether HTTP Proxy requires authentication or not.
Modify Proxy Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Site Id to retrieve Proxy Settings
Proxy Settings
The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.
HTTP Proxy Mode
HTTP Proxy Address.
A custom Proxy port number.
HTTP Proxy Password.
HTTP Proxy User.
HTTP Proxy Requires Authentication: Enable (True) or disable (False).
No Content
Retrieve information about RAS scanning settings.
Site ID for which to retrieve the RAS universal scanning settings (optional)
Success
TWAIN Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Scanner
Whether to Replicate TWAIN Pattern or not.
WIA Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID%
Whether to Replicate WIA Pattern or not.
Specifies items in the TWAIN Applications list.
Whether to replicate TWAIN Applications or not.
Update scanning settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Site ID (optional)
RAS Scanning settings
WIA Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID%
Replicate WIA pattern.
TWAIN Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Scanner
Replicate TWAIN Pattern.
Specifies items in the TWAIN Applications list.
Replicate TWAIN Applications.
No Content
Joins a Tenant Broker.
Site ID from which to retrieve the Tenant Broker settings (optional).
TenantBroker settings
This can be the Tenant Broker secret key located at Farm | Settings | Tenant Broker, or the Tenant invitation hash created at Farm | Tenants | Add.
The IP or DNS address of the Tenant Broker to join.
The Tenant name. Applicable only if Farms are allowed to register using a secret key.
The accessible name. Applicable only if Farms are allowed to register using a secret key.
No Content
Retrieve the status of the Tenant Broker.
Site ID from which to retrieve the Tenant Broker settings (optional).
Success
Retrieve the System settings
Success
Whether CEP Is Enabled or not
The Time to reset idle session
Modify System Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Site ID
System Settings
Customer Experience Program: Enable (True) or disable (False).
HTTP Proxy Mode
Reset RAS Console Idle session after (minutes).
No Content
Retrieve a Windows device group's Inbound ports by ID.
Windows device group Id
Success
Port number.
Connection Protocol type.
Profile Setting.
Add an Inbound port to a Windows device group by ID.
Windows device group Id
Windows device group Inbound port settings
The Port to add to the windows device group.
Connection Protocol type.
Profile Setting.
Created
Remove an Inbound port from a Windows device group by ID.
Windows device group Id
Windows device group Inbound port settings
The Port of the Windows Device Group to remove.
Connection Protocol type.
Profile Setting.
No Content
Add URL Redirection Entry.
The Site ID for which to modify the URL Redirection Settings. (optional)
URL Redirection Entry settings.
Whether the URL redirection will be enabled or disabled.
The URL to redirect or not.
Redirect action type options
No Content
Retrieve URL Redirection Entry.
The Id for which to retrieve the URL Redirection Entry
The Site ID for which to modify the URL Redirection Settings. (optional)
Success
ID of the object.
Priority of the object.
Whether the url entry rule is enabled or not.
The URL pattern.
Redirect action type options
Update URL Redirection Entry.
The ID for which to modify the URL Redirection Entry.
The Site ID for which to modify the URL Redirection Settings. (optional)
URL Redirection Entry settings.
Whether the URL redirection will be enabled or disabled.
The URL to redirect or not.
Redirect action type options
Move Direction.
No Content
Remove URL Redirection Entry.
The ID for which to Remove the URL Redirection Entry.
The Site ID for which to modify the URL Redirection Settings. (optional)
No Content
Unjoins a Tenant Broker.
Site ID from which to retrieve the Tenant Broker settings (optional).
No Content
Retrieve URL Redirection Settings.
The Site ID for which to retrieve the URL RedirectionSettings. (optional)
Success
The site ID to which the URL redirection settings refer to.
Redirect action type options
Whether the 'Replicate Settings' option is enabled or not.
The URL redirect list.
ID of the object.
Priority of the object.
Whether the url entry rule is enabled or not.
The URL pattern.
Redirect action type options
Modify URL Redirection Settings.
The Site ID for which to modify the URL Redirection Settings. (optional)
URL Redirection Settings.
Redirect action type options
Whether the 'Replicate Settings' option is enabled or not.
No Content
Retrieve a list of Windows device groups.
Site ID for which to retrieve the Windows device group (optional).
Filter the result by Windows device group name (optional).
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
The ID of the Site from which to retrieve the Windows device group.
Windows device group name
Description of the Windows device group
Whether Removeable drives are disabled or not.
Whether Print Screens are disabled or not.
Whether the Replace Desktop option is enabled or not.
Whether the Kiosk Mode option is enabled or not.
Whether the Use Client As Desktop option is enabled or not.
Whether the Firewall option is enabled or not.
The Inbound Ports.
Port number.
Connection Protocol type.
Profile Setting.
Whether the Request Authorization option is enabled or not.
Create a new Windows device group.
Windows device group settings
Name of the new Windows Device Group.
Description of the new Windows Device Group.
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
The ID of the Site from which to retrieve the Windows device group.
Windows device group name
Description of the Windows device group
Whether Removeable drives are disabled or not.
Whether Print Screens are disabled or not.
Whether the Replace Desktop option is enabled or not.
Whether the Kiosk Mode option is enabled or not.
Whether the Use Client As Desktop option is enabled or not.
Whether the Firewall option is enabled or not.
The Inbound Ports.
Port number.
Connection Protocol type.
Profile Setting.
Whether the Request Authorization option is enabled or not.
Retrieve a specific Windows device group by ID.
Windows device group Id
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
The ID of the Site from which to retrieve the Windows device group.
Windows device group name
Description of the Windows device group
Whether Removeable drives are disabled or not.
Whether Print Screens are disabled or not.
Whether the Replace Desktop option is enabled or not.
Whether the Kiosk Mode option is enabled or not.
Whether the Use Client As Desktop option is enabled or not.
Whether the Firewall option is enabled or not.
The Inbound Ports.
Port number.
Connection Protocol type.
Profile Setting.
Whether the Request Authorization option is enabled or not.
Update Windows device group settings.
Windows device group ID.
Windows device group settings.
Modify the description of the Windows Device Group.
Modify the description of the Windows Device Group.
Enable or disable the Windows Device Group.
Enable or disable Removeable Drives.
Enable or disable Print Screens.
Enable or disable the Replace Desktop option.
Enable or disable Kiosk Mode.
Enable or disable the Client As Desktop option.
The Admin Mode Passoword.
Enable or disable Firewall option.
Enable or disable the Request Authorization option.
No Content
Delete a Windows device group by ID.
No Content