CiscoVsmFWCreator.idl

CiscoVsmFWCreator::VsmCECreator
CiscoVsmFWCreator::VsmCERCCreator
CiscoVsmFWCreator::VsmCoSProfileCreator
CiscoVsmFWCreator::VsmCustomerCreator
CiscoVsmFWCreator::VsmCustomerSiteCreator
CiscoVsmFWCreator::VsmPECreator
CiscoVsmFWCreator::VsmPRGCreator
CiscoVsmFWCreator::VsmProviderAdminDomainCreator
CiscoVsmFWCreator::VsmRegionCreator
CiscoVsmFWCreator::VsmVpnCreator

The CiscoVsmFWCreator module defines interfaces to an underlying CORBA server that implements the VPN service model. This server contains the objects that create 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 creator object, you can:

Add new elements to the VPN inventory repository.
Retrieve elements from the VPN inventory repository.
Set the name, ID, and other element attributes.

These element-creator 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 creators and the CiscoVsmBrowser objects they produce, use the respective release operations defined by the CiscoVpnServiceModel::VpnInvMgr interface.

See Also

CiscoVpnServiceModel, CiscoVsmBrowser, CiscoVsmSRCreator, CiscoVsmExceptions

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCECreator

An instance of the VsmCECreator interface represents a creator object for a new customer-edge router (CE) with which to define and add a new CiscoVsmBrowser::VsmCE object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newCECreator() operation to get a new VsmCECreator object. Before adding a new CiscoVsmBrowser::VsmCE object to the VPN Inventory Repository, set the following information for its VsmCECreator object:

Host name
Domain name
Network name
Password list
Router-interface list
CE type

After setting information for the new VsmCECreator object, you can add a new CiscoVsmBrowser::VsmCE object to the VPN Inventory Repository, assigning it to a specific customer site.

See Also

CiscoVsmBrowser::VsmCE, CiscoVsmBrowser::VsmCE::getID, CiscoVpnServiceModel::VpnInvMgr::newCECreator, CiscoVpnServiceModel::VpnInvMgr::releaseCECreator, CiscoVpnServiceModel::VpnInvMgr::releaseCE

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmCE object with the supplied settings to the specified customer site in the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmCE addToRep(
in CiscoVsmBrowser::VsmCustomerSite customerSite)

raises(
RepException);

Parameters

customerSite—in CiscoVsmBrowser::VsmCustomerSite that represents the customer site of the CiscoVsmBrowser::VsmCE router object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmCE—Object added to the VPN Inventory Repository through the VsmCECreator interface.

Raises

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

See Also

CiscoVsmBrowser::VsmCE::getCustomerSite, VsmPECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setCEType()

Sets the CE type of the CiscoVsmBrowser::VsmCE router object to be generated by this VsmCECreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCE::getRouterInterfaceList, setHostName, setDomainName, setNetworkName, setRouterPasswords, setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

setDomainName()

Sets the domain name of the CiscoVsmBrowser::VsmCE router object to be generated by this VsmCECreator object.

Usage

void setDomainName(
in string domainName)

raises(
RepException);

Parameters

domainName—in string that represents the domain name of the CiscoVsmBrowser::VsmCE router object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCE::getDomainName, setHostName, setNetworkName, setRouterPasswords, setRouterInterfaces, setCEType

Since

Cisco VPN Solutions Center, Release 1.0

setHostName()

Sets the host name of the CiscoVsmBrowser::VsmCE router object to be generated by this VsmCECreator object.

Usage

void setHostName(
in string hostName)

raises(
RepException);

Parameters

hostName—in string that represents the host name of the CiscoVsmBrowser::VsmCE router object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCE::getHostName, setDomainName, setNetworkName, setRouterPasswords, setRouterInterfaces, setCEType

Since

Cisco VPN Solutions Center, Release 1.0

setNetworkName()

Sets the network name of the CiscoVsmBrowser::VsmCE router object to be generated by this VsmCECreator object.

Usage

void setNetworkName(
in string networkName)

raises(
RepException);

Parameters

networkName—in string that represents the network name of the CiscoVsmBrowser::VsmCE router object to be stored in the VPN Inventory Repository. The hostname+domainName string must be unique within a network although it may be duplicated for a different network.

Raises

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

See Also

CiscoVsmBrowser::VsmCE::getNetworkName, setHostName, setDomainName, setRouterPasswords, setRouterInterfaces, setCEType

Since

Cisco VPN Solutions Center, Release 1.0

setRouterInterfaces()

Sets the router-interface list for the CiscoVsmBrowser::VsmCE router object to be generated by this VsmCECreator object.

Usage

void setRouterInterfaces(
in CiscoVsmBrowser::VsmRouterInterfaceSeq interfaceList)

raises(
RepException);

Parameters

interfaceList—in CiscoVsmBrowser::VsmRouterInterfaceSeq that represents a list of router interfaces for the CiscoVsmBrowser::VsmCE router object to be stored in the VPN Inventory Repository.

Raises

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

Description

The setRouterInterfList() operation adds the list of available interfaces to the CiscoVsmBrowser::VsmCE router object in the VPN Inventory Repository. This operation does not affect provisioning.

See Also

CiscoVsmBrowser::VsmCE::getRouterInterfaceList, setHostName, setDomainName, setNetworkName, setRouterPasswords, setCEType

Since

Cisco VPN Solutions Center, Release 1.0

setRouterPasswords()

Sets the password list for the CiscoVsmBrowser::VsmCE router object to be generated by this VsmCECreator object.

Usage

void setRouterPasswords(
in CiscoVsmBrowser::VsmPasswordSeq passwordList)

raises(
RepException);

Parameters

passwordList—in CiscoVsmBrowser::VsmPasswordSeq that represents a list of passwords for the CiscoVsmBrowser::VsmCE router object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCE::getRouterPasswordList, setHostName, setDomainName, setNetworkName, setRouterInterfaces, setCEType

Since

Cisco VPN Solutions Center, Release 1.0

setTelnetRetries()

Sets the number of times to attempt a telnet connection for the CiscoVsmBrowser::VsmCE object to be generated 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, setTelnetTimeOut

Since

Cisco VPN Solutions Center, Release 1.2

setTelnetTimeOut()

Sets the telnet timeout value for the CiscoVsmBrowser::VsmCE object to be generated 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, setTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.2

Interface VsmCERCCreator

An instance of the VsmCERCCreator interface represents a creator object for a new CE routing community with which to define and add a new CiscoVsmBrowser::VsmCERC object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newCERCCreator() operation to get a new VsmCERCCreator object. Before adding a new CiscoVsmBrowser::VsmCERC object to the VPN Inventory Repository, set the following information for its VsmCERCCreator object:

Description of the CE routing community
Hub route target for a hub-and-spoke CERC
Spoke route target for a hub-and-spoke CERC
Auto-pick indicator to specify auto or manual generation of both hub and spoke RT values for a hub-and-spoke CERC

After setting information for the new VsmCERCCreator object, you can add a new CiscoVsmBrowser::VsmCERC object to the VPN Inventory Repository, assigning it to a specific VPN.

See Also

CiscoVsmBrowser::VsmCERC, CiscoVsmBrowser::VsmCERC::getID, CiscoVpnServiceModel::VpnInvMgr::newCERCCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCERCCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCERC

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmCERC object with the supplied settings and as a member of the specified virtual private network (VPN) to the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmCERC addToRep(
in CiscoVsmBrowser::VsmVPN vpn)

raises(
RepException);

Parameters

vpn—in CiscoVsmBrowser::VsmVPN that represents the virtual private network to which to assign membership for the CiscoVsmBrowser::VsmCERC object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmCERC—Object added to the VPN Inventory Repository through the VsmCERCCreator interface.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setAutoPickRTValues()

When TRUE, assuming a hub-and-spoke CERC configuration is used, indicates that route-target (RT) values for both the hub and spoke routers are to be automatically chosen for the CiscoVsmBrowser::VsmCERC object to be generated by this VsmCERCCreator object.

Usage

void setAutoPickRTValues(
in boolean autoPick);

Parameters

autoPick—in string that, when TRUE, indicates that route-target (RT) values for both the hub and spoke routers are to be automatically chosen for the CiscoVsmBrowser::VsmCERC object to be stored in the VPN Inventory Repository.

Raises

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

See Also

setHubRT, setSpokeRT

Since

Cisco VPN Solutions Center, Release 1.0

setDesc()

Sets a description string for the CiscoVsmBrowser::VsmCERC object to be generated by this VsmCERCCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCERC::getDesc, setHubRT, setSpokeRT, setAutoPickRTValues

Since

Cisco VPN Solutions Center, Release 1.0

setHubRT()

Assuming a hub-and-spoke CERC configuration is used, sets the route-target (RT) value for the hub router associated with the CiscoVsmBrowser::VsmCERC object to be generated by this VsmCERCCreator object.

Usage

void setHubRT(
in string rt)

raises(
RepException);

Parameters

rt—in string that represents a route-target (RT) value to be applied to the hub router of the CE routing community (CERC) that is associated with the CiscoVsmBrowser::VsmCERC object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCERC::getHubRT, setSpokeRT, setAutoPickRTValues

Since

Cisco VPN Solutions Center, Release 1.0

setSpokeRT()

Assuming a hub-and-spoke CERC configuration is used, sets the route-target (RT) value for the spoke routers that are associated with the CiscoVsmBrowser::VsmCERC object to be generated by this VsmCERCCreator object.

Usage

void setSpokeRT(
in string rt)

raises(
RepException);

Parameters

rt—in string that represents a route-target (RT) value to be applied to the spoke routers of the CE routing community (CERC) that is associated with the CiscoVsmBrowser::VsmCERC object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCERC::getSpokeRT, setHubRT, setAutoPickRTValues

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCoSProfileCreator

An instance of the VsmCoSProfileCreator interface represents a creator object for a class-of-service (CoS) profile with which to define and add a new CiscoVsmBrowser::VsmCoSProfile object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newCoSProfileCreator() operation to get a new VsmCoSProfileCreator object. Before adding a new CiscoVsmBrowser::VsmCoSProfile object to the VPN Inventory Repository, set the following information for its VsmCoSProfileCreator object:

CoS-profile name
Default status
Profile-configuration values
Out-of-contract multiplier

After setting information for the new VsmCoSProfileCreator object, you can add a new CiscoVsmBrowser::VsmCoSProfile object to the VPN Inventory Repository, assigning it to a specific provider and with specific list of classes.

See Also

CiscoVsmBrowser::VsmCoSProfile, CiscoVpnServiceModel::VpnInvMgr::newCoSProfileCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfileCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfile

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmCoSProfile object with the supplied settings—belonging to the specified provider administrative domain and with the specified classes of service—to the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmCoSProfile addToRep(
in CiscoVsmBrowser::VsmProviderAdminDomain provider,
in CiscoVsmBrowser::VsmCoSClassSeq classList)

raises(
RepException);

Parameters

provider—in CiscoVsmBrowser::VsmProviderAdminDomain that represents the provider administrative domain to which to apply the CiscoVsmBrowser::VsmCoSProfile object to be added to the VPN Intentory Repository.

classList—in CiscoVsmBrowser::VsmCoSClassSeq that represents list of service classes—that is, a CoS list—to be applied to the CiscoVsmBrowser::VsmCoSProfile object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmCoSProfile—Object added to the VPN Inventory Repository through the VsmCoSProfileCreator interface.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setCoSProfileConfig()

Sets the configuration values for the CiscoVsmBrowser::VsmCoSProfile object to be generated by this VsmCoSProfileCreator object.

Usage

void setCoSProfileConfig(
in CiscoVsmBrowser::VsmCoSProfileConfigSeq cosProfileConfigValues)

raises(
RepException);

Parameters

cosProfileConfigValues—in CiscoVsmBrowser::VsmCoSProfileConfigSeq that represents the configuration values for the class-of-service (CoS) profile that is associated with the CiscoVsmBrowser::VsmCoSProfile object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCoSProfile::getCoSProfileConfig, setName, setDefault, setOutOfContractMultiplier

setDefault()

When TRUE, sets the CiscoVsmBrowser::VsmCoSProfile object to be generated by this VsmCoSProfileCreator 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 stored 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, setName, setCoSProfileConfig, setOutOfContractMultiplier

setName()

Sets the name string for the CiscoVsmBrowser::VsmCoSProfile object to be generated by this VsmCoSProfileCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCoSProfile::getName, setDefault, setCoSProfileConfig, setOutOfContractMultiplier

Since

Cisco VPN Solutions Center, Release 1.0

setOutOfContractMultiplier()

Sets the out-of-contract multiplier for the CiscoVsmBrowser::VsmCoSProfile object to be generated by this VsmCoSProfileCreator object.

Usage

void setOutOfContractMultiplier(
in float multiplier)

raises(
RepException);

Parameters

multiplier—in float that represents the excessive data-flow-rate multiplier for the class-of-service (CoS) profile that is associated with the CiscoVsmBrowser::VsmCoSProfile object to be stored in the VPN Inventory Repository.

Raises

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

Description

The out-of-contract multiplier is applied to the contracted data-flow rate to determine the excessive-rate limit—that is, the rate beyond which data packets are to be dropped to excessive volume.

See Also

CiscoVsmBrowser::VsmCoSProfile::getOutOfContractMultiplier, setName, setDefault, setCoSProfileConfig

Interface VsmCustomerCreator

An instance of the VsmCustomerCreator interface represents a creator object for a new customer for whom to define and add a new CiscoVsmBrowser::VsmCustomer object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newCustomerCreator() operation to get a new VsmCustomerCreator object. Before adding a new CiscoVsmBrowser::VsmCustomer object to the VPN Inventory Repository, set the following information for its VsmCustomerCreator object:

Customer name
Customer-contact information

After setting information for the new VsmCustomerCreator object, you can add a new CiscoVsmBrowser::VsmCustomer object to the VPN Inventory Repository.

See Also

CiscoVsmBrowser::VsmCustomer, CiscoVsmBrowser::VsmCustomer::getAllCustomerSites, CiscoVsmBrowser::VsmCustomer::findCustomerSiteByName, CiscoVpnServiceModel::VpnInvMgr::newCustomerCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCustomer, VsmCustomerSiteCreator, CiscoVsmBrowser::VsmCustomerSite

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmCustomer object with the supplied settings to the VPN Inventory Repository.

Usage

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

Returns

CiscoVsmBrowser::VsmCustomer—Object added to the VPN Inventory Repository by this VsmCustomerCreator object.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setContactInfo()

Sets the contact information for the CiscoVsmBrowser::VsmCustomer object to be generated by this VsmCustomerCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCustomer::getContactInfo, setName

Since

Cisco VPN Solutions Center, Release 1.0

setName()

Sets the name string for the CiscoVsmBrowser::VsmCustomer object to be generated by this VsmCustomerCreator object.

Usage

void setName(
in string customerName)

raises(
RepException);

Parameters

customerName—in string that represents the name of the customer that is associated with the CiscoVsmBrowser::VsmCustomer object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCustomer::getName, setContactInfo

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCustomerSiteCreator

An instance of the VsmCustomerSiteCreator interface represents a creator object for a new customer site with which to define and add a new CiscoVsmBrowser::VsmCustomerSite object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newCustomerSiteCreator() operation to get a new VsmCustomerSiteCreator object. Before adding a new CiscoVsmBrowser::VsmCustomerSite object to the VPN Inventory Repository, set the following information for its VsmCustomerSiteCreator object:

Customer-site name
Site-location information

After setting information for the new VsmCustomerSiteCreator object, you can add a new CiscoVsmBrowser::VsmCustomerSite object to the VPN Inventory Repository, assigning it to a specific customer.

See Also

CiscoVsmBrowser::VsmCustomerSite, CiscoVpnServiceModel::VpnInvMgr::newCustomerSiteCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerSiteCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerSite

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmCustomerSite object with the supplied settings to the specified customer in the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmCustomerSite addToRep(
in CiscoVsmBrowser::VsmCustomer customer)

raises(
RepException);

Parameters

customer—in CiscoVsmBrowser::VsmCustomer that represents the customer to whom to assign the CiscoVsmBrowser::VsmCustomerSite object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmCustomerSite—Object added to the VPN Inventory Repository through the VsmCustomerSiteCreator interface.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setLocationInfo()

Sets the location information for the CiscoVsmBrowser::VsmCustomerSite object to be generated by this VsmCustomerSiteCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCustomer::getContactInfo, setName

Since

Cisco VPN Solutions Center, Release 1.0

setName()

Sets the name string for the CiscoVsmBrowser::VsmCustomerSite object to be generated by this VsmCustomerSiteCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCustomerSite::getName, setLocationInfo

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmPECreator

An instance of the VsmPECreator interface represents a creator object for a new provider-edge router (PE) with which to define and add a new CiscoVsmBrowser::VsmPE object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newPECreator() operation to get a new VsmPECreator object. Before adding a new CiscoVsmBrowser::VsmPE object to the VPN Inventory Repository, set the following information for its VsmPECreator object:

Host name
Domain name
Network name
Password list
Router-interface list

After setting information for the new VsmPECreator object, you can add a new CiscoVsmBrowser::VsmPE object to the VPN Inventory Repository, assigning it to a specific region of the provider administrative domain.

See Also

CiscoVsmBrowser::VsmPE, CiscoVsmBrowser::VsmPE::getID, CiscoVpnServiceModel::VpnInvMgr::newPECreator, CiscoVpnServiceModel::VpnInvMgr::releasePECreator, CiscoVpnServiceModel::VpnInvMgr::releasePE

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmPE object with the supplied settings to the specified region in the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmPE addToRep(
in CiscoVsmBrowser::VsmRegion region)

raises(
RepException);

Parameters

region—in CiscoVsmBrowser::VsmRegion that represents the region of the CiscoVsmBrowser::VsmPE router object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmPE—Object added to the VPN Inventory Repository through the VsmPECreator interface.

Raises

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

See Also

CiscoVsmBrowser::VsmPE::getRegion, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setDomainName()

Sets the domain name of the CiscoVsmBrowser::VsmPE router object to be generated by this VsmPECreator object.

Usage

void setDomainName(
in string domainName)

raises(
RepException);

Parameters

domainName—in string that represents the domain name of the CiscoVsmBrowser::VsmPE router object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmPE::getDomainName, setHostName, setNetworkName, setRouterPasswords, setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

setHostName()

Sets the host name of the CiscoVsmBrowser::VsmPE router object to be generated by this VsmPECreator object.

Usage

void setHostName(
in string hostName)

raises(
RepException);

Parameters

hostName—in string that represents the host name of the CiscoVsmBrowser::VsmPE router object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmPE::getHostName, setDomainName, setNetworkName, setRouterPasswords, setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

setNetworkName()

Sets the network name of the CiscoVsmBrowser::VsmPE router object to be generated by this VsmPECreator object.

Usage

void setNetworkName(
in string networkName)

raises(
RepException);

Parameters

networkName—in string that represents the network name of the CiscoVsmBrowser::VsmPE router object to be stored in the VPN Inventory Repository. The hostname+domainName string must be unique within a network although it may be duplicated for a different network.

Raises

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

See Also

CiscoVsmBrowser::VsmPE::getNetworkName, setHostName, setDomainName, setRouterPasswords, setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

setRouterInterfaces()

Sets the router-interface list for the CiscoVsmBrowser::VsmPE router object to be generated by this VsmPECreator object.

Usage

void setRouterInterfaces(
in CiscoVsmBrowser::VsmRouterInterfaceSeq interfaceList)

raises(
RepException);

Parameters

interfaceList—in CiscoVsmBrowser::VsmRouterInterfaceSeq that represents a list of router interfaces for the CiscoVsmBrowser::VsmPE router object to be stored in the VPN Inventory Repository.

Raises

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

Description

The setRouterInterfList() operation adds the list of available interfaces to the CiscoVsmBrowser::VsmPE router object in the VPN Inventory Repository. This operation does not affect provisioning.

See Also

CiscoVsmBrowser::VsmPE::getRouterInterfaceList, setHostName, setDomainName, setNetworkName, setRouterPasswords

Since

Cisco VPN Solutions Center, Release 1.0

setRouterPasswords()

Sets the password list for the CiscoVsmBrowser::VsmPE router object to be generated by this VsmPECreator object.

Usage

void setRouterPasswords(
in CiscoVsmBrowser::VsmPasswordSeq passwordList)

raises(
RepException);

Parameters

passwordList—in CiscoVsmBrowser::VsmPasswordSeq that represents a list of passwords for the CiscoVsmBrowser::VsmPE router object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmPE::getRouterPasswordList, setHostName, setDomainName, setNetworkName, setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

setTelnetRetries()

Sets the number of times to attempt a telnet connection for the CiscoVsmBrowser::VsmPE object to be generated 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, setTelnetTimeOut

Since

Cisco VPN Solutions Center, Release 1.2

setTelnetTimeOut()

Sets the telnet timeout value for the CiscoVsmBrowser::VsmPE object to be generated 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, setTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.2

Interface VsmPRGCreator

An instance of the VsmPRGCreator interface represents a creator object for a new port-reservation group with which to define and add a new CiscoVsmBrowser::VsmPRG object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newPRGCreator() operation to get a new VsmPRGCreator object. Before adding a new CiscoVsmBrowser::VsmPRG object to the VPN Inventory Repository, set a description for it in its VsmPRGCreator object.

After setting information for the new VsmPRGCreator object, you can add a new CiscoVsmBrowser::VsmPRG object to the VPN Inventory Repository, assigning it to a specific VPN.

See Also

CiscoVsmBrowser::VsmPRG, CiscoVsmBrowser::VsmPRG::getID, CiscoVpnServiceModel::VpnInvMgr::newPRGCreator, CiscoVpnServiceModel::VpnInvMgr::releasePRGCreator, CiscoVpnServiceModel::VpnInvMgr::releasePRG

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmPRG object with the supplied settings and as a member of the specified virtual private network (VPN) to the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmPRG addToRep(
in CiscoVsmBrowser::VsmVPN vpn)

raises(
RepException);

Parameters

vpn—in CiscoVsmBrowser::VsmVPN that represents the virtual private network associated with the CiscoVsmBrowser::VsmPRG object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmPRG—Object added to the VPN Inventory Repository through the VsmPRGCreator interface.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setDesc()

Sets a description string for the CiscoVsmBrowser::VsmPRG object to be generated by this VsmPRGCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmCERC::getDesc

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmProviderAdminDomainCreator

An instance of the VsmProviderAdminDomainCreator interface represents a creator object for a new provider administrative domain with which to define and add a new CiscoVsmBrowser::VsmProviderAdminDomain object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newVsmProviderAdminDomainCreator() operation to get a new VsmProviderAdminDomainCreator object. Before adding a new CiscoVsmBrowser::VsmProviderAdminDomain object to the VPN Inventory Repository, set the following information for its VsmProviderAdminDomainCreator object:

Provider administrative domain name
Provider contact information
BGP autonomous-system (AS) number

After setting information for the new VsmProviderAdminDomainCreator object, you can add a new CiscoVsmBrowser::VsmProviderAdminDomain object to the VPN Inventory Repository.

See Also

CiscoVsmBrowser::VsmProviderAdminDomain, CiscoVpnServiceModel::VpnInvMgr::newVsmProviderAdminDomainCreator, CiscoVpnServiceModel::VpnInvMgr::releaseProviderAdminDomainCreator, CiscoVpnServiceModel::VpnInvMgr::releaseProvider

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmProviderAdminDomain object with the supplied settings to the VPN Inventory Repository.

Usage

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

Returns

CiscoVsmBrowser::VsmProviderAdminDomain—Object added to the VPN Inventory Repository by this VsmProviderAdminDomainCreator object.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setASNumber()

Sets the BGP autonomous system (AS) number for the CiscoVsmBrowser::VsmProviderAdminDomain object to be generated by this VsmProviderAdminDomainCreator object.

Usage

void setASNumber(
in unsigned long asNumber)

raises(
RepException);

Parameters

asNumber—in unsigned long that represents the BGP autonomous system (AS) number for the CiscoVsmBrowser::VsmProviderAdminDomain object to be generated by this VsmProviderAdminDomainCreator object.

Raises

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

See Also

CiscoVsmBrowser::VsmProviderAdminDomain::getASNumber, setName, setContactInfo

setContactInfo()

Sets the contact information for the CiscoVsmBrowser::VsmProviderAdminDomain object to be generated by this VsmProviderAdminDomainCreator object.

Usage

void setContactInfo(
in string contactInfo)

raises(
RepException);

Parameters

contactInfo—in string that represents the contact information of the provider that is associated with the CiscoVsmBrowser::VsmProviderAdminDomain object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmProviderAdminDomain::getContactInfo, setName, setASNumber

Since

Cisco VPN Solutions Center, Release 1.0

setName()

Sets the name string for the CiscoVsmBrowser::VsmProviderAdminDomain object to be generated by this VsmProviderAdminDomainCreator object.

Usage

void setName(
in string providerAdminDomainName)

raises(
RepException);

Parameters

providerAdminDomainName—in string that represents the name of the provider that is associated with the CiscoVsmBrowser::VsmProviderAdminDomain object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmProviderAdminDomain::getName, setContactInfo, setASNumber

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmRegionCreator

An instance of the VsmRegionCreator interface represents a creator object for a new region of the provider backbone network with which to define and add a new CiscoVsmBrowser::VsmRegion object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newRegionCreator() operation to get a new VsmRegionCreator object. Before adding a new CiscoVsmBrowser::VsmRegion object to the VPN Inventory Repository, set the name of the region for its VsmRegionCreator object.

After setting information for the new VsmRegionCreator object, you can add a new CiscoVsmBrowser::VsmRegion object to the VPN Inventory Repository, assigning it to a specific provider.

See Also

CiscoVsmBrowser::VsmRegion, CiscoVpnServiceModel::VpnInvMgr::newRegionCreator, CiscoVpnServiceModel::VpnInvMgr::releaseRegionCreator, CiscoVpnServiceModel::VpnInvMgr::releaseRegion

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmRegion object with the supplied settings and belonging to the specified provider administrative domain to the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmRegion addToRep(
in CiscoVsmBrowser::VsmProviderAdminDomain provider)

raises(
RepException);

Parameters

provider—in CiscoVsmBrowser::VsmProviderAdminDomain that represents the provider administrative domain to which to assign the CiscoVsmBrowser::VsmRegion object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmRegion—Object added to the VPN Inventory Repository through the VsmRegionCreator interface.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmVpnCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setName()

Sets the name string for the CiscoVsmBrowser::VsmRegion object to be generated by this VsmRegionCreator 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 stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmRegion::getName

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmVpnCreator

An instance of the VsmVpnCreator interface represents a creator object for a new virtual private network (VPN) with which to define and add a new CiscoVsmBrowser::VsmVPN object to the VPN Inventory Repository.

Description

Execute the CiscoVpnServiceModel::VpnInvMgr::newVPNCreator() operation to get a new VsmVpnCreator object. Before adding a new CiscoVsmBrowser::VsmVPN object to the VPN Inventory Repository, set the name of the VPN for its VsmVpnCreator object.

After setting information for the new VsmVpnCreator object, you can add a new CiscoVsmBrowser::VsmVPN object to the VPN Inventory Repository, assigning it to a specific region of the provider administrative domain.

See Also

CiscoVsmBrowser::VsmVPN, CiscoVpnServiceModel::VpnInvMgr::newVPNCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPNCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPN, CiscoVpnServiceModel::VpnInvMgr::newVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::newVPNServiceModifier, CiscoVpnServiceModel::VpnInvMgr::releaseVPNServiceModifier

Since

Cisco VPN Solutions Center, Release 1.0

Operations

addToRep()

Adds a CiscoVsmBrowser::VsmVPN object with the supplied settings and belonging to the specified provider administrative domain to the VPN Inventory Repository.

Usage

CiscoVsmBrowser::VsmVPN addToRep(
in CiscoVsmBrowser::VsmProviderAdminDomain provider)

raises(
RepException);

Parameters

provider—in CiscoVsmBrowser::VsmProviderAdminDomain that represents the provider administrative domain to which to assign the CiscoVsmBrowser::VsmVPN object to be added to the VPN Intentory Repository.

Returns

CiscoVsmBrowser::VsmVPN—Object added to the VPN Inventory Repository through the VsmVpnCreator interface.

Raises

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

See Also

VsmPECreator::addToRep, VsmCECreator::addToRep, VsmProviderAdminDomainCreator::addToRep, VsmCustomerCreator::addToRep, VsmCustomerSiteCreator::addToRep, VsmRegionCreator::addToRep, VsmCoSProfileCreator::addToRep, VsmCERCCreator::addToRep, VsmPRGCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

setName()

Sets the name string for the CiscoVsmBrowser::VsmVPN object to be generated by this VsmVpnCreator object.

Usage

void setName(
in string vpnName)

raises(
RepException);

Parameters

vpnName—in string that represents the name of the virtual private network (VPN) that is associated with the CiscoVsmBrowser::VsmVPN object to be stored in the VPN Inventory Repository.

Raises

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

See Also

CiscoVsmBrowser::VsmVPN::getName

Since

Cisco VPN Solutions Center, Release 1.0

Table of Contents

CiscoVsmFWCreator.idl