Parallels RAS - REST API v1.0 API Reference
Overview
Parallels RAS comes with various APIs to help you develop custom applications that integrate with it. The RAS REST API is one of them. This guide describes how to use the REST API and documents the available REST resources, complete with request syntax and examples.
Getting Started
Applications communicate with Parallels RAS by sending HTTP or HTTPS requests. Parallels RAS answers with a JSON file in a response to every HTTP request.
All HTTP requests that you will use to retrieve and manage Parallels RAS resources have the following base structure:
https://<API-host>:20443/api/<URI>
where:
- <API-host> is the IP address or FQDN of the server on which the RAS REST API endpoint is installed.
- <URI> is a path to a REST resource that you would like to work with. The available resources and their paths and possible parameters are described in the OPERATIONS section. Request body schemas are documented in the SCHEMA DEFINITIONS section.
Logging in and Sending Requests
This section contains an example of RAS REST API usage that can help you quickly get started. The example demonstrates how to:
- Login to Parallels RAS and obtain an authentication token.
- Retrieve the information about all available RD Session Hosts.
- Retrieve the information about a specific RD Session Host.
- Modify RD Session Host properties.
Log in to Parallels RAS and obtain an authorization token
Before you can access any of the resources, you need to log in to Parallels RAS using administrator credentials and obtain an authorization token. This is accomplished by sending the following request:
POST https://<API-host>:20443/api/session/logon
Request headers The logon request must contain just the Content-Type request header. Subsequent requests must additionally contain the auth_token header, as you'll see in the examples that follow this one.
Content-Type: application/json; api-version=1.0
Request body The request body must contain the RAS administrator user name and password:
{
"username": "USER",
"password": "PASSWORD"
}
Response After sending the logon request, you will receive a reply containing the authentication token, which you will use in all subsequent requests:
{
"authToken": "[AUTHENTICATION_TOKEN]"
}
Throughout this document, AUTHENTICATION_TOKEN refers to the authentication token, which can be obtained from /api/session/logon.
Retrieve information about RD Session Hosts
Now that we have the authentication token, we can send requests to access various resources. In this example we'll first obtain the information about all available RD Session Hosts. In the example that follows, we'll obtain the information about a specific RD Session Host.
To retrieve the RD Session Host info, send the following request:
GET https://<API-host>:20443/api/RDS
Request headers This time the auth_token request header must also be included and must contain the authentication token that we've obtained earlier:
- Content-Type: application/json; api-version=1.0
- auth_token: [AUTHENTICATION_TOKEN]
Response The response will look similar to the following (with multiple RD Session Hosts in the farm, each block of the result set will contain the information about an individual server):
{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
…
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "IP_ADDR",
"enabled": true,
"description": "",
"siteId": 1,
"id": 2
}
Retrieve information about a specific RD Session Host
To retrieve the information about a specific server, we'll use the same request as above but will add the server ID in the end:
GET https://<API-host>:20443/api/RDS/2/
The response will also be similar to the example above and will contain the information just for the specified server.
Modify RD Session Host properties
In this example we'll modify a property of the RD Session Host that we retrieved earlier. For simplicity let's modify the "description" field.
The request to modify properties of an RD Session Host has the following syntax:
PUT https://<API-host>:20443/api/RDS/2/
Note "2" at the end of the request, which specifies the ID of the RD Session Host that we want to modify.
Request headers
- Content-Type: application/json; api-version=1.0
- auth_token: [AUTHENTICATION_TOKEN]
Request body
{
"description": "description was updated!"
}
Response If the PUT request succeeds, you will get an empty response with code "204: No Content". To verify that the "description" field was in fact modified, let's use the same GET request that we used earlier: GET https://<API-host>:20443/api/RDS/2/
As we can see, the result now contains the updated "description" field:
{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
…
"server": "IP_ADDR",
"enabled": true,
"description": "description was updated!",
"siteId": 1,
"id": 2
}
Examples
Below you can find some samples containing sequences of different types of HTTP requests:
Basic Sample How to start a session, get all sites, get a particular site, get all gateways, add a new GW, get a particular GW, create a RDS server, get the RDS server status, get the RDS server sessions.
RDS Sample How to get all RDS servers, add a new RDS Server, get the its status, get its sessions, add the Server to a RDS Group, update the RDS Group.
Publishing Sample How to manage published resources and use filtering options.
PA & Gateway Sample How to manage Publishing Agents and Gateways.
Licensing Sample How to manage license.
Version: 1.0
AdminAccount
List
Retrieves Admin Account/s.
Admin Account Name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
]
Create
Create a new Admin Account.
Admin Account settings
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"email": "string",
"mobile": "string",
"enabled": "boolean",
"notify": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
Get CustomPermission
Retrieve the Custom Permissions of an Admin Account by id.
Admin Account Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"sitePermissions": [
{
"siteId": "integer (int32)",
"rdsHosts": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"rdshGroups": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"remotePCs": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"gateways": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishingAgents": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"halb": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"themes": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishing": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"connection": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"winDevices": {
"sitePermission": {}
}
}
]
}
Update CustomPermission
Update a Custom Permission of an Admin Account. Specifying a SiteId is mandatory except for Monitoring and Reporting. To set a Permission for a specific object, provide an ObjId within the body. To set a Global Permission, do not provide an ObjId within the body.
Custom Permission settings
Admin Account id
Site ID for the permission being set (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"objId": "integer (int32)",
"objectType": "string",
"permissions": "string"
}
Success
Unauthorized
Not Found
Get PowerPermission
Retrieve the Power Permissions of an Admin Account by id.
Admin Account Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"adminId": "integer (int32)",
"allowSiteChanges": "boolean",
"allowConnectionChanges": "boolean",
"allowSessionManagement": "boolean",
"allowClientManagementChanges": "boolean",
"allowViewingReportingInfo": "boolean",
"allowViewingSiteInfo": "boolean",
"allowPublishingChanges": "boolean",
"allowPolicyChanges": "boolean",
"allowViewingPolicyInfo": "boolean",
"allowAllSites": "boolean",
"allowInSiteIds": [
"integer (int32)"
]
}
Update PowerPermission
Update a Power Permission of an Admin Account.
Power Permission settings
Admin Account id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"allowSiteChanges": "boolean",
"allowPublishingChanges": "boolean",
"allowConnectionChanges": "boolean",
"allowViewingReportingInfo": "boolean",
"allowViewingSiteInfo": "boolean",
"allowViewingPolicyInfo": "boolean",
"allowSessionManagement": "boolean",
"allowClientManagementChanges": "boolean",
"allowPolicyChanges": "boolean",
"allowAllSites": "boolean",
"allowInSiteIds": [
"integer (int32)"
]
}
Success
Unauthorized
Not Found
Get
Retrieve an Admin Account by id.
Admin Account Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
Update
Update Admin Account settings.
Admin Account settings
Admin Account id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"email": "string",
"mobile": "string",
"enabled": "boolean",
"notify": "string",
"permissions": "string",
"fullPermissions": "boolean"
}
Success
Unauthorized
Not Found
Delete
Force Delete the Admin Account
Admin Account Id
Success
Unauthorized
Not Found
Certificates
List by Site ID
Retrieve a list of all the RAS Certificates.
Site ID of which the Certificates will be retrieved (optional)
Filter the result by certificate name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
]
Get
Retrieve a specific RAS Certificate.
ID of the Certificate to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Modify the properties of a RAS Certificate.
The Certificate to be updated
ID of the Certificate to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"newName": "string",
"description": "string",
"usage": "string",
"enabled": "boolean"
}
Success
Unauthorized
Not Found
Delete
Delete a RAS Certificate.
ID of the Certificate to be deleted
Success
Unauthorized
Not Found
Export
Export a RAS Certificate.
ID of the Certificate to be exported
Success
Unauthorized
Not Found
Import Public Key
This can be used to Import the Public Key of a Requested Certificate.
ID of the Certificate to be updated.
Public Key file to be uploaded.
Success
Unauthorized
Update Intermediate
This can be used to Update the Intermediate of an Imported Certificate.
ID of the Certificate to be updated.
Intermediate file to be uploaded.
Success
Unauthorized
Generate Request
Generate a new Certificate Request.
The Certificate Request details for a certificate to be requested.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"description": "string",
"usage": "string",
"enabled": "boolean",
"keySize": "string",
"countryCode": "string",
"fullStateOrProvince": "string",
"city": "string",
"organisation": "string",
"organisationUnit": "string",
"email": "string",
"commonName": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
Generate Self Signed
Generate a new Self Signed Certificate.
The Self Signed Certificate details for a certificate to be generated.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"description": "string",
"usage": "string",
"enabled": "boolean",
"keySize": "string",
"countryCode": "string",
"expireInMonths": "integer (int32)",
"fullStateOrProvince": "string",
"city": "string",
"organisation": "string",
"organisationUnit": "string",
"email": "string",
"commonName": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
Import a Certificate
This can be used to import a new Certificate file.
The name of the target Certificate.
Site ID in which to add the Certificate.
A user-defined Certificate description.
A set of usages to assign. To form a set of usages 'OR' individual usage enum IDs.
Whether to enable or disable the certificate being created.
Certificate file to be uploaded.
Privatekey file to be uploaded.
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
Import a Pfx file
This can be used to import a Pfx file. If the pfx password is used (optional), the file has to be in a pfx format and will be used as a Certificate file, as well.
The name of the target Certificate.
Site ID in which to add the Certificate.
A user-defined Certificate description.
A set of usages to assign. To form a set of usages 'OR' individual usage enum IDs.
Whether to enable or disable the certificate being created.
Password of the pfx File to be uploaded.
Private Key File to be uploaded.
Success
Unauthorized
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
ConnectionAllowedDevices
List
Retrieve a list of all the settings for RAS allowed devices
Site ID for which to retrieve all the settings for RAS allowed devices (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"allowClient2XOS": "boolean",
"allowClientBlackberry": "boolean",
"allowClientChromeApp": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientJava": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientMode": "string",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWinPhone": "boolean",
"allowClientWyse": "boolean",
"replicateSettings": "boolean",
"siteId": "integer (int32)",
"minBuild2XOS": "integer (int32)",
"minBuildBlackberry": "integer (int32)",
"minBuildChromeApp": "integer (int32)",
"minBuildAndroid": "integer (int32)",
"minBuildHTML5": "integer (int32)",
"minBuildIOS": "integer (int32)",
"minBuildJava": "integer (int32)",
"minBuildLinux": "integer (int32)",
"minBuildMAC": "integer (int32)",
"minBuildWebPortal": "integer (int32)",
"minBuildWindows": "integer (int32)",
"minBuildWinPhone": "integer (int32)",
"minBuildWyse": "integer (int32)"
}
]
Update
Update settings of a RAS allowed device
RAS allowed device settings
ID of the site for which the RAS Allowed device settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"allowClientMode": "string",
"allowClient2XOS": "boolean",
"allowClientBlackberry": "boolean",
"allowClientChromeApp": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientJava": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWinPhone": "boolean",
"allowClientWyse": "boolean",
"replicateSettings": "boolean",
"minBuild2XOS": "integer (int32)",
"minBuildBlackberry": "integer (int32)",
"minBuildChromeApp": "integer (int32)",
"minBuildAndroid": "integer (int32)",
"minBuildHTML5": "integer (int32)",
"minBuildIOS": "integer (int32)",
"minBuildJava": "integer (int32)",
"minBuildLinux": "integer (int32)",
"minBuildMAC": "integer (int32)",
"minBuildWebPortal": "integer (int32)",
"minBuildWindows": "integer (int32)",
"minBuildWinPhone": "integer (int32)",
"minBuildWyse": "integer (int32)"
}
Success
Unauthorized
Not Found
ConnectionAuthentication
List
Retrieve a list of all the settings for RAS authentication
Site ID for which to retrieve all the settings for RAS authentication (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"authType": "string",
"allTrustedDomains": "boolean",
"domain": "string",
"useClientDomain": "boolean",
"forceNetBIOSCreds": "boolean",
"replicateSettings": "boolean",
"siteId": "integer (int32)"
}
]
Update
Update RAS authentication settings
RAS allowed device settings
ID of the site for which the RAS authentication settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"authType": "string",
"allTrustedDomains": "boolean",
"domain": "string",
"useClientDomain": "boolean",
"forceNetBIOSCreds": "boolean",
"replicateSettings": "boolean"
}
Success
Unauthorized
Not Found
ConnectionMFA
List 2FA Settings
Retrieve a list of all the multi-factor authentication settings.
Site ID for which to retrieve multi-factor authentication settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"deepnetSettings": {
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"authMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"ssl": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string"
},
"safeNetSettings": {
"authMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string"
},
"radiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"azureRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"duoRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"fortiRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"tekRadiusSettings": {}
}
Update 2FA Settings
Update multi-factor authentication settings.
Multi-factor authentication settings
ID of the site for which the multi-factor authentication settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"provider": "string",
"excludeClientIPs": "boolean",
"excludeClientMAC": "boolean",
"excludeClientGWIPs": "boolean",
"excludeUserGroup": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)",
"replicateSettings": "boolean"
}
Success
Unauthorized
Not Found
List Azure Radius Settings
Retrieve a list of all the multi-factor authentication Azure Radius settings.
Site ID for which to retrieve multi-factor authentication Azure Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Azure Radius Settings
Update multi-factor authentication Azure Radius settings.
Multi-factor authentication Azure Radius settings
ID of the site for which the multi-factor authentication Azure Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Deepnet Settings
Retrieve a list of all the multi-factor authentication Deepnet settings.
Site ID for which to retrieve multi-factor authentication Deepnet settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"authMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"ssl": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string"
}
]
Update Deepnet Settings
Update multi-factor authentication Deepnet settings.
Multi-factor authentication Deepnet settings
ID of the site for which the multi-factor authentication Deepnet settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"deepnetAuthMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"enableSSL": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Duo Radius Settings
Retrieve a list of all the multi-factor authentication Duo Radius settings.
Site ID for which to retrieve multi-factor authentication Duo Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Duo Radius Settings
Update multi-factor authentication Duo Radius settings.
Multi-factor authentication Duo Radius settings
ID of the site for which the multi-factor authentication Duo Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Exclude GWs
Retrieve a list of excluded GW for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of GW for multi-factor authentication settings (optional)
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW to Exclude List
Add a GW to the exclude list for the multi-factor authentication settings.
GW IP to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude GW list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string"
}
Success
Unauthorized
Conflict
Delete GW from Exclude List
Remove a GW from the exclude list for the multi-factor authentication settings.
GW IP to be deleted from the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude GW address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string"
}
Success
Unauthorized
Not Found
List Exclude IPs
Retrieve a list of excluded IP for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of IP addresses for multi-factor authentication settings (optional)
Represents the type of IP. Valid values are: 0 for v4 and 1 for v6 (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
]
}
Add IP to Exclude List
Add an IP address to the exclude list for the multi-factor authentication settings.
IP to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude IP list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"ipType": "string"
}
Success
Unauthorized
Conflict
Delete IP from Exclude List
Remove an IP address from the exclude list for the multi-factor authentication settings.
IP to be deleted from the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude IP address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"ipType": "string"
}
Success
Unauthorized
Not Found
List Exclude MACs
Retrieve a list of excluded MAC for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of MAC addresses for multi-factor authentication settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add MAC to Exclude List
Add a MAC address to the exclude list for the multi-factor authentication settings.
MAC address to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude MAC address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"macAddress": "string"
}
Success
Unauthorized
Conflict
Delete MAC from Exclude List
Remove a MAC address from the exclude list for the multi-factor authentication settings.
MAC address to be deleted from list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude MAC address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"macAddress": "string"
}
Success
Unauthorized
Not Found
List Exclude Users/Groups
Retrieve a list of excluded Users/Groups for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of Users/Groups for multi-factor authentication settings (optional)
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add User/Group to Exclude List
Add a User/Group to the exclude list for the multi-factor authentication settings.
User/Group to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude Users/Groups list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"type": "string"
}
Success
Unauthorized
Conflict
Delete User/Group from Exclude List
Remove a User/Group from the exclude list for the multi-factor authentication settings.
GW IP to be deleted from the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude Users/Groups list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"type": "string"
}
Success
Unauthorized
Not Found
List Forti Radius Settings
Retrieve a list of all the multi-factor authentication Forti Radius settings.
Site ID for which to retrieve multi-factor authentication Forti Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Forti Radius Settings
Update multi-factor authentication Forti Radius settings.
Multi-factor authentication Forti Radius settings
ID of the site for which the multi-factor authentication Forti Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Radius Settings
Retrieve a list of all the multi-factor authentication Radius settings.
Site ID for which to retrieve multi-factor authentication Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Radius Settings
Update multi-factor authentication Radius settings.
Multi-level authentication Radius settings
ID of the site for which the multi-factor authentication Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Radius Attributes
Retrieve a list of excluded Radius Attributes for multi-factor authentication settings.
Site ID for which to retrieve the list of Radius Attributes for multi-factor authentication settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
Add Radius Attribute
Add a Radius Attribute to the exclude list for the multi-factor authentication settings.
Radius Attribute to be added to the list that applies for multi-factor authentication settings
Site ID for which to update the Radius Attribute list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"value": "string",
"name": "string",
"vendor": "string",
"attributeType": "string"
}
Success
Unauthorized
Conflict
Delete Radius Attribute
Remove a Radius Attribute from the exclude list for the multi-factor authentication settings.
Radius Attribute to be removed from the list that applies for multi-factor authentication settings
Site ID for which to update the Radius Attribute list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"value": "string",
"name": "string",
"vendor": "string",
"attributeType": "string"
}
Success
Unauthorized
Not Found
List Safenet Settings
Retrieve a list of all the multi-factor authentication Safenet settings.
Site ID for which to retrieve multi-factor authentication Safenet settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"authMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string"
}
]
Update Safenet Settings
Update multi-factor authentication Safenet settings.
Multi-factor authentication Safenet settings
ID of the site for which the multi-factor authentication Safenet settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"safeNetAuthMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Tek Radius Settings
Retrieve a list of all the multi-factor authentication Tek Radius settings.
Site ID for which to retrieve multi-factor authentication Tek Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Tek Radius Settings
Update multi-factor authentication Tek Radius settings.
Multi-factor authentication Tek Radius settings
ID of the site for which the multi-factor authentication Tek Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List TOTP Settings
Retrieve a list of all the multi-factor authentication TOTP settings.
Site ID for which to retrieve multi-factor authentication TOTP settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"type": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
]
Update TOTP Settings
Update multi-factor authentication TOTP settings.
Multi-factor authentication TOTP settings
ID of the site for which the multi-factor authentication TOTP settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"totpType": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
ConnectionSettings
List
Retrieve a list of all the settings for RAS sessions
Site ID for which to retrieve all the settings for RAS sessions (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"fipsMode": "string",
"remoteIdleSessionTimeout": "integer (int32)",
"logoffIdleSessionTimeout": "integer (int32)",
"cachedSessionTimeout": "integer (int32)",
"replicateSettings": "boolean",
"siteId": "integer (int32)"
}
]
Update
Update settings of a RAS session
RAS session settings
ID of the site for which the RAS session settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"remoteIdleSessionTimeout": "integer (int32)",
"logoffIdleSessionTimeout": "integer (int32)",
"cachedSessionTimeout": "integer (int32)",
"fipsMode": "string",
"replicateSettings": "boolean"
}
Success
Unauthorized
Not Found
GW
List by Site ID
Retrieve a list of all the RAS Secure Client Gateway Servers.
Site ID of which the Gateway Servers will be retrieved (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
]
Create
Create a new RAS Secure Client Gateway Server.
The Gateway server to be created
If this parameter is included, the Gateway software will NOT be installed on the target server. The parameter should only be included if the server already has the software installed. If you need to install the software, omit this parameter. When installing the Gateway software, your RAS admin credentials will be used to push install the software. These are the credentials you used to connect to the RAS farm. If needed, you can specify different credentials using the Username and Password parameters.
An administrator account to push install the Gateway software on the target 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.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"server": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Get
Retrieve a specified RAS Secure Client Gateway Server.
ID of the Gateway server to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Modify the properties of a RAS Secure Client Gateway Server.
The Gateway server to be updated
ID of the Gateway server to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"newServer": "string",
"description": "string",
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"autoCertificate": "boolean",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
Success
Unauthorized
Not Found
Delete
Delete a RAS Secure Client Gateway Server.
The Gateway server to be deleted
When this parameter is included, the Gateway software will NOT be removed from the server. If you want to remove the software, omit this parameter. When removing the software, your RAS admin credentials will be used to remotely execute the uninstaller on the target server. You can specify different credentials if needed using the Username and Password parameters.
An administrator account name to remotely uninstall the Gateway software from 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.
ID of the Gateway server to be deleted
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{}
Success
Unauthorized
Not Found
Upload a Certificate file
This can be used to upload a Certificate file for a specified GW server. If the pfx password is used (optional), the file has to be in a pfx format and will be used as a Private Key file, as well.
ID of the Gateway server to be updated.
Certificate file to be uploaded.
Privatekey file to be uploaded.
Success
Unauthorized
Upload a Private Key file
This can be used to upload a Private Key file for a specified GW server. If the pfx password is used (optional), the file has to be in a pfx format and will be used as a Certificate file, as well.
Password of the pfx File to be uploaded.
ID of the Gateway server to be updated.
Private Key File to be uploaded.
Success
Unauthorized
Get Status
Retrieve summary and state information about a specified RAS Secure Client Gateway Server.
ID of the Gateway server of which summary and state information will be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"gwMode": "string",
"cipherStrength": "string",
"cipherStr": "string",
"availableIPs": "string",
"preferredPA": "string",
"clientConns": "integer (int32)",
"maxClientConns": "integer (int32)",
"clientSSLConns": "integer (int32)",
"maxClientSSLConns": "integer (int32)",
"httpRedirs": "integer (int32)",
"httpsRedirs": "integer (int32)",
"maxHTTPRedirs": "integer (int32)",
"maxHTTPSRedirs": "integer (int32)",
"wyseConns": "integer (int32)",
"maxWyseConns": "integer (int32)",
"wyseSSLConns": "integer (int32)",
"maxWyseSSLConns": "integer (int32)",
"htmL5Conns": "integer (int32)",
"htmL5SSLConns": "integer (int32)",
"maxHTML5Conns": "integer (int32)",
"maxHTML5SSLConns": "integer (int32)",
"clientMgrTCPConns": "integer (int32)",
"clientMgrTCPSSLConns": "integer (int32)",
"maxClientMgrTCPConns": "integer (int32)",
"maxClientMgrTCPSSLConns": "integer (int32)",
"activeRDPSessions": "integer (int32)",
"activeRDPSSLSessions": "integer (int32)",
"maxRDPSessions": "integer (int32)",
"maxRDPSSLSessions": "integer (int32)",
"rdpudpTunnels": "integer (int32)",
"rdpudpdtlsTunnels": "integer (int32)",
"maxRDPUDPTunnels": "integer (int32)",
"maxRDPUDPDTLSTunnels": "integer (int32)",
"totalConnections": "integer (int32)",
"cachedSockets": "integer (int32)",
"activeThreads": "integer (int32)",
"idleThreads": "integer (int32)",
"securityMode": "string",
"gatewayTCPSock": "string",
"rdptcpSock": "string",
"sslVersion": "string",
"gatewaySSLTCPSock": "string",
"clientManagerUDPSock": "string",
"htmL5TCPSock": "string",
"broadcastUDPSock": "string",
"rdpTunnelUDPSock": "string",
"rdpTunnelSSLUDPSock": "string",
"serverMessage": "string",
"fipsMode": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
List Status
Retrieve a list of the summary and state information for all RAS Secure Client Gateways.
Site ID for which the summary and state information of all Gateway Servers will be retrieved (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"gwMode": "string",
"cipherStrength": "string",
"cipherStr": "string",
"availableIPs": "string",
"preferredPA": "string",
"clientConns": "integer (int32)",
"maxClientConns": "integer (int32)",
"clientSSLConns": "integer (int32)",
"maxClientSSLConns": "integer (int32)",
"httpRedirs": "integer (int32)",
"httpsRedirs": "integer (int32)",
"maxHTTPRedirs": "integer (int32)",
"maxHTTPSRedirs": "integer (int32)",
"wyseConns": "integer (int32)",
"maxWyseConns": "integer (int32)",
"wyseSSLConns": "integer (int32)",
"maxWyseSSLConns": "integer (int32)",
"htmL5Conns": "integer (int32)",
"htmL5SSLConns": "integer (int32)",
"maxHTML5Conns": "integer (int32)",
"maxHTML5SSLConns": "integer (int32)",
"clientMgrTCPConns": "integer (int32)",
"clientMgrTCPSSLConns": "integer (int32)",
"maxClientMgrTCPConns": "integer (int32)",
"maxClientMgrTCPSSLConns": "integer (int32)",
"activeRDPSessions": "integer (int32)",
"activeRDPSSLSessions": "integer (int32)",
"maxRDPSessions": "integer (int32)",
"maxRDPSSLSessions": "integer (int32)",
"rdpudpTunnels": "integer (int32)",
"rdpudpdtlsTunnels": "integer (int32)",
"maxRDPUDPTunnels": "integer (int32)",
"maxRDPUDPDTLSTunnels": "integer (int32)",
"totalConnections": "integer (int32)",
"cachedSockets": "integer (int32)",
"activeThreads": "integer (int32)",
"idleThreads": "integer (int32)",
"securityMode": "string",
"gatewayTCPSock": "string",
"rdptcpSock": "string",
"sslVersion": "string",
"gatewaySSLTCPSock": "string",
"clientManagerUDPSock": "string",
"htmL5TCPSock": "string",
"broadcastUDPSock": "string",
"rdpTunnelUDPSock": "string",
"rdpTunnelSSLUDPSock": "string",
"serverMessage": "string",
"fipsMode": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
]
GWDefaultSettings
Get
Retrieve the Gateway Default settings.
Site ID for which to retrieve GW Default settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"siteId": "integer (int32)",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
Update
Update the Gateway default settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
GW settings
Site ID for which to update the GW Default settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"autoCertificate": "boolean",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
Success
Unauthorized
Not Found
License
Retrieve
Retrieve the current license setting.
Success
Activate
Activates Parallels RAS using a valid license key. Also allows to activate Parallels RAS as a trial version. Trial version will be activated if the key is empty.
License settings.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"email": "string",
"password": "string",
"key": "string"
}
Success
Unauthorized
Deactivate
Deactivates the current license key used by Parallels RAS.
License settings
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"email": "string",
"password": "string"
}
Success
Unauthorized
PA
List
Retrieve information about a list of RAS Publishing Agent servers.
Site ID for which to retrieve the RAS Publishing Agent server information (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
]
Create
Add a new RAS Publishing Agent server to a site. The agent software will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
RAS Publishing Agent server
Specifies NOT to install the agent software on the server. If you omit this parameter, the agent will be push installed on the server using your RAS admin credentials To specify different credentials, include the Username and Password parameters.
An administrator account for push installing the agent on the server. If this parameter is omitted, your RAS admin username and password will be used.
The password of the account specified in the Username parameter.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"server": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Get
Retrieve a specific Publishing Agent by id.
RAS Publishing Agent server Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Update settings of a RAS Publishing Agent server. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RAS Publishing Agent server
RAS Publishing Agent server id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"description": "string",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean"
}
Success
Unauthorized
Not Found
Delete
Delete a RAS Publishing Agent server from a site. The RAS Publishing Agent server will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.
RAS Publishing Agent server
Include this parameter if you wish to keep the RAS Publishing Agent software on the server. To uninstall the agent software, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials by including the Username and Password parameters.
A username that will be used to remotely uninstall the RAS Publishing Agent software from the target server. If this parameter is omitted, your RAS admin username and password will be used by default.
The password of the account specified in the Username parameter.
RAS Publishing Agent server Id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{}
Success
Unauthorized
Not Found
Update Priority
Increase or decrease the priority for a specified RAS Publishing Agent server.
RAS Publishing Agent server
RAS Publishing Agent server id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"direction": "string"
}
Success
Unauthorized
Not Found
Promote
Promote a RAS Publishing Agent server to master.The license key used must be registered in Parallels My Account. To activate Parallels RAS as a trial, omit the key parameter.
RAS Publishing Agent server
RAS Publishing Agent server id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"paUsername": "string",
"paPassword": "string"
}
Success
Unauthorized
Not Found
Get Status
Retrieve status information for a specified RAS Publishing Agent server.
RAS Publishing Agent server id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
List Status
Retrieve a list of RAS Publishing Agent servers with status information.
Site ID for which to retrieve the RAS Publishing Agent server information (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
]
PrintingSettings
Get
Retrieve information about RAS printing settings.
Site ID for which to retrieve the RAS universal printing settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"embedFonts": "boolean",
"replicatePrinterFont": "boolean",
"replicatePrinterPattern": "boolean",
"replicatePrinterDrivers": "boolean",
"driverAllowMode": "string",
"printerRetention": "string",
"printerDriversArray": [
"string"
],
"excludedFontsArray": [
"string"
],
"autoInstallFonts": [
"string"
],
"printerNamePattern": "string"
}
Update
Update printing settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RAS Printing settings
Site id (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"printerDriversArray": [
"string"
],
"excludedFontsArray": [
"string"
],
"printerNamePattern": "string",
"embedFonts": "boolean",
"replicatePrinterFont": "boolean",
"replicatePrinterPattern": "boolean",
"replicatePrinterDrivers": "boolean",
"driverAllowMode": "string",
"printerRetention": "string"
}
Success
Unauthorized
Not Found
Get Auto Install Fonts
Retrieve information about RAS printing settings font of a site.
Site ID for which to retrieve the RAS printing settings font (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Auto Install Font
Add a new RAS Printing settings font to a site.
Id of the site to which the font will be added (optional)
Font file to be uploaded.
Success
Unauthorized
Conflict
Delete Auto Install Fonts
Delete a RAS Printing settings font from a site.
RAS Printing settings font
Id of the site from which the font will be deleted (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"fontName": "string"
}
Success
Unauthorized
Not Found
PubDefaultSettings
Get
Retrieve default settings used to configure published resources for a specific Site
Site ID from which to retrieve the defaults
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"siteId": "integer (int32)",
"startPath": "string",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"replicateShortcutSettings": "boolean",
"replicateDisplaySettings": "boolean",
"waitForPrinters": "boolean",
"startMaximized": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"replicateLicenseSettings": "boolean"
}
Update
Modify default settings used to configure published resources for a specific Site
Publishing defualts configuration
Site ID from which to update the defaults
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"createShortcutOnDesktop": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"replicateLicenseSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"colorDepth": "string"
}
Success
Unauthorized
Not Found
PubFolders
List
Retrieve a list of all the published folders
Site ID for which to retrieve all the published RDS folders (optional)
Filter the result by name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
]
Create
Add a published folder to a site.
Published folder configuration
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"adminOnly": "boolean",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve information about a specified published folder.
ID of the published folder to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Update
Modify properties of a published folder.
Published folder configuration
ID of the published folder to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"adminOnly": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete
Delete a published folder
ID of the published folder to be deleted
Success
Unauthorized
Not Found
Get Client filter
Retrieves the filtered client device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Client filter
Add a client device name to the filter of type 'Client Device Name' for the specified published resource.
Published item client filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"client": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete Client filter
Delete a client device name to the filter of type 'Client Device Name' for the specified published resource.
ID of the published resource to be updated
Name of the Client filter to be deleted
Success
Unauthorized
Not Found
Get GW filter
Retrieves the filtered Gateways for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW filter
Add a RAS Secure Client Gateway to the filter of type 'Gateway' for the specified published resource.
Published item GW filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete GW filter
Delete a RAS Secure Client Gateway from the filter of type 'Gateway' for the specified published resource.
ID of the published resource to be updated
IP of the Gateway filter to be deleted
Success
Unauthorized
Not Found
Get IP filter
Retrieves the IP address list for the specified published resource.
ID of the published resource to be updated
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
]
}
Add IP filter
Add an IP address to the filter of type 'IP Address' for the specified published resource.
Published item IP filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete IP filter
Delete an IP address from the filter of type 'IP Address' for the specified published resource.
ID of the published resource to be updated
IP to be deleted from the IP filter
Success
Unauthorized
Not Found
Get MAC filter
Retrieves the filtered MAC addresses for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add MAC filter
Add a MAC address to the filter of type 'MAC Address' for the specified published resource.
Published item MAC filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"mac": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete MAC filter
Delete a MAC address from the filter of type 'MAC Address' for the specified published resource.
ID of the published resource to be updated
MAC address to be deleted from the filter
Success
Unauthorized
Not Found
Update Client OS filter
Add an OS filter for the specified published resource.
Published item client OS filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Sort
SortFolder: sort PubFolders by folder name in the Published Resources tree.
ID of Pub item to invoke.
Success
Unauthorized
Get User filter
Retrieves the filtered user accounts device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"account": "string",
"type": "string",
"sid": "string"
}
]
Add User filter
Add a User account to the filter of type 'User' for the specified published resource.
Published item user filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"sid": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete User filter
Delete a User account from the filter of type 'User' for the specified published resource.
ID of the published resource to be updated
Account of User to be deleted from the filter
Success
Unauthorized
Not Found
PubItemOSFilter
Update Client OS filter
Add an OS filter for the specified published resource.
Published item client OS filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
PubItems
List
Retrieve a list of all the published resources
Site ID for which to retrieve published resources (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve a specified published resource
ID of the published resource to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Delete
Delete a published resource
ID of the published resource to be deleted
Success
Unauthorized
Not Found
Copy
Copy (duplicate) a published item.
The Published item to be copied.
ID of Pub item to duplicate.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"parentId": "integer (int32)",
"previousId": "integer (int32)"
}
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Download Icon
Save the published resource icon to a specified directory. The command returns the full path (with filename) of the saved published resource icon.
ID of the published resource of which the icon will be retrieved
Success
Unauthorized
Not Found
Update resource icon
Publish a resource icon file name. Can be an executable (.exe), a .dll or a .ico file.
Index of the icon to be loaded from the binary specified in the Icon property(optional)
ID of the published resource for which the icon will be updated
File that will be used as the new icon
Success
Unauthorized
Not Found
Move
Move a published item to a specified node in the Published Resources tree.
The Published item to be moved.
ID of Pub item to move.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"parentId": "integer (int32)",
"previousId": "integer (int32)"
}
Success
Unauthorized
Not Found
PubRDSApps
List
Retrieve a list of all the published RDS applications
Site ID for which to retrieve all the published RDS applications (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Create
Add a published RDS application to a site.
undefined
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"target": "string",
"parameters": "string",
"startIn": "string",
"startOnLogon": "boolean",
"winType": "string",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve a specified published RDS application
ID of the published RDS application to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Update
Modify properties of a published RDS application.
Published RDS application configuration
ID of the published RDS application to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritDisplayDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"inheritLicenseDefaultSettings": "boolean",
"enableFileExtensions": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"fileExtensions": "string",
"serverId": "integer (int32)",
"target": "string",
"parameters": "string",
"startIn": "string",
"winType": "string",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"inheritShortcutDefaultSettings": "boolean",
"startOnLogon": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete
Delete a published application from a site.
ID of the published RDS application to be deleted
Success
Unauthorized
Not Found
Get Client filter
Retrieves the filtered client device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Client filter
Add a client device name to the filter of type 'Client Device Name' for the specified published resource.
Published item client filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"client": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete Client filter
Delete a client device name to the filter of type 'Client Device Name' for the specified published resource.
ID of the published resource to be updated
Name of the Client filter to be deleted
Success
Unauthorized
Not Found
Create File Extension
Add a file extension for the specified published RDS application.
File extension for published RDS application to be added
ID of the published RDS application to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"extension": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Update File Extension
Modify properties of a file extension for the specified published RDS application.
File extension for published RDS application to be updated
ID of the published RDS application to be updated
Name of the file extension that will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"parameters": "string",
"extension": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete File Extension
Remove a file extension from the specified published RDS application.
ID of the published RDS application to be updated
The file extension that will be deleted
Success
Unauthorized
Not Found
Get GW filter
Retrieves the filtered Gateways for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW filter
Add a RAS Secure Client Gateway to the filter of type 'Gateway' for the specified published resource.
Published item GW filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete GW filter
Delete a RAS Secure Client Gateway from the filter of type 'Gateway' for the specified published resource.
ID of the published resource to be updated
IP of the Gateway filter to be deleted
Success
Unauthorized
Not Found
Get IP filter
Retrieves the IP address list for the specified published resource.
ID of the published resource to be updated
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
]
}
Add IP filter
Add an IP address to the filter of type 'IP Address' for the specified published resource.
Published item IP filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete IP filter
Delete an IP address from the filter of type 'IP Address' for the specified published resource.
ID of the published resource to be updated
IP to be deleted from the IP filter
Success
Unauthorized
Not Found
Get MAC filter
Retrieves the filtered MAC addresses for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add MAC filter
Add a MAC address to the filter of type 'MAC Address' for the specified published resource.
Published item MAC filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"mac": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete MAC filter
Delete a MAC address from the filter of type 'MAC Address' for the specified published resource.
ID of the published resource to be updated
MAC address to be deleted from the filter
Success
Unauthorized
Not Found
Update Client OS filter
Add an OS filter for the specified published resource.
Published item client OS filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Get Server Attribute
Get Server Attributes for the specified published RDS application.
Specifies the RDS Application for which Server Attributes will be shown
ID of the published RDS application from which the Server Attribute will be shown
ID of the RDS Server from which attributes will be shown
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"serverId": "integer (int32)",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
]
Update Server Attribute
Add a Server Attribute for the specified published RDS application.
Specifies the Server Attribute that will be modified
ID of the published RDS application for which the Server Attribute will be updated
ID of the RDS Server for which the attribute will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"target": "string",
"startIn": "string",
"parameters": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Create Server Attribute
Add a Server Attribute for the specified published RDS application.
Specifies the Server Attribute that will be added
ID of the published RDS application for which the Server Attribute will be added
ID of the RDS Server to which the attribute will be added
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"serverID": "integer (int32)",
"target": "string",
"startIn": "string",
"parameters": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete Server Attribute
Remove a Server Attribute for the specified published RDS application.
ID of the published RDS application for which the Server Attribute will be deleted
ID of the RDS Server for which the attribute will be deleted
Success
Unauthorized
Not Found
Get User filter
Retrieves the filtered user accounts device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"account": "string",
"type": "string",
"sid": "string"
}
]
Add User filter
Add a User account to the filter of type 'User' for the specified published resource.
Published item user filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"sid": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete User filter
Delete a User account from the filter of type 'User' for the specified published resource.
ID of the published resource to be updated
Account of User to be deleted from the filter
Success
Unauthorized
Not Found
PubRDSDesktops
List
Retrieve a list of all the published RDS desktops
Site ID for which to retrieve all the published RDS desktops (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"connectToConsole": "boolean",
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"publishFrom": "string",
"useAvailableArea": "boolean",
"width": "integer (int32)",
"height": "integer (int32)",
"allowMultiMonitor": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Create
Add a published RDS desktop to a site.
undefined
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"connectToConsole": "boolean",
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"startOnLogon": "boolean",
"width": "integer (int32)",
"height": "integer (int32)",
"desktopSize": "string",
"allowMultiMonitor": "string",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"connectToConsole": "boolean",
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"publishFrom": "string",
"useAvailableArea": "boolean",
"width": "integer (int32)",
"height": "integer (int32)",
"allowMultiMonitor": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve information about a specified published RDS desktop.
ID of the published RDS desktop to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"connectToConsole": "boolean",
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"publishFrom": "string",
"useAvailableArea": "boolean",
"width": "integer (int32)",
"height": "integer (int32)",
"allowMultiMonitor": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Update
Modify properties of a specified published desktop.
Published RDS desktop configuration
ID of the published RDS desktop to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"connectToConsole": "boolean",
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"width": "integer (int32)",
"height": "integer (int32)",
"desktopSize": "string",
"allowMultiMonitor": "string",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"inheritShortcutDefaultSettings": "boolean",
"startOnLogon": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete
Delete a published RDS desktop
ID of the published RDS desktop to be deleted
Success
Unauthorized
Not Found
Get Client filter
Retrieves the filtered client device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Client filter
Add a client device name to the filter of type 'Client Device Name' for the specified published resource.
Published item client filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"client": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete Client filter
Delete a client device name to the filter of type 'Client Device Name' for the specified published resource.
ID of the published resource to be updated
Name of the Client filter to be deleted
Success
Unauthorized
Not Found
Get GW filter
Retrieves the filtered Gateways for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW filter
Add a RAS Secure Client Gateway to the filter of type 'Gateway' for the specified published resource.
Published item GW filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete GW filter
Delete a RAS Secure Client Gateway from the filter of type 'Gateway' for the specified published resource.
ID of the published resource to be updated
IP of the Gateway filter to be deleted
Success
Unauthorized
Not Found
Get IP filter
Retrieves the IP address list for the specified published resource.
ID of the published resource to be updated
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
]
}
Add IP filter
Add an IP address to the filter of type 'IP Address' for the specified published resource.
Published item IP filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete IP filter
Delete an IP address from the filter of type 'IP Address' for the specified published resource.
ID of the published resource to be updated
IP to be deleted from the IP filter
Success
Unauthorized
Not Found
Get MAC filter
Retrieves the filtered MAC addresses for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add MAC filter
Add a MAC address to the filter of type 'MAC Address' for the specified published resource.
Published item MAC filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"mac": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete MAC filter
Delete a MAC address from the filter of type 'MAC Address' for the specified published resource.
ID of the published resource to be updated
MAC address to be deleted from the filter
Success
Unauthorized
Not Found
Update Client OS filter
Add an OS filter for the specified published resource.
Published item client OS filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Get User filter
Retrieves the filtered user accounts device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"account": "string",
"type": "string",
"sid": "string"
}
]
Add User filter
Add a User account to the filter of type 'User' for the specified published resource.
Published item user filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"sid": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete User filter
Delete a User account from the filter of type 'User' for the specified published resource.
ID of the published resource to be updated
Account of User to be deleted from the filter
Success
Unauthorized
Not Found
RDS
List
Retrieve a list of RDS settings. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
Site ID for which to retrieve RDS settings (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"directAddress": "string",
"rasTemplateId": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"preferredPAId": "integer (int32)",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
],
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
]
Create
Create a new RDS host server to a site. The RD Session Host agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
RDS settings
Specifies NOT to install the RD Session Host 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 RD Session Host 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 RD Session Host agent is installed. If this parameter is omitted, the server will be restarted if required.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"server": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"directAddress": "string",
"rasTemplateId": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"preferredPAId": "integer (int32)",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
],
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Get
Retrieve a specific RDS by id. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
RDS Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"directAddress": "string",
"rasTemplateId": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"preferredPAId": "integer (int32)",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
],
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Update RD Session Host server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RDS settings
RDS id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"newServer": "string",
"description": "string",
"directAddress": "string",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"dragAndDropMode": "string",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
Success
Unauthorized
Not Found
Delete
Delete a RDS host server from a site. The RD Session Host agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.
RDS removal configuration
If this parameter is included, the RD Session Host 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 RD Session Host 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.
RDS Id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{}
Success
Unauthorized
Not Found
List Sessions Status by Server ID
Retrieve a list of sessions for a specified RDS.
RDS Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"sessionID": "integer (int32)",
"type": "string",
"state": "string",
"protocol": "string",
"user": "string",
"ip": "string",
"serverID": "integer (int32)",
"themeID": "integer (int32)",
"logonTime": "string (date-time)",
"deviceName": "string",
"idleStartTime": "string (date-time)",
"verticalResolution": "integer (int32)",
"horizontalResolution": "integer (int32)",
"colourDepth": "string"
}
Get Sessions Status
Retrieve a specific session.
(no description)
(no description)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"sessionID": "integer (int32)",
"type": "string",
"state": "string",
"protocol": "string",
"user": "string",
"ip": "string",
"serverID": "integer (int32)",
"themeID": "integer (int32)",
"logonTime": "string (date-time)",
"deviceName": "string",
"idleStartTime": "string (date-time)",
"verticalResolution": "integer (int32)",
"horizontalResolution": "integer (int32)",
"colourDepth": "string"
}
List processes by Server ID and Session ID
Retrieve the list of all processes for a specified session of a specified RDS.
Server ID for which processes of a specified RDS session will be retrieved
Session ID for which all processes will be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"appName": "string",
"process": "string",
"pid": "integer (int32)",
"user": "string",
"session": "integer (int32)",
"serverID": "integer (int32)"
}
]
Get process
Retrieve a specified process for a specified session of a specified RDS.
Server ID for which a process of a specified RDS session will be retrieved
Session ID for which a specified process will be retrieved
ID of the process to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"appName": "string",
"process": "string",
"pid": "integer (int32)",
"user": "string",
"session": "integer (int32)",
"serverID": "integer (int32)"
}
List processes by Server ID
Retrieve the list of all processes for all the sessions of a specified RDS.
Server ID for which processes for all the RDS sessions will be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"appName": "string",
"process": "string",
"pid": "integer (int32)",
"user": "string",
"session": "integer (int32)",
"serverID": "integer (int32)"
}
]
Get Status
Retrieve the RD Session Host status information for the server.
RDS id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"preferredPA": "string",
"activeSessions": "integer (int32)",
"disconnectedSessions": "integer (int32)",
"activeConnections": "integer (int32)",
"ip": "string",
"loginStatus": "string",
"updStatus": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
Disconnect Session
Invoke the RDS Session to send the Disconnect command to the RDS Session with specified Session Id.
The ID of an RD Session Host server.
Session Id of the Session to be Disconnected.
Success
Unauthorized
Not Found
LogOff Session
Invoke the RDS Session to send the LogOff command to the RDS Session with specified Session Id.
The ID of an RD Session Host server.
Session Id of the Session to be Logged Off.
Success
Unauthorized
Not Found
Send Message Session
Invoke the RDS Session to send a message to the RDS Session with specified Session Id.
RDS Session
The ID of an RD Session Host server.
Session Id of the Session to be sent a message.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"msgTitle": "string",
"message": "string"
}
Success
Unauthorized
Kill Process
Invoke the RDS Process Command to send the Kill command to the Process with specified Process Id.
The ID of an RD Session Host server.
RDS Process Id of the RDS Process to be killed.
Success
Unauthorized
Not Found
List Status by Site ID
Retrieve the list of all sessions.
Site ID of which the sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"sessionID": "integer (int32)",
"type": "string",
"state": "string",
"protocol": "string",
"user": "string",
"ip": "string",
"serverID": "integer (int32)",
"themeID": "integer (int32)",
"logonTime": "string (date-time)",
"deviceName": "string",
"idleStartTime": "string (date-time)",
"verticalResolution": "integer (int32)",
"horizontalResolution": "integer (int32)",
"colourDepth": "string"
}
]
List processes by Site ID
Retrieve the list of all processes for all the RDS sessions.
Site ID for which processes for all the RDS sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"appName": "string",
"process": "string",
"pid": "integer (int32)",
"user": "string",
"session": "integer (int32)",
"serverID": "integer (int32)"
}
]
List Status
Retrieve a list of RDS host servers with status information.
Site ID for which RDS host servers with status information will be retrieved (optional)
Filter the result by server name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"preferredPA": "string",
"activeSessions": "integer (int32)",
"disconnectedSessions": "integer (int32)",
"activeConnections": "integer (int32)",
"ip": "string",
"loginStatus": "string",
"updStatus": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
]
RDSDefaultSettings
Get
Retrieve the RDS Default settings.
Site ID for which to retrieve RDS Default settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"siteId": "integer (int32)",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
Update
Update the RD Session Host server default settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RDS settings
Site ID for which to update the RDS Default settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
Success
Unauthorized
Not Found
RDSession
List
Retrieve one or multiple RD Sessions, from different sources such as RDS and VDI.
Site ID from which to retrieve the RD session information (optional).
Source from which to retrieve the RD Session information.
The Host ID of the server for which to retrieve the information (optional).
The name of the server to filter the RD Session information (optional).
State to filter the RD Session information (optional).
User to filter the RD Session information (optional).
IP Address to filter the RD Session information (optional).
The Theme ID for which to retrieve the information (optional).
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"source": "string",
"vdiGuestId": "string",
"sessionID": "integer (int32)",
"type": "string",
"state": "string",
"protocol": "string",
"user": "string",
"ip": "string",
"serverID": "integer (int32)",
"themeID": "integer (int32)",
"logonTime": "string (date-time)",
"deviceName": "string",
"idleStartTime": "string (date-time)",
"verticalResolution": "integer (int32)",
"horizontalResolution": "integer (int32)",
"colourDepth": "string"
}
]
RDSGroups
List by Site ID
Retrieve a list of the RD Session Host server groups
Site ID for which to retrieve the RD Session Host server groups (optional)
Filter the result by name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"rdsDefSettings": {
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
},
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"rdsIds": [
"integer (int32)"
],
"id": "integer (int32)"
}
]
Create
Create a new RD Session Host server group
RDS Group
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"siteId": "integer (int32)",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"rdsIds": [
"integer (int32)"
],
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"rdsDefSettings": {
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
},
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"rdsIds": [
"integer (int32)"
],
"id": "integer (int32)"
}
List Members by Group ID
Retrieve the list of RD Session Host servers which are members of the specified group.
ID of the RD Session Host server group of which members information will be retrieved
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"directAddress": "string",
"rasTemplateId": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"preferredPAId": "integer (int32)",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
],
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
]
Add Member
Add a member to a RD Session Host server group.
RDS group member configuration
ID of the member to be added to an RD Session Host server group
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"rdsIds": [
"integer (int32)"
]
}
Success
Unauthorized
Delete Member
Delete a member from a RD Session Host server group.
ID of the member of an RD Session Host server group to be deleted
ID of the RD Session Host server group of which the member will be deleted
Success
Unauthorized
Not Found
Get
Retrieves information about a RD Session Host server group.
ID of the RD Session Host server group to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"rdsDefSettings": {
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
},
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"rdsIds": [
"integer (int32)"
],
"id": "integer (int32)"
}
Update
Modify the properties of a RD Session Host server group
The RD Session Host server group to be updated
ID of the RD Session Host server group to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"newName": "string",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"autoPreferredPA": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
Success
Unauthorized
Not Found
Delete
Delete a RD Session Host server group
ID of the RD Session Host server group to be deleted
Success
Unauthorized
Not Found
ScanningSettings
Get
Retrieve information about RAS scanning settings.
Site ID for which to retrieve the RAS universal scanning settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"twainNamePattern": "string",
"replicateTWAINPattern": "boolean",
"wiaNamePattern": "string",
"replicateWIAPattern": "boolean"
}
Update
Update scanning settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RAS Scanning settings
Site id (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"twainNamePattern": "string",
"wiaNamePattern": "string",
"replicateTWAINPattern": "boolean",
"replicateWIAPattern": "boolean"
}
Success
Unauthorized
Not Found
Session
List
Retrieves a list of admin sessions. State=1 means that a session is Connected, while State=4 means that a session is Disconnected.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"userId": "integer (int32)",
"logonTime": "string (date-time)",
"ip": "string",
"state": "string",
"computerName": "string",
"id": "integer (int32)"
}
]
LogOff Other Admin
Invoke the RAS Admin Session to send the LogOff command for the Admin with specified Session Id.
RAS Admin Session
Session Id of the Admin to be Disconnected.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{}
Success
Unauthorized
Log off
Log off user. User must be authenticated first.
Success
Unauthorized
Log on
Authenticate the user. When sucessful, an authorizaton token will be generated.
Contains the information about the session.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"username": "string",
"password": "string"
}
Success
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"authToken": "string"
}
Settings
Apply
After any of the Parallels RAS farm settings modifications, settings must be applied to commit the changes. This is equivalent of clicking the Apply button on the main Parallels RAS Console window.
Specifies if waiting for all PAs to sync is needed.
Success
Unauthorized
Export
Exports the complete Parallels RAS farm configuration to a file available for download. This functionality can be used to back up farm settings.
Success
Unauthorized
Import
This can be used to import/restore farm configuration.
File with database configuration.
Success
Unauthorized
Site
List
Retrieve the list of all the available Sites.
Filter the result by name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"name": "string",
"licensingSite": "boolean",
"id": "integer (int32)"
}
]
Create
Add a new site to the RAS farm.
The Site to be created
If this parameter is included, the Publishing Agent software will NOT be installed on the target server. You may use this option if the server already has the Publishing Agent installed.
A username to log in to the target server and push install the Publishing Agent on it. You must also specify the Password parameter. If you've included the NoInstall parameter, you don't have to include the Username and Password parameters.
The password for the user specified in the Username parameter.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"server": "string",
"name": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"licensingSite": "boolean",
"id": "integer (int32)"
}
Get
Retrieve a Site.
ID of the Site to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"name": "string",
"licensingSite": "boolean",
"id": "integer (int32)"
}
Update
Modify the Site properties.
The Site to be updated
ID of the Site to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"newName": "string"
}
Success
Unauthorized
Not Found
Delete
Delete a Site from the RAS farm.
ID of the Site to be deleted
Success
Unauthorized
Not Found
Get Status
Retrieve summary and state information about a Site
ID of the Site of which summary and state information will be retrieved.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"priority": "integer (int32)",
"name": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
List Status
Retrieve a list of the Sites summary and state information.
Filter the result by server name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"priority": "integer (int32)",
"name": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
]
WebService
Version
Retrieves the version of the Remote Application Server Web Service.
Success
Schema Definitions
Add2FAExcludeGWIP: object
- ip: string (up to 255 chars)
-
Value that represents the Gateway IP address.
Example
{
"ip": "string"
}
Add2FAExcludeIPList: object
- ip: string (up to 255 chars)
-
Value that represents the IP - ipType: string 0 = Version4, 1 = Version6, 2 = BothVersions
-
Represents the type of IP
Example
{
"ip": "string",
"ipType": "string"
}
Add2FAExcludeMACList: object
- macAddress: string (up to 17 chars)
-
A string value representing a MAC address.
Example
{
"macAddress": "string"
}
Add2FAExcludeUserGroupList: object
- account: string (1 to 255 chars)
-
A string value representing the ldap of a User/Group. - type: string 0 = Unknown, 1 = User, 2 = Group, 3 = ForeignSecurityPrincipal
-
The type of account (User/Group) being excluded, defaults to User.
Example
{
"account": "string",
"type": "string"
}
Add2FARadiusAttr: object
- vendorID: integer (int32)
-
Radius Attribute Vendor ID - attributeID: integer (int32)
-
Radius Attribute ID - value: string (up to 255 chars)
-
Radius Attribute Value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time. - name: string (up to 255 chars)
-
Radius Attribute Name - vendor: string (up to 255 chars)
-
Radius Attribute Vendor name - attributeType: string 0 = Number, 1 = String, 2 = IP, 3 = Time
-
Radius Attribute Type. IP, String, Number, Time
Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"value": "string",
"name": "string",
"vendor": "string",
"attributeType": "string"
}
AddPubItemClientFilter: object
- client: string (1 to 255 chars)
-
FQDN, computer name, or IP address of the client to add to the filter. - siteId: integer (int32)
-
Site ID.
Example
{
"client": "string",
"siteId": "integer (int32)"
}
AddPubItemGWFilter: object
- ip: string (1 to 255 chars)
-
The IP address of the RAS Secure Client Gateway to add to the filter. - siteId: integer (int32)
-
Site ID.
Example
{
"ip": "string",
"siteId": "integer (int32)"
}
AddPubItemIPFilter: object
- ip: string (1 to 255 chars)
-
The IP address to add to the filter. - siteId: integer (int32)
-
Site ID.
Example
{
"ip": "string",
"siteId": "integer (int32)"
}
AddPubItemMACFilter: object
- mac: string (1 to 255 chars)
-
The MAC address to add to the filter. - siteId: integer (int32)
-
Site ID.
Example
{
"mac": "string",
"siteId": "integer (int32)"
}
AddPubItemUserFilter: object
- account: string (1 to 255 chars)
-
The name of the user/group account to add to the filter. - sid: string (1 to 255 chars)
-
The SID of the user/group account to add to the filter. - siteId: integer (int32)
-
Site ID.
Example
{
"account": "string",
"sid": "string",
"siteId": "integer (int32)"
}
AddPubRDSAppServerAttr: object
- serverID: integer (int32)
-
RDS server id on which the attributes will be updated. - target: string (up to 255 chars)
-
Application target file. (i.e. calc.exe, file.txt, etc.) - startIn: string (up to 255 chars)
-
Application working directory. - parameters: string (up to 255 chars)
-
Application parameters. - siteId: integer (int32)
-
Site ID.
Example
{
"serverID": "integer (int32)",
"target": "string",
"startIn": "string",
"parameters": "string",
"siteId": "integer (int32)"
}
AddRDSGroupMember: object
- rdsIds: integer[]
-
The IDs of RD Session Host servers to be added to the specified group. -
integer (int32)
Example
{
"rdsIds": [
"integer (int32)"
]
}
AllowedOperatingSystems: object
- chrome: boolean
- android: boolean
- htmL5: boolean
- iOS: boolean
- linux: boolean
- mac: boolean
- webPortal: boolean
- windows: boolean
- wyse: boolean
Example
{
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
}
Certificate: object
- name: string
-
Certificate Name. - siteId: integer (int32)
-
ID of the site. - enabled: boolean
-
Whether the certificate is enabled or not. - status: string 0 = SelfSigned, 1 = Request, 2 = Imported
-
Whether the certificate is Self-Signed, Imported or Requested. - usage: string 0 = None, 2 = Gateway, 4 = HALB
-
A set of assigned certificate usages. To form a set of usages 'OR' individual usage enums. - intermediate: string
-
The intermediate. - publicKey: string
-
The public key. - request: string
-
The certificate request. - expirationDate: string (date-time)
-
The expiration date of the certificate. - keySize: string 0 = KeySize1024, 1 = KeySize2048, 2 = KeySize4096, 255 = KeySizeUnknown
-
The certificate key size. - description: string
-
The description of the certificate. - commonName: string
-
The common name of the certifate. - id: integer (int32)
-
ID of the object.
Example
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
CopyPubItem: object
- parentId: integer (int32)
-
ID of a new parent published item. To obtain the published item ID, use the Get-PubItem command. - previousId: integer (int32)
-
ID of a sibling item after which to place the specified published item. To obtain the sibling item ID, use the Get-PubItem command.
Example
{
"parentId": "integer (int32)",
"previousId": "integer (int32)"
}
DeepnetSettings: object
- activateEmail: boolean
- activateSMS: boolean
- app: string
- appID: string
- authMode: string 0 = MandatoryForAllUsers, 1 = CreateTokenForDomainAuthenticatedUsers, 2 = UsersWithDeepnetAcc
- deepnetAgent: string
- deepnetType: string 0 = DualShield, 1 = Deepnet
- defaultDomain: string
- ssl: boolean
- server: string
- port: integer (int32)
- tokenType: string 0 = FlashID, 1 = MobileID, 2 = GridID, 3 = QuickID
Example
{
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"authMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"ssl": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string"
}
GenerateCertificateRequest: object
- name: string (1 to 255 chars)
-
The name of the target Certificate. - description: string (1 to 255 chars)
-
A user-defined Certificate description. - usage: string 0 = None, 2 = Gateway, 4 = HALB
-
A set of usages to assign. To form a set of usages 'OR' individual usage enum IDs. - enabled: boolean
-
Whether to enable or disable the certificate being created. - keySize: string 0 = KeySize1024, 1 = KeySize2048, 2 = KeySize4096, 255 = KeySizeUnknown
-
The Key Size for the certificate to be generated. - countryCode: string (1 to 255 chars)
-
The Country Code for the certificate to be generated. By default, the country code from the PowerShell region information is used. - fullStateOrProvince: string (1 to 255 chars)
-
The Full State or Province for the certificate to be generated. - city: string (1 to 255 chars)
-
The City for the certificate to be generated. - organisation: string (1 to 255 chars)
-
The Organisation for the certificate to be generated. - organisationUnit: string (1 to 255 chars)
-
The Organisation Unit for the certificate to be generated. - email: string (1 to 255 chars)
-
The Email for the certificate to be generated. - commonName: string (1 to 255 chars)
-
The Common Name for the certificate to be generated.
Example
{
"name": "string",
"description": "string",
"usage": "string",
"enabled": "boolean",
"keySize": "string",
"countryCode": "string",
"fullStateOrProvince": "string",
"city": "string",
"organisation": "string",
"organisationUnit": "string",
"email": "string",
"commonName": "string"
}
GenerateSelfSignedCertificate: object
- name: string (1 to 255 chars)
-
The name of the target Certificate. - description: string (1 to 255 chars)
-
A user-defined Certificate description. - usage: string 0 = None, 2 = Gateway, 4 = HALB
-
A set of usages to assign. To form a set of usages 'OR' individual usage enum IDs. - enabled: boolean
-
Whether to enable or disable the certificate being created. - keySize: string 0 = KeySize1024, 1 = KeySize2048, 2 = KeySize4096, 255 = KeySizeUnknown
-
The Key Size for the certificate to be generated. - countryCode: string (1 to 255 chars)
-
The Country Code for the certificate to be generated. By default, the country code from the PowerShell region information is used. - expireInMonths: integer (int32)
-
To specify the length of validatity of the certificate being generated. - fullStateOrProvince: string (1 to 255 chars)
-
The Full State or Province for the certificate to be generated. - city: string (1 to 255 chars)
-
The City for the certificate to be generated. - organisation: string (1 to 255 chars)
-
The Organisation for the certificate to be generated. - organisationUnit: string (1 to 255 chars)
-
The Organisation Unit for the certificate to be generated. - email: string (1 to 255 chars)
-
The Email for the certificate to be generated.
[NOTE] This parameter is required when "expireInMonths" is present. - commonName: string (1 to 255 chars)
-
The Common Name for the certificate to be generated.
[NOTE] This parameter is required when "expireInMonths" is present.
Example
{
"name": "string",
"description": "string",
"usage": "string",
"enabled": "boolean",
"keySize": "string",
"countryCode": "string",
"expireInMonths": "integer (int32)",
"fullStateOrProvince": "string",
"city": "string",
"organisation": "string",
"organisationUnit": "string",
"email": "string",
"commonName": "string"
}
GetPubRDSAppServerAttr: object
- serverId: integer (int32)
-
RDS server id for which the attributes will be acquired. - siteId: integer (int32)
-
Site ID.
Example
{
"serverId": "integer (int32)",
"siteId": "integer (int32)"
}
GlobalPermission: object
- permissions: string 0 = None, 1 = View, 2 = Modify, 4 = ManageSessions, 8 = Add, 16 = Delete, 32 = Control
Example
{
"permissions": "string"
}
GlobalPermissions: object
- monitoring: GlobalPermission
- reporting: GlobalPermission
Example
{
"monitoring": {
"permissions": "string"
},
"reporting": {
"permissions": "string"
}
}
GW: object
- ipVersion: string 0 = Version4, 1 = Version6, 2 = BothVersions
-
The IP version for the Gateway to use. - iPs: string
-
One or multiple (separated by comma) IP addresses. - bindV4Addresses: string
-
IPv4 address to bind to. - optimizeConnectionIPv4: string
-
Optimize connection for the list of IPv4 (comma separated values). - bindV6Addresses: string
-
IPv6 address to bind to. - optimizeConnectionIPv6: string
-
Optimize connection for the list of IPv6 (comma separated values). - inheritDefaultModeSettings: boolean
-
Whether default mode settings are enabled or disabled. - inheritDefaultNetworkSettings: boolean
-
Whether default network settings are enabled or disabled. - inheritDefaultSslTlsSettings: boolean
-
Whether default SSL/TLS settings are enabled or disabled. - inheritDefaultHTML5Settings: boolean
-
Whether default HTML5 settings are enabled or disabled. - inheritDefaultWyseSettings: boolean
-
Whether default wyse settings are enabled or disabled. - inheritDefaultSecuritySettings: boolean
-
Whether default security settings are enabled or disabled. - inheritDefaultWebSettings: boolean
-
Whether default web settings are enabled or disabled. - gwMode: string 0 = Normal, 1 = Forwarding
-
Gateway mode: Normal or Forwarding. - normalModeForwarding: boolean
-
Whether forwarding requests to HTTP server are enabled or disabled. - forwardGatewayServers: string
-
One or multiple (separated by comma) Forwarding Gateway Servers. - preferredPAId: integer (int32)
-
ID of the Preferred Publishing Agent. - forwardHttpServers: string
-
One or multiple (separated by comma) Forwarding HTTP Servers. - enableGWPort: boolean
-
Whether a custom RAS Secure Client Gateway port is enabled or disabled. - gwPort: integer (int32)
-
A custom Gateway port number. - enableRDP: boolean
-
Whether a custom RDP port is enabled or disabled. - rdpPort: integer (int32)
-
A custom RDP port number. - broadcast: boolean
-
Whether the 'Broadcast RAS Secure Client Gateway Address' option is enabled or disabled. - enableRDPUDP: boolean
-
Whether the 'RDP UDP Data Tunneling' option is enabled or disabled. - enableClientManagerPort: boolean
-
Whether the 'Client Manager Port' option is enabled or disabled. - dosPro: boolean
-
Whether the 'RDP DOS Attack Filter' option is enabled or disabled. - enableSSL: boolean
-
Whether SSL is enabled or disabled. - sslPort: integer (int32)
-
SSL port number. - minSSLVersion: string 0 = SSLv2, 1 = SSLv3, 2 = TLSv1, 3 = TLSv1_1, 4 = TLSv1_2
-
Minimum SSL version. - cipherStrength: string 0 = Low, 1 = Medium, 2 = High, 3 = Custom
-
Cipher strength. - cipher: string
-
Cipher string. - certificateId: integer (int32)
-
The ID of the specific Certificate to be used. - enableHSTS: boolean
-
Whether HSTS is enabled or disabled. - hstsMaxAge: integer (int32)
-
Set Maximum Age of HSTS. - hstsIncludeSubdomains: boolean
-
Whether HSTS to include subdomains option is enabled or disabled. - hstsPreload: boolean
-
Whether HSTS to preload option is enabled or disabled. - enableHTML5: boolean
-
Whether HTML5 connectivity on the Gateway is enabled or disabled. - htmL5Port: integer (int32)
-
A custom HTML5 port number. - launchMethod: string 0 = ParallelsClientAndHTML5, 1 = ParallelsClient, 2 = HTML5
-
Launch method: 0=ParallelsClientAndHTML5, 1=ParallelsClient, 2=HTML5. - allowLaunchMethod: boolean
-
Allow users to select a resource launch method. - allowAppsInNewTab: boolean
-
Allow users to start applications in a new browser tab. - usePreWin2000LoginFormat: boolean
-
Whether the 'Use Pre Windows 2000 Login Format' option is enabled or disabled. - allowEmbed: boolean
-
Allow embedding of Web Client into other web pages. - allowFileTransfer: boolean
-
Whether the 'Allow file transfer' option is enabled or disabled. - allowClipboard: boolean
-
Whether the 'Allow Clipboard' option is enabled or disabled. - enableAlternateNLBHost: boolean
-
Whether alternate NLB Host is enabled or disabled. - alternateNLBHost: string
-
Alternate NLB Host name. - enableAlternateNLBPort: boolean
-
Whether alternate NLB Port is enabled or disabled. - alternateNLBPort: integer (int32)
-
Alternate NLB Port number. - enableWyseSupport: boolean
-
Whether support for Wyse Thin Client OS is enabled or disabled. - securityMode: string 0 = AllowAllExcept, 1 = AllowOnly
-
GW Security Mode: 0=Allow All Except, 1=Allow Only. - macAllowExcept: string[]
-
Lists all the Security 'MAC Allow Except' MAC addresses. -
string - macAllowOnly: string[]
-
Lists all the Security 'MAC Allow Only' MAC addresses. -
string - webRequestsURL: string
-
The URL for Web requests. - webCookie: string
-
The Web Cookie Name used by RAS. - server: string
-
Server name. - enabled: boolean
-
Whether the server is enabled or not. - description: string
-
Description of the server. - siteId: integer (int32)
-
ID of the site. - id: integer (int32)
-
ID of the object.
Example
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
GWDefaultSiteSettings: object
- siteId: integer (int32)
- gwMode: string 0 = Normal, 1 = Forwarding
-
Gateway mode: Normal or Forwarding. - normalModeForwarding: boolean
-
Whether forwarding requests to HTTP server are enabled or disabled. - forwardGatewayServers: string
-
One or multiple (separated by comma) Forwarding Gateway Servers. - preferredPAId: integer (int32)
-
ID of the Preferred Publishing Agent. - forwardHttpServers: string
-
One or multiple (separated by comma) Forwarding HTTP Servers. - enableGWPort: boolean
-
Whether a custom RAS Secure Client Gateway port is enabled or disabled. - gwPort: integer (int32)
-
A custom Gateway port number. - enableRDP: boolean
-
Whether a custom RDP port is enabled or disabled. - rdpPort: integer (int32)
-
A custom RDP port number. - broadcast: boolean
-
Whether the 'Broadcast RAS Secure Client Gateway Address' option is enabled or disabled. - enableRDPUDP: boolean
-
Whether the 'RDP UDP Data Tunneling' option is enabled or disabled. - enableClientManagerPort: boolean
-
Whether the 'Client Manager Port' option is enabled or disabled. - dosPro: boolean
-
Whether the 'RDP DOS Attack Filter' option is enabled or disabled. - enableSSL: boolean
-
Whether SSL is enabled or disabled. - sslPort: integer (int32)
-
SSL port number. - minSSLVersion: string 0 = SSLv2, 1 = SSLv3, 2 = TLSv1, 3 = TLSv1_1, 4 = TLSv1_2
-
Minimum SSL version. - cipherStrength: string 0 = Low, 1 = Medium, 2 = High, 3 = Custom
-
Cipher strength. - cipher: string
-
Cipher string. - certificateId: integer (int32)
-
The ID of the specific Certificate to be used. - enableHSTS: boolean
-
Whether HSTS is enabled or disabled. - hstsMaxAge: integer (int32)
-
Set Maximum Age of HSTS. - hstsIncludeSubdomains: boolean
-
Whether HSTS to include subdomains option is enabled or disabled. - hstsPreload: boolean
-
Whether HSTS to preload option is enabled or disabled. - enableHTML5: boolean
-
Whether HTML5 connectivity on the Gateway is enabled or disabled. - htmL5Port: integer (int32)
-
A custom HTML5 port number. - launchMethod: string 0 = ParallelsClientAndHTML5, 1 = ParallelsClient, 2 = HTML5
-
Launch method: 0=ParallelsClientAndHTML5, 1=ParallelsClient, 2=HTML5. - allowLaunchMethod: boolean
-
Allow users to select a resource launch method. - allowAppsInNewTab: boolean
-
Allow users to start applications in a new browser tab. - usePreWin2000LoginFormat: boolean
-
Whether the 'Use Pre Windows 2000 Login Format' option is enabled or disabled. - allowEmbed: boolean
-
Allow embedding of Web Client into other web pages. - allowFileTransfer: boolean
-
Whether the 'Allow file transfer' option is enabled or disabled. - allowClipboard: boolean
-
Whether the 'Allow Clipboard' option is enabled or disabled. - enableAlternateNLBHost: boolean
-
Whether alternate NLB Host is enabled or disabled. - alternateNLBHost: string
-
Alternate NLB Host name. - enableAlternateNLBPort: boolean
-
Whether alternate NLB Port is enabled or disabled. - alternateNLBPort: integer (int32)
-
Alternate NLB Port number. - enableWyseSupport: boolean
-
Whether support for Wyse Thin Client OS is enabled or disabled. - securityMode: string 0 = AllowAllExcept, 1 = AllowOnly
-
GW Security Mode: 0=Allow All Except, 1=Allow Only. - macAllowExcept: string[]
-
Lists all the Security 'MAC Allow Except' MAC addresses. -
string - macAllowOnly: string[]
-
Lists all the Security 'MAC Allow Only' MAC addresses. -
string - webRequestsURL: string
-
The URL for Web requests. - webCookie: string
-
The Web Cookie Name used by RAS.
Example
{
"siteId": "integer (int32)",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
GWSysInfo: object
- gwMode: string 0 = Normal, 1 = Forwarding
-
The Gateway mode: Normal or Forwarding. - cipherStrength: string 0 = Low, 1 = Medium, 2 = High, 3 = Custom
-
Cipher strength: 0=Low, 1=Medium, 2=High, 3=Custom. - cipherStr: string
-
Cipher string. - availableIPs: string
-
Local IP list. - preferredPA: string
-
Preferred Publishing Agent. - clientConns: integer (int32)
-
Number of client connections. - maxClientConns: integer (int32)
-
Number of maximum client connections. - clientSSLConns: integer (int32)
-
Number of client SSL connections. - maxClientSSLConns: integer (int32)
-
Number of maximum client SSL connections. - httpRedirs: integer (int32)
-
Number of HTTP redirections. - httpsRedirs: integer (int32)
-
Number of HTTPS redirections. - maxHTTPRedirs: integer (int32)
-
Number of maximum HTTP redirections. - maxHTTPSRedirs: integer (int32)
-
Number of maximum HTTPS redirections. - wyseConns: integer (int32)
-
Number of WYSE connections. - maxWyseConns: integer (int32)
-
Number of maximum WYSE connections. - wyseSSLConns: integer (int32)
-
Number of WYSE SSL connections. - maxWyseSSLConns: integer (int32)
-
Number of maximum WYSE SSL connections. - htmL5Conns: integer (int32)
-
Number of HTML5 connections. - htmL5SSLConns: integer (int32)
-
Number of HTML5 SSL connections. - maxHTML5Conns: integer (int32)
-
Number of maximum HTML5 connections. - maxHTML5SSLConns: integer (int32)
-
Number of maximum HTML5 SSL connections. - clientMgrTCPConns: integer (int32)
-
Number of client manager TCP connections. - clientMgrTCPSSLConns: integer (int32)
-
Number of client manager TCP SSL connections. - maxClientMgrTCPConns: integer (int32)
-
Number of maximum client manager TCP connections. - maxClientMgrTCPSSLConns: integer (int32)
-
Number of maximum client manager TCP SSL connections. - activeRDPSessions: integer (int32)
-
Number of active RDP sessions. - activeRDPSSLSessions: integer (int32)
-
Number of active RDP SSL sessions. - maxRDPSessions: integer (int32)
-
Number of maximum RDP sessions. - maxRDPSSLSessions: integer (int32)
-
Number of maximum RDP SSL sessions. - rdpudpTunnels: integer (int32)
-
Number of RDP UDP tunnels. - rdpudpdtlsTunnels: integer (int32)
-
Number of RDP UDP DTLS tunnels. - maxRDPUDPTunnels: integer (int32)
-
Number of maximum RDP UDP tunnels. - maxRDPUDPDTLSTunnels: integer (int32)
-
Number of maximum RDP UDP DTLS tunnels. - totalConnections: integer (int32)
-
Number of total connections. - cachedSockets: integer (int32)
-
Number of cached sockets. - activeThreads: integer (int32)
-
Number of active threads. - idleThreads: integer (int32)
-
Number of idle threads. - securityMode: string 0 = AllowAllExcept, 1 = AllowOnly
-
Gateway security mode: 0=Allow All Except, 1=Allow Only. - gatewayTCPSock: string
-
Gateway TCP socket. - rdptcpSock: string
-
RDP TCP socket. - sslVersion: string 0 = SSLv2, 1 = SSLv3, 2 = TLSv1, 3 = TLSv1_1, 4 = TLSv1_2
-
SSL version. - gatewaySSLTCPSock: string
-
Gateway SSL TCP socket. - clientManagerUDPSock: string
-
Client manager UDP socket. - htmL5TCPSock: string
-
HTML5 TCP socket. - broadcastUDPSock: string
-
Broadcast UDP socket. - rdpTunnelUDPSock: string
-
RDP tunnel UDP socket. - rdpTunnelSSLUDPSock: string
-
RDP tunnel SSL UDP socket. - serverMessage: string
-
Server message. - fipsMode: string
-
FIPS mode: 0=Disabled, 1=FIPS 140-2, 2=FIPS encryption failed, 3=FIPS is not supported. - cpuLoad: integer (int32)
-
CPU load percentage. - memLoad: integer (int32)
-
Memory load percentage. - diskRead: integer (int32)
-
Disk Read. - diskWrite: integer (int32)
-
Disk Write. - enabled: boolean
-
Enabled or not. - id: string
-
ID of RAS Agent. - server: string
-
Server name. - siteId: integer (int32)
-
ID of Site. - agentVer: string
-
Agent Version. - serverOS: string
-
Server Operating System. - serviceStartTime: string
-
Service start time. - systemBootTime: string
-
System boot time. - unhandledExceptions: integer (int32)
-
Number of unhandled exceptions. - agentState: string 0 = OK, 1 = EnumSessionsFailed, 2 = RDSRoleDisabled, 3 = MaxNonCompletedSessions, 4 = RASScheduleInProgress, 5 = ConnectionFailed, 6 = InvalidCredentials, 7 = NeedsSysprep, 8 = SysPrepInProgress, 9 = CloningFailed, 10 = Synchronising, 12 = FinalizingSysprep, 13 = LogonDrainUntilRestart, 14 = LogonDrain, 15 = LogonDisabled, 16 = ForcedDisconnect, 17 = CloningCanceled, 18 = RASprepInProgress, 19 = FinalizingRASprep, 20 = InstallingRDSRole, 21 = RebootPending, 22 = PortMismatch, 23 = NeedsDowngrade, 24 = NotApplied, 25 = CloningInProgress, 26 = MarkedForDeletion, 27 = StandBy, 28 = UnsupportedVDIType, 29 = FreeESXLicenseNotSupported, 30 = ManagedESXNotSupported, 31 = HotfixKB2580360NotInstalled, 32 = InvalidHostVersion, -6 = Unknown, -5 = NeedsUpdate, -4 = NotVerified, -3 = ServerDeleted, -2 = DisabledFromSettings, -1 = Disconnected
-
Agent State. - serverType: string 1 = RDS, 2 = VDIHost, 3 = Gateway, 4 = Guest, 5 = PC, 6 = VDITemplate, 7 = PA, 9 = Site, -1 = All
-
Type of server. - logLevel: string 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard, 4 = Extended, 5 = Verbose
-
Level of logging: 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard (Information), 4 = Extended, 5 = Verbose (Trace).
Example
{
"gwMode": "string",
"cipherStrength": "string",
"cipherStr": "string",
"availableIPs": "string",
"preferredPA": "string",
"clientConns": "integer (int32)",
"maxClientConns": "integer (int32)",
"clientSSLConns": "integer (int32)",
"maxClientSSLConns": "integer (int32)",
"httpRedirs": "integer (int32)",
"httpsRedirs": "integer (int32)",
"maxHTTPRedirs": "integer (int32)",
"maxHTTPSRedirs": "integer (int32)",
"wyseConns": "integer (int32)",
"maxWyseConns": "integer (int32)",
"wyseSSLConns": "integer (int32)",
"maxWyseSSLConns": "integer (int32)",
"htmL5Conns": "integer (int32)",
"htmL5SSLConns": "integer (int32)",
"maxHTML5Conns": "integer (int32)",
"maxHTML5SSLConns": "integer (int32)",
"clientMgrTCPConns": "integer (int32)",
"clientMgrTCPSSLConns": "integer (int32)",
"maxClientMgrTCPConns": "integer (int32)",
"maxClientMgrTCPSSLConns": "integer (int32)",
"activeRDPSessions": "integer (int32)",
"activeRDPSSLSessions": "integer (int32)",
"maxRDPSessions": "integer (int32)",
"maxRDPSSLSessions": "integer (int32)",
"rdpudpTunnels": "integer (int32)",
"rdpudpdtlsTunnels": "integer (int32)",
"maxRDPUDPTunnels": "integer (int32)",
"maxRDPUDPDTLSTunnels": "integer (int32)",
"totalConnections": "integer (int32)",
"cachedSockets": "integer (int32)",
"activeThreads": "integer (int32)",
"idleThreads": "integer (int32)",
"securityMode": "string",
"gatewayTCPSock": "string",
"rdptcpSock": "string",
"sslVersion": "string",
"gatewaySSLTCPSock": "string",
"clientManagerUDPSock": "string",
"htmL5TCPSock": "string",
"broadcastUDPSock": "string",
"rdpTunnelUDPSock": "string",
"rdpTunnelSSLUDPSock": "string",
"serverMessage": "string",
"fipsMode": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
InvokeLicActivate: object
- email: string
-
The email address you use to log in to Parallels My Account. - password: string
-
Your Parallels account password. - key: string
-
Parallels RAS License Key. The key must be registered in Parallels My Account. To activate Parallels RAS as a trial version, omit this parameter.
Example
{
"email": "string",
"password": "string",
"key": "string"
}
InvokeLicDeactivate: object
- email: string
-
The email address you use to log in to Parallels My Account. - password: string
-
Your Parallels account password.
Example
{
"email": "string",
"password": "string"
}
InvokePAPromote: object
- paUsername: string
-
An administrator account for connecting with the new PA server (the one being promoted). If this parameter is omitted, your RAS admin username (and password) will be used. - paPassword: string
-
The password of the account specified in the PAUsername parameter.
Example
{
"paUsername": "string",
"paPassword": "string"
}
InvokeRDSSession: object
- msgTitle: string (1 to 255 chars)
-
The message title for the session message. - message: string (1 to 255 chars)
-
The session message to be sent.
Example
{
"msgTitle": "string",
"message": "string"
}
MovePubItem: object
- parentId: integer (int32)
-
ID of a new published item parent. To obtain the published item ID, use the Get-PubItem command. For the root node, set ParentId to '0' (zero). - previousId: integer (int32)
-
ID of a sibling after which to place the specified published item. To obtain the sibling item ID, use the Get-PubItem command.
Example
{
"parentId": "integer (int32)",
"previousId": "integer (int32)"
}
NewGW: object
- server: string (1 to 255 chars)
-
FQDN or IP address of the server to be added to a site as a RAS Secure Client Gateway. - siteId: integer (int32)
-
The site ID to which the Gateway should be added. To obtain the ID of a desired site, use the appropriate command to Get Sites. If the parameter is omitted, the site ID of the Licensing Server will be used.
Example
{
"server": "string",
"siteId": "integer (int32)"
}
NewPA: object
- server: string (1 to 255 chars)
-
FQDN or IP address of the server to add to a site as a RAS Publishing Agent. - siteId: integer (int32)
-
Site ID to which to add the RAS Publishing Agent server. If the parameter is omitted, the Licensing Server site ID will be used.
Example
{
"server": "string",
"siteId": "integer (int32)"
}
NewPubFolder: object
- adminOnly: boolean false
-
Use folder for administrative purposes only. - name: string (1 to 255 chars)
-
Published resource name. - parentId: integer (int32)
-
Parent publishing folder Id. - previousId: integer (int32)
-
Previous published Id. - enabled: boolean
-
Enable or disable a published resource. - description: string (up to 255 chars)
-
Published resource description. - publishToSiteIds: integer[]
-
An array of Sites Ids to which to publish a resource. -
integer (int32) - siteId: integer (int32)
-
Site ID. - ipFilterEnabled: boolean
-
Enable or disable IP filters. - ipFilterReplicate: boolean
-
Replicate or not IP filters. - clientFilterEnabled: boolean
-
Enable or disable client filters. - clientFilterReplicate: boolean
-
Replicate or not client filters. - macFilterEnabled: boolean
-
Enable or disable mac filters. - macFilterReplicate: boolean
-
Replicate or not mac filters. - userFilterEnabled: boolean
-
Enable or disable user filters. - userFilterReplicate: boolean
-
Replicate or not user filters. - gwFilterEnabled: boolean
-
Enable or disable GW filters.
Example
{
"adminOnly": "boolean",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
NewPubRDSApp: object
- publishFrom: string 0 = All, 1 = Group, 2 = Server
-
Specifies the 'Publish from' option. Acceptable values: All (All servers in the site), Group (Server Groups), Server (Individual Servers). - publishFromGroupIds: integer[]
-
Specifies one or multiple group Ids from which to publish the application. The PublishFrom parameter must specify 1 (Server groups). -
integer (int32) - publishFromServerIds: integer[]
-
Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Individual Servers). -
integer (int32) - target: string
-
File name and path of a published application executable. - parameters: string
-
Optional parameters to pass to the published application executable. - startIn: string
-
Folder name in which to start a published application. - startOnLogon: boolean false
-
Enables or disables the 'Start automatically when user logs on' option. - winType: string 0 = Normal, 1 = Maximized, 2 = Minimized
-
Published application window type. Acceptable values: Normal, Maximized, Minimized - name: string (1 to 255 chars)
-
Published resource name. - parentId: integer (int32)
-
Parent publishing folder Id. - previousId: integer (int32)
-
Previous published Id. - enabled: boolean
-
Enable or disable a published resource. - description: string (up to 255 chars)
-
Published resource description. - publishToSiteIds: integer[]
-
An array of Sites Ids to which to publish a resource. -
integer (int32) - siteId: integer (int32)
-
Site ID. - ipFilterEnabled: boolean
-
Enable or disable IP filters. - ipFilterReplicate: boolean
-
Replicate or not IP filters. - clientFilterEnabled: boolean
-
Enable or disable client filters. - clientFilterReplicate: boolean
-
Replicate or not client filters. - macFilterEnabled: boolean
-
Enable or disable mac filters. - macFilterReplicate: boolean
-
Replicate or not mac filters. - userFilterEnabled: boolean
-
Enable or disable user filters. - userFilterReplicate: boolean
-
Replicate or not user filters. - gwFilterEnabled: boolean
-
Enable or disable GW filters.
Example
{
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"target": "string",
"parameters": "string",
"startIn": "string",
"startOnLogon": "boolean",
"winType": "string",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
NewPubRDSDesktop: object
- connectToConsole: boolean false
-
Enables or disables the 'Connect to console' option. - publishFrom: string 0 = All, 1 = Group, 2 = Server
-
Specifies the 'Publish from' option. Acceptable values: All (All servers in the site), Group (Server Groups), Server (Individual Servers). - publishFromGroupIds: integer[]
-
Specifies one or multiple group Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (Server groups). -
integer (int32) - publishFromServerIds: integer[]
-
Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Individual Servers). -
integer (int32) - startOnLogon: boolean false
-
Enables or disables the 'Start automatically when user logs on' option. - width: integer (int32)
-
Specified a custom desktop width. - height: integer (int32)
-
Specifies a custom desktop height. - desktopSize: string 0 = UseAvailableArea, 1 = FullScreen, 2 = W640xH480, 3 = W800xH600, 4 = W854xH480, 5 = W1024xH576, 6 = W1024xH768, 7 = W1152xH864, 8 = W1280xH720, 9 = W1280xH768, 10 = W1280xH800, 11 = W1280xH960, 12 = W1280xH1024, 13 = W1360xH768, 14 = W1366xH768, 15 = W1400xH1050, 16 = W1440xH900, 17 = W1600xH900, 18 = W1600xH1024, 19 = W1600xH1200, 20 = W1680xH1050, 21 = W1920xH1080, 22 = W1920xH1200, 23 = W1920xH1440, 24 = W2048xH1152, 25 = Custom
-
Desktop Size. Possible values are: 0 (Use available area), 1 (Full screen), Custom = 25. Acceptable values: 640x480, 800x600, 854x480, 1024x576, 1024x768, 1152x864, 1280x720, 1280x768, 1280x800, 1280x960, 1280x1024, 1360x768, 1366x768, 1400x1050, 1440x900, 1600x900, 1600x1024, 1600x1200, 1680x1050, 1920x1440, 1920x1080, 1920x1200, 2048x1152 - allowMultiMonitor: string 0 = Enabled, 1 = Disabled, 2 = UseClientSettings
-
Specifies the "Multi-monitor" option. Acceptable values: Enabled, Disabled, UseClientSettings. - name: string (1 to 255 chars)
-
Published resource name. - parentId: integer (int32)
-
Parent publishing folder Id. - previousId: integer (int32)
-
Previous published Id. - enabled: boolean
-
Enable or disable a published resource. - description: string (up to 255 chars)
-
Published resource description. - publishToSiteIds: integer[]
-
An array of Sites Ids to which to publish a resource. -
integer (int32) - siteId: integer (int32)
-
Site ID. - ipFilterEnabled: boolean
-
Enable or disable IP filters. - ipFilterReplicate: boolean
-
Replicate or not IP filters. - clientFilterEnabled: boolean
-
Enable or disable client filters. - clientFilterReplicate: boolean
-
Replicate or not client filters. - macFilterEnabled: boolean
-
Enable or disable mac filters. - macFilterReplicate: boolean
-
Replicate or not mac filters. - userFilterEnabled: boolean
-
Enable or disable user filters. - userFilterReplicate: boolean
-
Replicate or not user filters. - gwFilterEnabled: boolean
-
Enable or disable GW filters.
Example
{
"connectToConsole": "boolean",
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"startOnLogon": "boolean",
"width": "integer (int32)",
"height": "integer (int32)",
"desktopSize": "string",
"allowMultiMonitor": "string",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
NewRASAdminAccount: object
- name: string (1 to 255 chars)
-
The name of a user or group to add to the farm as an administrator. - email: string (1 to 255 chars)
-
The user email address. - mobile: string (1 to 50 chars)
-
The user mobile phone number. - enabled: boolean
-
Whether enable or disable this administrator in the farm. - notify: string 0 = None, 1 = Email
-
Sets the "Receive system notifications via" option. Possible values are: "None", "Email". - fullPermissions: boolean
-
Enables or disables the "Full Permissions" option. - permissions: string 0 = PowerAdmin, 1 = RootAdmin, 2 = CustomAdmin
-
Specifies the type of permission to use.
Example
{
"name": "string",
"email": "string",
"mobile": "string",
"enabled": "boolean",
"notify": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
NewRASSession: object
- username: string (1 to 255 chars)
-
Parallels RAS administrator username.
[NOTE] This parameter is required when "password" is present. - password: string
-
Parallels RAS administrator password.
[NOTE] This parameter is required when "username" is present.
Example
{
"username": "string",
"password": "string"
}
NewRDS: object
- server: string (1 to 255 chars)
-
An RD Session Host server FQDN or IP address. - siteId: integer (int32)
-
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
Example
{
"server": "string",
"siteId": "integer (int32)"
}
NewRDSGroup: object
- name: string (1 to 255 chars)
-
Group name. - siteId: integer (int32)
-
Site ID in which to create the group. If the parameter is omitted, the site ID of the Licensing Server will be used. - description: string (1 to 255 chars)
-
A description of the specified group. - useRASTemplate: boolean false
-
Enables use of RAS Template. - rasTemplateId: integer (int32)
-
The RD RAS Template Id. - workLoadThreshold: integer (int32)
-
Send a request to the RAS template when the workload threshold is above the specified value Default: 75 - serversToAddPerRequest: integer (int32)
-
Number of servers to be added to the group per request Default: 1 - maxServersFromTemplate: integer (int32)
-
Max number of servers to be added to the group from the RAS Template Default: 2 - workLoadToDrain: integer (int32)
-
Drain and unassign servers from group when workload is below the specified value Default: 20 - rdsIds: integer[]
-
A list of RD Session Host servers (an array of RDS Ids) to add to the group. -
integer (int32) - inheritDefaultAgentSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global agent settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultPrinterSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global printer settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultUPDSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global User Profile Disk settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultDesktopAccessSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global Desktop Access settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - port: integer (int32)
-
Specifies the port number for the RD Session Host agent. - maxSessions: integer (int32)
-
Specifies the 'Maximum Sessions' property. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Sessions Disconnect Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration). - supportShellURLNamespaceObjects: boolean
-
Enables or disables the 'Support Shell URL Namespace Objects' option. - preferredPAId: integer (int32)
-
The preferred Publishing Agent server. - allowRemoteExec: boolean
-
Enables or disables the 'Allow 2XRemoteExec to send command to the client' option. - enableAppMonitoring: boolean
-
Enables or disables the 'Application Monitoring' option. - useRemoteApps: boolean
-
Enables or disables the 'Use RemoteApps if available' option. - allowFileTransfer: boolean
-
Enables or disables the 'Allow file transfer' option. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES. - removeClientNameFromPrinterName: boolean
-
Enables or disables the 'Remove client name from printer name' option. - removeSessionNumberFromPrinterName: boolean
-
Enables or disables the 'Remove session number from printer name' option. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled. - updRoamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include. - upDiskPath: string (up to 255 chars)
-
Specifies the User Profile Disk path. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Enables or disables the 'Restrict direct desktop access to the following users' option. Use the RestrictedUsers parameter to specify the list of users. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs. -
string
Example
{
"name": "string",
"siteId": "integer (int32)",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"rdsIds": [
"integer (int32)"
],
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
NewSite: object
- server: string (1 to 255 chars)
-
The target server FQDN or IP address. - name: string (1 to 255 chars)
-
The name you want to use for the new site.
Example
{
"server": "string",
"name": "string"
}
ObjectPermission: object
- objId: integer (int32)
- permissions: string 0 = None, 1 = View, 2 = Modify, 4 = ManageSessions, 8 = Add, 16 = Delete, 32 = Control
Example
{
"objId": "integer (int32)",
"permissions": "string"
}
PA: object
- priority: integer (int32)
-
Priority of the specified RAS PA server. - ip: string
-
IP address of RAS PA server. - alternativeIPs: string
-
Alternative IPs to access the RAS PA server. - standby: boolean
-
Whether the RAS PA server is in standby mode or not. - markedForDeletion: boolean
-
Whether the RAS PA server is marked for deletion or not. - server: string
-
Server name. - enabled: boolean
-
Whether the server is enabled or not. - description: string
-
Description of the server. - siteId: integer (int32)
-
ID of the site. - id: integer (int32)
-
ID of the object.
Example
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
PASysInfo: object
- cpuLoad: integer (int32)
-
CPU load percentage. - memLoad: integer (int32)
-
Memory load percentage. - diskRead: integer (int32)
-
Disk Read. - diskWrite: integer (int32)
-
Disk Write. - enabled: boolean
-
Enabled or not. - id: string
-
ID of RAS Agent. - server: string
-
Server name. - siteId: integer (int32)
-
ID of Site. - agentVer: string
-
Agent Version. - serverOS: string
-
Server Operating System. - serviceStartTime: string
-
Service start time. - systemBootTime: string
-
System boot time. - unhandledExceptions: integer (int32)
-
Number of unhandled exceptions. - agentState: string 0 = OK, 1 = EnumSessionsFailed, 2 = RDSRoleDisabled, 3 = MaxNonCompletedSessions, 4 = RASScheduleInProgress, 5 = ConnectionFailed, 6 = InvalidCredentials, 7 = NeedsSysprep, 8 = SysPrepInProgress, 9 = CloningFailed, 10 = Synchronising, 12 = FinalizingSysprep, 13 = LogonDrainUntilRestart, 14 = LogonDrain, 15 = LogonDisabled, 16 = ForcedDisconnect, 17 = CloningCanceled, 18 = RASprepInProgress, 19 = FinalizingRASprep, 20 = InstallingRDSRole, 21 = RebootPending, 22 = PortMismatch, 23 = NeedsDowngrade, 24 = NotApplied, 25 = CloningInProgress, 26 = MarkedForDeletion, 27 = StandBy, 28 = UnsupportedVDIType, 29 = FreeESXLicenseNotSupported, 30 = ManagedESXNotSupported, 31 = HotfixKB2580360NotInstalled, 32 = InvalidHostVersion, -6 = Unknown, -5 = NeedsUpdate, -4 = NotVerified, -3 = ServerDeleted, -2 = DisabledFromSettings, -1 = Disconnected
-
Agent State. - serverType: string 1 = RDS, 2 = VDIHost, 3 = Gateway, 4 = Guest, 5 = PC, 6 = VDITemplate, 7 = PA, 9 = Site, -1 = All
-
Type of server. - logLevel: string 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard, 4 = Extended, 5 = Verbose
-
Level of logging: 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard (Information), 4 = Extended, 5 = Verbose (Trace).
Example
{
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
PubAppAttr: object
- parameters: string
- startIn: string
- target: string
- serverId: integer (int32)
Example
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
PubDefaultSettings: object
- siteId: integer (int32)
-
ID of the Site. - startPath: string
-
Starting path of the settings. - createShortcutOnDesktop: boolean
-
Whether the 'Create shortcut on Desktop' option is enabled or not. - createShortcutInStartFolder: boolean
-
Whether the 'Create shortcut in Start Folder' option is enabled or not. - createShortcutInStartUpFolder: boolean
-
Whether the 'Create shortcut in Auto Start Folder' option is enabled or not. - replicateShortcutSettings: boolean
-
Whether the 'Replicate Settings' option is enabled or not. - replicateDisplaySettings: boolean
-
Whether the 'Replicate Display Settings' option is enabled or not. - waitForPrinters: boolean
-
Whether the option 'Wait until all RAS Universal Printers are redirected before showing the application' is enabled or not. - startMaximized: boolean
-
Whether the option 'Start Maximized' is enabled or not. - waitForPrintersTimeout: integer (int32)
-
Printer redirection timeout(in seconds). Works together with the WaitForPrinters parameter. - colorDepth: string 0 = Colors8Bit, 1 = Colors15Bit, 2 = Colors16Bit, 3 = Colors24Bit, 4 = Colors32Bit, 5 = ClientSpecified
-
Specifies the display color depth setting: 0=Colors8Bit, 1=Colors15Bit, 2=Colors16Bit, 3=Colors24Bit, 4=Colors32Bit, 5=ClientSpecified. - disableSessionSharing: boolean
-
Whether the option 'Disable Session Sharing' is enabled or not. - oneInstancePerUser: boolean
-
Whether the option 'Allow users to start only one instance of the application' is enabled or not. - conCurrentLicenses: integer (int32)
-
Specifies the number of concurrent licenses (the 'Concurrent licenses' option). - licenseLimitNotify: string 0 = WarnUserAndNoStart, 1 = WarnUserAndStart, 2 = NotifyAdminAndStart, 3 = NotifyUserAdminAndStart, 4 = NotifyUserAdminAndNoStart
-
Specifies an action to perform when the license limit is exceeded.: 0=Warn user and do not start, 1=Notify administrator and start, 2=Notify user, administrator and start, 3=Notify user, administrator and do not start. - replicateLicenseSettings: boolean
-
Whether the option 'Replicate license settings' is enabled or not.
Example
{
"siteId": "integer (int32)",
"startPath": "string",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"replicateShortcutSettings": "boolean",
"replicateDisplaySettings": "boolean",
"waitForPrinters": "boolean",
"startMaximized": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"replicateLicenseSettings": "boolean"
}
PubFileExtSettings: object
- extension: string
-
Name of the extension. - parameters: string
-
Parameters of extension settings. - enabled: boolean
-
Whether enabled or not.
Example
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
PubFolder: object
- adminOnly: boolean
-
Whether there are admin rights only for this folder or not. - name: string
-
Name of published item. - type: string 0 = Any, 1 = Folder, 2 = RDSApp, 3 = RDSDesktop, 4 = VDIDesktop, 5 = PCDesktop, 6 = PCApp, 7 = VDIApp
-
Type of published item: 0=Any, 1=Folder, 2=RDSApp, 3=RDSDesktop, 4=VDIDesktop, 5=PCDesktop, 6=PCApp, 7=VDIApp. - parentId: integer (int32)
-
ID of the parent folder of the published item. - previousId: integer (int32)
-
ID of the previous published item. - description: string
-
Description. - enabled: boolean
-
Whether the published item is enabled or not. - publishToSite: integer[]
-
List of the IDs of all the sites this item is published to. -
integer (int32) - userFilterEnabled: boolean
-
Whether User Filtering is enabled or not. - userFilterReplicate: boolean
-
Whether to replicate User Filtering or not. - allowedUsers: UserFilter
-
Lists the allowed users. -
UserFilter - clientFilterEnabled: boolean
-
Whether Client Filtering is enabled or not. - clientFilterReplicate: boolean
-
Whether to replicate Client Filtering or not. - allowedClients: string[]
-
Lists the allowed clients. -
string - ipFilterEnabled: boolean
-
Whether IP Filtering is enabled or not. - ipFilterReplicate: boolean
-
Whether to replicate IP Filtering or not. - allowedIP4s: IP4Range
-
Lists the allowed IPv4 addresses. -
IP4Range - allowedIP6s: IP6Range
-
Lists the allowed IPV6 addresses. -
IP6Range - macFilterEnabled: boolean
-
Whether MAC address Filtering is enabled or not. - macFilterReplicate: boolean
-
Whether to replicate MAC address Filtering or not. - allowedMACs: string[]
-
Lists the allowed MAC addresses. -
string - gwFilterEnabled: boolean
-
Whether Gateway Filtering is enabled or not. - allowedGWs: string[]
-
Lists the allowed Gateways. -
string - osFilterEnabled: boolean
-
Whether OS Filtering is enabled or not. - osFilterReplicate: boolean
-
Whether to replicate OS Filtering or not. - allowedOSes: AllowedOperatingSystems
- id: integer (int32)
-
ID of the object.
Example
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
PubItem: object
- name: string
-
Name of published item. - type: string 0 = Any, 1 = Folder, 2 = RDSApp, 3 = RDSDesktop, 4 = VDIDesktop, 5 = PCDesktop, 6 = PCApp, 7 = VDIApp
-
Type of published item: 0=Any, 1=Folder, 2=RDSApp, 3=RDSDesktop, 4=VDIDesktop, 5=PCDesktop, 6=PCApp, 7=VDIApp. - parentId: integer (int32)
-
ID of the parent folder of the published item. - previousId: integer (int32)
-
ID of the previous published item. - description: string
-
Description. - enabled: boolean
-
Whether the published item is enabled or not. - publishToSite: integer[]
-
List of the IDs of all the sites this item is published to. -
integer (int32) - userFilterEnabled: boolean
-
Whether User Filtering is enabled or not. - userFilterReplicate: boolean
-
Whether to replicate User Filtering or not. - allowedUsers: UserFilter
-
Lists the allowed users. -
UserFilter - clientFilterEnabled: boolean
-
Whether Client Filtering is enabled or not. - clientFilterReplicate: boolean
-
Whether to replicate Client Filtering or not. - allowedClients: string[]
-
Lists the allowed clients. -
string - ipFilterEnabled: boolean
-
Whether IP Filtering is enabled or not. - ipFilterReplicate: boolean
-
Whether to replicate IP Filtering or not. - allowedIP4s: IP4Range
-
Lists the allowed IPv4 addresses. -
IP4Range - allowedIP6s: IP6Range
-
Lists the allowed IPV6 addresses. -
IP6Range - macFilterEnabled: boolean
-
Whether MAC address Filtering is enabled or not. - macFilterReplicate: boolean
-
Whether to replicate MAC address Filtering or not. - allowedMACs: string[]
-
Lists the allowed MAC addresses. -
string - gwFilterEnabled: boolean
-
Whether Gateway Filtering is enabled or not. - allowedGWs: string[]
-
Lists the allowed Gateways. -
string - osFilterEnabled: boolean
-
Whether OS Filtering is enabled or not. - osFilterReplicate: boolean
-
Whether to replicate OS Filtering or not. - allowedOSes: AllowedOperatingSystems
- id: integer (int32)
-
ID of the object.
Example
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
PubRDSApp: object
- publishFromServer: integer[]
-
List of servers to publish from. -
integer (int32) - publishFromGroup: integer[]
-
List of groups to publish from. -
integer (int32) - perServerAttributes: PubAppAttr
-
Application settings per server. -
PubAppAttr - publishFrom: string 0 = All, 1 = Group, 2 = Server
-
'Publish From' options for published applications: 0=All servers, 1=Server groups, 2=Individual servers. - enableFileExtensions: boolean
-
Whether file extensions option is enabled or not. - inheritDisplayDefaultSettings: boolean
-
Whether the 'Inherit default license settings' option is enabled or disabled. - replicateDisplaySettings: boolean
-
Whether the 'Replicate Display Settings' is enabled or not. - startMaximized: boolean
-
Whether the application will start as maximized or not. - waitForPrinters: boolean
-
Whether the application will wait for the printers or not. - waitForPrintersTimeout: integer (int32)
-
Timeout for waiting of the application for the printers. - colorDepth: string 0 = Colors8Bit, 1 = Colors15Bit, 2 = Colors16Bit, 3 = Colors24Bit, 4 = Colors32Bit, 5 = ClientSpecified
-
Depth of color: 0=Colors8Bit, 1=colors15Bit, 2=colors16Bit, 3=colors24Bit, 4=colors32Bit, 5=clientSpecified. - inheritLicenseDefaultSettings: boolean
-
Whether to inherit license default settings or not. - replicateLicenseSettings: boolean
-
Whether to replicate license settings or not. - replicateFileExtensionSettings: boolean
-
Whether to replicate file extension settings or not. - replicateDefaultServerSettings: boolean
-
Whether to replicate settings of the default server or not. - disableSessionSharing: boolean
-
Whether to disable session sharing or not. - oneInstancePerUser: boolean
-
Whether the option for one instance per user is enabled or not. - conCurrentLicenses: integer (int32)
-
Number of concurrent licenses. - licenseLimitNotify: string 0 = WarnUserAndNoStart, 1 = WarnUserAndStart, 2 = NotifyAdminAndStart, 3 = NotifyUserAdminAndStart, 4 = NotifyUserAdminAndNoStart
-
Style of notification about the license limit: 0=warnUserAndNoStart, 1=warnUserAndStart, 2=notifyAdminAndStart, 3=notifyUserAdminAndStart, 4=notifyUserAdminAndNoStart. - fileExtensions: PubFileExtSettings
-
Lists extension settings for published applications. -
PubFileExtSettings - winType: string 0 = Normal, 1 = Maximized, 2 = Minimized
-
Window Type: 0=Normal, 1=Maximized, 2=Minimized. - parameters: string
-
Application parameters. - startIn: string
-
Application working directory. - target: string
-
Application target file. - startOnLogon: boolean
-
Whether the 'Start automatically when user logs on' option is enabled or disabled. - inheritShortcutDefaultSettings: boolean
-
Whether to inherit default shortcut settings or not. - replicateShortcutSettings: boolean
-
Whether to replicate shortcut settings or not. - createShortcutOnDesktop: boolean
-
Whether to create a shortcut on the desktop or not. - createShortcutInStartFolder: boolean
-
Whether to create a shortcut in the start folder or not. - createShortcutInStartUpFolder: boolean
-
Whether to create a shortcut in the startup folder or not. - startPath: string
-
Starting path of the published item. - name: string
-
Name of published item. - type: string 0 = Any, 1 = Folder, 2 = RDSApp, 3 = RDSDesktop, 4 = VDIDesktop, 5 = PCDesktop, 6 = PCApp, 7 = VDIApp
-
Type of published item: 0=Any, 1=Folder, 2=RDSApp, 3=RDSDesktop, 4=VDIDesktop, 5=PCDesktop, 6=PCApp, 7=VDIApp. - parentId: integer (int32)
-
ID of the parent folder of the published item. - previousId: integer (int32)
-
ID of the previous published item. - description: string
-
Description. - enabled: boolean
-
Whether the published item is enabled or not. - publishToSite: integer[]
-
List of the IDs of all the sites this item is published to. -
integer (int32) - userFilterEnabled: boolean
-
Whether User Filtering is enabled or not. - userFilterReplicate: boolean
-
Whether to replicate User Filtering or not. - allowedUsers: UserFilter
-
Lists the allowed users. -
UserFilter - clientFilterEnabled: boolean
-
Whether Client Filtering is enabled or not. - clientFilterReplicate: boolean
-
Whether to replicate Client Filtering or not. - allowedClients: string[]
-
Lists the allowed clients. -
string - ipFilterEnabled: boolean
-
Whether IP Filtering is enabled or not. - ipFilterReplicate: boolean
-
Whether to replicate IP Filtering or not. - allowedIP4s: IP4Range
-
Lists the allowed IPv4 addresses. -
IP4Range - allowedIP6s: IP6Range
-
Lists the allowed IPV6 addresses. -
IP6Range - macFilterEnabled: boolean
-
Whether MAC address Filtering is enabled or not. - macFilterReplicate: boolean
-
Whether to replicate MAC address Filtering or not. - allowedMACs: string[]
-
Lists the allowed MAC addresses. -
string - gwFilterEnabled: boolean
-
Whether Gateway Filtering is enabled or not. - allowedGWs: string[]
-
Lists the allowed Gateways. -
string - osFilterEnabled: boolean
-
Whether OS Filtering is enabled or not. - osFilterReplicate: boolean
-
Whether to replicate OS Filtering or not. - allowedOSes: AllowedOperatingSystems
- id: integer (int32)
-
ID of the object.
Example
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
PubRDSDesktop: object
- connectToConsole: boolean
-
Connect to console - publishFromServer: integer[]
-
List of servers to publish from. -
integer (int32) - publishFromGroup: integer[]
-
List of groups to publish from. -
integer (int32) - publishFrom: string 0 = All, 1 = Group, 2 = Server
-
'Publish From' options for published desktops: 0=All servers, 1=Server groups, 2=Individual servers. - useAvailableArea: boolean
-
Whether all he available area is used or not. - width: integer (int32)
-
Desktop width. - height: integer (int32)
-
Desktop height. - allowMultiMonitor: string 0 = Enabled, 1 = Disabled, 2 = UseClientSettings
-
Specifies the Multi-monitor option. Acceptable values: Enabled, Disabled, UseClientSettings. - startOnLogon: boolean
-
Whether the 'Start automatically when user logs on' option is enabled or disabled. - inheritShortcutDefaultSettings: boolean
-
Whether to inherit default shortcut settings or not. - replicateShortcutSettings: boolean
-
Whether to replicate shortcut settings or not. - createShortcutOnDesktop: boolean
-
Whether to create a shortcut on the desktop or not. - createShortcutInStartFolder: boolean
-
Whether to create a shortcut in the start folder or not. - createShortcutInStartUpFolder: boolean
-
Whether to create a shortcut in the startup folder or not. - startPath: string
-
Starting path of the published item. - name: string
-
Name of published item. - type: string 0 = Any, 1 = Folder, 2 = RDSApp, 3 = RDSDesktop, 4 = VDIDesktop, 5 = PCDesktop, 6 = PCApp, 7 = VDIApp
-
Type of published item: 0=Any, 1=Folder, 2=RDSApp, 3=RDSDesktop, 4=VDIDesktop, 5=PCDesktop, 6=PCApp, 7=VDIApp. - parentId: integer (int32)
-
ID of the parent folder of the published item. - previousId: integer (int32)
-
ID of the previous published item. - description: string
-
Description. - enabled: boolean
-
Whether the published item is enabled or not. - publishToSite: integer[]
-
List of the IDs of all the sites this item is published to. -
integer (int32) - userFilterEnabled: boolean
-
Whether User Filtering is enabled or not. - userFilterReplicate: boolean
-
Whether to replicate User Filtering or not. - allowedUsers: UserFilter
-
Lists the allowed users. -
UserFilter - clientFilterEnabled: boolean
-
Whether Client Filtering is enabled or not. - clientFilterReplicate: boolean
-
Whether to replicate Client Filtering or not. - allowedClients: string[]
-
Lists the allowed clients. -
string - ipFilterEnabled: boolean
-
Whether IP Filtering is enabled or not. - ipFilterReplicate: boolean
-
Whether to replicate IP Filtering or not. - allowedIP4s: IP4Range
-
Lists the allowed IPv4 addresses. -
IP4Range - allowedIP6s: IP6Range
-
Lists the allowed IPV6 addresses. -
IP6Range - macFilterEnabled: boolean
-
Whether MAC address Filtering is enabled or not. - macFilterReplicate: boolean
-
Whether to replicate MAC address Filtering or not. - allowedMACs: string[]
-
Lists the allowed MAC addresses. -
string - gwFilterEnabled: boolean
-
Whether Gateway Filtering is enabled or not. - allowedGWs: string[]
-
Lists the allowed Gateways. -
string - osFilterEnabled: boolean
-
Whether OS Filtering is enabled or not. - osFilterReplicate: boolean
-
Whether to replicate OS Filtering or not. - allowedOSes: AllowedOperatingSystems
- id: integer (int32)
-
ID of the object.
Example
{
"connectToConsole": "boolean",
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"publishFrom": "string",
"useAvailableArea": "boolean",
"width": "integer (int32)",
"height": "integer (int32)",
"allowMultiMonitor": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
RadiusAttrInfo: object
- vendorID: integer (int32)
- attributeID: integer (int32)
- attributeType: string 0 = Number, 1 = String, 2 = IP, 3 = Time
- name: string
- vendor: string
- value: string
Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
RadiusSettings: object
- server: string
- port: integer (int32)
- passwordEncoding: string 0 = PAP, 1 = CHAP
- retries: integer (int32)
- timeout: integer (int32)
- typeName: string
- usernameOnly: boolean
- forwardFirstPwdToAD: boolean
- attributeInfoList: RadiusAttrInfo
-
RadiusAttrInfo
Example
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
RASAdminAccount: object
- id: integer (int32)
- name: string
- type: string 0 = User, 1 = Group, 2 = UserGroup
- notify: string 0 = None, 1 = Email
- enabled: boolean
- email: string
- mobile: string
- groupName: string
- fullPermissions: boolean
- permissions: string 0 = PowerAdmin, 1 = RootAdmin, 2 = CustomAdmin
Example
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
RASAdminSession: object
- userId: integer (int32)
- logonTime: string (date-time)
- ip: string
- state: string 0 = Active, 1 = Connected, 2 = ConnectQuery, 3 = Shadow, 4 = Disconnected, 5 = Idle, 6 = Listen, 7 = Reset, 8 = Down, 9 = Init, -1 = All
- computerName: string
- id: integer (int32)
-
ID of the object.
Example
{
"userId": "integer (int32)",
"logonTime": "string (date-time)",
"ip": "string",
"state": "string",
"computerName": "string",
"id": "integer (int32)"
}
RASAllowedDevicesSetting: object
- allowClient2XOS: boolean
- allowClientBlackberry: boolean
- allowClientChromeApp: boolean
- allowClientAndroid: boolean
- allowClientHTML5: boolean
- allowClientIOS: boolean
- allowClientJava: boolean
- allowClientLinux: boolean
- allowClientMAC: boolean
- allowClientMode: string 0 = AllowAllClientsConnectToSystem, 1 = AllowSelectedClientsConnectToSystem, 2 = AllowSelectedClientsListPublishedItems
- allowClientWebPortal: boolean
- allowClientWindows: boolean
- allowClientWinPhone: boolean
- allowClientWyse: boolean
- replicateSettings: boolean
- siteId: integer (int32)
- minBuild2XOS: integer (int32)
- minBuildBlackberry: integer (int32)
- minBuildChromeApp: integer (int32)
- minBuildAndroid: integer (int32)
- minBuildHTML5: integer (int32)
- minBuildIOS: integer (int32)
- minBuildJava: integer (int32)
- minBuildLinux: integer (int32)
- minBuildMAC: integer (int32)
- minBuildWebPortal: integer (int32)
- minBuildWindows: integer (int32)
- minBuildWinPhone: integer (int32)
- minBuildWyse: integer (int32)
Example
{
"allowClient2XOS": "boolean",
"allowClientBlackberry": "boolean",
"allowClientChromeApp": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientJava": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientMode": "string",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWinPhone": "boolean",
"allowClientWyse": "boolean",
"replicateSettings": "boolean",
"siteId": "integer (int32)",
"minBuild2XOS": "integer (int32)",
"minBuildBlackberry": "integer (int32)",
"minBuildChromeApp": "integer (int32)",
"minBuildAndroid": "integer (int32)",
"minBuildHTML5": "integer (int32)",
"minBuildIOS": "integer (int32)",
"minBuildJava": "integer (int32)",
"minBuildLinux": "integer (int32)",
"minBuildMAC": "integer (int32)",
"minBuildWebPortal": "integer (int32)",
"minBuildWindows": "integer (int32)",
"minBuildWinPhone": "integer (int32)",
"minBuildWyse": "integer (int32)"
}
RASAuthSettings: object
- authType: string 0 = UsernamePassword, 1 = SmartCard, 2 = UsernamePasswordOrSmartCard
- allTrustedDomains: boolean
- domain: string
- useClientDomain: boolean
- forceNetBIOSCreds: boolean
- replicateSettings: boolean
- siteId: integer (int32)
Example
{
"authType": "string",
"allTrustedDomains": "boolean",
"domain": "string",
"useClientDomain": "boolean",
"forceNetBIOSCreds": "boolean",
"replicateSettings": "boolean",
"siteId": "integer (int32)"
}
RASCustomPermission: object
- sitePermissions: SitePermission
-
SitePermission - globalPermissions: GlobalPermissions
Example
{
"sitePermissions": [
{
"siteId": "integer (int32)",
"rdsHosts": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"rdshGroups": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"remotePCs": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"gateways": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishingAgents": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"halb": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"themes": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishing": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"connection": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"winDevices": {
"sitePermission": {
"permissions": "string"
}
}
}
]
}
RASPowerPermission: object
- adminId: integer (int32)
- allowSiteChanges: boolean
- allowConnectionChanges: boolean
- allowSessionManagement: boolean
- allowClientManagementChanges: boolean
- allowViewingReportingInfo: boolean
- allowViewingSiteInfo: boolean
- allowPublishingChanges: boolean
- allowPolicyChanges: boolean
- allowViewingPolicyInfo: boolean
- allowAllSites: boolean
- allowInSiteIds: integer[]
-
integer (int32)
Example
{
"adminId": "integer (int32)",
"allowSiteChanges": "boolean",
"allowConnectionChanges": "boolean",
"allowSessionManagement": "boolean",
"allowClientManagementChanges": "boolean",
"allowViewingReportingInfo": "boolean",
"allowViewingSiteInfo": "boolean",
"allowPublishingChanges": "boolean",
"allowPolicyChanges": "boolean",
"allowViewingPolicyInfo": "boolean",
"allowAllSites": "boolean",
"allowInSiteIds": [
"integer (int32)"
]
}
RASPrintingSettings: object
RAS Printing Settings
- embedFonts: boolean
- replicatePrinterFont: boolean
- replicatePrinterPattern: boolean
- replicatePrinterDrivers: boolean
- driverAllowMode: string 0 = AllowRedirUsingAnyDriver, 1 = AllowRedirUsingSpecifiedDriver, 2 = DoNotAllowRedirUsingSpecifiedDriver
- printerRetention: string 0 = Off, 1 = On
- printerDriversArray: string[]
-
string - excludedFontsArray: string[]
-
string - autoInstallFonts: string[]
-
string - printerNamePattern: string
Example
{
"embedFonts": "boolean",
"replicatePrinterFont": "boolean",
"replicatePrinterPattern": "boolean",
"replicatePrinterDrivers": "boolean",
"driverAllowMode": "string",
"printerRetention": "string",
"printerDriversArray": [
"string"
],
"excludedFontsArray": [
"string"
],
"autoInstallFonts": [
"string"
],
"printerNamePattern": "string"
}
RASScanningSettings: object
RAS Scanning Settings
- twainNamePattern: string
- replicateTWAINPattern: boolean
- wiaNamePattern: string
- replicateWIAPattern: boolean
Example
{
"twainNamePattern": "string",
"replicateTWAINPattern": "boolean",
"wiaNamePattern": "string",
"replicateWIAPattern": "boolean"
}
RASSessionSetting: object
- fipsMode: string 0 = Disabled, 1 = Allowed, 2 = Enforced
- remoteIdleSessionTimeout: integer (int32)
- logoffIdleSessionTimeout: integer (int32)
- cachedSessionTimeout: integer (int32)
- replicateSettings: boolean
- siteId: integer (int32)
Example
{
"fipsMode": "string",
"remoteIdleSessionTimeout": "integer (int32)",
"logoffIdleSessionTimeout": "integer (int32)",
"cachedSessionTimeout": "integer (int32)",
"replicateSettings": "boolean",
"siteId": "integer (int32)"
}
RDPSession: object
- sessionID: integer (int32)
-
RAS session Id. - type: string 0 = Desktop, 1 = PublishedApps, 2 = Application, 3 = VDI, 4 = VDIApp, 5 = PC, 6 = PCApp, 7 = Admin, 8 = Unknown, 9 = RemoteApps, 10 = DirectRDP
-
The type of RDP session. - state: string 0 = Active, 1 = Connected, 2 = ConnectQuery, 3 = Shadow, 4 = Disconnected, 5 = Idle, 6 = Listen, 7 = Reset, 8 = Down, 9 = Init, -1 = All
-
State of RDP session. - protocol: string 0 = Console, 2 = RDP
-
Protocol used for session. - user: string
-
User to which the session belongs to. - ip: string
-
Session server IP. - serverID: integer (int32)
-
Session server Id. - themeID: integer (int32)
-
Theme Id. - logonTime: string (date-time)
-
Session Logon. - deviceName: string
-
Client Device Name. - idleStartTime: string (date-time)
-
Session Idle Time. - verticalResolution: integer (int32)
-
Session Vertical Resolution. - horizontalResolution: integer (int32)
-
Session Horizontal Resolution. - colourDepth: string 1 = COLOURDEPTH_4BIT, 2 = COLOURDEPTH_8BIT, 4 = COLOURDEPTH_16BIT, 8 = COLOURDEPTH_3BYTE, 16 = COLOURDEPTH_15BIT, 24 = COLOURDEPTH_24BIT, 32 = COLOURDEPTH_32BIT
-
Session Resolution.
Example
{
"sessionID": "integer (int32)",
"type": "string",
"state": "string",
"protocol": "string",
"user": "string",
"ip": "string",
"serverID": "integer (int32)",
"themeID": "integer (int32)",
"logonTime": "string (date-time)",
"deviceName": "string",
"idleStartTime": "string (date-time)",
"verticalResolution": "integer (int32)",
"horizontalResolution": "integer (int32)",
"colourDepth": "string"
}
RDS: object
- directAddress: string
-
The direct address of the target RD Session Host server. - rasTemplateId: integer (int32)
-
. - inheritDefaultAgentSettings: boolean
-
If true, default agent settings will be inherited. - inheritDefaultPrinterSettings: boolean
-
If true, default printer settings will be inherited. - inheritDefaultUPDSettings: boolean
-
If true, default UPD settings will be inherited. - inheritDefaultDesktopAccessSettings: boolean
-
If true, default desktop access settings will be inherited. - port: integer (int32)
-
The port number of RD Session host agent. - maxSessions: integer (int32)
-
Maximum number of session an RDS can have. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Sessions Disconnect Timeout'. 0 - No timeout. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow Client URL/Mail Redirection'. - supportShellURLNamespaceObjects: boolean
-
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled. - allowRemoteExec: boolean
-
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled. - enableAppMonitoring: boolean
-
Specifies if 'Application Monitoring' option is enabled or disabled. - useRemoteApps: boolean
-
Specifies if 'Use RemoteApps if available' option is enables or disabled. - allowFileTransfer: boolean
-
Specifies if 'Allow file transfer' option is enables or disabled. - allowDragAndDrop: boolean
-
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated) - dragAndDropMode: string 0 = Disabled, 1 = ClientToServer, 2 = ServerToClient, 3 = Bidirectional
-
Specifies the mode the drag and drop feature will operate. - preferredPAId: integer (int32)
-
The preferred Publishing Agent server id. - enablePrinting: boolean
-
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category. - enableTWAIN: boolean
-
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled . In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category. - enableWIA: boolean
-
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. - removeClientNameFromPrinterName: boolean
-
Specifies if 'Remove client name from printer name' option is enabled or disabled. - removeSessionNumberFromPrinterName: boolean
-
Specifies if 'Remove session number from printer name' optionis enabled or disabled. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - diskPath: string
-
Specifies the User Profile Disk path. - roamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs. -
string - server: string
-
Server name. - enabled: boolean
-
Whether the server is enabled or not. - description: string
-
Description of the server. - siteId: integer (int32)
-
ID of the site. - id: integer (int32)
-
ID of the object.
Example
{
"directAddress": "string",
"rasTemplateId": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"preferredPAId": "integer (int32)",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
],
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
RDSDefaultSettings: object
- port: integer (int32)
-
The port number of RD Session host agent. - maxSessions: integer (int32)
-
Maximum number of session an RDS can have. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Sessions Disconnect Timeout'. 0 - No timeout. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow Client URL/Mail Redirection'. - supportShellURLNamespaceObjects: boolean
-
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled. - preferredPAId: integer (int32)
-
The preferred Publishing Agent server id. - allowRemoteExec: boolean
-
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled. - enableAppMonitoring: boolean
-
Specifies if 'Application Monitoring' option is enabled or disabled. - useRemoteApps: boolean
-
Specifies if 'Use RemoteApps if available' option is enables or disabled. - allowFileTransfer: boolean
-
Specifies if 'Allow file transfer' option is enables or disabled. - allowDragAndDrop: boolean
-
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated) - dragAndDropMode: string 0 = Disabled, 1 = ClientToServer, 2 = ServerToClient, 3 = Bidirectional
-
Specifies the mode the drag and drop feature will operate. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. - removeClientNameFromPrinterName: boolean
-
Specifies if 'Remove client name from printer name' option is enabled or disabled. - removeSessionNumberFromPrinterName: boolean
-
Specifies if 'Remove session number from printer name' optionis enabled or disabled. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - diskPath: string
-
Specifies the User Profile Disk path. - roamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs. -
string
Example
{
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
RDSDefaultSiteSettings: object
- siteId: integer (int32)
- port: integer (int32)
-
The port number of RD Session host agent. - maxSessions: integer (int32)
-
Maximum number of session an RDS can have. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Sessions Disconnect Timeout'. 0 - No timeout. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow Client URL/Mail Redirection'. - supportShellURLNamespaceObjects: boolean
-
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled. - preferredPAId: integer (int32)
-
The preferred Publishing Agent server id. - allowRemoteExec: boolean
-
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled. - enableAppMonitoring: boolean
-
Specifies if 'Application Monitoring' option is enabled or disabled. - useRemoteApps: boolean
-
Specifies if 'Use RemoteApps if available' option is enables or disabled. - allowFileTransfer: boolean
-
Specifies if 'Allow file transfer' option is enables or disabled. - allowDragAndDrop: boolean
-
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated) - dragAndDropMode: string 0 = Disabled, 1 = ClientToServer, 2 = ServerToClient, 3 = Bidirectional
-
Specifies the mode the drag and drop feature will operate. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. - removeClientNameFromPrinterName: boolean
-
Specifies if 'Remove client name from printer name' option is enabled or disabled. - removeSessionNumberFromPrinterName: boolean
-
Specifies if 'Remove session number from printer name' optionis enabled or disabled. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - diskPath: string
-
Specifies the User Profile Disk path. - roamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs. -
string
Example
{
"siteId": "integer (int32)",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
RDSession: object
- source: string 1 = RDS, 2 = VDI, -1 = All
-
The type of RDP session. - vdiGuestId: string
-
Guest Id to which a VDI RDP session is connected to. - sessionID: integer (int32)
-
RAS session Id. - type: string 0 = Desktop, 1 = PublishedApps, 2 = Application, 3 = VDI, 4 = VDIApp, 5 = PC, 6 = PCApp, 7 = Admin, 8 = Unknown, 9 = RemoteApps, 10 = DirectRDP
-
The type of RDP session. - state: string 0 = Active, 1 = Connected, 2 = ConnectQuery, 3 = Shadow, 4 = Disconnected, 5 = Idle, 6 = Listen, 7 = Reset, 8 = Down, 9 = Init, -1 = All
-
State of RDP session. - protocol: string 0 = Console, 2 = RDP
-
Protocol used for session. - user: string
-
User to which the session belongs to. - ip: string
-
Session server IP. - serverID: integer (int32)
-
Session server Id. - themeID: integer (int32)
-
Theme Id. - logonTime: string (date-time)
-
Session Logon. - deviceName: string
-
Client Device Name. - idleStartTime: string (date-time)
-
Session Idle Time. - verticalResolution: integer (int32)
-
Session Vertical Resolution. - horizontalResolution: integer (int32)
-
Session Horizontal Resolution. - colourDepth: string 1 = COLOURDEPTH_4BIT, 2 = COLOURDEPTH_8BIT, 4 = COLOURDEPTH_16BIT, 8 = COLOURDEPTH_3BYTE, 16 = COLOURDEPTH_15BIT, 24 = COLOURDEPTH_24BIT, 32 = COLOURDEPTH_32BIT
-
Session Resolution.
Example
{
"source": "string",
"vdiGuestId": "string",
"sessionID": "integer (int32)",
"type": "string",
"state": "string",
"protocol": "string",
"user": "string",
"ip": "string",
"serverID": "integer (int32)",
"themeID": "integer (int32)",
"logonTime": "string (date-time)",
"deviceName": "string",
"idleStartTime": "string (date-time)",
"verticalResolution": "integer (int32)",
"horizontalResolution": "integer (int32)",
"colourDepth": "string"
}
RDSGroup: object
- rdsDefSettings: RDSDefaultSettings
- name: string
- siteId: integer (int32)
- enabled: boolean
- description: string
- useRASTemplate: boolean
- rasTemplateId: integer (int32)
- workLoadThreshold: integer (int32)
- serversToAddPerRequest: integer (int32)
- maxServersFromTemplate: integer (int32)
- workLoadToDrain: integer (int32)
- inheritDefaultAgentSettings: boolean
-
If true, default agent settings will be inherited. - inheritDefaultPrinterSettings: boolean
-
If true, default printer settings will be inherited. - inheritDefaultUPDSettings: boolean
-
If true, default UPD settings will be inherited. - inheritDefaultDesktopAccessSettings: boolean
-
If true, default desktop access settings will be inherited. - rdsIds: integer[]
-
integer (int32) - id: integer (int32)
-
ID of the object.
Example
{
"rdsDefSettings": {
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"allowDragAndDrop": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"diskPath": "string",
"roamingMode": "string",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
},
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"rdsIds": [
"integer (int32)"
],
"id": "integer (int32)"
}
RDSSysInfo: object
- preferredPA: string
-
Specifies the preferred PA. - activeSessions: integer (int32)
-
Number of active sessions. - disconnectedSessions: integer (int32)
-
Number of disconnected sessions. - activeConnections: integer (int32)
-
Number of active connections. - ip: string
-
The IP the agent is using. - loginStatus: string 0 = Enabled, 1 = Disabled, 2 = DrainMode
-
The Session login status - updStatus: string 0 = Enabled, 1 = Disabled, 2 = NotSupported
-
The Session UPD status - cpuLoad: integer (int32)
-
CPU load percentage. - memLoad: integer (int32)
-
Memory load percentage. - diskRead: integer (int32)
-
Disk Read. - diskWrite: integer (int32)
-
Disk Write. - enabled: boolean
-
Enabled or not. - id: string
-
ID of RAS Agent. - server: string
-
Server name. - siteId: integer (int32)
-
ID of Site. - agentVer: string
-
Agent Version. - serverOS: string
-
Server Operating System. - serviceStartTime: string
-
Service start time. - systemBootTime: string
-
System boot time. - unhandledExceptions: integer (int32)
-
Number of unhandled exceptions. - agentState: string 0 = OK, 1 = EnumSessionsFailed, 2 = RDSRoleDisabled, 3 = MaxNonCompletedSessions, 4 = RASScheduleInProgress, 5 = ConnectionFailed, 6 = InvalidCredentials, 7 = NeedsSysprep, 8 = SysPrepInProgress, 9 = CloningFailed, 10 = Synchronising, 12 = FinalizingSysprep, 13 = LogonDrainUntilRestart, 14 = LogonDrain, 15 = LogonDisabled, 16 = ForcedDisconnect, 17 = CloningCanceled, 18 = RASprepInProgress, 19 = FinalizingRASprep, 20 = InstallingRDSRole, 21 = RebootPending, 22 = PortMismatch, 23 = NeedsDowngrade, 24 = NotApplied, 25 = CloningInProgress, 26 = MarkedForDeletion, 27 = StandBy, 28 = UnsupportedVDIType, 29 = FreeESXLicenseNotSupported, 30 = ManagedESXNotSupported, 31 = HotfixKB2580360NotInstalled, 32 = InvalidHostVersion, -6 = Unknown, -5 = NeedsUpdate, -4 = NotVerified, -3 = ServerDeleted, -2 = DisabledFromSettings, -1 = Disconnected
-
Agent State. - serverType: string 1 = RDS, 2 = VDIHost, 3 = Gateway, 4 = Guest, 5 = PC, 6 = VDITemplate, 7 = PA, 9 = Site, -1 = All
-
Type of server. - logLevel: string 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard, 4 = Extended, 5 = Verbose
-
Level of logging: 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard (Information), 4 = Extended, 5 = Verbose (Trace).
Example
{
"preferredPA": "string",
"activeSessions": "integer (int32)",
"disconnectedSessions": "integer (int32)",
"activeConnections": "integer (int32)",
"ip": "string",
"loginStatus": "string",
"updStatus": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
Remove2FAExcludeGWIP: object
- ip: string (up to 255 chars)
-
Value that represents the Gateway IP address.
Example
{
"ip": "string"
}
Remove2FAExcludeIPList: object
- ip: string (up to 255 chars)
-
Value that represents the IP - ipType: string 0 = Version4, 1 = Version6, 2 = BothVersions
-
Represents the type of IP
Example
{
"ip": "string",
"ipType": "string"
}
Remove2FAExcludeMACList: object
- macAddress: string (up to 17 chars)
-
A string value representing a MAC address.
Example
{
"macAddress": "string"
}
Remove2FAExcludeUserGroupList: object
- account: string (1 to 255 chars)
-
A string value representing the ldap of a User/Group. - type: string 0 = Unknown, 1 = User, 2 = Group, 3 = ForeignSecurityPrincipal
-
The type of account (User/Group) being excluded, defaults to User.
Example
{
"account": "string",
"type": "string"
}
Remove2FARadiusAttr: object
- vendorID: integer (int32)
-
Radius Attribute Vendor ID - attributeID: integer (int32)
-
Radius Attribute ID - value: string (up to 255 chars)
-
Radius Attribute Value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time. - name: string (up to 255 chars)
-
Radius Attribute Name - vendor: string (up to 255 chars)
-
Radius Attribute Vendor name - attributeType: string 0 = Number, 1 = String, 2 = IP, 3 = Time
-
Radius Attribute Type. IP, String, Number, Time
Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"value": "string",
"name": "string",
"vendor": "string",
"attributeType": "string"
}
RemoveRASPrintingFont: object
- fontName: string (up to 255 chars)
-
Auto Install Font Name.
Example
{
"fontName": "string"
}
SafeNetSettings: object
- authMode: string 0 = MandatoryForAllUsers, 1 = CreateTokenForDomainAuthenticatedUsers, 2 = UsersWithSafeNetAcc
- otpServiceURL: string
- userRepository: string
- tmsWebApiURL: string
Example
{
"authMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string"
}
ServerAppInfo: object
- appName: string
-
Application name. - process: string
-
Process name. - pid: integer (int32)
-
Process Id. - user: string
-
User which is running the application. - session: integer (int32)
-
RAS session Id. - serverID: integer (int32)
-
Server id from where the application is hosted.
Example
{
"appName": "string",
"process": "string",
"pid": "integer (int32)",
"user": "string",
"session": "integer (int32)",
"serverID": "integer (int32)"
}
Set2FADeepnetSett: object
- excludeUserGroup: boolean
-
Whether to enable or disable the User/Group filter. - activateEmail: boolean
-
Deepnet setting. Enables or disables the activation Email. - activateSMS: boolean
-
Deepnet setting. Enables or disables the activation SMS. - app: string (up to 255 chars)
-
Deepnet setting. A value that represents the application name. - appID: string (up to 255 chars)
-
Deepnet setting. A value that represents the application ID. - deepnetAuthMode: string 0 = MandatoryForAllUsers, 1 = CreateTokenForDomainAuthenticatedUsers, 2 = UsersWithDeepnetAcc
-
Authentication mode which defines the type of user for which a token will be created. - deepnetAgent: string (up to 255 chars)
-
Deepnet setting. A value that represents the name of Deepnet Agent. - deepnetType: string 0 = DualShield, 1 = Deepnet
-
Deepnet setting. Represents the Deepnet type. - defaultDomain: string (up to 255 chars)
-
Deepnet setting. A value that represents the Default Domain. - enableSSL: boolean
-
Deepnet setting. Enables or disables SSL. - server: string (up to 255 chars)
-
Deepnet/Radius setting. The server of the second level authentication provider. - port: integer (int32)
-
Deepnet/Radius setting. The port number of the second level authentication provider. - tokenType: string 0 = FlashID, 1 = MobileID, 2 = GridID, 3 = QuickID
-
Token Type. - userEnrollment: string 0 = Allow, 1 = AllowUntil, 2 = DoNotAllow
-
TOTP setting. The state of user enrollment. - untilDateTime: string (date-time)
-
TOTP setting. The allow user enrollment until date/time.
Example
{
"excludeUserGroup": "boolean",
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"deepnetAuthMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"enableSSL": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Set2FARadiusSett: object
- excludeUserGroup: boolean
-
Whether to enable or disable the User/Group filter. - server: string (up to 255 chars)
-
Deepnet/Radius setting. The server of the second level authentication provider. - port: integer (int32)
-
Deepnet/Radius setting. The port number of the second level authentication provider. - passwordEncoding: string 0 = PAP, 1 = CHAP
-
Radius setting. The type of password encoding to be used. - retries: integer (int32)
-
Radius setting. Number of retries. - secretKey: string (up to 200 chars)
-
Radius setting. The secret key. - timeout: integer (int32)
-
Radius setting. Connection timeout. - typeName: string (up to 200 chars)
-
Radius setting. Radius type name. - usernameOnly: boolean
-
Radius setting. Enables or disables forwarding of only the Username to Radius Server. - forwardFirstPwdToAD: boolean
-
Radius setting. Enables or disables forwarding of first password to Windows authentication provider. - userEnrollment: string 0 = Allow, 1 = AllowUntil, 2 = DoNotAllow
-
TOTP setting. The state of user enrollment. - untilDateTime: string (date-time)
-
TOTP setting. The allow user enrollment until date/time.
Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Set2FASafenetSett: object
- excludeUserGroup: boolean
-
Whether to enable or disable the User/Group filter. - safeNetAuthMode: string 0 = MandatoryForAllUsers, 1 = CreateTokenForDomainAuthenticatedUsers, 2 = UsersWithSafeNetAcc
-
Authentication mode which defines the type of user for which a token will be created. - otpServiceURL: string (up to 255 chars)
-
Safenet setting. The server of the second level authentication provider. - userRepository: string (up to 255 chars)
-
Safenet setting. A value representing User Store. - tmsWebApiURL: string (up to 255 chars)
-
Safenet setting. The URL of the web service. - userEnrollment: string 0 = Allow, 1 = AllowUntil, 2 = DoNotAllow
-
TOTP setting. The state of user enrollment. - untilDateTime: string (date-time)
-
TOTP setting. The allow user enrollment until date/time.
Example
{
"excludeUserGroup": "boolean",
"safeNetAuthMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Set2FASett: object
- provider: string 0 = None, 1 = Deepnet, 2 = SafeNet, 3 = Radius, 4 = AzureRadius, 5 = DuoRadius, 6 = FortiRadius, 7 = TekRadius, 8 = GAuthTOTP
-
Changes the provider type used by second level authentication. - excludeClientIPs: boolean
-
Whether to enable or disable the IP filter. - excludeClientMAC: boolean
-
Whether to enable or disable the MAC address filter. - excludeClientGWIPs: boolean
-
Whether to enable or disable the Gateway IP filter. - excludeUserGroup: boolean
-
Whether to enable or disable the User/Group filter. - userEnrollment: string 0 = Allow, 1 = AllowUntil, 2 = DoNotAllow
-
TOTP setting. The state of user enrollment. - untilDateTime: string (date-time)
-
TOTP setting. The allow user enrollment until date/time. - replicateSettings: boolean
-
Enables or disables replication of settings to other sites.
Example
{
"provider": "string",
"excludeClientIPs": "boolean",
"excludeClientMAC": "boolean",
"excludeClientGWIPs": "boolean",
"excludeUserGroup": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)",
"replicateSettings": "boolean"
}
Set2FATOTPSett: object
- excludeUserGroup: boolean
-
Whether to enable or disable the User/Group filter. - totpType: string (up to 255 chars)
-
TOTP setting. Sets the authentication method type name. - userEnrollment: string 0 = Allow, 1 = AllowUntil, 2 = DoNotAllow
-
TOTP setting. The state of user enrollment. - untilDateTime: string (date-time)
-
TOTP setting. The allow user enrollment until date/time.
Example
{
"excludeUserGroup": "boolean",
"totpType": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
SetCertificate: object
- newName: string (1 to 255 chars)
-
The new name of the target Certificate. - description: string (1 to 255 chars)
-
A user-defined Certificate description. - usage: string 0 = None, 2 = Gateway, 4 = HALB
-
Change the Usage for the Certificate. To form a set of usages 'OR' individual usage enum IDs. - enabled: boolean
-
Enable or disable the specified Certificate in a site.
Example
{
"newName": "string",
"description": "string",
"usage": "string",
"enabled": "boolean"
}
SetGW: object
- enabled: boolean
-
Enable or disable the specified Gateway. - newServer: string (1 to 255 chars)
-
The new Gateway name. The name must be either a valid FQDN or a valid IP address. - description: string (up to 255 chars)
-
A user-defined Gateway description. - ipVersion: string 0 = Version4, 1 = Version6, 2 = BothVersions
-
The IP version for the Gateway to use. Accepted values: Version4 (IPv4), Version6 (IPv6), BothVersions (both IPv4 and IPv6). - iPs: string (1 to 255 chars)
-
One or multiple (separated by comma) IP addresses. - bindV4Addresses: string (1 to 255 chars)
-
IPv4 address to bind to. If '0.0.0.0' is passed, will bind to all available addresses. When using a specific address, it has to be available in the IPv4 address list. - optimizeConnectionIPv4: string (up to 255 chars)
-
Optimize connection for the list of IPv4 (comma separated values). - bindV6Addresses: string (1 to 255 chars)
-
IPv6 address to bind to. If '::' is passed, will bind to all available addresses. When using a specific address, it has to be available in the IPv6 address list. - optimizeConnectionIPv6: string (up to 255 chars)
-
Optimize connection for the list of IPv6 (comma separated values). - inheritDefaultModeSettings: boolean
-
Enable or disable default mode settings. - inheritDefaultNetworkSettings: boolean
-
Enable or disable default network settings. - inheritDefaultSslTlsSettings: boolean
-
Enable or disable default SSL/TLS setting. - inheritDefaultHTML5Settings: boolean
-
Enable or disable default HTML5 settings. - inheritDefaultWyseSettings: boolean
-
Enable or disable default wyse settings. - inheritDefaultSecuritySettings: boolean
-
Enable or disable default security settingsd. - inheritDefaultWebSettings: boolean
-
Enable or disable default web settings. - gwMode: string 0 = Normal, 1 = Forwarding
-
Gateway Mode. Accepted values: Normal, Forwarding. - normalModeForwarding: boolean
-
Forward requests to HTTP server. - forwardGatewayServers: string (up to 255 chars)
-
One or multiple (separated by comma) Forwarding Gateway Servers. E.g. localhost:80, web1 - autoPreferredPA: boolean false
-
Set preferred PA as Automatically. - preferredPAId: integer (int32)
-
The preferred PA server Id - forwardHttpServers: string (up to 255 chars)
-
One or multiple (separated by comma) Forwarding HTTP Servers. E.g. localhost:81, web1 - enableGWPort: boolean
-
Enable or disable a custom RAS Secure Client Gateway port. To specify a custom port, set this parameter to True and use the GWPort parameter to specify the port number. - gwPort: integer (int32)
-
A custom Gateway port number. For this port to take effect, the EnableGWPort parameters must be set to $True. - enableRDP: boolean
-
Enable or disable a custom RDP port. To specify a custom port number, use the RDPPort parameter. - rdpPort: integer (int32)
-
A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True. - broadcast: boolean
-
Enable or disable the 'Broadcast RAS Secure Client Gateway Address' option. - enableRDPUDP: boolean
-
Enable or disable the 'RDP UDP Data Tunneling' option. - enableClientManagerPort: boolean
-
Enable or disable the 'Client Manager Port' option. - dosPro: boolean
-
Enable or disable the 'RDP DOS Attack Filter' option. - enableSSL: boolean
-
Enable or disable SSL on the port specified in the SSLPort parameter. - sslPort: integer (int32)
-
SSL port number. To enable the port, set the EnableSSL port parameter to True. - minSSLVersion: string 0 = SSLv2, 1 = SSLv3, 2 = TLSv1, 3 = TLSv1_1, 4 = TLSv1_2
-
Minimum SSL version. Accepted values: TLSv1_2 (TLS v1.2 only, strong), TLSv1_1 (TLS v1.1 - TLS v1.2), TLSv1 (TLS v1 - TLS v1.2), SSLv3 (SSL v3 - TLS v1.2), SSLv2 (SSL v2 - TLS v1.2). - cipherStrength: string 0 = Low, 1 = Medium, 2 = High, 3 = Custom
-
Cipher strength. Accepted values: Low, Medium, High, Custom. - cipher: string (up to 255 chars)
-
Cipher string. - autoCertificate: boolean false
-
Set Certificate as Automatically. - certificateId: integer (int32)
-
The Certificate Id. Certificate Set Priority 2. This value will be ignored if a CertificateObj is specified. - enableHSTS: boolean
-
Enable or disable HSTS. To specify a custom HSTS Age, set this parameter to True and use the HSTSMaxAge parameter to specify the HSTS maximum age. - hstsMaxAge: integer (int32)
-
Specifies the HSTS maximum age. - hstsIncludeSubdomains: boolean
-
Enable or disable the HSTS sub-domains. - hstsPreload: boolean
-
Enable or disable the HSTS preload. - enableHTML5: boolean
-
Enable or disable HTML5 connectivity on the Gateway. - htmL5Port: integer (int32)
-
A custom HTML5 port number. - launchMethod: string 0 = ParallelsClientAndHTML5, 1 = ParallelsClient, 2 = HTML5
-
Launch method. Accepted values: ParallelsClientAndHTML5 (Parallels Client and fallback to HTML5), ParallelsClient (Parallels Client only), HTML5 (HTML5 Client only). - allowLaunchMethod: boolean
-
Allow users to select a resource launch method. - allowAppsInNewTab: boolean
-
Allow users to start applications in a new browser tab. - usePreWin2000LoginFormat: boolean
-
Enables or disables the 'Use Pre Windows 2000 Login Format' option. - allowEmbed: boolean
-
Allow embedding of Web Client into other web pages. - allowFileTransfer: boolean
-
Enables or disables the 'Allow file transfer' option. - allowClipboard: boolean
-
Enables or disables the 'Allow Clipboard' option. - enableAlternateNLBHost: boolean
-
Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter. - alternateNLBHost: string (1 to 255 chars)
-
Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True. - enableAlternateNLBPort: boolean
-
Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter. - alternateNLBPort: integer (int32)
-
Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True. - enableWyseSupport: boolean
-
Enable or disable Wyse ThinOS support. - securityMode: string 0 = AllowAllExcept, 1 = AllowOnly
-
Security Mode. Accepted values: AllowAllExcept, AllowOnly. - macAllowExcept: string[]
-
Specifies the Security 'MAC Allow Except' MAC addresses. -
string - macAllowOnly: string[]
-
Specifies the Security 'MAC Allow Only' MAC addresses. -
string - webRequestsURL: string (up to 255 chars)
-
Sets a URL for Web requests. This is the URL that will open when a user enters the IP address of the RAS Secure Client Gateway server in a web browser. For the URL to work, the gateway mode must be set to Normal. - webCookie: string (up to 255 chars)
-
Sets the Web Cookie Name used by RAS.
Example
{
"enabled": "boolean",
"newServer": "string",
"description": "string",
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"autoCertificate": "boolean",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
SetGWDefaults: object
- gwMode: string 0 = Normal, 1 = Forwarding
-
Gateway Mode. Accepted values: Normal, Forwarding. - normalModeForwarding: boolean
-
Forward requests to HTTP server. - forwardGatewayServers: string (up to 255 chars)
-
One or multiple (separated by comma) Forwarding Gateway Servers. E.g. localhost:80, web1 - autoPreferredPA: boolean false
-
Set preferred PA as Automatically. - preferredPAId: integer (int32)
-
The preferred PA server Id - forwardHttpServers: string (up to 255 chars)
-
One or multiple (separated by comma) Forwarding HTTP Servers. E.g. localhost:81, web1 - enableGWPort: boolean
-
Enable or disable a custom RAS Secure Client Gateway port. To specify a custom port, set this parameter to True and use the GWPort parameter to specify the port number. - gwPort: integer (int32)
-
A custom Gateway port number. For this port to take effect, the EnableGWPort parameters must be set to $True. - enableRDP: boolean
-
Enable or disable a custom RDP port. To specify a custom port number, use the RDPPort parameter. - rdpPort: integer (int32)
-
A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True. - broadcast: boolean
-
Enable or disable the 'Broadcast RAS Secure Client Gateway Address' option. - enableRDPUDP: boolean
-
Enable or disable the 'RDP UDP Data Tunneling' option. - enableClientManagerPort: boolean
-
Enable or disable the 'Client Manager Port' option. - dosPro: boolean
-
Enable or disable the 'RDP DOS Attack Filter' option. - enableSSL: boolean
-
Enable or disable SSL on the port specified in the SSLPort parameter. - sslPort: integer (int32)
-
SSL port number. To enable the port, set the EnableSSL port parameter to True. - minSSLVersion: string 0 = SSLv2, 1 = SSLv3, 2 = TLSv1, 3 = TLSv1_1, 4 = TLSv1_2
-
Minimum SSL version. Accepted values: TLSv1_2 (TLS v1.2 only, strong), TLSv1_1 (TLS v1.1 - TLS v1.2), TLSv1 (TLS v1 - TLS v1.2), SSLv3 (SSL v3 - TLS v1.2), SSLv2 (SSL v2 - TLS v1.2). - cipherStrength: string 0 = Low, 1 = Medium, 2 = High, 3 = Custom
-
Cipher strength. Accepted values: Low, Medium, High, Custom. - cipher: string (up to 255 chars)
-
Cipher string. - autoCertificate: boolean false
-
Set Certificate as Automatically. - certificateId: integer (int32)
-
The Certificate Id. - enableHSTS: boolean
-
Enable or disable HSTS. To specify a custom HSTS Age, set this parameter to True and use the HSTSMaxAge parameter to specify the HSTS maximum age. - hstsMaxAge: integer (int32)
-
Specifies the HSTS maximum age. - hstsIncludeSubdomains: boolean
-
Enable or disable the HSTS sub-domains. - hstsPreload: boolean
-
Enable or disable the HSTS preload. - enableHTML5: boolean
-
Enable or disable HTML5 connectivity on the Gateway. - htmL5Port: integer (int32)
-
A custom HTML5 port number. - launchMethod: string 0 = ParallelsClientAndHTML5, 1 = ParallelsClient, 2 = HTML5
-
Launch method. Accepted values: ParallelsClientAndHTML5 (Parallels Client and fallback to HTML5), ParallelsClient (Parallels Client only), HTML5 (HTML5 Client only). - allowLaunchMethod: boolean
-
Allow users to select a resource launch method. - allowAppsInNewTab: boolean
-
Allow users to start applications in a new browser tab. - usePreWin2000LoginFormat: boolean
-
Enables or disables the 'Use Pre Windows 2000 Login Format' option. - allowEmbed: boolean
-
Allow embedding of Web Client into other web pages. - allowFileTransfer: boolean
-
Enables or disables the 'Allow file transfer' option. - allowClipboard: boolean
-
Enables or disables the 'Allow Clipboard' option. - enableAlternateNLBHost: boolean
-
Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter. - alternateNLBHost: string (1 to 255 chars)
-
Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True. - enableAlternateNLBPort: boolean
-
Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter. - alternateNLBPort: integer (int32)
-
Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True. - enableWyseSupport: boolean
-
Enable or disable Wyse ThinOS support. - securityMode: string 0 = AllowAllExcept, 1 = AllowOnly
-
Security Mode. Accepted values: AllowAllExcept, AllowOnly. - macAllowExcept: string[]
-
Specifies the Security 'MAC Allow Except' MAC addresses. -
string - macAllowOnly: string[]
-
Specifies the Security 'MAC Allow Only' MAC addresses. -
string - webRequestsURL: string (up to 255 chars)
-
Sets a URL for Web requests. This is the URL that will open when a user enters the IP address of the RAS Secure Client Gateway server in a web browser. For the URL to work, the gateway mode must be set to Normal. - webCookie: string (up to 255 chars)
-
Sets the Web Cookie Name used by RAS.
Example
{
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"autoCertificate": "boolean",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
SetPA: object
- enabled: boolean
-
Enable or disable the specified RAS Publishing Agent. - description: string (up to 255 chars)
-
A user-defined RAS Publishing Agent description. - ip: string (up to 255 chars)
-
An IP address of the RAS Publishing Agent server. - alternativeIPs: string (up to 255 chars)
-
A list of alternative IP addresses separated by a comma. - standby: boolean
-
Set the specified RAS Secondary PA in Standby (or vice versa).
Example
{
"enabled": "boolean",
"description": "string",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean"
}
SetPAPriority: object
- direction: string 0 = Up, 1 = Down
-
The direction to move the PA object: Up or Down (changes the priority of the Publishing Agent accordingly).
Example
{
"direction": "string"
}
SetPubAppFileExt: object
- enabled: boolean
-
Whether the file extension should be enabled or disabled for the specified published app. - parameters: string
-
File extension parameters for the specified published app. - extension: string
-
The file extension that will be added/modified. - siteId: integer (int32)
-
Site ID.
Example
{
"enabled": "boolean",
"parameters": "string",
"extension": "string",
"siteId": "integer (int32)"
}
SetPubDefaultSettings: object
- createShortcutOnDesktop: boolean
-
Enables or disables the 'Create shortcut on Desktop' option. - replicateShortcutSettings: boolean
-
Enables or disables the 'Replicate settings' option. - createShortcutInStartFolder: boolean
-
Enables or disables the 'Create shortcut in Start folder' option. - createShortcutInStartUpFolder: boolean
-
Enables or disables the 'Create shortcut in Auto Start folder' option. - startPath: string (1 to 255 chars)
-
Specifies a path in the Start folder. - replicateDisplaySettings: boolean
-
Enables or disables the "Replicate settings option'. This will replicate display settings to all sites. - startMaximized: boolean
-
Enables or disables the 'Start the application as maximized when using mobile clients" option. - waitForPrinters: boolean
-
Enables or disables the 'Wait until all RAS Universal Printers are redirected before showing the application" option. - waitForPrintersTimeout: integer (int32)
-
Printer redirection timeout (in seconds). Works together with the WaitForPrinters parameter. - replicateLicenseSettings: boolean
-
Enables or disables the 'Replicate settings' option. This will replicate license settings to all sites. - disableSessionSharing: boolean
-
Enables or disables the 'Disable session sharing' option. - oneInstancePerUser: boolean
-
Enables or disables the 'Allow users to start only one instance of the application' option. - conCurrentLicenses: integer (int32)
-
Specifies the number of concurrent licenses (the 'Concurrent licenses' option). - licenseLimitNotify: string 0 = WarnUserAndNoStart, 1 = WarnUserAndStart, 2 = NotifyAdminAndStart, 3 = NotifyUserAdminAndStart, 4 = NotifyUserAdminAndNoStart
-
Specifies an action to perform when the license limit is exceeded. Possible values are: 0 (Warn user and do not start), 1 (Warn user and start), 2 (Notify administrator and start), 3 (Notify user, administrator and start), 4 (Notify user, administrator and do not start). - colorDepth: string 0 = Colors8Bit, 1 = Colors15Bit, 2 = Colors16Bit, 3 = Colors24Bit, 4 = Colors32Bit, 5 = ClientSpecified
-
Specifies the display color depth setting. Possible values are: Colors8Bit, Colors15Bit, Colors16Bit, Colors24Bit, Colors32Bit, ClientSpecified
Example
{
"createShortcutOnDesktop": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"replicateLicenseSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"colorDepth": "string"
}
SetPubFolder: object
- adminOnly: boolean
-
Use folder for administrative purposes only. - newName: string (1 to 255 chars)
-
A new name to assign to the published resource. - enabled: boolean
-
Enable or disable a published resource. - description: string (up to 255 chars)
-
Published resource description. - publishToSiteIds: integer[]
-
An array of sites to which to publish a resource. -
integer (int32) - ipFilterEnabled: boolean
-
Enable or disable IP filters. - ipFilterReplicate: boolean
-
Replicate or not IP filters. - clientFilterEnabled: boolean
-
Enable or disable client filters. - clientFilterReplicate: boolean
-
Replicate or not client filters. - macFilterEnabled: boolean
-
Enable or disable mac filters. - macFilterReplicate: boolean
-
Replicate or not mac filters. - userFilterEnabled: boolean
-
Enable or disable user filters. - userFilterReplicate: boolean
-
Replicate or not user filters. - gwFilterEnabled: boolean
-
Enable or disable GW filters. - osFilterEnabled: boolean
-
Enable or disable the OS filter. - osFilterReplicate: boolean
-
Replicate or not OS filter settings to all sites. - allowClientChrome: boolean
-
Allow or not Chrome OS Clients. - allowClientAndroid: boolean
-
Allow or not Android Clients. - allowClientHTML5: boolean
-
Allow or not HTML5 Clients. - allowClientIOS: boolean
-
Allow or not IOS Clients. - allowClientLinux: boolean
-
Allow or not Linux Clients. - allowClientMAC: boolean
-
Allow or not MAC Clients. - allowClientWebPortal: boolean
-
Allow or not Web Portal Clients. - allowClientWindows: boolean
-
Allow or not Windows Clients. - allowClientWyse: boolean
-
Allow or not Wyse Clients. - siteId: integer (int32)
-
Site ID.
Example
{
"adminOnly": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
SetPubItemClientOSFilter: object
- osFilterEnabled: boolean
-
Whether to enable or disable the filter for the specified published resource. - osFilterReplicate: boolean
-
Whether to replicate filter settings to all sites. - allowClientChrome: boolean
-
Allows Chrome OS clients. - allowClientAndroid: boolean
-
Allows Android clients. - allowClientHTML5: boolean
-
Allows HTML5 clients. - allowClientIOS: boolean
-
Allows IOS clients. - allowClientLinux: boolean
-
Allows Linux clients. - allowClientMAC: boolean
-
Allows Mac clients. - allowClientWebPortal: boolean
-
Allows Web Portal clients. - allowClientWindows: boolean
-
Allows Windows clients. - allowClientWyse: boolean
-
Allows Wyse clients. - siteId: integer (int32)
-
Site ID.
Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
SetPubItemExtension: object
- extension: string
-
The file extension that will be added/modified. - siteId: integer (int32)
-
Site ID.
Example
{
"extension": "string",
"siteId": "integer (int32)"
}
SetPubRDSApp: object
- publishFrom: string 0 = All, 1 = Group, 2 = Server
-
Specifies the 'Publish from' option. Acceptable values: All (All servers in the site), Group (Server Groups), Server (Individual Servers). - publishFromGroupIds: integer[]
-
Specifies one or multiple group Ids from which to publish the application. The PublishFrom parameter must specify 1 (Server groups). -
integer (int32) - publishFromServerIds: integer[]
-
One or multiple RDS Host server Ids from which to publish the application. The PublishFrom parameter must specify 2 (Individual Servers). -
integer (int32) - replicateDisplaySettings: boolean
-
Enables or disable the 'Replicate settings' option (replicates display settings to all sites). - startMaximized: boolean
-
Enables or disables the 'Start the application as maximized when using mobile clients" option. - waitForPrinters: boolean
-
Enables or disables the 'Wait until all RAS universal printers are redirected before showing the application" option. - waitForPrintersTimeout: integer (int32)
-
Printer redirection timeout (in seconds). Set this option when enabling the WaitForPrinters option. - colorDepth: string 0 = Colors8Bit, 1 = Colors15Bit, 2 = Colors16Bit, 3 = Colors24Bit, 4 = Colors32Bit, 5 = ClientSpecified
-
Specifies the display color depth setting. Possible values are: Colors8Bit, Colors15Bit, Colors16Bit, Colors24Bit, Colors32Bit, ClientSpecified - inheritDisplayDefaultSettings: boolean
-
Enables or disables the 'Inherit default settings" option for display properties. - replicateLicenseSettings: boolean
-
Enables or disables the 'Replicate licensing settings" (settings are replicated to all sites). - disableSessionSharing: boolean
-
Enables or disables the 'Disable session sharing' option (licenses). - oneInstancePerUser: boolean
-
Enables or disables the 'Allow users to start only one instance of the application' option. - conCurrentLicenses: integer (int32)
-
Specifies the 'Concurrent licenses' option (the number of concurrent licenses). - licenseLimitNotify: string 0 = WarnUserAndNoStart, 1 = WarnUserAndStart, 2 = NotifyAdminAndStart, 3 = NotifyUserAdminAndStart, 4 = NotifyUserAdminAndNoStart
-
Specifies the "If license limit is exceeded' option. Acceptable values: WarnUserAndNoStart, WarnUserAndStart, NotifyAdminAndStart, NotifyUserAdminAndStart, NotifyUserAdminAndNoStart - inheritLicenseDefaultSettings: boolean
-
Enables or disables the 'Inherit default license settings' option. - enableFileExtensions: boolean
-
Enables or disables the 'Enable File Extensions' option. - replicateFileExtensionSettings: boolean
-
Enables or disable the 'Replicate settings' option (replicates extension settings to all sites). - replicateDefaultServerSettings: boolean
-
Enables or disable the 'Replicate settings' option (replicates default server settings to all sites). - fileExtensions: string
-
List of file extensions to be added to the current list, if doesn't exist(comma separated values). - serverId: integer (int32)
- target: string
-
File name and path of a published application executable. - parameters: string
-
Optional parameters to pass to the published application executable. - startIn: string
-
Folder name in which to start a published application. - winType: string 0 = Normal, 1 = Maximized, 2 = Minimized
-
Published application window type. Acceptable values: Normal, Maximized, Minimized. - replicateShortcutSettings: boolean
-
Replicate shortcut settings to all sites. - createShortcutOnDesktop: boolean
-
Create a shortcut on a client's desktop. - createShortcutInStartFolder: boolean
-
Create a shortcut in the client's Start folder. - createShortcutInStartUpFolder: boolean
-
Create a shortcut in the client's Auto Start folder. - startPath: string (1 to 255 chars)
-
Specifies the path in the Start folder where the shortcut will be created. - inheritShortcutDefaultSettings: boolean
-
Inherit default shortcut settings. - startOnLogon: boolean
-
Start a resource automatically when a user logs on. - newName: string (1 to 255 chars)
-
A new name to assign to the published resource. - enabled: boolean
-
Enable or disable a published resource. - description: string (up to 255 chars)
-
Published resource description. - publishToSiteIds: integer[]
-
An array of sites to which to publish a resource. -
integer (int32) - ipFilterEnabled: boolean
-
Enable or disable IP filters. - ipFilterReplicate: boolean
-
Replicate or not IP filters. - clientFilterEnabled: boolean
-
Enable or disable client filters. - clientFilterReplicate: boolean
-
Replicate or not client filters. - macFilterEnabled: boolean
-
Enable or disable mac filters. - macFilterReplicate: boolean
-
Replicate or not mac filters. - userFilterEnabled: boolean
-
Enable or disable user filters. - userFilterReplicate: boolean
-
Replicate or not user filters. - gwFilterEnabled: boolean
-
Enable or disable GW filters. - osFilterEnabled: boolean
-
Enable or disable the OS filter. - osFilterReplicate: boolean
-
Replicate or not OS filter settings to all sites. - allowClientChrome: boolean
-
Allow or not Chrome OS Clients. - allowClientAndroid: boolean
-
Allow or not Android Clients. - allowClientHTML5: boolean
-
Allow or not HTML5 Clients. - allowClientIOS: boolean
-
Allow or not IOS Clients. - allowClientLinux: boolean
-
Allow or not Linux Clients. - allowClientMAC: boolean
-
Allow or not MAC Clients. - allowClientWebPortal: boolean
-
Allow or not Web Portal Clients. - allowClientWindows: boolean
-
Allow or not Windows Clients. - allowClientWyse: boolean
-
Allow or not Wyse Clients. - siteId: integer (int32)
-
Site ID.
Example
{
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritDisplayDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"inheritLicenseDefaultSettings": "boolean",
"enableFileExtensions": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"fileExtensions": "string",
"serverId": "integer (int32)",
"target": "string",
"parameters": "string",
"startIn": "string",
"winType": "string",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"inheritShortcutDefaultSettings": "boolean",
"startOnLogon": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
SetPubRDSAppServerAttr: object
- target: string (up to 255 chars)
-
Application target file. (i.e. calc.exe, file.txt, etc.) - startIn: string (up to 255 chars)
-
Application working directory. - parameters: string (up to 255 chars)
-
Application parameters. - siteId: integer (int32)
-
Site ID.
Example
{
"target": "string",
"startIn": "string",
"parameters": "string",
"siteId": "integer (int32)"
}
SetPubRDSDesktop: object
- connectToConsole: boolean
-
Enables or disables the 'Connect to console' option. - publishFrom: string 0 = All, 1 = Group, 2 = Server
-
Specifies the 'Publish from' option. Acceptable values: All (All servers in the site), Group (Server Groups), Server (Individual Servers). - publishFromGroupIds: integer[]
-
Specifies one or multiple group Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (Server groups). -
integer (int32) - publishFromServerIds: integer[]
-
Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Individual Servers). -
integer (int32) - width: integer (int32)
-
Desktop width. - height: integer (int32)
-
Desktop height. - desktopSize: string 0 = UseAvailableArea, 1 = FullScreen, 2 = W640xH480, 3 = W800xH600, 4 = W854xH480, 5 = W1024xH576, 6 = W1024xH768, 7 = W1152xH864, 8 = W1280xH720, 9 = W1280xH768, 10 = W1280xH800, 11 = W1280xH960, 12 = W1280xH1024, 13 = W1360xH768, 14 = W1366xH768, 15 = W1400xH1050, 16 = W1440xH900, 17 = W1600xH900, 18 = W1600xH1024, 19 = W1600xH1200, 20 = W1680xH1050, 21 = W1920xH1080, 22 = W1920xH1200, 23 = W1920xH1440, 24 = W2048xH1152, 25 = Custom
-
Desktop Size. Possible values are: 0 (Use available area), 1 (Full screen), Custom = 25. Specific sizes are specified by numbers in the 2 to 24 range: 2 (640x480), 3 (800x600), ... 24 (2048 x 1152) Listed in that order: 640x480, 800x600, 854x480, 1024x576, 1024x768, 1152x864, 1280x720, 1280x768, 1280x800, 1280x960, 1280x1024, 1360x768, 1366x768, 1400x1050, 1440x900, 1600x900, 1600x1024, 1600x1200, 1680x1050, 1920x1440, 1920x1080, 1920x1200, 2048x1152 - allowMultiMonitor: string 0 = Enabled, 1 = Disabled, 2 = UseClientSettings
-
Specifies the Multi-monitor option. Acceptable values: Enabled, Disabled, UseClientSettings. - replicateShortcutSettings: boolean
-
Replicate shortcut settings to all sites. - createShortcutOnDesktop: boolean
-
Create a shortcut on a client's desktop. - createShortcutInStartFolder: boolean
-
Create a shortcut in the client's Start folder. - createShortcutInStartUpFolder: boolean
-
Create a shortcut in the client's Auto Start folder. - startPath: string (1 to 255 chars)
-
Specifies the path in the Start folder where the shortcut will be created. - inheritShortcutDefaultSettings: boolean
-
Inherit default shortcut settings. - startOnLogon: boolean
-
Start a resource automatically when a user logs on. - newName: string (1 to 255 chars)
-
A new name to assign to the published resource. - enabled: boolean
-
Enable or disable a published resource. - description: string (up to 255 chars)
-
Published resource description. - publishToSiteIds: integer[]
-
An array of sites to which to publish a resource. -
integer (int32) - ipFilterEnabled: boolean
-
Enable or disable IP filters. - ipFilterReplicate: boolean
-
Replicate or not IP filters. - clientFilterEnabled: boolean
-
Enable or disable client filters. - clientFilterReplicate: boolean
-
Replicate or not client filters. - macFilterEnabled: boolean
-
Enable or disable mac filters. - macFilterReplicate: boolean
-
Replicate or not mac filters. - userFilterEnabled: boolean
-
Enable or disable user filters. - userFilterReplicate: boolean
-
Replicate or not user filters. - gwFilterEnabled: boolean
-
Enable or disable GW filters. - osFilterEnabled: boolean
-
Enable or disable the OS filter. - osFilterReplicate: boolean
-
Replicate or not OS filter settings to all sites. - allowClientChrome: boolean
-
Allow or not Chrome OS Clients. - allowClientAndroid: boolean
-
Allow or not Android Clients. - allowClientHTML5: boolean
-
Allow or not HTML5 Clients. - allowClientIOS: boolean
-
Allow or not IOS Clients. - allowClientLinux: boolean
-
Allow or not Linux Clients. - allowClientMAC: boolean
-
Allow or not MAC Clients. - allowClientWebPortal: boolean
-
Allow or not Web Portal Clients. - allowClientWindows: boolean
-
Allow or not Windows Clients. - allowClientWyse: boolean
-
Allow or not Wyse Clients. - siteId: integer (int32)
-
Site ID.
Example
{
"connectToConsole": "boolean",
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"width": "integer (int32)",
"height": "integer (int32)",
"desktopSize": "string",
"allowMultiMonitor": "string",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"inheritShortcutDefaultSettings": "boolean",
"startOnLogon": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
SetRASAdminAccount: object
- email: string (1 to 255 chars)
-
Parallels RAS administrator email address. - mobile: string (1 to 50 chars)
-
Parallels RAS administrator mobile phone number. - enabled: boolean
-
Enables or disables the specified administrator account. - notify: string 0 = None, 1 = Email
-
Specifies a method for system notifications. Possible values are: "None", "Email". - permissions: string 0 = PowerAdmin, 1 = RootAdmin, 2 = CustomAdmin
- fullPermissions: boolean
-
Whether to grant the specified administrator full permissions in the farm. If set to False, permissions can be set individually.
Example
{
"email": "string",
"mobile": "string",
"enabled": "boolean",
"notify": "string",
"permissions": "string",
"fullPermissions": "boolean"
}
SetRASAllowedDeviceSetting: object
- allowClientMode: string 0 = AllowAllClientsConnectToSystem, 1 = AllowSelectedClientsConnectToSystem, 2 = AllowSelectedClientsListPublishedItems
-
Sets the permission mode for allowing types of clients. - allowClient2XOS: boolean
-
Allows 2XOS clients. - allowClientBlackberry: boolean
-
Allows Blackberry clients. - allowClientChromeApp: boolean
-
Allows ChromeApp clients. - allowClientAndroid: boolean
-
Allows Droid clients. - allowClientHTML5: boolean
-
Allows HTML5 clients. - allowClientIOS: boolean
-
Allows IOS clients. - allowClientJava: boolean
-
Allows Java clients. - allowClientLinux: boolean
-
Allows Linux clients. - allowClientMAC: boolean
-
Allows Mac clients. - allowClientWebPortal: boolean
-
Allows Web clients. - allowClientWindows: boolean
-
Allows Windows clients. - allowClientWinPhone: boolean
-
Allows WindowsPhone clients. - allowClientWyse: boolean
-
Allows Wyse clients. - replicateSettings: boolean
-
Enables/disables replication of settings to other sites. - minBuild2XOS: integer (int32)
-
Represents the minimum build required for the 2XOS client. - minBuildBlackberry: integer (int32)
-
Represents the minimum build required for the Blackberry client. - minBuildChromeApp: integer (int32)
-
Represents the minimum build required for the Chromeapp client. - minBuildAndroid: integer (int32)
-
Represents the minimum build required for the Droid client. - minBuildHTML5: integer (int32)
-
Represents the minimum build required for the HTML5 client. - minBuildIOS: integer (int32)
-
Represents the minimum build required for the IOS client. - minBuildJava: integer (int32)
-
Represents the minimum build required for the Java client. - minBuildLinux: integer (int32)
-
Represents the minimum build required for the Linux client. - minBuildMAC: integer (int32)
-
Represents the minimum build required for the Mac client. - minBuildWebPortal: integer (int32)
-
Represents the minimum build required for the Web client. - minBuildWindows: integer (int32)
-
Represents the minimum build required for the Windows client. - minBuildWinPhone: integer (int32)
-
Represents the minimum build required for the Windows Phone client. - minBuildWyse: integer (int32)
-
Represents the minimum build required for the Wyse client.
Example
{
"allowClientMode": "string",
"allowClient2XOS": "boolean",
"allowClientBlackberry": "boolean",
"allowClientChromeApp": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientJava": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWinPhone": "boolean",
"allowClientWyse": "boolean",
"replicateSettings": "boolean",
"minBuild2XOS": "integer (int32)",
"minBuildBlackberry": "integer (int32)",
"minBuildChromeApp": "integer (int32)",
"minBuildAndroid": "integer (int32)",
"minBuildHTML5": "integer (int32)",
"minBuildIOS": "integer (int32)",
"minBuildJava": "integer (int32)",
"minBuildLinux": "integer (int32)",
"minBuildMAC": "integer (int32)",
"minBuildWebPortal": "integer (int32)",
"minBuildWindows": "integer (int32)",
"minBuildWinPhone": "integer (int32)",
"minBuildWyse": "integer (int32)"
}
SetRASAuthSettings: object
- authType: string 0 = UsernamePassword, 1 = SmartCard, 2 = UsernamePasswordOrSmartCard
-
Represents the type of authentication. - allTrustedDomains: boolean
-
Whether to use all trusted domains. - domain: string (1 to 64 chars)
-
Domain name. - useClientDomain: boolean
-
Whether to use the client domain, if specified. - forceNetBIOSCreds: boolean
-
Whether to force clients to use NetBIOS credentials. - replicateSettings: boolean
-
Whether to replicate settings to other sites.
Example
{
"authType": "string",
"allTrustedDomains": "boolean",
"domain": "string",
"useClientDomain": "boolean",
"forceNetBIOSCreds": "boolean",
"replicateSettings": "boolean"
}
SetRASCustomPermission: object
- objId: integer (int32)
-
ID of a particular RAS Farm object to assign permissions for. - objectType: string 1 = RDSHosts, 3 = Gateways, 5 = RemotePCs, 7 = PublishingAgents, 16 = RDSHGroups, 25 = HALB, 26 = WinDevices, 31 = Themes, 40 = Publishing, 2003 = Monitoring, 2004 = Reporting, 2012 = Connection
-
Permission Type. - permissions: string 0 = None, 1 = View, 2 = Modify, 4 = ManageSessions, 8 = Add, 16 = Delete, 32 = Control
-
A set of permissions to assign. To form a set of permissions 'OR' individual permission enum IDs.
Example
{
"objId": "integer (int32)",
"objectType": "string",
"permissions": "string"
}
SetRASPowerPermission: object
- allowSiteChanges: boolean
-
Enables or disables the "Allow Site changes" option. - allowPublishingChanges: boolean
-
Enables or disables the "Allow Publishing changes" option. - allowConnectionChanges: boolean
-
Enables or disables the "Allow Connection changes" option. - allowViewingReportingInfo: boolean
-
Enables or disables the "Allow viewing of RAS Reporting" option. - allowViewingSiteInfo: boolean
-
Enables or disables the "Allow viewing of Site Information" option. - allowViewingPolicyInfo: boolean
-
Enables or disables the "Allow viewing of Policy Information" option. - allowSessionManagement: boolean
-
Enables or disables the "Allow Session Management" option. - allowClientManagementChanges: boolean
-
Enables or disables the "Allow Client Management changes" option. - allowPolicyChanges: boolean
-
Enables or disables the "Allow Policy changes" option. - allowAllSites: boolean
-
Enables or disables the "All Sites" option. If enabled, the administrator can manage all sites in the farm. Otherwise, sites can be specified individually. - allowInSiteIds: integer[]
-
A list of site ids (a integer array) which the administrator should be allowed to manage. -
integer (int32)
Example
{
"allowSiteChanges": "boolean",
"allowPublishingChanges": "boolean",
"allowConnectionChanges": "boolean",
"allowViewingReportingInfo": "boolean",
"allowViewingSiteInfo": "boolean",
"allowViewingPolicyInfo": "boolean",
"allowSessionManagement": "boolean",
"allowClientManagementChanges": "boolean",
"allowPolicyChanges": "boolean",
"allowAllSites": "boolean",
"allowInSiteIds": [
"integer (int32)"
]
}
SetRASPrintingSettings: object
- printerDriversArray: string[]
-
Printer Drivers string array. -
string - excludedFontsArray: string[]
-
Excluded Fonts string array. -
string - printerNamePattern: string (up to 255 chars)
-
Printer Name Pattern. Default pattern: %PRINTERNAME% for %USERNAME% by Parallels Valid pattern variables: %PRINTERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Printer - embedFonts: boolean
-
Embed Fonts. - replicatePrinterFont: boolean
-
Replicate Printer Font Settings. - replicatePrinterPattern: boolean
-
Replicate Printer Name Pattern Settings. - replicatePrinterDrivers: boolean
-
Replicate Printer Drivers Settings. - driverAllowMode: string 0 = AllowRedirUsingAnyDriver, 1 = AllowRedirUsingSpecifiedDriver, 2 = DoNotAllowRedirUsingSpecifiedDriver
-
Printer Drivers allow mode. - printerRetention: string 0 = Off, 1 = On
-
Printer Retention mode.
Example
{
"printerDriversArray": [
"string"
],
"excludedFontsArray": [
"string"
],
"printerNamePattern": "string",
"embedFonts": "boolean",
"replicatePrinterFont": "boolean",
"replicatePrinterPattern": "boolean",
"replicatePrinterDrivers": "boolean",
"driverAllowMode": "string",
"printerRetention": "string"
}
SetRASScanningSettings: object
- twainNamePattern: string (up to 255 chars)
-
TWAIN Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Scanner - wiaNamePattern: string (up to 255 chars)
-
WIA Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% - replicateTWAINPattern: boolean
-
Replicate TWAIN Pattern. - replicateWIAPattern: boolean
-
Replicate WIA pattern.
Example
{
"twainNamePattern": "string",
"wiaNamePattern": "string",
"replicateTWAINPattern": "boolean",
"replicateWIAPattern": "boolean"
}
SetRASSessionSetting: object
- remoteIdleSessionTimeout: integer (int32)
-
Sets the session idle timeout. - logoffIdleSessionTimeout: integer (int32)
-
Sets the client logoff timeout. - cachedSessionTimeout: integer (int32)
-
Sets the cached session timeout. - fipsMode: string 0 = Disabled, 1 = Allowed, 2 = Enforced
-
FIPS 140-2 encryption mode. - replicateSettings: boolean
-
Whether to replicate settings to other sites.
Example
{
"remoteIdleSessionTimeout": "integer (int32)",
"logoffIdleSessionTimeout": "integer (int32)",
"cachedSessionTimeout": "integer (int32)",
"fipsMode": "string",
"replicateSettings": "boolean"
}
SetRDS: object
- enabled: boolean
-
Enable or disable the specified RD Session Host server in a site. - newServer: string (1 to 255 chars)
-
A new server name. This must be either the server's FQDN or IP address. - description: string (up to 255 chars)
-
A user-defined RD Session Host server description. - directAddress: string (up to 255 chars)
-
Specifies the RD Session Host server direct address. - inheritDefaultAgentSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit RD Session Host agent settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultPrinterSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit RD Session Host printer settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultUPDSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit RD Session Host User Profile Disk settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultDesktopAccessSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit RD Session Host Desktop Access settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - port: integer (int32)
-
Specifies the port number for the RD Session Host agent. - maxSessions: integer (int32)
-
Specifies the 'Maximum Sessions' property. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Sessions Disconnect Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration). - supportShellURLNamespaceObjects: boolean
-
Enables or disables the 'Support Shell URL Namespace Objects' option. - allowRemoteExec: boolean
-
Enables or disables the 'Allow 2XRemoteExec to send command to the client' option. - enableAppMonitoring: boolean
-
Enables or disables the 'Application Monitoring' option. - useRemoteApps: boolean
-
Enables or disables the 'Use RemoteApps if available' option. - allowFileTransfer: boolean
-
Enables or disables the 'Allow file transfer' option. - dragAndDropMode: string 0 = Disabled, 1 = ClientToServer, 2 = ServerToClient, 3 = Bidirectional
-
Specifies the mode the client server drag and drop feature will operate. - enablePrinting: boolean
-
Enables or disables Universal Printing on the RD Session Host server. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category. - enableTWAIN: boolean
-
Enables or disables TWAIN (Universal Scanning) on the RD Session Host server. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category. - enableWIA: boolean
-
Enables or disables WIA (Universal Scanning) on the RD Session Host server. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES. - removeClientNameFromPrinterName: boolean
-
Enables or disables the 'Remove client name from printer name' option. - removeSessionNumberFromPrinterName: boolean
-
Enables or disables the 'Remove session number from printer name' option. - autoPreferredPA: boolean false
-
Sets the 'Preferred Publishing Agent' option to 'Automatically". - preferredPAId: integer (int32)
-
The preferred Publishing Agent server Id. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled. - updRoamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include. - upDiskPath: string (up to 255 chars)
-
Specifies the User Profile Disk path. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Enables or disables the 'Restrict direct desktop access to the following users' option. Use the RestrictedUsers parameter to specify the list of users. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs. -
string
Example
{
"enabled": "boolean",
"newServer": "string",
"description": "string",
"directAddress": "string",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"dragAndDropMode": "string",
"enablePrinting": "boolean",
"enableTWAIN": "boolean",
"enableWIA": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
SetRDSDefaults: object
- port: integer (int32)
-
Specifies the RD Session Host agent port number. - maxSessions: integer (int32)
-
Specifies the 'Maximum Sessions' option. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Settings Disconnect Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow mail and URL redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration). - supportShellURLNamespaceObjects: boolean
-
Enables or disables the 'Support Shell URL Namespace Objects' option. - autoPreferredPA: boolean false
-
Sets the 'Preferred Publishing Agent' option to 'Automatically". - preferredPAId: integer (int32)
-
The preferred Publishing Agent server. - allowRemoteExec: boolean
-
Enables or disables the 'Allow 2XRemoteExec to send command to the client' option. - enableAppMonitoring: boolean
-
Enables or disables the 'Enable application monitoring' option. - useRemoteApps: boolean
-
Enables or disables the 'Use RemoteApps if available' option. - allowFileTransfer: boolean
-
Enables or disables the 'Allow file transfer' option. - dragAndDropMode: string 0 = Disabled, 1 = ClientToServer, 2 = ServerToClient, 3 = Bidirectional
-
Specifies the mode the client server drag and drop feature will operate. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES. - removeClientNameFromPrinterName: boolean
-
Enables or disables the 'Remove client name from printer name' option. - removeSessionNumberFromPrinterName: boolean
-
Enables or disables the 'Remove session number from printer name' option. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled. - updRoamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include. - upDiskPath: string (up to 255 chars)
-
Specifies the User Profile Disk path. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Enables or disables the 'Restrict direct desktop access to the following users' option. To specify the list of users, use the RestrictedUsers parameter. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain User account names and User SIDs. -
string
Example
{
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"dragAndDropMode": "string",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
SetRDSGroup: object
- enabled: boolean
-
Enables or disables the specified group(s) in a site. - newName: string (1 to 255 chars)
-
A new name to assign to the specified group. - description: string (1 to 255 chars)
-
A description of the specified group. - useRASTemplate: boolean
-
Enables or disables the use of RAS Template. - rasTemplateId: integer (int32)
-
The RD RAS Template Id. - workLoadThreshold: integer (int32)
-
Send a request to the RAS template when the workload threshold is above the specified value - serversToAddPerRequest: integer (int32)
-
Number of servers to be added to the group per request - maxServersFromTemplate: integer (int32)
-
Max number of servers to be added to the group from the RAS Template - workLoadToDrain: integer (int32)
-
Drain and unassign servers from group when workload is below the specified value - inheritDefaultAgentSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global agent settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultPrinterSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global printer settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultUPDSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global User Profile Disk settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - inheritDefaultDesktopAccessSettings: boolean
-
Enables the 'Inherit default settings' option. This will inherit Global Desktop Access settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters. - port: integer (int32)
-
Specifies the port number for the RD Session Host agent. - maxSessions: integer (int32)
-
Specifies the 'Maximum Sessions' property. - sessionTimeout: integer (int32)
-
Specifies the 'Publishing Sessions Disconnect Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'. - sessionLogoffTimeout: integer (int32)
-
Specifies the 'Publishing Settings Reset Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'. - allowURLAndMailRedirection: string 0 = Disabled, 1 = Enabled, 2 = EnabledWithAppRegistration
-
Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration). - supportShellURLNamespaceObjects: boolean
-
Enables or disables the 'Support Shell URL Namespace Objects' option. - autoPreferredPA: boolean false
-
Sets the 'Preferred Publishing Agent' option to 'Automatically". - allowRemoteExec: boolean
-
Enables or disables the 'Allow 2XRemoteExec to send command to the client' option. - enableAppMonitoring: boolean
-
Enables or disables the 'Application Monitoring' option. - useRemoteApps: boolean
-
Enables or disables the 'Use RemoteApps if available' option. - allowFileTransfer: boolean
-
Enables or disables the 'Allow file transfer' option. - printerNameFormat: string 0 = PrnFormat_PRN_CMP_SES, 1 = PrnFormat_SES_CMP_PRN, 2 = PrnFormat_PRN_REDSES
-
Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES. - removeClientNameFromPrinterName: boolean
-
Enables or disables the 'Remove client name from printer name' option. - removeSessionNumberFromPrinterName: boolean
-
Enables or disables the 'Remove session number from printer name' option. - updMode: string 0 = DoNotChange, 1 = Enabled, 2 = Disabled
-
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled. - updRoamingMode: string 0 = Exclude, 2 = Include
-
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include. - upDiskPath: string (up to 255 chars)
-
Specifies the User Profile Disk path. - maxUserProfileDiskSizeGB: integer (int32)
-
Specifies the max user profile disk size (in GB). - includeFolderPath: string[]
-
Specifies the UPD 'Include' folder paths. -
string - includeFilePath: string[]
-
Specifies the UPD 'Include' file paths. -
string - excludeFolderPath: string[]
-
Specifies the UPD 'Exclude' folder paths. -
string - excludeFilePath: string[]
-
Specifies the UPD 'Exclude' file paths. -
string - restrictDesktopAccess: boolean
-
Enables or disables the 'Restrict direct desktop access to the following users' option. Use the RestrictedUsers parameter to specify the list of users. - restrictedUsers: string[]
-
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs. -
string
Example
{
"enabled": "boolean",
"newName": "string",
"description": "string",
"useRASTemplate": "boolean",
"rasTemplateId": "integer (int32)",
"workLoadThreshold": "integer (int32)",
"serversToAddPerRequest": "integer (int32)",
"maxServersFromTemplate": "integer (int32)",
"workLoadToDrain": "integer (int32)",
"inheritDefaultAgentSettings": "boolean",
"inheritDefaultPrinterSettings": "boolean",
"inheritDefaultUPDSettings": "boolean",
"inheritDefaultDesktopAccessSettings": "boolean",
"port": "integer (int32)",
"maxSessions": "integer (int32)",
"sessionTimeout": "integer (int32)",
"sessionLogoffTimeout": "integer (int32)",
"allowURLAndMailRedirection": "string",
"supportShellURLNamespaceObjects": "boolean",
"autoPreferredPA": "boolean",
"allowRemoteExec": "boolean",
"enableAppMonitoring": "boolean",
"useRemoteApps": "boolean",
"allowFileTransfer": "boolean",
"printerNameFormat": "string",
"removeClientNameFromPrinterName": "boolean",
"removeSessionNumberFromPrinterName": "boolean",
"updMode": "string",
"updRoamingMode": "string",
"upDiskPath": "string",
"maxUserProfileDiskSizeGB": "integer (int32)",
"includeFolderPath": [
"string"
],
"includeFilePath": [
"string"
],
"excludeFolderPath": [
"string"
],
"excludeFilePath": [
"string"
],
"restrictDesktopAccess": "boolean",
"restrictedUsers": [
"string"
]
}
SetSite: object
- newName: string (1 to 255 chars)
-
A new name to assign to the site.
Example
{
"newName": "string"
}
Site: object
- name: string
-
Name of the site. - licensingSite: boolean
-
Whether this is a licensing site or not. - id: integer (int32)
-
ID of the object.
Example
{
"name": "string",
"licensingSite": "boolean",
"id": "integer (int32)"
}
SitePermission: object
- siteId: integer (int32)
- rdsHosts: SiteTypePermission
- rdshGroups: SiteTypePermission
- remotePCs: SiteTypePermission
- gateways: SiteTypePermission
- publishingAgents: SiteTypePermission
- halb: SiteTypePermission
- themes: SiteTypePermission
- publishing: SiteTypePermission
- connection: SiteTypePermission
- winDevices: SiteTypePermission
Example
{
"siteId": "integer (int32)",
"rdsHosts": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"rdshGroups": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"remotePCs": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"gateways": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishingAgents": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"halb": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"themes": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishing": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"connection": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"winDevices": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{}
]
}
}
SiteSysInfo: object
- priority: integer (int32)
- name: string
-
Site Name - cpuLoad: integer (int32)
-
CPU load percentage. - memLoad: integer (int32)
-
Memory load percentage. - diskRead: integer (int32)
-
Disk Read. - diskWrite: integer (int32)
-
Disk Write. - enabled: boolean
-
Enabled or not. - id: string
-
ID of RAS Agent. - server: string
-
Server name. - siteId: integer (int32)
-
ID of Site. - agentVer: string
-
Agent Version. - serverOS: string
-
Server Operating System. - serviceStartTime: string
-
Service start time. - systemBootTime: string
-
System boot time. - unhandledExceptions: integer (int32)
-
Number of unhandled exceptions. - agentState: string 0 = OK, 1 = EnumSessionsFailed, 2 = RDSRoleDisabled, 3 = MaxNonCompletedSessions, 4 = RASScheduleInProgress, 5 = ConnectionFailed, 6 = InvalidCredentials, 7 = NeedsSysprep, 8 = SysPrepInProgress, 9 = CloningFailed, 10 = Synchronising, 12 = FinalizingSysprep, 13 = LogonDrainUntilRestart, 14 = LogonDrain, 15 = LogonDisabled, 16 = ForcedDisconnect, 17 = CloningCanceled, 18 = RASprepInProgress, 19 = FinalizingRASprep, 20 = InstallingRDSRole, 21 = RebootPending, 22 = PortMismatch, 23 = NeedsDowngrade, 24 = NotApplied, 25 = CloningInProgress, 26 = MarkedForDeletion, 27 = StandBy, 28 = UnsupportedVDIType, 29 = FreeESXLicenseNotSupported, 30 = ManagedESXNotSupported, 31 = HotfixKB2580360NotInstalled, 32 = InvalidHostVersion, -6 = Unknown, -5 = NeedsUpdate, -4 = NotVerified, -3 = ServerDeleted, -2 = DisabledFromSettings, -1 = Disconnected
-
Agent State. - serverType: string 1 = RDS, 2 = VDIHost, 3 = Gateway, 4 = Guest, 5 = PC, 6 = VDITemplate, 7 = PA, 9 = Site, -1 = All
-
Type of server. - logLevel: string 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard, 4 = Extended, 5 = Verbose
-
Level of logging: 0 = Critical, 1 = Error, 2 = Warning, 3 = Standard (Information), 4 = Extended, 5 = Verbose (Trace).
Example
{
"priority": "integer (int32)",
"name": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
SiteTypePermission: object
- sitePermission: GlobalPermission
- objectPermissions: ObjectPermission
-
ObjectPermission
Example
{
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
}
TOTPSettings: object
- type: string
- userEnrollment: string 0 = Allow, 1 = AllowUntil, 2 = DoNotAllow
- untilDateTime: string (date-time)
Example
{
"type": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
TwoFactorAuthSetting: object
- deepnetSettings: DeepnetSettings
- safeNetSettings: SafeNetSettings
- radiusSettings: RadiusSettings
- azureRadiusSettings: RadiusSettings
- duoRadiusSettings: RadiusSettings
- fortiRadiusSettings: RadiusSettings
- tekRadiusSettings: RadiusSettings
- gAuthTOTPSettings: TOTPSettings
- provider: string 0 = None, 1 = Deepnet, 2 = SafeNet, 3 = Radius, 4 = AzureRadius, 5 = DuoRadius, 6 = FortiRadius, 7 = TekRadius, 8 = GAuthTOTP
- excludeClientIPs: boolean
- excludeClientMAC: boolean
- excludeClientGWIPs: boolean
- excludeClientMACList: string[]
-
string - excludeClientGWIPList: string[]
-
string - replicateSettings: boolean
- siteId: integer (int32)
- excludeClientIPList: IP4Range
-
IP4Range - excludeClientIPv6List: IP6Range
-
IP6Range - excludeUserGroup: boolean
- excludeUserGroupList: UserFilter
-
UserFilter
Example
{
"deepnetSettings": {
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"authMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"ssl": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string"
},
"safeNetSettings": {
"authMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string"
},
"radiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"azureRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"duoRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"fortiRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"tekRadiusSettings": {
"server": "string"
}
}
UserFilter: object
- account: string
-
The name of the user/group account the filter is added to. - type: string 0 = Unknown, 1 = User, 2 = Group, 3 = ForeignSecurityPrincipal
-
The type of the account (user or group) the filter is added to. - sid: string
-
The SID of the user/group account the filter is added to.
Example
{
"account": "string",
"type": "string",
"sid": "string"
}
VDITemplate: object
- name: string
- siteId: integer (int32)
- enabled: boolean
- templateType: string 0 = VDIDesktop, 1 = RDSH
- vdiHostId: integer (int32)
- maxGuests: integer (int32)
- preCreatedGuests: integer (int32)
- guestsToCreate: integer (int32)
- unusedGuestDurationMins: integer (int32)
- vdiGuestId: string
- physicalHostId: string
- physicalHostName: string
- folderId: string
- folderName: string
- subFolderName: string
- guestNameFormat: string
- nativePoolId: string
- nativePoolName: string
- cloneMethod: string 0 = FullClone, 1 = LinkedClone
- linkedClone: boolean
- useDefAgentSettings: boolean
- deleteUnusedGuests: boolean
- licenseKeyType: string 0 = KMS, 1 = MAK
- isMAK: boolean
- licKeys: VDITemplateLicKey
-
VDITemplateLicKey - imagePrepTool: string 0 = RASPrep, 1 = SysPrep
- isRASPrep: boolean
- computerName: string
- ownerName: string
- organization: string
- administrator: string
- domain: string
- domainOrgUnit: string
- inheritDefVDIActionSettings: boolean
- inheritDefVDISecuritySettings: boolean
- sessionResetTimeoutSec: integer (int32)
- sessionAction: string 0 = Disconnect, 1 = Logoff
- performAction: string 0 = DoNothing, 2 = Shutdown, 3 = Restart, 4 = Suspend, 7 = Delete, 8 = Unassign, 9 = Recreate
- performActionAfterSec: integer (int32)
- isUsersGrantedRDPermissions: boolean
- groupType: string 0 = RDUsers, 1 = Administrators
- id: integer (int32)
-
ID of the object.
Example
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"templateType": "string",
"vdiHostId": "integer (int32)",
"maxGuests": "integer (int32)",
"preCreatedGuests": "integer (int32)",
"guestsToCreate": "integer (int32)",
"unusedGuestDurationMins": "integer (int32)",
"vdiGuestId": "string",
"physicalHostId": "string",
"physicalHostName": "string",
"folderId": "string",
"folderName": "string",
"subFolderName": "string",
"guestNameFormat": "string",
"nativePoolId": "string",
"nativePoolName": "string",
"cloneMethod": "string",
"linkedClone": "boolean",
"useDefAgentSettings": "boolean",
"deleteUnusedGuests": "boolean",
"licenseKeyType": "string",
"isMAK": "boolean",
"licKeys": [
{
"licenseKey": "string",
"keyLimit": "integer (int32)"
}
],
"imagePrepTool": "string",
"isRASPrep": "boolean",
"computerName": "string",
"ownerName": "string",
"organization": "string",
"administrator": "string",
"domain": "string",
"domainOrgUnit": "string",
"inheritDefVDIActionSettings": "boolean",
"inheritDefVDISecuritySettings": "boolean",
"sessionResetTimeoutSec": "integer (int32)",
"sessionAction": "string",
"performAction": "string",
"performActionAfterSec": "integer (int32)",
"isUsersGrantedRDPermissions": "boolean",
"groupType": "string",
"id": "integer (int32)"
}