CiscoVsmFWModifier.idl

CiscoVsmFWModifier::VsmCEModifier
CiscoVsmFWModifier::VsmCERCModifier
CiscoVsmFWModifier::VsmCoSProfileModifier
CiscoVsmFWModifier::VsmCustomerModifier
CiscoVsmFWModifier::VsmCustomerSiteModifier
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

Interface VsmCEModifier

An instance of the VsmCEModifier interface represents a modifier object for an existing provider-edge router.

Operations

setCEType()

Sets the CE type of the underlying CiscoVsmBrowser::VsmCE router object.

Usage

void setCEType(
in CiscoVsmBrowser::VsmCEType ceType)

raises(
RepException);

Parameters

ceType can be unmanaged router, managed router, managed shadow router, managed management-LAN router, managed RTR router, managed shadow RTR router, management-LAN RTR router, direct- connected router, direct-connected management-host router

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmCE object in the VPN Inventory Repository.

Usage

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

Returns

The updated CE

Raises

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

Interface VsmCERCModifier

An instance of the VsmCERCModifier interface represents a modifier object for an existing CE routing community.

Operations

setDesc()

Change the description for the underlying CiscoVsmBrowser::VsmCERC object.

Usage

void setDesc(
in string description)

raises(
RepException);

Parameters

description CE community's description

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmCERC object in the VPN Inventory Repository.

Usage

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

Returns

The updated CERC

Raises

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

Interface VsmCoSProfileModifier

An instance of the VsmCoSProfileModifier interface represents a modifier object for an existing class-of-service profile.

Operations

setDefault()

Change the default state of the CoS profile to indicate whether it is part of the default set of CoS profiles.

Usage

void setDefault(
in boolean defaultState)

raises(
RepException);

Parameters

defaultState TRUE indicates that the class-of-service profile is to be part of the default set of CoS profiles

Raises

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

setName()

Change the name for the underlying CiscoVsmBrowser::VsmCoSProfile object.

Usage

void setName(
in string cosProfileName)

raises(
RepException);

Parameters

cosProfileName class-of-service profile name

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmCoSProfile object in the VPN Inventory Repository.

Usage

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

Returns

The updated CoS profile

Raises

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

Interface VsmCustomerModifier

An instance of the VsmCustomerModifier interface represents a modifier object for an existing customer.

Operations

setContactInfo()

Change the contact info for the underlying CiscoVsmBrowser::VsmCustomer object.

Usage

void setContactInfo(
in string contactInfo)

raises(
RepException);

Parameters

contactInfo contact information of the customer

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmCustomer object in the VPN Inventory Repository.

Usage

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

Returns

The updated customer

Raises

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

Interface VsmCustomerSiteModifier

An instance of the VsmCustomerSite interface represents a modifier object for an existing customer site.

Operations

setLocationInfo()

Change the location information of the underlying CiscoVsmBrowser::VsmCustomerSite object.

Usage

void setLocationInfo(
in string locationInfo)

raises(
RepException);

Parameters

locationInfo location information of site

Raises

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

setName()

Change the name for the underlying CiscoVsmBrowser::VsmCustomerSite object.

Usage

void setName(
in string customerSiteName)

raises(
RepException);

Parameters

customerSiteName name of customer site

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmCustomerSite object in the VPN Inventory Repository.

Usage

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

Returns

The updated customer site

Raises

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

Interface VsmPRGModifier

An instance of the VsmPRGModifier interface represents a modifier object for an existing port-reservation group.

Operations

setDesc()

Change the description for the underlying CiscoVsmBrowser::VsmPRG object.

Usage

void setDesc(
in string description)

raises(
RepException);

Parameters

description port-reservation group's description

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmPRG object in the VPN Inventory Repository.

Usage

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

Returns

The updated port reservation grup

Raises

CiscoVsmExceptions::RepException If a VPN InventoryRepository error occurs.

Interface VsmProviderAdminDomainModifier

An instance of the VsmProviderAdminDomainModifier interface represents a modifier object for an existing provider administrative domain

Operations

setContactInfo()

Change the contact info for the underlying CiscoVsmBrowser::VsmProviderAdminDomain object.

Usage

void setContactInfo(
in string contactInfo)

raises(
RepException);

Parameters

contactInfo contact information of the provider

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmProviderAdminDomain object in the VPN Inventory Repository.

Usage

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

Returns

The updated provider admin domain

Raises

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

void setName(
in string regionName)

raises(
RepException);

Parameters

regionName name of region

Raises

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

updateRep()

Update the underlying CiscoVsmBrowser::VsmRegion object in the VPN Inventory Repository.

Usage

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

Returns

The updated region

Raises

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

Table of Contents

CiscoVsmFWModifier.idl