Overview Package Class Deprecated Help

vpls
Vpls

public class Vpls

Properties
cac.BandwidthReservedTunnel-Set type=Children-Set
dctr.VplsVirtualSite-Set type=Children-Set
hasEthRingCtrlSAP A flag indicates whether there are any Ethernet Ring Control SAPs in this service.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Has Ethernet Ring Control SAP(s)
overrides Map of overrides of default custom property values.

type=Map (Pointer to string)
service.VlanUplink-Set type=Children-Set
steerParamInclude A bitmap used to determine which tunnel admin groups are currently included for this service tunnel.

type=long
default=0
Displayed(tab/group)=Included (bitmap) (Tunnel Admin Groups), Included (bitmap) (Tunnel Admin Groups)
vpls.BSite-Set type=Children-Set
vpls.EvpnSite-Set type=Children-Set
vpls.ISite-Set type=Children-Set
vpls.Site-Set type=Children-Set
  
Properties inherited from vpls.AbstractVpls
bandwidthMethod, bgpAdAdminStatus, cacProbableCause, cacStatus, cos0BW, cos1BW, cos2BW, cos3BW, cos4BW, cos5BW, cos6BW, cos7BW, defaultMeshVcId, fullyConnected, hasProblem, includeBSite, includeEVPNSite, includeEtreeSite, includeISite, inheritanceMask, l2fwd.ServiceMacProtection-Set, lastAuditTime, lastCacTime, lspPathBooking, missSpokeConfiguration, missingMeshSdpBinding, packagePolicyPointer, rca.Problem-Set, service.GneSite-Set, svcConnectionType, tier, topologyAutoCompletion, topologyAutoCompletionType, tunnelSelectionProfile, useBwReservedPath, vPDomain, vplsId
 
Properties inherited from service.Service
administrativeState, aggrOperationalState, compositeSvcId, compositeSvcPointer, configuredNumberOfSites, containsDynamicSites, customerName, description, displayedName, enableAppPerfReporting, flowThruSvcPtrs, globalServiceComments, globalServiceName, groupPointer, id, ipDetailCount, isSegmented, isTunnelBeingUsed, lockOlcState, mfThroughputTest, mtuInconsistent, nsdManaged, numberOfCircuitsInconsistent, numberOfConnector, numberOfInterfacesInconsistent, numberOfSegments, numberOfSites, numberOfSitesInconsistent, olcState, operationalFlags, reportCustName, sas.OneTimeValidationResult-Set, sasEntityName, sasTestSuiteCount, service.CustomDCPGroup-Set, service.IPDetailApp-Set, service.IPDetailAppGrp-Set, service.ServiceThroughputConfig-Set, service.SystemDCPGroup-Set, service.TerminationPointPointer-Set, serviceId, serviceTypeInconsistent, subscriberId, subscriberPointer, svcConnectionType, svcPriority, svcSegmentPointerList, svcTunnelPtrs, svcTunnelType, templatePointer, templateVersionPointer, tier, topologyMisconfigured
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

prepareThroughputTest

DEPRECATED - 11.0 R5 - create an instance of {{service.ServiceThroughputConfig}} instead
Prepare the throughput test with the test info passed in.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
testInfo : service.ThroughputTestStruct -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (string) - A list of error messages.

restoreServiceForThroughputTest

Restore the service from the throughput test.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
serviceFdn : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (string) - A list of error messages.

restoreSitesForThroughputTest

DEPRECATED - 11.0 R5 - delete the object of {{service.ServiceThroughputConfig}} instead
Restore the service sites from the throughput test.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
sourceSiteFdn : string -
destinationSiteFdn : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (string) - A list of error messages.
Methods inherited from vpls.AbstractVpls
distributeServiceMacProtectionList, findAssociatedEpipeSites, findAssociatedISites
 
Methods inherited from service.Service
DeleteAllSystemDCPGroups, auditServiceState, getServiceSegments, rediscoverReturnSpokeSdpBinding, shutDown, turnUp