Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Configuring PTP Notifications for High Corrections (Default Options)
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/ptp.json

{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyHighCorr": {
          "attributes": {
            "notify": "enabled"
}}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <ptp-items>
    <notifyhighcorr-items>
      <notify>enabled</notify>
    </notifyhighcorr-items>
  </ptp-items>
</System>

Configuring High Corrections

Configuring PTP Notifications for High Corrections (Default Options)

Configuring PTP Notifications for High Corrections (Default Options)

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.

ptp notification type high-correction


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
ptpPtpEntity sys/ptp
ptpPtpNotifyHighCorr sys/ptp/notifyhighcorr


ptpPtpNotifyHighCorr Properties

The following table contains information about the ptpPtpNotifyHighCorr 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 NameData TypeDescriptionValues
notifyptp:AdminSt
(scalar:Enum8)		PTP high-correction notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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 How PTP Notifications for High Corrections are Sent Immediately

Configuring How PTP Notifications for High Corrections are Sent Immediately

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.

ptp notification type high-correction interval immediate


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
ptpPtpEntity sys/ptp
ptpPtpNotifyHighCorr sys/ptp/notifyhighcorr


ptpPtpNotifyHighCorr Properties

The following table contains information about the ptpPtpNotifyHighCorr 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 NameData TypeDescriptionValues
intervalptp:NotifyHighCorrInterval
(scalar:Uint32)		PTP high-correction notification interval
RANGE: [0 , 300]
DEFAULT: 5
notifyptp:AdminSt
(scalar:Enum8)		PTP high-correction notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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 How PTP Notifications for High Corrections are Sent With a Non-Default Interval

Configuring How PTP Notifications for High Corrections are Sent With a Non-Default Interval

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.

ptp notification type high-correction interval 10


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
ptpPtpEntity sys/ptp
ptpPtpNotifyHighCorr sys/ptp/notifyhighcorr


ptpPtpNotifyHighCorr Properties

The following table contains information about the ptpPtpNotifyHighCorr 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 NameData TypeDescriptionValues
intervalptp:NotifyHighCorrInterval
(scalar:Uint32)		PTP high-correction notification interval
RANGE: [0 , 300]
DEFAULT: 5
notifyptp:AdminSt
(scalar:Enum8)		PTP high-correction notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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 How PTP Notifications for High Corrections are Sent Periodically With or Without High-Corrections During the Interval

Configuring How PTP Notifications for High Corrections are Sent Periodically With or Without High-Corrections During the Interval

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.

ptp notification type high-correction interval 10 periodic-notification enable


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
ptpPtpEntity sys/ptp
ptpPtpNotifyHighCorr sys/ptp/notifyhighcorr


ptpPtpNotifyHighCorr Properties

The following table contains information about the ptpPtpNotifyHighCorr 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 NameData TypeDescriptionValues
intervalptp:NotifyHighCorrInterval
(scalar:Uint32)		PTP high-correction notification interval
RANGE: [0 , 300]
DEFAULT: 5
notifyptp:AdminSt
(scalar:Enum8)		PTP high-correction notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
periodicptp:AdminSt
(scalar:Enum8)		PTP high-correction notification periodic-notificationSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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 How PTP Notifications for High Corrections are Sent Periodically Only if There are No High-Corrections During the Interval

Configuring How PTP Notifications for High Corrections are Sent Periodically Only if There are No High-Corrections During the Interval

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.

ptp notification type high-correction interval 10 periodic-notification disable


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
ptpPtpEntity sys/ptp
ptpPtpNotifyHighCorr sys/ptp/notifyhighcorr


ptpPtpNotifyHighCorr Properties

The following table contains information about the ptpPtpNotifyHighCorr 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 NameData TypeDescriptionValues
intervalptp:NotifyHighCorrInterval
(scalar:Uint32)		PTP high-correction notification interval
RANGE: [0 , 300]
DEFAULT: 5
notifyptp:AdminSt
(scalar:Enum8)		PTP high-correction notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
periodicptp:AdminSt
(scalar:Enum8)		PTP high-correction notification periodic-notificationSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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 PTP Notification for High Corrections

Deleting PTP Notification for High Corrections

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.

no ptp notification type high-correction


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
ptpPtpEntity sys/ptp
ptpPtpNotifyHighCorr sys/ptp/notifyhighcorr


ptpPtpNotifyHighCorr Properties

The following table contains information about the ptpPtpNotifyHighCorr 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 NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)		The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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