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

InterfacesApp Service

Table Of Contents

InterfacesApp Service

Information About InterfacesApp Service

createLoopbackNetworkInterfaces

createRoutedSubNetworkInterfaces

createVirtualSwitchedNetworkInterfaces

createVlanNetworkInterfaces

deleteLogicalNetworkInterfaces

disableLldpService

disableSviService

disableUdldService

enableLldpService

enableSviService

enableUdldService

fetchCurrentTransceiverStatusForPorts

getAclAssociations

getActiveRoutedPortsCountInNetworkElement

getActiveSwitchedPortsCountInNetworkElement

getAdminDownRoutedPortsCountInNetworkElement

getAdminDownSwitchedPortsCountInNetworkElement

getAllFibreChannelInterfacesInNetworkElement

getAllInterfacesInNetworkElement

getAllMgmtInterfaces

getAllVirtualEthernetPorts

getControlInterfaces

getErrorDetectionSettings

getErrorRecoverySettings

getIpAclAssociationsForNetworkInterface

getLldpGlobalSetting

getLldpSettingsForNetworkInterface

getLogicalInterfacesInNetworkElement

getLoopbackInterfacesInNetworkElement

getMacAclAssociationsForNetworkInterface

getMgmtInterfaces

getMissingPortGroupMembers

getNetworkInterfaces

getNetworkInterfacesByName

getNetworkInterfaceSettings

getOperDownRoutedPortsCountInNetworkElement

getOperDownSwitchedPortsCountInNetworkElement

getPortsInCards

getPortsInModule

getPortsInNetworkElement

getPortStatusSummary

getPortsWithErrorVlanAssociations

getPortsWithFabricPortStatusAssociations

getPortsWithLogicalIntfAssociation

getPortsWithLsgAssociations

getPortsWithPortChannelAssociations

getPortsWithSecurityAssociations

getPortsWithSpanAssocations

getPortsWithVlanAssociations

getPortUsedForDiscovery

getRoutedPortsInModule

getRoutedPortsInNetworkElement

getRoutedPortsWithSecurityAssociations

getRoutedSubNetworkInterfacesInNetworkElement

getSubInterfacesForRoutedNetworkInterface

getSviServiceStateForNetworkElements

getSvsVirtualEthGlobalSetting

getSwicthedPortsCountInModule

getSwitchedPortsInModule

getSwitchedPortsInModuleByMode

getSwitchedPortsInNetworkElement

getSwitchedPortsWithSecurityAssociations

getSystemDefaultSettings

getTotalPortsCountInNetworkElement

getTotalRoutedPortsCountInNetworkElement

getTotalSwitchedPortsCountInNetworkElement

getTunnelInterfacesInNetworkElement

getUdldServiceStateForNetworkElements

getVirtualEthernetPortsInNetworkElement

getVirtualPortsInCard

getVirtualPortsInVirtualComputerSystem

getVirtualPortsWithNoCardAssoc

getVlanNetworkInterfacesInNetworkElement

modifyAdminStateForNetworkInterfaces

modifyErrorDetectionSettingInNetworkElement

modifyErrorRecoverySettingInNetworkElement

modifyNetworkInterfaces

modifyNetworkInterfaceSetting

modifyPortModeToRouted

modifyPortModeToSwitched

modifyRoutedSubNetworkInterfaces

modifySvsVethGlobalSettingInNetworkElement

modifySwitchPortMode

modifySystemDefaultSetting


InterfacesApp Service


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

Information About InterfacesApp Service

This chapter defines the APIs exposed by the InterfacesApp service feature.

createLoopbackNetworkInterfaces

Creates one or more Loopback interface objects in a network element.

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 loopBackIns is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occur:

In the loopBackIns collection, if any of the LoopBackNetworkInterface attribute is not valid.

Parameters

opContext—Operational context

neInstanceNameId - Instance name ID of the network element.

loopbackIns - loopback objects that need to be created.

Return Value

Instance name IDs of the newly created Loopback interface objects.

createRoutedSubNetworkInterfaces

Create one or more routed sub-interfaces object for a routed physical interface.

ValidationException is thrown if any of the following situation occurs:

If niId is null.

If niId is not a valid InstanceNameId.

If the subInfs is null or the collection is empty.

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

If there is no object existing in database corresponding to the InstanceNameId.

If IP address (Ipv4AddressPrefix) being configured to the interface without creating a encapsulation VLAN (Vlan) association

If the configured IP address (Ipv4AddressPrefix) overlaps with primary or secondary IP address of any other Layer 3 interfaces existing in the device.

If the configured encapsulation VLAN (Vlan) is not available or already in use by any other interfaces.

If encapsulation type (SubInterfaceEncapsulationType) is configured without specifying encapsulation VLAN..

PropertiesException is thrown if any of the following situation occurs:

In the subInfs collection, if any of the RoutedSubNetworkInterface attribute is not valid.

Parameters

opContext—Operational context

networkInterfaceInstanceNameIds—List of InstanceNameId of network interfaces.

niId - instance name Id of RoutedNetworkInterface.

subInfs - List of RoutedSubNetworkInterface objects that need to be created.

Return Value

Instance name Ids of newly created routed sub-network interface objects.

createVirtualSwitchedNetworkInterfaces

Creates one or more virtual switched interface objects in a network element.

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 vsnifs is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the vsnifs collection, if any of the VirtualSwitchedNetworkInterface attribute is not valid. .

Parameters

opContext—Operational context

neInstanceNameId - Instance name ID of the network element.

vsnifs - vsni objects that need to be created.

Return Value

Instance name IDs of the newly created vsni interface objects.

createVlanNetworkInterfaces

Creates one or more VLAN interface (SVI) objects in a network element.

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 vlanIns is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the vlanIns collection, if any of the VlanNetworkInterface attribute is not valid.

Parameters

opContext—Operational context

neInstanceNameId - Instance name ID of the network element.

vsnifs - vsni objects that need to be created.

Return Value

Instance name IDs of the newly created SVI objects.

deleteLogicalNetworkInterfaces

Delete one or more existing layer 3 logical network interface objects. This method can be used for the following logical interfaces:

Loopback interfaces

SVI

Routed sub-network interface

ValidationException is thrown if any of the following situation occurs:

If niInstanceNameIds collection is null or it is empty.

If niInstanceNameIds collection contains an element that is not of type IpNetworkInterface InstanceNameId.

If niInstanceNameIds collection contains a NetworkInterface that does not exist in the database.

Parameters

opContext—Operational context

neInstanceNameId - Instance name ID of the network element.

Return Value

void

disableLldpService

Disables LldpService in the device.Given the instance name ID of one or more network elements, lldp will be disabled on those elements.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null or empty or it is not of type InstanceNameId.

If neInstanceNameIdCol does not a valid AbstractNetworkElement InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameIdCol - List of InstanceNameId of lldp disabled AbstractNetworkElement.

Return Value

void.

disableSviService

Disables SVI service for the given device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

void.

disableUdldService

Disables UDLD service for the given device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

If neInstanceNameIdCol does not a valid AbstractNetworkElement InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

void.

enableLldpService

Enables LldpService in the device.Given the instance name ID of one or more network elements, lldp will be enabled on those elements. This API is to enable "feature lldp" option globally in the device..

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null or empty or it is not of type InstanceNameId.

If neInstanceNameIdCol does not a valid AbstractNetworkElement InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameIdCol - List of InstanceNameId of AbstractNetworkElement.

Return Value

void.

enableSviService

Enables SVI service for the given device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

void.

enableUdldService

Enables UDLD service for the given device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

void.

fetchCurrentTransceiverStatusForPorts

Returns a list of network interface object populated with all transceiver status associations.

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

Parameters

opContext—Current Operational context

ifInstanceNameIdCol—InstanceNameId corresponding to the NetworkInterface

Return Value

List of NetworkInterface instances with security associations populated.

Following associations are populated for each interface if it is exist for the given interface:

sfpStatusRef

sfpDiagnosticsThresoldStatusRef

networkInterfaceNameRef

getAclAssociations

Return a collection of interface to ACL assocation objects corresponding to a given interface object.

ValidationException is thrown if any of the following situation occurs:

If vlanInstanceNameId contains invalid VLAN InstanceNameId or null value.

If there is no equivalent VLAN object with the given InstanceNameId in the vlanInstanceNameId.

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

Set of AclAppliesToNetworkInterface objects associated to given network interface.

Following objects will be populated on other end of AclAppliesToNetworkInterface association:

1. AccessControlList

getActiveRoutedPortsCountInNetworkElement

Returns number of active routed ports present in the device.

ValidationException is thrown if any of the following situation occurs:

If mstInstanceNameIds is null or it is empty.

If mstInstanceNameIds contains invalid MstSetting InstanceNameId or null value.

If there is no equivalent MstSetting object with the given InstanceNameId in the mstInstanceNameIds.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

Return Value

Number of ports.

getActiveSwitchedPortsCountInNetworkElement

Returns number of active switched ports present in the device for a given switch port mode.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameId> is null or it is not a valid network element InstanceNameId.

If the mode is null.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

mode - Switched network interface mode.

Return Value

Number of ports.

getAdminDownRoutedPortsCountInNetworkElement

Returns number of admin down routed ports present in the device.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

Return Value

Number of ports.

getAdminDownSwitchedPortsCountInNetworkElement

Returns number of admin down switched ports present in the device for a given switch port mode.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameId is null or if the neInstanceNameId is not a valid network element InstanceNameId.

If the mode is null

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

mode - Switched network interface mode.

Return Value

Number of ports.

getAllFibreChannelInterfacesInNetworkElement

Returns all types of fibre channel interfaces present in a network element.Given the instance name ID of a network element, returns a collection of interface objects. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

ValidationException is thrown if the argument passed is null or if the element in the list is not a valid network element InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

className - the complete class name of the interface.

Return Value

List of all interfaces present in the device.

getAllInterfacesInNetworkElement

Returns all types of interfaces present in a network element.Given the instance name ID of a network element, returns a collection of interface objects (both physical and logical interfaces).

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

Return Value

List of all interfaces present in the device.

getAllMgmtInterfaces

Returns a list of list of mgmt interfaces for a given neInstanceNameIdCol. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

Return Value

List of all interfaces present in the device.

getAllVirtualEthernetPorts

Returns all the virtual ports present in the device.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

slotNo - the slot number of the module whose ports are required.

Return Value

Set of SwitchedNetworkInterface instances present in a module.

The following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getControlInterfaces

Returns the ControlNetworkInterface for a given list of device. Returned list may have null entries if any of the NetworkElement corresponding to neInstanceNameIdCol has no ControlNetworkInterface.

Parameters

opContext—Operational context

neInstanceNameIdCol - InstanceNameId corresponding to the network elements .

Return Value

List of Control interfaces present in the device.

getErrorDetectionSettings

Return a collection of port error detection setting for a list of network elements.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

List of PortErrorDisableDetectionSetting for the given list of devices. No other associations will be avaiable.

getErrorRecoverySettings

Return a collection of port error recovery setting for a list of network elements.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

List of PortErrorDisableRecoverySetting for the given list of devices. No other associations will be avaiable.

getIpAclAssociationsForNetworkInterface

Returns collection of interface to IP ACL association objects corresponding to a given interface object.

ValidationException is thrown if the argument passed is null or it is not a valid network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceId - InstanceNameId corresponding to the RoutedNetworkInterface.

Return Value

List of AclAppliesToNetworkInterface objects associated to given network interface.

Following objects will be populated on other end of AclAppliesToNetworkInterface association:

AccessControlList

getLldpGlobalSetting

Returns a list of LldpGlobalSetting objects. Each LldpGlobalSetting object will have a Boolean attribute lldpServiceEnable populated which indicates whether LLDP service is enabled/disabled on this device.

Parameters

opContext—Operational context

neInstanceNameIdCol - InstanceNameId corresponding to the network elements.

Return Value

List of LldpGlobalSetting objects.

getLldpSettingsForNetworkInterface

Return a list of LLDP Setting objects associated with the list of Network Interfaces.

ValidationException is thrown if the argument passed is null or it is not a valid network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceIdCol - InstanceNameId corresponding to the NetworkInterface.

Return Value

Instance of LldpSetting

getLogicalInterfacesInNetworkElement

Returns all the logical interfaces present in a network element.Given the instance name ID of a network element, returns a collection of logical interface objects.

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

Parameters

opContext—Operational context

neInstanceNameIds—List of InstanceNameId of network elements.

Return Value

List of all the logical interfaces present in the network element. The following interfaces will be returned

SVIs.

Tunnel Interfaces.

Loopback Intefaces.

Port Channels.

getLoopbackInterfacesInNetworkElement

Returns all the Loopback interfaces present in a network element.Given the instance name ID of a network element, returns a collection of LoopBack interface objects.

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

Parameters

opContext—Operational context

neInstanceNameIds—List of InstanceNameId of network elements.

Return Value

List of all the LoopBackNetworkInterface present in the network element

Following associations will be available for each interface:

NetworkInterfaceName

NetworkInterfaceStatus

getMacAclAssociationsForNetworkInterface

Returns collection of interface to MAC ACL assocation objects corresponding to a given interface object.

ValidationException is thrown if the argument passed is null or it is not a valid network interface InstanceNameId.

Parameters

opContext—Current Operational context.

interfaceId - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

List of AclAppliesToNetworkInterface objects associated to given network interface.

getMgmtInterfaces

Returns the MgmtNetworkInterface for a given list of device. The returned list may have null entries if any of the NetworkElement corresponding to neInstanceNameIdCol has no MgmtNetworkInterface.

Parameters

opContext—Operational context

neInstanceNameIdCol - InstanceNameId corresponding to the network elements.

Return Value

List of Mgmt interfaces present in the device.

getMissingPortGroupMembers

Returns a list of port group members that are missed in the given list of Interface InstanceNameIds. Returns empty list when the given list has all the members of port groups or the given interfaces are not a member of a port group.

ValidationException is thrown if any of the following situation occurs:

If interfaceIds is null or it is empty.

If interfaceIds contains invalid NetworkInterface InstanceNameId or null value.

If there is no equivalent NetworkInterface object with the given InstanceNameId in the interfaceIds.

Parameters

opContext—Current Operational context.

interfaceId - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

Returns a List of or RoutedNetworkInterface objects

Following associations will be available for each interface and all other associations will be cleared:

NetworkInterfaceName

NetworkInterfaceStatus

PortCapability

getNetworkInterfaces

Returns a collection of network interface objects for the given list of interface Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Current Operational context.

interfaceId - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

List of instance ids of NetworkInterface NetworkInterface instance

Following associations will be available in case of physical port:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation VLAN

Following associations will be available in case of logical interface (PortChannel, SVI, Loopback):

NetworkInterfaceName

NetworkInterfaceStatus

getNetworkInterfacesByName

Returns the List of NetworkInterface objects given the names or range of the NetworkInterface.

ValidationException is thrown if the neInstanceNameId passed is null or it is not a valid network element InstanceNameId.

Parameters

opContext - Current Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

interfaceRange - Interface names or range to be returned.

Return Value

List of NetworkInterface objects corresponding to the interfaceRange provided.

getNetworkInterfaceSettings

Returns a a collecton of network interface global settings for a given list of device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

List of NetworkInterfaceSetting for the given list of devices. No association are avaiable.

getOperDownRoutedPortsCountInNetworkElement

Returns number of operationally down routed ports present in the device.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element.

Return Value

Number of ports.

getOperDownSwitchedPortsCountInNetworkElement

Return number of operationally down switched ports present in the device for a given switch port mode.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameId> is null or it is not a valid network element InstanceNameId.

If the mode is null

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

mode - switched network interface mode.

Return Value

Number of ports

getPortsInCards

Returns a list of SwitchedNetworkInterface instances and RoutedNetworkInterface instances present in a card.

ValidationException is thrown if the argument passed is null or it is not a valid routed port InstanceNameId.

Parameters

opContext—Operational context

cardInstanceNameIdCol - InstanceNameId corresponding to list of cards.

Return Value

A list of SwitchedNetworkInterface instances and RoutedNetworkInterface instances present in a card.

Following associations will be available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation

getPortsInModule

Returns all the physical ports present in the module for a given slot.Given the instance name ID of a network element and the slot number of a module, returns a collection of physical interface objects corresponding to the module.

ValidationException is thrown if the argument passed is null or it is not a valid routed port InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

slotNo - the slot number of the module whose ports are required.

Return Value

List of SwitchedNetworkInterface instances and RoutedNetworkInterface instances present in a module.

Following associations will be available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation

getPortsInNetworkElement

Returns a collection of switched and routed physical interface objects present in a network element. Given the instance name ID of a network element, returns a collection of interface objects.

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

Parameters

opContext—Operational context

neInstanceNameIds—List of InstanceNameId of network elements queried.

Return Value

List of SwitchedNetworkInterface instances and RoutedNetworkInterface instances present in the device. In the returned list of objects only the following associations will be available and all other associations will be cleared.

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

VLAN

getPortStatusSummary

Returns status summary for both Switched and Routed ports, here status summary includes count of ports which are operationally up/down, admin up/down and the total count of switched/routed ports.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

interfaceType - NetworkInterfaceType.

Return Value

List of switched and routed ports.

getPortsWithErrorVlanAssociations

Return a list of switched network interface object populated with error VLAN associations.

ValidationException is thrown if the argument passed is null or it is not a valid switched network interface InstanceNameId.

Parameters

opContext—Current Operational context

interfaceIdCol - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

Instance of SwitchedNetworkInterface.

getPortsWithFabricPortStatusAssociations

Returns the network interface objects with fabricPortStatus associations populated.

ValidationException is thrown if any of the following situation occurs:

If interfaceIds is null or it is empty.

If interfaceIds contains invalid NetworkInterface InstanceNameId or null value.

If there is no equivalent NetworkInterface object with the given InstanceNameId in the interfaceIds .

Parameters

opContext—Current Operational context

interfaceIdCol - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

Instance of NetworkInterface.

getPortsWithLogicalIntfAssociation

Return a list of network interface object populated with logical interface associations. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

Parameters

opContext—Current Operational context

interfaceIdCol - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

Instance of NetworkInterface.

getPortsWithLsgAssociations

Returns the switched network interface objects with LinkStateGroupAppliesToSwitchedNetworkInterface associations populated.

ValidationException is thrown if any of the following situation occurs:

If interfaceIds is null or it is empty.

If interfaceIds contains invalid SwitchedNetworkInterface InstanceNameId or null value.

If there is no equivalent SwitchedNetworkInterface object with the given InstanceNameId in the interfaceIds.

Parameters

opContext—Operational context

interfaceIds - A List of InstanceNameId objects of SwitchedNetworkInterface objects for which the LinkStateGroupAppliesToSwitchedNetworkInterface associations are required.

Return Value

Returns a List of SwitchedNetworkInterface and objects populated with link state group associations.

getPortsWithPortChannelAssociations

Returns the network interface objects with port-channel associations populated.

ValidationException is thrown if any of the following situation occurs:

If interfaceIds is null or it is empty.

If interfaceIds contains invalid NetworkInterface InstanceNameId or null value.

If there is no equivalent NetworkInterface object with the given InstanceNameId in the interfaceIds.

Parameters

opContext—Operational context

interfaceIds - A List of InstanceNameId objects of SwitchedNetworkInterface and RoutedNetworkInterface objects for which the port-channel associations are required.

Return Value

Returns a List of SwitchedNetworkInterface and RoutedNetworkInterface objects populated with port-channel associations.

getPortsWithSecurityAssociations

Returns a list of network interface object populated with all security associations.

ValidationException is thrown if the argument passed is null or it is not a valid network interface InstanceNameId.

Parameters

opContext - Current Operational context

interfaceIdCol - InstanceNameId corresponding to the NetworkInterface.

Return Value

List of NetworkInterface instances with security associations populated.

Following associations will be populated for each interface if it is exist for the given interface:

CtsNetworkInterfaceSetting

Dot1xNetworkInterfaceSetting

IpSourceGuardSetting

TrafficStormControlSetting

Port Security setting. VLAN details will not be populated for this association.

getPortsWithSpanAssocations

Returns network interface object with SPAN assocations populated for a given network interface.

ValidationException is thrown if the argument passed is null or it is not a valid network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceIdCol - InstanceNameId corresponding to the NetworkInterface.

Return Value

Instance of NetworkInterface with span associations populated.

getPortsWithVlanAssociations

Return a list of switched network interface object populated with VLAN associations.

ValidationException is thrown if the argument passed is null or it is not a valid switched network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceIdCol - InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

Instance of SwitchedNetworkInterface

Following associations will be populated for the SwitchedNetworkInterface:

SwitchedNetworkInterfaceBelongsToVlan which includes access VLAN, Native VLAN, Voice VLAN

PromiscuousPvlanMapping Primary and corresponding secondary VLANs

Following associations will be populated for each VLAN which are available as part of above associations:

VLAN collection incase of Primary VLAN

VLAN reference in case of Secondary VLAN

getPortUsedForDiscovery

Returns a instance of network interface with IP address equal to the mgmt IP address (Either IPv4 or IPv6 primary address) of the network element corresponding to neInstanceNameId.

ValidationException is thrown if the neInstanceNameId is null.

Parameters

opContext—Operational context

eInstanceNameId - the instance id of NetworkElement.

Return Value

List of IpNetworkInterface instances.

getRoutedPortsInModule

Returns all the routed physical ports present in the module for a given slot.Given the instance name ID of a network element and the slotnumber of a module, returns a collection of routed interface objects corresponding to the specified module.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

slotNo - the slot number of the module whose ports are required.

Return Value

List of RoutedNetworkInterface instances present in a module

Following associations will be available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation VLAN

getRoutedPortsInNetworkElement

Returns all the routed physical ports present in the device.Given the instance name ID of a network element, returns a collection of routed interface objects present in the device.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements.

Return Value

Set of RoutedNetworkInterface instances present in a module

Following associations will be available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation VLAN

getRoutedPortsWithSecurityAssociations

Return a routed network interface object populated with all security associations.

ValidationException is thrown if the argument passed is null or it is not a valid routed network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceIdCol - InstanceNameId corresponding to the RoutedNetworkInterface.

Return Value

Instance of RoutedNetworkInterface with security associations populated. Following associations will be populated for each interface:

CtsNetworkInterfaceSetting

Dot1xNetworkInterfaceSetting

getRoutedSubNetworkInterfacesInNetworkElement

Returns all the routed sub-interfaces objects present in a network element.Given the instance name ID of a network element, returns a collection of routed sub-interface objects.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId of network element.

Return Value

void

getSubInterfacesForRoutedNetworkInterface

Returns all the routed sub interface objects that are associated to a routed port.Given the instance name ID of a physical routed port, returns a collection of routed sub-interface objects associated with it.

ValidationException is thrown if the argument passed is null or it is not a valid routed port InstanceNameId.

Parameters

opContext—Operational context

routedInfId - InstanceNameId of a routed interface.

Return Value

List of all the RoutedSubNetworkInterface objects associated for a routed ports .

Following associations are available for each interface:

NetworkInterfaceName

NetworkInterfaceStatus

Vlan

getSviServiceStateForNetworkElements

Returns a collecton of Boolean, representing the SVI service state (Enabled / Disabled) for the given device Ids. SVI service state will be null for Cat6k devices.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements.

Return Value

List of boolean values representing the SVI service state for the given list of devices.

getSvsVirtualEthGlobalSetting

Returns the device level SvsVirtualEthGlobalSetting for one or more network elements. Given the InstanceNameId of one or more network elements, returns the corresponding SvsVirtualEthGlobalSetting object for those network elements.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null or empty or it is not of type InstanceNameId.

If neInstanceNameIdCol is not a valid InstanceNameId of AbstractNetworkElement object.

Parameters

opContext—Operational context

neInstanceNameIdCol - InstanceNameId of one or more AbstractNetworkElement objects

Return Value

A collection of SvsVirtualEthGlobalSetting objects.

getSwicthedPortsCountInModule

Returns all the switched ports present in the device for a given slot.Given the instance name ID of a network element and the slotnumber of a module, returns a collection of switched interface objects corresponding to the specified module.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

slotNo - the slot number of the module whose ports are required

Return Value

Set of SwitchedNetworkInterface instances present in a module.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsInModule

Returns all the switched ports present in the device for a given slot.Given the instance name ID of a network element and the slotnumber of a module, returns a collection of switched interface objects corresponding to the specified module. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

slotNo - the slot number of the module whose ports are required

Return Value

Set of SwitchedNetworkInterface instances present in a module.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsInModuleByMode

Returns specific switched ports present in the module for a given slot.Given the instance name ID of a network element, slotnumber of a module and the switchport mode, returns a collection of switched interface objects corresponding to the specified module and mode.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

slotNo - the slot number of the module whose ports are required

mode - switch port mode. If mode is null, return switch ports of all the modes present in a module

Return Value

List of SwitchedNetworkInterface instances present in a module.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsInNetworkElement

Returns specific switched ports present in the module for a given mode.Given the instance name ID of a network element and the switchport mode, returns a collection of switched interface objects with specified mode.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network elements

mode - switch port mode. If mode is null, return switch ports of all the modes present in a module.

Return Value

List of SwitchedNetworkInterface instances present in a module.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsWithSecurityAssociations

Return a list of switched network interface object populated with all security associations.

ValidationException is thrown if the argument passed is null or it is not a valid switched network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceIdCol - InstanceNameId corresponding to the SwitchedNetworkInterface

Return Value

Instance of SwitchedNetworkInterface with security associations populated.

Following associations are populated for each interface:

CtsNetworkInterfaceSetting

Dot1xNetworkInterfaceSetting

IpSourceGuardSetting

TrafficStormControlSetting

Port Security setting. VLAN details will not be populated for this association.

getSystemDefaultSettings

Returns a a collecton of System Default Settings for a given list of device Ids.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

Return Value

List of SystemDefaultSettings for the given list of devices.

getTotalPortsCountInNetworkElement

Returns number of physical ports present in the device.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

Return Value

Number of physical ports.

getTotalRoutedPortsCountInNetworkElement

Returns number of routed ports present in the device.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

Return Value

Number of physical ports.

getTotalSwitchedPortsCountInNetworkElement

Returns number of switched ports present in the device for a given switch port mode.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

mode - switched network interface mode

Return Value

Number of physical ports.

getTunnelInterfacesInNetworkElement

Returns all the tunnel interfaces present in a network element.Given the instance name ID of a network element, returns a collection of tunnel interface objects.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

Return Value

List of all the Tunnel present in the network element.

Following associations are available for each interface:

NetworkInterfaceName

NetworkInterfaceStatus

getUdldServiceStateForNetworkElements

Returns a collecton of Boolean, representing the UDLD service state (Enabled / Disabled) for the given device Ids. UDLD service state will be null for Cat6k devices.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

Return Value

List of Boolean representing the UDLD service state for the given list of devices.

getVirtualEthernetPortsInNetworkElement

Returns specific virtual ethernet ports present in the network element with the specifed mode. Given the instance name ID of a network element and the switchport mode, returns a collection of virtual interface objects with specified mode.

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

Parameters

opContext—Operational context

neInstanceNameIds - InstanceNameId corresponding to the network elements

mode - switch port mode. If mode is null, return virtual switched ports of all the modes present in a module

Return Value

List of SwitchedNetworkInterface instances present in a module.

Following associations are available for each interface:

NetworkInterfaceName

NetworkInterfaceStatus

getVirtualPortsInCard

Returns List of virtual ethernet ports present for the given List of cards.

ValidationException is thrown if any of the following situation occurs:

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

If a valid non-exixting card InstanceNameId is passed.

Parameters

opContext—Operational context

cardIdCol - InstanceNameId corresponding to list of cards

Return Value

List of List VirtualSwitchedNetworkInterface instances present in a card.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

VirtualLink

Following associations are available in Virtual Link:

NetworkInterface collection.

getVirtualPortsInVirtualComputerSystem

Returns List of virtual ethernet ports associated with the given List of virtual computer system.

ValidationException is thrown if any of the following situation occurs:

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

If a valid non-exixting card InstanceNameId is passed.

Parameters

opContext—Operational context

vmIdCol - InstanceNameId corresponding to list of virtual computer system ids

Return Value

List of List VirtualSwitchedNetworkInterface instances assoicated with the given VM (VirtualComputerSystem) .

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

VirtualLink

Following associations are available in Virtual Link:

NetworkInterface collection.

getVirtualPortsWithNoCardAssoc

Returns List of virtual ethernet ports with no card association. Those are user created ones.

ValidationException is thrown if any of the following situation occurs:

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

If a valid non-exixting card InstanceNameId is passed.

Parameters

opContext—Operational context

neIdCol - InstanceNameId corresponding to list of ane

Return Value

List of List VirtualSwitchedNetworkInterface instances with card reference as null.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

VirtualLink

Following associations are available in Virtual Link:

NetworkInterface collection.

getVlanNetworkInterfacesInNetworkElement

Returns all the VLAN network interfaces (SVIs) present in a network element.Given the instance name ID of a network element, returns a collection of VLAN interface objects.

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

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId of network element

Return Value

List of all the VlanNetworkInterface present in the network element.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

modifyAdminStateForNetworkInterfaces

Updates the admin state of Network Interfaces with the given state. If Port Channel Network Interfaces are passed as a parameter, this API will update the admin states for its member ports with the same state.

ValidationException is thrown if any of the following situation occurs:

If the niInstanceNameIds is null or the collection is empty.

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

Parameters

opContext—Operational context

niInstanceNameIds - InstanceNameId

status - admin status

Return Value

void

modifyErrorDetectionSettingInNetworkElement

Modify the existing error detection settings for a given network element Id.

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 modifiedErrorDetection is null.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

modifiedErrorDetection - modified PortErrorDisableDetectionSetting

Return Value

void

modifyErrorRecoverySettingInNetworkElement

Modify the existing error detection settings for a given network element Id.

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 modifiedErrorRecovery is null.

PropertiesException is thrown if any of the following situation occurs:

If the recoveryInterval, attribute is invalid.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

modifiedErrorRecovery - modified PortErrorDisableRecoverySetting.

Return Value

void

modifyNetworkInterfaces

Modify one or more physical and logical interface (except port-channel) objects. Incase the interface is a kind of IpNetworkInterface then the secondary and helper IP address collection will be updated. If the interface is a mode change (say switched to routed or visa-versa), need to set the AbstractNetworkElement reference.

ValidationException is thrown if any of the following situation occurs:

If the modifiedNetworkInterfaceCol is null or the collection is empty.

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

If the modifiedNetworkInterfaceCol contains one or more NetworkInterface objects without AbstractNetworkElement association.

If the modifiedNetworkInterfaceCol contains objects that are of type SwitchedEtherChannelNetworkInterface or RoutedEtherChannelNetworkInterface. Port-Channels are not supported in this API.

If the configured IP address (Ipv4AddressPrefix) overlaps with primary or secondary IP address of any other Layer 3 interfaces existing in the device.

The following ValidationException situations occurs incase modified interface being RoutedSubNetworkInterface:

If IP address (Ipv4AddressPrefix) being configured to the interface without creating a encapsulation VLAN (Vlan) association.

If the configured encapsulation VLAN (Vlan) is not available or already in use by any other interfaces.

If encapsulation type (SubInterfaceEncapsulationType) is configured without specifying encapsulation VLAN.

PropertiesException is thrown if any of the following situation occurs:

In the modifiedNetworkInterfaceCol collection, if any of the NetworkInterface attribute is not valid.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

modifiedNetworkInterfaceCol—

Return Value

void

modifyNetworkInterfaceSetting

Modify the network interface global setting for a given network element Id.

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 modifiedNetInt is null.

PropertiesException is thrown if any of the following situation occurs:

In the jumboMtu, attribute is invalid.

Parameters

opContext—Operational context

neInstanceNameId - InstanceNameId corresponding to the network element

modifiedNetInt —

Return Value

void

modifyPortModeToRouted

Modify the port mode from switched to routed for a given network interface. On the server, when this method is called all the Layer2 associations will be cleared/retained base on the device platform. Remaining associations will be re-associated to the new object. All attributes present for the old object will be reassigned to the new object.

ValidationException is thrown if any of the following situation occurs:

If switchedInterfaceNameIdCol collection is null or it is empty.

If switchedInterfaceNameIdCol collection contains an object that is not of type SwitchedNetworkInterface InstanceName id.

If switchedInterfaceNameIdCol collection contains a SwitchedNetworkInterface that does not exist in the database.

PropertiesException is thrown if any of the following situation occurs:

In the jumboMtu, attribute is invalid.

Parameters

opContext—Current operational context

switchedInterfaceNameIdCol - InstanceNameId corresponding to the network element

Return Value

List of newly created routed ports.

modifyPortModeToSwitched

Modify the port mode from routed to switched for a given network interface. On the server, when this method is called all the Layer 3 associations will be cleared/retainded base on the device platform. Remaining associations will be re-associated to the new object. All attributes present for the old object will be reassigned to the new object.

ValidationException is thrown if any of the following situation occurs:

If routedInterfaceNameIdCol collection is null or it is empty.

If routedInterfaceNameIdCol collection contains an object that is not of type RoutedNetworkInterface InstanceName id.

If routedInterfaceNameIdCol collection contains a RoutedNetworkInterface that does not exist in the database.

PropertiesException is thrown if any of the following situation occurs:

In the jumboMtu, attribute is invalid.

Parameters

opContext—Current operational context

routedInterfaceNameIdCol - List of instance name Ids of routed ports.

switchPortMode - Switchport mode.

trunkMode - Trunk port mode. Based on this mode, trunk encapsulation and non-negotiate will be set to corresponding defaults. If the trunk mode is static, change the encapsulation to dot1q and non-negotiation to true.

Return Value

List of newly created routed ports.

modifyRoutedSubNetworkInterfaces

Modify one or more existing routed sub-interface objects.

Following associations are updated:

Port Setting

Encapsulation VLAN

ValidationException is thrown if any of the following situation occurs:

If the modifiedRoutedSubNetworkInfs is null or the collection is empty.

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

If IP address (Ipv4AddressPrefix) being configured to the interface without creating a encapsulation VLAN (Vlan) association

If the configured IP address (Ipv4AddressPrefix) overlaps with primary or secondary IP address of any other Layer 3 interfaces existing in the device.

If the configured encapsulation VLAN (Vlan) is not available or already in use by any other interfaces.

If encapsulation type (SubInterfaceEncapsulationType) is configured without specifying encapsulation VLAN.

PropertiesException is thrown if any of the following situation occurs:

In the subInfs collection, if any of the RoutedSubNetworkInterface attribute is not valid.

Parameters

opContext—Current operational context

modifiedRoutedSubNetworkInfs - modified list of RoutedSubNetworkInterface objects.

Return Value

void.

modifySvsVethGlobalSettingInNetworkElement

Modify the SvsVirtualEthGlobalSetting for a given network element Id.

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 modifiedSetting is null.

PropertiesException is thrown if any of the following situation occurs:

In the subInfs collection, if any of the RoutedSubNetworkInterface attribute is not valid.

Parameters

opContext—Current operational context.

neInstanceNameId

modifiedSetting -

Return Value

void.

modifySwitchPortMode

Modify the switch port mode for a given list of switch ports. This will enable to specify the new switch port mode. This API will not re-create a new instance name id. It will just apply the new attributes specified to the existing objects. Trunk mode can be specified if the port mode is getting changed to Trunk mode. If the trunk mode is not specified, default trunk mode will be change to static mode. Trunk mode will be ignore if the port mode is getting changes to any mode other than trunk.

ValidationException is thrown if any of the following situation occurs:

If switchedInterfaceNameIdCol collection is null or it is empty.

If switchedInterfaceNameIdCol collection contains an object that is not of type SwitchedNetworkInterface InstanceName id.

If switchedInterfaceNameIdCol collection contains a SwitchedNetworkInterface that does not exist in the database.

PropertiesException is thrown if any of the following situation occurs:

In the subInfs collection, if any of the RoutedSubNetworkInterface attribute is not valid.

Parameters

opContext—Current operational context.

switchedInterfaceNameIdCol - List of instance name Ids of routed ports

switchPortMode - New switchport mode

trunkMode - Trunk port mode. This is applicable only if the mode is changed to trunk mode. Based on this mode set, trunk encapsulation and non-negotiate will be set to corresponding defaults. If the trunk mode is static, change the encapsulation to dot1q (if supported by the interface) and non-negotiation to true. Similary if the trunk mode is changes to dynamic auto/desirable, non-negotiation will be set to false and encapsulation will be set to negotiate (if supported by the interface).

Return Value

void.

modifySystemDefaultSetting

Modify the System Default Setting for a given network element Id. Modifying the system default state will affect the follwing type of instances of the networkelement:

SwitchedNetworkInterface

SwitchedEtherChannelNetworkInterface

RoutedNetworkInterface


Note Modifying the switchPortModeEnabled attribute of SystemDefaultSetting will trigger rediscovery for that particular device


ValidationException is thrown if any of the following situation occurs:

If the sysDefaultSettingsCol is null.

If the sysDefaultSettingsCol is empty.

PropertiesException is thrown if any of the following situation occurs:

In the subInfs collection, if any of the RoutedSubNetworkInterface attribute is not valid.

Parameters

opContext—Current operational context.

sysDefaultSettingsCol - Collection of modified setting to be persisted

Return Value

void.