NetconfSession

Represents session between gateway and Netconf Manager, This can only be created by netconfmgr user

Overview

associatedGatewayID string creation only   filterable  
associatedGatewayName string read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
status enum (CONNECTED | DISCONNECTED) filterable  

API Resource

/netconfsessions/id
delete get put

Parents

/netconfmanagers/id/netconfsessions
get post

Children

/netconfsessions/id/metadatas
get post
/netconfsessions/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedGatewayID string creation only   filterable  
Discussion

UUID of the gateway associated to this Netconf session.

Charateristics

Format: free
SDK attribute: associatedGatewayID

associatedGatewayName string read only   autogenerated  
Discussion

Name of the gateway associated to this Netconf session.

Charateristics

Format: free
SDK attribute: associatedGatewayName

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

status enum filterable  
Discussion

The status of the NetConf session to a gateway.

Charateristics

Allowed values: CONNECTED, DISCONNECTED
SDK attribute: status