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 the Version
DME
YANG
CopyGET http://<IP_Address>/api/mo/sys/showversion.json
Response
{
"totalCount": "1",
"imdata": [
{
"sysmgrShowVersion": {
"attributes": {
"activePackage": "",
"biosCompileTime": "12/07/2015",
"biosVersion": "09.20",
"bootflashSize": "51496280",
"copyRight": "Cisco Nexus Operating System (NX-OS) Software\nTAC support: http://www.cisco.com/tac\nCopyright (C) 2002-2018, Cisco and/or its affiliates.\nAll rights reserved.\nThe copyrights to certain works contained in this software are\nowned by other third parties and used and distributed under their own\nlicenses, such as open source. This software is provided \"as is,\" and unless\notherwise stated, there is no warranty, express or implied, including but not\nlimited to warranties of merchantability and fitness for a particular purpose.\nCertain components of this software are licensed under\nthe GNU General Public License (GPL) version 2.0 or \nGNU General Public License (GPL) version 3.0 or the GNU\nLesser General Public License (LGPL) Version 2.1 or \nLesser General Public License (LGPL) Version 2.0. \nA copy of each such license is available at\nhttp://www.opensource.org/licenses/gpl-2.0.php and\nhttp://opensource.org/licenses/gpl-3.0.html and\nhttp://www.opensource.org/licenses/lgpl-2.1.php and\nhttp://www.gnu.org/licenses/old-licenses/library.txt.\n",
"dn": "sys/showversion",
"kernelUptime": "15 minute(s) 2 second(s) ",
"lastResetReason": "Reset Requested by CLI command reload",
"lastResetService": "",
"lastResetSysVersion": "9.2(1)",
"lastResetTime": "996434 usecs after Fri Jul 6 21:29:32 2018",
"nxosCompileTime": " 7/5/2018 21:00:00",
"nxosImageFile": "bootflash:///h232.bin",
"nxosVersion": "9.2(1)",
"plugin": "Core Plugin, Ethernet Plugin"
}
}
}
]
}
CopyGET: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/showversion-items/
<showversion-items>
<activePackage/>
<biosCompileTime>12/07/2015</biosCompileTime>
<biosVersion>09.20</biosVersion>
<bootflashSize>51496280</bootflashSize>
<copyRight>Cisco Nexus Operating System (NX-OS) Software
TAC support: http://www.cisco.com/tac
Copyright (C) 2002-2018, Cisco and/or its affiliates.
All rights reserved.
The copyrights to certain works contained in this software are
owned by other third parties and used and distributed under their own
licenses, such as open source. This software is provided "as is," and unless
otherwise stated, there is no warranty, express or implied, including but not
limited to warranties of merchantability and fitness for a particular purpose.
Certain components of this software are licensed under
the GNU General Public License (GPL) version 2.0 or
GNU General Public License (GPL) version 3.0 or the GNU
Lesser General Public License (LGPL) Version 2.1 or
Lesser General Public License (LGPL) Version 2.0.
A copy of each such license is available at
http://www.opensource.org/licenses/gpl-2.0.php and
http://opensource.org/licenses/gpl-3.0.html and
http://www.opensource.org/licenses/lgpl-2.1.php and
http://www.gnu.org/licenses/old-licenses/library.txt.
</copyRight>
<kernelUptime>16 minute(s) 2 second(s) </kernelUptime>
<lastResetReason>Reset Requested by CLI command reload</lastResetReason>
<lastResetService/>
<lastResetSysVersion>9.2(1)</lastResetSysVersion>
<lastResetTime>996434 usecs after Fri Jul 6 21:29:32 2018</lastResetTime>
<nxosCompileTime> 7/5/2018 21:00:00</nxosCompileTime>
<nxosImageFile>bootflash:///h232.bin</nxosImageFile>
<nxosVersion>9.2(1)</nxosVersion>
<plugin>Core Plugin, Ethernet Plugin</plugin>
</showversion-items>