Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Configuring GRPC tunnel destination
DME
YANG
Copy
POST http://<mgmt_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "grpctunnelInst": {
          "children": [
            {
              "grpctunnelTunnelMgr": {
                "children": [
                  {
                    "grpctunnelTunnel": {
                      "attributes": {
                        "cert": "server.trust.point",
                        "certClient": "client.trust.point",
                        "dest": "1.1.1.1",
                        "port": "1111",
                        "srcIf": "lo1",
                        "targetId": "t1111",
                        "targetType": "GNMI_GNOI",
                        "targetVrf": "t-vrf-1001",
                        "vrf": "vrf-0001"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Response
{
    imdata:[]
}

Copy
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
  <grpctunnel-items>
    <tunnelmgr-items>
      <tunnel-items>
        <Tunnel-list>
          <dest>1.1.1.1</dest>
          <port>1111</port>
          <targetId>t1111</targetId>
          <targetType>GNMI_GNOI</targetType>
          <vrf>vrf-0001</vrf>
          <cert>server.trust.point</cert>
          <certClient>client.trust.point</certClient>
          <srcIf>lo1</srcIf>
          <targetVrf>t-vrf-1001</targetVrf>
        </Tunnel-list>
      </tunnel-items>
    </tunnelmgr-items>
  </grpctunnel-items>
</System>

Configuring GRPC tunnel destination

Configuring GRPC tunnel destination

Configuring GRPC tunnel destination


CLI Command

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.

grpctunnel destination <name-or-ip> port <port> target <target-id> type <type> use-vrf <vrf-name> [source-interface <intf-name>] [cert <tunnel server trustpoint>] [client-cert <client trustpoint>] [target-vrf <target-vrf>]

Note: The property information for this example was added in Release 10.3(2)F.


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
Tunnel sys/grpctunnel/tunnelmgr/tunnel-[name-or-ip]-port-[port-num]-target-[target-id]-type-[GNMI_GNOI]-vrf-[vrf-name]


Tunnel Properties

The following table contains information about the tunnel properties. and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeValueDescription
destnaming:NameRange: min="1" max="254"Tunnel server ip address or the hostname
portscalar:Uint1Range : [1-65535]Tunnel server port number
targetIdnaming:NameRange: min="1" max="254"Target ID. This is an opaque string.
targetTypenaming:NameOnly support GNMI_GNOITarget Type
vrfl3:VrfNameRange: min="1" max="32"vrf name to dial out
srcIfnw:IfIdSupported interfaces include loopback and svi interfacessource-interface used to determine the egress source ip address of the tunnel establishment.
certos:OsStringRange: min="0" max="64"Trustpoint which holds the tunnel server certificate.
certClientos:OsStringRange: min="0" max="64"Trustpoint which holds the client certificate.
targetVrfl3:VrfNameRange: min="1" max="32"vrf name to be used to reach local target.


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Next