Cisco DCNM Web Services API Guide, Release 4.2
DhcpSnoopApp Service
Downloads: This chapterpdf (PDF - 175.0KB) The complete bookPDF (PDF - 7.93MB) | Feedback

DhcpSnoopingApp Service

Table Of Contents

DhcpSnoopingApp Service

Information About DhcpSnoopingApp Service

addStaticBindings

clearRateLimitingConfigurationInInterfaces

deleteAllBindings

deleteAllBindingsInNetworkElements

deleteAllDynamicBindingsInInterfaces

deleteAllDynamicBindingsInNetworkElements

deleteAllDynamicBindingsInVlanOfAnInterface

deleteAllStaticBindingsInInterfaces

deleteAllStaticBindingsInNetworkElements

deleteAllStaticBindingsInVlanOfAnInterface

deleteDynamicBindings

deleteStaticAndDynamicBindings

deleteStaticBindings

disableDhcpSnoopingInNetworkElement

disableDhcpSnoopingOnVlans

disableDhcpSnoopingService

enableDhcpSnoopingOnVlans

enableDhcpSnoopingOnVlansByRange

enableDhcpSnoopingService

getDhcpSnoopingDisabledVlansInNetworkElement

getDhcpSnoopingEnabledVlansInNetworkElement

getDhcpSnoopingGlobalSettingOnNetworkElements

getDhcpSnoopingServiceStateInNetworkElements

getDhcpSnoopingSettingOnVlans

getDynamicBindingsInInterface

getInterfacesWithDhcpRateLimitingInNetworkElement

getInterfacesWithDynamicBindingsInNetworkElement

getInterfacesWithStaticBindingsInNetworkElement

getNumberOfDynamicBindingsInVlans

getNumberOfStaticBindingsInVlans

getStaticBindingsInInterface

getStaticBindingsInVlanOfAnInterface

getStaticDhcpSnoopingBindings

getTrustStateSettingOnInterfaces

getUntrustedInterfacesWithDefaultRateLimitInNetwork
Element

getVlansWithDhcpSnoopingInNetworkElement

modifyDhcpSnoopingGlobalSetting

modifyStaticBindings

modifyTrustStateSettings


DhcpSnoopingApp Service


This chapter describes the DCNM web services' API methods for the DhcpSnoopingApp service.

Information About DhcpSnoopingApp Service

This chapter defines the APIs exposed by the DHCP snooping feature service.

addStaticBindings

Creates static binding entries given a list of static binding entry objects.

ValidationException is thrown if any of the following situation occurs:

If the dhcpSnoopingBindings collection is null or the collection is empty.

If the dhcpSnoopingBindings collection contains one or more null element, or the collection contains objects that are not of type DhcpSnoopingBinding.

If any of the DhcpSnoopingBinding, in the dhcpSnoopingBindings collection does not contain value for abstractNetworkElementRef.

If the AbstractNetworkElement specified by abstractNetworkElementRef in any of the DhcpSnoopingBinding objects in the collection dhcpSnoopingBindings does not exist in the database.

If any of the DhcpSnoopingBinding, in the dhcpSnoopingBindings collection does not contain value for networkInterfaceRef.

If the NetworkInterface specified by networkInterfaceRef in any of the DhcpSnoopingBinding objects in the collection dhcpSnoopingBindings does not exist in the database.

If any of the DhcpSnoopingBinding, in the dhcpSnoopingBindingsdoes not contain value for vlanRef.

If the (@link com.cisco.dcbu.dcm.model.VLAN.VlanExternal} specified by vlanRef in any of the DhcpSnoopingBinding objects in the collection dhcpSnoopingBindings does not exist in the database.

IntegrityException is thrown if any of the DhcpSnoopingBinding objects in the dhcpSnoopingBindings collection already exist.

PropertiesException is thrown if any of the following situation occurs:

If any of the attributes of DhcpSnoopingBinding object in the collection dhcpSnoopingBindings is not valid.

If the lease expiry time specified for any of the DhcpSnoopingBinding objects in the dhcpSnoopingBindings collection, got expired.

Parameters

opContext—Operational context

dhcpSnoopingBindings—A collection having objects of type DhcpSnoopingBinding. Each object represents an entry in DHCP Snooping binding table in the device.

Return Value

A collection of InstanceNameId of the new binding entries.

clearRateLimitingConfigurationInInterfaces

Clears the DHCP rate limiting configurations done in a collection of untrusted interfaces. This API also restores the DHCP rate limiting to default value.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or empty or it is not of type InstanceNameId.

If any of the interface specified by its InstanceNameId in the collection interfaceInstanceNameIds does not exist in the database.

Parameters

opContext—Operational context

interfaceInstanceNameIds—- A collection of InstanceNameId of interfaces.

Return Value

void

deleteAllBindings

Deletes both static and dynamic entries configured in all the VLANs in a given interface, given the InstanceNameId of the interfaces.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or not a valid interface instance name ID.

If the interface does not exist in the database.

If the interface does not contain any DhcpSnoopingBinding associated to it.

Parameters

opContext—Operational context

interfaceInstanceNameIds—- A collection of InstanceNameId of the interfaces whose bindings are to be deleted.

Return Value

void

deleteAllBindingsInNetworkElements

Deletes both static and dynamic entries configured in the network elements, given the InstanceNameId of the network elements.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or not a valid network element instance name ID.

If the network element does not exist in the database.

If the network element does not contain any DhcpSnoopingBinding associated to it.

Parameters

opContext—Operational context

networkElementIds—- A collection of InstanceNameId of the network elements in which the bindings are to be deleted.

Return Value

void

deleteAllDynamicBindingsInInterfaces

Deletes all dynamically learned entries corresponding to a collection of interfaces in binding table, given the InstanceNameId of the interfaces.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or not a valid interface instance name ID.

If the interface does not exist in the database.

If the interface does not contain any DhcpSnoopingBinding associated to it

Parameters

opContext—Operational context

interfaceInstanceNameIds—- A collection of InstanceNameId of the interfaces in which bindings are to be deleted.

Return Value

void

deleteAllDynamicBindingsInNetworkElements

Deletes all dynamic binding entries in a given collection of network elements, given the InstanceNameId of the network elements.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or not a valid network element instance name ID.

If the network element does not exist in the database.

If the network element does not contain any DhcpSnoopingBinding associated to it

Parameters

opContext—Operational context

networkElementIds—- A collection of InstanceNameId of the network element in which bindings are to be deleted.

Return Value

void

deleteAllDynamicBindingsInVlanOfAnInterface

Deletes all dynamic binding entries configured in a given VLAN in an interface, given the InstanceNameId of the interface and VLAN.

ValidationException is thrown if any of the following situation occurs:

If the interfaceInstanceNameIdargument passed is null or not a valid interface instance name ID.

If the interface does not exist in the database.

If the vlanInstanceNameId argument passed is null or not a valid VLAN instance name ID.

If the VLAN does not exist in the database.

If the VLAN does not contain any DhcpSnoopingBinding associated to it

Parameters

opContext—Operational context

vlanInstanceNameId—- InstanceNameId of the VLAN in which the bindings are to be deleted.

interfaceInstanceNameIds—- A collection of InstanceNameId of the interfaces in which bindings are to be deleted for the given VLAN.

Return Value

void

deleteAllStaticBindingsInInterfaces

Deletes all static binding entries configured in a given collection of interfaces, given the InstanceNameId of the interfaces.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or not a valid interface instance name ID.

If the interface does not exist in the database.

If the interface does not contain any DhcpSnoopingBinding associated to it

Parameters

opContext—Operational context

interfaceInstanceNameIds—- A collection of InstanceNameId of the interfaces in which bindings are to be deleted.

Return Value

void

deleteAllStaticBindingsInNetworkElements

Deletes all static binding entries in a given collection of network elements, given the InstanceNameId of the network elements.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or not a valid network element instance name ID.

If the network element does not exist in the database.

If the network element does not contain any DhcpSnoopingBinding associated to it.

Parameters

opContext—Operational context

networkElementIds—- A collection of InstanceNameId of the network elements in which bindings are to be deleted.

Return Value

void

deleteAllStaticBindingsInVlanOfAnInterface

Deletes all static binding entries configured in a given VLAN in an interface, given the InstanceNameId of the interface and VLAN.

ValidationException is thrown if any of the following situation occurs:

If the argument interfaceInstanceNameId is null or not a valid interface instance name ID.

If the interface does not exist in the database.

If the argument vlanInstanceNameId is null or not a valid VLAN instance name ID.

If the VLAN does not exist in the database.

If the VLAN does not contain any DhcpSnoopingBinding associated to it

Parameters

opContext—Operational context

interfaceInstanceNameId—- InstanceNameId of the interface in which bindings are to be deleted for the given VLAN.

vlanInstanceNameId—- InstanceNameId of the VLAN in which the bindings are to be deleted.

Return Value

void

deleteDynamicBindings

Deletes dynamically learned entries in binding table, given the InstanceNameId of the DHCP snooping binding.

ValidationException is thrown if any of the following situation occurs:

If the collection dhcpSnoopingBindingsis null or empty.

If any of the element in the collection dhcpSnoopingBindings is null or not a valid DHCP snooping binding instance name ID.

If the DHCP snooping binding does not exist in the database.

Parameters

opContext—Operational context

dhcpSnoopingBindings—- A collection of InstanceNameId of the DHCP snooping bindings that are to be deleted.

Return Value

void

deleteStaticAndDynamicBindings

Deletes both static and dynamic entries configured in a particular VLAN in an interfae, given the InstanceNameId of the interface and VLAN.

ValidationException is thrown if any of the following situation occurs:

If the interfaceInstanceNameIdargument passed is null or not a valid interface instance name ID.

If the interface does not exist in the database.

If the vlanInstanceNameIdargument passed is nullor not a valid VLAN instance name ID.

If the VLAN does not exist in the database.

If the VLAN does not contain any DhcpSnoopingBinding associated to it

Parameters

opContext—Operational context

vlanInstanceNameId—- InstanceNameId of the VLAN in which the bindings are to be deleted.

interfaceInstanceNameIds—- A collection of InstanceNameId of the interfaces in which bindings are to be deleted for the given VLAN.

Return Value

void

deleteStaticBindings

Deletes static binding entries from the DHCP snooping binding table, given the InstanceNameId of the DHCP snooping bindings.

ValidationException is thrown if any of the following situation occurs:

If the collection dhcpSnoopingBindingsis null or empty.

If any of the element in the collection dhcpSnoopingBindings is null or not a valid DHCP snooping binding instance name ID.

If the DHCP snooping binding does not exist in the database.

Parameters

opContext—Operational context

dhcpSnoopingBindings—- A collection of InstanceNameId of the DHCP snooping bindings that are to be deleted.

Return Value

void

disableDhcpSnoopingInNetworkElement

Disables DHCP snooping in a network element, given its instance name ID.

ValidationException is thrown if any of the following situation occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of network element in which DHCP snooping is to be disabled.

Return Value

void

disableDhcpSnoopingOnVlans

Disables DHCP snooping in VLANs, given the list of InstanceNameId of the VLANs.

ValidationException is thrown if any of the following situation occurs:

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

If the VLAN does not exist in the database.

Parameters

opContext—Operational context

vlanInstanceNameId—- List of InstanceNameId of VlanExternal in which DHCP snooping is to be disabled.

Return Value

void

disableDhcpSnoopingService

Disables DHCP snooping Service in a InstanceNameId network element. Service Enabling/Disabling is supported in DC OS platform. If this API is called with the network elements of Catalyst 6500 series switches then FeatureException will be thrown.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null.

If neInstanceNameIdCol does not contain a valid network element InstanceNameId.

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameIdCol—- A collection of InstanceNameId of the network elements.

Return Value

void

enableDhcpSnoopingOnVlans

Enables DHCP snooping in VLANs, given the list of InstanceNameId of the VLANs.

ValidationException is thrown if any of the following situation occurs:

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

If the VLAN does not exist in the database.

Parameters

opContext—Operational context

vlanInstanceNameIds—- List of InstanceNameId of VlanExternals in which DHCP snooping has to be enabled.

Return Value

void

enableDhcpSnoopingOnVlansByRange

Enables DHCP snooping in a pre-provisioned VLAN. It is possible to enable DHCP Snooping just by using VLAN IDs. The VLANs in which DHCP snooping has to be enabled need not actually exist in the device. This API addresses this pre-provisioning configuration.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameId is null.

If neInstanceNameId is not a valid network element InstanceNameId.

If the network element does not exist in the database.

If the argument vlanRange is null.

Parameters

opContext—Operational context

vlanRange—- A String representing the range of VLANs. The string holds comma separated / hyphenated list of VLANs. For example, vlanRange could be 4,6,9,15-20,25.

Return Value

void

enableDhcpSnoopingService

Enables DHCP snooping Service in a InstanceNameId network element. Service Enabling/Disabling is supported in DC OS platform. If this API is called with the network elements of Catalyst 6500 series switches then FeatureException will be thrown.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null.

If neInstanceNameIdCol does not contain a valid network element InstanceNameId.

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameIdCol—- A collection of InstanceNameId of the network elements.

Return Value

void

getDhcpSnoopingDisabledVlansInNetworkElement

Returns a collection of DHCP snooping disabled VLANs in a given network element given the InstanceNameId of the network element.

ValidationException is thrown if any of the following situation occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of the network element.

Return Value

A list of DHCP snooping disabled VlanExternal objects. In the returned list, only the associations with DhcpSnoopingSetting will be present and other associations will be cleared.

getDhcpSnoopingEnabledVlansInNetworkElement

Returns a collection of DHCP snooping enabled VLANs in a given network element given the InstanceNameId of the network element.

ValidationException is thrown if any of the following situation occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

networkElementId—- InstanceNameId of the network element.

Return Value

A list of DHCP snooping enabled VlanExternal objects. In the returned list, only the association with DhcpSnoopingSetting will be present and other associations will be cleared.

getDhcpSnoopingGlobalSettingOnNetworkElements

Returns a collection of DHCP snooping global settings, given the InstanceNameId of the network elements.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or empty or if any of the element in the collection is not a valid network element InstanceNameId.

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameIds—- A collection of InstanceNameId of the network elements.

Return Value

A collection of DhcpSnoopingGlobalSetting objects for network elements.

getDhcpSnoopingServiceStateInNetworkElements

Returns state of DhcpSnoopingService like whether DhcpSnoopingService is enabled or disabled in a list of network elements. Given the list of instance name IDs of the network elements, returns a array of Boolean values.

ValidationException is thrown if any of the following situation occurs:

if the argument passed is null

If neInstanceNameIdCol collection contains an element that is null or the collection is empty or it is not type InstanceNameId.

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

Parameters

opContext—Operational context

neInstanceNameIdCol—InstanceNameId of the one or more Network Element for which the DhcpSnoopingService state is required

Return Value

The returned array will contain Boolean instances.

Boolean value TRUE indicates DhcpSnoopingService is enabled in the given network element.

Boolean value FALSE indicates DhcpSnoopingService is disabled in the given network element.

getDhcpSnoopingSettingOnVlans

Returns the DHCP snooping settings associated with the VLANs, given the list of InstanceNameId of VLANs

ValidationException is thrown if any of the following situation occurs:

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

If the VLAN does not exist in the device.

Parameters

opContext—Operational context

vlanInstanceNameIds—- A list of InstanceNameId of VLANs to be queried for DHCP snooping setting.

Return Value

A list of DhcpSnoopingSetting objects. The returned list will contain the DhcpSnoopingSetting objects pertaining to the given list of VLANs

getDynamicBindingsInInterface

Returns the dynamic bindings that are learnt in an interface, given the InstanceNameId of the interface.

ValidationException is thrown if any of the following situation occurs:

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

If the interface does not exist in the database.

Parameters

opContext—Operational context

interfaceInstanceNameId—- InstanceNameId of the interface.

Return Value

A collection of static binding configured in the given interface. Returned collection will have objects of type DhcpSnoopingBinding. In the returned list of objects only the following associations will be present and other associations will be cleared.

AbstractNetworkElement association.

NetworkInterfaceassociation.

VlanExternal association.

getInterfacesWithDhcpRateLimitingInNetworkElement

Returns all the interfaces having DHCP rate configured, given the InstanceNameId of network element.

ValidationException is thrown if any of the following situation occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of the network element.

Return Value

A collection of interface objects having DHCP rate limiting configured.In the returned list of objects, only the following associations will be present, and all other associations will be cleared.

TrustStateSetting association.

NetworkInterfaceName association.

getInterfacesWithDynamicBindingsInNetworkElement

Returns the interfaces having dynamic bindings in them, given the InstanceNameId of the network element. The network element is the device in which the interface is present.

ValidationException is thrown any of the following situations occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of network element

Return Value

A collection of interfaces in the network element in which dynamic bindings are learned. Returned collection will have InstanceNameIds of interface objects having dynamic bindings.In the returned list of objects, only the following associations will be present, and all other associations will be cleared.

DhcpSnoopingBindingassociation.

NetworkInterfaceName association.

getInterfacesWithStaticBindingsInNetworkElement

Returns the interfaces having static bindings configured in them, given the InstanceNameId of the network element. The network element is the device in which the interface is present.

ValidationException is thrown any of the following situations occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of network element

Return Value

A collection of interfaces in the network element in which static bindings are configured. Returned collection will have InstanceNameIds of interface objects having static bindings.In the returned list of objects, only the following associations will be present, and all other associations will be cleared.

DhcpSnoopingBindingassociation.

NetworkInterfaceName association.

getNumberOfDynamicBindingsInVlans

Returns the number of dynamic bindings configured in the VLANs given the InstanceNameId of the VLANs.

ValidationException is thrown if any of the following situation occurs:

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

If the VLAN does not exist in the device.

Parameters

opContext—Operational context

vlanInstanceNameIds—- A collection of InstanceNameId of VLANs.

Return Value

A collection of integer values representing the number of dynamic bindings configured in VLANs.

getNumberOfStaticBindingsInVlans

Returns the number of static bindings configured in a collection of VLANs, given the InstanceNameId of the VLANs.

ValidationException is thrown if any of the following situation occurs:

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

If the VLAN does not exist in the database.

Parameters

opContext—Operational context

vlanInstanceNameIds—- A collection of InstanceNameId of VLANs.

Return Value

A collection of integer values representing the number of static bindings configured in VLANs

getStaticBindingsInInterface

Returns the static bindings configured in an interface, given the InstanceNameId of the interface.

ValidationException is thrown if any of the following situation occurs:

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

If the interface does not exist in the database.

Parameters

opContext—Operational context

interfaceInstanceNameId—- InstanceNameId of the interface

Return Value

A collection of static binding configured in the given interface. Returned collection will have objects of type DhcpSnoopingBinding. In the returned list of objects, only the following associations will be present and other associations will be cleared.

AbstractNetworkElement association.

NetworkInterface association.

VlanExternal association.

getStaticBindingsInVlanOfAnInterface

Returns the static bindings configured in a VLAN in an interface, given the InstanceNameId of the VLAN and the interface.

ValidationException is thrown if any of the following situation occurs:

If the argument interfaceInstanceNameId passed is null or it is not a valid interface InstanceNameId.

If the interface does not exist in the database.

If the argument vlanInstanceNameId passed is null or it is not a valid VLAN InstanceNameId.

If the VLAN does not exist in the database.

Parameters

opContext—Operational context

interfaceInstanceNameId—- InstanceNameId of the interface

vlanInstanceNameId—- InstanceNameId of a VLAN in the interface

Return Value

A collection of static binding configured in given VLAN in an interface. Returned collection will have objects of type DhcpSnoopingBinding.In the returned list of objects, only the following associations will be present, and all other associations will be cleared.

AbstractNetworkElement association.

NetworkInterface association.

VlanExternal association.

getStaticDhcpSnoopingBindings

Returns a collection of DHCP snooping binding objects corresponding to the InstanceNameIds given.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid DHCP Snooping Binding InstanceNameId.

If the DHCP Snooping Binding does not exist in the database.

Parameters

opContext—Operational context

dhcpSnoopingBindings—a collection of InstanceNameId of DHCP snooping binding objects representing entries in the DHCP snooping binding table.

Return Value

A collection of DHCPSnoopingBinding objects DhcpSnoopingBinding.In the returned list of objects, only the following associations will be present, and all other associations will be cleared.

AbstractNetworkElement association.

NetworkInterface association.

VlanExternal association.

getTrustStateSettingOnInterfaces

Returns the DHCP snooping trust state settings configured in a collection of Layer 2 interfaces, given the InstanceNameId of the interfaces.

ValidationException is thrown if any of the following situation occurs:

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

If the interface does not exist in the database.

Parameters

opContext—Operational context

interfaceInstanceNameIds—- List of InstanceNameId of interfaces.

Return Value

A collection of TrustStateSetting objects corresponding to the given interfaces TrustStateSetting

getUntrustedInterfacesWithDefaultRateLimitInNetwork
Element

Returns all the untrusted interfaces having default DHCP rate, in a network element, given the InstanceNameId of network element.

ValidationException is thrown if any of the following situation occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of the network element.

Return Value

A collection of untrusted interface objects having default DHCP rate. In the returned list of objects, only the following associations will be present, and all other associations will be cleared.

TrustStateSetting association.

NetworkInterfaceName association.

getVlansWithDhcpSnoopingInNetworkElement

Returns a collection of VLANs which has DHCP snooping setting (DHCP snooping enabled and disabled) in a given network element given the InstanceNameId of the network element.This will not return the VLANs in which DHCP snooping is not supported.

ValidationException is thrown if any of the following situation occurs:

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

If the network element does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of the network element.

Return Value

A list of DHCP snooping enabled and disabled VlanExternal objects. In the returned list, only the associations with DhcpSnoopingSetting will be present and other associations will be cleared.

modifyDhcpSnoopingGlobalSetting

Modifies one or more attibutes of DhcpSnoopingGlobalSettings. Modification of "dhcpSnoopingServiceEnable" is not allowed in this API. If it is modified then MetadataException will be thrown. To enable/disable DHCP Snooping Service API.

ValidationException is thrown if any of the following situation occurs:

If the argument neInstanceNameId is null.

If neInstanceNameId is not a valid network element InstanceNameId.

If the argument dhcpSnoopingGlobalSetting is null.

PropertiesException is thrown if any of the attributes in dhcpSnoopingGlobalSetting object is invalid.

Parameters

opContext—Operational context

neInstanceNameId—- InstanceNameId of the network element.

dhcpSnoopingGlobalSetting—- Modified DhcpSnoopingGlobalSetting object that will replace the existing DhcpSnoopingGlobalSetting object in the database.

Return Value

void

modifyStaticBindings

Modifies one or more DHCP snooping binding objects that exist in the database.

ValidationException is thrown if any of the following situation occurs:

If the collection dhcpSnoopingBindings is null or empty.

If any of the element in the collection dhcpSnoopingBindings is null.

If any of the element in the collection dhcpSnoopingBindings is not of type DhcpSnoopingBinding.

PropertiesException is thrown if any of the attributes of DhcpSnoopingBinding is not valid.

Example:

If the value for IpAddress is not specified.

If the value for the MacAddress is not specified

If the value for the lease expiry time is not specified and etc.

Parameters

opContext—Operational context

dhcpSnoopingBindings—- A collection of modified DhcpSnoopingBinding entries.

Return Value

void

modifyTrustStateSettings

Modifies one or more existing trust state settings in the given collection of interfaces.

ValidationException is thrown if any of the following situation occurs:

If interfaceInstanceNameIds collection is null or it is empty.

If interfaceInstanceNameIds collection contains an object that is not of type NetworkInterface.

If TrustStateSetting is not supported in that interface. It is supported only in the interfaces of type SwitchedNetworkInterface and RoutedNetworkInterface.

If trustStateSettings collection is null or it is empty.

If trustStateSettings collection contains an object that is not of type TrustStateSetting.

IntegrityException is thrown if the interfaceInstanceNameIds and trustStateSettings collections size are not equal.

PropertiesException is thrown, if any of the attribute of TrustStateSetting is not valid.

Example: TrustState attribute in the TrustStateSetting object cannot have Trusted DHCP trust state, if the interface in which the TrustStateSetting is configured is a RoutedNetworkInterface.

Parameters

opContext—Operational context

interfaceInstanceNameIds—- A collection of InstanceNameIds of interfaces.

trustStateSetting—- A collection of modified TrustStateSetting object TrustStateSetting

Return Value

void