Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the GRPC Port Number

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "grpcInst": {
          "attributes": {
            "port": "sample_value"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <grpc-items>
    <port>sample_value</port>
  </grpc-items>
</System>

Configuring GRPC

For information about this feature, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html

Configuring the GRPC Port Number

Note: This example was added in Release 9.3(5).

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

grpc port sample_value

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
topSystem	sys
grpcInst	sys/grpc

grpcInst Properties

The following table contains information about the grpcInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
port	scalar:Uint32	Specifies the port number on which the grpc Agent listens	RANGE: [1024 , 65535] DEFAULT: 50051

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the GRPC Port Number

Note:

When you delete the port, it falls back to its default value of 50051
This example was added in Release 9.3(5).

CLI Commands

no grpc port sample_value

Verifying a DME Configuration

MO	DN
topSystem	sys
grpcInst	sys/grpc

grpcInst Properties

Property Name	Data Type	Description	Values
port	scalar:Uint32	Specifies the port number on which the grpc Agent listens	RANGE: [1024 , 65535] DEFAULT: 50051

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Certificate Id

Note:

This example was added in Release 9.3(5).
If grpc has a 1-Day certificate or a certificate configured in the conf file, in the model, "cert" property will be seen as empty. When grpc certificate is configured using the CLI, "cert" will have the value of the configured certificate .

CLI Commands

grpc certificate SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
grpcInst	sys/grpc

grpcInst Properties

Property Name	Data Type	Description	Values
cert	os:OsString (naming:Name)	Specifies the certificate to be used for TLS authentication	RANGE: The size of the certificate that can be accepted. The grpc certificate size should be between 0 and 64.

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Certificate Id

After you delete the certificate, it goes back to the default value.

Note:

This example was added in Release 9.3(5).
After delete, it falls back to the certificate configured using conf file if present or the default 1-Day certificate.

CLI Commands

no grpc certificate SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
grpcInst	sys/grpc

grpcInst Properties

Property Name	Data Type	Description	Values
cert	os:OsString (naming:Name)	Specifies the certificate to be used for TLS authentication	RANGE: The size of the certificate that can be accepted. The grpc certificate size should be between 0 and 64.

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

GRPC Set VRF

Note:

When feature grpc is enabled, by default grpc is enabled over "management" interface. In the model, "useVrf" property will be seen as empty, if grpc is enabled only for management interface. When grpc is enabled for default vrf, "useVrf" property will have the value "default".
This exampl e was added in Release 9.3(5).

CLI Commands

grpc use-vrf default

Verifying a DME Configuration

MO	DN
topSystem	sys
grpcInst	sys/grpc

grpcInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString	(naming:Name)\|Vrf to be used for grpc communication.	The only value that useVrf can have is 'default'

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the GRPC Set VRF

Note: This example was added in Release 9.3(5).

CLI Commands

no grpc use-vrf default

Verifying a DME Configuration

MO	DN
topSystem	sys
grpcInst	sys/grpc

grpcInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString	(naming:Name)\|Vrf to be used for grpc communication.	The only value that useVrf can have is 'default'

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Max Concurrent Calls for GRPC GNMI

Note: This example was added in Release 9.3(5).

CLI Commands

grpc gnmi max-concurrent-calls sample_value

Verifying a DME Configuration

MO	DN
grpcInst	sys/grpc
grpcGnmi	sys/grpc/gnmi

grpcGnmi Properties

The following table contains information about the grpcGnmi properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
maxCalls	scalar:Uint16	Specifies the maximum number of concurrent calls to gnmi.	RANGE: [1 , 16] DEFAULT: 8

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Max Concurrent Calls for GRPC GNMI

Note: This example was added in Release 9.3(5).

CLI Commands

no grpc gnmi max-concurrent-calls sample_value

Verifying a DME Configuration

MO	DN
grpcInst	sys/grpc
grpcGnmi	sys/grpc/gnmi

grpcGnmi Properties

Property Name	Data Type	Description	Values
maxCalls	scalar:Uint16	Specifies the maximum number of concurrent calls to gnmi.	RANGE: [1 , 16] DEFAULT: 8

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html