Configures all components of SSL VPN for remote user connections—advancedConfig, clientConfiguration, ipPools, privateNetworks, users, webResources, clientInstallPackages, authenticationConfiguration, and layoutConfigurationDto.

Note

VMware recommends you issue a GET request to retrieve the SSL VPN configuration, modify the configuration, then submit the changes by sending a PUT request.

Prerequisites
1

Log in to vCloud Air as an administrator. See Log in to vCloud Air for information.

2

Create a login session with vCloud Director. See Create a Session for a Virtual Data Center in a Service for information.

3

Using the vCloud API, query vCloud Director for the ID of the edge gateway that requires SSL VPN configuration. See Querying the vCloud API for information.

Procedure
1

(Optional) Request the current SSL VPN configuration for the edge gateway. See List SSL VPN Configuration for vCloud Air.

2

Examine the response and update the required elements.

For a description of each element of the SSL VPN schema, see Schema for SSL VPN Configuration.

3

Submit the updated configuration using the following request header and request body:

PUT https://vchs.vmware.com/hybridity/api/gateways/gatewayId/sslvpn/config

In the request header, include the OATH token and the Accept header that you obtained when creating a login session: 

Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: vcloud-auth-token

In the request body, include the schema elements you retrieved and updated from the GET request.

The server returns status 204 NO CONTENT in the response header. The server does not return a response body.

Example: Requests and Responses to Configure SSL VPN

Request Header – Get the SSL VPN Configuration 

GET https://vchs.vmware.com/hybridity/api/gateways/gw-5/sslvpn/config
Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "d6eFLOqQYfuEn2MJTp7BQ2ISEO+ZYaEgTcqBy8wZQ6js="

Request body not required.

Response Body – Get the SSL VPN Configuration 

{
"version": 4,
"enabled": false,
"template": null,
"logging": {
    "enable": false,
    "logLevel": "info"
},
"advancedConfig": {
    "enableCompression": false,
    "forceVirtualKeyboard": false,
    "randomizeVirtualkeys": false,
    "preventMultipleLogon": false,
    "enableLogging": null,
    "clientNotification": "",
    "enablePublicUrlAccess": false,
    "timeout": {
        "forcedTimeout": 0,
        "sessionIdleTimeout": 10
    }
},
"clientConfiguration": {
    "autoReconnect": true,
    "tunnelConfiguration": null,
    "upgradeNotification": false
},
"ipPools": null,
"privateNetworks": null,
"users": null,
"webResources": null,
"clientInstallPackages": null,
"authenticationConfiguration": {
    "passwordAuthentication": {
        "preventMultipleLogon": null,
        "authenticationTimeout": 1,
        "primaryAuthServers": {
            "authServers": null
        },
        "secondaryAuthServer": {
            "authServer": null
        }
    },
    "certificateAuthentication": null
},
"serverSettings": null,
"layoutConfigurationDto": {
    "portalTitle": "VMware",
    "companyName": "VMware",
    "logoFile": null,
    "encodedLogo": null,
    "logoExtention": "jpg",
    "logoUri": "/api/3.0/edges/edge-9/sslvpn/config/layout/images/portallogo",
    "logoBackgroundColor": "56A2D4",
    "titleColor": "996600",
    "topFrameColor": "000000",
    "menuBarColor": "999999",
    "rowAlternativeColor": "FFFFFF",
    "bodyColor": "FFFFFF",
    "rowColor": "F5F5F5"
  }
}

Request Header – Add an SSL VPN User 

PUT https://vchs.vmware.com/hybridity/api/gateways/gw-5/sslvpn/config
Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "d6eFLOqQYfuEn2MJTp7BQ2ISEO+ZYaEgTcqBy8wZQ6js="

Request Body – Add an SSL VPN User 

{
"version": 4,
"enabled": false,
"template": null,
"logging": {
    "enable": false,
    "logLevel": "info"
},
"advancedConfig": {
    "enableCompression": false,
    "forceVirtualKeyboard": false,
    "randomizeVirtualkeys": false,
    "preventMultipleLogon": false,
    "enableLogging": null,
    "clientNotification": "",
    "enablePublicUrlAccess": false,
    "timeout": {
        "forcedTimeout": 0,
        "sessionIdleTimeout": 10
    }
},
"clientConfiguration": {
    "autoReconnect": true,
    "tunnelConfiguration": null,
    "upgradeNotification": false
},
"ipPools": null,
"privateNetworks": null,
"users": null,
	   "users":[{
	      "objectId": "user-538",
		     "userId":"tester",
		     "password":null,
		     "firstName":"test",
		     "lastName":"test",
		     "description":"",
		     "disableUserAccount":false,
		     "passwordNeverExpires":true,
		     "changePassword":{
		         "changePasswordOnNextLogin":false}
			 }
"webResources": null,
"clientInstallPackages": null,
"authenticationConfiguration": {
    "passwordAuthentication": {
        "preventMultipleLogon": null,
        "authenticationTimeout": 1,
        "primaryAuthServers": {
            "authServers": null
        },
        "secondaryAuthServer": {
            "authServer": null
        }
    },
    "certificateAuthentication": null
},
"serverSettings": null,
"layoutConfigurationDto": {
    "portalTitle": "VMware",
    "companyName": "VMware",
    "logoFile": null,
    "encodedLogo": null,
    "logoExtention": "jpg",
    "logoUri": "/api/3.0/edges/edge-9/sslvpn/config/layout/images/portallogo",
    "logoBackgroundColor": "56A2D4",
    "titleColor": "996600",
    "topFrameColor": "000000",
    "menuBarColor": "999999",
    "rowAlternativeColor": "FFFFFF",
    "bodyColor": "FFFFFF",
    "rowColor": "F5F5F5"
  }
}