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...
Restart a virtual machine.
Provider ID
VM ID
No Content
Suspend a virtual machine.
Provider ID
VM ID
No Content
Delete a Provider server from a site. The VDI agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.
Provider ID
If this parameter is included, the VDI 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 VDI agent from the 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
Remove a Remote PC Static from a Provider.
Provider ID
Remote PC Static ID
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
Removes Azure Virtual Desktop Hosts from a Templated Azure Virtual Desktop Host Pool.
The Templated Azure Virtual Desktop Host Pool ID from which to remove the Azure Virtual Desktop Hosts.
The ID of the target host VM.
Site ID for which to remove the Azure Virtual Desktop Host (optional)
No Content
Start a virtual machine.
Provider ID
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
Reset a virtual machine.
Provider ID
VM 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
Stop a virtual machine.
Provider ID
VM ID
No Content
Remove a Schedule setting.
The ID of a Schedule setting to remove.
No Content
Creates Azure Virtual Desktop Hosts from a Templated Azure Virtual Desktop Host Pool.
Site ID for which to create the Azure Virtual Desktop Host (optional)
Azure Virtual Desktop Host.
Host Pool Id of the AVD Host.
Number of Hosts to create from template.
No Content
Import a list of Remote PC Static to a Provider from a file.
Provider ID
Upload File
Created
Creates an Azure Virtual Desktop Host from a Standalone Azure Virtual Desktop Host Pool.
Site ID for which to create the Azure Virtual Desktop Host (optional)
Azure Virtual Desktop Host.
Host Pool Id of the AVD Host.
The Azure Host ID of the AVD Host. Found as Resource ID in Azure.
No Content
Removes an Azure Virtual Desktop Host from a Standalone Azure Virtual Desktop Host Pool.
Site ID for which to remove the Azure Virtual Desktop Host (optional)
Azure Virtual Desktop Host.
Host Pool Id.
The Azure Host ID.
No Content
Retrieve the Remote PC Static list of a Provider.
Provider ID
Success
The ID of the Remote PC Static
The Name of the Remote PC Static
The MAC Address of the Remote PC Static
The Subnet of the Remote PC Static
Update a Remote PC Static of a Provider.
Provider ID
Remote PC Static ID
Remote PC Static configuration.
Remote PC Static Name
Remote PC Static MAC Address
Remote PC Static Subnet
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
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 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
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.
Add a Remote PC Static to a Provider.
Provider ID
Remote PC Static configuration.
Remote PC Static Name.
Remote PC Static MAC Address.
Remote PC Static Subnet. Default: 0.0.0.0
Created
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
ID of the VM
Provider ID
Host Name
AVD Agent
Host Pool
Workspace
Location
Resource Group
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
ID of the VM
Provider ID
Host Name
AVD Agent
Host Pool
Workspace
Location
Resource Group
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
Retrieve the host VM list in real-time.
Site ID from which to retrieve the host VM list (optional).
Success
Site ID
ID of the VM
Provider ID
Host Name
AVD Agent
Host Pool
Workspace
Location
Resource Group
Retrieve a specific VM by ID from a specific Provider by ID.
Provider ID
VM ID
Success
Site ID
Name of the VM
ID of the VM
Provider ID
VM User
FQDN or IP address of the RAS Server
VM State
ID of Native Pool
Whether the VM is host or not
Whether the VM is template or not
IP of the VM
Retrieve a list of VM information of a specific Provider by ID.
Provider ID
Success
Site ID
Name of the VM
ID of the VM
Provider ID
VM User
FQDN or IP address of the RAS Server
VM State
ID of Native Pool
Whether the VM is host or not
Whether the VM is template or not
IP of the VM
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 VM information.
Site ID for which to retrieve VM information (optional)
Success
Site ID
Name of the VM
ID of the VM
Provider ID
VM User
FQDN or IP address of the RAS Server
VM State
ID of Native Pool
Whether the VM is host or not
Whether the VM is template or not
IP of the VM
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
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
Retrieve a list of Provider settings.
Site ID for which to retrieve Provider settings (optional)
Filter the result by Provider 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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
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
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
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
Retrieve a specific Provider by ID.
Provider 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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
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
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
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 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
Create a new Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Deprecated path - To create a new provider specify the type in the url ex: api/provider/hyperv
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
The preferred Connection Broker ID.
Use all guests.
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
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).
AVD Agent name.
Subnet name.
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).
AVD Agent name.
Subnet name.
Retrieve the Provider status information for the server.
Provider 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.
Specifies the preferred Connection Broker.
High Availability State
Number of active connections.
FQDN or IP address of the VDI Agent.
The Provider Friendly Name.
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).
AVD Agent name.
Subnet name.
AVD user session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
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).
AVD Agent name.
Subnet name.
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).
AVD Agent name.
Subnet name.
AVD Session Processes Information
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
The list of Session Processes.
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
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).
AVD Agent name.
Subnet name.
AVD user session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
Retrieve a list of Provider servers with status information.
Site ID for which Provider servers with status information will be retrieved (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.
Specifies the preferred Connection Broker.
High Availability State
Number of active connections.
FQDN or IP address of the VDI Agent.
The Provider Friendly Name.
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).
AVD Agent name.
Subnet name.
AVD Session Processes Information
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
The list of Session Processes.
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
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
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
Create a new AVD Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
This is an Experimental feature which is subject to slight changes.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Azure Subscription ID.
Azure Tenant ID.
Azure Authentication URL.
Azure Management URL.
Azure Resource URI.
AVD Version (Experimental)
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
AVD Version (Experimental)
The Graph URL.
The Feed URL.
Active Directory Domain Service Type
The Web Access URL.
VDI Azure Information
Azure authentication URL
Azure management URL
Azure resource URI
Azure subscription ID
Azure tenant ID
Azure Cost Optimize Timeout in seconds
Enable Azure Cost Optimize
Create a new HyperV Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
HyperV Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
HyperV Version
Create a new Nutanix Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Nutanix Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
Nutanix Version
Create a new Scale Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Scale Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
Scale Version
Create a new Azure Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Specifies the friendly name of the Provider.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The preferred Connection Broker ID.
Use all guests.
Azure Subscription ID.
Azure Tenant ID.
Azure Authentication URL.
Azure Management URL.
Azure Resource URI.
Azure Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Azure Version
VDI Azure Information
Azure authentication URL
Azure management URL
Azure resource URI
Azure subscription ID
Azure tenant ID
Azure Cost Optimize Timeout in seconds
Enable Azure Cost Optimize
Create a new RemotePCDynamic Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Remote PC Dynamic Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
Remote PC Dynamic Version
Domain Target OU.
The Subnet of the Dynamic Remote PC.
Create a new RemotePCStatic Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Remote PC Static Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
Remote PC Static Version
VDI PC List Hash.
VDI PC List Hash.
The ID of the Remote PC Static
The Name of the Remote PC Static
The MAC Address of the Remote PC Static
The Subnet of the Remote PC Static
Create a new HyperV Failover Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
HyperV Failover Cluster Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
HyperV Failover Cluster Version
MAC Address Management
Enable MAC Management.
Create a new RemotePCDynamic Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
The preferred Connection Broker ID.
Use all guests.
AWSEC2 Hypervisor Type
The access key ID of the Amazon Web Service account.
The secret access key of the Amazon Web Service account.
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
AWSEC2 Hypervisor Type
Amazon Elastic Compute Cloud Location Type
Region Name
Access Key Id
Region Code
Endpoint Url
Modify Provider server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Provider ID
Provider settings
Enables or disables the specified Provider server in a site.
A new name for the Provider.
The name of the target Provider server. This must be the actual server name used in the RAS farm.
A user-defined Provider server description.
Specifies the Provider server direct address.
Specifies the port number for the RAS VDI Agent.
FQDN or IP address of the server where the RAS VDI Agent is running. You only need to specify this parameter if the RAS VDI Agent is dedicated.
URL and Mail Redirection values.
Enable or disable the 'Support Shell URL Namespace Objects' option.
Set the Drag and Drop option.
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Enable or disable the 'Remove client name from printer name' option.
Enable or disable the 'Remove session number from printer name' option.
Printer Name Format
Enable or disable the 'Enable Drive Redirection Cache' option.
Manage RDP transport protocol.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.
The preferred Connection Broker ID.
Use all guests.
Cost Optimize Timeout in seconds. Applicable to: AVD (Experimental) and Azure.
Enable Cost Optimize. Applicable to: AVD (Experimental) and Azure.
The Feed URL. Applicable to: AVD (Experimental).
The Web Access URL. Applicable to: AVD (Experimental).
Active Directory Domain Service Type
The access key ID of the Amazon Web Service account. Applicable to: AWSEC2.
The secret access key of the Amazon Web Service account. Applicable to: AWSEC2.
Amazon Elastic Compute Cloud Location Type
The region name of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
The region code of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
The endpoint URL of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2. Example: https://ec2.us-east01.amazonaws.com.
HyperV Version
HyperV Failover Cluster Version
Starting MAC Address. Applicable to: HyperV Failover.
Ending MAC Address. Applicable to: HyperV Failover.
Specifies if the MAC Management is enabled or not. Applicable to: HyperV Failover.
Nutanix Version
Domain Target OU. Applicable to: Remote PC Dynamic.
The subnet of the remote PC dynamic. Applicable to: Remote PC Dynamic.
Scale Version
Vmware VCenter Version
Resource Pool. Applicable to: VCenter
Vmware ESX Version
No Content
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).
AVD Agent name.
Subnet name.
AVD user session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
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).
AVD Agent name.
Subnet name.
AVD Session Processes Information
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
The list of Session Processes.
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Retrieve a list of assigned hosts.
Site ID.
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
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
Invoke the VDI Process Command to send the Kill command to the Process with specified Process ID.
The ID of the provider.
VM ID.
Process ID.
No Content
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 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.
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
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
Retrieve the list of all processes for a specified VDI Host of a specified Provider.
The ID of the Provider server.
VM ID.
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Host VM ID
Retrieve a specified process for a specified session of a specified Provider.
The ID of the Provider server.
VM ID.
ID of the process to be retrieved
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Host VM ID
Retrieve the list of all processes for all the VDI Host sessions.
Site ID from which to retrieve the specified Provider server information (optional).
The name of the Provider server for which to retrieve the information (optional).
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Host VM ID
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.
Retrieve the list of all processes for all the sessions of a specified Provider.
The ID of the Provider server.
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Host VM ID
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 specific Host Status.
The ID of the Provider server.
VM ID.
Success
Provider name.
FQDN or IP address of the RAS Server.
VDI Host State
VDI Host Connection
Template Name.
Template ID.
Host Session Type
Provider user name.
IP of the Provider.
Host ID.
Provider ID.
Service start time.
System boot time.
Number of unhandled exceptions.
RAS Log Level
VDI user session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
Whether the Provider is in maintenance or not.
Whether the Provider is a template or not.
Agent State
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 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.
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 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.
Retrieve a list of statuses for a specific Provider.
The ID of the Provider server.
Success
Provider name.
FQDN or IP address of the RAS Server.
VDI Host State
VDI Host Connection
Template Name.
Template ID.
Host Session Type
Provider user name.
IP of the Provider.
Host ID.
Provider ID.
Service start time.
System boot time.
Number of unhandled exceptions.
RAS Log Level
VDI user session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
Whether the Provider is in maintenance or not.
Whether the Provider is a template or not.
Agent State
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 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 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 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 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.
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 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
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
Create a new VCenter Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Vmware VCenter Version
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
Vmware VCenter Version
Resource pool.
Create a new VMwareESX Provider server to a site. The VDI agent 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 VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI 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 VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Provider settings
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
The preferred Connection Broker ID.
Use all guests.
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.
Whether the server is enabled or not.
Description of the server.
ID of the site.
Whether the default Agent settings are inherited or not.
FQDN or IP address of the server where the RAS VDI Agent is running.
ID of the preferred Connection Broker.
Server name.
Name of the Provider.
Provider Major Type
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).
Specifies the port number for the Provider.
The port to communicate with the dedicated provider.
Specifies the Provider server direct address.
Specifies the 'Disconnect Timeout'. 0 - No timeout.
Specifies the 'Reset Timeout'. 0 - No timeout.
URL and Mail Redirection values.
Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.
Whether drag and drop is allowed or not.
Whether remote execution is allowed or not.
Whether application monitoring is enabled or not.
Whether remote applications are used or not.
Whether the 'Allow file transfer' option is enabled or disabled (deprecated).
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Whether printing is enabled or not.
Whether TWAIN (Universal Scanning) is enabled or not.
Whether WIA (Universal Scanning) is enabled or not.
Whether the default printer settings are used or not.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Printer Name Format
Whether the Drive Redirection Cache is enabled or not.
Manage RDP transport protocol.
Specifies whether all Guests are used or not.
Whether a dedicated VDI Agent server is used or not.
Admin credentials.
Vmware ESX Version
Retrieve the list of all statuses.
Site ID of which the sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
Provider name.
FQDN or IP address of the RAS Server.
VDI Host State
VDI Host Connection
Template Name.
Template ID.
Host Session Type
Provider user name.
IP of the Provider.
Host ID.
Provider ID.
Service start time.
System boot time.
Number of unhandled exceptions.
RAS Log Level
VDI user session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Host ID to which Remote Desktop Session is connected to.
Whether the Provider is in maintenance or not.
Whether the Provider is a template or not.
Agent State