OC Telemetry

Package: openconfig-telemetry.yang

Creating a Sensor Group

Creating a Sensor Group
Payload
----------
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
        <sensor-groups>
          <sensor-group>
            <sensor-group-id>1</sensor-group-id>
            <sensor-paths>
              <sensor-path>
                <path>openconfig-network-instance:network-instances/network-instance/interfaces/interface/state</path>
              </sensor-path>
            </sensor-paths>
          </sensor-group>
        </sensor-groups>
      </telemetry-system>
    </config>
  </edit-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <ok/>
</rpc-reply>

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


CLI Commands

telemetry
 sensor-group 1
  path openconfig-network-instance:network-instances/network-instance/interfaces/interface/state

Deleting a Sensor Group

Deleting a Sensor Group
Payload
----------
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
        <sensor-groups>
          <sensor-group xc:operation="remove">
            <sensor-group-id>1</sensor-group-id>
          </sensor-group>
        </sensor-groups>
      </telemetry-system>
    </config>
  </edit-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <ok/>
</rpc-reply>

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


CLI Commands

telemetry
 no sensor-group 1

Creating a Destination Group

Creating a Destination Group
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
        <destination-groups>
          <destination-group>
            <group-id>1</group-id>
            <destinations>
              <destination>
                <destination-address>1.1.1.1</destination-address>
                <destination-port>22222</destination-port>
              </destination>
            </destinations>
          </destination-group>
        </destination-groups>
      </telemetry-system>
    </config>
  </edit-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <ok/>
</rpc-reply>


CLI Commands

telemetry
 destination-group 1
  ip address 1.1.1.1 port 22222

Deleting a Destination Group

Deleting a Destination Group
Payload
----------
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
        <destination-groups>
          <destination-group xc:operation="remove">
            <group-id>1</group-id>
          </destination-group>
        </destination-groups>
      </telemetry-system>
    </config>
  </edit-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <ok/>
</rpc-reply>


CLI Commands

telemetry
 no destination-group 1

Creating a Subscription

Creating a Subscription
Payload
----------
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
      <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
        <subscriptions>
          <persistent-subscriptions>
            <persistent-subscription>
              <name>1</name>
              <destination-groups>
                <destination-group>
                  <group-id>1</group-id>
                </destination-group>
              </destination-groups>
              <sensor-profiles>
                <sensor-profile>
                  <sensor-group>1</sensor-group>
                  <config>
                    <sample-interval>30000</sample-interval>
                  </config>
                </sensor-profile>
              </sensor-profiles>
            </persistent-subscription>
          </persistent-subscriptions>
        </subscriptions>
      </telemetry-system>
    </config>
  </edit-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <ok/>
</rpc-reply>


CLI Commands
telemetry
 subscription 1
  dst-grp 1
  snsr-grp 1 sample-interval 30000

Deleting a Subscription

Deleting a Subscription
Payload
----------
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
        <subscriptions>
          <persistent-subscriptions>
            <persistent-subscription xc:operation="remove">
              <name>1</name>
            </persistent-subscription>
          </persistent-subscriptions>
        </subscriptions>
      </telemetry-system>
    </config>
  </edit-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <ok/>
</rpc-reply>


CLI Commands

telemetry
 no subscription 1

Querying the Telemetry Configuration

Querying the Telemetry Configuration
Payload
----------
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <get-config>
      <source>
        <running/>
      </source>
      <filter>
          <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
          </telemetry-system>
      </filter>
  </get-config>
</nc:rpc>

Response
----------
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
  <data>
    <telemetry-system xmlns="http://openconfig.net/yang/telemetry">
      <destination-groups>
        <destination-group>
          <group-id>1</group-id>
          <config>
            <group-id>1</group-id>
          </config>
          <destinations>
            <destination>
              <destination-address>1.1.1.1</destination-address>
              <destination-port>22222</destination-port>
              <config>
                <destination-address>1.1.1.1</destination-address>
                <destination-port>22222</destination-port>
              </config>
            </destination>
          </destinations>
        </destination-group>
      </destination-groups>
      <sensor-groups>
        <sensor-group>
          <sensor-group-id>1</sensor-group-id>
          <config>
            <sensor-group-id>1</sensor-group-id>
          </config>
          <sensor-paths>
            <sensor-path>
              <path>openconfig-network-instance:network-instances/network-instance/interfaces/interface/state</path>
              <config>
                <path>openconfig-network-instance:network-instances/network-instance/interfaces/interface/state</path>
              </config>
            </sensor-path>
          </sensor-paths>
        </sensor-group>
      </sensor-groups>
      <subscriptions>
        <persistent-subscriptions>
          <persistent-subscription>
            <name>1</name>
            <config>
              <name>1</name>
            </config>
            <destination-groups>
              <destination-group>
                <group-id>1</group-id>
                <config>
                  <group-id>1</group-id>
                </config>
              </destination-group>
            </destination-groups>
            <sensor-profiles>
              <sensor-profile>
                <sensor-group>1</sensor-group>
                <config>
                  <sensor-group>1</sensor-group>
                  <sample-interval>30000</sample-interval>
                </config>
              </sensor-profile>
            </sensor-profiles>
          </persistent-subscription>
        </persistent-subscriptions>
      </subscriptions>
    </telemetry-system>
  </data>
</rpc-reply>


CLI Commands

CLI Output
Switch# show run telemetry
!Command: show running-config telemetry
!Running configuration last done at: Fri Dec 13 18:38:20 2019
!Time: Fri Dec 13 18:38:57 2019


version 9.3(3) Bios:version 07.66
feature telemetry


telemetry
  destination-group 1
    ip address 1.1.1.1 port 22222 protocol gRPC encoding GPB
  sensor-group 1
    data-source YANG
    path openconfig-network-instance:network-instances/network-instance/interfaces/interface/state
  subscription 1
    dst-grp 1
    snsr-grp 1 sample-interval 30000