gNMI is built on top of Google Remote Procedure Call (gRPC). gRPC is an open source high performance RPC framework released in 2016. It uses HTTP/2 for transport, protocol buffers for the interface description language, and includes the following features:
+gRPC can generate cross-platform client and server bindings for many languages. It also supports TLS and token-based authentication. gRPC uses protocol buffers to encode data.
+gRPC Network Management Interface (gNMI) is a specification of RPCs for managing or collecting the state of a device. The content provided through gNMI can be modeled using YANG. gRPC carries gNMI and provides the ability to create and transmit requests.
+gNMI can be transmitted in two ways:
+NX-OS supports the following gNMI RPCs:
+gNMI subscription can be used with both dial-in or dial-out methods.
+Starting in NX-OS 9.3.1, Nexus switches support the following subscription features:
+gNMI relies on gRPC. A combination of gRPC and gNMI settings are required to configure this functionality on NX-OS.
+Enable the gRPC agent. +
switch# feature grpc
+Configure the port number used for gRPC. +
switch# grpc port 50051
+Note
+Ports can be from 1024 to 65535. Default is 50051.
+Specify the certificate trustpoint ID used for gRPC. +
switch# grpc certificate TRUSTPOINT
+Note
+TRUSTPOINT is the name of your trustpoint ID. For more information, see Installing Identity Certificates
+Set the limit of simultaneous dial-in calls to the gNMI server on the device. +
switch# grpc gnmi max-concurrent-calls 8
+Note
+Allow the gRPC agent to accept requests on specified VRFs. +
switch# grpc use-vrf default
+Note
+By default, the management VRF accepts incoming requests when the gRPC feature is enabled.
+At this point, your device is ready to use the Cisco native YANG model with gNMI. +If you'd like to use the OpenConfig model instead, it will need to be enabled with the following command: +
switch# feature openconfig
+As per gnmi specification:
+3.1 Session Security, Authentication and RPC Authorization
+The session between the client and server MUST be encrypted using TLS - and a target or client MUST NOT fall back to unencrypted sessions.
+NX-OS only supports TLS connection on gRPC, mTLS is supported since NX-OS 10.1(1). There are two certificates required in this process:
+To create any type of certificate, a certificate authority (CA) is required. If you don't have one (or you are looking for something that is free), follow the steps in this guide by Jamie Nguyen: OpenSSL Certificate Authority
+Accurate time is important when dealing with TLS certificates. It is recommended to setup NTP on the client and servers/devices. If you see errors related to the certificate not being valid yet or expired, it is probably due to the client or server having the incorrect time set.
+For simplicity, this tutorial uses root but other users with less privileges can be used.
+Make sure your keys and certificates are protected.
+Tests for this tutorial are done using gNMIc and pygNMI
+A server certificate will allow you to connect to an NX-OS device securely, without the need to skip TLS verification for TLS connections.
+Note
+It is assumed that you have a valid root and intermediate CA certificates installed in your workstation. Instructions can be found at the top of this article on how to set that up.
+gRPC does not use the CN attribute of the certificate to verify hostname. Add the subjectAltName=${ENV::SAN} option to the /root/ca/intermediate/openssl.cnf file. This will be added in the [ server_cert ] section.
server_cert example:
+[ server_cert ]
+# Extensions for server certificates (`man x509v3_config`).
+basicConstraints = CA:FALSE
+subjectAltName=${ENV::SAN}
+nsCertType = server
+nsComment = "OpenSSL Generated Server Certificate"
+subjectKeyIdentifier = hash
+authorityKeyIdentifier = keyid,issuer:always
+keyUsage = critical, digitalSignature, keyEncipherment
+extendedKeyUsage = serverAuth
+The value ${ENV::SAN} instructs openssl to look for the value of the subjectAltName in an environmental variable called SAN
If you don't have a DNS available, you can manually add the host entry in the /etc/hosts file if you would like to use names instead of IPs. Either one works.
+In this example, the device name is nx93000v-01.cisco.com and its management IP is 192.168.1.1.
+export SAN=DNS:nx9300v-01,DNS:nx9300v-01.cisco.com,IP:192.168.1.1
+Although the file name is trivial, it is a best practice to use the hostname of the device or other identifier that summarizes the purpose of the certificate.
+Note
+The following commands are intended to be run from /root/ca
+You can use the same certificate for multiple devices. Make sure to use server_cert extensions.
openssl genrsa -out intermediate/private/nx9300v-01.cisco.com.key.pem
+openssl req -config intermediate/openssl.cnf -key intermediate/private/nx9300v-01.cisco.com.key.pem -new -sha256 -out intermediate/csr/nx9300v-01.cisco.com.csr.pem
+(...)
+-----
+Country Name (2 letter code) [GB]:US
+State or Province Name [England]:CO
+Locality Name []:
+Organization Name [Alice Ltd]:Nexus
+Organizational Unit Name []:Datacenter
+Common Name []:nx9300v-01.cisco.com
+Email Address []:
+openssl ca -config intermediate/openssl.cnf -extensions server_cert -days 375 -notext -md sha256 -in intermediate/csr/nx9300v-01.cisco.com.csr.pem -out intermediate/certs/nx9300v-01.cisco.com.cert.pem
+Check that the alternative name section is present and has the values set in the previous step
+openssl x509 -noout -text -in intermediate/certs/nx9300v-01.cisco.com.cert.pem
+X509v3 Subject Alternative Name:
+DNS:nx9300v-01, IP Address:192.168.1.1
+cat intermediate/certs/nx9300v-01.cisco.com.cert.pem > intermediate/certs/nx9300v-01.cisco.com.chain.cert.pem
+cat intermediate/certs/intermediate.cert.pem >> intermediate/certs/nx9300v-01.cisco.com.chain.cert.pem
+cat certs/ca.cert.pem >> intermediate/certs/nx9300v-01.cisco.com.chain.cert.pem
+Note
+Make sure to export the password. Also, your NX-OS device will need the scp-server feature enabled to accept the SCP transfer.
openssl pkcs12 -export -out intermediate/certs/nx9300v-01.cisco.com.pfk -inkey intermediate/private/nx9300v-01.cisco.com.key.pem -in intermediate/certs/nx9300v-01.cisco.com.chain.cert.pem
+scp intermediate/certs/nx9300v-01.cisco.com.pfk admin@192.168.1.1:
+Execute the following commands on the device. For this example, "supersecret" was used as the password.
+nx9300v_01# configure
+nx9300v_01(config)# crypto ca trustpoint server
+nx9300v_01(config)# crypto ca import server pkcs12 bootflash:nx9300v-01.cisco.com.pfk supersecret
+Configure grpc to use the truspoint above: +
nx9300v_01(config)# grpc certificate server
+Use the certificate chain file, not the standalone certificate file. The --skip-verify option should not be needed
gnmic -a nx9300v-01.cisco.com:50051 -u admin -p YOURPASSWORD get --path /System/name --tls-cert intermediate/certs/nx9300v-01.cisco.com.chain.cert.pem --tls-key intermediate/private/nx9300v-01.cisco.com.key.pem -e json --tls-ca intermediate/certs/ca-chain.cert.pem
+[
+ {
+ "source": "nx9300v-01.cisco.com:50051",
+ "timestamp": 1657660857691587822,
+ "time": "2022-07-12T21:20:57.691587822Z",
+ "updates": [
+ {
+ "Path": "System/name",
+ "values": {
+ "System/name": "nx9300v-01"
+ }
+ }
+ ]
+ }
+]
+Note
+For simplicity, this example includes credentials in clear text, which is not a best practice.
+# Modules
+from pygnmi.client import gNMIclient
+import json
+# Variables
+host = ('nx9300v-01.cisco.com', '50051')
+paths = ['/System/name']
+
+# Body
+if __name__ == '__main__':
+ with gNMIclient(target=host, username='admin', password="YOURPASSWORD", path_cert="./ca/intermediate/certs/nx9300v-01.cisco.com.chain.cert.pem",
+ path_key="./ca/intermediate/private/nx9300v-01.cisco.com.key.pem", path_root="./ca/intermediate/certs/ca-chain.cert.pem") as gc:
+ result = gc.get(path=paths, encoding='json')
+ print(result)
+# python get-nx.py
+{'notification': [{'timestamp': 1657660901108756130, 'update': [{'path': 'System/name', 'val': 'nx9300v-01'}]}]}
+If you prefer to use a certificate and key instead of a password, you can create a client certificate that can be used to authenticate against the NX-OS device. +It is assumed that you have a valid root and intermediate CA certificates installed in your workstation. Instructions can be found at the top of this article on how to set that up.
+Although the file name is trivial, it is a best practice to use the username or other identifier that sumarizes the purpose of the certificate, csr and keys.
+Note
+Generate private key: +
openssl genrsa -out intermediate/private/admin.key.pem 2048
+Create CSR:
+openssl req -config intermediate/openssl.cnf -key intermediate/private/admin.key.pem -new -sha256 -out intermediate/csr/admin.csr.pem
+-----
+Country Name (2 letter code) [GB]:US
+State or Province Name [England]:CO
+Locality Name []:
+Organization Name [Alice Ltd]:Nexus
+Organizational Unit Name []:admin
+Common Name []:admin
+Email Address []:
+Sign the certificate: +
openssl ca -config intermediate/openssl.cnf -extensions usr_cert -days 375 -notext -md sha256 -in intermediate/csr/admin.csr.pem -out intermediate/certs/admin.cert.pem
+cat intermediate/certs/admin.cert.pem > intermediate/certs/admin.chain.cert.pem
+cat intermediate/certs/intermediate.cert.pem >> intermediate/certs/admin.chain.cert.pem
+cat certs/ca.cert.pem >> intermediate/certs/admin.chain.cert.pem
+For this example, gnmi-root is used as trustpoint name but it can have any name. Use the content of the root certificate only (certs/ca.cert.pem) - no chains or intermediate certs are required, when client authenticates with nxos using certificate, it needs to provide the chain of certificates(root certificate can be ommited).
+Execute the following commands on the device:
+nx9300v_01# configure
+nx9300v_01(config)# crypto ca trustpoint gnmi-root
+nx9300v_01(config)# crypto ca authenticate gnmi-root
+input (cut & paste) CA certificate (chain) in PEM format;
+end the input with a line containing only END OF INPUT :
+-----BEGIN CERTIFICATE-----
+(...)
+-----END CERTIFICATE-----
+END OF INPUT
+(...)
+
+Do you accept this certificate? [yes/no]:yes
+Configure the grpc client root certificate: +
nx9300v_01(config)# grpc client root certificate gnmi-root
+You might need to change the tls files path to match your environment +Password is not required anymore
+# cat .gnmic.yaml
+log-file: /tmp/gnmic.log
+debug: true
+tls-ca: ./intermediate/certs/ca-chain.cert.pem
+targets:
+ 192.168.1.2:50051:
+ username: admin
+ tls-cert: ./intermediate/certs/admin.chain.cert.pem
+ tls-key: ./intermediate/private/admin.key.pem
+# gnmic get --path /System/name
+[
+ {
+ "source": "192.168.1.2:50051",
+ "timestamp": 1663693091279809206,
+ "time": "2022-09-20T12:58:11.279809206-04:00",
+ "updates": [
+ {
+ "Path": "System/name",
+ "values": {
+ "System/name": "nx9300v_01"
+ }
+ }
+ ]
+ }
+]
+gNMIc is a free gNMI client that provides full support for get, set, capabilities, and subscribe RPCs. +It has many features and supports multiple deployment methods. More information can be found on the gNMIc homepage.
+gNMIc can be deployed on the following platforms:
+Instructions for each platform can be found on the gNMIc installation page.
+ + + + + + + + + + + + + +| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Admin state | ++ | /System/arp-items/inst-items/adminSt | +
| Operational state | ++ | /System/arp-items/operSt | +
| Allow ARP outside subnet | ++ | /System/arp-items/inst-items/allowStaticArpOutsideSubnet | +
| Cache limit | ++ | /System/arp-items/inst-items/cacheLimit | +
| Proxy ARP state | +/interfaces/interface/subinterfaces/subinterface/ipv4/proxy-arp/config/mode | ++ |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| + | + | + |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| ACL TCAM | ++ | /System/pltfm-items/mod-items/TcamStatsModule-list/inst-items/TcamStatsInst-list | +
| FIB TCAM | ++ | /System/capacity-items/fibresutil-items | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| All CDP info | ++ | /System/cdp-items/inst-items | +
| CDP status | ++ | /System/cdp-items/inst-items/adminSt | +
| Holdtime | ++ | /System/cdp-items/inst-items/holdIntvl | +
| Interface admin state | ++ | /System/cdp-items/inst-items/if-items/If-list/adminSt | +
| Interface ID | ++ | /System/cdp-items/inst-items/if-items/If-list/id | +
| Interface VLAN | ++ | /System/cdp-items/inst-items/if-items/If-list/nativeVlan | +
| Interface status | ++ | /System/cdp-items/inst-items/if-items/If-list/operSt | +
| Port local MAC | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/localMAC | +
| Port MTU | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/mtu | +
| Neighbor capabilities | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/cap | +
| Remote platform type | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/platId | +
| Remote interface | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/portId | +
| Remote MAC | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/remoteMAC | +
| Remote IP | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/intf-items/IntfAddr-list/addr | +
| Remote management IP | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/mgmt-items/MgmtAddr-list/addr | +
| Remote device name | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/sysName | +
| Remote device version | ++ | /System/cdp-items/inst-items/if-items/If-list/adj-items/AdjEp-list/ver | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Admin state | ++ | /System/copp-items/adminSt | +
| Operational state | ++ | /System/copp-items/operSt | +
| Class rate limiter state | ++ | /System/copp-items/enableFlag | +
| Error code | ++ | /System/copp-items/error | +
| Profile | ++ | /System/copp-items/profile-items/prof | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Listening port | ++ | /System/grpc-items/port | +
| Keepalive timeout | ++ | /System/grpc-items/gnmi-items/keepAliveTimeout | +
| Max calls allowed | ++ | /System/grpc-items/gnmi-items/maxCalls | +
| Minimum sample interval (seconds) | ++ | /System/grpc-items/gnmi-items/minSampleInterval | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Admin status | +/interfaces/interface/state/admin-status | +/System/intf-items/phys-items/PhysIf-list/adminSt | +
| Operational status | +/interfaces/interface/state/oper-status | ++ |
| Interface descriptions | +/interfaces/interface/state/description | ++ |
| Interface names | +/interfaces/interface/state/name | ++ |
| Default layer | ++ | /System/ethpm-items/inst-items/systemDefaultLayer | +
| Default admin state | ++ | /System/ethpm-items/inst-items/systemDefaultAdminSt | +
| System jumbo MTU size (bytes) | ++ | /System/ethpm-items/inst-items/systemJumboMtu | +
| FEC Mode | ++ | /System/intf-items/phys-items/PhysIf-list/FECMode | +
| Access VLAN | +/interfaces/interface/ethernet/switched-vlan/state/access-vlan/ | +/System/intf-items/phys-items/PhysIf-list/accessVlan | +
| Bundle port number | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/bdlPortNum | +
| Port channel state | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/channelingSt | +
| Member port flags | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/flags | +
| LTL programmed | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/ltlProgrammed | +
| Aggregation operational state | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/operSt | +
| Summarized operational state | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/summOperSt | +
| Aggregation member uptime | ++ | /System/intf-items/phys-items/PhysIf-list/aggrmbrif-items/uptime | +
| Auto negotiation status | ++ | /System/intf-items/phys-items/PhysIf-list/autoNeg | +
| Beacon status | ++ | /System/intf-items/phys-items/PhysIf-list/beacon | +
| Bandwidth parameter | ++ | /System/intf-items/phys-items/PhysIf-list/bw | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Interface counters | +/interfaces/interface/state/counters | +/System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items | +
| Ingress octet rate (300 second avg) | ++ | /System/intf-items/phys-items/PhysIf-list/dbgIfIn-items/octetRate | +
| Egress octet rate (300 second avg) | ++ | /System/intf-items/phys-items/PhysIf-list/dbgIfOut-items/octetRate | +
| Ingress packets discarded | +/interfaces/interface/state/counters/in-discards | ++ |
| Egress packets discarded | +/interfaces/interface/state/counters/out-discards | ++ |
| Ingress broadcast packets | +/interfaces/interface/state/counters/in-broadcast-pkts | ++ |
| Ingress multicast packets | +/interfaces/interface/state/counters/in-multicast-pkts | ++ |
| Ingress unicast packets | +/interfaces/interface/state/counters/in-unicast-pkts | ++ |
| Egress broadcast packets | +/interfaces/interface/state/counters/out-broadcast-pkts | ++ |
| Egress multicast packets | +/interfaces/interface/state/counters/out-multicast-pkts | ++ |
| Egress unicast packets | +/interfaces/interface/state/counters/out-unicast-pkts | ++ |
| Ingress errors | +/interfaces/interface/state/counters/in-errors | ++ |
| Interface status | +/interfaces/interface/state/oper-status | ++ |
| Egress errors | +/interfaces/interface/state/counters/out-errors | ++ |
| Alignment errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/alignmentErrors | +
| Babble count | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/babble | +
| Carrier sense errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/carrierSenseErrors | +
| Control input unknown OP codes | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/controlInUnknownOpcodes | +
| Deferred transmissions | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/deferredTransmissions | +
| Excessive collisions | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/excessiveCollisions | +
| FCS errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/fCSErrors | +
| Frame too long count | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/frameTooLongs | +
| Input pause frames | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/inPauseFrames | +
| Internal MAC receive errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/internalMacReceiveErrors | +
| Internal MAC transmit errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/internalMacTransmitErrors | +
| Late collisions count | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/lateCollisions | +
| Lost carrier errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/lostCarrierErrors | +
| Multiple collision frames | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/multipleCollisionFrames | +
| No carrier errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/noCarrierErrors | +
| Output pause frames | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/outPauseFrames | +
| Runts | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/runts | +
| Single collision frames | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/singleCollisionFrames | +
| Symbol errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgDot3Stats-items/symbolErrors | +
| Total Broadcast packets | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/broadcastPkts | +
| Total CRC align errors | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/cRCAlignErrors | +
| Total collisions | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/collisions | +
| Total drop events | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/dropEvents | +
| Total egress bytes | +/interfaces/interface/state/counters/out-octets | +/System/intf-items/phys-items/PhysIf-list/dbgIfOut-items/octets | +
| Total fragments | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/fragments | +
| Interface down drop | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/ifdowndrop | +
| Total ignored | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/ignored | +
| Total ingress bytes | +/interfaces/interface/state/counters/in-octets | +/System/intf-items/phys-items/PhysIf-list/dbgIfIn-items/octets | +
| Total jabbers | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/jabbers | +
| Total multicast packets | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/multicastPkts | +
| Total octets | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/octets | +
| Total Overrun | ++ | /System/intf-items/phys-items/PhysIf-list/dbgEtherStats-items/overrun | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Transceiver Sensor(list) | +N/A |
+System/intf-items/phys-items/PhysIf-list/phys-items/fcot-items/lane-items |
+
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| + | + | + |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| + | + | + |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| All LLDP information | +/lldp/interfaces/interface | ++ |
| LLDP neighbor ID type | +/lldp/interfaces/interface/neighbors/neighbor/state/chassis-id-type | ++ |
| LLDP chassis ID | +/lldp/interfaces/interface/neighbors/neighbor/state/chassis-id | ++ |
| Port ID type | +/lldp/interfaces/interface/neighbors/neighbor/state/port-id-type | ++ |
| Neighbor port ID | +/lldp/interfaces/interface/neighbors/neighbor/state/port-id | ++ |
| State status and type | +/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/state | ++ |
| State status | +/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/state/enabled | ++ |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| + | + | + |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Hostname | ++ | /System/name | +
| System Serial number | ++ | /System/serial | +
| System copyright | ++ | /System/showversion-items/copyRight | +
| BIOS version | ++ | /System/showversion-items/biosVersion | +
| BIOS date | ++ | /System/showversion-items/biosCompileTime | +
| NX-OS version | ++ | /System/showversion-items/nxosVersion | +
| NX-OS date | ++ | /System/showversion-items/nxosCompileTime | +
| NX-OS image filename | ++ | /System/showversion-items/nxosImageFile | +
| Kernel uptime | ++ | /System/showversion-items/kernelUptime | +
| Last reset reason | ++ | /System/showversion-items/lastResetReason | +
| Last reset OS version | ++ | /System/showversion-items/lastResetSysVersion | +
| Last reset time | ++ | /System/showversion-items/lastResetTime | +
| System alarms | +/system/alarms | +/System/alarms-items/alarm-items/Alarm-list | +
| Running config != startup config | ++ | /System/configDirty | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Auto copy status | ++ | /System/boot-items/autoCopy | +
| Exclude configuration status | ++ | /System/boot-items/excludeCfg | +
| Boot success status | ++ | /System/boot-items/image-items/image_err | +
| Image verification | ++ | /System/boot-items/image-items/imageverification | +
| Supervisor 1 image | ++ | /System/boot-items/image-items/sup1 | +
| Supervisor 2 image | ++ | /System/boot-items/image-items/sup2 | +
| Supervisor 1 reload image | ++ | /System/boot-items/image-items/sup1NextReload | +
| Supervisor 2 reload image | ++ | /System/boot-items/image-items/sup2NextReload | +
| POAP state | ++ | /System/boot-items/poap | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| PSU slot ID number | ++ | /System/ch-items/psuslot-items/PsuSlot-list/id | +
| PSU slot physical ID number | ++ | /System/ch-items/psuslot-items/PsuSlot-list/physId | +
| PSU ID number | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/id | +
| Serial | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/ser | +
| PSU slot description | ++ | /System/ch-items/psuslot-items/PsuSlot-list/descr | +
| PSU description | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/descr | +
| Slot type | ++ | /System/ch-items/psuslot-items/PsuSlot-list/type | +
| Presence | ++ | /System/ch-items/psuslot-items/PsuSlot-list/operSt | +
| Location | ++ | /System/ch-items/psuslot-items/PsuSlot-list/loc | +
| State | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/operSt | +
| Vendor | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/vendor | +
| Model | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/model | +
| Revision | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/rev | +
| Software alarm state | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/softwareAlarm | +
| Hardware alarm state | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/hardwareAlarm | +
| Power cord presence | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/typeCordConnected | +
| Amps input (actual) | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/inputCurr | +
| Amps input | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/iIn | +
| Amps output (actual) | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/drawnCurr | +
| Amps output | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/iOut | +
| Volts source | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/vSrc | +
| Volts input | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/vIn | +
| Volts output | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/vOut | +
| Volts PSU | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/volt | +
| VDR ID | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/vdrId | +
| Watts input | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/pIn | +
| Watts output | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/pOut | +
| Fan state | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/fanOpSt | +
| Fan direction | ++ | /System/ch-items/psuslot-items/PsuSlot-list/psu-items/fanDirection | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Drive ID | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/id | +
| Description | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/descr | +
| Drive type | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/type | +
| Vendor | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/vendor | +
| Model | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/model | +
| Revision | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/rev | +
| Serial | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/ser | +
| Access type | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/acc | +
| Lifetime percent used | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/lifetime | +
| Manufacturing time | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/mfgTm | +
| Drive status | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/operSt | +
| Minor alarm count | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/minorAlarm | +
| Major alarm count | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/majorAlarm | +
| Terabytes written | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/tbw | +
| Bad blocks | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/gbb | +
| Drive warning count | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/warning | +
| Read error rate | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/readErrorRate | +
| P/E Cycles | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/flash-items/peCycle | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Fan module ID | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fanId | +
| Fan ID within module | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fan_params-items/FanParams-list/trayInst | +
| Description | ++ | /System/ch-items/ftslot-items/FtSlot-list/ft-items/fan-items/Fan-list/descr | +
| Presence | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fanPresent | +
| Direction | ++ | /System/ch-items/ftslot-items/FtSlot-list/ft-items/fan-items/Fan-list/dir | +
| Status | ++ | /System/ch-items/ftslot-items/FtSlot-list/ft-items/fan-items/Fan-list/operSt | +
| Vendor | ++ | /System/ch-items/ftslot-items/FtSlot-list/ft-items/fan-items/Fan-list/vendor | +
| Model | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fanProdId | +
| RPM | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fan_params-items/FanParams-list/fanRpm | +
| Fan speed (percent) | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fan_params-items/FanParams-list/fanSpeed | +
| Max RPM | ++ | /System/pie-items/env-items/fan-items/fan_env_info-items/fan_env_record-items/FanEnvRecord-list/fan_params-items/FanParams-list/maxRpm | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Chassis description | ++ | /System/ch-items/descr | +
| All line cards | ++ | /System/ch-items/lcslot-items/LCSlot-list | +
| Line card ID | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/id | +
| Line card description | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/descr | +
| Line card model | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/model | +
| Line card serial number | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/ser | +
| Line card hardware version | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/hwVer | +
| Line card revision | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/rev | +
| Line card breakout factor | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/breakoutFactor | +
| Line card MAC | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/macB | +
| Line card MAC end | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/macE | +
| Line card number of ports | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/numP | +
| Line card operational state | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/operSt | +
| Line card part number | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/partNumber | +
| Line card power state | ++ | /System/ch-items/lcslot-items/LCSlot-list/lc-items/pwrSt | +
| Line card physical presence | ++ | /System/ch-items/lcslot-items/LCSlot-list/operSt | +
| Supervisor ID | ++ | /System/ch-items/supslot-items/SupCSlot-list/id | +
| Supervisor location | ++ | /System/ch-items/supslot-items/SupCSlot-list/loc | +
| Supervisor slot description | ++ | /System/ch-items/supslot-items/SupCSlot-list/descr | +
| Supervisor physical presence | ++ | /System/ch-items/supslot-items/SupCSlot-list/operSt | +
| Supervisor power status | ++ | /System/ch-items/supslot-items/SupCSlot-list/poweroff | +
| Supervisor CPU ID | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/id | +
| Supervisor CPU vendor | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/vendor | +
| Supervisor CPU model | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/model | +
| Supervisor CPU architecture | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/arch | +
| Supervisor CPU speed (GHz) | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/speed | +
| Supervisor CPU cores | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/cores | +
| Supervisor CPU cores enabled | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/coresEn | +
| Supervisor CPU threads | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/cpu-items/CPU-list/thrds | +
| Supervisor RAM DIMM ID | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/dimm-items/Dimm-list/id | +
| Supervisor RAM total | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/dimm-items/Dimm-list/cap | +
| Supervisor RAM used | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/dimm-items/Dimm-list/used | +
| Supervisor temp sensors | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list | +
| Supervisor temp sensor ID | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/id | +
| Supervisor temp sensor type | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/type | +
| Supervisor temp sensor major threshold | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/majorThresh | +
| Supervisor temp sensor minor threshold | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/minorThresh | +
| Supervisor temp sensor status | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/operSt | +
| Supervisor temp sensor current temp | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/tempValue | +
| Supervisor temp sensor temp unit | ++ | /System/ch-items/supslot-items/SupCSlot-list/sup-items/sensor-items/Sensor-list/unit | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| All QOS info | +/oc-qos:qos | +/System/ipqos-items | +
| Dynamic buffer share | ++ | /System/ipqos-items/dynamicBufferShare | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Input queue name | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:input/oc-qos:queues/oc-qos:queue/oc-qos:state/oc-qos:name | +/System/ipqos-items/queuing-items/policy-items/in-items/intf-items/If-list/queCmap-items/QueuingStats-list/cmapName | +
| Input queue dropped packets | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:input/oc-qos:queues/oc-qos:queue/oc-qos:state/oc-qos:dropped-pkts | +/System/ipqos-items/queuing-items/policy-items/in-items/intf-items/If-list/queCmap-items/QueuingStats-list/dropPackets | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Interface ID | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:interface-id | +Interface ID /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/name | +
| All stats | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:output/oc-qos:queues/oc-qos:queue/oc-qos:state | +/System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list | +
| Class map name | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:output/oc-qos:queues/oc-qos:queue/oc-qos:state/oc-qos:name | +/System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/cmapName | +
| Policy map name | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/pmapName | +
| Current queue depth (bytes) | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/currQueueDepth | +
| Dropped byte count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/dropBytes | +
| Dropped packets | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:output/oc-qos:queues/oc-qos:queue/oc-qos:state/oc-qos:dropped-pkts | +/System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/dropPackets | +
| Ingress queue depth | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ingQDepthBytes | +
| Ingress queue dropped packet count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ingQDropPackets | +
| Transmit octets | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:output/oc-qos:queues/oc-qos:queue/oc-qos:state/oc-qos:transmit-octets | ++ |
| Transmit packets | +/oc-qos:qos/oc-qos:interfaces/oc-qos:interface/oc-qos:output/oc-qos:queues/oc-qos:queue/oc-qos:state/oc-qos:transmit-pkts | +/System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/txPackets | +
| Multicast queue depth | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/mcCurrQueueDepth | +
| Multicast dropped bytes count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/mcDropBytes | +
| Multicast dropped packet count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/mcDropPackets | +
| Multicast transmit byte count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/mcTxBytes | +
| Multicast transmit packet count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/mcTxPackets | +
| Priority-based flow control per packet pause received count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/pfcRxPpp | +
| Priority-based flow control per packet pause transmitted count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/pfcTxPpp | +
| Priority-based flow control watchdog queue flushed packets | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/pfcwdFlushedPackets | +
| Priority-based flow control watchdog queue restored count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/pfcwdRestoredCount | +
| Priority-based flow control watchdog queue shutdown count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/pfcwdShutdownCount | +
| Random detect ECN marked packet count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/randEcnMarkedPackets | +
| QOS statistic type | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/statType | +
| Transmit byte count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/txBytes | +
| Unicast current queue depth (bytes) | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ucCurrQueueDepth | +
| Unicast droped bytes count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ucDropBytes | +
| Unicast droped packet count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ucDropPackets | +
| Unicast transmit byte count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ucTxBytes | +
| Unicast transmit packet count | ++ | /System/ipqos-items/queuing-items/policy-items/out-items/intf-items/If-list/queCmap-items/QueuingStats-list/ucTxPackets | +
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| Memory utilized | +/components/component/state/memory/utilized | +/System/pie-items/modules-items/module-items/Module-list/memory-items/memory_usage-items/memUsed | +
| Memory reserved | +/system/memory/state/reserved | ++ |
| Memory available | +/components/component/state/memory/available | +/System/pie-items/modules-items/module-items/Module-list/memory-items/memory_usage-items/memFree | +
| Memory total | +/system/memory/state/physical | +/System/pie-items/modules-items/module-items/Module-list/memory-items/memory_usage-items/memTotal | +
| Component status | +/components/component/state/oper-status | ++ |
| CPU total average utilization | +/system/cpus/cpu/state/total/avg | ++ |
| CPU current utilization | +/components/component/cpu/utilization/state/instant | +/System/procsys-items/syscpusummary-items/syscpu-items/SysCpu-list/total-items/pct | +
| CPU state average utilization | +/components/component/cpu/utilization/state/avg | +/System/procsys-items/syscpusummary-items/syscpu-items/SysCpu-list/total-items/avg | +
| CPU state minimum utilization | +/components/component/cpu/utilization/state/min | +/System/procsys-items/syscpusummary-items/syscpu-items/SysCpu-list/total-items/min | +
| CPU state maximum utilization | +/components/component/cpu/utilization/state/max | +/System/procsys-items/syscpusummary-items/syscpu-items/SysCpu-list/total-items/max | +
| Fan speed | +/components/component/fan/state/speed | ++ |
| Fan state | +/openconfig-platform:components/component/fan/state/ | ++ |
| Metric | +Openconfig Model | +Native Model | +
|---|---|---|
| VLAN ID | +/network-instances/network-instance/vlans/vlan/state/vlan-id | ++ |
Cisco YANG Suite is a set of tools and plugins to learn and test YANG programmable interfaces such as NETCONF, RESTCONF, gNMI, OpenConfig, and more.
+This tool provides a central place to interact with Cisco IOS XE, IOS XR, and NX-OS devices to assist with learning and migration to modern programmable network management tools. +Features include:
+The tool can be installed in a Docker container or a Python virtual environment.
+Additional information can be found below: +Cisco DevNet YANG Suite +YANG Suite GitHub
+ + + + + + + + + + + + + +