Configuring PTP Notifications

Configuring Notifications for Changes in the PTP Grand Master

Configuring Notifications for Changes in the PTP Grand Master
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ptpPtpEntity": {
          "attributes": {
            "notifyGmChange": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyGmChange>enabled</notifyGmChange>
  </ptp-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
notifyGmChangeptp:AdminSt
(scalar:Enum8)
PTP gm-change 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

Deleting Notifications for Changes in the PTP Grand Master

Deleting Notifications for Changes in the PTP Grand Master
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ptpPtpEntity": {
          "attributes": {
            "notifyGmChange": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyGmChange>disabled</notifyGmChange>
  </ptp-items>
</System>

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 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.

MODN
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 NameData TypeDescriptionValues
notifyGmChangeptp:AdminSt
(scalar:Enum8)
PTP gm-change 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 Notifications for Changes in PTP Parent

Configuring Notifications for Changes in PTP Parent
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ptpPtpEntity": {
          "attributes": {
            "notifyParentChange": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyParentChange>enabled</notifyParentChange>
  </ptp-items>
</System>

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 parent-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.

MODN
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 NameData TypeDescriptionValues
notifyParentChangeptp:AdminSt
(scalar:Enum8)
PTP parent-change 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

Deleting Notifications for Changes in PTP Parent

Deleting Notifications for Changes in PTP Parent
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ptpPtpEntity": {
          "attributes": {
            "notifyParentChange": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyParentChange>disabled</notifyParentChange>
  </ptp-items>
</System>

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 parent-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.

MODN
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 NameData TypeDescriptionValues
notifyParentChangeptp:AdminSt
(scalar:Enum8)
PTP parent-change 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 are Sent for Port-State Changes (Default Options)

Configuring How PTP Notifications are Sent for Port-State Changes (Default Options)
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "notify": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <notify>enabled</notify>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-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.

MODN
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 NameData TypeDescriptionValues
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for All Port-State Changes

Configuring How PTP Notifications are Sent for All Port-State Changes
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "category": "all",
            "notify": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <category>all</category>
      <notify>enabled</notify>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change category all


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
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 NameData TypeDescriptionValues
categoryptp:NotifyPortStateChgCategory
(scalar:Enum8)
PTP port-state-change notification categorySELECTION:
0 - master-slave-only
1 - all
DEFAULT: master-slave-only
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for Master-Slave-Only Port-State Changes

Configuring How PTP Notifications are Sent for Master-Slave-Only Port-State Changes
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "category": "master-slave-only",
            "notify": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <category>master-slave-only</category>
      <notify>enabled</notify>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change category master-slave-only


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
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 NameData TypeDescriptionValues
categoryptp:NotifyPortStateChgCategory
(scalar:Enum8)
PTP port-state-change notification categorySELECTION:
0 - master-slave-only
1 - all
DEFAULT: master-slave-only
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for Port-State Changes Immediately

Configuring How PTP Notifications are Sent for Port-State Changes Immediately
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "interval": "0",
            "notify": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <interval>0</interval>
      <notify>enabled</notify>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change 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
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 NameData TypeDescriptionValues
intervalptp:NotifyPortStateChgInterval
(scalar:Uint32)
PTP port-state-change notification interval
RANGE: [0 , 300]
DEFAULT: 0
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for Port-State Changes at Fixed Intervals

Configuring How PTP Notifications are Sent for Port-State Changes at Fixed Intervals
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "interval": "10",
            "notify": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <interval>10</interval>
      <notify>enabled</notify>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change 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
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 NameData TypeDescriptionValues
intervalptp:NotifyPortStateChgInterval
(scalar:Uint32)
PTP port-state-change notification interval
RANGE: [0 , 300]
DEFAULT: 0
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for Port-State Changes at Fixed Intervals With or Without State Changes During the Interval

Configuring How PTP Notifications are Sent for Port-State Changes at Fixed Intervals With or Without State Changes During the Interval
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "interval": "10",
            "notify": "enabled",
            "periodic": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <interval>10</interval>
      <notify>enabled</notify>
      <periodic>enabled</periodic>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change 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
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 NameData TypeDescriptionValues
intervalptp:NotifyPortStateChgInterval
(scalar:Uint32)
PTP port-state-change notification interval
RANGE: [0 , 300]
DEFAULT: 0
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
periodicptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for Port-State Changes at Fixed Intervals Only if No State Changes are Made During the Interval

Configuring How PTP Notifications are Sent for Port-State Changes at Fixed Intervals Only if No State Changes are Made During the Interval
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "interval": "10",
            "notify": "enabled",
            "periodic": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <interval>10</interval>
      <notify>enabled</notify>
      <periodic>disabled</periodic>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change 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
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 NameData TypeDescriptionValues
intervalptp:NotifyPortStateChgInterval
(scalar:Uint32)
PTP port-state-change notification interval
RANGE: [0 , 300]
DEFAULT: 0
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
periodicptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 are Sent for All Categories of Port-State Changes at Fixed Intervals With or Without State Changes During the Interval

Configuring How PTP Notifications are Sent for All Categories of Port-State Changes at Fixed Intervals With or Without State Changes During the Interval
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "category": "all",
            "interval": "10",
            "notify": "enabled",
            "periodic": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items>
      <category>all</category>
      <interval>10</interval>
      <notify>enabled</notify>
      <periodic>enabled</periodic>
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-change category all 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
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 NameData TypeDescriptionValues
categoryptp:NotifyPortStateChgCategory
(scalar:Enum8)
PTP port-state-change notification categorySELECTION:
0 - master-slave-only
1 - all
DEFAULT: master-slave-only
intervalptp:NotifyPortStateChgInterval
(scalar:Uint32)
PTP port-state-change notification interval
RANGE: [0 , 300]
DEFAULT: 0
notifyptp:AdminSt
(scalar:Enum8)
PTP port-state-change notification enable/disableSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
periodicptp:AdminSt
(scalar:Enum8)
PTP port-state-change 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 Notifications for Changes in Port-State Changes

Deleting Notifications for Changes in Port-State Changes
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items nc:operation="delete">
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-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.

MODN
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 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

Disabling Notifications for Changes in Port-State Changes

Disabling Notifications for Changes in Port-State Changes
POST http://<mgmt0_IP>/api/mo/sys/ptp.json
{
  "ptpPtpEntity": {
    "children": [
      {
        "ptpPtpNotifyPortStateChg": {
          "attributes": {
            "notify": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ptp-items>
    <notifyportstatechg-items nc:operation="delete">
    </notifyportstatechg-items>
  </ptp-items>
</System>

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 port-state-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.

MODN
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 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