Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Retrieve a list of assigned hosts.
Site ID.
No Content
Invoke the VDI Session to send the Disconnect command to the VDI Host with specified VM ID.
The ID of the provider.
VM ID.
No Content
Invoke the VDI Session to send the LogOff command to the VDI Host with specified VM ID.
The ID of the provider.
VM ID.
No Content
Remove a RAS Guest Agent from a host VM, thus making it a plain VM, not a host VM recognized by Parallels RAS.
The ID of the Provider server where the target host VM resides.
The ID of the target host VM.
If this parameter is included, the VDI Guest agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the RAS Guest Agent from the VM. 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
Remove a Schedule setting.
The ID of a Schedule setting to remove.
No Content
Delete a Schedule Message by ID.
The ID of the Schedule setting for which to remove the message.
The ID of the message to remove.
No Content
Remove a host assignment.
The ID of the Provider server on which the target Host resides.
The ID of the host VM.
Site ID.
No Content
Retrieve a Schedule Message.
The ID of the Schedule setting for which to retrieve the message.
The ID of the message to retrieve.
Success
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Add a Schedule target setting.
The ID of the Schedule setting to modify.
The Schedule target settings.
Pool Id
GUID
Guest Name
Host Azure ID
Created
Remove a Schedule target setting.
The ID of a Schedule setting to remove.
The Schedule target settings.
Pool Id
GUID
Guest Name
Host Azure ID
No Content
Modify a host assignment.
The ID of the Provider server on which the target Host resides.
The ID of the host VM.
Site ID.
VDI Host Assignment settings
The name of the user account to which to assign the Host.
The name of the device to which to assign the Host.
The SID of the user account to which to assign the Host.
No Content
Retrieve the specified host VM from a Provider in real-time.
The ID of a Provider server from which to retrieve the specified VM.
The ID of a host VM for which to retrieve the information.
Success
Site ID
Name of the VM
ID of the VM
Provider ID
Template ID
Pool ID
Time when the object was last used.
Time when the object was created.
Retrieve the host VM list in real-time.
Site ID from which to retrieve the host VM list (optional).
The ID of the VDI Template for which to retrieve the hosts of (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the host list will be filtered with those with an assigned user.
Success
Site ID
Name of the VM
ID of the VM
Provider ID
Template ID
Pool ID
Time when the object was last used.
Time when the object was created.
Retrieve the host VM list from a Provider in real-time.
The ID of a Provider server from which to obtain the VM list.
Success
Site ID
Name of the VM
ID of the VM
Provider ID
Template ID
Pool ID
Time when the object was last used.
Time when the object was created.
Retrieve Schedule Message(s).
The ID of the Schedule setting for which to retrieve the messages.
Success
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Get a list of the schedule setting's target native hosts.
The ID of the Schedule setting for which to retrieve the target settings.
The Schedule settings.
Success
Pool Id
GUID
Guest Name
Host Azure ID
Update a Schedule Message.
The ID of the Schedule setting for which to modify the message.
The ID of the message to modify.
Message settings.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
No Content
Create a Schedule Message.
The ID of the Schedule setting for which to create the message.
Message settings.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Created
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Retrieve a list of Host Sessions by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve the Host Session Processes.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve the Host Sessions.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve a list of Host Session Processes by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve a list of Host Sessions by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve a list of Host Session Processes by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Modify properties of a Schedule setting.
The ID of the Schedule setting to modify.
Schedule settings
A new name for the scheduler job.
Whether to enable or disable the schedule.
Schedule description.
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
No Content
Retrieve information about one or multiple Schedule setting.
Site ID from which to retrieve the Schedule setting (optional).
The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule 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.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Startup Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
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.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Reboot Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
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.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Retrieve information about a particular Schedule setting by ID.
The ID of the Schedule 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.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Shutdown Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
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.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new disable Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
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.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Invoke the VDI Session to send a message to the RD Session Host Session with specified Session ID.
The ID of the provider.
VM ID.
VDI Session
The message title for the session message.
The session message to be sent.
No Content
Retrieve a list of Host status by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve the Host status.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.
Retrieve a list of Host status by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
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.
Host IP Address.
Power State
Host Assignment Type
User.
Disk(s).
Device.