Web Services API Guide, Cisco DCNM for LAN, Release 5.x
SVSDomainApp Service
Downloads: This chapterpdf (PDF - 87.0KB) The complete bookPDF (PDF - 11.08MB) | Feedback

SvsDomainApp Service

Table Of Contents

SvsDomainApp Service

Information About SvsDomainApp Service

bindSvsDomainSettingToVlan

deleteSvsDomainSettingInNetworkElements

fetchCurrentSvsNeighborsInNetworkElements

getSvsDomainSettingInNetworkElements

getSvsNeighborsInNetworkElements

getSystemVlansInNetworkElements

modifySvsDomainSettings

unbindVlanFromSvsDomainSetting


SvsDomainApp Service


This chapter describes the DCNM web services' API methods for the SvsDomainApp service. This API is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Information About SvsDomainApp Service

SvsDomainApp service helps to configure the domain configurations on the VSM. The Virtual Supervisor Module (VSM) and Virtual Ethernet Module (VEM) are separated within the Layer 2 domain. To allow VSM-VEM pairs to communicate within the same Layer 2 domain, each pair must have a unique identifier.

The svs domain configuration includes the following attributes.

Domain ID—Unique id assigned to VSM which ranges from 1 to 4095. It ensures that VEMs do not respond to commands from non-participating VSMs. Each packet between VSM and VEM is tagged with the appropriate Domain ID

Control Vlan— All the control traffic between the VSM and the VEM is carried over the configured control VLAN.

Packet Vlan — All the data traffic between the VSM and the VEM is carried over the configured packet VLAN.

Svs Mode— Represents the mode of connectivity which could be Layer2 or Layer3. A management or control interface needs to be configured if the mode is Layer3.

bindSvsDomainSettingToVlan

Associates a SvsDomainSetting to Vlan in a specified SvsCtrlModeType.

ParameterException is thrown if any of the following situations occur:

If domainSettingInstanceNameId is null

If domainSettingInstanceNameId is not a valid InstanceNameId.

If the vlanInstanceNameIdis null or invalid InstanceNameId of a Vlan.

If the systemVlanType is null.

Parameters

opContext— operational context.

domainSettingInstanceNameId—InstanceNameId of aSvsDomainSetting object.

vlanId—Integer value of a Vlan object.

systemVlanType—systemVlanType can either be "CONTROL" or "PACKET".

Return Value

List of newly created SystemVlanForSvsDomain objects

deleteSvsDomainSettingInNetworkElements

Deletes Svs Domain Setting in network.

ValidationException is thrown if the following situation occur:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for neId does not exist.

Parameters

neInstanceNameId—Instance name ID of network element for which Vrf are to be queried.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

Return Value

void

fetchCurrentSvsNeighborsInNetworkElements

Returns Svs Neighbors information corresponding to the network elements by sending request to the device.

ValidationException is thrown if the following situation occur:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for neId does not exist.

Parameters

neInstanceNameId—Instance name ID of network element for which Vrf are to be queried.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

Return Value

List of SvsNeighbor objects.

getSvsDomainSettingInNetworkElements

Returns Svs Domain information corresponding to the network element.

ValidationException is thrown if the following situation occur:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for neId does not exist.

Parameters

neInstanceNameId—Instance name ID of network element for which Vrf are to be queried.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

destinationPrefix—Destination for which the routes are to be queried for.

Return Value

List of UnicastRoutes.

getSvsNeighborsInNetworkElements

Returns Svs Neighbors information corresponding to the network elements.

ValidationException is thrown if the following situation occur:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for neId does not exist.

Parameters

neInstanceNameId—Instance name ID of network element for which Vrf are to be queried.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

ipNetworkInterfaceName—IpNetworkInterface for which the routes are to be queried for.

Return Value

void.

getSystemVlansInNetworkElements

Returns the system vlans configured in SVS Domain setting for the given network elements.

ValidationException is thrown if the following situation occur:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for neId does not exist.

Parameters

neInstanceNameId—Instance name ID of network element for which Vrf are to be queried.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

nextHopAddress—next hop address for which the routes are to be queried for.

Return Value

List of Pairs containing vlan ids .

The first element in the pair represents the control vlan id and the second element represents the packet vlan id configured for the SvsDomainSetting in the network elements. If the SvsDomainSetting is not configured in the network elements, the list will contain an empty pair.

modifySvsDomainSettings

Modify a collection of Svs Domain Setting objects.

ValidationException is thrown if the following situation occur:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for neId does not exist.

Parameters

neInstanceNameId—Instance name ID of network element for which Vrf are to be queried.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

routeOrigin—Route Origin for which the routes are to be queried for. TBD: Route Origin is declared as Enumeration type routeOriginType in IM { direct, local,static,am, bgp,ospf,isis,rip,eigrp}.

Return Value

void.

unbindVlanFromSvsDomainSetting

Clears the VLAN association from a SvsDomainSetting for specific SystemVlanType and bind default Vlan to given SystemVlanType.

ParameterException is thrown if any of the following situations occur:

If svsDomainSettingInstanceNameId is null or it is not a valid InstanceNameId of a SvsDomainSetting object.

If the systemVlanType is null.

Parameters

vrfInstanceNameIdCol—List of Instance name ID of vrf for which you query Urib Status.

afi—AddressFamily that the routes are to be queried for. afi can be either "IPV4" or "IPV6".

Return Value

void