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

FipSnoopingApp Service

Table Of Contents

FipSnoopingApp Service

Information About FipSnoopingApp Service

disableFipSnooping

disableFipSnoopingOnVlans

enableFipSnooping

enableFipSnoopingOnVlans

fetchActiveFipSnoopingSessionsInNetworkElements

getActiveFcoeNodesInInterfaces

getActiveFcoeNodesInNetworkElements

getActiveFcoeNodesInVlans

getFipSnoopingEnabledVlansInNetworkElement

getFipSnoopingGlobalSetting

getFipSnoopingInterfaceSettingsForInterfaces

getFipSnoopingStateOfNetworkElements

getFipSnoopingVlanSettingsForVlans

modifyFipSnoopingInterfaceSettings

modifyFipSnoopingVlanSettings

validateVlansForFipSnooping


FipSnoopingApp Service


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

Information About FipSnoopingApp Service

This chapter defines the APIs that you can use to get and set information about FipSnoopingApp on the DCNM server.

disableFipSnooping

Disables FIP snooping on one or more network elements. Given the instance name ID of one or more network elements, FIP snooping feature will be disabled on those elements. This API can be used to disable FIP snooping for the Nexus devices supporting this feature.

ValidationException is thrown if any of the following situation occurs:

If the neIdCol is null.

If the neIdCol contains one or more null element, or the collection is empty

If any of the given network element does not support FIP snooping.

Parameters

opContext - Operational Context

neIdCol - list of InstanceNameId of the Network Element for which the FIP snooping should be enabled

Returns

void.

disableFipSnoopingOnVlans

Disables FIP snooping on the VLANs corresponding to the specified InstanceNameId collection.

ValidationException is thrown if any of the following situation occurs:

If the vlanIdCol is null.

If the vlanIdCol contains one or more null element, or the collection is empty

If any of the network element to which the VLAN , where FIP snooping needs to be disabled, belong does not support FIP snooping

Parameters

opContext - Operational Context

vlanIdCol - list of InstanceNameId objects of the VLANs where FIP snooping should be disabled.

Returns

List of InstanceNameIds of the FipSnoopingVlanSetting objects corresponding to the VLANs specified.

enableFipSnooping

Enables FIP snooping on one or more network elements. Given the instance name ID of one or more network elements, FIP snooping feature will be enabled on those elements. This API can be used to enable FIP snooping for the Nexus devices supporting this feature.

ValidationException is thrown if any of the following situation occurs:

If the neIdCol is null.

If the neIdCol contains one or more null element, or the collection is empty

If any of the given network element does not support FIP snooping.

Parameters

opContext - Operational Context

neIdCol - list of InstanceNameId of the Network Element for which the FIP snooping should be enabled

enableFipSnoopingOnVlans

Enables FIP snooping on the VLANs corresponding to the specified InstanceNameId collection.

ValidationException is thrown if any of the following situation occurs:

If the vlanIdCol is null.

If the vlanIdCol contains one or more null element, or the collection is empty

If any of the network element to which the VLAN , where FIP snooping needs to be enabled, belong does not support FIP snooping

Parameters

opContext - Operational Context

vlanIdCol - list of InstanceNameId objects of the VLANs where FIP snooping should ne enabled.

Returns

List of InstanceNameIds of the FipSnoopingVlanSetting objects corresponding to the VLANs specified.

fetchActiveFipSnoopingSessionsInNetworkElements

Fetches the active FIP sessions between FCFs and ENodes that are being snooped by the specified network elements. Given a list of InstanceNameId object of the network elements, this API will return the associated list of ActiveFipSession objects as a list in the same order.

Following associations will be available for each ActiveFipSession:

1. Active FCF

2. Active ENode

ValidationException is thrown if any of the following situation occurs:

If neIdCol is null or empty

If any of the elements in the collection is null or is not a valid network element InstanceNameId

Parameters

opContext - Operational Context.

neIdCol - InstanceNameIds of the network elements.

Returns

List of ActiveFipSession objects list corresponding to the specified InstanveNameId list. If there is no active FIP session on a specified network element, then the corresponding entry in the returned list will be an empty list.

getActiveFcoeNodesInInterfaces

Returns the FCoE forwarders (FCoE switches) and ENodes (hosts/servers) which has active FIP sessions through the specified interfaces. Given a list of InstanceNameId objects of the interested interfaces, this API will return the associated list of ActiveFcoeNode objects as a list in the same order.

Following associations will be available for each ActiveFcoeNode instance:

VLAN reference

ValidationException is thrown if any of the following situation occurs:

If ifIdCol is null or empty

If any of the elements in the collection is null or is not a valid network interface InstanceNameId

Parameters

opContext - Operational Context.

ifIdCol - InstanceNameIds of the interfaces.

Returns

List of ActiveFcoeNode objects list corresponding to the specified InstanceNameId list. If there is no active FCFs or ENodes on a specified interface, then the corresponding entry in the returned list will be an empty list.

getActiveFcoeNodesInNetworkElements

Returns the FCoE forwarders (FCoE switches) and ENodes (hosts/servers) connected through the specified network elements . Given a list of InstanceNameId objects of the interested network elements, this API will return the associated list of ActiveFcoeNode objects as a list in the same order.

Following associations will be available for eachActiveFcoeNode instance:

1. Network Interface reference

2. VLAN reference

ValidationException is thrown if any of the following situation occurs:

If neIdCol is null or empty

If any of the elements in the collection is null or is not a valid network element InstanceNameId

Parameters

opContext - Operational Context.

neIdCol - InstanceNameId of the network elements.

Returns

List of ActiveFcoeNode objects list corresponding to the specified InstanceNameId list. If there is no active FCoE Nodes (ENodes or FCFs) on a specified network element, then the corresponding entry in the returned list will be an empty list.

getActiveFcoeNodesInVlans

Returns the FCoE forwarders (FCoE switches) and ENodes (hosts/servers) which has active FIP sessions on the specified VLANs. Given a list of InstanceNameId objects of the interested VLANs, this API will return the associated list of ActiveFcoeNode objects as a list in the same order.

Following associations will be available for each ActiveFcoeNode instance:

Network Interface reference

ValidationException is thrown if any of the following situation occurs:

If vlanIdCol is null or empty

If any of the elements in the collection is null or is not a valid VLAN InstanceNameId

Parameters

opContext - Operational Context.

vlanIdCol - InstanceNameId of the VLANs.

Returns

List of ActiveFcoeNode objects list corresponding to the specified InstanceNameId list. If there is no active ENodes or FCFs on a specified VLAN, then the corresponding entry in the returned list will be an empty list.

getFipSnoopingEnabledVlansInNetworkElement

Returns the FIP snooping enabled VLAN objects in each of the network elements corresponding to the specified InstanceNameId list . Given the instance name ID of one or more network elements, this API will return only the FIP snooping enabled VlanExternal objects in each network element

Following associations will be available for each VLAN:

1. VLAN Status

2. FIP Snooping VLAN Settings

ValidationException is thrown if any of the following situation occurs:

If neIdCol is null or empty

If any of the elements in the collection is null or is not a valid network element InstanceNameId

Parameters

opContext - Operational Context.

neIdCol - InstanceNameId of Network Elements.

Returns

List of VlanExternal instances list for each specified network element InstanceNameId in the same order.

getFipSnoopingGlobalSetting

Returns the device level FIP snooping global settings for one or more network elements. Given the instance name ID of one or more network elements, it returns the corresponding FipSnoopingGlobalSetting object for those network elements.

ValidationException is thrown if any of the following situation occurs:

If neIdCol collection contains an element that is null or the collection is empty.

If the argument passed is null or it is not a valid network element InstanceNameId

Parameters

opContext - Operational Context

neIdCol - list of InstanceNameId of the Network Element for which the FIP snooping global settings are required

Returns

FIP snooping global settings configured in the given network elements. The returned list will contain the list of FipSnoopingGlobalSetting instances.

getFipSnoopingInterfaceSettingsForInterfaces

Returns the FIP snooping settings for the specified interfaces. Given a list of InstanceNameId objects corresponding to the interested interfaces, this API will return the associated FipSnoopingInterfaceSettings objects as a list in the same order.

ValidationException is thrown if any of the following situation occurs:

If ifIdCol is null or empty

If any of the elements in the collection is null or is not a valid network interface InstanceNameId

Parameters

opContext - Operational context.

ifIdCol - InstanceNameId of the interfaces.

Returns

List of FipSnoopingInterfaceSettings objects corresponding to the specified InstanceNameId list.

getFipSnoopingStateOfNetworkElements

Returns state of the FIP snooping feature for a list of network elements. Given the list of instance name IDs of the network elements, returns the list of Boolean objects.

ValidationException is thrown if any of the following situation occurs:

If neIdCol collection contains an element that is null or the collection is empty .

If the argument passed is null or it is not a valid network element InstanceNameId.

Parameters

opContext - Operational Context

neIdCol - InstanceNameId of the one or more Network Element for which the FIP snooping state is required

Returns

The returned list will contain Boolean instances.

Boolean value TRUE represents FIP snooping is enabled in the given network element.

Boolean value FALSE represents FIP snooping is disabled in the given network element.

getFipSnoopingVlanSettingsForVlans

Returns the FIP snooping settings for the specified VLANs. Given a list of InstanceNameId objects corresponding to the interested VLANs, this API will return the associated FipSnoopingVlanSettings objects as a list in the same order.

ValidationException is thrown if any of the following situation occurs:

If vlanIdCol is null or empty

If any of the elements in the collection is null or is not a valid VLAN InstanceNameId

Parameters

opContext - Operational Context.

vlanIdCol - InstanceNameId of VLANs.

Returns

List of FipSnoopingVlanSettings objects corresponding to the specified InstanceNameId list.

modifyFipSnoopingInterfaceSettings

Modifies existing FIP snooping interface settings for one or more interfaces belonging to one or more network elements.Following are the FIP snooping interface settings that can be modified through this API.

FIP snooping port mode

ValidationException is thrown if any of the following situation occurs:

If the fipSnoopingIfSettings is null.

If the fipSnoopingIfSettings contains one or more null element, or the collection is empty

If any of the network element to which the interface , whose FIP snooping setting is being modified, belong does not support FIP snooping

If any of the interface , whose FIP snooping global setting is being modified, does not support FIP snooping.

Parameters

opContext - Operational Context

fipSnoopingIfSettings - list of FipSnoopingInterfaceSettings objects which should be modified.

Returns

void.

modifyFipSnoopingVlanSettings

Modifies existing FIP snooping VLAN settings for one or more VLANs belonging to one or more network elements. As of now following are the FIP snooping VLAN settings that can be modified through this API.

FIP snooping state

FC MAP value

ValidationException is thrown if any of the following situation occurs:

If the fipSnoopingVlanSettings is null.

If the fipSnoopingVlanSettings contains one or more null element, or the collection is empty.

If any of the network element to which the VLAN , whose FIP snooping setting is being modified, belong does not support FIP snooping

Parameters

opContext - Operational Context

fipSnoopingVlanSettings - list of FipSnoopingVlanSettings objects which should be modified.

Returns

void.

validateVlansForFipSnooping

Retrieves each Vlan object with the specified ids from each of the network elements corresponding to the specified InstanceNameId objects and if the Vlan object exists, it will check for the following conditions and will throw ValidationException if any of the condition fails.

1. VLAN should not be a private VLAN

2. VLAN should not be a CIN VLAN

3. VLAN should not have any VACL associated with it

This API will not throw any exception if a Vlan object does not exist with the specified id on a network element.

ValidationException is also thrown if any of the following situation occurs:

If neNameIdCol is null or empty

If vlanIds is null or empty

If any of the elements in the collection is null or is not a valid network element InstanceNameId

Parameters

opContext - Operational Context

vlanIds - List of Integer representing the VLAN id.

neNameIdCol - InstanceNameId collection of network elements

Returns

void.