shg
Site



public class Site

Properties
autoLearnMacProtect Specifies whether to enable automatic population of the MAC protect list with source MAC addresses learned on the associated with this SHG.

type=generic.TruthValue
default=false
Displayed(tab/group)=Auto Learn Mac Protect

autoLearnMacProtectExcludeList Specifies mac-list name which contains MAC addresses to be excluded from auto learn mac protect. This property is valid only if shg.Site.autoLearnMacProtect is true. When shg.Site.autoLearnMacProtect is set to false, this property will be reset to default value.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Exclude MAC List

bgpVplsMhSiteName The name of the BGP Multi-homing VPLS site that this SHG site associated with.

type=string
access=read-only
default=
Displayed(tab/group)=Assigned to Multi-homing Site (/BGP Multi-homing)

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

description

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

displayedName

type=string
access=read-create
default=
minimum=1
maximum=32
Mandatory on create
Displayed(tab/group)=Name

residential tlsShgResidential indicates whether or not the split-horizon-group is residential. In a Residential Split Horizon Group (RSHG) there is no downstream broadcast, and all saps in the group will share the default ingress queue. The value can be specified during row-creation, cannot be changed later on.

type=boolean
access=read-create
default=false
Displayed(tab/group)=Residential

restrictProtectedSource

type=generic.TruthValue
default=false
Displayed(tab/group)=Restrict Protected Source

restrictProtectedSourceAction

type=service.RestrictProtectedSourceAction
default=disable
Displayed(tab/group)=Restrict Protected Source Action

restrictUnprotectedDestination

type=generic.TruthValue
default=false
Displayed(tab/group)=Restrict Unprotected Destination

serviceId

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

serviceName

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

serviceType

type=service.ServiceType
access=read-only
default=unknown
Displayed(tab/group)=Service Type (/Service)

siteId

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Site ID (/Site)

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)

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

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

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

configure

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.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -
Exceptions:
shg.Site.configureException

delete

DEPRECATED - 8.0.R1
Use
generic.GenericObject.deleteInstance() instead.
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

find

DEPRECATED - 8.0.R1
Use root find instead.
Input Parameters:
filter : FilterHolder -
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) -
Supported Network Elements
7450 ESS
7750 SR
7705 SAR Gen 2
7705 SAR Gen 2
7705 SAR Hm
7705 SAR H
7705 SAR Supported from 4.0.R1
7210 SAS M Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS T Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7210 SAS X
7210 SAS K
7210 SAS R
7250 IXR
7950 XRS
Product Specifics
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 (all versions)
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 (all versions)
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 (all versions)
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 (all versions)
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 (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0