Configuring VXLAN OAM (NGOAM)

The VXLAN operations, administration, and maintenance (OAM) protocol is a protocol for installing, monitoring, and troubleshooting Ethernet networks to enhance management in VXLAN based overlay networks.

Cisco Nexus 3500 Series switches do not support VXLAN OAM on Cisco NX-OS Release 7.0(3)I7(2) and the previous releases.

Similar to ping, traceroute, or pathtrace utilities that allow quick determination of the problems in the IP networks, equivalent troubleshooting tools have been introduced to diagnose the problems in the VXLAN networks. The VXLAN OAM tools, for example, ping, pathtrace, and traceroute provide the reachability information to the hosts and the VTEPs in a VXLAN network. The OAM channel is used to identify the type of the VXLAN payload that is present in these OAM packets.

There are two types of payloads supported:

Conventional ICMP packet to the destination to be tracked
Special NVO3 draft Tissa OAM header that carries useful information

The ICMP channel helps to reach the traditional hosts or switches that do not support the new OAM packet formats. The NVO3 draft Tissa channels helps to reach the supported hosts or switches and carries the important diagnostic information. The VXLAN NVO3 draft Tissa OAM messages may be identified via the reserved OAM EtherType or by using a well-known reserved source MAC address in the OAM packets depending on the implementation on different platforms. This constitutes a signature for recognition of the VXLAN OAM packets.

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure VXLAN OAM on Cisco Nexus 3000 and 9000 Series switches and to show how the REST APIs correspond to the CLI commands. For more information, see the Cisco Nexus 9000 Series NX-OS VXLAN Configuration Guide, Release 7.x.

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

Enabling NGOAM

Enabling NGOAM

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

{
  "fmEntity": {
    "children": [
      {
        "fmNgoam": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}

{
    imdata:[]
}

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

Before you can use the NX-API REST NGOAM configuration APIs, you must enable NGOAM on the switch.

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

CLI Commands

The CLI commands and options listed below are the 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.

feature ngoam

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 NGOAM OAM Profile

Configuring an NGOAM OAM Profile

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

{
"ngoamEntity": {
  "children": [
    {
      "ngoamProfile": {
        "attributes": {
          "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2

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/

A Description of the NGOAM Profile

A Description of the NGOPAM Profile

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "desc": "This is an NGOAM profile",
            "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <desc>This is an NGOAM profile</desc>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
description This is an NGOAM 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/

Encapsulating dot1q

Encapsulating dot1q

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "dot1q": "123",
            "dot1qIf": "eth1/1",
            "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <dot1q>123</dot1q>
        <dot1qIf>eth1/1</dot1qIf>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
dot1q 123 ethernet1/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/site/nx-os/docs/nexus-model-reference/

Configuring the NGOAM Hop Count

Configuring the NGOAM Hop Count

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "hop": "23",
            "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <hop>23</hop>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
hop 23

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/

Configuring the NGOAM Egress Interface

Configuring the NGOAM Egress Interface

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "interface": "Ethernet1/1",
            "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <interface>Ethernet1/1</interface>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
interface ethernet1/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/site/nx-os/docs/nexus-model-reference/

Specifying the OAM-Channel

Specifying the OAM-Channel

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "oamChannel": "tissa",
            "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <oamChannel>tissa</oamChannel>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
oam-channel 2

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/

Configuring the NGOAM Payload

Configuring the NGOAM Payload

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "payloadPad": "0x0",
            "profId": "2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <payloadPad>0x0</payloadPad>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
payload pad 0x0

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/

Configuring NGOAM UDP Source Port Range

Configuring NGOAM UDP Source Port Range

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2",
            "srcPort": "1-4"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <srcPort>1-4</srcPort>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
sport 1-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

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/

Configuring NGOAM Flow Forward

Configuring NGOAM Flow Forward

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward

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/

Specifying a Flow Profile to Include a dot1q Tag

Specifying a Flow Profile to Include a dot1q Tag

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "dot1q": "123",
                  "forward": "yes"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <dot1q>123</dot1q>
          <forward>true</forward>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
dot1q 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/site/nx-os/docs/nexus-model-reference/

Specifying a Flow IPv4 Destination Address

Specifying a Flow IPv4 Destination Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "ipDest": "1.2.3.4"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <ipDest>1.2.3.4</ipDest>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
ip 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

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/

Specifying the Flow Source IPv4 Address

Specifying the Flow Source IPv4 Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "ipSrc": "1.2.3.4"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <ipSrc>1.2.3.4</ipSrc>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
ip source 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

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/

Specifying a Flow IPv6 Destination Address

Specifying a Flow IPv6 Destination Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "ipv6Dest": "1:2::3:4"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <ipv6Dest>1:2::3:4</ipv6Dest>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
ipv6 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

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/

Specifying the Flow Source IPv6 Address

Specifying the Flow Source IPv6 Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "ipv6Src": "1:2::3:4"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <ipv6Src>1:2::3:4</ipv6Src>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
ipv6 source 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

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/

Specifying the Flow Destination MAC Address

Specifying the Flow Destination MAC Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "macDest": "00:01:00:02:00:03"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <macDest>00:01:00:02:00:03</macDest>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
mac-address destination 1.2.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/

Specifying the Flow Source MAC Address

Specifying the Flow Source MAC Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "macSrc": "00:01:00:02:00:03"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <macSrc>00:01:00:02:00:03</macSrc>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
mac-address source 1.2.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/

Specifying the Flow Destination Port Address

Specifying the Flow Destination Port Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "portDest": "123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <portDest>123</portDest>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
port destination 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/site/nx-os/docs/nexus-model-reference/

Specifying the Flow Source Port Address

Specifying the Flow Source Port Address

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "portSrc": "123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <portSrc>123</portSrc>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
port source 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/site/nx-os/docs/nexus-model-reference/

Specifying the Flow Protocol Number

Specifying the Flow Protocol Number

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamProfile": {
          "attributes": {
            "profId": "2"
          },
          "children": [
            {
              "ngoamFlowFwd": {
                "attributes": {
                  "forward": "yes",
                  "protocol": "123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
          <protocol>123</protocol>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
protocol 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/site/nx-os/docs/nexus-model-reference/

Configuring an NGOAM OAM Connectivity Check

Configuring an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-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.

ngoam connect-check 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/site/nx-os/docs/nexus-model-reference/

Deleting an NGOAM OAM Connectivity Check

Deleting an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list xc:operation="delete">
        <ccId>123</ccId>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

no ngoam connect-check 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/site/nx-os/docs/nexus-model-reference/

Configuring Destination and Source MAC Addresses on an NGOAM Payload

Configuring Destination and Source MAC Addresses on an NGOAM Payload

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_dot1q": "123",
            "payload_dstmac": "00:01:00:02:00:03",
            "payload_srcmac": "00:03:00:02:00:01"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_dot1q>123</payload_dot1q>
        <payload_dstmac>00:01:00:02:00:03</payload_dstmac>
        <payload_srcmac>00:03:00:02:00:01</payload_srcmac>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
payload
mac-addr 1.2.3 3.2.1 dot1q 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/site/nx-os/docs/nexus-model-reference/

Configuring Destination and Source Ports on an NGOAM Payload

Configuring Destination and Source Ports on an NGOAM Payload

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_dstport": "321",
            "payload_srcport": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_dstport>321</payload_dstport>
        <payload_srcport>123</payload_srcport>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
payload
port 123 321

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/

Configuring an IANA Protocol ID on an NGOAM Payload

Configuring an IANA Protocol ID on an NGOAM Payload

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_protocol": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_protocol>123</payload_protocol>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
payload
proto 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/site/nx-os/docs/nexus-model-reference/

Configuring an Interface on Which the Host with the Source IP of the Payload is Connected

Configuring an Interface on Which the Host with the Source IP of the Payload is Connected

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_srcif": "eth1/2"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_srcif>eth1/2</payload_srcif>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
payload
src-intf ethernet 1/2

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/

Configuring Destination and Source IPs on an NGOAM Payload

Configuring Destination and Source IPs on an NGOAM Payload

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_dstip": "1.2.3.4",
            "payload_srcip": "4.3.2.1"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_dstip>1.2.3.4</payload_dstip>
        <payload_srcip>4.3.2.1</payload_srcip>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
payload
ip 1.2.3.4 4.3.2.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/site/nx-os/docs/nexus-model-reference/

Configuring Destination and Source IPv6 Addresses on an NGOAM Payload

Configuring Destination and Source IPv6 Addresses on an NGOAM Payload

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_dstipv6": "1:2::3:4",
            "payload_srcipv6": "4:3::2:1"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_dstipv6>1:2::3:4</payload_dstipv6>
        <payload_srcipv6>4:3::2:1</payload_srcipv6>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
payload
ipv6 1:2::3:4 4:3::2: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/site/nx-os/docs/nexus-model-reference/

Deleting an NGOAM Payload on an NGOAM OAM Connectivity Check

Deleting an NGOAM Payload on an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "payload_dot1q": "0",
            "payload_dstip": "0.0.0.0",
            "payload_dstipv6": "",
            "payload_dstmac": "00:00:00:00:00:00",
            "payload_dstport": "0",
            "payload_protocol": "0",
            "payload_srcif": "unspecified",
            "payload_srcip": "0.0.0.0",
            "payload_srcipv6": "",
            "payload_srcmac": "00:00:00:00:00:00",
            "payload_srcport": "0"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <payload_dot1q>0</payload_dot1q>
        <payload_dstip>0.0.0.0</payload_dstip>
        <payload_dstipv6></payload_dstipv6>
        <payload_dstmac>00:00:00:00:00:00</payload_dstmac>
        <payload_dstport>0</payload_dstport>
        <payload_protocol>0</payload_protocol>
        <payload_srcif>unspecified</payload_srcif>
        <payload_srcip>0.0.0.0</payload_srcip>
        <payload_srcipv6></payload_srcipv6>
        <payload_srcmac>00:00:00:00:00:00</payload_srcmac>
        <payload_srcport>0</payload_srcport>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no payload

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/

Configuring an NGOAM Ping Payload on an NGOAM OAM Connectivity Check

Configuring an NGOAM Ping Payload on an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
data-pattern pad 0x0

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/

Configuring a Destination IP Address on an NGOAM OAM Connectivity Check

Configuring a Destination IP Address on an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "dstIp": "1.2.3.4"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <dstIp>1.2.3.4</dstIp>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
dest ip 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

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/

Configuring an Outgoing Egress Ethernet Interface on an NGOAM OAM Connectivity Check

Configuring an Outgoing Egress Ethernet Interface on an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "egressIf": "eth123/3/3.34"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <egressIf>eth123/3/3.34</egressIf>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
egress ethernet 123/3/3.34

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/

Deleting an Outgoing Egress Ethernet Interface on an NGOAM OAM Connectivity Check

Deleting an Outgoing Egress Ethernet Interface on an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "egressIf": "unspecified"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <egressIf>unspecified</egressIf>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no egress

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/

Configuring the Wait Interval (in Seconds) Between Sending Each Packet on an NGOAM OAM Connectivity Check

Configuring the Wait Interval (in Seconds) Between Sending Each Packet on an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "interval": "3"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <interval>3</interval>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
interval 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/

Configuring the Packet Size to Send for an NGOAM OAM Connectivity Check

Configuring the Packet Size to Send for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "packetSz": "3"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <packetSz>3</packetSz>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
packet-size 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/

Configuring the Profile ID for an NGOAM OAM Connectivity Check

Configuring the Profile ID for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "profileId": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <profileId>123</profileId>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
profile 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/site/nx-os/docs/nexus-model-reference/

Deleting the Profile for an NGOAM OAM Connectivity Check

Deleting the Profile for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "profileId": "0"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <profileId>0</profileId>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no 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/

Configuring the Source IP Address for an NGOAM OAM Connectivity Check

Configuring the Source IP Address for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "srcIp": "1.2.3.4"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <srcIp>1.2.3.4</srcIp>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
source 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

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/

Deleting the Source IP Address for an NGOAM OAM Connectivity Check

Deleting the Source IP Address for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "srcIp": "0.0.0.0",
            "srcIpv6": ""
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <srcIp>0.0.0.0</srcIp>
        <srcIpv6></srcIpv6>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no source

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/

Deleting the Outer UDP Source Port for an NGOAM OAM Connectivity Check

Deleting the Outer UDP Source Port for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "srcPort": "123"

}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <srcPort>123</srcPort>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
sport 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/site/nx-os/docs/nexus-model-reference/

Deleting the Outer UDP Source Port for an NGOAM OAM Connectivity Check

Deleting the Outer UDP Source Port for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "srcPort": "0"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <srcPort>0</srcPort>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no sport

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/

Configuring the Timeout Interval for an NGOAM OAM Connectivity Check

Configuring the Timeout Interval for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "timeout": "30"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <timeout>30</timeout>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
timeout 30

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/

Verifying the Host Reachability for an NGOAM OAM Connectivity Check

Verifying the Host Reachability for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "verifyHost": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <verifyHost>true</verifyHost>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
verify-host

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/

Deleting the Verification for Host Reachability for an NGOAM OAM Connectivity Check

Deleting the Verification for Host Reachability for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "verifyHost": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <verifyHost>false</verifyHost>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no verify-host

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/

Configuring the VNI for an NGOAM OAM Connectivity Check

Configuring the VNI for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "vni": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <vni>123</vni>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
vni 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/site/nx-os/docs/nexus-model-reference/

Deleting the VNI for an NGOAM OAM Connectivity Check

Deleting the VNI for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "vni": "0"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <vni>0</vni>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no vni 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/site/nx-os/docs/nexus-model-reference/

Configuring a VRF for an NGOAM OAM Connectivity Check

Configuring a VRF for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "vrf": "VRF_1"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <vrf>VRF_1</vrf>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
vrf VRF_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/site/nx-os/docs/nexus-model-reference/

Deleting a VRF for an NGOAM OAM Connectivity Check

Deleting a VRF for an NGOAM OAM Connectivity Check

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

{
  "ngoamEntity": {
    "children": [
      {
        "ngoamConnectCheck": {
          "attributes": {
            "ccId": "123",
            "vrf": "default"
}}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <cc-items>
      <ConnectCheck-list>
        <ccId>123</ccId>
        <vrf>default</vrf>
      </ConnectCheck-list>
    </cc-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam connect-check 123
no 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/

NGOAM Install ACL

NGOAM Install ACL

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

{
  "topSystem": {
    "children": [
      {
        "ngoamEntity": {
          "children": [
            {
              "ngoamProfile": {
                "attributes": {
                  "profId": "2"
                },
                "children": [
                  {
                    "ngoamFlowFwd": {
                      "attributes": {
                        "forward": "yes"
}}}]}},

            {
              "ngoamInstallAcl": {
                "attributes": {
                  "enabled": "yes"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
    <installacl-items>
      <enabled>true</enabled>
    </installacl-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
ngoam install acl

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/

NGOAM Authentication Key

NGOAM Authentication Key

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

{
  "topSystem": {
    "children": [
{
"ngoamEntity": {
  "children": [
{
  "ngoamProfile": {
    "attributes": {
      "profId": "2"
},
"children": [
{
"ngoamFlowFwd": {
  "attributes": {
    "forward": "yes"
}}}]}},

{
  "ngoamAuthentication": {
    "attributes": {
      "key": "key"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ngoam-items>
    <profile-items>
      <Profile-list>
        <profId>2</profId>
        <flowfwd-items>
          <forward>true</forward>
        </flowfwd-items>
      </Profile-list>
    </profile-items>
    <authentication-items>
      <key>key</key>
    </authentication-items>
  </ngoam-items>
</System>

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

CLI Commands

ngoam profile 2
flow forward
ngoam authentication key

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/

Disabling NGOAM

Disabling NGOAM

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

{
  "fmEntity": {
    "children": [
      {
        "fmNgoam": {
          "attributes": {
            "adminSt": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <ngoam-items>
      <adminSt>disabled</adminSt>
    </ngoam-items>
  </fm-items>
</System>

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

CLI Commands

no feature ngoam

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/