Apache CloudStack 4.20.0.0 Root Admin API Reference
updateVpnCustomerGateway
Update site to site vpn customer gateway
Request parameters
Parameter Name | Description | Required |
id | id of customer gateway | true |
cidrlist | guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,). | true |
esppolicy | ESP policy of the customer gateway | true |
gateway | public ip address id of the customer gateway | true |
ikepolicy | IKE policy of the customer gateway | true |
ipsecpsk | IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes. | true |
account | the account associated with the gateway. Must be used with the domainId parameter. | false |
domainid | the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain. | false |
dpd | If DPD is enabled for VPN connection | false |
esplifetime | Lifetime of phase 2 VPN connection to the customer gateway, in seconds | false |
forceencap | Force encapsulation for Nat Traversal | false |
ikelifetime | Lifetime of phase 1 VPN connection to the customer gateway, in seconds | false |
ikeversion | Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike | false |
name | name of this customer gateway | false |
splitconnections | For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. | false |
Response Tags
Response Name | Description |
id | the vpn gateway ID |
account | the owner |
cidrlist | guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). |
domain | the domain name of the owner |
domainid | the domain id of the owner |
domainpath | the domain path of the owner |
dpd | if DPD is enabled for customer gateway |
esplifetime | Lifetime of ESP SA of customer gateway |
esppolicy | IPsec policy of customer gateway |
forceencap | if Force NAT Encapsulation is enabled for customer gateway |
gateway | public ip address id of the customer gateway |
ikelifetime | Lifetime of IKE SA of customer gateway |
ikepolicy | IKE policy of customer gateway |
ikeversion | Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike |
ipaddress | guest ip of the customer gateway |
ipsecpsk | IPsec preshared-key of customer gateway |
name | name of the customer gateway |
project | the project name |
projectid | the project id |
removed | the date and time the host was removed |
splitconnections | For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements. |