Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Configuring an Interface as a Trunk Port and Enabling a List of Allowed VLANs
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l1PhysIf": {
          "attributes": {
            "id": "eth1/2",
            "mode": "trunk",
            "trunkVlans": "15-20"
          }
        }
      }
    ]
  }
}

Response
{
    imdata:[]
}

Copy
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <mode>trunk</mode>
        <trunkVlans>15-20</trunkVlans>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring an Ethernet Interface

Ethernet interfaces include routed ports.

For more information about Ethernet interfaces, see the Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide:

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

Configuring an Interface as a Trunk Port and Enabling a List of Allowed VLANs

Configuring an Interface as a Trunk Port and Enabling a List of Allowed VLANs

The example in this section configures an interface as a trunk port and enables a list of trunk VLANs. When this API call executes, an l1PhysIf object named "phys-[eth1/2]" (/sys/intf/phys-[eth1/2]/) is created in the MO database, as well as several other objects that are required for port-channel functionality.

The phys-[eth1/2] object holds the configuration for the interface that is configured as a trunk port.

To verify that the interface configuration was created, issue an HTTP GET request to query the following URI.


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 mode trunk
 switchport trunk allowed vlan 15-20

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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


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
model1:Mode
(scalar:Enum8)		Administrative port modeSELECTION:
1 - access
2 - trunk
3 - fex-fabric
4 - dot1q-tunnel
5 - promiscuous
6 - host
7 - trunk_secondary
8 - trunk_promiscuous
9 - vntag
DEFAULT: access
trunkVlansl1:l1IfTrunkVlans
(l2:VlanBitmap)		Configed Trunk Vlans
DEFAULT: 1-4094


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

Querying a Trunk Port Configuration

Querying a Trunk Port Configuration

The example in this section queries the trunk port interface configuration that was specified in the previous POST request.

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
l1PhysIf sys/intf/phys-{[id]}


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
FECModel1:FECMode
(scalar:Enum8)		FEC ModeSELECTION:
1 - fc-fec
2 - rs-fec
3 - fec-off
4 - auto
5 - rs-ieee
6 - rs-cons16
7 - kp-fec
DEFAULT: auto
accessVlanl1:l1IfAccessVlan
(base:Encap)		Configured Access VlanSELECTION: unknown, vlan-%d or vxlan-%d
DEFAULT: vlan-1
adminStl1:AdminSt
(scalar:Enum8)		Administrative port stateSELECTION:
1 - down
2 - up
DEFAULT: up
autoNegl1:AutoNeg
(scalar:Enum8)		Administrative port auto-negotiationSELECTION:
1 - on
2 - off
3 - 25G
DEFAULT: on
beaconl1:Beacon
(scalar:Enum8)		Beacon StateSELECTION:
1 - on
2 - off
DEFAULT: off
bwl1:Bw
(scalar:Uint32)		The bandwidth parameter for a routed interface, port channel, or subinterface.
RANGE: [0 , 3200000000]
DEFAULT: 0
childAction
mo:ModificationChildAction
scalar:Bitmask32		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • controllerIdaggregate:ControllerIdBitmap
    (base:BitArray)    		Controller ID
    ARRAY SIZE: 256
    delayl1:Delay
    (scalar:Uint32)    		The administrative port delay time.
    RANGE: [1 , 16777215]
    DEFAULT: 1
    descrnaming:Descr1024
    (string:Basic)    		descr
    MAX SIZE: 254
    dfeTuningDelayl1:DfeTuningDelay
    (scalar:Uint16)    		DFE (Decision Feedback Equalizer) Tuning Delay
    RANGE: [100 , 10000]
    DEFAULT: 100
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    dot1qEtherTypel1:DDot1qEtherType
    (scalar:Uint32)    		The administrative port Dot1q ether-type. Dot1q Ether Type configures the TPID value in the VLAN tag field for packets received and sent by the interface.
    RANGE: [1536 , 65535]
    DEFAULT: 0x8100
    duplexl1:Duplex
    (scalar:Enum8)    		DuplexSELECTION:
    1 - auto
    2 - full
    3 - half
    DEFAULT: auto
    ethpmCfgFailedBmp
    scalar:Bitmask64    		 SELECTION:
  • -9223372036854775808ull - l1:PhysIfmodTs_failed_flag
  • 1024ull - l1:PhysIfaccessVlan_failed_flag
  • 1048576ull - l1:PhysIfmedium_failed_flag
  • 1073741824ull - l1:PhysIfbeacon_failed_flag
  • 1099511627776ull - l1:PhysIfpacketTimestampIngressSourceId_failed_flag
  • 128ull - l1:PhysIfsnmpTrapSt_failed_flag
  • 131072ull - l1:PhysIflinkDebounce_failed_flag
  • 134217728ull - l1:PhysIftrunkVlans_failed_flag
  • 137438953472ull - l1:PhysIflinkTransmitReset_failed_flag
  • 140737488355328ull - l1:PhysIfvoiceVlanType_failed_flag
  • 16384ull - l1:PhysIfdot1qEtherType_failed_flag
  • 16777216ull - l1:PhysIfrouterMac_failed_flag
  • 16ull - l1:PhysIfdescr_failed_flag
  • 17179869184ull - l1:PhysIflinkDebounceLinkUp_failed_flag
  • 17592186044416ull - l1:PhysIfvoicePortCos_failed_flag
  • 1ull - l1:PhysIfname_failed_flag
  • 2048ull - l1:PhysIfbw_failed_flag
  • 2097152ull - l1:PhysIfmode_failed_flag
  • 2147483648ull - l1:PhysIfdfeAdaptiveTuning_failed_flag
  • 2199023255552ull - l1:PhysIfpacketTimestampState_failed_flag
  • 2305843009213693952ull - l1:PhysIfuid_failed_flag
  • 256ull - l1:PhysIfspeed_failed_flag
  • 262144ull - l1:PhysIflinkLog_failed_flag
  • 268435456ull - l1:PhysIfusage_failed_flag
  • 274877906944ull - l1:PhysIfmonPolDn_failed_flag
  • 2ull - l1:PhysIfadminSt_failed_flag
  • 32768ull - l1:PhysIfinhBw_failed_flag
  • 32ull - l1:PhysIfduplex_failed_flag
  • 33554432ull - l1:PhysIfspanMode_failed_flag
  • 34359738368ull - l1:PhysIflinkLoopback_failed_flag
  • 35184372088832ull - l1:PhysIfvoicePortTrust_failed_flag
  • 4096ull - l1:PhysIfcontrollerId_failed_flag
  • 4194304ull - l1:PhysIfnativeVlan_failed_flag
  • 4294967296ull - l1:PhysIfdfeTuningDelay_failed_flag
  • 4398046511104ull - l1:PhysIfspeedGroup_failed_flag
  • 4611686018427387904ull - l1:PhysIfpersistentOnReload_failed_flag
  • 4ull - l1:PhysIfFECMode_failed_flag
  • 512ull - l1:PhysIfswitchingSt_failed_flag
  • 524288ull - l1:PhysIfmdix_failed_flag
  • 536870912ull - l1:PhysIfuserCfgdFlags_failed_flag
  • 549755813888ull - l1:PhysIfpacketTimestampEgressSourceId_failed_flag
  • 64ull - l1:PhysIfmtu_failed_flag
  • 65536ull - l1:PhysIflayer_failed_flag
  • 67108864ull - l1:PhysIftrunkLog_failed_flag
  • 68719476736ull - l1:PhysIflinkMacUpTimer_failed_flag
  • 70368744177664ull - l1:PhysIfvoiceVlanId_failed_flag
  • 8192ull - l1:PhysIfdelay_failed_flag
  • 8388608ull - l1:PhysIfportT_failed_flag
  • 8589934592ull - l1:PhysIfid_failed_flag
  • 8796093022208ull - l1:PhysIfuniDirectionalEthernet_failed_flag
  • 8ull - l1:PhysIfautoNeg_failed_flag
  • DEFAULT: 0
    • ethpmCfgFailedTs
    scalar:Uint64
    ethpmCfgState
    scalar:UByte
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    inhBwl1:InheritBw
    (scalar:Uint32)    		Administrative port inherit bandwidth
    RANGE: [0 , 4294967295]
    DEFAULT: 4294967295
    layerl1:Layer
    (scalar:Enum8)    		Administrative port layerSELECTION:
    1 - Layer2
    2 - Layer3
    DEFAULT: Layer2
    linkDebouncel1:LinkDebounce
    (scalar:Uint16)    		Administrative port link debounce interval
    RANGE: [0 , 20000]
    DEFAULT: 100
    linkDebounceLinkUpl1:LinkDebounceLinkUp
    (scalar:Uint16)    		Link Debounce Interval - LinkUp Event
    RANGE: [0 , 10000]
    DEFAULT: 0
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default
    linkTransmitResetl1:LinkTransmitReset
    (scalar:Enum8)    		Link Transmit ResetSELECTION:
    0 - disable
    1 - enable
    DEFAULT: enable
    mdixl1:Mdix
    (scalar:Enum8)    		The administrative Mdix mode. The Medium-dependant interface crossover (Mdix) is when the interface automatically detects the required cable connection type (straight through or crossover) and configures the connection appropriately. SELECTION:
    1 - auto
    2 - mdi
    3 - mdi-x
    DEFAULT: auto
    mediuml1:Medium
    (scalar:Enum8)    		The administrative port medium type.SELECTION:
    1 - broadcast
    2 - p2p
    DEFAULT: broadcast
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    model1:Mode
    (scalar:Enum8)    		Administrative port modeSELECTION:
    1 - access
    2 - trunk
    3 - fex-fabric
    4 - dot1q-tunnel
    5 - promiscuous
    6 - host
    7 - trunk_secondary
    8 - trunk_promiscuous
    9 - vntag
    DEFAULT: access
    mtul1:Mtu
    (scalar:Uint32)    		Administrative port mtu
    RANGE: [576 , 9216]
    DEFAULT: 1500
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    nativeVlanl1:l1IfNativeVlan
    (base:Encap)    		Configured Native VlanSELECTION: unknown, vlan-%d or vxlan-%d
    DEFAULT: vlan-1
    packetTimestampEgressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Egress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampIngressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Ingress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    DEFAULT: disable
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • portTeqpt:PortT
    (scalar:Enum16)    		Type of the port: Fabric vs LeafSELECTION:
    0 - unknown
    1 - eobc
    2 - mgmt
    3 - fab
    4 - leaf
    5 - extchhp
    6 - extchfp
    DEFAULT: unknown
    routerMacaddress:MAC
    		The administrative router MAC address.Value must match MM:MM:MM:SS:SS:SS format
    DEFAULT: not-applicable
    snmpTrapStl1:SnmpTrapSt
    (scalar:Enum8)    		Administrative port snmp trap stateSELECTION:
    1 - enable
    2 - disable
    DEFAULT: enable
    spanModel1:SpanMode
    (scalar:Enum8)    		Administrative port span modeSELECTION:
    1 - not-a-span-dest
    2 - span-dest
    3 - span-dest-fwd
    4 - span-dest-fwd-learn
    DEFAULT: not-a-span-dest
    speedl1:Speed
    (scalar:Enum8)    		Administrative port speedSELECTION:
    0 - unknown
    2 - 100M
    3 - 1G
    4 - 10G
    5 - 40G
    6 - auto
    7 - auto 100M
    8 - auto 100M 1G
    9 - 100G
    10 - 25G
    11 - 10M
    12 - 50G
    13 - 200G
    14 - 400G
    15 - 2.5G
    16 - 5G
    17 - auto 2.5G 5G 10G
    18 - auto 100M 1G 2.5G 5G
    DEFAULT: auto
    speedGroupl1:SpeedGroup
    (scalar:Enum8)    		Speed GroupSELECTION:
    0 - unknown
    3 - 1000
    4 - 10000
    5 - 40000
    6 - auto
    10 - 25000
    DEFAULT: auto
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    switchingStl1:SwitchingSt
    (scalar:Enum8)    		Switching stateSELECTION:
    0 - disabled
    1 - enabled
    DEFAULT: disabled
    trunkLogl1:TrunkLog
    (scalar:Enum8)    		Administrative trunk logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default
    trunkVlansl1:l1IfTrunkVlans
    (l2:VlanBitmap)    		Configed Trunk Vlans
    DEFAULT: 1-4094
    usagel1:PortUsage
    (scalar:Bitmask8)    		The port usage type.SELECTION:
    1 - discovery
    2 - epg
    4 - fabric
    8 - infra
    16 - controller
    32 - blacklist
    DEFAULT: discovery
    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
    vlanmgrCfgFailedBmp
    scalar:Bitmask64    		The configuration attribute that encountered faults (failures) while configuring.SELECTION:
  • -9223372036854775808ull - l1:PhysIfmodTs_failed_flag
  • 1024ull - l1:PhysIfaccessVlan_failed_flag
  • 1048576ull - l1:PhysIfmedium_failed_flag
  • 1073741824ull - l1:PhysIfbeacon_failed_flag
  • 1099511627776ull - l1:PhysIfpacketTimestampIngressSourceId_failed_flag
  • 128ull - l1:PhysIfsnmpTrapSt_failed_flag
  • 131072ull - l1:PhysIflinkDebounce_failed_flag
  • 134217728ull - l1:PhysIftrunkVlans_failed_flag
  • 137438953472ull - l1:PhysIflinkTransmitReset_failed_flag
  • 140737488355328ull - l1:PhysIfvoiceVlanType_failed_flag
  • 16384ull - l1:PhysIfdot1qEtherType_failed_flag
  • 16777216ull - l1:PhysIfrouterMac_failed_flag
  • 16ull - l1:PhysIfdescr_failed_flag
  • 17179869184ull - l1:PhysIflinkDebounceLinkUp_failed_flag
  • 17592186044416ull - l1:PhysIfvoicePortCos_failed_flag
  • 1ull - l1:PhysIfname_failed_flag
  • 2048ull - l1:PhysIfbw_failed_flag
  • 2097152ull - l1:PhysIfmode_failed_flag
  • 2147483648ull - l1:PhysIfdfeAdaptiveTuning_failed_flag
  • 2199023255552ull - l1:PhysIfpacketTimestampState_failed_flag
  • 2305843009213693952ull - l1:PhysIfuid_failed_flag
  • 256ull - l1:PhysIfspeed_failed_flag
  • 262144ull - l1:PhysIflinkLog_failed_flag
  • 268435456ull - l1:PhysIfusage_failed_flag
  • 274877906944ull - l1:PhysIfmonPolDn_failed_flag
  • 2ull - l1:PhysIfadminSt_failed_flag
  • 32768ull - l1:PhysIfinhBw_failed_flag
  • 32ull - l1:PhysIfduplex_failed_flag
  • 33554432ull - l1:PhysIfspanMode_failed_flag
  • 34359738368ull - l1:PhysIflinkLoopback_failed_flag
  • 35184372088832ull - l1:PhysIfvoicePortTrust_failed_flag
  • 4096ull - l1:PhysIfcontrollerId_failed_flag
  • 4194304ull - l1:PhysIfnativeVlan_failed_flag
  • 4294967296ull - l1:PhysIfdfeTuningDelay_failed_flag
  • 4398046511104ull - l1:PhysIfspeedGroup_failed_flag
  • 4611686018427387904ull - l1:PhysIfpersistentOnReload_failed_flag
  • 4ull - l1:PhysIfFECMode_failed_flag
  • 512ull - l1:PhysIfswitchingSt_failed_flag
  • 524288ull - l1:PhysIfmdix_failed_flag
  • 536870912ull - l1:PhysIfuserCfgdFlags_failed_flag
  • 549755813888ull - l1:PhysIfpacketTimestampEgressSourceId_failed_flag
  • 64ull - l1:PhysIfmtu_failed_flag
  • 65536ull - l1:PhysIflayer_failed_flag
  • 67108864ull - l1:PhysIftrunkLog_failed_flag
  • 68719476736ull - l1:PhysIflinkMacUpTimer_failed_flag
  • 70368744177664ull - l1:PhysIfvoiceVlanId_failed_flag
  • 8192ull - l1:PhysIfdelay_failed_flag
  • 8388608ull - l1:PhysIfportT_failed_flag
  • 8589934592ull - l1:PhysIfid_failed_flag
  • 8796093022208ull - l1:PhysIfuniDirectionalEthernet_failed_flag
  • 8ull - l1:PhysIfautoNeg_failed_flag
  • DEFAULT: 0
    • vlanmgrCfgFailedTs
    scalar:Uint64    		The timestamp of the last fault
    vlanmgrCfgState
    scalar:UByte    		The state of a visualizer fault. The state can be creation failure, modification failure, or no failure.
    voicePortCosl1:VoicePortCos
    (scalar:SByte)    		Voice Port Cos
    RANGE: [-1 , 7]
    DEFAULT: none
    voicePortTrustl1:VoicePortTrust
    (scalar:SByte)    		Voice Port TrustSELECTION:
    -1 - disable
    8 - enable
    DEFAULT: disable
    voiceVlanIdl1:VoiceVlanId
    (scalar:Uint16)    		Voice VLAN ID
    RANGE: [0 , 4092]
    DEFAULT: none
    voiceVlanTypel1:VoiceVlanType
    (scalar:Enum8)    		Voice vlan typeSELECTION:
    0 - none
    1 - tagged
    2 - dot1p
    3 - untagged
    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 an Interface as a Layer 2 Access Port and Enabling an Access VLAN

    Configuring an Interface as a Layer 2 Access Port and Enabling an Access VLAN

    This example configures an interface as a layer 2 access port and enables an access VLAN.

    When the POST request executes, the l1PhysIf object that was created in the previous POST request "phys-[eth1/2]" (/sys/intf/phys-[eth1/2]/) is reconfigured to be a layer 2 access port.


    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 mode access
      switchport access vlan 150

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}


    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
    accessVlanl1:l1IfAccessVlan
    (base:Encap)    		Configured Access VlanSELECTION: unknown, vlan-%d or vxlan-%d
    DEFAULT: vlan-1
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    model1:Mode
    (scalar:Enum8)    		Administrative port modeSELECTION:
    1 - access
    2 - trunk
    3 - fex-fabric
    4 - dot1q-tunnel
    5 - promiscuous
    6 - host
    7 - trunk_secondary
    8 - trunk_promiscuous
    9 - vntag
    DEFAULT: access


    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

    Querying an Access Port Configuration

    Querying an Access Port Configuration

    The example in this section queries the access port interface configuration that was specified in the previous POST request.

    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
    l1PhysIf sys/intf/phys-{[id]}


    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
    FECModel1:FECMode
    (scalar:Enum8)    		FEC ModeSELECTION:
    1 - fc-fec
    2 - rs-fec
    3 - fec-off
    4 - auto
    5 - rs-ieee
    6 - rs-cons16
    7 - kp-fec
    DEFAULT: auto
    accessVlanl1:l1IfAccessVlan
    (base:Encap)    		Configured Access VlanSELECTION: unknown, vlan-%d or vxlan-%d
    DEFAULT: vlan-1
    adminStl1:AdminSt
    (scalar:Enum8)    		Administrative port stateSELECTION:
    1 - down
    2 - up
    DEFAULT: up
    autoNegl1:AutoNeg
    (scalar:Enum8)    		Administrative port auto-negotiationSELECTION:
    1 - on
    2 - off
    3 - 25G
    DEFAULT: on
    beaconl1:Beacon
    (scalar:Enum8)    		Beacon StateSELECTION:
    1 - on
    2 - off
    DEFAULT: off
    bwl1:Bw
    (scalar:Uint32)    		The bandwidth parameter for a routed interface, port channel, or subinterface.
    RANGE: [0 , 3200000000]
    DEFAULT: 0
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • controllerIdaggregate:ControllerIdBitmap
    (base:BitArray)    		Controller ID
    ARRAY SIZE: 256
    delayl1:Delay
    (scalar:Uint32)    		The administrative port delay time.
    RANGE: [1 , 16777215]
    DEFAULT: 1
    descrnaming:Descr1024
    (string:Basic)    		descr
    MAX SIZE: 254
    dfeTuningDelayl1:DfeTuningDelay
    (scalar:Uint16)    		DFE (Decision Feedback Equalizer) Tuning Delay
    RANGE: [100 , 10000]
    DEFAULT: 100
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    dot1qEtherTypel1:DDot1qEtherType
    (scalar:Uint32)    		The administrative port Dot1q ether-type. Dot1q Ether Type configures the TPID value in the VLAN tag field for packets received and sent by the interface.
    RANGE: [1536 , 65535]
    DEFAULT: 0x8100
    duplexl1:Duplex
    (scalar:Enum8)    		DuplexSELECTION:
    1 - auto
    2 - full
    3 - half
    DEFAULT: auto
    ethpmCfgFailedBmp
    scalar:Bitmask64    		 SELECTION:
  • -9223372036854775808ull - l1:PhysIfmodTs_failed_flag
  • 1024ull - l1:PhysIfaccessVlan_failed_flag
  • 1048576ull - l1:PhysIfmedium_failed_flag
  • 1073741824ull - l1:PhysIfbeacon_failed_flag
  • 1099511627776ull - l1:PhysIfpacketTimestampIngressSourceId_failed_flag
  • 128ull - l1:PhysIfsnmpTrapSt_failed_flag
  • 131072ull - l1:PhysIflinkDebounce_failed_flag
  • 134217728ull - l1:PhysIftrunkVlans_failed_flag
  • 137438953472ull - l1:PhysIflinkTransmitReset_failed_flag
  • 140737488355328ull - l1:PhysIfvoiceVlanType_failed_flag
  • 16384ull - l1:PhysIfdot1qEtherType_failed_flag
  • 16777216ull - l1:PhysIfrouterMac_failed_flag
  • 16ull - l1:PhysIfdescr_failed_flag
  • 17179869184ull - l1:PhysIflinkDebounceLinkUp_failed_flag
  • 17592186044416ull - l1:PhysIfvoicePortCos_failed_flag
  • 1ull - l1:PhysIfname_failed_flag
  • 2048ull - l1:PhysIfbw_failed_flag
  • 2097152ull - l1:PhysIfmode_failed_flag
  • 2147483648ull - l1:PhysIfdfeAdaptiveTuning_failed_flag
  • 2199023255552ull - l1:PhysIfpacketTimestampState_failed_flag
  • 2305843009213693952ull - l1:PhysIfuid_failed_flag
  • 256ull - l1:PhysIfspeed_failed_flag
  • 262144ull - l1:PhysIflinkLog_failed_flag
  • 268435456ull - l1:PhysIfusage_failed_flag
  • 274877906944ull - l1:PhysIfmonPolDn_failed_flag
  • 2ull - l1:PhysIfadminSt_failed_flag
  • 32768ull - l1:PhysIfinhBw_failed_flag
  • 32ull - l1:PhysIfduplex_failed_flag
  • 33554432ull - l1:PhysIfspanMode_failed_flag
  • 34359738368ull - l1:PhysIflinkLoopback_failed_flag
  • 35184372088832ull - l1:PhysIfvoicePortTrust_failed_flag
  • 4096ull - l1:PhysIfcontrollerId_failed_flag
  • 4194304ull - l1:PhysIfnativeVlan_failed_flag
  • 4294967296ull - l1:PhysIfdfeTuningDelay_failed_flag
  • 4398046511104ull - l1:PhysIfspeedGroup_failed_flag
  • 4611686018427387904ull - l1:PhysIfpersistentOnReload_failed_flag
  • 4ull - l1:PhysIfFECMode_failed_flag
  • 512ull - l1:PhysIfswitchingSt_failed_flag
  • 524288ull - l1:PhysIfmdix_failed_flag
  • 536870912ull - l1:PhysIfuserCfgdFlags_failed_flag
  • 549755813888ull - l1:PhysIfpacketTimestampEgressSourceId_failed_flag
  • 64ull - l1:PhysIfmtu_failed_flag
  • 65536ull - l1:PhysIflayer_failed_flag
  • 67108864ull - l1:PhysIftrunkLog_failed_flag
  • 68719476736ull - l1:PhysIflinkMacUpTimer_failed_flag
  • 70368744177664ull - l1:PhysIfvoiceVlanId_failed_flag
  • 8192ull - l1:PhysIfdelay_failed_flag
  • 8388608ull - l1:PhysIfportT_failed_flag
  • 8589934592ull - l1:PhysIfid_failed_flag
  • 8796093022208ull - l1:PhysIfuniDirectionalEthernet_failed_flag
  • 8ull - l1:PhysIfautoNeg_failed_flag
  • DEFAULT: 0
    • ethpmCfgFailedTs
    scalar:Uint64
    ethpmCfgState
    scalar:UByte
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    inhBwl1:InheritBw
    (scalar:Uint32)    		Administrative port inherit bandwidth
    RANGE: [0 , 4294967295]
    DEFAULT: 4294967295
    layerl1:Layer
    (scalar:Enum8)    		Administrative port layerSELECTION:
    1 - Layer2
    2 - Layer3
    DEFAULT: Layer2
    linkDebouncel1:LinkDebounce
    (scalar:Uint16)    		Administrative port link debounce interval
    RANGE: [0 , 20000]
    DEFAULT: 100
    linkDebounceLinkUpl1:LinkDebounceLinkUp
    (scalar:Uint16)    		Link Debounce Interval - LinkUp Event
    RANGE: [0 , 10000]
    DEFAULT: 0
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default
    linkTransmitResetl1:LinkTransmitReset
    (scalar:Enum8)    		Link Transmit ResetSELECTION:
    0 - disable
    1 - enable
    DEFAULT: enable
    mdixl1:Mdix
    (scalar:Enum8)    		The administrative Mdix mode. The Medium-dependant interface crossover (Mdix) is when the interface automatically detects the required cable connection type (straight through or crossover) and configures the connection appropriately. SELECTION:
    1 - auto
    2 - mdi
    3 - mdi-x
    DEFAULT: auto
    mediuml1:Medium
    (scalar:Enum8)    		The administrative port medium type.SELECTION:
    1 - broadcast
    2 - p2p
    DEFAULT: broadcast
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    model1:Mode
    (scalar:Enum8)    		Administrative port modeSELECTION:
    1 - access
    2 - trunk
    3 - fex-fabric
    4 - dot1q-tunnel
    5 - promiscuous
    6 - host
    7 - trunk_secondary
    8 - trunk_promiscuous
    9 - vntag
    DEFAULT: access
    mtul1:Mtu
    (scalar:Uint32)    		Administrative port mtu
    RANGE: [576 , 9216]
    DEFAULT: 1500
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    nativeVlanl1:l1IfNativeVlan
    (base:Encap)    		Configured Native VlanSELECTION: unknown, vlan-%d or vxlan-%d
    DEFAULT: vlan-1
    packetTimestampEgressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Egress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampIngressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Ingress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    DEFAULT: disable
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • portTeqpt:PortT
    (scalar:Enum16)    		Type of the port: Fabric vs LeafSELECTION:
    0 - unknown
    1 - eobc
    2 - mgmt
    3 - fab
    4 - leaf
    5 - extchhp
    6 - extchfp
    DEFAULT: unknown
    routerMacaddress:MAC
    		The administrative router MAC address.Value must match MM:MM:MM:SS:SS:SS format
    DEFAULT: not-applicable
    snmpTrapStl1:SnmpTrapSt
    (scalar:Enum8)    		Administrative port snmp trap stateSELECTION:
    1 - enable
    2 - disable
    DEFAULT: enable
    spanModel1:SpanMode
    (scalar:Enum8)    		Administrative port span modeSELECTION:
    1 - not-a-span-dest
    2 - span-dest
    3 - span-dest-fwd
    4 - span-dest-fwd-learn
    DEFAULT: not-a-span-dest
    speedl1:Speed
    (scalar:Enum8)    		Administrative port speedSELECTION:
    0 - unknown
    2 - 100M
    3 - 1G
    4 - 10G
    5 - 40G
    6 - auto
    7 - auto 100M
    8 - auto 100M 1G
    9 - 100G
    10 - 25G
    11 - 10M
    12 - 50G
    13 - 200G
    14 - 400G
    15 - 2.5G
    16 - 5G
    17 - auto 2.5G 5G 10G
    18 - auto 100M 1G 2.5G 5G
    DEFAULT: auto
    speedGroupl1:SpeedGroup
    (scalar:Enum8)    		Speed GroupSELECTION:
    0 - unknown
    3 - 1000
    4 - 10000
    5 - 40000
    6 - auto
    10 - 25000
    DEFAULT: auto
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    switchingStl1:SwitchingSt
    (scalar:Enum8)    		Switching stateSELECTION:
    0 - disabled
    1 - enabled
    DEFAULT: disabled
    trunkLogl1:TrunkLog
    (scalar:Enum8)    		Administrative trunk logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default
    trunkVlansl1:l1IfTrunkVlans
    (l2:VlanBitmap)    		Configed Trunk Vlans
    DEFAULT: 1-4094
    usagel1:PortUsage
    (scalar:Bitmask8)    		The port usage type.SELECTION:
    1 - discovery
    2 - epg
    4 - fabric
    8 - infra
    16 - controller
    32 - blacklist
    DEFAULT: discovery
    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
    vlanmgrCfgFailedBmp
    scalar:Bitmask64    		The configuration attribute that encountered faults (failures) while configuring.SELECTION:
  • -9223372036854775808ull - l1:PhysIfmodTs_failed_flag
  • 1024ull - l1:PhysIfaccessVlan_failed_flag
  • 1048576ull - l1:PhysIfmedium_failed_flag
  • 1073741824ull - l1:PhysIfbeacon_failed_flag
  • 1099511627776ull - l1:PhysIfpacketTimestampIngressSourceId_failed_flag
  • 128ull - l1:PhysIfsnmpTrapSt_failed_flag
  • 131072ull - l1:PhysIflinkDebounce_failed_flag
  • 134217728ull - l1:PhysIftrunkVlans_failed_flag
  • 137438953472ull - l1:PhysIflinkTransmitReset_failed_flag
  • 140737488355328ull - l1:PhysIfvoiceVlanType_failed_flag
  • 16384ull - l1:PhysIfdot1qEtherType_failed_flag
  • 16777216ull - l1:PhysIfrouterMac_failed_flag
  • 16ull - l1:PhysIfdescr_failed_flag
  • 17179869184ull - l1:PhysIflinkDebounceLinkUp_failed_flag
  • 17592186044416ull - l1:PhysIfvoicePortCos_failed_flag
  • 1ull - l1:PhysIfname_failed_flag
  • 2048ull - l1:PhysIfbw_failed_flag
  • 2097152ull - l1:PhysIfmode_failed_flag
  • 2147483648ull - l1:PhysIfdfeAdaptiveTuning_failed_flag
  • 2199023255552ull - l1:PhysIfpacketTimestampState_failed_flag
  • 2305843009213693952ull - l1:PhysIfuid_failed_flag
  • 256ull - l1:PhysIfspeed_failed_flag
  • 262144ull - l1:PhysIflinkLog_failed_flag
  • 268435456ull - l1:PhysIfusage_failed_flag
  • 274877906944ull - l1:PhysIfmonPolDn_failed_flag
  • 2ull - l1:PhysIfadminSt_failed_flag
  • 32768ull - l1:PhysIfinhBw_failed_flag
  • 32ull - l1:PhysIfduplex_failed_flag
  • 33554432ull - l1:PhysIfspanMode_failed_flag
  • 34359738368ull - l1:PhysIflinkLoopback_failed_flag
  • 35184372088832ull - l1:PhysIfvoicePortTrust_failed_flag
  • 4096ull - l1:PhysIfcontrollerId_failed_flag
  • 4194304ull - l1:PhysIfnativeVlan_failed_flag
  • 4294967296ull - l1:PhysIfdfeTuningDelay_failed_flag
  • 4398046511104ull - l1:PhysIfspeedGroup_failed_flag
  • 4611686018427387904ull - l1:PhysIfpersistentOnReload_failed_flag
  • 4ull - l1:PhysIfFECMode_failed_flag
  • 512ull - l1:PhysIfswitchingSt_failed_flag
  • 524288ull - l1:PhysIfmdix_failed_flag
  • 536870912ull - l1:PhysIfuserCfgdFlags_failed_flag
  • 549755813888ull - l1:PhysIfpacketTimestampEgressSourceId_failed_flag
  • 64ull - l1:PhysIfmtu_failed_flag
  • 65536ull - l1:PhysIflayer_failed_flag
  • 67108864ull - l1:PhysIftrunkLog_failed_flag
  • 68719476736ull - l1:PhysIflinkMacUpTimer_failed_flag
  • 70368744177664ull - l1:PhysIfvoiceVlanId_failed_flag
  • 8192ull - l1:PhysIfdelay_failed_flag
  • 8388608ull - l1:PhysIfportT_failed_flag
  • 8589934592ull - l1:PhysIfid_failed_flag
  • 8796093022208ull - l1:PhysIfuniDirectionalEthernet_failed_flag
  • 8ull - l1:PhysIfautoNeg_failed_flag
  • DEFAULT: 0
    • vlanmgrCfgFailedTs
    scalar:Uint64    		The timestamp of the last fault
    vlanmgrCfgState
    scalar:UByte    		The state of a visualizer fault. The state can be creation failure, modification failure, or no failure.
    voicePortCosl1:VoicePortCos
    (scalar:SByte)    		Voice Port Cos
    RANGE: [-1 , 7]
    DEFAULT: none
    voicePortTrustl1:VoicePortTrust
    (scalar:SByte)    		Voice Port TrustSELECTION:
    -1 - disable
    8 - enable
    DEFAULT: disable
    voiceVlanIdl1:VoiceVlanId
    (scalar:Uint16)    		Voice VLAN ID
    RANGE: [0 , 4092]
    DEFAULT: none
    voiceVlanTypel1:VoiceVlanType
    (scalar:Enum8)    		Voice vlan typeSELECTION:
    0 - none
    1 - tagged
    2 - dot1p
    3 - untagged
    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

    Issuing a Shut or No Shut of the Interface

    Issuing a Shut or No Shut of the Interface

    The example in this section shows how to issue a shut or no shut for an interface. In this example, the interface that was first configured to be a trunk port and then reconfigured to be a layer 2 access port, as shown in previous sections, is brought down.

    If the interface is up and you want to bring it down, change "adminSt": "up" to "adminSt": "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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}


    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
    adminStl1:AdminSt
    (scalar:Enum8)    		Administrative port stateSELECTION:
    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

    Verifying the Shut or No Shut of an Interface

    Verifying the Shut or No Shut of an Interface

    The example in this section queries the trunk port interface configuration that was specified in the previous POST request.

    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
    l1PhysIf sys/intf/phys-{[id]}


    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
    FECModel1:FECMode
    (scalar:Enum8)    		FEC ModeSELECTION:
    1 - fc-fec
    2 - rs-fec
    3 - fec-off
    4 - auto
    5 - rs-ieee
    6 - rs-cons16
    7 - kp-fec
    DEFAULT: auto
    accessVlanl1:l1IfAccessVlan
    (base:Encap)    		Configured Access VlanSELECTION: unknown, vlan-%d or vxlan-%d
    DEFAULT: vlan-1
    adminStl1:AdminSt
    (scalar:Enum8)    		Administrative port stateSELECTION:
    1 - down
    2 - up
    DEFAULT: up
    autoNegl1:AutoNeg
    (scalar:Enum8)    		Administrative port auto-negotiationSELECTION:
    1 - on
    2 - off
    3 - 25G
    DEFAULT: on
    beaconl1:Beacon
    (scalar:Enum8)    		Beacon StateSELECTION:
    1 - on
    2 - off
    DEFAULT: off
    bwl1:Bw
    (scalar:Uint32)    		The bandwidth parameter for a routed interface, port channel, or subinterface.
    RANGE: [0 , 3200000000]
    DEFAULT: 0
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • controllerIdaggregate:ControllerIdBitmap
    (base:BitArray)    		Controller ID
    ARRAY SIZE: 256
    delayl1:Delay
    (scalar:Uint32)    		The administrative port delay time.
    RANGE: [1 , 16777215]
    DEFAULT: 1
    descrnaming:Descr1024
    (string:Basic)    		descr
    MAX SIZE: 254
    dfeTuningDelayl1:DfeTuningDelay
    (scalar:Uint16)    		DFE (Decision Feedback Equalizer) Tuning Delay
    RANGE: [100 , 10000]
    DEFAULT: 100
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    dot1qEtherTypel1:DDot1qEtherType
    (scalar:Uint32)    		The administrative port Dot1q ether-type. Dot1q Ether Type configures the TPID value in the VLAN tag field for packets received and sent by the interface.
    RANGE: [1536 , 65535]
    DEFAULT: 0x8100
    duplexl1:Duplex
    (scalar:Enum8)    		DuplexSELECTION:
    1 - auto
    2 - full
    3 - half
    DEFAULT: auto
    ethpmCfgFailedBmp
    scalar:Bitmask64    		 SELECTION:
  • -9223372036854775808ull - l1:PhysIfmodTs_failed_flag
  • 1024ull - l1:PhysIfaccessVlan_failed_flag
  • 1048576ull - l1:PhysIfmedium_failed_flag
  • 1073741824ull - l1:PhysIfbeacon_failed_flag
  • 1099511627776ull - l1:PhysIfpacketTimestampIngressSourceId_failed_flag
  • 128ull - l1:PhysIfsnmpTrapSt_failed_flag
  • 131072ull - l1:PhysIflinkDebounce_failed_flag
  • 134217728ull - l1:PhysIftrunkVlans_failed_flag
  • 137438953472ull - l1:PhysIflinkTransmitReset_failed_flag
  • 140737488355328ull - l1:PhysIfvoiceVlanType_failed_flag
  • 16384ull - l1:PhysIfdot1qEtherType_failed_flag
  • 16777216ull - l1:PhysIfrouterMac_failed_flag
  • 16ull - l1:PhysIfdescr_failed_flag
  • 17179869184ull - l1:PhysIflinkDebounceLinkUp_failed_flag
  • 17592186044416ull - l1:PhysIfvoicePortCos_failed_flag
  • 1ull - l1:PhysIfname_failed_flag
  • 2048ull - l1:PhysIfbw_failed_flag
  • 2097152ull - l1:PhysIfmode_failed_flag
  • 2147483648ull - l1:PhysIfdfeAdaptiveTuning_failed_flag
  • 2199023255552ull - l1:PhysIfpacketTimestampState_failed_flag
  • 2305843009213693952ull - l1:PhysIfuid_failed_flag
  • 256ull - l1:PhysIfspeed_failed_flag
  • 262144ull - l1:PhysIflinkLog_failed_flag
  • 268435456ull - l1:PhysIfusage_failed_flag
  • 274877906944ull - l1:PhysIfmonPolDn_failed_flag
  • 2ull - l1:PhysIfadminSt_failed_flag
  • 32768ull - l1:PhysIfinhBw_failed_flag
  • 32ull - l1:PhysIfduplex_failed_flag
  • 33554432ull - l1:PhysIfspanMode_failed_flag
  • 34359738368ull - l1:PhysIflinkLoopback_failed_flag
  • 35184372088832ull - l1:PhysIfvoicePortTrust_failed_flag
  • 4096ull - l1:PhysIfcontrollerId_failed_flag
  • 4194304ull - l1:PhysIfnativeVlan_failed_flag
  • 4294967296ull - l1:PhysIfdfeTuningDelay_failed_flag
  • 4398046511104ull - l1:PhysIfspeedGroup_failed_flag
  • 4611686018427387904ull - l1:PhysIfpersistentOnReload_failed_flag
  • 4ull - l1:PhysIfFECMode_failed_flag
  • 512ull - l1:PhysIfswitchingSt_failed_flag
  • 524288ull - l1:PhysIfmdix_failed_flag
  • 536870912ull - l1:PhysIfuserCfgdFlags_failed_flag
  • 549755813888ull - l1:PhysIfpacketTimestampEgressSourceId_failed_flag
  • 64ull - l1:PhysIfmtu_failed_flag
  • 65536ull - l1:PhysIflayer_failed_flag
  • 67108864ull - l1:PhysIftrunkLog_failed_flag
  • 68719476736ull - l1:PhysIflinkMacUpTimer_failed_flag
  • 70368744177664ull - l1:PhysIfvoiceVlanId_failed_flag
  • 8192ull - l1:PhysIfdelay_failed_flag
  • 8388608ull - l1:PhysIfportT_failed_flag
  • 8589934592ull - l1:PhysIfid_failed_flag
  • 8796093022208ull - l1:PhysIfuniDirectionalEthernet_failed_flag
  • 8ull - l1:PhysIfautoNeg_failed_flag
  • DEFAULT: 0
    • ethpmCfgFailedTs
    scalar:Uint64
    ethpmCfgState
    scalar:UByte
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    inhBwl1:InheritBw
    (scalar:Uint32)    		Administrative port inherit bandwidth
    RANGE: [0 , 4294967295]
    DEFAULT: 4294967295
    layerl1:Layer
    (scalar:Enum8)    		Administrative port layerSELECTION:
    1 - Layer2
    2 - Layer3
    DEFAULT: Layer2
    linkDebouncel1:LinkDebounce
    (scalar:Uint16)    		Administrative port link debounce interval
    RANGE: [0 , 20000]
    DEFAULT: 100
    linkDebounceLinkUpl1:LinkDebounceLinkUp
    (scalar:Uint16)    		Link Debounce Interval - LinkUp Event
    RANGE: [0 , 10000]
    DEFAULT: 0
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default
    linkTransmitResetl1:LinkTransmitReset
    (scalar:Enum8)    		Link Transmit ResetSELECTION:
    0 - disable
    1 - enable
    DEFAULT: enable
    mdixl1:Mdix
    (scalar:Enum8)    		The administrative Mdix mode. The Medium-dependant interface crossover (Mdix) is when the interface automatically detects the required cable connection type (straight through or crossover) and configures the connection appropriately. SELECTION:
    1 - auto
    2 - mdi
    3 - mdi-x
    DEFAULT: auto
    mediuml1:Medium
    (scalar:Enum8)    		The administrative port medium type.SELECTION:
    1 - broadcast
    2 - p2p
    DEFAULT: broadcast
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    model1:Mode
    (scalar:Enum8)    		Administrative port modeSELECTION:
    1 - access
    2 - trunk
    3 - fex-fabric
    4 - dot1q-tunnel
    5 - promiscuous
    6 - host
    7 - trunk_secondary
    8 - trunk_promiscuous
    9 - vntag
    DEFAULT: access
    mtul1:Mtu
    (scalar:Uint32)    		Administrative port mtu
    RANGE: [576 , 9216]
    DEFAULT: 1500
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    nativeVlanl1:l1IfNativeVlan
    (base:Encap)    		Configured Native VlanSELECTION: unknown, vlan-%d or vxlan-%d
    DEFAULT: vlan-1
    packetTimestampEgressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Egress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampIngressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Ingress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    DEFAULT: disable
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • portTeqpt:PortT
    (scalar:Enum16)    		Type of the port: Fabric vs LeafSELECTION:
    0 - unknown
    1 - eobc
    2 - mgmt
    3 - fab
    4 - leaf
    5 - extchhp
    6 - extchfp
    DEFAULT: unknown
    routerMacaddress:MAC
    		The administrative router MAC address.Value must match MM:MM:MM:SS:SS:SS format
    DEFAULT: not-applicable
    snmpTrapStl1:SnmpTrapSt
    (scalar:Enum8)    		Administrative port snmp trap stateSELECTION:
    1 - enable
    2 - disable
    DEFAULT: enable
    spanModel1:SpanMode
    (scalar:Enum8)    		Administrative port span modeSELECTION:
    1 - not-a-span-dest
    2 - span-dest
    3 - span-dest-fwd
    4 - span-dest-fwd-learn
    DEFAULT: not-a-span-dest
    speedl1:Speed
    (scalar:Enum8)    		Administrative port speedSELECTION:
    0 - unknown
    2 - 100M
    3 - 1G
    4 - 10G
    5 - 40G
    6 - auto
    7 - auto 100M
    8 - auto 100M 1G
    9 - 100G
    10 - 25G
    11 - 10M
    12 - 50G
    13 - 200G
    14 - 400G
    15 - 2.5G
    16 - 5G
    17 - auto 2.5G 5G 10G
    18 - auto 100M 1G 2.5G 5G
    DEFAULT: auto
    speedGroupl1:SpeedGroup
    (scalar:Enum8)    		Speed GroupSELECTION:
    0 - unknown
    3 - 1000
    4 - 10000
    5 - 40000
    6 - auto
    10 - 25000
    DEFAULT: auto
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    switchingStl1:SwitchingSt
    (scalar:Enum8)    		Switching stateSELECTION:
    0 - disabled
    1 - enabled
    DEFAULT: disabled
    trunkLogl1:TrunkLog
    (scalar:Enum8)    		Administrative trunk logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default
    trunkVlansl1:l1IfTrunkVlans
    (l2:VlanBitmap)    		Configed Trunk Vlans
    DEFAULT: 1-4094
    usagel1:PortUsage
    (scalar:Bitmask8)    		The port usage type.SELECTION:
    1 - discovery
    2 - epg
    4 - fabric
    8 - infra
    16 - controller
    32 - blacklist
    DEFAULT: discovery
    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
    vlanmgrCfgFailedBmp
    scalar:Bitmask64    		The configuration attribute that encountered faults (failures) while configuring.SELECTION:
  • -9223372036854775808ull - l1:PhysIfmodTs_failed_flag
  • 1024ull - l1:PhysIfaccessVlan_failed_flag
  • 1048576ull - l1:PhysIfmedium_failed_flag
  • 1073741824ull - l1:PhysIfbeacon_failed_flag
  • 1099511627776ull - l1:PhysIfpacketTimestampIngressSourceId_failed_flag
  • 128ull - l1:PhysIfsnmpTrapSt_failed_flag
  • 131072ull - l1:PhysIflinkDebounce_failed_flag
  • 134217728ull - l1:PhysIftrunkVlans_failed_flag
  • 137438953472ull - l1:PhysIflinkTransmitReset_failed_flag
  • 140737488355328ull - l1:PhysIfvoiceVlanType_failed_flag
  • 16384ull - l1:PhysIfdot1qEtherType_failed_flag
  • 16777216ull - l1:PhysIfrouterMac_failed_flag
  • 16ull - l1:PhysIfdescr_failed_flag
  • 17179869184ull - l1:PhysIflinkDebounceLinkUp_failed_flag
  • 17592186044416ull - l1:PhysIfvoicePortCos_failed_flag
  • 1ull - l1:PhysIfname_failed_flag
  • 2048ull - l1:PhysIfbw_failed_flag
  • 2097152ull - l1:PhysIfmode_failed_flag
  • 2147483648ull - l1:PhysIfdfeAdaptiveTuning_failed_flag
  • 2199023255552ull - l1:PhysIfpacketTimestampState_failed_flag
  • 2305843009213693952ull - l1:PhysIfuid_failed_flag
  • 256ull - l1:PhysIfspeed_failed_flag
  • 262144ull - l1:PhysIflinkLog_failed_flag
  • 268435456ull - l1:PhysIfusage_failed_flag
  • 274877906944ull - l1:PhysIfmonPolDn_failed_flag
  • 2ull - l1:PhysIfadminSt_failed_flag
  • 32768ull - l1:PhysIfinhBw_failed_flag
  • 32ull - l1:PhysIfduplex_failed_flag
  • 33554432ull - l1:PhysIfspanMode_failed_flag
  • 34359738368ull - l1:PhysIflinkLoopback_failed_flag
  • 35184372088832ull - l1:PhysIfvoicePortTrust_failed_flag
  • 4096ull - l1:PhysIfcontrollerId_failed_flag
  • 4194304ull - l1:PhysIfnativeVlan_failed_flag
  • 4294967296ull - l1:PhysIfdfeTuningDelay_failed_flag
  • 4398046511104ull - l1:PhysIfspeedGroup_failed_flag
  • 4611686018427387904ull - l1:PhysIfpersistentOnReload_failed_flag
  • 4ull - l1:PhysIfFECMode_failed_flag
  • 512ull - l1:PhysIfswitchingSt_failed_flag
  • 524288ull - l1:PhysIfmdix_failed_flag
  • 536870912ull - l1:PhysIfuserCfgdFlags_failed_flag
  • 549755813888ull - l1:PhysIfpacketTimestampEgressSourceId_failed_flag
  • 64ull - l1:PhysIfmtu_failed_flag
  • 65536ull - l1:PhysIflayer_failed_flag
  • 67108864ull - l1:PhysIftrunkLog_failed_flag
  • 68719476736ull - l1:PhysIflinkMacUpTimer_failed_flag
  • 70368744177664ull - l1:PhysIfvoiceVlanId_failed_flag
  • 8192ull - l1:PhysIfdelay_failed_flag
  • 8388608ull - l1:PhysIfportT_failed_flag
  • 8589934592ull - l1:PhysIfid_failed_flag
  • 8796093022208ull - l1:PhysIfuniDirectionalEthernet_failed_flag
  • 8ull - l1:PhysIfautoNeg_failed_flag
  • DEFAULT: 0
    • vlanmgrCfgFailedTs
    scalar:Uint64    		The timestamp of the last fault
    vlanmgrCfgState
    scalar:UByte    		The state of a visualizer fault. The state can be creation failure, modification failure, or no failure.
    voicePortCosl1:VoicePortCos
    (scalar:SByte)    		Voice Port Cos
    RANGE: [-1 , 7]
    DEFAULT: none
    voicePortTrustl1:VoicePortTrust
    (scalar:SByte)    		Voice Port TrustSELECTION:
    -1 - disable
    8 - enable
    DEFAULT: disable
    voiceVlanIdl1:VoiceVlanId
    (scalar:Uint16)    		Voice VLAN ID
    RANGE: [0 , 4092]
    DEFAULT: none
    voiceVlanTypel1:VoiceVlanType
    (scalar:Enum8)    		Voice vlan typeSELECTION:
    0 - none
    1 - tagged
    2 - dot1p
    3 - untagged
    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 an IPv4 Address for an Interface

    Configuring ACL TCAM Region with e-racl TCAM Carving

    The HTTP request in this example assigns an IPv4 address to an interface.

    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
    ipv4Entity sys/ipv4
    ipv4Inst sys/ipv4/inst
    ipv4Dom sys/ipv4/inst/dom-{name}
    ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
    ipv4Addr sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}


    ipv4Dom Properties

    The following table contains information about the ipv4Dom 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
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63


    ipv4If Properties

    The following table contains information about the ipv4If 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


    ipv4Addr Properties

    The following table contains information about the ipv4Addr 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
    addraddress:Ip
    		AddressValue 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

    Configuring User Flags (Layer)

    Configuring User Flags (Layer)

    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 e1/2
      switchport


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


    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 User Flags (Admin State)

    Configuring User Flags (Admin State)

    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 e1/2
      no shutdown


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


    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
    adminStl1:AdminSt
    (scalar:Enum8)    		Administrative port stateSELECTION:
    1 - down
    2 - up
    DEFAULT: up
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    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 User Flags (MTU)

    Configuring User Flags (MTU)

    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 e1/2
      mtu 9000


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


    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
    mtul1:Mtu
    (scalar:Uint32)    		Administrative port mtu
    RANGE: [576 , 9216]
    DEFAULT: 1500
    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 the Layer, Admin State, and MTU in the Same Payload (One-Shot)

    Configuring the Layer, Admin State, and MTU in the Same Payload (One-Shot)

    User configured flags (REST property userCfgdFlags in l1PhysIf and pcAggrIf MOs) are used to indicate that a property (layer, admin state, and/or mtu) has been configured by the user.
    If these flags are not set, you may experience configuration loss (for layer, admin state, and MTU) on the reload of the system. Interfaces with the “admin_layer” and/or “admin_state” value set for “userCfgdFlags” will be unaffected by the system default switchport and system default switchport shutdown commands (respectively). User configured flags are automatically set correctly when CLI is executed, and only must be manually set for REST.

    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

    Creating a Subinterface under a Main Interface

    Creating a Subinterface under a Main Interface

    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

    Querying the State of a Subinterface

    Querying the State of a Subinterface

    The example in this section queries the state of a specified subinterface.

    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
    l3EncRtdIf sys/intf/encrtd-{[id]}


    l3EncRtdIf Properties

    The following table contains information about the l3EncRtdIf 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
    adminStl1:AdminSt
    (scalar:Enum8)    		Administrative stateSELECTION:
    1 - down
    2 - up
    DEFAULT: down
    bwl1:Bw
    (scalar:Uint32)    		The encapsulated routed interface bandwidth.
    RANGE: [0 , 3200000000]
    DEFAULT: 0
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • delayl1:Delay
    (scalar:Uint32)    		The encapsulation routed interface delay.
    RANGE: [1 , 16777215]
    DEFAULT: 1
    descrnaming:Descr1024
    (string:Basic)    		Description
    MAX SIZE: 254
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    encapbase:Encap
    		The routed interface encapsulation VLAN.SELECTION: unknown, vlan-%d or vxlan-%d
    ethpmCfgFailedBmp
    scalar:Bitmask64    		 SELECTION:
  • -9223372036854775808ull - l3:EncRtdIfmodTs_failed_flag
  • 1024ull - l3:EncRtdIfmediumType_failed_flag
  • 128ull - l3:EncRtdIfifConnDn_failed_flag
  • 16384ull - l3:EncRtdIfrouterMac_failed_flag
  • 16ull - l3:EncRtdIfdescr_failed_flag
  • 1ull - l3:EncRtdIfname_failed_flag
  • 2048ull - l3:EncRtdIfmonPolDn_failed_flag
  • 2305843009213693952ull - l3:EncRtdIfuid_failed_flag
  • 256ull - l3:EncRtdIflinkLog_failed_flag
  • 2ull - l3:EncRtdIfadminSt_failed_flag
  • 32768ull - l3:EncRtdIfrouterMacIpv6Extract_failed_flag
  • 32ull - l3:EncRtdIfencap_failed_flag
  • 4096ull - l3:EncRtdIfmtu_failed_flag
  • 4611686018427387904ull - l3:EncRtdIfpersistentOnReload_failed_flag
  • 4ull - l3:EncRtdIfbw_failed_flag
  • 512ull - l3:EncRtdIflinkLogEn_failed_flag
  • 64ull - l3:EncRtdIfid_failed_flag
  • 65536ull - l3:EncRtdIfsnmpTrap_failed_flag
  • 8192ull - l3:EncRtdIfmtuInherit_failed_flag
  • 8ull - l3:EncRtdIfdelay_failed_flag
  • DEFAULT: 0
    • ethpmCfgFailedTs
    scalar:Uint64
    ethpmCfgState
    scalar:UByte
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    ifConnDnreference:BinRef
    		Interface Connectivity Dn
    lcOwnNANANA
    linkLogEn
    l1:LinkLog
    scalar:Enum8    		A property to indicate if the encapsulation routed interface link logging is enabled.SELECTION:
  • 1 - default
  • 2 - enable
  • 3 - disable
  • default: 1
  • DEFAULT: default(1)
    • mediumTypel1:Medium
    (scalar:Enum8)    		Interface Medium TypeSELECTION:
    1 - broadcast
    2 - p2p
    DEFAULT: broadcast
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    monPolDn
    reference:BinRef    		The monitoring policy for the encapsulation routed interface object.
    mtul1:Mtu
    (scalar:Uint32)    		The encapsulation routed interface MTU.
    RANGE: [576 , 9216]
    DEFAULT: 1500
    mtuInheritscalar:Bool
    		The encapsulation routed interfac3 inherit MTU from global policy.SELECTION: true or false
    DEFAULT: true
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    routerMacaddress:MAC
    		The encapsulation routed interface MAC router.Value must match MM:MM:MM:SS:SS:SS format
    DEFAULT: not-applicable
    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 a Fabric-Facing Port on an Ethernet Interface

    Configuring a Fabric-Facing Port on an Ethernet Interface


    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/1
     port-type fabric

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}
    l1PhysIfExtended sys/intf/phys-{[id]}/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
    portTypeFabricl1:PortTypeFabric
    (scalar:Enum8)    		Identifies if or not the port is a fabric-facing portSELECTION:
    0 - no
    1 - yes
    DEFAULT: no


    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 Fabric-Facing Port configured on an Ethernet Interface

    Deleting a Fabric-Facing Port configured on an Ethernet Interface


    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/1
     no port-type fabric

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}
    l1PhysIfExtended sys/intf/phys-{[id]}/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
    portTypeFabricl1:PortTypeFabric
    (scalar:Enum8)    		Identifies if or not the port is a fabric-facing portSELECTION:
    0 - no
    1 - yes
    DEFAULT: no


    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 Packet Timestamping (Egress Direction)

    Configuring Packet Timestamping (Egress Direction)

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

    interface ethernet 1/3
     timestamp egress id 123

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}


    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
    packetTimestampEgressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Egress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    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 Packet Timestamping (Ingress Direction)

    Configuring Packet Timestamping (Ingress Direction)

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

    interface ethernet 1/3
     timestamp ingress id 123

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}


    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
    packetTimestampIngressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Ingress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    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 Packet Timestamping (Ingress and Egress Directions)

    Configuring Packet Timestamping (Ingress and Egress Directions)

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

    interface ethernet 1/3
     timestamp ingress id 123 egress id 123

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}


    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
    packetTimestampEgressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Egress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampIngressSourceIdl1:PacketTimestampSourceId
    (scalar:Uint32)    		 Ingress timestamp Source Id
    RANGE: [0 , 8388606]
    DEFAULT: 0
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    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 a Packet Timestamp Configuration

    Deleting a Packet Timestamp Configuration

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

    interface ethernet 1/3
     no timestamp

    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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-{[id]}


    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
    packetTimestampStatel1:PacketTimestampState
    (scalar:Enum8)    		 packet timestamp feature stateSELECTION:
    0 - disable
    1 - enable-ingress
    2 - enable-egress
    3 - enable-both
    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 DFE Tuning Delay

    Configuring DFE Tuning Delay

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


    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/3
      dfe-tuning-delay 7375


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


    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
    dfeTuningDelayl1:DfeTuningDelay
    (scalar:Uint16)    		DFE (Decision Feedback Equalizer) Tuning Delay
    RANGE: [100 , 10000]
    DEFAULT: 100
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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 DFE Tuning Delay

    Deleting DFE Tuning Delay

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


    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/3
      no dfe-tuning-delay 7375


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


    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
    dfeTuningDelayl1:DfeTuningDelay
    (scalar:Uint16)    		DFE (Decision Feedback Equalizer) Tuning Delay
    RANGE: [100 , 10000]
    DEFAULT: 100
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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 Audo MDIX Mode

    Configuring Audo MDIX Mode

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


    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/3
      mdix auto


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


    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
    mdixl1:Mdix
    (scalar:Enum8)    		The administrative Mdix mode. The Medium-dependant interface crossover (Mdix) is when the interface automatically detects the required cable connection type (straight through or crossover) and configures the connection appropriately. SELECTION:
    1 - auto
    2 - mdi
    3 - mdi-x
    DEFAULT: auto


    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 Audo MDIX Mode

    Deleting Audo MDIX Mode

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


    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/3
      no mdix auto


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


    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
    mdixl1:Mdix
    (scalar:Enum8)    		The administrative Mdix mode. The Medium-dependant interface crossover (Mdix) is when the interface automatically detects the required cable connection type (straight through or crossover) and configures the connection appropriately. SELECTION:
    1 - auto
    2 - mdi
    3 - mdi-x
    DEFAULT: auto


    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 Description

    Configuring a Description

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


    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/3
      description 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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-[eth1/3]


    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
    descr
    naming:Descr1024
    string:Basic    		Additional descriptive information about the object. RANGE: Min: "0" Max: "254"
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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 Description

    Deleting a Description

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


    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/3
      no description 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
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-[eth1/3]


    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
    descr
    naming:Descr1024
    string:Basic    		Additional descriptive information about the object. RANGE: Min: "0" Max: "254"
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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 Outside Nat Interface

    Configuring Outside Nat Interface

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


    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
     ip nat outside


    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
    interfaceEntitysys/intf
    l1PhysIfsys/intf/phys-[eth1/2]
    natDomsys/nat/inst/dom-default
    natEntitysys/nat
    natInstsys/nat/inst


    natDom Properties

    The following table contains information about the natDom 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
    name
    naming:Name256
    string:Basic    		The name of the object. RANGE: Min: "1" Max: "128"


    natIf Properties

    The following table contains information about the natIf 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
    natIfnat:NatTrafficDir
    (scalar:Enum8)    		NAT interface config inside/outsideSELECTION:
    0 - ip-nat-invalid
    1 - ip-nat-inside
    2 - ip-nat-outside


    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


    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

    For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

    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 Outside Nat Interface

    Deleting Outside Nat Interface

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


    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
     no ip nat outside


    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
    interfaceEntitysys/intf
    l1PhysIfsys/intf/phys-[eth1/2]
    natDomsys/nat/inst/dom-default
    natEntitysys/nat
    natIfsys/nat/inst/dom-default/if-[eth1/2]
    natIfsys/nat/inst/dom-default/if-[po123]
    natIfsys/nat/inst/dom-default/if-[vlan1]
    natInstsys/nat/inst


    natDom Properties

    The following table contains information about the natDom 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
    name
    naming:Name256
    string:Basic    		The name of the object. RANGE: Min: "1" Max: "128"


    natIf Properties

    The following table contains information about the natIf 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		Modification statusSELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    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


    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

    For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

    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 Inside Nat Interface

    Configuring Inside Nat Interface

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


    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
     ip nat inside


    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
    interfaceEntitysys/intf
    l1PhysIfsys/intf/phys-[eth1/2]
    natDomsys/nat/inst/dom-default
    natEntitysys/nat
    natInstsys/nat/inst


    natDom Properties

    The following table contains information about the natDom 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
    name
    naming:Name256
    string:Basic    		The name of the object. RANGE: Min: "1" Max: "128"


    natIf Properties

    The following table contains information about the natIf 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
    natIfnat:NatTrafficDir
    (scalar:Enum8)    		NAT interface config inside/outsideSELECTION:
    0 - ip-nat-invalid
    1 - ip-nat-inside
    2 - ip-nat-outside


    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


    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

    For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

    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 Inside Nat Interface

    Deleting Inside Nat Interface

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


    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
     no ip nat inside


    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
    interfaceEntitysys/intf
    l1PhysIfsys/intf/phys-[eth1/2]
    natDomsys/nat/inst/dom-default
    natEntitysys/nat
    natIfsys/nat/inst/dom-default/if-[eth1/2]
    natIfsys/nat/inst/dom-default/if-[po123]
    natIfsys/nat/inst/dom-default/if-[vlan1]
    natInstsys/nat/inst


    natDom Properties

    The following table contains information about the natDom 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
    name
    naming:Name256
    string:Basic    		The name of the object. RANGE: Min: "1" Max: "128"


    natIf Properties

    The following table contains information about the natIf 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		Modification statusSELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    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


    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

    For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

    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 IPv6 Stateless Address Autoconfig (For SLAAC)

    Configuring IPv6 Stateless Address Autoconfig (For SLAAC)

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


    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
      ipv6 address autoconfig default


    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
    ipv6Entity sys/ipv6
    ipv6Inst sys/ipv6/inst
    ipv6Dom sys/ipv6/inst/dom-default
    ipv6If sys/ipv6/inst/dom-default/if-[eth1/2]
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-[eth1/2]


    ipv6Dom Properties

    The following table contains information about the ipv6Dom 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
    name
    naming:Name256
    string:Basic    		The name of the object. RANGE: Min: "1" Max: "128"


    ipv6If Properties

    The following table contains information about the ipv6If 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
    autoconfignw:AdminSt
    (scalar:Enum8)    		IPv6 Stateless address autoconfigSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    defaultRoutenw:AdminSt
    (scalar:Enum8)    		Default Route Addition with Nexthop as RA Source AddressSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    useLinkLocalAddrnw:AdminSt
    (scalar:Enum8)    		IPv6 Address Use Link Local AddressSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled


    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


    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 IPv6 Stateless Address Autoconfig (For SLAAC)

    Deleting IPv6 Stateless Address Autoconfig (For SLAAC)

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


    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
      no ipv6 address autoconfig default


    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
    ipv6Entity sys/ipv6
    ipv6Inst sys/ipv6/inst
    ipv6Dom sys/ipv6/inst/dom-default
    ipv6If sys/ipv6/inst/dom-default/if-[eth1/2]
    interfaceEntity sys/intf
    l1PhysIf sys/intf/phys-[eth1/2]


    ipv6Dom Properties

    The following table contains information about the ipv6Dom 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
    name
    naming:Name256
    string:Basic    		The name of the object. RANGE: Min: "1" Max: "128"


    ipv6If Properties

    The following table contains information about the ipv6If 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
    autoconfignw:AdminSt
    (scalar:Enum8)    		IPv6 Stateless address autoconfigSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    useLinkLocalAddrnw:AdminSt
    (scalar:Enum8)    		IPv6 Address Use Link Local AddressSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled


    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


    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 Shutdown for All LAN VLANs on an Interface

    Configuring Shutdown for All LAN VLANs on an Interface

    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 Shutdown for All LAN VLANs on an Interface

    Deleting Shutdown for All LAN VLANs on an Interface

    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 UPDOWN and CHANGE Messages

    Configuring UPDOWN and CHANGE Messages

    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
      logging event port link-status


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


    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
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default


    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 UPDOWN and CHANGE Messages

    Deleting UPDOWN and CHANGE Messages

    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
      no logging event port link-status


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


    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
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default


    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 UPDOWN and CHANGE Messages (Using the Default Value)

    Configuring UPDOWN and CHANGE Messages (Using the Default Value)

    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
      logging event port link-status default


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


    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
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default


    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 UPDOWN and CHANGE Messages (Using the Default Value)

    Deleting UPDOWN and CHANGE Messages (Using the Default Value)

    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
      no logging event port link-status default


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


    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
    linkLogl1:LinkLog
    (scalar:Enum8)    		Administrative link logging enableSELECTION:
    1 - default
    2 - enable
    3 - disable
    DEFAULT: default


    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 SNMP LINKUP and LINKDOWN Traps

    Configuring SNMP LINKUP and LINKDOWN Traps

    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
      snmp trap link-status


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


    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
    snmpTrapStl1:SnmpTrapSt
    (scalar:Enum8)    		Administrative port snmp trap stateSELECTION:
    1 - enable
    2 - disable
    DEFAULT: enable


    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 SNMP LINKUP and LINKDOWN Traps

    Deleting SNMP LINKUP and LINKDOWN Traps

    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
      no snmp trap link-status


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


    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
    snmpTrapStl1:SnmpTrapSt
    (scalar:Enum8)    		Administrative port snmp trap stateSELECTION:
    1 - enable
    2 - disable
    DEFAULT: enable


    Related Documentation

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

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

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

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

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

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

    Next