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...
Log off user. User must be authenticated first.
Success
Export the complete Parallels RAS farm configuration to a file available for download. This functionality can be used to back up farm settings.
Success
After any of the Parallels RAS farm settings modifications, settings must be applied to commit the changes. This is equivalent of clicking the Apply button on the main Parallels RAS Console window.
Specifies if waiting for all PAs to sync is needed.
No Content
Invoke the RAS Admin Session to send the LogOff command for the Admin with specified Session ID.
Session ID of the Admin to be Disconnected.
No Content
This can be used to Import and change the PFX Certificate within Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.
Upload File
No Content
Retrieve the Performance Monitor Settings.
Success
Enable or disable RAS Performance Monitor.
Server hosting RAS Performance Monitor database.
Connection Port to the Server hosting RAS Performance Monitor database.
Deactivate the current license key used by Parallels RAS.
License settings
The email address you use to log in to Parallels My Account.
Your Parallels account password.
No Content
Sends an invitation email using the current configuration of the Parallels RAS Invitation.
Send RAS invitation email using the current configuration of the Parallels RAS invitation.
Recipients email address(s) for the RAS invitation email. Can be a comma-separated list of multiple email addresses.
No Content
Sends a test email using the current configuration of the Parallels RAS mailbox.
Sends a test email using the current configuration of the Parallels RAS mailbox.
Destination email address(es) for the test email. Can be a comma-separated list of multiple addresses.
Created
Admin Account ID
Force Delete the Admin Account
No Content
Retrieve the farm settings
Success
The Name of the Farm.
Activate Parallels RAS using a valid license key. Also allows to activate Parallels RAS as a trial version. Trial version will be activated if the key is empty.
License settings.
The email address you use to log in to Parallels My Account.
Your Parallels account password.
Parallels RAS License Key. The key must be registered in Parallels My Account. To activate Parallels RAS as a trial version, omit this parameter.
Bind the license activation with a specific MAC address. The MAC address should be in the format XX-XX-XX-XX-XX-XX. To select a MAC address automatically, omit this parameter.
No Content
Modify the Performance Monitor Settings.
Performance Monitor Settings model
Enable or disable RAS Performance Monitor.
Server hosting RAS Performance Monitor database.
Connection Port to the Server hosting RAS Performance Monitor database.
No Content
Retrieves Parallels RAS mailbox settings.
Success
Use TLS / SSL (for Mailbox)
Modifies Parallels RAS mailbox settings.
Modifies the Parallels RAS mailbox configuration settings.
SMTP server name. Example: "mail.yourcompany.com:500"
Sender email address.
SMTP server user name.
SMTP server password.
Set whether SMTP server requires authentication.
Use TLS / SSL (for Mailbox)
No Content
Update a Custom Permission of an Admin Account. Specifying a SiteId is mandatory except for Monitoring and Reporting. To set a Permission for a specific object, provide an ObjId within the body. To set a Global Permission, do not provide an ObjId within the body.
Admin Account ID
Site ID for the permission being set (optional)
Custom Permission settings
ID of a particular RAS Farm object to assign permissions for.
Permission Object Types
Permission Flags
No Content
Retrieve the Invitation Email Settings
Success
Invitation Target Device
Invitation Connection Mode
Invitation Authentication Type
Retrieve a list of admin sessions. State=1 means that a session is Connected, while State=4 means that a session is Disconnected.
Success
ID of the object.
ID of the user of the session.
Session Logon Time.
IP of the session.
Session State
Computer name of the session.
Language
Modify Farm Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Site ID
Farm Settings
The new name of the specified Farm name.
No Content
Modify Invitation Email Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Invitation Email Settings
The email content to be sent in the invitation.
If this parameter is included, the body content will be replaced with the default body content.
Public Secure Gateway IP (IP:Gateway Port/SSL Port).
Third party credentials provider GUID (SSO).
Target Device List.
Invitation Target Device
Force to wrap third party SSO component.
Invitation Connection Mode
Invitation Authentication Type
No Content
Retrieve the Power Permissions of an Admin Account by ID.
Admin Account ID
Success
Admin account ID
Permission to do changes to RAS Site settings.
Permission to do changes to Connection settings.
Permission to manage user sessions.
Permission to manage client devices.
Permission for read mode access to RAS Reporting.
Permission for read mode access to the License Information.
Permission for read mode access to RAS Site information.
Permission to manage published resources.
Permission to manage RAS client Policies.
Permission for read mode to RAS client Policies.
Permission to manage all Sites in the Farm.
A list of site IDs which the administrator should be allowed to manage.
Retrieve an Admin Account by ID.
Admin Account 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.
Parallels RAS administrator user or group name.
Admin Type
Admin Notify
Whether this administrator is enabled or disabled in the farm.
The user email address.
The user mobile phone number.
Group name.
Whether the "Full Permissions" option is enabled or disabled.
Administrator type
Retrieve Admin Account(s).
Admin Account 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.
Parallels RAS administrator user or group name.
Admin Type
Admin Notify
Whether this administrator is enabled or disabled in the farm.
The user email address.
The user mobile phone number.
Group name.
Whether the "Full Permissions" option is enabled or disabled.
Administrator type
Retrieve the current license setting.
Specifies whether to retrieve the number of current licensed users from cache or calculate it on demand.
Success
License Type (Permanent, PrePaid, PostPaid, ExtTrial, LegacyTrial, or NormalTrial)
Expiry date of License
Maximum number of licensed users
Maximum amount of connected users since the product was installed (calculated together with the Usage Today).
Amount of users currently connected
State of Grace period
Days left for Grace period
License Type
RAS licensing requires attention.
The current status message of the RAS License.
The alert message a RAS Administrator should be notificed about.
Update a Power Permission of an Admin Account.
Admin Account ID
Power Permission settings
Enable or disable the "Allow Site changes" option.
Enable or disable the "Allow Publishing changes" option.
Enable or disable the "Allow Connection changes" option.
Enable or disable the "Allow viewing of RAS Reporting" option.
Enable or disable the "Allow viewing of License Information" option.
Enable or disable the "Allow viewing of Site Information" option.
Enable or disable the "Allow viewing of Policy Information" option.
Enable or disable the "Allow Session Management" option.
Enable or disable the "Allow Device Management changes" option.
Enable or disable the "Allow Policy changes" option.
Enable or disable the "All Sites" option. If enabled, the administrator can manage all sites in the farm. Otherwise, sites can be specified individually.
A list of site ids (an integer array) which the administrator should be allowed to manage.
No Content
Authenticate the user. When successful, an authorization token will be generated.
Authenticate with local machine to configure local Web Admin Settings. NOTE: Only localhost connections are allowed.
Contains the information about the session.
Parallels RAS administrator username.
Parallels RAS administrator password.
Success
The Authentication Token of the current session.
Specifies if the user is Locally Authenticated or with RAS Connection Broker.
The User ID connected to the current session.
Specifies if Settings need to be applied or not.
The Site ID to which the current session is connected to.
The current Settings ID.
The ID of the current session.
The Server that the current session is connected to.
The Licensing Server.
Specifies if the session is connected with the Primary Connection Broker of a Site.
Specifies if the session is connected is with the Licensing Server.
Specifies the Domain where the Connection Broker is installed.
Specifies the Farm Name.
Specifies the Farm GUID.
Retrieve the Reporting Settings.
Success
Enable or disable RAS Reporting functionality.
Minimum CPU change required to track the counter.
Minimum Memory change required to track the counter.
Enable or disable custom report.
Custom report folder name.
Port used by the service which receives data from the RAS Connection Broker. The default port is 30008.
The FQDN or IP address of the server where RAS Reporting is installed.
Enable or disable Username/Password credentials to connect to the Server hosting RAS Reporting.
Username to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).
How long the server counters information (such as CPU, Memory and number of sessions) is kept (in seconds).
Enable or disable Server counters information tracking.
How long information regarding the sessions opened on your servers is kept (in seconds).
Enable or disable Sessions information tracking.
Enable or disable logon details tracking.
How long to retain logon details.
Enable or disable tracking of user experience data.
How long to retain user experience data.
Track UX evaluator by user percentage choice.
Track Latency by user percentage choice.
Track bandwidth by user percentage choice.
Modify the Reporting Settings.
Reporting Configuration Settings model
Enable or disable RAS Reporting functionality.
Minimum CPU change required to track the counter.
Minimum Memory change required to track the counter.
Enable or disable custom report.
Custom report folder name.
Port used by the service which receives data from the RAS Connection Broker. The default port is 30008.
The FQDN or IP address of the server where RAS Reporting is installed.
Enable or disable Username/Password credentials to connect to the Server hosting RAS Reporting.
Username to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).
Password to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).
How long the server counters information (such as CPU, Memory and number of sessions) is kept (in seconds).
Enable or disable Server counters information tracking.
How long information regarding the sessions opened is kept (in seconds).
Enable or disable Sessions information tracking.
Enable or disable Logon information tracking.
How long information regarding the logon is kept (in seconds).
Enable or disable User experience tracking.
How long information regarding the user experience is kept (in seconds).
Track UX Evaluator when change is more than user input.
Track Delta latency when change is more than user input.
Track Delta bandwidth when change is more than user input.
No Content
Update Admin Account settings.
Admin Account ID
Admin Account settings
Parallels RAS administrator email address.
Parallels RAS administrator mobile phone number.
Enable or disable the specified administrator account.
Admin Notify
Administrator type
No Content
Create a new Admin Account.
Admin Account settings
The name of a user or group to add to the farm as an administrator.
The user email address.
The user mobile phone number.
Enables or disables this administrator in the farm.
Admin Notify
Administrator 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.
Parallels RAS administrator user or group name.
Admin Type
Admin Notify
Whether this administrator is enabled or disabled in the farm.
The user email address.
The user mobile phone number.
Group name.
Whether the "Full Permissions" option is enabled or disabled.
Administrator type
Retrieve the Custom Permissions of an Admin Account by ID.
Admin Account ID
Success
List of the site permissions
Site ID
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
The global permissions
The global permission
Permission Flags
The global permission
Permission Flags
The global permission
Permission Flags
Retrieve the version of the Remote Application Server Web Service.
Success
This can be used to import/restore farm configuration.
Upload File
No Content
Modify the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.
Web Admin settings
Specifies the Allowed Hosts.
Specifies the HTTPS URL.
Specifies whether to enable/disable Web Console.
Specifies the Web Console Base Path. The RAS Web Administration Server Service needs to be manually restarted for the BasePath change to be effective.
Specifies the Web Console Polling Interval.
Specifies whether to enable/disable REST.
Specifies the RAS Licensing Server.
Specifies the RAS Secondary Servers.
Specifies the Session Expiry time in minutes.
Specifies the Session Disconnect Delay in seconds.
No Content
Retrieve the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.
Success
Specifies the Allowed Hosts
The Kestrel configuration
The endpoints configuration
The HTTPS default certificate configuration
URL of the configuration
The Certificate Policy
Path where the certificate lies.
Encrypted Password of the certificate.
RAS Web Administration Service configuration
Web Console configuration
Whether the configuration is enabled or not.
Specifies the Web Console Base Path.
Specifies the Web Console Polling Interval.
Specifies the Web Console Log Level.
The REST configuration
Whether the REST configuration is enabled or not.
The RAS server configuration
RAS Licensing server
List of secondary servers
Session Configuration
Session Expiry
Session Disconnect Delay
RAS Ocelot routing configuration
The path that the server will request
Protocol to use
List of servers and ports where the RAS Performance Monitor is hosted.
Server hosting RAS Performance Monitor
Port where the server is hosting RAS Performance Monitor
The URL on the RAS Web Admin service that will be redirected
Retrieve the Permissions of the logged Admin.
Success
The current admin name
Admin Type
Email address of the current admin
The group name
Mobile number of the current admin
The SID of the current admin
Administrator type
List of Runtime Sites for the current admin
Farm Mode
Whether monitoring is enabled or not for the current admin
Whether reporting is enabled or not for the current admin
Whether licensing is enabled or not for the current admin
Whether quick keypad is enabled or not for the current admin
Whether policies are enabled or not for the current admin
Section Permissions
List of sections for which permissions to manage are granted.
Site ID
Permission to manage Tenants
Permission to manage Remote Desktop Servers
Permission to manage Remote Desktop Groups
Permission to manage Remote Desktop Scheduler
Permission to manage Remote Desktop Sessions
Permission to manage Providers
Permission to manage VDI Host Pools
Permission to manage VDI Templates
Permission to manage VDI Hosts
Permission to manage VDI Sessions
Permission to manage Gateways
Permission to manage Tunneling Policies
Permission to manage PCs
Permission to manage Connection Brokers
Permission to Auto Promote
Permission to manage HALB
Permission to manage Auditing
Permission to manage Global Logging
Permission to manage URL Redirection
Permission to manage Notifications
Permission to manage Global Client Settings
Permission to manage Site Features
Permission to manage Themes
Permission to manage Certificates
Permission to manage Enrollment Servers
Permission to manage AD Integration
Permission to manage Load Balancer
Permission to manage Publishing
Permission to manage Universal Printing
Permission to manage Universal Scanning
Permission to manage Connection
Permission to manage Connection Authentication
Permission to manage Connection Settings
Permission to manage Connection Multi-Factor Authentication
Permission to manage SAML
Permission to manage Connection Allowed Devices
Permission to manage Device Manager
Permission to manage Devices
Permission to manage Windows Device Groups
Permission to manage Devices Options
Permission to manage Devices Schedule
Permission to manage Administration
Permission to manage Farm Features
The RAS power administrator permissions
Admin account ID
Permission to do changes to RAS Site settings.
Permission to do changes to Connection settings.
Permission to manage user sessions.
Permission to manage client devices.
Permission for read mode access to RAS Reporting.
Permission for read mode access to the License Information.
Permission for read mode access to RAS Site information.
Permission to manage published resources.
Permission to manage RAS client Policies.
Permission for read mode to RAS client Policies.
Permission to manage all Sites in the Farm.
A list of site IDs which the administrator should be allowed to manage.
The custom permissions list
List of the site permissions
Site ID
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
Site type permission
The global permission
Permission Flags
List of object permissions for this site
Permission Flags
The global permissions
The global permission
Permission Flags
The global permission
Permission Flags
The global permission
Permission Flags