vpls
Site



public class Site

Stats:
vpls.EvpnMplsIgmpSnpgErrorStats vpls.EvpnMplsIgmpSnpgStats vpls.VxlanIgmpSnpgErrorStats vpls.VxlanIgmpSnpgStats

Properties
bgpEvpnEnabled Specifies whether BGP EVPN is enabled on this site.

type=boolean
default=false

bridgeDomainId Identifies a specific Bridge Domain on the Network Element.

type=long
access=read-create
default=0
minimum=0
maximum=4096
Displayed(tab/group)=Bridge Domain ID

enableEvpnMplsRvplsEcmp Specifies whether ECMP behavior is enabled on R-VPLS EVPN MPLS services, so that the unnecessary performance impact can be avoided if there is no need for EVPN-MPLS ECMP.

type=boolean
default=false
Displayed(tab/group)=Enable EVPN-MPLS ECMP (/Routed VPLS)

enableIpItfBinding Indicates whether to allow IP interface binding on this service site.

type=boolean
default=false
Displayed(tab/group)=Enable IP Interface Binding (/Routed VPLS)

enableProxyArp A flag indicates whether proxy arp is enabled.

type=boolean
default=false
Displayed(tab/group)=Enable Proxy ARP

enableProxyNd A flag indicates whether proxy nd is enabled.

type=boolean
default=false
Displayed(tab/group)=Enable Proxy Node Discovery

enableSecureSaps Applicable to Telco 7250 only. Applicable to Telco 7250 only. Used to configure the SAPs to forward only traffic from the uplink ports. This is similar to Super-VLAN.

DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM
type=boolean
default=false

enableVxlanEcmp Specifies whether ECMP behavior is enabled on R-VPLS services, so that the unnecessary performance impact can be avoided if there is no need for VXLAN ECMP

type=boolean
default=false
Displayed(tab/group)=Enable VXLAN ECMP (/Routed VPLS)

gsmp.GsmpGroup-Set type=Children-Set
ipInterfaceName

type=string
access=read-only
default=

ipInterfacePointer

type=Pointer
access=read-only
default=
Displayed(tab/group)=L3 IP Interface (/Routed VPLS)

ipInterfaceServiceId

type=long
access=read-only
default=0

l2fwd.SiteFib-Set type=Children-Set
macMoveEnabled The value of the object tnSvcTlsMacMoveadminStatus specifies the administrative state of the MAC movement feature associated with this service.

type=boolean
default=false
Displayed(tab/group)=MAC Move Enabled (/MAC Move)

macMoveFrequency The value of the object tnSvcTlsMacMoveMaxRate specifies the maximum rate at which MAC's can be re-learned in this VPLS service, before the SAP where the moving MAC was last seen is automatically disabled in order to protect the system againts undetected loops or duplicate MAC's. The rate is computed as the maximum number of re-learns allowed in a 5 second interval: e.g. the default rate of 2 re-learns per second corresponds to 10 re-learns in a 5 second period.

type=int
default=2
minimum=1
maximum=10
Displayed(tab/group)=Frequency (/MAC Move)

macMoveRetries The value of the object tnSvcTlsMacMoveNumRetries specifies the number of times retries are performed for re-enabling the SAP/SDP. A value of zero indicates unlimited number of retries.

type=int
access=read-only
default=3
minimum=0
maximum=255
Displayed(tab/group)=Retries (/MAC Move)

macMoveRetry The value of tnSvcTlsMacMoveRetryTimeout specifies the time in seconds to wait before a SAP that has been disabled after exceeding the maximum re-learn rate is re-enabled. A value of zero indicates that the SAP will not be automatically re-enabled after being disabled. If after the SAP is re-enabled it is disabled again, the effective retry timeout is doubled in order to avoid thrashing. An inconsistentValue error is returned if the value of this object is set to less than five times the value of tnSvcTlsMacMoveRetryTimeout.

type=int
default=10
minimum=0
maximum=600
Displayed(tab/group)=Retry Timeout (/MAC Move)

mclagBinding

type=boolean
default=false
Displayed(tab/group)=Enable MC-LAG Binding (/MC-LAG configuration)

netIngClassificationOverridePointer Specifies the Network Ingress Classification Policy name for this service.

type=Pointer
default=
Displayed(tab/group)=7250 SROS Ingress Classification Policy (/Network Ingress QoS)

providerTunnelEnabled Specifies whether provider tunnel is enabled on this site.

type=boolean
default=false
Displayed(tab/group)=Enable Provider Tunnel (Provider Tunnel)

service.VideoIfAttachment-Set type=Children-Set
service.VideoInterface-Set type=Children-Set
shg.Site-Set type=Children-Set
spb.ConditionalStaticMac-Set type=Children-Set
svcVcType Applicable to Telco 7250 only. VC Type of the service.

DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM
type=vpls.ServiceVcType
default=ethernet

vpls.BgpAdSite-Set type=Children-Set
vpls.BgpCfg-Set type=Children-Set
vpls.BgpEvpn-Set type=Children-Set
vpls.BgpMhSite-Set type=Children-Set
vpls.BgpVplsSite-Set type=Children-Set
vpls.DataMulticastTunnelInterface-Set type=Children-Set
vpls.DynamicProxyArp-Set type=Children-Set
vpls.DynamicProxyNd-Set type=Children-Set
vpls.EVPNGateway-Set type=Children-Set
vpls.Endpoint-Set type=Children-Set
vpls.EvpnMplsPimSnooping-Set type=Children-Set
vpls.IgmpHostTracking-Set type=Children-Set
vpls.L2AccessInterface-Set type=Children-Set
vpls.L2ManagementInterface-Set type=Children-Set
vpls.MSap-Set type=Children-Set
vpls.ProviderTunnel-Set type=Children-Set
vpls.ProviderTunnelThreshold-Set type=Children-Set
vpls.ProxyArp-Set type=Children-Set
vpls.ProxyArpEntry-Set type=Children-Set
vpls.ProxyNd-Set type=Children-Set
vpls.ProxyNdEntry-Set type=Children-Set
vpls.SegmentRoutingV6-Set type=Children-Set
vpls.StaticProxyArp-Set type=Children-Set
vpls.StaticProxyNd-Set type=Children-Set
vpls.VXLANPimSnooping-Set type=Children-Set
vpls.VxlanVni-Set type=Children-Set
vplsMode Applicable to Telco 7250 only. The mode of the VPLS service being configured on this Site. The current applicable values are Qualified and Unqualified. This attribute is only valid on the 7250 ES node.

DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM
type=netw.VplsMode
access=read-only

vplsTag Applicable to Telco 7250 only. The VPLS Tag on a 7250 ES node is applicable on Qualified and Unqualified VPLS services. It represents the VLAN ID associated to this service on the node. For Qualified mode, all SAPs that will be located on this site will have to use an encapsulation value that matches the VPLS Tag selected here.

DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM
type=long
default=0
minimum=2
maximum=65535

wlangw.WlanGwVplsSite-Set type=Children-Set
  
Properties inherited from vpls.AbstractSite
bgpAdEnabled, bgpAutoDiscoveryAdminState, bgpEnabled, bgpVplsEnabled, bidirectionalMIPEnabled, clear.ClearRequest-Set, defaultGatewayIpAddr, defaultGatewayIpAddrType, defaultGatewayMacAddr, ethernetoam.CfmVlanDefaultMd-Set, firewallBypassPolicy, gsmpAdministrativeState, ingrPathMgmtPolicyPointer, l2fib.MFibGrpSrc-Set, l2fwd.MldSiteMvr-Set, l2fwd.SiteIgmpSnooping-Set, l2fwd.SiteMacProtection-Set, l2fwd.SiteMvr-Set, l4LoadBalancing, localRouting, mcastIpv6SnpgScope, mcastShg, mfibTableHighWatermark, mfibTableLowWatermark, mfibTableSize, numberOfMeshSdpBindings, pimSnpgEnabled, radiusDiscoveryAdminState, rvplsEnabled, shcvAction, shcvInterval, shcvPolicyIPv4Pointer, shcvRetryCount, shcvRetryTimeout, shcvSourceIpAddress, shcvSourceIpAddressType, shcvSourceMacAddress, spiLoadBalancing, svcAllowL2ptXstpBpdu, svcCustomerVcId, svcSapType, svt.MeshSdpBinding-Set, svt.SpokeSdpBinding-Set, teidLoadBalancing, topologyAutoCompletion, vcId, vpls.SiteMldSnooping-Set, vpls.SitePimSnooping-Set, vpls.SitePimSnoopingV6-Set, vplsId, vxlanSrcTepIpAddr, vxlanSrcTepIpAddrType
 
Properties inherited from vpls.AbstractTlsSite
bandwidthMethod, cos0BW, cos1BW, cos2BW, cos3BW, cos4BW, cos5BW, cos6BW, cos7BW, dstSapForTpTest, eTreeEnabled, ethOrIpL4TeidHashing, ignoreMtuMismatch, includeEtreeTaggedSap, includeEtreeTaggedSdp, l2fwd.SiteStp-Set, loopbackTimeForTpTest, loopbackTypeForTpTest, mfThroughputTest, mtu, overrideSvcBwConfig, perServiceHashing, portToRestoreSapForTpTest, pppoeCircuitId, srcSapForTpTest, testRole, testSource, testTarget, tunnelElmi, tunnelFaultNotification
 
Properties inherited from service.Site
acctSessionId, acctSessionIdCtrl, administrativeState, alarmProfile, creationOrigin, dependantOlcState, description, displayedName, dynamicServicePolicyPointer, ethernetSwitchCardPointer, isMemberOfSvcSegment, lockOlcState, monitorAccessInterfaceOper, mtu, mtuCheck, numberOfAccessInterfaces, numberOfCircuits, oamEnabled, olcState, operationalFlags, operationalState, rowStatus, rtr.ProtocolSite-Set, serviceId, serviceIdString, serviceName, serviceTypeMismatch, siteId, siteIdAddrType, subscriberId, subscriberName, svcComponentId, svcSegmentPointerList, templateVersionPointer, vcId
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

requestClearIgmpHostTracking

Request clearing of all IGMP Host Tracking information for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
aInOnlyStats : boolean - Whether to clear the IGMP Host Tracking statistics only (host tracking info is not cleared).
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearProxyArpDups

Request to clear the duplicate Proxy-ARP entrie(s)
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.
ipAddr : InetAddress - The IP address of the duplicate Proxy-Arp entry.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearProxyArpDyn

Request to clear the dynamic Proxy-ARP entrie(s)
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.
ipAddr : InetAddress - The IP address of the dynamic Proxy-Arp entry.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearProxyNdDups

Request to clear the duplicate Proxy-ND entrie(s)
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.
ipAddr : InetAddress - The IP address of the duplicate Proxy-ND entry.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearProxyNdDyn

Request to clear the dynamic Proxy-ND entrie(s)
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.
ipAddr : InetAddress - The IP address of the dynamic Proxy-ND entry.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Methods inherited from service.Site
findSitesFor, shutDown, turnUp
 
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
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
OS9700E/9800E
7705 SAR H
7705 SAR Supported from 4.0.R1
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Generic NE
Product Specifics
7210 SAS D (all versions)
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 (all versions)
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 E (all versions)
7210 SAS K (all versions)
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 (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
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 (all versions)
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 (all versions)
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 (all versions)
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
7210 SAS X (all versions)
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 (all versions)
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 (all versions)
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 (all versions)
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
DC 210 (all versions)
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 (all versions)
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 (all versions)
DC VSA8 5.0
DC VSA8 6.0
DC VSC (all versions)
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE (all versions)
Generic NE 1.0.0
OS9700E/9800E (all versions)
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6