Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Configuring Classic Keychain
DME
YANG
Copy
POST http://<mgmt_IP>/api/mo/sys.json

   
{
  "topSystem": {
    "children": [
      {
        "kcmgrEntity": {
          "children": [
            {
              "kcmgrKeychains": {
                "children": [
                  {
                    "kcmgrClassicKeychain": {
                      "attributes": {
                        "keychainName": "test"
                      },
                      "children": [
                        {
                          "kcmgrKey": {
                            "attributes": {
                              "cryptoAlgo": "MD5",
                              "encryptType": "type7",
                              "keyId": "1",
                              "keyString": "070e234f"
                            },
                            "children": [
                              {
                                "kcmgrSendlifetime": {
                                  "attributes": {
                                    "duration": "0",
                                    "infinite": "enabled",
                                    "local": "local",
                                    "startDay": "6",
                                    "startMonth": "Dec",
                                    "startTime": "00:37:48",
                                    "startYear": "2023"
                                  }
                                }
                              },
                              {
                                "kcmgrAcceptlifetime": {
                                  "attributes": {
                                    "duration": "0",
                                    "endDay": "6",
                                    "endMonth": "Dec",
                                    "endTime": "00:37:48",
                                    "endYear": "2024",
                                    "infinite": "disabled",
                                    "local": "unspecified",
                                    "startDay": "6",
                                    "startMonth": "Dec",
                                    "startTime": "00:37:48",
                                    "startYear": "2023"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Response
{
    imdata:[]
}

Copy
<System>
        <kcmgr-items>
          <keychains-items>
            <classickeychain-items>
              <ClassicKeychain-list>
                <keychainName>test</keychainName>
                <classickeyid-items>
                  <Key-list>
                    <keyId>1</keyId>
                    <encryptType>unencrypted</encryptType>
                    <keyString>abc</keyString>
                    <cryptoAlgo>MD5</cryptoAlgo>
                    <sendlifetime-items>
                      <startTime>00:37:48</startTime>
                      <startDay>6</startDay>
                      <startMonth>Dec</startMonth>
                      <startYear>2023</startYear>
                      <infinite>enabled</infinite>
                    </sendlifetime-items>
                    <acceptlifetime-items>
                      <startTime>00:37:48</startTime>
                      <startDay>6</startDay>
                      <startMonth>Dec</startMonth>
                      <startYear>2023</startYear>
                      <endTime>00:37:48</endTime>
                      <endDay>6</endDay>
                      <endMonth>Dec</endMonth>
                      <endYear>2024</endYear>
                    </acceptlifetime-items>
                  </Key-list>
                </classickeyid-items>
              </ClassicKeychain-list>
            </classickeychain-items>
          </keychains-items>
        </kcmgr-items>
      </System>

Configuring Keychain Management

Keychain management allows you to create and maintain keychains, which are sequences of keys (sometimes called shared secrets). You can use keychains with features that secure communications with other devices by using key-based authentication. The device allows you to configure multiple keychains.

For more information, see the Cisco Nexus 9000 Series NX-OS Unicast Routing Configuration Guide:

https://www.cisco.com/content/en/us/td/docs/dcn/nx-os/nexus9000/104x/unicast-routing-configuration/cisco-nexus-9000-series-nx-os-unicast-routing-configuration-guide.html

Configuring Classic Keychain

Configuring Classic Keychain


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.

key-chain macsec-psk

Note: The property information for this example was added in release 10.3(1)F.


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.

MODN
topSystem sys
kcmgrEntity sys/kcmgr
kcmgrClassicKeychain sys/kcmgr/keychains/classickeychain-{[ keychainName]}
kcmgrKey sys/kcmgr/keychains/classickeychain-{[ keychainName]}/classickeyid-{keyId}
KcmgrAcceptlifetime sys/kcmgr/keychains/classickeychain-{[keychainName]}/classickeyid-{keyId}/acceptlifetime
kcmgrSendlifetime sys/kcmgr/keychains/classickeychain-{[keychainName]}/classickeyid-{keyId}/sendlifetime


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 Macsec Keychain

Configuring Macsec Keychain


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.

key chain test macsec

Note: The property information for this example was added in release 10.3(1)F.


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.

MODN
topSystem sys
kcmgrEntity sys/kcmgr
kcmgrMacsecKeychain sys/kcmgr/keychains/macseckeychain-{[ keychainName]}
kcmgrMacsecKeyId sys/kcmgr/keychains/macseckeychain-{[ keychainName]}/macseckeyid-{keyId}
kcmgrMacsecSendlifetime sys/kcmgr/keychains/macseckeychain-{[keychainName]}/macseckeyid-{keyId}/sendlifetime


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 Tunnel Encryption Keychain

Configuring Tunnel Encryption Keychain


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.

key-chain tunnelencrypt-psk tunnel-encryption

Note: The property information for this example was added in release 10.3(1)F.


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.

MODN
topSystem sys
kcmgrEntity sys/kcmgr
kcmgrTunnelencryptKeychain sys/kcmgr/keychains/tunnelencryptkeychain-{[ keychainName]}
kcmgrTunnelencryptKeyId sys/kcmgr/keychains/tunnelencryptkeychain-{[ keychainName]}/tunnelencryptkeyid -{keyId}
kcmgrTunnelencryptSendlifetime sys/kcmgr/keychains/tunnelencryptkeychain-{[keychainName]}/tunnelencryptkeyid-{keyId}/sendlifetime


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

Next