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 Notifications for Changes in the PTP Grand Master

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ptpPtpEntity": {
          "attributes": {
            "notifyGmChange": "enabled"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <ptp-items>
    <notifyGmChange>enabled</notifyGmChange>
  </ptp-items>
</System>

Configuring PTP Notifications

Configuring Notifications for Changes in the PTP Grand Master

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 gm-change

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

ptpPtpEntity Properties

The following table contains information about the ptpPtpEntity 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
notifyGmChange	ptp:AdminSt (scalar:Enum8)	PTP gm-change notification enable/disable	SELECTION: 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 Notifications for Changes in the PTP Grand Master

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

CLI Commands

no ptp notification type gm-change

Verifying a DME Configuration

MO	DN
topSystem	sys
ptpPtpEntity	sys/ptp

ptpPtpEntity Properties

Property Name	Data Type	Description	Values
notifyGmChange	ptp:AdminSt (scalar:Enum8)	PTP gm-change notification enable/disable	SELECTION: 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 Notifications for Changes in PTP Parent

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

CLI Commands

ptp notification type parent-change

Verifying a DME Configuration

MO	DN
topSystem	sys
ptpPtpEntity	sys/ptp

ptpPtpEntity Properties

Property Name	Data Type	Description	Values
notifyParentChange	ptp:AdminSt (scalar:Enum8)	PTP parent-change notification enable/disable	SELECTION: 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 Notifications for Changes in PTP Parent

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

CLI Commands

no ptp notification type parent-change

Verifying a DME Configuration

MO	DN
topSystem	sys
ptpPtpEntity	sys/ptp

ptpPtpEntity Properties

Property Name	Data Type	Description	Values
notifyParentChange	ptp:AdminSt (scalar:Enum8)	PTP parent-change notification enable/disable	SELECTION: 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 are Sent for Port-State Changes (Default Options)

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

CLI Commands

ptp notification type port-state-change

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

The following table contains information about the ptpPtpNotifyPortStateChg 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
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 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 are Sent for All Port-State Changes

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

CLI Commands

ptp notification type port-state-change category all

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
category	ptp:NotifyPortStateChgCategory (scalar:Enum8)	PTP port-state-change notification category	SELECTION: 0 - master-slave-only 1 - all DEFAULT: master-slave-only
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 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 are Sent for Master-Slave-Only Port-State Changes

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

CLI Commands

ptp notification type port-state-change category master-slave-only

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
category	ptp:NotifyPortStateChgCategory (scalar:Enum8)	PTP port-state-change notification category	SELECTION: 0 - master-slave-only 1 - all DEFAULT: master-slave-only
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 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 are Sent for Port-State Changes Immediately

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

CLI Commands

ptp notification type port-state-change interval immediate

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
interval	ptp:NotifyPortStateChgInterval (scalar:Uint32)	PTP port-state-change notification interval	RANGE: [0 , 300] DEFAULT: 0
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 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 are Sent for Port-State Changes at Fixed Intervals

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

CLI Commands

ptp notification type port-state-change interval 10

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
interval	ptp:NotifyPortStateChgInterval (scalar:Uint32)	PTP port-state-change notification interval	RANGE: [0 , 300] DEFAULT: 0
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 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 are Sent for Port-State Changes at Fixed Intervals With or Without State Changes During the Interval

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

CLI Commands

ptp notification type port-state-change interval 10 periodic-notification enable

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
interval	ptp:NotifyPortStateChgInterval (scalar:Uint32)	PTP port-state-change notification interval	RANGE: [0 , 300] DEFAULT: 0
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
periodic	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification periodic-notification	SELECTION: 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 are Sent for Port-State Changes at Fixed Intervals Only if No State Changes are Made During the Interval

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

CLI Commands

ptp notification type port-state-change interval 10 periodic-notification disable

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
interval	ptp:NotifyPortStateChgInterval (scalar:Uint32)	PTP port-state-change notification interval	RANGE: [0 , 300] DEFAULT: 0
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
periodic	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification periodic-notification	SELECTION: 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 are Sent for All Categories of Port-State Changes at Fixed Intervals With or Without State Changes During the Interval

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

CLI Commands

ptp notification type port-state-change category all interval 10 periodic-notification enable

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
category	ptp:NotifyPortStateChgCategory (scalar:Enum8)	PTP port-state-change notification category	SELECTION: 0 - master-slave-only 1 - all DEFAULT: master-slave-only
interval	ptp:NotifyPortStateChgInterval (scalar:Uint32)	PTP port-state-change notification interval	RANGE: [0 , 300] DEFAULT: 0
notify	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification enable/disable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
periodic	ptp:AdminSt (scalar:Enum8)	PTP port-state-change notification periodic-notification	SELECTION: 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 Notifications for Changes in Port-State Changes

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

CLI Commands

no ptp notification type port-state-change

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
status	mo: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

Disabling Notifications for Changes in Port-State Changes

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

CLI Commands

no ptp notification type port-state-change

Verifying a DME Configuration

MO	DN
ptpPtpEntity	sys/ptp
ptpPtpNotifyPortStateChg	sys/ptp/notifyportstatechg

ptpPtpNotifyPortStateChg Properties

Property Name	Data Type	Description	Values
status	mo: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