Configuring System Default Switchport

Configuring the System Default Switchport

Configuring the System Default Switchport
POST http://<mgmt0_IP>/api/node/mo/sys/pltfm/tcamRegion.json
{
  "topSystem": {
    "children": [
      {
        "ethpmEntity": {
          "children": [
            {
              "ethpmInst": {
                "attributes": {
                  "systemDefaultLayer": "Layer2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ethpm-items>
    <inst-items>
      <systemDefaultLayer>Layer2</systemDefaultLayer>
    </inst-items>
  </ethpm-items>
</System>


CLI Command

The CLI command below is the equivalent to the payload example 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.

system default switchport

Note: The property information for this example was added in Release 9.3(3).


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
ethpmEntity sys/ethpm
ethpmInst sys/ethpm/inst


ethpmInst Properties

The following table contains information about the ethpmInst 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
systemDefaultLayerl1:Layer
(scalar:Enum8)
System Default LayerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2


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 the System Default Switchport

Deleting the System Default Switchport
POST http://<mgmt0_IP>/api/node/mo/sys/pltfm/tcamRegion.json
{
  "topSystem": {
    "children": [
      {
        "ethpmEntity": {
          "children": [
            {
              "ethpmInst": {
                "attributes": {
                  "systemDefaultLayer": "Layer3"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ethpm-items>
    <inst-items>
      <systemDefaultLayer>Layer3</systemDefaultLayer>
    </inst-items>
  </ethpm-items>
</System>


CLI Command

The CLI command below is the equivalent to the payload example 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.

no system default switchport

Note: The property information for this example was added in Release 9.3(3).


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
ethpmEntity sys/ethpm
ethpmInst sys/ethpm/inst


ethpmInst Properties

The following table contains information about the ethpmInst 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
systemDefaultLayerl1:Layer
(scalar:Enum8)
System Default LayerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2


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 the System Default Switchport Admin State (Down)

Configuring the System Default Switchport Admin State
POST http://<mgmt0_IP>/api/node/mo/sys/pltfm/tcamRegion.json
{
  "topSystem": {
    "children": [
      {
        "ethpmEntity": {
          "children": [
            {
              "ethpmInst": {
                "attributes": {
                  "systemDefaultAdminSt": "down"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ethpm-items>
    <inst-items>
      <systemDefaultAdminSt>down</systemDefaultAdminSt>
    </inst-items>
  </ethpm-items>
</System>


CLI Command

The CLI command below is the equivalent to the payload example 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.

system default switchport shutdown

Note: The property information for this example was added in Release 9.3(3).


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
ethpmEntity sys/ethpm
ethpmInst sys/ethpm/inst


ethpmInst Properties

The following table contains information about the ethpmInst 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
systemDefaultAdminStl1:AdminSt
(scalar:Enum8)
System Default Admin StSELECTION:
1 - down
2 - up
DEFAULT: up


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 the System Default Switchport Admin State (Up)

Configuring the System Default Switchport
POST http://<mgmt0_IP>/api/node/mo/sys/pltfm/tcamRegion.json
{
  "topSystem": {
    "children": [
      {
        "ethpmEntity": {
          "children": [
            {
              "ethpmInst": {
                "attributes": {
                  "systemDefaultAdminSt": "up"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ethpm-items>
    <inst-items>
      <systemDefaultAdminSt>up</systemDefaultAdminSt>
    </inst-items>
  </ethpm-items>
</System>


CLI Command

The CLI command below is the equivalent to the payload example 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.

no system default switchport down

Note: The property information for this example was added in Release 9.3(3).


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
ethpmEntity sys/ethpm
ethpmInst sys/ethpm/inst


ethpmInst Properties

The following table contains information about the ethpmInst 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
systemDefaultAdminStl1:AdminSt
(scalar:Enum8)
System Default Admin StSELECTION:
1 - down
2 - up
DEFAULT: up


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