GNMIProfile

Represents configuration to access device using gNMI protocol

Overview

assocEntityType string read only  
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  
keyAlias string filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
owner string autogenerated  
password string required  
port integer filterable   orderable  
userName string required   filterable   orderable  

API Resource

/gnmiprofiles/id
delete get put

Parents

/enterprises/id/gnmiprofiles
get post
/gnmiprofiles
get post

Children

/gnmiprofiles/id/metadatas
get post
/gnmiprofiles/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

assocEntityType string read only  
Discussion

Type of the entity to which the Profile belongs to.


Charateristics

Format: free
SDK attribute: assocEntityType

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.


Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

A detailed description of the GNMI Profile entity.


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

keyAlias string filterable   orderable  
Discussion

Key alias name in keystore to connect device using TLS


Charateristics

Format: free
Max length: 128
SDK attribute: keyAlias

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   filterable   orderable  
Discussion

Name of the GNMI Profile entity.


Charateristics

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.


Charateristics

Format: free
SDK attribute: owner

password string required  
Discussion

The password used to establish GNMI sessions with the gateway instances using this GNMI Profile.


Charateristics

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

port integer filterable   orderable  
Discussion

GNMI session port


Charateristics

Default value: 57400
Min value: 1
Max value: 65535
SDK attribute: port

userName string required   filterable   orderable  
Discussion

The user name used to establish GNMI sessions with the gateway instances using this GNMI Profile.


Charateristics

Format: free
Max length: 255
SDK attribute: userName