Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
- Cisco Nexus 3000 and 9000 Series NX-API REST Documentation
- Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
- Getting Started with the Cisco Nexus 3000 and 9000 Series NX-API REST SDK
- Related Documentation
- New and Changed Information
- Manageability
- ISSU Commands
- Installing Software Packages
- Configuring NX-API Management
- Managing Images
- Manageability Actions
- Configuring GRPC tunnel destination
- Manageability Using YANG (NETCONF)
- Configuring Fundamentals
- High Availability and Redundancy
- Configuring ITD
- Configuring Interfaces
- Configuring Ethernet Interfaces
- Configuring a MAC Address Limitation
- Configuring VLAN Interfaces
- Configuring Loopback Interfaces
- Configuring MGMT Interfaces
- Configuring Breakout Profiles
- Configuring System Default Switchport
- Configuring UDLD
- Configuring BFD
- Configuring LACP
- Configuring Hostname Loopback
- Configuring Breakout on High-Bandwidth Interfaces
- Configuring Port-Channel Interfaces
- Configuring Virtual Port Channels
- Configuring Tunnel Interfaces
- Configuring Layer 2 Protocol Tunneling
- Configuring Network Address Translation (NAT)
- Configuring IP TCP MSS
- Configuring Hardware Profile Settings
- Querying Interface Information
- Clearing Statistics
- Configuring IP SLAs
- Configuring Label Switching
- Configuring Segment Routing
- Configuring MPLS LDP
- Configuring Label Advertisement
- Configuring Label Allocation
- Configuring MPLS
- Disabling MPLS Forwarding for IP
- Configuring LDP Session Backoff
- Configuring LDP Discovery
- Configuring Explicit Null Label Advertisement
- Configuring LDP Graceful Restart
- Configuring LDP Holdtime
- Configuring a Neighbor
- Configuring an LDP Password
- Configuring LDP Logging
- Configuring LDP Labels
- Configuring an LDP Session
- Configuring MPLS LDP on an Interface
- Configuring Netstack
- Configuring Layer 2 Switching
- Configuring Flex Links
- Configuring Hairpin Forwarding
- Configuring Storm Control
- Configuring a Private VLAN (PVLAN)
- Configuring Multicast Routing
- Configuring PIM/PIM6
- Configuring MSDP
- Configuring IGMP
- Configuring MLD Snooping
- Configuring MRIB
- Configuring RPF Routes for Multicast
- Configuring Fabric Extender
- Configuring QoS
- Configuring Policing
- Configuring QoS Class Maps
- Configuring QoS Policy Maps
- Configuring a User-Defined Network QoS Policy
- Configuring the Hardware Buffer Utilization Thresholds
- Configuring Hardware QoS
- Configuring Hardware Profile Settings on the Cisco Nexus 3500 Platform
- Configuring Cisco Nexus 9000 (Cisco-ASIC based) Platform QoS
- Configuring Priority Flow Control
- Changing the Bandwidth Allocated to Unicast and Multicast Traffic
- Clearing Statistics
- Configuring TCAM
- Enabling Queue-Based ECN Marking
- Configuring Trust Boundaries
- Configuring Security
- Configuring FIPS Mode
- Configuring EAP Profile
- Configuring Keychain Management
- Configuring AAA
- Configuring RADIUS
- Configuring TACACS+
- Configuring LDAP
- Configuring SSH
- Configuring a Trustpool Policy
- Configuring a Trustpoint Certificate Authority
- Configuring a Trustpoint Certificate Authority
- Configuring Certificate Authority Related Information
- Crypto ca import for mytrustpoint pkcs12
- Configuring Telnet
- Configuring the Shell Type for Login
- Configuring User Accounts and RBAC
- Configuring the VSH Roles and Rules
- Configuring ACLs
- Configuring Port Security
- Configuring DHCP
- Configuring Password Encryption
- Configuring VPN Ids
- Configuring Unicast RPF (URPF)
- Configuring System Security Compliance
- Configuring Control Plane Policing
- Configuring Rate Limits
- Configuring MACsec
- Known Behaviour for Logging Level Configs
- Configuring System Management
- Configuring Sup Boot Variables
- Configuring System Cores
- Configuring System Trace Level
- Configuring the Fast Reload Network Stabilization Timer
- Configuring Frequency Synchronization
- Configuring NTP
- Configuring PTP
- Verifying PTP Counters
- Configuring Cisco Discovery Protocol
- Configuring Call Home
- Configuring Checkpoints and Rollback
- Configuring System Logging
- Configuring the Scheduler
- Configuring SNMP
- Configuring RMON
- Configuring Online Diagnostics
- Configuring EVMED
- Configuring Embedded Event Manager
- Configuring Memory Thresholds
- Configuring SPAN
- Configuring ERSPAN
- Configuring LLDP
- Enabling and Disabling LLDP
- Configuring LLDP in Global Mode
- Configuring LLDP on the if-eth-base/if-ethernet-all Command Mode
- Configuring LLDP on the if-gig-ether Command Mode
- Configuring LLDP on the if-gig-ether-all Command Mode
- Configuring LLDP on the if-mgmt-ether Command Mode
- Configuring the DCBXP Version
- Configuring System Interface Shutdown
- Configuring NetFlow
- Configuring Drop Report Tool
- Configuring sFlow
- Attaching a TAP Aggregation Policy to an Interface
- Configuring MPLS Stripping
- Configuring the Maintenance-Mode Profile
- Configuring Maintenance Mode
- Configuring CFS
- Configuring User-Defined Fields
- Configuring a Fan-Direction Mismatch
- System-Level High Availability
- Configuring NX-OS Container Tracker
- Configuring VXLAN
- VXLAN New and Changed
- Micro-segmentation for VXLAN Fabrics Using Group Policy Option (GPO)
- Configuring VXLAN BGP EVPN
- Configuring HMM
- Configure VXLAN FHS
- VXLAN Configuration Command Examples
- Configuring NVE Interfaces
- Configuring BGP EVPN Filtering
- Configuring VXLAN OAM (NGOAM)
- Executing Ping NVE, Traceroute NVE, and Path Trace NVE
- Configuring System NVE
- Associating NVE Interfaces with VNIs
- Configuring ngMVPN
- Configuring Selective Q-in-VNI
- Ephemeral (MOTL) MOs for NVE
- Configuring Unicast Routing
- Configuring the System Routing Mode
- Configuring ARP
- Configuring ALPM
- Configuring Logging for Software Forwarding of IP Packets
- Configuring DNS
- Configuring OSPF, OSPFv2, and OSPFv3
- Configuring OSPF
- Configuring OSPFv2
- Configuring OSPFv3
- Configuring an IPv6 Unicast Address Family Under an OSPFv3 Instance
- Configuring OSPFv3 Broadcast Network Type
- Configuring OSPFv3 on an Ethernet Interface
- Configuring OSPFv3 on a Loopback Interface
- Configuring OSPFv3 on a MGMT Interface
- Configuring OSPFv3 on a P2P Ethernet Interface
- Configuring OSPFv3 on a Tunnel Interface
- Configuring a Virtual Link Under an OSPFv3 Instance
- Configuring a VRF Under an OSPFv3 Instance
- Querying OSPFv3
- Configuring IS-IS
- Configuring IS-IS in Global Configuration Command Mode
- Configuring IS-IS in Interface Configuration Mode
- Configuring IS-IS in Router Configuration Mode
- Configuring IS-IS in Router VRF Configuration Mode
- Configuring IS-IS in Router IPv4 Address Family Configuration Mode
- Configuring IS-IS in Router IPv6 Address Family Configuration Mode
- IS-IS Operational Commands
- Configuring EIGRP
- Enabling EIGRP
- Disabling EIGRP
- Configuring isolate Under EIGRP
- Configuring flush-routes under EIGRP
- Configuring vrf
- Configuring EIGRP address-family
- Configuring EIGRP router-id
- Configuring EIGRP distance
- Configuring EIGRP maximum paths
- Configuring EIGRP default information originate
- Configuring EIGRP administrative state
- Configuring IPV4 EIGRP route redistribution
- Configuring IPv6 EIGRP route redistribution
- Configuring EIGRP table map filter
- Configuring EIGRP redistribute maximum prefix
- Configuring EIGRP graceful restart
- Configuring EIGRP log adjacency changes
- Configuring EIGRP log adjacency warnings
- Configuring EIGRP metric version
- Configuring EIGRP metric maximum hops
- Configuring EIGRP nsf await redistribute proto convergence
- Configuring EIGRP autonomous system number
- Configuring EIGRP nsf route-hold timer
- Configuring EIGRP nsf converge timer
- Configuring EIGRP nsf signal timer
- Configuring EIGRP timers active-time
- Configuring EIGRP supress fib pending
- Configuring EIGRP passive interface
- Configuring EIGRP metric weights
- Configuring EIGRP default metric
- Configuring EIGRP stub
- Configuring EIGRP authentication key chain
- Configuring EIGRP authentication mode
- Configuring BFD for EIGRP
- Configuring EIGRP in Interface Configuration Mode
- Configuring BGP
- Configuring a BGP Router
- VXLAN EVPN Traffic Engineering - Multi-Site Egress Load-Balancing
- VXLAN EVPN Traffic Engineering – RPM support
- Configuring BGP on a VRF
- Configuring BFD Multihop under a Neighbor
- Configuring an IPv4 Multicast Address Family
- Configuring an IPv4 MVPN Address Family
- Configuring an IPv4 Unicast Address Family
- Configuring an IPv6 MVPN Address Family
- Configuring an IPv6 Unicast Address Family
- Configuring a Link-State Address Family
- Configuring a VPNv4 Unicast Address Family
- Configuring a VPNv6 Unicast Address Family
- Configuring a Peer Policy Template
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Policy Template
- Configuring an IPv4 Unicast Subaddress Family for a Peer Policy Template
- Configuring an IPv6 Unicast Subaddress Family for a Peer Policy Template
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Policy Template
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Policy Template
- Configuring a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a Peer Template
- Configuring an IPv4 Labeled Subaddress Family for a Peer Template
- Configuring an IPv4 Unicast Subaddress Family for a Peer Template
- Configuring an IPv6 Unicast Subaddress Family for a Peer Template
- Configuring a VPNv4 Subaddress Family for a Peer Template
- Configuring a VPNV6 Subaddress Family for a Peer Template
- Configuring Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a Peer Template with Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a BGP Neighbor (IP Address)
- Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Labeled Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Multicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv4 MVPN Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 MVPN Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an L2VPN EVPN Address Family under a BGP Neighbor (IP Address)
- Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring a VPNv6 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring BGP Session Templates Under a BGP Neighbor (IP Address)
- Configuring a BGP Neighbor (Ethernet Interface)
- Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring an IPv6 MVPN Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring an L2VPN EVPN Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a VPNv6 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a BMP Server
- Configuring Mixed ECMP
- About Querying Ephemeral Data
- Configuring RIP
- Configuring DSCP
- Configuring VRFs
- Configuring Route Policy Manager
- First-Hop Redundancy Protocols
- Configuring Hardware Forwarding
- Configuring Hardware Ejector
- Configuring Hardware Profile Settings
- Configuring the Site of Origin
- Configuring AS-4 Dot Notation
- Configuring Static Routing
- Configuring Load Sharing in the Unicast FIB
- Configuring OpenFlow
- Configuring RTP Flow Monitoring
- Configuring Kernel Stack
- Configuring Apphosting
- Controlling the Guest Shell
- Enabling the Guest Shell and Querying the Result
- Disabling the Guest Shell and Querying the Result
- Destroying the Guest Shell and Querying the Result
- Rebooting the Guest Shell and Querying the Result
- Increasing the Guest Shell Rootfs Size and Querying the Result
- Changing the CPU Memory Size that the Guest Shell Uses and Querying the Result
- Changing the Memory Size the Guest Shell Uses and Querying the Result
- Syncing the Guest Shell Rootfs to the Standby Supervisor and Querying the Result
- Exporting the Guest Shell Rootfs and Querying the Result
- Upgrading the Guest Shell Rootfs and Querying the Result
- Querying Guest Shell Information
- Change Virtual Service Global Configuration
- Managing System Hardware
- Configuring the Baseboard Management Controller
- Configuring Virtual Machine Tracker
- Configuring Virtual Device Contexts
- Configuring iCAM
- Configuring SRv6
- Configuring Smart Software Licensing
- Querying Configurations (Show Commands)
- Querying Advertised Routes
- Querying DHCP Relay Interfaces
- Querying Diagnostic Result Test IDs
- Querying the Environment Settings
- Querying Feature Status
- Querying Inventory Information
- Querying IS-IS Configurations
- Querying IP IGMP Groups
- Querying IP OSPF Neighbor Details
- Querying IP OSPF Neighbor VRF Information
- Querying L2VPN EVPN
- Querying LLDP
- Querying MAC Address Table Info
- Querying Module Information
- Querying NAT ITD
- Querying NTP Peer Status
- Querying an OSPFv2 Instance
- Querying Patterns
- Querying PIM Information
- Querying the Processes Log
- Querying Spanning Tree Information
- Querying a Summary of IP Interface Status and Configuration Information
- Querying TCAM Resource Utilization
- Querying MCAST NAT TCAM Resource Monitoring
- Querying NBM TCAM Resource Monitoring
- Querying the Version
- Querying VLAN ID Counters
- Querying VRF Information
- Querying VRRP Information
- Querying Forwarding Route Information
- Querying IP Route Details
- Querying the Current MOTD Banner Message
- Querying OSPF Neighbors
- Querying Analytic Information
- Querying Interface and VLAN Counters and Statistics
- Querying ITD Runtime Information
- Querying ePBR Runtime Information
- Using the Managed Object Browser
- Monitoring the Environment
Querying IS-IS Statistics
DME
YANG
CopyGET: /api/mo/sys/isis/inst-1/dom-default/oper.json?rsp-subtree=full
{
"totalCount": "1",
"imdata": [
{
"isisOperIsis": {
"attributes": {
"dn": "sys/isis/inst-1/dom-default/oper",
"lspPurged": "0",
"lspRefreshed": "6",
"lspSourced": "4",
"modTs": "2021-03-16T07:35:02.783+00:00",
"spfCalc": "13"
},
"children": [
{
"isisOperIf": {
"attributes": {
"disElections": "4",
"id": "vlan10",
"modTs": "2021-03-16T07:35:02.522+00:00",
"rn": "operif-[vlan10]"
}
}
},
{
"isisAdj": {
"attributes": {
"modTs": "2021-03-16T07:35:02.431+00:00",
"rn": "adj"
},
"children": [
{
"isisLevel": {
"attributes": {
"cktType": "l1",
"modTs": "2021-03-16T07:35:02.431+00:00",
"rn": "level-[l1]"
},
"children": [
{
"isisAdjIf": {
"attributes": {
"adjRestartSupport": "1",
"adjRestartSuppress": "0",
"areaAddress": "47.0004.004d.",
"baseTopoIpv4": "yes",
"baseTopoIpv6": "no",
"cktId": "switch.01",
"holdTimer": "00:00:33",
"id": "vlan10",
"level": "l1",
"modTs": "2021-03-16T07:40:13.516+00:00",
"multiTopoIpv4": "no",
"multiTopoIpv6": "no",
"multitopology": "no",
"operSt": "up",
"peerIpv4": "9.9.9.2",
"peerIpv6": "0::",
"priority": "64",
"rn": "adjif-[vlan10]",
"snpa": "5221.149e.1b08",
"sysName": "switch",
"upTime": "00:05:11"
}
}
}
]
}
},
{
"isisLevel": {
"attributes": {
"cktType": "l2",
"modTs": "2021-03-16T07:35:02.431+00:00",
"rn": "level-[l2]"
},
"children": [
{
"isisAdjIf": {
"attributes": {
"adjRestartSupport": "1",
"adjRestartSuppress": "0",
"areaAddress": "47.0004.004d.",
"baseTopoIpv4": "yes",
"baseTopoIpv6": "no",
"cktId": "switch.01",
"holdTimer": "00:00:31",
"id": "vlan10",
"level": "l2",
"modTs": "2021-03-16T07:40:14.234+00:00",
"multiTopoIpv4": "no",
"multiTopoIpv6": "no",
"multitopology": "no",
"operSt": "up",
"peerIpv4": "9.9.9.2",
"peerIpv6": "0::",
"priority": "64",
"rn": "adjif-[vlan10]",
"snpa": "5221.149e.1b08",
"sysName": "switch",
"upTime": "00:05:11"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
Response
{
imdata:[]
}
Copy<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:44fe0521-ef1f-48e0-82e7-da0461d54a7e">
<nc:get>
<nc:filter>
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<isis-items>
<inst-items>
<Inst-list>
<name>1</name>
<dom-items>
<Dom-list>
<name>default</name>
<oper-items/>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</isis-items>
</System>
</nc:filter>
</nc:get>
</nc:rpc>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:44fe0521-ef1f-48e0-82e7-da0461d54a7e">
<data>
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<isis-items>
<inst-items>
<Inst-list>
<name>1</name>
<dom-items>
<Dom-list>
<name>default</name>
<oper-items>
<adj-items>
<level-items>
<Level-list>
<cktType>l2</cktType>
<adjif-items>
<AdjIf-list>
<id>vlan10</id>
<adjRestartSupport>1</adjRestartSupport>
<adjRestartSuppress>0</adjRestartSuppress>
<areaAddress>47.0004.004d.</areaAddress>
<baseTopoIpv4>true</baseTopoIpv4>
<baseTopoIpv6>false</baseTopoIpv6>
<cktId>switch.01</cktId>
<holdTimer>00:00:30</holdTimer>
<level>l2</level>
<multiTopoIpv4>false</multiTopoIpv4>
<multiTopoIpv6>false</multiTopoIpv6>
<multitopology>false</multitopology>
<operSt>up</operSt>
<peerIpv4>9.9.9.2</peerIpv4>
<peerIpv6>0::</peerIpv6>
<priority>64</priority>
<snpa>5221.149e.1b08</snpa>
<sysName>switch</sysName>
<upTime>00:01:24</upTime>
</AdjIf-list>
</adjif-items>
</Level-list>
<Level-list>
<cktType>l1</cktType>
<adjif-items>
<AdjIf-list>
<id>vlan10</id>
<adjRestartSupport>1</adjRestartSupport>
<adjRestartSuppress>0</adjRestartSuppress>
<areaAddress>47.0004.004d.</areaAddress>
<baseTopoIpv4>true</baseTopoIpv4>
<baseTopoIpv6>false</baseTopoIpv6>
<cktId>switch.01</cktId>
<holdTimer>00:00:32</holdTimer>
<level>l1</level>
<multiTopoIpv4>false</multiTopoIpv4>
<multiTopoIpv6>false</multiTopoIpv6>
<multitopology>false</multitopology>
<operSt>up</operSt>
<peerIpv4>9.9.9.2</peerIpv4>
<peerIpv6>0::</peerIpv6>
<priority>64</priority>
<snpa>5221.149e.1b08</snpa>
<sysName>switch</sysName>
<upTime>00:01:23</upTime>
</AdjIf-list>
</adjif-items>
</Level-list>
</level-items>
</adj-items>
<lspPurged>0</lspPurged>
<lspRefreshed>12</lspRefreshed>
<lspSourced>4</lspSourced>
<operif-items>
<OperIf-list>
<id>vlan10</id>
<disElections>2</disElections>
</OperIf-list>
</operif-items>
<spfCalc>12</spfCalc>
</oper-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</isis-items>
</System>
</data>
</rpc-reply>