Configuring Virtual Machine Tracker

Virtual Machine Tracker (VM Tracker) works together with VMware vCenter and enables you to do the following:

  • Identify the Cisco Nexus 9000 Series port that is used for each VM
  • Identify the VLAN requirements of each VM
  • Track the movement of VMs from one host (ESXi) to another
  • Track VM configuration changes such as additions, deletions, or modifications of VLANs, and configure VLANs on Cisco Nexus 9000 Series ports accordingly
  • Track the additions or deletions of VMs and hosts, and configure VLANs on Cisco Nexus 9000 Series ports accordingly
  • Track the state of VMs and dynamically provisions VLANs on the Cisco Nexus 9000 server facing physical ports.

For more information, see the Cisco Nexus 9000 Series NX-OS Virtual Machine Tracker Configuration Guide:

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

Configuring Shut of All LAN VLANs on an Interface

Configuring Shut of  All LAN VLANs on an Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/3"
                },
                "children": [
                  {
                    "l1PhysIfExtended": {
                      "attributes": {
                        "shutDownLan": "enable"
                      }
                    }
                  }
                ]
              }
            },
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                },
                "children": [
                  {
                    "l1PhysIfExtended": {
                      "attributes": {
                        "shutDownLan": "enable"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
        <physExtd-items>
          <shutDownLan>enable</shutDownLan>
        </physExtd-items>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/2</id>
        <physExtd-items>
          <shutDownLan>enable</shutDownLan>
        </physExtd-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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

interface ethernet 1/2-3
  shutdown lan


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
topSystem sys
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/3]
l1PhysIfExtended sys/intf/phys-[eth1/3]/physExtd
l1PhysIf sys/intf/phys-[eth1/2]
l1PhysIfExtended sys/intf/phys-[eth1/2]/physExtd


l1PhysIf Properties

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

Property NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIfExtended Properties

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

Property NameData TypeDescriptionValues
shutDownLanscalar:Enum8
Shut/Unshut all LAN VLANs on interface
DEFAULT: disable


l1PhysIf Properties

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

Property NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIfExtended Properties

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

Property NameData TypeDescriptionValues
shutDownLanscalar:Enum8
Shut/Unshut all LAN VLANs on interface
DEFAULT: disable


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

Deleting Shut of All LAN VLANs on an Interface

Deleting Shut of  All LAN VLANs on an Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/3"
                },
                "children": [
                  {
                    "l1PhysIfExtended": {
                      "attributes": {
                        "shutDownLan": "disable"
                      }
                    }
                  }
                ]
              }
            },
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                },
                "children": [
                  {
                    "l1PhysIfExtended": {
                      "attributes": {
                        "shutDownLan": "disable"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
        <physExtd-items>
          <shutDownLan>disable</shutDownLan>
        </physExtd-items>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/2</id>
        <physExtd-items>
          <shutDownLan>disable</shutDownLan>
        </physExtd-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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

interface ethernet 1/2-3
  no shutdown lan


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
topSystem sys
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/3]
l1PhysIfExtended sys/intf/phys-[eth1/3]/physExtd
l1PhysIf sys/intf/phys-[eth1/2]
l1PhysIfExtended sys/intf/phys-[eth1/2]/physExtd


l1PhysIf Properties

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

Property NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIfExtended Properties

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

Property NameData TypeDescriptionValues
shutDownLanscalar:Enum8
Shut/Unshut all LAN VLANs on interface
DEFAULT: disable


l1PhysIf Properties

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

Property NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIfExtended Properties

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

Property NameData TypeDescriptionValues
shutDownLanscalar:Enum8
Shut/Unshut all LAN VLANs on interface
DEFAULT: disable


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

Configuring a Host to Connect

Configuring a Host to Connect
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]


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

Deleting a Host to Connect

Deleting a Host to Connect
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list nc:operation="delete">
        <connName>VMHostName_1</connName>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

no vmtracker connection VMHostName_1


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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

Configuring VM Tracker Fabric Autoconfiguration

Configuring VM Tracker Fabric Autoconfiguration
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vmtrackerVmTracker": {
          "attributes": {
            "autoconfigEnabled": "yes"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <autoconfigEnabled>true</autoconfigEnabled>
  </vmtracker-items>
</System>

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

vmtracker fabric auto-config


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
topSystem sys
vmtrackerVmTracker sys/vmtracker


vmtrackerVmTracker Properties

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

Property NameData TypeDescriptionValues
autoconfigEnabledscalar:Bool
Enable vmtracker fabric auto-configSELECTION: true or false
DEFAULT: false


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

Deleting VM Tracker Fabric Autoconfiguration

Deleting VM Tracker Fabric Autoconfiguration
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vmtrackerVmTracker": {
          "attributes": {
            "autoconfigEnabled": "no"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <autoconfigEnabled>false</autoconfigEnabled>
  </vmtracker-items>
</System>

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

no vmtracker fabric auto-config


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
topSystem sys
vmtrackerVmTracker sys/vmtracker


vmtrackerVmTracker Properties

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

Property NameData TypeDescriptionValues
autoconfigEnabledscalar:Bool
Enable vmtracker fabric auto-configSELECTION: true or false
DEFAULT: false


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

Configuring VM Tracker on an Interface

Configuring VM Tracker on an Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vmtrackerVmTracker": {
          "children": [
            {
              "vmtrackerVmTrackerIf": {
                "attributes": {
                  "enable": "yes",
                  "vmtrackerInterface": "eth1/2"
                }
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <vmtracker-items>
      <VmTrackerIf-list>
        <vmtrackerInterface>eth1/2</vmtrackerInterface>
        <enable>true</enable>
      </VmTrackerIf-list>
    </vmtracker-items>
  </vmtracker-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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

interface ethernet 1/2
  switchport
   vmtracker enable


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
topSystem sys
vmtrackerVmTracker sys/vmtracker
vmtrackerVmTrackerIf sys/vmtracker/vmtracker-[eth1/2]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


vmtrackerVmTrackerIf Properties

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

Property NameData TypeDescriptionValues
enablescalar:Bool
Enable vmtracker on this interface.SELECTION: true or false
DEFAULT: true
vmtrackerInterfacenw:IfId
(base:IfIndex)
A vmtracker interfaceMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIf Properties

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

Property NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


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

Deleting VM Tracker on an Interface

Deleting VM Tracker on an Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vmtrackerVmTracker": {
          "children": [
            {
              "vmtrackerVmTrackerIf": {
                "attributes": {
                  "enable": "no",
                  "vmtrackerInterface": "eth1/2"
                }
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <vmtracker-items>
      <VmTrackerIf-list>
        <vmtrackerInterface>eth1/2</vmtrackerInterface>
        <enable>false</enable>
      </VmTrackerIf-list>
    </vmtracker-items>
  </vmtracker-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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

interface ethernet 1/2
  switchport
   no vmtracker enable


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
topSystem sys
vmtrackerVmTracker sys/vmtracker
vmtrackerVmTrackerIf sys/vmtracker/vmtracker-[eth1/2]
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-[eth1/2]


vmtrackerVmTrackerIf Properties

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

Property NameData TypeDescriptionValues
enablescalar:Bool
Enable vmtracker on this interface.SELECTION: true or false
DEFAULT: true
vmtrackerInterfacenw:IfId
(base:IfIndex)
A vmtracker interfaceMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIf Properties

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

Property NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


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

Configuring Auto Creation of VLANs

Configuring Auto Creation of VLANs
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "autoVlan": "yes",
            "connName": "VMHostName_1"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <autoVlan>true</autoVlan>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  autovlan enable


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
autoVlanscalar:Bool
Enable dynamic creation of VLANs learnedSELECTION: true or false
DEFAULT: true
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]


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

Deleting Auto Creation of VLANs

Deleting Auto Creation of VLANs
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "autoVlan": "no",
            "connName": "VMHostName_1"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <autoVlan>false</autoVlan>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no autovlan enable


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
autoVlanscalar:Bool
Enable dynamic creation of VLANs learnedSELECTION: true or false
DEFAULT: true
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]


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

Configuring a Host to Connect

Configuring a Host to Connect
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "connect": "yes",
            "refresh": "yes"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <connect>true</connect>
        <refresh>true</refresh>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  connect


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
connectscalar:Bool
Attempt to establish this connectionSELECTION: true or false
DEFAULT: false
refreshscalar:Bool
Attempt to establish this connectionSELECTION: true or false
DEFAULT: false


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

Deleting a Host to Connect

Deleting a Host to Connect
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "connect": "no",
            "refresh": "no"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <connect>false</connect>
        <refresh>false</refresh>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no connect


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
connectscalar:Bool
Attempt to establish this connectionSELECTION: true or false
DEFAULT: false
refreshscalar:Bool
Attempt to establish this connectionSELECTION: true or false
DEFAULT: false


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

Configuring Interval for the New Host Searching Timer

Configuring Interval for the New Host Searching Timer
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "findNewHost": "123"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <findNewHost>123</findNewHost>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  set interval find-new-host 123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
findNewHostscalar:Uint32
Check this frequently for new hosts
RANGE: [0 , 65355]
DEFAULT: 3600


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

Deleting Interval for the New Host Searching Timer

Deleting Interval for the New Host Searching Timer
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "findNewHost": "3600"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <findNewHost>3600</findNewHost>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no set interval find-new-host 123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
findNewHostscalar:Uint32
Check this frequently for new hosts
RANGE: [0 , 65355]
DEFAULT: 3600


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

Configuring Interval for Syncing Complete Info From Host

Configuring Interval for Syncing Complete Info From Host
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "syncFullInfo": "123"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <syncFullInfo>123</syncFullInfo>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  set interval sync-full-info 123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
syncFullInfoscalar:Uint32
Check this frequently for hosts, VMs, and port groups
RANGE: [0 , 65355]
DEFAULT: 3600


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

Deleting Interval for Syncing Complete Info From Host

Deleting Interval for Syncing Complete Info From Host
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "syncFullInfo": "3600"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <syncFullInfo>3600</syncFullInfo>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no set interval sync-full-info 123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
syncFullInfoscalar:Uint32
Check this frequently for hosts, VMs, and port groups
RANGE: [0 , 65355]
DEFAULT: 3600


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

Configuring a Username

Configuring a Username
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "remotePassword": "SampleString_123",
            "remoteUserName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <remotePassword>SampleString_123</remotePassword>
        <remoteUserName>SampleString_123</remoteUserName>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  username SampleString_123 password 0 SampleString_123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
remotePasswordstring:Password
Password for logging into this VMware server
remoteUserNamestring:Basic
Username for logging into this VMware host
RANGE: [0 , 128]


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

Deleting a Username

Deleting a Username
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "remotePassword": "",
            "remoteUserName": ""
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <remotePassword></remotePassword>
        <remoteUserName></remoteUserName>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no username SampleString_123 password 0 SampleString_123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
remotePasswordstring:Password
Password for logging into this VMware server
remoteUserNamestring:Basic
Username for logging into this VMware host
RANGE: [0 , 128]


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

Configuring a Username

Configuring a Username
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "remotePassword": "SampleString_123",
            "remotePasswordType": "5",
            "remoteUserName": "SampleString_123"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <remotePassword>SampleString_123</remotePassword>
        <remotePasswordType>5</remotePasswordType>
        <remoteUserName>SampleString_123</remoteUserName>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  username SampleString_123 password 5 SampleString_123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
remotePasswordstring:Password
Password for logging into this VMware server
remotePasswordTypevmtracker:PasswordType
(scalar:Enum8)
Password EnCrypt TypeSELECTION:
0 - 0
5 - 5
DEFAULT: 0
remoteUserNamestring:Basic
Username for logging into this VMware host
RANGE: [0 , 128]


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

Deleting a Username

Deleting a Username
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "remotePassword": "",
            "remotePasswordType": "5",
            "remoteUserName": ""
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <remotePassword></remotePassword>
        <remotePasswordType>5</remotePasswordType>
        <remoteUserName></remoteUserName>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no username SampleString_123 password 5 SampleString_123


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
remotePasswordstring:Password
Password for logging into this VMware server
remotePasswordTypevmtracker:PasswordType
(scalar:Enum8)
Password EnCrypt TypeSELECTION:
0 - 0
5 - 5
DEFAULT: 0
remoteUserNamestring:Basic
Username for logging into this VMware host
RANGE: [0 , 128]


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

Configuring List of Allowed VLANs Used for Interface Configuration

Configuring List of Allowed VLANs Used for Interface Configuration
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "allowedVlans": "1-4094",
            "connName": "VMHostName_1"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <allowedVlans>1-4094</allowedVlans>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  allowed-vlans all


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
allowedVlansl2:VlanBitmap
(base:BitArray)
Limit the possible VLANs learned from the destination by this set
ARRAY SIZE: 4096
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]


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

Configuring an IP Address

Configuring an IP Address
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "remoteIp": "1.2.3.4"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <remoteIp>1.2.3.4</remoteIp>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  remote ip address 1.2.3.4


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
remoteIpaddress:Ip
Destination IP address of this connectionValue must match ipv4 or ipv6 known format


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

Deleting an IP Address

Deleting an IP Address
POST http://<mgmt0_IP>/api/mo/sys/vmtracker.json
{
  "vmtrackerVmTracker": {
    "children": [
      {
        "vmtrackerConnection": {
          "attributes": {
            "connName": "VMHostName_1",
            "remoteIp": "0.0.0.0"
}}}]}}
{
    imdata:[]
}
<System>
  <vmtracker-items>
    <connection-items>
      <Connection-list>
        <connName>VMHostName_1</connName>
        <remoteIp>0.0.0.0</remoteIp>
      </Connection-list>
    </connection-items>
  </vmtracker-items>
</System>

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

vmtracker connection VMHostName_1
  no remote ip address


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
vmtrackerVmTracker sys/vmtracker
vmtrackerConnection sys/vmtracker/connection-VMHostName_1


vmtrackerConnection Properties

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

Property NameData TypeDescriptionValues
connNamestring:Basic
Name of a connection the remote VMware Host
RANGE: [0 , 64]
remoteIpaddress:Ip
Destination IP address of this connectionValue must match ipv4 or ipv6 known format


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