Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Port on which the Local RADIUS Server Listens

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/userext/radiusext.json
{
  "aaaRadiusEp": {
    "children": [
      {
        "aaaDynamicRadiusAuthServer": {
          "attributes": {
            "port": "3568"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <userext-items>
    <radiusext-items>
      <dynamicradiusauthserver-items>
        <port>3568</port>
      </dynamicradiusauthserver-items>
    </radiusext-items>
  </userext-items>
</System>

Configuring a Local Server Profile for RFC 5176 Support

Configuring the Port on which the Local RADIUS Server Listens

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

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.

aaa server radius dynamic-author
port 3568

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
aaaRadiusEp	sys/userext/radiusext
aaaDynamicRadiusAuthServer	sys/userext/radiusext/dynamicradiusauthserver

aaaDynamicRadiusAuthServer Properties

The following table contains information about the aaaDynamicRadiusAuthServer 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	Configuration for port number	RANGE: [0 , 65535] DEFAULT: 1700

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 Port on which the Local RADIUS Server Listens

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

CLI Commands

aaa server radius dynamic-author
no port 3568

Verifying a DME Configuration

MO	DN
aaaRadiusEp	sys/userext/radiusext
aaaDynamicRadiusAuthServer	sys/userext/radiusext/dynamicradiusauthserver

aaaDynamicRadiusAuthServer Properties

Property Name	Data Type	Description	Values
port	scalar:Uint32	Configuration for port number	RANGE: [0 , 65535] DEFAULT: 1700

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 Encryption Key Shared with the RADIUS Clients

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

CLI Commands

aaa server radius dynamic-author
server-key 0 SampleString_123

Verifying a DME Configuration

MO	DN
aaaRadiusEp	sys/userext/radiusext
aaaDynamicRadiusAuthServer	sys/userext/radiusext/dynamicradiusauthserver

aaaDynamicRadiusAuthServer Properties

Property Name	Data Type	Description	Values
key	string:Basic	Configuration for server key	RANGE: [0 , 63]
keyEnc	aaa:KeyEnc (scalar:Enum8)	server key Encription type	SELECTION: 0 - 0 6 - 6 7 - 7 DEFAULT: 0

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 Encryption Key Shared with the RADIUS Clients

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

CLI Commands

aaa server radius dynamic-author
no server-key 0 SampleString_123

Verifying a DME Configuration

MO	DN
aaaRadiusEp	sys/userext/radiusext
aaaDynamicRadiusAuthServer	sys/userext/radiusext/dynamicradiusauthserver

aaaDynamicRadiusAuthServer Properties

Property Name	Data Type	Description	Values
key	string:Basic	Configuration for server key	RANGE: [0 , 63]
keyEnc	aaa:KeyEnc (scalar:Enum8)	server key Encription type	SELECTION: 0 - 0 6 - 6 7 - 7 DEFAULT: 0

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 Encryption Key Shared with the RADIUS Client (Encrypted)

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

CLI Commands

aaa server radius dynamic-author
client HostName vrf default server-key 7 SampleString_123

Verifying a DME Configuration

MO	DN
aaaDynamicRadiusAuthServer	sys/userext/radiusext/dynamicradiusauthserver
aaaDynamicAuthClient	sys/userext/radiusext/dynamicradiusauthserver/dynamicauthclient-[HostName]

aaaDynamicAuthClient Properties

The following table contains information about the aaaDynamicAuthClient 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
key	string:Basic	serverkey for dynamic-author client	RANGE: [0 , 63]
keyEnc	aaa:KeyEnc (scalar:Enum8)	Default key encryption type	SELECTION: 0 - 0 6 - 6 7 - 7 DEFAULT: 0
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 128]
vrf	l3:VrfName (string:Basic)	vrf name for dynamic-author client	A sequence of characters

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 Encryption Key Shared with the RADIUS Client (Clear Text)

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

CLI Commands

aaa server radius dynamic-author
client HostName vrf management server-key 0 SampleString_123

Verifying a DME Configuration

MO	DN
aaaDynamicRadiusAuthServer	sys/userext/radiusext/dynamicradiusauthserver
aaaDynamicAuthClient	sys/userext/radiusext/dynamicradiusauthserver/dynamicauthclient-[HostName]

aaaDynamicAuthClient Properties

Property Name	Data Type	Description	Values
key	string:Basic	serverkey for dynamic-author client	RANGE: [0 , 63]
keyEnc	aaa:KeyEnc (scalar:Enum8)	Default key encryption type	SELECTION: 0 - 0 6 - 6 7 - 7 DEFAULT: 0
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 128]
vrf	l3:VrfName (string:Basic)	vrf name for dynamic-author client	A sequence of characters

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