BGPPeer

Encapsulates the BGP peer information for system monitor entity.

Overview

address string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastStateChange integer
status enum (ADMIN_DOWN | DOWN | UP)

API Resource

/bgppeers/id

Parents

/hscs/id/bgppeers
get
/vscs/id/bgppeers
get

Children

/bgppeers/id/permissions
delete get post put
/bgppeers/id/metadatas
get post
/bgppeers/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

address string filterable   orderable  
Discussion

IP of the BGP peer.

Charateristics

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

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

lastStateChange integer
Discussion

Last state change timestamp.

Charateristics

SDK attribute: lastStateChange

status enum
Discussion

Current connection status of the BGP peer.

Charateristics

Allowed values: ADMIN_DOWN, DOWN, UP
SDK attribute: status