| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
The administrative state of the service .
type=service.ServiceState default=up Displayed(tab/group)=Administrative State |
| aggrOperationalState |
The operational status of this service site.
type=service.AggrOperState access=read-only default=up Displayed(tab/group)=Aggregated Service Site Operational State |
| compositeSvcId |
type=long access=read-only Displayed(tab/group)=Composite ID |
| compositeSvcPointer |
type=Pointer access=read-only Displayed(tab/group)=Composite Service |
| configuredNumberOfSites |
type=int access=read-only default=0 |
| containsDynamicSites |
Indicates whether this service contains sites created by a dynamic service policy.
type=boolean access=read-only default=false Displayed(tab/group)=Contains Dynamically Created Sites |
| customerName |
type=string access=read-only default= maximum=255 Displayed(tab/group)=Customer Name |
| description |
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description |
| displayedName |
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Service Name, Name (/Service Tunnel) |
| enableAppPerfReporting |
NSP Analytics property to enable Application Performance reporting.
type=boolean default=false Displayed(tab/group)=Enable Application Performance Reporting for Residential Groups (Application Assurance.NSP Analytics Parameters.General) |
| flowThruSvcPtrs |
The list of Services that are using this tunnel.
type=Set (Pointer) access=read-only |
| globalServiceComments |
type=string default= minimum=0 maximum=256 |
| globalServiceName |
type=string default= minimum=0 maximum=80 |
| groupPointer |
This attribute points to the SimpleGroup object on which this service is limited.
Presently, this field has only meaning for services of type VLAN but will be
extended to other types in the future. If you aren't creating a VLAN service,
do not modify this attribute (leave to default).
type=Pointer access=read-create default= Mandatory on create |
| id |
type=long access=read-create default=0 minimum=1 maximum=1000000999999 Displayed(tab/group)=SVC Mgr Service ID |
| ipDetailCount |
NSP Analytics property for the number of addresses that require IP Detail reporting.
type=int default=10 minimum=0 maximum=100 Displayed(tab/group)=Number Of IP Detail Addresses (Application Assurance.NSP Analytics Parameters.General) |
| isSegmented |
Specifies if this service has already been segmented.
type=boolean access=read-only default=false |
| isTunnelBeingUsed |
This property specifies whether a service tunnel is being used or not.
type=boolean access=read-only default=false Displayed(tab/group)=Used By a Service (/Service Tunnel) |
| lockOlcState |
This is used to lock the OLC State while in OLC Maintenance State only.
type=boolean default=false Displayed(tab/group)=Lock OLC State (/OLC) |
| mfThroughputTest |
Indicates whether this service is modified for the service throughput test.
type=boolean access=read-only default=false Displayed(tab/group)=Modified for Throughput Test |
| mtuInconsistent |
type=boolean access=read-only default=false |
| nsdManaged |
This property is used by NSD and indicates whether this service is eligible to be managed by NSD.
type=boolean default=false Displayed(tab/group)=NSD Managed |
| numberOfCircuitsInconsistent |
As of release 4.0 this property is not supported for VPLS and Management-VPLS
services (the calculation of this value could be incorrect if there is a
Spoke SDP Binding between two sites of the same (M)VPLS service).
As of release 4.0 the value for VPLS and M-VPLS services is always 'false'.
type=boolean access=read-only default=false |
| numberOfConnector |
type=int access=read-only default=0 |
| numberOfInterfacesInconsistent |
type=boolean access=read-only default=false |
| numberOfSegments |
Number of segments in this service.
type=int access=read-only default=0 |
| numberOfSites |
type=int access=read-only default=0 Displayed(tab/group)=Number Of Sites |
| numberOfSitesInconsistent |
type=boolean access=read-only default=false |
| olcState |
Object Life Cycle can be set using generic.GenericObject.updateUserObjectLifecycleStates().
type=generic.OLCStates access=read-only default=inService Displayed(tab/group)=Current OLC State (/OLC) |
| operationalFlags |
Specifies all the conditions that affect the
operating status of this service.
type=service.OperFlags access=read-only Displayed(tab/group)=State Cause |
| reportCustName |
Customer name to be used for NSP Analytics reports.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Report Customer Name (Application Assurance.NSP Analytics Parameters.General) |
| sas.OneTimeValidationResult-Set |
type=Children-Set |
| sasEntityName |
type=string access=read-only minimum=0 maximum=252 |
| sasTestSuiteCount |
type=int access=read-only default=0 minimum=0 Displayed(tab/group)=Test Suite Count |
| service.CustomDCPGroup-Set |
type=Children-Set |
| service.IPDetailApp-Set |
type=Children-Set |
| service.IPDetailAppGrp-Set |
type=Children-Set |
| service.ServiceThroughputConfig-Set |
type=Children-Set |
| service.SystemDCPGroup-Set |
type=Children-Set |
| service.TerminationPointPointer-Set |
type=Children-Set |
| serviceId |
type=long access=read-create default=0 minimum=1 maximum=2147483647 Displayed(tab/group)=Service ID |
| serviceTypeInconsistent |
type=boolean access=read-only default=false |
| subscriberId |
type=long access=read-only default=0 Displayed(tab/group)=Customer ID |
| subscriberPointer |
type=Pointer access=read-create Mandatory on create Displayed(tab/group)=Customer |
| svcConnectionType |
The connection between the service and the service tunnel
type=svt.ConnectionType access=read-only default=unspecified Displayed(tab/group)=Connection Type (/Service Tunnel) |
| svcPriority |
Indicates the Priority of the Service. Low: Indicates that the service can be deleted by simply ticking a box in the confirmation dialog. Medium: Indicates that the operator needs to confirm the deletion by providing the priority of the service as confirmation, hence has to type in "Medium". High: Indicates that administrator rights are required to delete the service and the operator needs to confirm the deletion by providing the priority of the service as confirmation, hence has to type in "High". type=security.PriorityTypedefault=low Displayed(tab/group)=Service Priority |
| svcSegmentPointerList |
The list of service segments full names within this service.
(This list is only applicable if the service isSegmented)
type=Set (Pointer) access=read-only |
| svcTunnelPtrs |
The list of Service Tunnels that are being used by this service.
type=Set (Pointer) access=read-only |
| svcTunnelType |
The type of service tunnel
type=svt.TunnelType access=read-only default=service Displayed(tab/group)=Tunnel Type (/Service Tunnel) |
| templatePointer |
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=Template |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| tier |
type=int default=1 minimum=1 maximum=10 Displayed(tab/group)=Service Tier |
| topologyMisconfigured |
As of release 4.0 this property is not supported for VPLS and Management-VPLS
services (the calculation of this value could be incorrect if there is a
Spoke SDP Binding between two sites of the same (M)VPLS service).
As of release 4.0 the value for VPLS and M-VPLS services is always 'false'.
As of release 11.0 R5, TopologyMisconfigured alarm is no longer raised on VLL services.
Hence; the value of this property is always false.
type=boolean access=read-only default=false |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
aInSvcMgrIds
: Set (long) - A set contains service manager IDs.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
instanceFullName
: string - the full name of the object.
filter
: FilterHolder - Optional filter for service segments.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
segments
: List (generic.CommonManagedEntityInformation) - Segments of this service.
The returned segment objects are shallow (they do not contain any child objects).
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.
svcMgrId
: long - The specified service manager ID.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false