Retrieves the SSL VPN configuration for remote users to connect to vCloud Air.

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 you require SSL VPN configuration details about. See Querying the vCloud API for information.

To get the details for the SSL VPN configuration, issue the following request:

GET 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"

If the request is successful, the server returns HTTP response code 200 and the details of the SSL VPN configuration.

Request Header – Get 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 SSL VPN Configuration

{
"featureType":"sslvpn_4.0",
"version":10,
"enabled":true,
"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":{
      "ipPools": [{
	     "objectId": "ippool-538",
		 "ipRange":"172.16.1.10-172.16.1.30",
		 "netmask":"255.255.255.0",
		 "gateway":"172.16.1.1",
		 "primaryDns":"10.20.20.1",
		 "secondaryDns":"10.20.20.2",
		 "dnsSuffix":"eng.vmware.com",
		 "winsServer":"",
		 "description":"",
		 "enabled":true,
		 "order":1
		 }]
	},
	"privateNetworks":{
	   "privateNetworks":[{
	      "objectId":"privatenetwork-538",
		  "network":"192.168.168.0/24",
		  "sendOverTunnel":{"ports":null,"optimize":true},
		  "description":"",
		  "order":1,
		  "enabled":true}
	      ]},
	"users":{
	   "users":[{
	      "objectId": "user-538",
		  "userId":"tester",
		  "password":null,
		  "firstName":"test",
		  "lastName":"test",
		  "description":"",
		  "disableUserAccount":false,
		  "passwordNeverExpires":true,
		  "changePassword":{
		     "changePasswordOnNextLogin":false}
			 }
		 ]},
	"webResources":null,
	"clientInstallPackages":{
	   "clientInstallPackages":[{
	      "objectId":"clientinstallpackage-538",
		  "profileName":"linux",
		  "gatewayList":[{
		     "hostName":"192.168.4.49",
			 "port":5443}],
		  "createLinuxClient":true,
		  "createMacClient":false,
		  "startClientOnLogon":false,
		  "hideSystrayIcon":false,
		  "rememberPassword":false,
		  "silentModeOperation":false,
		  "silentModeInstallation":false,
		  "hideNetworkAdaptor":false,
		  "createDesktopIcon":true,
		  "enforceServerSecurityCertValidation":false,
		  "description":"",
		  "enabled":true}
		  ]},
	  "authenticationConfiguration": {
	     "passwordAuthentication":{
		    "preventMultipleLogon":null,
			"authenticationTimeout":1,
         "primaryAuthServers":{
			   "authServers":[{
			      "serverType":"local",
				  "authServerType":"local",
				  "objectId":"authserver-519",
				  "order":1,
				  "isSecondaryAuthServer":false,
				  "terminateSessionOnAuthFails":false,
				  "enabled":true,
         "passwordPolicy":{
			"minLength":1,
			"maxLength":63,
			"minAlphabets":0,
			"minDigits":0,
			"minSpecialChar":0,
			"allowUserIdWithinPassword":true,
			"passwordLifeTime":30,
			"expiryNotification":25},
			"accountLockoutPolicy":{
			   "retryCount":3,
			   "retryDuration":1,
			   "lockoutDuration":1}
			   }]
		   },
         "secondaryAuthServer":{
		      "authServer":null}
		   },
         "certificateAuthentication":null},		
      "serverSettings":{"
	     serverAddresses":{
		    "type":"IpAddressesDto",
			"ipAddress":["192.168.4.49"]},
		"port":5443,
		"certificateId":null,
		"cipherList":{
		   "cipher":["RC4-MD5"]}
		   },
	  "layoutConfigurationDto":{
	     "portalTitle":"VMware",
		 "companyName":"VMware",
		 "logoFile":null,
		 "encodedLogo":null,
		 "logoExtention":"jpg",
		 "logoUri":"/api/3.0/edges/edge-97/sslvpn/config/layout/images/portallogo",
		 "logoBackgroundColor":"56A2D4",
		 "titleColor":"996600",
		 "topFrameColor":"000000",
		 "menuBarColor":"999999",
		 "rowAlternativeColor":"FFFFFF",
		 "bodyColor":"FFFFFF",
		 "rowColor":"F5F5F5"}
 }