Configuring Event Exporters

Configuring an IPv4 Destination for an Events Exporter

Configuring an IPv4 Destination for an Events Exporter

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "postcard"
          },
          "children": [
            {
              "inbandTelemetryCollector": {
                "attributes": {
                  "dstAddr": "1.2.3.4",
                  "name": "exptr_1",
                  "vrfName": "default"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>postcard</mode>
          <collector-items>
            <TelemetryCollector-list>
              <name>exptr_1</name>
              <dstAddr>1.2.3.4</dstAddr>
              <vrfName>default</vrfName>
            </TelemetryCollector-list>
          </collector-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(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.

hardware-telemetry postcard-telemetry
postcard-telemetry exporter exptr_1
destination 1.2.3.4

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

Deleting the Destination for an Events Exporter

Deleting the Destination for an Events Exporter

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "postcard"
          },
          "children": [
            {
              "inbandTelemetryCollector": {
                "attributes": {
                  "dstAddr": "127.0.0.1",
                  "name": "exptr_1",
                  "vrfName": "default"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>postcard</mode>
          <collector-items>
            <TelemetryCollector-list>
              <name>exptr_1</name>
              <dstAddr>127.0.0.1</dstAddr>
              <vrfName>default</vrfName>
            </TelemetryCollector-list>
          </collector-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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

CLI Commands

hardware-telemetry postcard-telemetry
postcard-telemetry exporter exptr_1
no destination

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 the Destination UDP Port for an Events Exporter

Configuring the Destination UDP Port for an Events Exporter

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "postcard"
          },
          "children": [
            {
              "inbandTelemetryCollector": {
                "attributes": {
                  "dstPort": "30459",
                  "name": "exptr_1",
                  "vrfName": "default"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>postcard</mode>
          <collector-items>
            <TelemetryCollector-list>
              <name>exptr_1</name>
              <dstPort>30459</dstPort>
              <vrfName>default</vrfName>
            </TelemetryCollector-list>
          </collector-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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

CLI Commands

hardware-telemetry postcard-telemetry
postcard-telemetry exporter exptr_1
transport udp 30459

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

Deleting the Destination UDP Port for an Events Exporter

Deleting the Destination UDP Port for an Events Exporter

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

{
  "inbandTelemetryInt": {
    "children": [
      {
        "inbandTelemetryInst": {
          "attributes": {
            "mode": "postcard"
          },
          "children": [
            {
              "inbandTelemetryCollector": {
                "attributes": {
                  "dstPort": "31337",
                  "name": "exptr_1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <hwtelemetry-items>
    <inbandtelemetry-items>
      <inst-items>
        <TelemetryInst-list>
          <mode>postcard</mode>
          <collector-items>
            <TelemetryCollector-list>
              <name>exptr_1</name>
              <dstPort>31337</dstPort>
            </TelemetryCollector-list>
          </collector-items>
        </TelemetryInst-list>
      </inst-items>
    </inbandtelemetry-items>
  </hwtelemetry-items>
</System>

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

CLI Commands

hardware-telemetry postcard-telemetry
postcard-telemetry exporter exptr_1
no transport udp

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