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 ITU-T Option 2, Generation 1: Stratum 4 Freerun

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "fsyncMgrSynceEntity": {
          "children": [
            {
              "fsyncMgrSynceEthif": {
                "attributes": {
                  "freqsync": "yes",
                  "id": "eth1/3",
                  "qlrcvexactoptype": "op2g1",
                  "qlrcvexactval": "fsync-ql-o2-g1-st4",
                  "qlrcvhval": "fsync-ql-common-none",
                  "qlrcvlval": "fsync-ql-common-none"
                }
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/3"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <fsyncmgr-items>
    <if-items>
      <MgrSynceEthif-list>
        <id>eth1/3</id>
        <freqsync>true</freqsync>
        <qlrcvexactoptype>op2g1</qlrcvexactoptype>
        <qlrcvexactval>fsync-ql-o2-g1-st4</qlrcvexactval>
        <qlrcvhval>fsync-ql-common-none</qlrcvhval>
        <qlrcvlval>fsync-ql-common-none</qlrcvlval>
      </MgrSynceEthif-list>
    </if-items>
  </fsyncmgr-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring the Received Quality Level (Exact)

Configuring ITU-T Option 2, Generation 1: Stratum 4 Freerun

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.

interface ethernet 1/3
frequency synchronization
quality receive exact itu-t option 2 generation 1 ST4

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
fsyncMgrSynceEntity	sys/fsyncmgr
fsyncMgrSynceEthif	sys/fsyncmgr/if-[eth1/3]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/3]

fsyncMgrSynceEthif Properties

The following table contains information about the fsyncMgrSynceEthif 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
freqsync	scalar:Bool	frequency synchronization	SELECTION: true or false DEFAULT: false
id	nw:IfId (base:IfIndex)	SyncE ethernet interface	Must match first field in the output of `show intf brief`. Example: Eth1/1
qlrcvexactoptype	fsyncMgr:qloptype (scalar:Enum8)	quality receive exact QL option type	SELECTION: 0 - none 1 - op1 2 - op2g1 3 - op2g2 DEFAULT: none
qlrcvexactval	fsyncMgr:qlvalue (scalar:Enum8)	quality receive exact QL value	SELECTION: 1 - fsync-ql-common-dnu 2 - fsync-ql-common-failed 3 - fsync-ql-common-none 20 - fsync-ql-o1-eprtc 21 - fsync-ql-o1-prtc 22 - fsync-ql-o1-prc 23 - fsync-ql-o1-ssu-a 24 - fsync-ql-o1-ssu-b 25 - fsync-ql-o1-eeec 26 - fsync-ql-o1-eec1 27 - fsync-ql-o1-sec 40 - fsync-ql-o2-g1-eprtc 41 - fsync-ql-o2-g1-prtc 42 - fsync-ql-o2-g1-prs 43 - fsync-ql-o2-g1-stu 44 - fsync-ql-o2-g1-st2 45 - fsync-ql-o2-g1-st3 46 - fsync-ql-o2-g1-eeec 47 - fsync-ql-o2-g1-eec2 48 - fsync-ql-o2-g1-smc 49 - fsync-ql-o2-g1-st4 50 - fsync-ql-o2-g1-res 60 - fsync-ql-o2-g2-eprtc 61 - fsync-ql-o2-g2-prtc 62 - fsync-ql-o2-g2-prs 63 - fsync-ql-o2-g2-stu 64 - fsync-ql-o2-g2-st2 65 - fsync-ql-o2-g2-tnc 66 - fsync-ql-o2-g2-st3e 67 - fsync-ql-o2-g2-st3 68 - fsync-ql-o2-g2-eeec 69 - fsync-ql-o2-g2-eec2 70 - fsync-ql-o2-g2-smc 71 - fsync-ql-o2-g2-st4 72 - fsync-ql-o2-g2-prov DEFAULT: fsync-ql-common-none
qlrcvhval	fsyncMgr:qlvalue (scalar:Enum8)	quality receive highest QL value	SELECTION: 1 - fsync-ql-common-dnu 2 - fsync-ql-common-failed 3 - fsync-ql-common-none 20 - fsync-ql-o1-eprtc 21 - fsync-ql-o1-prtc 22 - fsync-ql-o1-prc 23 - fsync-ql-o1-ssu-a 24 - fsync-ql-o1-ssu-b 25 - fsync-ql-o1-eeec 26 - fsync-ql-o1-eec1 27 - fsync-ql-o1-sec 40 - fsync-ql-o2-g1-eprtc 41 - fsync-ql-o2-g1-prtc 42 - fsync-ql-o2-g1-prs 43 - fsync-ql-o2-g1-stu 44 - fsync-ql-o2-g1-st2 45 - fsync-ql-o2-g1-st3 46 - fsync-ql-o2-g1-eeec 47 - fsync-ql-o2-g1-eec2 48 - fsync-ql-o2-g1-smc 49 - fsync-ql-o2-g1-st4 50 - fsync-ql-o2-g1-res 60 - fsync-ql-o2-g2-eprtc 61 - fsync-ql-o2-g2-prtc 62 - fsync-ql-o2-g2-prs 63 - fsync-ql-o2-g2-stu 64 - fsync-ql-o2-g2-st2 65 - fsync-ql-o2-g2-tnc 66 - fsync-ql-o2-g2-st3e 67 - fsync-ql-o2-g2-st3 68 - fsync-ql-o2-g2-eeec 69 - fsync-ql-o2-g2-eec2 70 - fsync-ql-o2-g2-smc 71 - fsync-ql-o2-g2-st4 72 - fsync-ql-o2-g2-prov DEFAULT: fsync-ql-common-none
qlrcvlval	fsyncMgr:qlvalue (scalar:Enum8)	quality receive lowest QL value	SELECTION: 1 - fsync-ql-common-dnu 2 - fsync-ql-common-failed 3 - fsync-ql-common-none 20 - fsync-ql-o1-eprtc 21 - fsync-ql-o1-prtc 22 - fsync-ql-o1-prc 23 - fsync-ql-o1-ssu-a 24 - fsync-ql-o1-ssu-b 25 - fsync-ql-o1-eeec 26 - fsync-ql-o1-eec1 27 - fsync-ql-o1-sec 40 - fsync-ql-o2-g1-eprtc 41 - fsync-ql-o2-g1-prtc 42 - fsync-ql-o2-g1-prs 43 - fsync-ql-o2-g1-stu 44 - fsync-ql-o2-g1-st2 45 - fsync-ql-o2-g1-st3 46 - fsync-ql-o2-g1-eeec 47 - fsync-ql-o2-g1-eec2 48 - fsync-ql-o2-g1-smc 49 - fsync-ql-o2-g1-st4 50 - fsync-ql-o2-g1-res 60 - fsync-ql-o2-g2-eprtc 61 - fsync-ql-o2-g2-prtc 62 - fsync-ql-o2-g2-prs 63 - fsync-ql-o2-g2-stu 64 - fsync-ql-o2-g2-st2 65 - fsync-ql-o2-g2-tnc 66 - fsync-ql-o2-g2-st3e 67 - fsync-ql-o2-g2-st3 68 - fsync-ql-o2-g2-eeec 69 - fsync-ql-o2-g2-eec2 70 - fsync-ql-o2-g2-smc 71 - fsync-ql-o2-g2-st4 72 - fsync-ql-o2-g2-prov DEFAULT: fsync-ql-common-none

l1PhysIf Properties

The following table contains information about the l1PhysIf 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
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1

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 ITU-T Option 2, Generation 1: Enhanced Primary Reference Timing Clock