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

ObjectGroupApp Service

Table Of Contents

ObjectGroupApp Service

Information About ObjectGroupApp Service

createIPv4AddressGroups

createIPv6AddressGroups

createPortGroups

deleteIPv4AddressGroups

deleteIPv6AddressGroups

deletePortGroups

getAddressGroups

getAddrGrpsWithoutEntriesInNetworkElement

getIPv4AddressGroups

getIPv4AddrGrpsInNetworkElement

getIPv4AddrGrpsWithoutEntriesInNetworkElement

getIPv6AddressGroups

getIPv6AddrGrpsInNetworkElement

getIPv6AddrGrpsWithoutEntriesInNetworkElement

getPortGroups

getPortGroupsInNetworkElement

getPortGrpsWithoutEntriesInNetworkElement

modifyIPv4AddressGroups

modifyIPv6AddressGroups

modifyPortGroups


ObjectGroupApp Service


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

Information About ObjectGroupApp Service

This interface defines all the APIs exposed by the ObjectGroupApp Service.

createIPv4AddressGroups

Creates one or more IPv4AddressGroup objects in a network element.

InstanceException is thrown if any of the following situation occurs:

If neInstanceNameId is null.

If neInstanceNameId is not a valid InstanceNameId of a network element.

ParameterException is thrown if any of the following situation occurs:

If the ipv4AddressGroupCol is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the ipv4AddressGroupCol collection, if any of the IPv4AddressGroup attribute is not valid or the IPv4AddressGroupEntry inside a IPv4AddressGroup is not valid.

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of a network element.

ipv4AddressGroupCol - a collection (one or more) of IPv4AddressGroup objects that will be created in the database.

Return Value

List of IPv4AddressGroup objects that are newly created.

createIPv6AddressGroups

Creates one or more IPv6AddressGroup objects in a network element.

InstanceException is thrown if any of the following situation occurs:

If neInstanceNameId is null.

If neInstanceNameId is not a valid InstanceNameId of a network element.

ParameterException is thrown if any of the following situation occurs:

If the ipv6AddressGroupCol is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the ipv6AddressGroupCol collection, if any of the IPv4AddressGroup attribute is not valid or the IPv4AddressGroupEntry inside a IPv4AddressGroup is not valid.

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of a network element.

ipv6AddressGroupCol - a collection (one or more) of IPv4AddressGroup objects that will be created in the database.

areaRtSumm - List of OspfAreaRouteSummary objects to be added to the OspfAreaSetting Collection.

Return Value

List of IPv6AddressGroup objects that are newly created.

createPortGroups

Creates one or more PortGroup objects in a network element.

InstanceException is thrown if any of the following situation occurs:

If neInstanceNameId is null.

If neInstanceNameId is not a valid InstanceNameId of a network element.

ParameterException is thrown if any of the following situation occurs:

If the portGroupCol is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the ipv6AddressGroupCol collection, if any of the IPv6AddressGroup attribute is not valid or the IPv6AddressGroupEntry inside a IPv6AddressGroup is not valid.

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of a network element.

ipv6AddressGroupCol - a collection (one or more) of IPv6AddressGroup objects that will be created in the database.

Return Value

IPv6AddressGroup objects that are newly created.

deleteIPv4AddressGroups

Deletes one or more IPv4 Address Group objects.

ParameterException is thrown if any of the following situation occurs:

If ipv4AddressGrpInstanceNameIdCol collection is null or it is empty.

If ipv4AddressGrpInstanceNameIdCol collection contains an element that is not of type IPv4AddressGroup InstanceNameId.

If ipv4AddressGrpInstanceNameIdCol collection contains a IPv4AddressGroup that does not exist in the database.

Parameters

opContext - operational context.

ipv4AddressGrpInstanceNameIdCol - a collection that contains InstanceNameId of one or more IPv4AddressGroup objects that needs to be deleted.

Return Value

void.

deleteIPv6AddressGroups

Deletes one or more IPv6 Address Group objects.

ParameterException is thrown if any of the following situation occurs:

If ipv6AddressGrpInstanceNameIdCol collection is null or it is empty.

If ipv6AddressGrpInstanceNameIdCol collection contains an element that is not of type IPv6AddressGroup InstanceNameId.

If ipv6AddressGrpInstanceNameIdCol collection contains a IPv4AddressGroup that does not exist in the database.

Parameters

opContext - operational context.

ipv6AddressGrpInstanceNameIdCol - a collection that contains InstanceNameId of one or more IPv6AddressGroup objects that needs to be deleted.

Return Value

IPv6AddressGroup objects that are newly created.

deletePortGroups

Deletes one or more Port Group objects.

ParameterException is thrown if any of the following situation occurs:

If ipv6AddressGrpInstanceNameIdCol collection is null or it is empty.

If ipv6AddressGrpInstanceNameIdCol collection contains an element that is not of type IPv6AddressGroup InstanceNameId.

If ipv6AddressGrpInstanceNameIdCol collection contains a IPv4AddressGroup that does not exist in the database.

Parameters

opContext - operational context.

ipv6AddressGrpInstanceNameIdCol - a collection that contains InstanceNameId of one or more IPv6AddressGroup objects that needs to be deleted.

Return Value

void.

getAddressGroups

Returns IPv4 and Ipv6 AddressGroups from it's InstanceNameIds.

ValidationException is thrown if any of the following situation occurs:

If addrGrpInstanceNameIdCol is null or it is empty.

If addrGrpInstanceNameIdCol contains invalid InstanceNameId of a IPv4AddressGroup and IPv6AddressGroup or null value.

If there is no equivalent IPv4 AddressGroup object with the given InstanceNameId in the addrGrpInstanceNameIdCol.

Parameters

opContext - operational context.

addrGrpInstanceNameIdCol - a collection of InstanceNameId of IPv4AddressGroup and IPv6AddressGroup.

Return Value

List of IPv4AddressGroup & IPv6AddressGroupobjects corresponding to given collection of InstanceNameId. In the returned list of IPv4 and Ipv6 Address Group objects, only the following associations will be present.

All associated Address Group Entries of the returned Address Group object.

ExtendedAccessControlList association for every Entries, if any, in IPv4AddressGroupEntry and IPv6AddressGroup.

getAddrGrpsWithoutEntriesInNetworkElement

Returns all IPv4 and IPv6 Address Groups configured in a network element.

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

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of the network element.

Return Value

List of IPv4AddressGroup and IPv6AddressGroup objects.

getIPv4AddressGroups

Returns IPv4 AddressGroups from it's InstanceNameIds.

ValidationException is thrown if any of the following situation occurs:

If ipv4addrGrpInstanceNameIdCol is null or it is empty.

If ipv4addrGrpInstanceNameIdCol contains invalid InstanceNameId of a IPv4AddressGroup

or null value.

If there is no equivalent IPv4 AddressGroup object with the given InstanceNameId in the ipv4addrGrpInstanceNameIdCol.

Parameters

opContext - operational context.

ipv4addrGrpInstanceNameIdCol - a collection of InstanceNameId of IPv4AddressGroup.

Return Value

List of IPv4AddressGroupobjects corresponding to given collection of InstanceNameId. In the returned list of IPv4 Address Group objects, only the following associations will be present.

All associated Address Group Entries of the returned Address Group object.

ExtendedAccessControlList association for every Entries, if any, in IPv4AddressGroupEntry.

getIPv4AddrGrpsInNetworkElement

Returns all IPv4Address groups configured in a network element.

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

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of the network element.

Return Value

List of IPv6AddressGroup objects.

getIPv4AddrGrpsWithoutEntriesInNetworkElement

Returns all IPv4 Address Groups configured in a network element.

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

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of the network element.

Return Value

List of IPv4AddressGroup objects.

getIPv6AddressGroups

Returns IPv6 AddressGroups from it's InstanceNameIds.

ValidationException is thrown if any of the following situation occurs:

If ipv6addrGrpInstanceNameIdCol is null or it is empty.

If ipv6addrGrpInstanceNameIdCol contains invalid InstanceNameId of a IPv4AddressGroup

or null value.

If there is no equivalent IPv6 AddressGroup object with the given InstanceNameId in the ipv6addrGrpInstanceNameIdCol.

Parameters

opContext - operational context.

ipv6addrGrpInstanceNameIdCol - a collection of InstanceNameId of IPv6AddressGroup.

Return Value

List of IPv6AddressGroupobjects corresponding to given collection of InstanceNameId. In the returned list of IPv6 Address Group objects, only the following associations will be present.

All associated Address Group Entries of the returned Address Group object.

ExtendedAccessControlList association for every Entries, if any, in IPv6AddressGroupEntry.

getIPv6AddrGrpsInNetworkElement

Returns all IPv6 Address groups configured in a network element.

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

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of the network element.

Return Value

List of IPv6AddressGroup objects.

getIPv6AddrGrpsWithoutEntriesInNetworkElement

Returns all IPv6 Address Groups configured in a network element.

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

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of the network element.

Return Value

list of IPv6AddressGroup objects. In the returned list of objects, all associations will be cleared. Returned Address Group will be ordered by the name Address Group.

getPortGroups

Returns PortGroups' from it's InstanceNameIds.

ValidationException is thrown if any of the following situation occurs:

If addrGrpInstanceNameIdCol is null or it is empty.

If portGrpInstanceNameIdCol contains invalid InstanceNameId of a PortGroup or null value

If there is no equivalent IPv4 AddressGroup object with the given InstanceNameId in the addrGrpInstanceNameIdCol.

Parameters

opContext - operational context.

portGrpInstanceNameIdCol - a collection of InstanceNameId of PortGroup.

Return Value

List of PortGroup objects corresponding to given collection of InstanceNameId.

getPortGroupsInNetworkElement

Returns all Port Groups for IPv4 and IPv6 configured in a network element.

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

Return Value

List of PortGroup objects. The returned list of objects will have the following associations:

All associated PortGroupEntries, if any, in PortGroup object.

All associated ExtendedAccessControlList of PortGroup and all associated Ipv6AccessControlList of PortGroup object.

getPortGrpsWithoutEntriesInNetworkElement

Returns all Port Groups for IPv4 and IPv6 configured in a network element.

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

Parameters

opContext - operational context.

neInstanceNameId - InstanceNameId of the network element.

Return Value

List of PortGroup objects.

modifyIPv4AddressGroups

Modifies one or more existing IPv4AddressGroup objects.

ParameterException is thrown if any of the following situation occurs:

If ipv4AddressGroupCol collection is null or it is empty.

If ipv4AddressGroupCol collection contains an object that is not of type IPv4AddressGroup.

If the ipv4AddressGroupCol collection contains a IPv4AddressGroup that does not exist in the database.

PropertiesException is thrown if the following situation occurs:

In the ipv4AddressGroupCol collection, if any attribute in the IPv4AddressGroup is not valid or if any IPv4AddressGroupEntry inside a IPv4 Address Group is not valid.

Parameters

opContext - operational context.

ipv4AddressGroupCol - a collection of IPv4AddressGroup objects that will replace the existing IPv4AddressGroup objects in the database.

Return Value

void.

modifyIPv6AddressGroups

Modifies one or more existing IPv6AddressGroup objects.

ParameterException is thrown if any of the following situation occurs:

If ipv6AddressGroupCol collection is null or it is empty.

If ipv6AddressGroupCol collection contains an object that is not of type IPv6AddressGroup.

If the ipv6AddressGroupCol collection contains a IPv6AddressGroup that does not exist in the database.

PropertiesException is thrown if the following situation occurs:

In the ipv6AddressGroupCol collection, if any attribute in the IPv6AddressGroup is not valid or if any IPv6AddressGroupEntry inside a IPv6Address Group is not valid.

Parameters

opContext - operational context.

ipv6AddressGroupCol - a collection of IPv6AddressGroup objects that will replace the existing IPv6AddressGroup objects in the database.

Return Value

void.

modifyPortGroups

Modifies one or more existing PortGroup objects.

ParameterException is thrown if any of the following situation occurs:

If portGroupCol collection is null or it is empty.

If portGroupCol collection contains an object that is not of type PortGroup.

If the portGroupCol collection contains a PortGroup that does not exist in the database.

PropertiesException is thrown if any of the following situation occurs:

In the portGroupCol collection, if any attribute in the PortGroup is not valid or if any PortGroupEntry inside a Port Group is not valid.

Parameters

opContext - operational context.

portGroupCol - a collection (one or more) of PortGroup objects that will replace the existing PortGroup objects in the database.

Return Value

void.