Awsec2

Last updated 11 months ago

Was this helpful?

Create

Create a new RemotePCDynamic Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.

post

/api/Provider/awsec2

Query parameters

noInstallboolean

Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.

usernamestring

An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.

passwordstring

The password of the account specified in the Username parameter.

noRestartboolean

Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.

noFireWallRulesboolean

Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.

Body

namestring | nullable

<para type="description">The name of the Provider.</para>

serverstring | nullable

<para type="description">A Provider server FQDN or IP addresses.</para>

siteIdinteger · int32

<para type="description">The site ID to which to add the specified server.</para> <para type="description">If the parameter is omitted, the Licensing Server site ID will be used.</para>

vdiAgentstring | nullable

<para type="description">FQDN or IP address of the server where the RAS VDI Agent is running.</para> <para type="description"></para>

preferredBrokerIdinteger · int32 | nullable

<para type="description">The preferred Connection Broker ID.</para>

useAllGuestsboolean | nullable

<para type="description">Use all guests.</para>

awseC2Versionstring · enumrequired

<para type="synopsis">AWSEC2 Hypervisor Type</para> <para type="description"></para>

Options: 0 = AWSEC2,1638400 = AWSEC2_Depr

accessKeyIDstring | nullablerequired

<para type="description">The access key ID of the Amazon Web Service account.</para>

secretAccessKeystring | nullablerequired

<para type="description">The secret access key of the Amazon Web Service account.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/awsec2' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "server": "text",
    "siteId": 1,
    "vdiAgent": "text",
    "preferredBrokerId": 1,
    "useAllGuests": true,
    "awseC2Version": [
      "0 = AWSEC2",
      "1638400 = AWSEC2_Depr"
    ],
    "accessKeyID": "text",
    "secretAccessKey": "text"
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-15T18:36:56.080Z",
  "timeLastMod": "2025-03-15T18:36:56.080Z",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "inheritDefaultAgentSettings": true,
  "vdiAgent": "text",
  "preferredBrokerId": 1,
  "server": "text",
  "name": "text",
  "type": [
    "9 = HyperV",
    "10 = VMwareESXi",
    "15 = VMwarevCenter",
    "16 = HyperVFailover",
    "18 = Nutanix",
    "20 = ScaleComputing",
    "21 = Azure",
    "22 = AVD",
    "23 = RemotePCStatic",
    "24 = RemotePCDynamic",
    "25 = AWSEC2"
  ],
  "providerUsername": "text",
  "hostPort": 1,
  "vdiPort": 1,
  "directAddress": "text",
  "sessionTimeout": 1,
  "sessionLogoffTimeout": 1,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": true,
  "allowDragAndDrop": true,
  "allowRemoteExec": true,
  "enableAppMonitoring": true,
  "useRemoteApps": true,
  "allowFileTransfer": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": true,
  "enablePrinting": true,
  "enableTWAIN": true,
  "enableWIA": true,
  "useDefaultPrinterSettings": true,
  "removeClientNameFromPrinterName": true,
  "removeSessionNumberFromPrinterName": true,
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "enableDriveRedirectionCache": true,
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "useAllGuests": true,
  "useDedicatedVDIAgent": true,
  "adminCredentials": [
    {
      "enabled": true,
      "priority": 1,
      "username": "text"
    }
  ],
  "version": [
    "0 = AWSEC2",
    "1638400 = AWSEC2_Depr"
  ],
  "locationType": [
    "0 = Default",
    "1 = OptedIn",
    "2 = EndpointUrl"
  ],
  "regionName": "text",
  "accessKeyId": "text",
  "regionCode": "text",
  "endpointUrl": "text"
}

Created