BRConnection

Configuration of VNS Gateway Border Router connection

Overview

address string
addressFamily enum (IPV4 | IPV6)
addressV6 string
advertisementCriteria enum (BFD | OPERATIONAL_LINK) filterable   orderable  
DNSAddress string
DNSAddressV6 string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gateway string
gatewayV6 string
inherited boolean read only  
lastUpdatedBy string autogenerated  
mode enum (Static) filterable   orderable  
netmask string
uplinkID integer read only   autogenerated   filterable  

API Resource

/brconnections/id
delete get put

Parents

/vlans/id/brconnections
get post
/vlantemplates/id/brconnections
get post

Children

/brconnections/id/metadatas
get post
/brconnections/id/bfdsessions
get post put
/brconnections/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

address string
Discussion

Static IP address for the VLAN on which the BR Connection is created.


Charateristics

Format: free
Max length: 255
SDK attribute: address

addressFamily enum
Discussion

IP address family of this BRConnection


Charateristics

Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: addressFamily

addressV6 string
Discussion

IPv6 address for static configuration on the BR Connection instance.


Charateristics

Format: ipv6
Max length: 255
SDK attribute: addressV6

advertisementCriteria enum filterable   orderable  
Discussion

Advertisement Criteria for Traffic Flow on a BR Connection.


Charateristics

Allowed values: BFD, OPERATIONAL_LINK
Default value: OPERATIONAL_LINK
SDK attribute: advertisementCriteria

DNSAddress string
Discussion

DNS Address for the vlan


Charateristics

Format: free
Max length: 255
SDK attribute: DNSAddress

DNSAddressV6 string
Discussion

DNS IPv6 Address


Charateristics

Format: ipv6
Max length: 255
SDK attribute: DNSAddressV6

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

gateway string
Discussion

IP address of the gateway bound to the VLAN.


Charateristics

Format: free
Max length: 255
SDK attribute: gateway

gatewayV6 string
Discussion

IPv6 address of the gateway bound to the port.


Charateristics

Format: ipv6
Max length: 255
SDK attribute: gatewayV6

inherited boolean read only  
Discussion

This flag will determine if the abstract connection is inherited from the instance template


Charateristics

Default value: false
SDK attribute: inherited

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

mode enum filterable   orderable  
Discussion

Connection mode: Only static is allowed on a Bridge Router Connection.


Charateristics

Allowed values: Static
SDK attribute: mode

netmask string
Discussion

network mask


Charateristics

Format: free
Max length: 255
SDK attribute: netmask

uplinkID integer read only   autogenerated   filterable  
Discussion

Internally generated ID in the range that idenitifies the uplink within the context of NSG.


Charateristics

Min value: 1
Max value: 65535
SDK attribute: uplinkID