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

SvsConnectionApp Service

Table Of Contents

SvsConnectionApp Service

Information About SvsConnectionApp Service

createSvsConnectionInNetworkElements

deleteSvsConnectionSettingInNetworkElements

disableSvsConnections

enableSvsConnections

getSvsConnectionsInNetworkElements

modifySvsConnections


SvsConnectionApp Service


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

Information About SvsConnectionApp Service

SvsConnectionApp service helps to establish connectivity between the VSM and the vCenter. Each VSM will have its unique auto generated XML Extension File.

The API categories are as follows:

Query/Get APIs—Query data from the persisted database.

Create APIs—Create new SVS CONNECTION.

Modify APIs—Modify existing SVS CONNECTION.

Delete APIs—Delete existing SVS CONNECTION.

createSvsConnectionInNetworkElements

Create SvsConnection settings for the given network elements.

ValidationException is thrown if any of the following situation occurs:

If value of SvsConnectionSettingCol are null or an SvsConnectionSetting is null.

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occur:

If the corresponding object for InstanceNameId in neId does not exist.

Parameters

opContext—operational context.

neIds—InstanceNameIds of network elements on which the Svs Connection Setting parameters are to be created.

svsConnectionSettingCol—Svs Connection Setting collection which includes the connection attributes to be configured.

Return Value

List of newly created SystemVlanForSvsDomain objects

deleteSvsConnectionSettingInNetworkElements

Deletes SvsConnection Setting for a network Element

ValidationException is thrown if any of the following situation occurs:

If the elements of svsConnInstanceNameIds are not valid InstanceNameId of SvsConnectionSetting.

IntegrityException is thrown if any of the following situation occurs:

If the corresponding AbstractNetworkElement objects for the InstanceNameId in the neNameIds does not exist.

Parameters

opContext—Operational context.

svsConnInstanceNameIds—List of InstanceNameIds of the svs connections configured on the devices which has to be deleted.

Return Value

void

disableSvsConnections

Disables SvsConnection for the given device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

If the neIds collection is empty or the collection contains object which are not a valid network element InstanceNameId

Parameters

opContext—Operational context.

svsConnInstanceNameIds—List of InstanceNameIds of the svs connections configured on the devices which has to be deleted.

Return Value

void.

enableSvsConnections

Enables SVS Connections for the given device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

If the neIds collection is empty or the collection contains object which are not a valid network element InstanceNameId.

Parameters

opContext—Operational context.

neIds—InstanceNameId corresponding to the network elements

Return Value

List of UnicastRoutes.

getSvsConnectionsInNetworkElements

Returns Svs Connections information corresponding to the network element.

ValidationException is thrown if the following situation occurs:

If neIds are null or not an InstanceNameId of AbstractNetworkElement.

IntegrityException is thrown if the following situation occurs:

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

List of SvsConnectionSetting objects.

The returned list will contain the list of following instances:

SvsConnectionStatusRef SvsConnectionStatus representing the operational status sync status of the svs connection.

modifySvsConnections

Modify a collection of Svs Connection Setting objects.

ValidationException is thrown if the following situation occurs:

If modifiedSvsConnectionSettingCol is null or empty.

PropertiesException is thrown if the following situation occurs:

If any of the attributes for SvsConnectionSetting object modifiedSvsConnectionSettingCol is not valid or not supported based on the platform type.

IntegrityException is thrown if the following situation occurs:

If the corresponding object for the objects in the modifiedSvsConnectionSettingCol SvsConnectionSetting collection does not exist.

Parameters

opContext—Operational context.

modifiedSvsConnectionSettingCol—List of modified SvsConnectionSetting objects.

Return Value

List of SvsConnectionSetting objects.

The returned list will contain the list of following instances:

SvsConnectionStatusRef SvsConnectionStatus representing the operational status sync status of the svs connection.