Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Configuring RTP Flows for Packet Loss Monitoring (IPv4)
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry.json

{
  "analyticsHwTelemetry": {
    "children": [
      {
        "netflowNetflow": {
          "attributes": {
            "isRtpIpv4": "yes",
            "rtpIpv4Acl": "ipv4ACLName"
}}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <hwtelemetry-items>
    <netflow-items>
      <isRtpIpv4>true</isRtpIpv4>
      <rtpIpv4Acl>ipv4ACLName</rtpIpv4Acl>
    </netflow-items>
  </hwtelemetry-items>
</System>

Configuring RTP Flow Monitoring

Real-Time Transport Protocol (RTP) is a network protocol for delivering audio and video over IP networks. It is designed for end-to-end, real-time transfer of streaming media. The protocol provides facilities for jitter compensation and detection of packet loss, which are common during UDP transmissions on an IP network. RTP flow monitoring caches RTP flows on the switch and detects any gaps in the RTP sequence number, which indicates a loss in RTP frames. This information helps to pinpoint where the loss is occurring and enables you to better plan hardware resources.

For more information, see the Cisco Nexus 9000 Series NX-OS IP Fabric for Media Solution Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Configuring RTP Flows for Packet Loss Monitoring (IPv4)

Configuring RTP Flows for Packet Loss Monitoring (IPv4)

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


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.

ip flow rtp ipv4ACLName


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
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow


netflowNetflow Properties

The following table contains information about the netflowNetflow 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
isRtpIpv4scalar:Bool
RTP IPV4 ConfigSELECTION: true or false
DEFAULT: false
rtpIpv4Aclnetflow:ACLName
(string:Basic)		RTP IPV4 ACL
MAX SIZE: 64
DEFAULT:


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 RTP Flows for Packet Loss Monitoring (IPv4)

Deleting RTP Flows for Packet Loss Monitoring (IPv4)

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


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 ip flow rtp ipv4ACLName


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
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow


netflowNetflow Properties

The following table contains information about the netflowNetflow 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
isRtpIpv4scalar:Bool
RTP IPV4 ConfigSELECTION: true or false
DEFAULT: false
rtpIpv4Aclnetflow:ACLName
(string:Basic)		RTP IPV4 ACL
MAX SIZE: 64
DEFAULT:


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 RTP Flows for Packet Loss Monitoring (IPv6)

Configuring RTP Flows for Packet Loss Monitoring (IPv6)

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


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.

ipv6 flow rtp ipv6ACLName


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
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow


netflowNetflow Properties

The following table contains information about the netflowNetflow 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
isRtpIpv6scalar:Bool
RTP IPV6 ConfigSELECTION: true or false
DEFAULT: false
rtpIpv6Aclnetflow:ACLName
(string:Basic)		RTP IPV6 ACL
MAX SIZE: 64
DEFAULT:


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 RTP Flows for Packet Loss Monitoring (IPv6)

Deleting RTP Flows for Packet Loss Monitoring (IPv6)

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


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 ipv6 flow rtp ipv6ACLName


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
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow


netflowNetflow Properties

The following table contains information about the netflowNetflow 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
isRtpIpv6scalar:Bool
RTP IPV6 ConfigSELECTION: true or false
DEFAULT: false
rtpIpv6Aclnetflow:ACLName
(string:Basic)		RTP IPV6 ACL
MAX SIZE: 64
DEFAULT:


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 RTP Flow Error Monitoring Duration

Configuring RTP Flow Error Monitoring Duration

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


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.

flow rtp timeout 100


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
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow


netflowNetflow Properties

The following table contains information about the netflowNetflow 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
rtpTimeoutnetflow:RtpTimeout
(scalar:Uint32)		RTP Flow Timeout
RANGE: [0 , 1440]
DEFAULT: 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/

Configuring the RTP Flow Error History Size

Configuring the RTP Flow Error History Size

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.

flow rtp history 100


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
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow


netflowNetflow Properties

The following table contains information about the netflowNetflow 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
rtpHistorynetflow:RtpHistory
(scalar:Uint32)		RTP Flow History Size
RANGE: [0 , 5000]
DEFAULT: 1000


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

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