NSGRoutingPolicyBinding

The NSG routing policy binding is used to assign routing policies to an NSG or group of NSGs as defined by the routing policy group. The local routing policies assigned to an NSG in a policy binding are preferred over global routing policies defined at the OSPF instance level.

Overview

associatedExportRoutingPolicyID string filterable  
associatedImportRoutingPolicyID string filterable  
associatedPolicyObjectGroupID string required   filterable   orderable  
description string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
exportToOverlay enum (DISABLED | ENABLED | INHERITED)
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable   locally unique  

API Resource

/nsgroutingpolicybindings/id
delete get put

Parents

/domains/id/nsgroutingpolicybindings
get post
/aggregateddomains/id/nsgroutingpolicybindings
get post

Children

/nsgroutingpolicybindings/id/metadatas
get post
/nsgroutingpolicybindings/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedExportRoutingPolicyID string filterable  
Discussion

ID of the Export Routing Policy which is associated to the current NSGRoutingPolicyBinding object.

Charateristics

Format: free
SDK attribute: associatedExportRoutingPolicyID

associatedImportRoutingPolicyID string filterable  
Discussion

ID of the Import Routing Policy which is associated to the current NSGRoutingPolicyBinding object.

Charateristics

Format: free
SDK attribute: associatedImportRoutingPolicyID

associatedPolicyObjectGroupID string required   filterable   orderable  
Discussion

ID of the Policy Object Group which is associated to the current NSGRoutingPolicyBinding object.

Charateristics

Format: free
SDK attribute: associatedPolicyObjectGroupID

description string
Discussion

Description for this Routing Policy Binding Object.

Charateristics

Format: free
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

exportToOverlay enum
Discussion

Flag to determine whether the BGP and OSPF learnt routes will be exported to VSC or not. This flags also exists at the domain level. If this attribute is set to 'INHERITED' (the default), the behavior is whatever is set at the domain level. Otherwise, this attribute takes precedence over the domain level one.

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: exportToOverlay

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   locally unique  
Discussion

Name of the RoutingPolicyBinding is unique within the Domain

Charateristics

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