The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter provides information about the Cisco Nexus 1000V application programming interface (API) functions. The functions are grouped under two namespaces—n1k and hyper-v. The functions that support write (create, update, and delete) operations are explicitly marked as writeable. All others are read-only functions.
The functions are the following:
Retrieves license-usage information. This function is equivalent to the show license usage command.
|
|
---|---|
|
|
---|---|
Retrieves information about Cisco Nexus 1000V modules. This function is equivalent to the show module command.
|
|
---|---|
Number of CPU licenses used by the Virtual Ethernet Module (VEM). |
|
Number of virtual network interface cards (vNICs) on the host. |
|
Retrieves information about the Cisco Nexus 1000V uplink ports.
|
|
---|---|
Retrieves information about the Cisco Nexus 1000V virtual ports.
|
|
---|---|
Retrieves a list of the Cisco Nexus 1000V port profiles in use on a specific module.
Retrieves a list of Cisco Nexus 1000V virtual ports in use on a specific module.
Retrieves a list of uplink ports in use on a specific module and related information.
Retrieves information that is associated with the Virtual Switch Extension Module (VSEM) object. For any external switch device managed by the Virtual Machine Manager (VMM), the VMM associates it to a VSEM object.
|
|
---|---|
Retrieves the VSM information needed by VMM to associate it to a switch extension. A VSEM can contain one or more switch extensions. For the Cisco Nexus 1000V, a VSEM can contain only one switch extension.
Retrieves a list of virtual port profiles. A virtual port profile is a port profile that can be attached to a virtual interface.
|
|
---|---|
ID of the switch extension to which to publish this port profile. |
[“/api/n1k/uplink-port-profile”]
Retrieves a list of uplink port profiles. An uplink port profile is a port profile that can be attached to a physical interface.
|
|
---|---|
ID of the switch extension on which to publish this port profile. |
|
Retrieves information for the Cisco Nexus 1000V switch port analyzer (SPAN) and the encapsulated remote SPAN (ERSPAN).
|
|
|
---|---|---|
The mtu value for the monitor session (the values can be <50-9000>). |
||
The ip dscp value for the monitor session (the values can be <0-63>). |
||
The source interface/vlan/port-profile which has the type/direction/source |
||
The IP precedence value for the monitor session (the values can be <0-7>). |
||
The type of the session (the values can be <local, erspan-source>). |
Yes 1 |
|
Yes 1 |
||
The destination vethernet interfaces for the monitor session. |
||
The header type for the monitor session ( the values can be <2-3>). |
||
The IP time-to-live value value for the monitor session (the values can be <1-255>). |
||
The erspan ID for the monitor session (the values can be <1-1023>). |
||
1.Indicates that the property value can be set from REST during creation but not during updation/modification. |
Retrieves information about users for the Cisco Nexus 1000V.
|
|
|
---|---|---|
Yes 2 |
||
2.Indicates that the property value can be set from REST during creation but not during updation/modification. |
Retrieves information about the Cisco Nexus 1000V port profiles.
Retrieves information about the Cisco Nexus 1000V port profiles.
|
|
|
---|---|---|
Yes 3 |
||
Yes 1 |
3.Indicates that the property value can be set using REST during creation but not during updation/modification. |
Retrieves a list of logical networks. This function represents a logical network that spans across multiple sites represented by multiple subnets.
|
|
|
---|---|---|
Yes 4 |
||
4.Indicates that the property value can be set using REST during creation but not during updation/modification. |
Retrieves a list of network segment pools. The network segment pools contain one or more network segments that represent a logical network in a location. This fuunction is equivalent to the VMM network segment pool.
|
|
|
---|---|---|
Network segments in this pool that can have an associated IP pool. |
||
Yes 5 |
5.Indicates that the property value can be set using REST during creation but not during updation/modification. |
Retrieves the Layer-3 information associated with the Layer-2 network. Every network segment is associated with an IP address pool.
|
|
|
---|---|---|
Yes 6 |
||
List of static IP addresses excluded from allocation by VMM. |
6.Indicates that the property value can be set using REST during creation but not during updation/modification. |
Retrieves a list of ethernet network segments. An ethernet network segment represents a HNV provider address subnet.
|
|
|
---|---|---|
Network segment pool to which this network segment belongs to. |
||
Name of the IP pool that is inherited in the network segment |
||
Yes7 |
||
ID of the network segment pool that this network segment inherits |
||
7.Indicates that the property value can be set using the REST API during creation but you can not update it later. |
Retrieves a list of network segments. A network segment represents a subnet.
|
|
|
---|---|---|
Network segment pool that this network segment is a member of. |
||
Yes 8 |
||
8.Indicates that the property value can be set using REST during creation but not during updation/modification. |
Retrieves a list of network uplinks. A network uplink can contain more than one network segment pool.
|
|
|
---|---|---|
Yes9 |
||
9.Indicates that the property value can be set using the REST API during creation but you can not update it later. |
Retrieves a list of virtual machine (VM) networks. A network segment can contain one or more network segments. For VLAN-based networks, a network segment can contain only one network segment.
|
|
|
---|---|---|
Yes 10 |
||
10.Indicates that the property value can be set using REST during creation but not during updation/modification. |
This section provides the REST API history.
|
|
|
---|---|---|
Added span, port-profile(write capability), and user resources APIs. |
||
Added Ethernet Network Segment and Network Uplink REST APIs. |