Apache CloudStack v4.5.0 Root Admin API Reference


Creates a l2tp/ipsec remote access vpn

Request parameters

Parameter NameDescriptionRequired
publicipidpublic ip address id of the vpn servertrue
accountan optional account for the VPN. Must be used with domainId.false
domainidan optional domainId for the VPN. If the account parameter is used, domainId must also be used.false
fordisplayan optional field, whether to the display the vpn to the end user or notfalse
iprangethe range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn serverfalse
openfirewallif true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by defaultfalse

Response Tags

Response NameDescription
idthe id of the remote access vpn
accountthe account of the remote access vpn
domainthe domain name of the account of the remote access vpn
domainidthe domain id of the account of the remote access vpn
fordisplayis vpn for display to the regular user
iprangethe range of ips to allocate to the clients
presharedkeythe ipsec preshared key
projectthe project name of the vpn
projectidthe project id of the vpn
publicipthe public ip address of the vpn server
publicipidthe public ip address of the vpn server
statethe state of the rule