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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Number of Maximum Simultaneous Client Sessions for Netconf

DME

YANG

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

Copy
      <System>
        <netconf-items>
          <maxSessions>sample_value</maxSessions>
        </netconf-items>
      </System>

Configuring Netconf

Configuring the Number of Maximum Simultaneous Client Sessions for Netconf

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.

netconf sessions 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
netconfInst	sys/netconf

Verifying the YANG Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the YANG 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
netconfInst	sys/netconf

netconfInst Properties

The following table contains information about the netconfInst 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
maxSessions	scalar:Uint16	Number of maximum simultaneous client sessions	RANGE: [1 , 10] DEFAULT: 5

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 Number of Maximum Simultaneous Client Sessions for Netconf

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

CLI Commands

no netconf sessions sample_value

Verifying a DME Configuration

MO	DN
topSystem	sys
netconfInst	sys/netconf

Verifying the YANG Configuration

MO	DN
netconfInst	sys/netconf

netconfInst Properties

Property Name	Data Type	Description	Values
maxSessions	scalar:Uint16	Number of maximum simultaneous client sessions	RANGE: [1 , 10] DEFAULT: 5

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 Netconf Duration until Idle Session Expires

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

CLI Commands

netconf idle-timeout sample_value

Verifying a DME Configuration

MO	DN
topSystem	sys
netconfInst	sys/netconf

Verifying the YANG Configuration

MO	DN
netconfInst	sys/netconf

netconfInst Properties

Property Name	Data Type	Description	Values
idleTimeout	uint32	Specifies the idle timeout (in minutes) before a session expires.	RANGE: 0 - 1440 DEFAULT: 5

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 Netconf Duration until Idle Session Expires

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

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

CLI Commands

no netconf idle-timeout sample_value

Verifying a DME Configuration

MO	DN
topSystem	sys
netconfInst	sys/netconf

Verifying the YANG Configuration

MO	DN
netconfInst	sys/netconf

netconfInst Properties

Property Name	Data Type	Description	Values
idleTimeout	uint32	Specifies the idle timeout (in minutes) before a session expires.	RANGE: 0 - 1440 DEFAULT: 5

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