Configuring Telemetry

This section contains payload examples to demonstrate how to use the NX-API REST API to configure telemetry on the Cisco Nexus 3000 and 9000 Series switches.

Telemetry offers a push model of network monitoring that provides clients with a near-real-time stream of network data.

Enabling the Telemetry Feature

The following steps enable the telemetry feature.

  1. Use GET to check that the NX-API is enabled.
  2. Enable the telemetry feature.
  3. Enable the telemetry configuration.

Step 1

Use GET to check that the NX-API is enabled.

Step 1

GET http://<IP_Address>/api/mo/sys/fm/nxapi.json

{
  "fmNxapi": {
    "attributes": {
      ...
      "adminSt": "enabled"
      ...
}}}

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

Step 2

Enable the Telemetry Feature

Step 2

POST http://<IP_Address>/api/mo/sys/fm/telemetry.json

{
  "fmTelemetry": {
    "attributes": {
      "adminSt": "enabled"
}}}

{
    imdata:[]
}

<System>
  <fm-items>
    <telemetry-items>
      <adminSt>enabled</adminSt>
    </telemetry-items>
  </fm-items>
</System>

This example enables the streaming telemetry feature.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

feature telemetry

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

Step 3

Enable the telemetry configuration.

Step 3

POST http://<IP_Address>/api/mo/sys/tm.json

{
    "telemetryEntity": {
      "attributes": {
        "adminSt": "enabled"
}}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
  </tm-items>
</System>

Enters configuration mode for streaming telemetry.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

telemetry

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 Sensor Groups

This section contains examples that demonstrate how to configure a sensor group.

Creating a Sensor Group

Creating a Sensor Group

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySensorGroup": {
          "attributes": {
            "id": "100"
}}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>100</id>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

Creates a sensor group and enters sensor group configuration mode.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 sensor-group 100

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

Adding a Sensor Group Path

Adding a Sensor Group Path

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySensorGroup": {
          "attributes": {
            "id": "100"
          },
          "children": [
            {
              "telemetrySensorPath": {
                "attributes": {
                  "depth": "0",
                  "filterCondition": "",
                  "path": "sys/bgp",
                  "queryCondition": ""
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>100</id>
        <path-items>
          <SensorPath-list>
            <path>sys/bgp</path>
            <depth>0</depth>
            <filterCondition></filterCondition>
            <queryCondition></queryCondition>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

Adds a sensor path to the sensor group. The depth setting specifies the retrieval level for the sensor path. A depth setting of 0, the only supported setting, retrieves only the root MO properties. The optional filter-condition parameter can be specified to create a specific filter for event-based subscriptions.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 sensor-group 100
  path sys/bgp depth 0

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 Intended Data Depth in Streaming Telemetry

Configuring Intended Data Depth in Streaming Telemetry

POST http://<IP_Address>/api/mo/sys/tm/sensor-10/path-[sys/bgp/inst/dom-default/af-ipv4-ucast].depth=3.json

{
  "telemetryEntity": {
    "attributes": {

    },
    "children": [
      {
        "telemetrySensorGroup": {
          "attributes": {
            "id": "10"
          },
          "children": [
            {
              "telemetrySensorPath": {
                "attributes": {
                  "depth": "3",
                  "path": "sys/bgp/inst/dom-default/af-ipv4-ucast",
}}]}}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>10</id>
        <path-items>
          <SensorPath-list>
            <path>sys/bgp</path>
            <depth>3</depth>
            <filterCondition></filterCondition>
            <queryCondition></queryCondition>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

Note: This is an existing command with newly allowed depth values. Unbounded in Release 7.0.3.6(1), the value could only be 0 or 1. Beginning in Release 7.0.3.7(1), the value can be either from 0 up to 32 or the special value unbounded. The command indicates the number of child levels to retrieve given a MO.

Note: This example was added in Release 7.0(3)I7(1).


CLI Commands

The CLI commands and options are equivalent to the payload example displayed in the pane on the right.

telemetry
 sensor-group 10
  path sys/bgp depth 3

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

Streaming Foreign Data from as Part of Streaming Telemetry

Streaming Foreign Data from as Part of Streaming Telemetry

POST http://<IP_Address>/api/mo/sys/tm/sensor-[10]/path-[sys/bgp/inst/dom-default/af-ipv4-ucast].queryCondition=<rsp-foreign-subtree=ephemeral>.json

{
  "telemetryEntity": {
    "attributes": {

    },
    "children": [
      {
        "telemetrySensorGroup": {
          "attributes": {
            "id": "10"
          },
          "children": [
            {
              "telemetrySensorPath": {
                "attributes": {
                  "path": "sys/bgp/inst/dom-default/af-ipv4-ucast",
                  "queryCondition": "rsp-foreign-subtree=ephemeral "

}}]}}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>10</id>
        <path-items>
          <SensorPath-list>
            <path>sys/bgp/inst/dom-default/af-ipv4-ucast</path>
            <depth>3</depth>
            <filterCondition></filterCondition>
            <queryCondition>rsp-foreign-subtree=applied-config</queryCondition>
          </SensorPath-list>
          <SensorPath-list>
            <path>sys/bgp/inst/dom-default/af-[l2vpn-evpn]</path>
            <depth>1</depth>
            <filterCondition></filterCondition>
            <queryCondition>rsp-foreign-subtree=ephemeral</queryCondition>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

The query-condition option takes rsp-foreign-subtree=applied-config and rsp-foreign-subtree=ephemeral; it indicates whether to look up an applied configuration or an ephemeral MO.

Note: This example was added in Release 7.0(3)I7(1).


CLI Commands

The CLI commands and options are equivalent to the payload example displayed in the pane on the right.

telemetry
 sensor-group 10
  path sys/bgp/inst/dom-default/af-ipv4-ucast depth 3 query-condition rsp-foreign-subtree=applied-config
  path sys/bgp/inst/dom-default/af-[l2vpn-evpn] depth 1 query-condition rsp-foreign-subtree=ephemeral

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 Destination Groups

The destination group specifies the destination address, port, encoding and transport that the router uses to send out telemetry data.

This section contains payload examples and CLIs to demonstrate many of the destination group configuration options and to show how the REST APIs correspond to the CLI commands.

Adding a Destination Group

Adding a Destination Group

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetryDestGroup": {
          "attributes": {
            "id": "100"
}}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>100</id>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

Creates a destination group with ID destination_group_ID and enters destination group configuration mode. Currently only numeric ID values are supported.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 destination-group 100

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 the HTTP Protocol for a Destination Group

Configuring the HTTP Protocol for a Destination Group

POST http://<mgmt0_IP>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetryDestGroup": {
          "attributes": {
            "id": "100"
          },
          "children": [
            {
              "telemetryDest": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "enc": "JSON",
                  "port": "50008",
                  "proto": "HTTP"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>100</id>
        <addr-items>
          <Dest-list>
            <addr>1.2.3.4</addr>
            <port>50008</port>
            <enc>JSON</enc>
            <proto>HTTP</proto>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

Configures the HTTP Protocol for a Destination Group

Note: This example was added in Release 7.0(3)I7(1).


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.

telemetry
 destination-group 100
  ip address 1.2.3.4 port 50008 protocol http encoding json

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 the UDP Protocol for a Destination Group

Configuring the UDP Protocol for a Destination Group

POST http://<mgmt0_IP>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetryDestGroup": {
          "attributes": {
            "id": "100"
          },
          "children": [
            {
              "telemetryDest": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "enc": "JSON",
                  "port": "50008",
                  "proto": "UDP"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>100</id>
        <addr-items>
          <Dest-list>
            <addr>1.2.3.4</addr>
            <port>50008</port>
            <enc>JSON</enc>
            <proto>UDP</proto>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

Configures the UDP Protocol for a Destination Group

Note: This example was added in Release 7.0(3)I7(1).


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.

telemetry
 destination-group 100
  ip address 1.2.3.4 port 50008 protocol udp encoding json

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

Creating a Destination Profile for Outgoing Data

Creating a Destination Profile for Outgoing Data

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetryDestGroup": {
          "attributes": {
            "id": "100"
          },
          "children": [
            {
              "telemetryDest": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "port": "50003"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>100</id>
        <addr-items>
          <Dest-list>
            <addr>1.2.3.4</addr>
            <port>50003</port>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

Configures telemetry to send data to a destination IP address. You can specify transporting the data using the Google remote procedure call (gRPC) protocol, and to encode the data using Google Protocol Buffers (GPB) format.

Note: This example was added in Release 7.0(3)I7(1).


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 destination-group 100
  ip address 1.2.3.4 port 50003

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 a Subscription

This section contains payload examples and CLIs to demonstrate many of the subscription configuration options and to show how the REST APIs correspond to the CLI commands.

Creating a Subscription Node

Creating a Subscription Node

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySubscription": {
          "attributes": {
            "id": "100"
}}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <subs-items>
      <Subscription-list>
        <id>100</id>
      </Subscription-list>
    </subs-items>
  </tm-items>
</System>

Creates a subscription node with ID sub_id and enters the subscription configuration mode. Currently only numeric ID values are supported.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 subscription 100

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 a Subscription Sensor Group

Configuring a Subscription Sensor Group

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySubscription": {
          "attributes": {
            "id": "100"
          },
          "children": [
            {
              "telemetryRsSensorGroupRel": {
                "attributes": {
                  "sampleIntvl": "15000",
                  "tDn": "sys/tm/sensor-100"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <subs-items>
      <Subscription-list>
        <id>100</id>
      </Subscription-list>
    </subs-items>
  </tm-items>
</System>

Links the sensor group with ID sensor_group_ID to this subscription and also sets the data sampling interval in milliseconds. An interval value of 0 creates an event-based subscription, in which telemetry data is sent only upon changes under the specified MO. An interval value greater than 0 creates a frequency-based subscription, in which telemetry data is sent periodically at the specified interval. For example, an interval value of 15000 results in the sending of telemetry data every 15 seconds.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 subscription 100
  snsr-grp 100 sample-interval 1500

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 a Subscription Destination Group

Configuring a Subscription Destination Group

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySubscription": {
          "attributes": {
            "id": "100"
          },
          "children": [
            {
              "telemetryRsDestGroupRel": {
                "attributes": {
                  "tDn": "sys/tm/dest-100"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <subs-items>
      <Subscription-list>
        <id>100</id>
        <rsdestGroupRel-items>
          <RsDestGroupRel-list>
            <tDn>/System/tm-items/dest-items/DestGroup-list[id='100']</tDn>
          </RsDestGroupRel-list>
        </rsdestGroupRel-items>
      </Subscription-list>
    </subs-items>
  </tm-items>
</System>

Links the destination group with ID destination_group_ID to this subscription.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 subscription 100
  sdst-grp 100

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 a Subscription for Event Notification Without Filter Conditions

Configuring a Subscription for Event Notification Without Filter Conditions

POST http://<IP_Address>/api/mo/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySensorGroup": {
          "attributes": {
            "id": "10"
          },
          "children": [
            {
              "telemetrySensorPath": {
                "attributes": {
                  "depth": "0",
                  "filterCondition": "",
                  "path": "sys/fm/bgp",
                  "queryCondition": ""
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>10</id>
        <path-items>
          <SensorPath-list>
            <path>sys/fm/bgp</path>
            <depth>0</depth>
            <filterCondition></filterCondition>
            <queryCondition></queryCondition>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

The following example shows how to subscribe to notifications for when BGP is enabled or disabled using the path attribute.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 subscription 100
  path sys/fm/bgp depth 0

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 a Subscription for Event Notifications with Filter Conditions

Configuring a Subscription for Event Notifications with Filter Conditions

POST http://<IP_Address>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetrySensorGroup": {
          "attributes": {
            "id": "10"
          },
          "children": [
            {
              "telemetrySensorPath": {
                "attributes": {
                  "depth": "0",
                  "filterCondition": "eq(fmBgp.operSt,\\\"disabled\\\")",
                  "path": "sys/fm/bgp",
                  "queryCondition": ""
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>10</id>
        <path-items>
          <SensorPath-list>
            <path>sys/fm/bgp</path>
            <depth>0</depth>
            <filterCondition>eq(fmBgp.operSt,\"disabled\")</filterCondition>
            <queryCondition></queryCondition>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

The following example will only generate notifications for BGP when BGP is disabled using the path attribute. The DME provides the filter expressions for the filterCondition attribute.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

telemetry
 subscription 100
  path sys/fm/bgp depth 0 filter-condition eq(fmBgp.operSt,\"disabled\")

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 Destination Profiles

This section contains payload examples and CLIs to demonstrate many of the destination profile configuration options and to show how the REST APIs correspond to the CLI commands.

Configuring the Default Destination Profile

Configuring the Default Destination Profile

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).


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.

telemetry
 destination-profile

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 the Default Destination Profile

Disabling the Default Destination Profile

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items xc:operation="delete">
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).


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.

telemetry
 no destination-profile

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 the Destination VRF for a Destination Profile

Configuring the Destination VRF for a Destination Profile

POST http://<mgmt0_IP>/api/mo/sys/tm.json

{
  "telemetryEntity": {
    "attributes": {
      "adminSt": "enabled"
    },
    "children": [
      {
        "telemetryDestProfile": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestOptVrf": {
                "attributes": {
                  "name": "default"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <vrf-items>
        <name>default</name>
      </vrf-items>
    </destprof-items>
  </tm-items>
</System>

Configures the destination VRF for a destination profile.

Note: This example was added in Release 7.0(3)I7(1).


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.

telemetry
 destination-profile
  use-vrf default

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 the Destination VRF for a Destination Profile

Disabling the Destination VRF for a Destination Profile

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptVrf": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <vrf-items xc:operation="delete">
      </vrf-items>
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).


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.

telemetry
 destination-profile
  no use-vrf

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

Enabling Gzip Compression for a Destination Profile

Enabling Gzip Compression for a Destination Profile

POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptCompression": {
                      "attributes": {
                        "name": "gzip"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <compression-items>
        <name>gzip</name>
      </compression-items>
    </destprof-items>
  </tm-items>
</System>

Enables gzip compression.

Note: This example was added in Release 7.0(3)I7(1).


CLI Commands

The CLI commands and options are equivalent to the payload example displayed in the pane on the right.

telemetry
 destination-profile
  use-compression gzip

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 Gzip Compression for a Destination Profile

Disabling Gzip Compression for a Destination Profile

POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptCompression": {
                      "attributes": {
                        "status": "deleted"

}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <compression-items xc:operation="delete">
      </compression-items>
    </destprof-items>
  </tm-items>
</System>

Disables gzip compression.

Note: This example was added in Release 7.0(3)I7(1).


CLI Commands

The CLI commands and options are equivalent to the payload example displayed in the pane on the right.

telemetry
 destination-profile
  no use-compression gzip

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 an IPv6 Address Under a Telemetry Destination Group

Configuring an IPv6 Address Under a Telemetry Destination Group

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestGroup": {
                "attributes": {
                  "id": "1"
                },
                "children": [
                  {
                    "telemetryDest": {
                      "attributes": {
                        "addr": "1:1::1:1",
                        "enc": "GPB",
                        "port": "50001",
                        "proto": "gRPC"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>1</id>
        <addr-items>
          <Dest-list>
            <addr>1:1::1:1</addr>
            <port>50001</port>
            <enc>GPB</enc>
            <proto>gRPC</proto>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

The format options include:

  • UDP
  • gRPC
  • HTTP
  • GPB
  • JSON

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-group 123
  ip address 1.2.3.4 port 123 protocol udp encoding GPB

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/media/dme/index.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

Deleting an IPv6 Address Under a Telemetry Destination Group

Deleting an IPv6 Address Under a Telemetry Destination Group

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestGroup": {
                "attributes": {
                  "id": "1"
                },
                "children": [
                  {
                    "telemetryDest": {
                      "attributes": {
                        "addr": "1:1::1:1",
                        "port": "50001",
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>1</id>
        <addr-items>
          <Dest-list xc:operation="delete">
            <addr>1:1::1:1</addr>
            <port>50001</port>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

The format options include:

  • UDP
  • gRPC
  • HTTP
  • GPB
  • JSON

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-group 123
  no ip address 1.2.3.4 port 123 protocol udp encoding json

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/media/dme/index.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

Configuring the Encoding Format (Under a Telemetry Destination-Group)

Configuring the Encoding Format (Under a Telemetry Destination-Group)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestGroup": {
                "attributes": {
                  "id": "123"
                },
                "children": [
                  {
                    "telemetryDest": {
                      "attributes": {
                        "addr": "1:2::3:4",
                        "enc": "JSON",
                        "port": "123",
                        "proto": "UDP"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>123</id>
        <addr-items>
          <Dest-list>
            <addr>1:2::3:4</addr>
            <port>123</port>
            <enc>JSON</enc>
            <proto>UDP</proto>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

The format options include:

  • UDP

  • gRPC

  • HTTP
  • GPB
  • JSON

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-group 123
  ipv6 address 1:2::3:4 port 123 protocol udp encoding json

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/media/dme/index.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

Deleting the Encoding Format (Under a Telemetry Destination-Group)

Deleting the Encoding Format (Under a Telemetry Destination-Group)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestGroup": {
                "attributes": {
                  "id": "123"
                },
                "children": [
                  {
                    "telemetryDest": {
                      "attributes": {
                        "addr": "1:2::3:4",
                        "port": "123",
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>123</id>
        <addr-items>
          <Dest-list xc:operation="delete">
            <addr>1:2::3:4</addr>
            <port>123</port>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

The format options include:

  • UDP
  • gRPC
  • HTTP
  • GPB
  • JSON

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-group 123
  no ipv6 address 1:2::3:4 port 123 protocol udp encoding json

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/media/dme/index.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

Enabling Chunking

Enabling Chunking

POST http://<mgmt0_IP>/api/mo/sys.json


  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestGroup": {
                "attributes": {
                  "id": "1"
                },
                "children": [
                  {
                    "telemetryDestGrpOptChunking": {
                      "attributes": {
                        "chunkSize": "4096"
                      }
                    }
                  },
                  {
                    "telemetryDest": {
                      "attributes": {
                        "addr": "171.68.197.40",
                        "enc": "GPB",
                        "port": "50051",
                        "proto": "gRPC"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>1</id>
        <chunking-items>
          <chunkSize>4096</chunkSize>
        </chunking-items>
        <addr-items>
          <Dest-list>
            <addr>171.68.197.40</addr>
            <port>50051</port>
            <enc>GPB</enc>
            <proto>gRPC</proto>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-group 1
  ip address 171.68.197.40 port 50051 protocol gRPC encoding GPB
  use-chunking size 4096

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/media/dme/index.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

Disabling Chunking

Disabling Chunking

POST http://<mgmt0_IP>/api/mo/sys.json


{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestGroup": {
                "attributes": {
                  "id": "1"
                },
                "children": [
                  {
                    "telemetryDestGrpOptChunking": {
                      "attributes": {
                        "status": "deleted"
                      }
                    }
                  },
                  {
                    "telemetryDest": {
                      "attributes": {
                        "addr": "171.68.197.40",
                        "enc": "GPB",
                        "port": "50051",
                        "proto": "gRPC"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <dest-items>
      <DestGroup-list>
        <id>1</id>
        <chunking-items xc:operation="delete">
        </chunking-items>
        <addr-items>
          <Dest-list>
            <addr>171.68.197.40</addr>
            <port>50051</port>
            <enc>GPB</enc>
            <proto>gRPC</proto>
          </Dest-list>
        </addr-items>
      </DestGroup-list>
    </dest-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-group 1
  ip address 171.68.197.40 port 50051 protocol gRPC encoding GPB
  no use-chunking

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/media/dme/index.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

Configuring the Retry Buffer Size (Under a Telemetry Destination-Group)

Configuring the Retry Buffer Size (Under a Telemetry Destination-Group)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptRetry": {
                      "attributes": {
                        "size": "123"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <retry-items>
        <size>123</size>
      </retry-items>
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-profile
  use-retry size 123

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/media/dme/index.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

Deleting the Retry Buffer Size (Under a Telemetry Destination-Group)

Deleting the Retry Buffer Size (Under a Telemetry Destination-Group)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptRetry": {
                      "attributes": {
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <retry-items xc:operation="delete">
      </retry-items>
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-profile
  no use-retry

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/media/dme/index.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

Configuring the Default Destination Profile

Configuring the Default Destination Profile

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptSourceInterface": {
                      "attributes": {
                        "name": "lo0"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <sourceinterface-items>
        <name>lo0</name>
      </sourceinterface-items>
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-profile
  source-interface loopback0

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/media/dme/index.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

Deleting the Default Destination Profile

Deleting the Default Destination Profile

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetryDestProfile": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "telemetryDestOptSourceInterface": {
                      "attributes": {
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <destprof-items>
      <adminSt>enabled</adminSt>
      <sourceinterface-items xc:operation="delete">
      </sourceinterface-items>
    </destprof-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 destination-profile
  source-interface loopback0

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/media/dme/index.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

Configuring the Data Source

Configuring the Data Source

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetrySensorGroup": {
                "attributes": {
                  "dataSrc": "YANG",
                  "id": "1"
                },
                "children": [
                  {
                    "telemetrySensorPath": {
                      "attributes": {
                        "depth": "0",
                        "filterCondition": "",
                        "path": "Cisco-NX-OS-device:System/intf-items",
                        "queryCondition": ""
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>1</id>
        <dataSrc>YANG</dataSrc>
        <path-items>
          <SensorPath-list>
            <path>Cisco-NX-OS-device:System/intf-items</path>
            <depth>0</depth>
            <filterCondition></filterCondition>
            <queryCondition></queryCondition>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 sensor-group 1
  data-source YANG
  path Cisco-NX-OS-device:System/intf-items

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/media/dme/index.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

Deleting the Data Source

Deleting the Data Source

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "telemetryEntity": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "telemetrySensorGroup": {
                "attributes": {
                  "dataSrc": "YANG",
                  "id": "1"
                },
                "children": [
                  {
                    "telemetrySensorPath": {
                      "attributes": {
                        "path": "Cisco-NX-OS-device:System/intf-items",
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <tm-items>
    <adminSt>enabled</adminSt>
    <sensor-items>
      <SensorGroup-list>
        <id>1</id>
        <dataSrc>YANG</dataSrc>
        <path-items>
          <SensorPath-list xc:operation="delete">
            <path>Cisco-NX-OS-device:System/intf-items</path>
          </SensorPath-list>
        </path-items>
      </SensorGroup-list>
    </sensor-items>
  </tm-items>
</System>

Note: This example was added in Release 9.1(2).


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.

telemetry
 sensor-group 1
  data-source YANG
  no path Cisco-NX-OS-device:System/intf-items

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/media/dme/index.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