CiscoVsmFWModifier.idl

CiscoVsmFWModifier::VsmCEModifier
CiscoVsmFWModifier::VsmCERCModifier
CiscoVsmFWModifier::VsmCoSProfileModifier
CiscoVsmFWModifier::VsmCustomerModifier
CiscoVsmFWModifier::VsmCustomerSiteModifier
CiscoVsmFWModifier::VsmPEModifier
CiscoVsmFWModifier::VsmPRGModifier
CiscoVsmFWModifier::VsmProviderAdminDomainModifier
CiscoVsmFWModifier::VsmRegionModifier

The CiscoVsmFWModifier module defines interfaces to an underlying CORBA server that implements the VPN service model. This server contains the objects that modify each of the non-service-request service-model elements that are accessible through the interfaces in the CiscoVsmBrowser module.

Using the operations that are associated with each modifier object, you can:

Update existing elements in the VPN inventory repository.
Set the name, ID, and other element attributes.

These element-modifier objects are generated by calls to the new operations defined by the CiscoVpnServiceModel::VpnInvMgr interface for each VPN element. Likewise, to remove each of these modifiers and the CiscoVsmBrowser objects they produce, use the respective release operations defined by the CiscoVpnServiceModel::VpnInvMgr interface.

See Also

CiscoVpnServiceModel, CiscoVsmBrowser, CiscoVsmExceptions

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmCEModifier

An instance of the VsmCEModifier interface represents a modifier object for a CiscoVsmBrowser::VsmCE object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCEModifier, CiscoVpnServiceModel::VpnInvMgr::releaseCEModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setCEType()

Sets the CE type of the CiscoVsmBrowser::VsmCE router object to be updated by this VsmCEModifier object.

Usage

void setCEType(
in CiscoVsmBrowser::VsmCEType ceType)

raises(
RepException);

Parameters

ceType—in CiscoVsmBrowser::VsmCEType that represents the CE type —unmanaged router, managed router, managed shadow router, managed management-LAN router, managed RTR router, managed shadow RTR router, managed management-LAN RTR router, direct-connected router, direct-connected management-host router—of the CiscoVsmBrowser::VsmCE router object to be updated in the VPN Inventory Repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCE::getRouterInterfaceList, CiscoVsmFWCreator::VsmCECreator::setCEType, setTelnetTimeOut, setTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.1

setTelnetRetries()

Sets the number of times to attempt a telnet connection for the CiscoVsmBrowser::VsmCE router object to be updated by this VsmCECreator object.

Usage

void setTelnetRetries(
in unsigned short telnetRetries)

raises(
RepException);

Parameters

telnetRetries—in unsigned short that represents the number of times to attempt a telnet connection.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCE::getTelnetRetries, CiscoVsmFWCreator::VsmCECreator::setTelnetRetries, setTelnetTimeOut

Since

Cisco VPN Solutions Center, Release 1.2

setTelnetTimeOut()

Sets the telnet timeout value for the CiscoVsmBrowser::VsmCE router object to be updated by this VsmCECreator object.

Usage

void setTelnetTimeOut(
in unsigned long telnetTimeoutValue)

raises(
RepException);

Parameters

telnetTimeoutValue—in unsigned long that represents the timeout value in seconds.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCE::getTelnetTimeOut, CiscoVsmFWCreator::VsmCECreator::setTelnetTimeOut, setTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.2

updateRep()

Updates the CiscoVsmBrowser::VsmCE object in the VPN Inventory repository that is supported by this VsmCEModifier object.

Usage

CiscoVsmBrowser::VsmCE updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmCE—Updated VsmCE object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCECreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeCEFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmCERCModifier

An instance of the VsmCERCModifier interface represents a modifier object for a CiscoVsmBrowser::VsmCERC object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCERCModifier, CiscoVpnServiceModel::VpnInvMgr::releaseCERCModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setDesc()

Sets a description string for the CiscoVsmBrowser::VsmCERC object to be updated by this VsmCERCModifier object.

Usage

void setDesc(
in string description)

raises(
RepException);

Parameters

description—in string that represents the description of the CE routing community (CERC) that is associated with the CiscoVsmBrowser::VsmCERC object to be updated in the VPN Inventory Repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCERC::getDesc, CiscoVsmFWCreator::VsmCERCCreator::setDesc

Since

Cisco VPN Solutions Center, Release 1.1

updateRep()

Updates the CiscoVsmBrowser::VsmCERC object in the VPN Inventory repository that is supported by this VsmCERCModifier object.

Usage

CiscoVsmBrowser::VsmCERC updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmCERC—Updated VsmCERC object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCERCCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeCERCFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmCoSProfileModifier

An instance of the VsmCoSProfileModifier interface represents a modifier object for a CiscoVsmBrowser::VsmCoSProfile object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCoSProfileModifier, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfileModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setDefault()

When TRUE, sets the CiscoVsmBrowser::VsmCoSProfile object to be updated by this VsmCoSProfileModifier object to be part of the default CoS-profile set.

Usage

void setDefault(
in boolean defaultState)

raises(
RepException);

Parameters

defaultState—in boolean that, when TRUE, indicates that the class-of-service (CoS) profile that is associated with the CiscoVsmBrowser::VsmCoSProfile object to be updated in the VPN Inventory repository is to be added as part of the default set of CoS profiles.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCoSProfile::isDefault, CiscoVsmFWCreator::VsmCoSProfileCreator::setDefault, setName

setName()

Sets the name string for the CiscoVsmBrowser::VsmCoSProfile object to be updated by this VsmCoSProfileModifier object.

Usage

void setName(
in string cosProfileName)

raises(
RepException);

Parameters

cosProfileName—in string that represents the name of the class-of-service (CoS) profile that is associated with the CiscoVsmBrowser::VsmCoSProfile object to be updated in the VPN Inventory repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCoSProfile::getName, CiscoVsmFWCreator::VsmCoSProfileCreator::setName, setDefault

Since

Cisco VPN Solutions Center, Release 1.1

updateRep()

Updates the CiscoVsmBrowser::VsmCoSProfile object in the VPN Inventory repository that is supported by this VsmCoSProfileModifier object.

Usage

CiscoVsmBrowser::VsmCoSProfile updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmCoSProfile—Updated VsmCoSProfile object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeCoSProfileFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmCustomerModifier

An instance of the VsmCustomerModifier interface represents a modifier object for a CiscoVsmBrowser::VsmCustomer object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCustomerModifier, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setContactInfo()

Sets the contact information for the CiscoVsmBrowser::VsmCustomer object to be updated by this VsmCustomerModifier object.

Usage

void setContactInfo(
in string contactInfo)

raises(
RepException);

Parameters

contactInfo—in string that represents the contact information of the customer that is associated with the CiscoVsmBrowser::VsmCustomer object to be updated in the VPN Inventory Repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCustomer::getContactInfo, CiscoVsmFWCreator::VsmCustomerCreator::setContactInfo

Since

Cisco VPN Solutions Center, Release 1.1

updateRep()

Updates the CiscoVsmBrowser::VsmCustomer object in the VPN Inventory repository that is supported by this VsmCustomerModifier object.

Usage

CiscoVsmBrowser::VsmCustomer updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmCustomer—Updated VsmCustomer object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCustomerCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeCustomerFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmCustomerSiteModifier

An instance of the VsmCustomerSiteModifier interface represents a modifier object for a CiscoVsmBrowser::VsmCustomerSite object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCustomerSiteModifier, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerSiteModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setLocationInfo()

Sets the location information for the CiscoVsmBrowser::VsmCustomerSite object to be updated by this VsmCustomerSiteModifier object.

Usage

void setLocationInfo(
in string locationInfo)

raises(
RepException);

Parameters

locationInfo—in string that represents the location information of the customer site that is associated with the CiscoVsmBrowser::VsmCustomerSite object to be updated in the VPN Inventory repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCustomerSite::getLocationInfo, CiscoVsmFWCreator::VsmCustomerSiteCreator::setLocationInfo, setName

Since

Cisco VPN Solutions Center, Release 1.1

setName()

Sets the name string for the CiscoVsmBrowser::VsmCustomerSite object to be updated by this VsmCustomerSiteModifier object.

Usage

void setName(
in string customerSiteName)

raises(
RepException);

Parameters

customerSiteName—in string that represents the name of the customer site that is associated with the CiscoVsmBrowser::VsmCustomerSite object to be updated in the VPN Inventory repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmCustomerSite::getName, CiscoVsmFWCreator::VsmCustomerSiteCreator::setName, setLocationInfo

Since

Cisco VPN Solutions Center, Release 1.1

updateRep()

Updates the CiscoVsmBrowser::VsmCustomerSite object in the VPN Inventory repository that is supported by this VsmCustomerSiteModifier object.

Usage

CiscoVsmBrowser::VsmCustomerSite updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmCustomerSite—Updated VsmCustomerSite object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeCustomerSiteFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmPEModifier

An instance of the VsmPEModifier interface represents a modifier object for a CiscoVsmBrowser::VsmPE object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newPEModifier, CiscoVpnServiceModel::VpnInvMgr::releasePEModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setTelnetRetries()

Sets the number of times to attempt a telnet connection for the CiscoVsmBrowser::VsmPE router object to be updated by this VsmPECreator object.

Usage

void setTelnetRetries(
in unsigned short telnetRetries)

raises(
RepException);

Parameters

telnetRetries—in unsigned short that represents the number of times to attempt a telnet connection.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmPE::getTelnetRetries, CiscoVsmFWCreator::VsmPECreator::setTelnetRetries, setTelnetTimeOut

Since

Cisco VPN Solutions Center, Release 1.2

setTelnetTimeOut()

Sets the telnet timeout value for the CiscoVsmBrowser::VsmPE router object to be updated by this VsmPECreator object.

Usage

void setTelnetTimeOut(
in unsigned long telnetTimeoutValue)

raises(
RepException);

Parameters

telnetTimeoutValue—in unsigned long that represents the timeout value in seconds.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmPE::getTelnetTimeOut, CiscoVsmFWCreator::VsmPECreator::setTelnetTimeOut, setTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.2

updateRep()

Updates the CiscoVsmBrowser::VsmPE object in the VPN Inventory repository that is supported by this VsmPEModifier object.

Usage

CiscoVsmBrowser::VsmPE updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmPE—Updated VsmPE object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removePEFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmPRGModifier

An instance of the VsmPRGModifier interface represents a modifier object for a CiscoVsmBrowser::VsmPRG object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newPRGModifier, CiscoVpnServiceModel::VpnInvMgr::releasePRGModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setDesc()

Sets a description string for the CiscoVsmBrowser::VsmPRG object to be updated by this VsmPRGModifier object.

Usage

void setDesc(
in string description)

raises(
RepException);

Parameters

description—in string that represents the description of the port-reservation group (PRG) that is associated with the CiscoVsmBrowser::VsmPRG object to be updated in the VPN Inventory Repository.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmBrowser::VsmPRG::getDesc, CiscoVsmFWCreator::VsmPRGCreator::setDesc

Since

Cisco VPN Solutions Center, Release 1.0

updateRep()

Updates the CiscoVsmBrowser::VsmPRG object in the VPN Inventory repository that is supported by this VsmPRGModifier object.

Usage

CiscoVsmBrowser::VsmPRG updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmPRG—Updated VsmPRG object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPRGCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removePRGFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmProviderAdminDomainModifier

An instance of the VsmProviderAdminDomainModifier interface represents a modifier object for an existing CiscoVsmBrowser::VsmProviderAdminDomain object that is stored in the VPN Inventory repository

See Also

CiscoVpnServiceModel::VpnInvMgr::newProviderAdminDomainModifier, CiscoVpnServiceModel::VpnInvMgr::releaseProviderAdminDomainModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setContactInfo()

Sets the contact information for the CiscoVsmBrowser::VsmProviderAdminDomain object to be updated by this VsmProviderAdminDomainModifier object.

Usage

void setContactInfo(
in string contactInfo)

raises(
RepException);

Parameters

contactInfo—Contact information for the CiscoVsmBrowser::VsmProviderAdminDomain object supported by this VsmProviderAdminDomainModifier object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmProviderAdminDomainCreator::setContactInfo, CiscoVsmBrowser::VsmProviderAdminDomain::getContactInfo

Since

Cisco VPN Solutions Center, Release 1.1

updateRep()

Updates the CiscoVsmBrowser::VsmProviderAdminDomain object in the VPN Inventory repository to be updated by this VsmProviderAdminDomainModifier object.

Usage

CiscoVsmBrowser::VsmProviderAdminDomain updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmProviderAdminDomain—Updated VsmProviderAdminDomain object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmProviderAdminDomainCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeProviderAdminDomainFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Interface VsmRegionModifier

An instance of the VsmRegionModifer interface represents a modifier object for a CiscoVsmBrowser::VsmRegion object that is stored in the VPN Inventory repository.

See Also

CiscoVpnServiceModel::VpnInvMgr::newRegionModifier, CiscoVpnServiceModel::VpnInvMgr::releaseRegionModifier

Since

Cisco VPN Solutions Center, Release 1.1

Operations

setName()

Sets the name string for the CiscoVsmBrowser::VsmRegion object to be updated by this VsmRegionModifier object.

Usage

void setName(
in string regionName)

raises(
RepException);

Parameters

regionName—in string that represents the name of the region that is associated with the CiscoVsmBrowser::VsmRegion object to be updated in the VPN Inventory Repository.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmRegionCreator::setName, CiscoVsmBrowser::VsmRegion::getName

Since

Cisco VPN Solutions Center, Release 1.1

updateRep()

Updates the CiscoVsmBrowser::VsmRegion object in the VPN Inventory repository that is supported by this VsmRegionModifier object.

Usage

CiscoVsmBrowser::VsmRegion updateRep();
raises(
RepException);

Returns

CiscoVsmBrowser::VsmRegion—Updated VsmRegion object.

Raises

CiscoVsmExceptions::RepException If a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmRegionCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::removeRegionFromRep

Since

Cisco VPN Solutions Center, Release 1.1

Table of Contents

CiscoVsmFWModifier.idl