NetconfGlobalConfiguration

This Entity defines Global Configurations such as Prefix-list, Mac-list etc., to be configured on a Third-party Gateway (Netconf - VTEP).

Overview

configDefinition string required  
creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   creation only   filterable   orderable  
netconfGatewayIDs list orderable  
owner string autogenerated  

API Resource

/netconfglobalconfigurations/id
delete get put

Parents

/netconfglobalconfigurations
get post

Children

/netconfglobalconfigurations/id/deploymentfailures
get
/netconfglobalconfigurations/id/permissions
delete get post put
/netconfglobalconfigurations/id/metadatas
get post
/netconfglobalconfigurations/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

configDefinition string required  
Discussion

Global configurations like prefix lists, community, mac-list etc.. to be configured on a Netconf Gateway.

Charateristics

Format: free
SDK attribute: configDefinition

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

A description of the GlobalConfiguration.

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   creation only   filterable   orderable  
Discussion

The unique name of the Global Configuration.

Charateristics

Allowed characters: regex:\w+[\w -]*
Format: free
Max length: 255
SDK attribute: name

netconfGatewayIDs list orderable  
Discussion

List of third-party Netconf Gateways on which Global Configuration will be deployed.

Charateristics

SDK attribute: netconfGatewayIDs

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner