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

FirewallAppService

Table Of Contents

FirewallAppService

Information About FirewallApp Service

getAllFirewallInNetwork

getAllVirtualContextInFwsm

getAsdmInstallationStatusOnDevice

getFirewallInterfacesInVirtualContext

getFwsmInAbstractNetworkElement

getParentInformationForFwsms

getPeerEndForFailover

getServiceLinksForVirtualContext

getVirtualContext

getVirtualContextNameIdsInFwsm

getVlansAssociatedWithFwsm


FirewallAppService


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

Information About FirewallApp Service

This interface defines all the APIs exposed by the FirewallApp service facade.

getAllFirewallInNetwork

Returns all the Firewall Services Module (FWSM) in the network. FirewallSetting reference is populated for each FWSM instance in the return list. This list is used to populate the first level of the firewall screen.

Parameters

opContext—Operational context

Return Value

void

getAllVirtualContextInFwsm

Returns the virtual context inside a single FWSM modules. One FWSM can have one or more than one virtual context in the modules. Each returned ANE represents a context and populates the FirewallSettingRef.

Parameters

opContext—Operational context

fwsmInstanceNameId—Service Module InstanceNameId

Return Value

List of ANEs. Each ANE represents a virtual context.

getAsdmInstallationStatusOnDevice

Automatically logs into the Adaptive Security Appliances (ASA) or FWSM corresponding to the given instanceNameId and determine whether Adaptive Security Device Manager (ASDM) image is installed on the device.

Parameters

opContext—Operational context.

aneInstanceNameId—The instanceNameId of the ASA or FWSM on which the presence of the ASDM image to be determined.

Return Value

True—If the ASDM image is present.

False—If the ASDM image is not present.

getFirewallInterfacesInVirtualContext

Returns all the interfaces inside a context with FirewallInterfaceSettings.

Parameters

opContext—Operational context

virtualContextInstanceNameId—InstanceNameId of the virtual context.

Return Value

void

getFwsmInAbstractNetworkElement

Returns the number of FWSM modules inside a Catalyst 6000 switch. A Catalyst 6000 switch can have more than one FWSM modules. Returns a list of ANEs each representing a firewall. The ANE is of the FWSM platform type and populates the FirewallSettingRef.

Parameters

opContext—Operational context.

c6kInstanceNameId—Catalyst switch InstanceNameId.

Return Value

A list of ANEs. Each ANE represents a firewall module.

getParentInformationForFwsms

Returns a non-persisted pojo with Catalyst 6000 switch hostname and fwsm slot number in a Catalyst 6000 switch.

Parameters

opContext—Operational context

fwsmInstanceNameIds—FWSM InstanceNameId.

Return Value

void

getPeerEndForFailover

Returns a non-persisted pojo with Catalyst 6000 switch hostname and FWSM slot number in a Catalyst 6000 switch.

Parameters

opContext—Operational context.

fwsmInstanceNameIds—FWSM InstanceNameId.

Return Value

void.

getServiceLinksForVirtualContext

Returns the multipoint links for all the VLANs mapped to a FWSM from the virtual context specified by aneInstanceNameIds. Each multipoint virtual link contains one or two end points. One end point inside the virtual context and another inside the Catalyst 6000 switch. Each interface inside multipoint virtual link will have FirewallInterfaceSetting Ref populated.

Parameters

opContext—Operational context.

aneInstanceNameIds—InstanceNameIds of Virtual Contexts.

Return Value

Ordered list where each virtual context will have a respective List.

getVirtualContext

Returns the virtual context ANE representing each aneInstanceNameIds.

Parameters

opContext—Operational context

aneInstanceNameIds—List of InstanceNameIds of Virtual Contexts .

Return Value

void

getVirtualContextNameIdsInFwsm

Returns all the virtual context instanceNameIds inside a FWSM module. There can be one or more than one virtual context in a FWSM. This function is used to get all the instanceNameId of virtual context inside a FWSM module and to get all the ANEs representing each virtual context.

Parameters

opContext—Operational context

fwsmInstanceNameId—Service Module InstanceNameId

Return Value

List representing the InstanceNameId's of virtual context present inside firewall.

getVlansAssociatedWithFwsm

This Api will return the range of VLANs associated with each FWSM module.

Parameters

opContext—Operational context.

fwsmInstanceNameIds—aneInstanceNameIds represents fwsm modules.

Return Value

List representing the VLAN range associated to each Firewall module