GNMISession

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

Overview

associatedGatewayID string creation only   filterable  
associatedGatewayName string read only   autogenerated  
creationDate string read only   autogenerated   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayModel string read only  
gatewayVendor enum (CISCO | NOKIA) read only  
gatewayVersion string read only   autogenerated  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
owner string autogenerated  
status enum (CONNECTED | DISCONNECTED) filterable  
subscriptionError string read only   filterable   orderable  
subscriptionFailureReason string read only   filterable   orderable  
subscriptionFailureRetryCount integer read only   filterable   orderable  
subscriptionState enum (COMPLETED | FAILED | IN_PROGRESS | INIT) read only   filterable  

API Resource

/gnmisessions/id
delete get put

Parents

/netconfmanagers/id/gnmisessions
get post

Children

/gnmisessions/id/metadatas
get post
/gnmisessions/id/alarms
get
/gnmisessions/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 GNMI session.

Charateristics

Format: free
SDK attribute: associatedGatewayID

associatedGatewayName string read only   autogenerated  
Discussion

Name of the gateway associated to this GNMI session.

Charateristics

Format: free
SDK attribute: associatedGatewayName

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

gatewayModel string read only  
Discussion

The model string of the gateway to which this session connected from Config Manager

Charateristics

Format: free
SDK attribute: gatewayModel

gatewayVendor enum read only  
Discussion

Vendor of the gateway to which this session connected from Config Manager

Charateristics

Allowed values: CISCO, NOKIA
SDK attribute: gatewayVendor

gatewayVersion string read only   autogenerated  
Discussion

Boot image version of gateway to which this session connected from Config Manager

Charateristics

Format: free
SDK attribute: gatewayVersion

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

status enum filterable  
Discussion

The status of the GNMI session to a gateway.

Charateristics

Allowed values: CONNECTED, DISCONNECTED
SDK attribute: status

subscriptionError string read only   filterable   orderable  
Discussion

Last subscription error reported

Charateristics

Format: free
Max length: 255
SDK attribute: subscriptionError

subscriptionFailureReason string read only   filterable   orderable  
Discussion

Detailed subscription error message

Charateristics

Format: free
Max length: 255
SDK attribute: subscriptionFailureReason

subscriptionFailureRetryCount integer read only   filterable   orderable  
Discussion

Number of times subscription has been attempted since first failure

Charateristics

Max value: 2147483647
SDK attribute: subscriptionFailureRetryCount

subscriptionState enum read only   filterable  
Discussion

Status of gnmi subscriptions to device from Netconf Manager

Charateristics

Allowed values: COMPLETED, FAILED, IN_PROGRESS, INIT
SDK attribute: subscriptionState