Retrieve Parallels RAS Connection Broker Auto Promotion Settings.
The Site ID for which to retrieve the Parallels RAS Connection Broker Auto Promotion settings. (optional)
Success
Whether Auto Promotion is enabled.
The amount of time (in mins) required to enable auto promotion.
Whether Failback is enabled.
Whether Replicate is enabled.
Modify Parallels RAS Auto Promotion Settings.
The Site ID for which to modify the Parallels RAS Auto Promotion Settings. (optional)
Auto Promotion Settings.
Whether Auto Promotion is enabled or not.
The amount of time (in mins) required to enable auto promotion.
Whether Failback is enabled or not.
Whether Replicate is enabled or not.
No Content
Retrieve a list of RAS Connection Broker servers with status information.
Site ID for which to retrieve the RAS Connection Broker server information (optional)
Filter the result by server name (optional)
Success
ID of RAS Agent.
ID of Site.
Agent State
RAS Status Type
Agent Version.
Server name.
Server Operating System.
Service start time.
System boot time.
Number of unhandled exceptions.
Id of the machine
RAS Log Level
CPU load percentage.
Memory load percentage.
Disk Read.
Disk Write.
Whether the object is enabled or not.
Retrieve status information for a specified RAS Connection Broker server.
RAS Connection Broker server ID
Success
ID of RAS Agent.
ID of Site.
Agent State
RAS Status Type
Agent Version.
Server name.
Server Operating System.
Service start time.
System boot time.
Number of unhandled exceptions.
Id of the machine
RAS Log Level
CPU load percentage.
Memory load percentage.
Disk Read.
Disk Write.
Whether the object is enabled or not.
Delete a RAS Connection Broker server from a site. The RAS Connection Broker server will be uninstalled from the server by default. You can optionally keep it by including the noUninstall
parameter.
RAS Connection Broker server ID
Include this parameter if you wish to keep the RAS Connection Broker software on the server. To uninstall the agent software, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials by including the Username and Password parameters.
A username that will be used to remotely uninstall the RAS Connection Broker software from the target server. If this parameter is omitted, your RAS admin username and password will be used by default.
The password of the account specified in the Username parameter.
No Content
Promote a RAS Connection Broker server to the primary Connection Broker. The license key used must be registered in Parallels My Account. To activate Parallels RAS as a trial, omit the key
parameter.
RAS Connection Broker server ID
RAS Connection Broker server
An administrator account for connecting with the new Connection Broker server (the one being promoted). If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the BrokerUsername parameter.
No Content
Increase or decrease the priority for a specified RAS Connection Broker server.
RAS Connection Broker server ID
RAS Connection Broker server
Move Direction.
No Content
Modify settings of a RAS Connection Broker server. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RAS Connection Broker server ID
RAS Connection Broker server
Enable or disable the specified RAS Connection Broker.
A user-defined RAS Connection Broker description.
An IP address of the RAS Connection Broker server.
A list of alternative IP addresses separated by a comma.
Set the specified RAS Secondary Connection Broker in Standby (or vice versa).
No Content
Retrieve information about a list of RAS Connection Broker servers.
Site ID for which to retrieve the RAS Connection Broker server information (optional)
Filter the result by server 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.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Priority of the specified RAS Connection Broker.
IP address of RAS Connection Broker.
Alternative IPs to access the RAS Connection Broker.
Whether the RAS Connection Broker is in standby mode or not.
Whether the RAS Connection Broker is marked for deletion or not.
Retrieve a specific Connection Broker by ID.
RAS Connection Broker server 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.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Priority of the specified RAS Connection Broker.
IP address of RAS Connection Broker.
Alternative IPs to access the RAS Connection Broker.
Whether the RAS Connection Broker is in standby mode or not.
Whether the RAS Connection Broker is marked for deletion or not.
Add a new RAS Connection Broker server to a site. The agent software will be installed on the server by default. You can optionally skip the agent installation by including the noInstall
parameter.
Specifies not to install the agent software on the server. If you omit this parameter, the agent will be push installed on the server using your RAS admin credentials To specify different credentials, include the Username and Password parameters.
An administrator account for push installing the agent on the server. If this parameter is omitted, your RAS admin username and password will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS Connection Broker is installed. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RD Session Host and the Connection Broker to communicate. If this parameter is omitted, the firewall rules will not be added.
RAS Connection Broker server
FQDN or IP address of the server to add to a site as a RAS Connection Broker.
Site ID to which to add the RAS Connection Broker server. If the parameter is omitted, the Licensing Server site ID will be used.
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.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Priority of the specified RAS Connection Broker.
IP address of RAS Connection Broker.
Alternative IPs to access the RAS Connection Broker.
Whether the RAS Connection Broker is in standby mode or not.
Whether the RAS Connection Broker is marked for deletion or not.