Start Or Stop The Vpn Service On A Vshield Edge; Configure Vpn Parameters On A Vshield Edge - VMware VSHIELD APP 1.0 - API Programming Manual

vShield API Programming Guide

Start or Stop the VPN Service on a vShield Edge

You enable or disable VPN service on a vShield Edge by updating the status to start or stop.
Example 5-33. Starting or Stopping VPN Service on a vShield Edge
Request:
PUT <vshield_manager-uri>/api/1.0/network/<portgroup-moid>/
Example:
PUT /api/1.0/network/network-244/vpn/ipsec/action/start HTTP/1.1
Authorization: Basic YWRtaW46ZGVmYXVsdA==
Host: localhost:9998
PUT /api/1.0/network/network-244/vpn/ipsec/action/stop HTTP/1.1
Authorization: Basic YWRtaW46ZGVmYXVsdA==
Host: locahost

Configure VPN Parameters on a vShield Edge

You can provide configuration parameters on a vShield Edge agent to set a VPN tunnel to a remote VPN
router. The first time you configure VPN service for a vShield Edge, the configuration must contain the server
configuration and a minimum of one remote site with a tunnel. If these elements are not sent, the configuration
is rejected.
The IPSec parameters must be compatible on all IPSec end points.
Example 5-34. Configuring VPN Parameters
Request:
POST <vshield_manager-uri>/api/1.0/network/<portgroup-moid>/vpn/ipsec/config
Rules:

Logging is disabled by default. To enable logging, add a <log /> element within <VPNServerConfig />.

VPN service requires encryption. You must specify the <encryptionAlgorithm /> element as either
3des or aes.

The natedPublicIpAddress element under VPNServerConfig is optional.

The siteName and tunnelName can contain only alphanumeric characters.
Example:
POST /api/1.0/network/network-244/vpn/ipsec/config HTTP/1.1
Content-Type: application/xml
Authorization: Basic YWRtaW46ZGVmYXVsdA==
Host: localhost:9998
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Content-Length: 662
<?xml version="1.0" encoding="UTF-8"
40
vpn/ipsec/action/{start | stop}
standalone="yes"?><VShieldEdgeConfig><VPNConfig><IpsecVPNConfig><SiteToSiteIpsec><
VPNServerConfig><externalIpAddress>10.112.196.219</externalIpAddress></VPNServerCo
nfig><VPNSite><Configuration><siteName>VSE1</siteName><remoteEndPointexternalIpAdd
ress>10.112.196.99</remoteEndPointexternalIpAddress><sharedSecret>psk1</sharedSecr
et><mtu>1500</mtu></Configuration><VPNTunnel><Configuration><tunnelName>tunnelVSE<
/tunnelName><remoteSiteSubnet>172.15.1.0/24</remoteSiteSubnet><encryptionAlgorithm
>3des</encryptionAlgorithm></Configuration></VPNTunnel></VPNSite></SiteToSiteIpsec
></IpsecVPNConfig></VPNConfig></VShieldEdgeConfig>
VMware, Inc.