service
Site



public abstract class Site

Properties
acctSessionId

type=string
access=read-only
default=
Displayed(tab/group)=Account Session ID (/Auto-Creation)

acctSessionIdCtrl

type=string
access=read-only
default=
Displayed(tab/group)=Account Session ID (Control) (/Auto-Creation)

administrativeState The administrative state of the service site.

type=netw.AdministrativeState
default=serviceUp
Displayed(tab/group)=Administrative State

alarmProfile

DEPRECATED: 23.4 - No longer applicable to any supported nodes
type=string
access=read-only
default=

creationOrigin Indicates the protocol or mechanism which created this site.

type=svt.L2RouteOriginType
access=read-create
default=manual
Displayed(tab/group)=Creation Mode (/Auto-Creation)

dependantOlcState

type=generic.OLCStates
access=read-only
default=inService

description

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description

displayedName Specifies the Name of the Service Site. It cannot be set to only spaces. Setting to "", "N/A", or "n/a" after creation, will clear Site Name from the node and NFM-P GUI will display "N/A". If not set by the user, a default value will be set by NSP-F automatically in the format of: [serviceType]:[mgrId]:[serviceId]:[nodeName]([siteId]) For SR 15.1, this attribute must be set to a unique value at creation - can be a string or number. If set to a number, the number must be of the same value as the service ID. There are a few exceptions: - For backhaul, there is no default name. It's left blank if user doesn't enter anything. - For VLAN, Vlan Name is used as the service Name

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=Name

dynamicServicePolicyPointer Identifies the Dynamic Service Policy used to create this service.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Dynamic Service Policy (/Auto-Creation)

ethernetSwitchCardPointer On 1830 PSS nodes, new cards like 11QPE24 supports E-LAN (VPLS) and later E-Line (VLL); other cards will follow. All of these cards support the SR-OS object model and behave similar to 7210 nodes. This object represents a service object on a given a site and card. This attribute is a pointer to the card model object.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Switch Name (/Network Element)

isMemberOfSvcSegment Specifies if this service site is member of any service segment.

type=boolean
access=read-only
default=false

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)

monitorAccessInterfaceOper

type=boolean
default=false
Displayed(tab/group)=Monitor Access Interface Operational State

mtu The maximum transfer unit of this site.

type=long
default=0
minimum=0
maximum=9714

mtuCheck

type=boolean
default=true

numberOfAccessInterfaces The number of access interfaces directly connected to this site.

type=long
access=read-only
default=0
Displayed(tab/group)=Number of SAPs

numberOfCircuits The number of circuits directly connected to this site.

type=long
access=read-only
default=0

oamEnabled Enable/disable OAM for this service site.

type=boolean
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.SiteOperFlags
access=read-only
Displayed(tab/group)=State Cause

operationalState The operational status of this service site.

type=netw.OperationalState
access=read-only
default=unknown
Displayed(tab/group)=Operational State

rowStatus This attribute is here to make Service Site compatible with the 7250 SNMP framework that is requiring the creation to be done using CreateAndWait instead of CreateAndGo.

DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM
type=int
access=read-only
default=1

rtr.ProtocolSite-Set type=Children-Set
serviceId

type=long
access=read-only
default=0
Displayed(tab/group)=Service ID (/Service)

serviceIdString A produce of the 7250 node; this attribute will store in a String format the service ID for this Service Site. The reason behind having this attribute is that the 7250 expects the service ID to be a service name (ie a String) that represents a number.

DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM
type=string
access=read-only
maximum=252

serviceName

type=string
access=read-only
default=
maximum=64
Displayed(tab/group)=Service Name (/Service)

serviceTypeMismatch

type=boolean
access=read-only
default=false

siteId

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=System ID (/Network Element)

siteIdAddrType

type=rtr.InetAddressType
access=read-only
default=ipv4

subscriberId

type=long
access=read-only
default=1
Displayed(tab/group)=Customer ID (/Customer)

subscriberName

type=string
access=read-only
default=
maximum=255
Displayed(tab/group)=Customer Name (/Customer)

svcComponentId

type=long
access=read-only
default=0
Displayed(tab/group)=SVC Mgr Service ID (/Service)

svcSegmentPointerList The list of service segments full names this site is a member of.

type=Set (Pointer)
access=read-only

templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)

vcId The virtual circuit identifier. For VPLS/MVPLS services on 7750/7450/7710-family nodes, it inherits the value of the default Mesh VC ID from the VPLS/MVPLS service component and the value is used for Mesh SDP Bindings. For 7250 nodes, it is the VC ID used for spoke SDP Bindings.

type=long
default=0
minimum=0
maximum=4294967295

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

findSitesFor

Find the sites identified by the filter.
Input Parameters:
filter : FilterHolder -
expandChildren : boolean -
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
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

shutDown

To administratively disable the service site.
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.
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

turnUp

To administratively enable the service site.
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.
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
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7250 IXR
7210 SAS R
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
OS6850/6850E
OS6855
OS6400
Wavence SM
OS6250
OS6450
OS6350
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
Generic NE
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Product Specifics
7210 SAS D 20.0.0
7210 SAS D 21.0.0
7210 SAS D 22.0.0
7210 SAS D 23.0.0
7210 SAS D 24.0.0
7210 SAS D 25.0.0
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE 1.0.0
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6350 6.7.2
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6400 6.4.3
OS6400 6.4.4
OS6400 6.4.5
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 8.10
OS6465 8.10
OS6465 8.6
OS6465 8.7
OS6465 8.8
OS6465 8.8
OS6465 8.9
OS6465 8.9
OS6465 8.9
OS6560/OS6560E 8.10
OS6560/OS6560E 8.10
OS6560/OS6560E 8.6
OS6560/OS6560E 8.7
OS6560/OS6560E 8.8
OS6560/OS6560E 8.8
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E 6.4.2
OS6850/6850E 6.4.3
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.6
OS6860E/OS6860N 8.7
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6865 8.10
OS6865 8.10
OS6865 8.6
OS6865 8.7
OS6865 8.8
OS6865 8.8
OS6865 8.9
OS6865 8.9
OS6865 8.9
OS6870 8.10
OS6900 8.10
OS6900 8.10
OS6900 8.6
OS6900 8.7
OS6900 8.8
OS6900 8.8
OS6900 8.9
OS6900 8.9
OS6900 8.9
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SM 19A.0.0
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0