Configuring Records

Configuring an Inband Network Telemetry Record

Configuring an Inband Network Telemetry Record

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "name": "record_1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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.

hardware-telemetry inband-telemetry
inband-telemetry record record_1

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

Deleting an Inband Network Telemetry Record

Deleting an Inband Network Telemetry Record

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "name": "record_1",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list xc:operation="delete">
              <name>record_1</name>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

CLI Commands

hardware-telemetry inband-telemetry
no inband-telemetry record record_1

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

Configuring Port Id Collection for a Record

Configuring Port Id Collection for a Record

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "port-id",
                  "name": "record_1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>port-id</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
collect port-id

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

Deleting Port Id Collection for a Record

Deleting Port Id Collection for a Record

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "switch-id",
                  "name": "record_1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>switch-id</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
no collect port-id

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference:
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 Queue Occupancy Collection for a Record

Configuring Queue Occupancy Collection for a Record

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "queue-occupancy",
                  "name": "record_1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>queue-occupancy</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
collect queue-occupancy

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

Deleting Queue Occupancy Collection for a Record

Deleting Queue Occupancy Collection for a Record

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

            {
              "inbandTelemetryInt": {
                "children": [
                  {
                    "inbandTelemetryInst": {
                      "attributes": {
                        "mode": "inbandtelemetry"
                      },
                      "children": [
                        {
                          "inbandTelemetryRecordP": {
                            "attributes": {
                              "collect0": "switch-id",
                              "name": "record_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>switch-id</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(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 opt-left corner of the pane on the right to view the JSON payload. Click the YANG tab to view the XML payload.

hardware-telemetry inband-telemetry
inband-telemetry record record_1
no collect queue-occupancy

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

For detailed information about classes and attributes in the payloads, see the NX-API DME Model Reference:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

Configuring Ingress Timestamp Collection

Configuring Ingress Timestamp Collection

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "ingress-ts",
                  "name": "record_1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>ingress-ts</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
collect ingress-timestamp

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

Deleting Ingress Timestamp Collection

Deleting Ingress Timestamp Collection

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "switch-id",
                  "name": "record_1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>switch-id</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
no collect ingress-timestamp

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference:
https://developer.cisco.com/media/dme/index.html

Configuring Egress Timestamp Collection

Configuring Egress Timestamp Collection

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "egress-ts",
                  "name": "record_1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>egress-ts</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
collect egress-timestamp

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

Deleting Egress Timestamp Collection

Deleting Egress Timestamp Collection

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "inbandtelemetry"
          },
          "children": [
            {
              "inbandTelemetryRecordP": {
                "attributes": {
                  "collect0": "switch-id",
                  "name": "record_1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>inbandtelemetry</mode>
          <recordp-items>
            <TelemetryRecordP-list>
              <name>record_1</name>
              <collect0>switch-id</collect0>
            </TelemetryRecordP-list>
          </recordp-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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

CLI Commands

hardware-telemetry inband-telemetry
inband-telemetry record record_1
no collect egress-timestamp

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference:
https://developer.cisco.com/media/dme/index.html