VPNConnection

Attaching this object to a WAN Service allows to extend its connectivity to and from external resources defined on your Data Center Edge Gateway.

Overview

associatedWANServiceID string
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  

API Resource

/vpnconnections/id
delete get put

Parents

/sharednetworkresources/id/vpnconnections
get post
/domains/id/vpnconnections
get post
/l2domains/id/vpnconnections
get post
/aggregateddomains/id/vpnconnections
get post

Children

/vpnconnections/id/metadatas
get post
/vpnconnections/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedWANServiceID string
Discussion

Assosciated WAN Service

Charateristics

Format: free
SDK attribute: associatedWANServiceID

description string filterable   orderable  
Discussion

A description of the VPNConnect

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the VPNConnect

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name