vpls
AbstractSite

Abstract site class represents the regular VPLS or MVPLS service site.



public abstract class AbstractSite

Properties
bgpAdEnabled Specifies whether BGP AD is enabled on this site.

type=boolean
default=false

bgpAutoDiscoveryAdminState Specifies whether BGP auto-discovery is enabled on this service.

DEPRECATED: 8.0R3 - OBSOLETE: Use bgpAdEnabled instead.
type=vpls.RadiusDiscoveryAdminState
default=down

bgpEnabled Specifies whether BGP is enabled on this site. Note: Before SR 10.0, BGP is enabled by default on the node with vpls Site creation. After 10.0, BGP needs to be manually enabled on the node under vpls Site.

type=boolean
default=false

bgpVplsEnabled Specifies whether BGP VPLS is enabled on this site.

type=boolean
default=false

bidirectionalMIPEnabled Specifies whether sap bidir MIP functionality is enabled on the service or not. This object is used by TLS (VPLS) services only, and has no effect nor can it be modified on other service types. On services that do not support sap bidir this object is fixed to the value 'disabled (2)."

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=Bi Directional MIP (OAM.ETH-CFM/MIP Configuration)

clear.ClearRequest-Set type=Children-Set
defaultGatewayIpAddr Specifies the default gateway IP address used in multi-chassis operation associated with this TLS service.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Default Gateway IP Address (Default Gateway)

defaultGatewayIpAddrType Specifies the type of default gateway IP address used in multi-chassis operation associated with this TLS service.

type=rtr.InetAddressType
default=ipv4

defaultGatewayMacAddr Specifies the type of default gateway MAC address used in multi-chassis operation associated with this TLS service.

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Default Gateway MAC Address (Default Gateway)

ethernetoam.CfmVlanDefaultMd-Set type=Children-Set
firewallBypassPolicy Specifies the firewall security bypass policy.

type=Pointer
default=
Displayed(tab/group)=Security Bypass Policy (Security/Security Bypass)

gsmpAdministrativeState

type=vpls.GsmpAdminState
default=disabled
Displayed(tab/group)=GSMP Administrative State (/GSMP)

ingrPathMgmtPolicyPointer Pointer to the instance of the multicast Ingress PathMgmt Info policy.

type=Pointer
default=Multicast PathMgmt Info Policy:default
Displayed(tab/group)=Ingress Info Policy (Multicast.Mcast Path Mgmt.General/Info Policy)

l2fib.MFibGrpSrc-Set type=Children-Set
l2fwd.MldSiteMvr-Set type=Children-Set
l2fwd.SiteIgmpSnooping-Set type=Children-Set
l2fwd.SiteMacProtection-Set type=Children-Set
l2fwd.SiteMvr-Set type=Children-Set
l4LoadBalancing Specifies whether or not L4 hashing for TLS Ethernet services

type=boolean
default=false
Displayed(tab/group)=L4 Load Balancing (/Load Balancing)

localRouting

type=netw.RoutingState
access=read-create
default=disabled

mcastIpv6SnpgScope Specifies the flooding scope of IPv6 multicast traffic when pim-snooping is enabled in this TLS. If set to 'macBased' only the bottom 32 bits of the destination IPv6 will be used, the source IPv6 address will be ignored. If set to 'sgBased' the full IPv6 destination and source address will be used

type=vpls.McastIpv6SnpgScope
default=macBased
Displayed(tab/group)=Mcast IPv6 Snooping Scope (/Pim Snooping)

mcastShg

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

mfibTableHighWatermark

type=long
default=95
minimum=0
maximum=100
units=%
Displayed(tab/group)=High Watermark (Forwarding Control.MFIB/MFIB)

mfibTableLowWatermark

type=long
default=90
minimum=0
maximum=100
units=%
Displayed(tab/group)=Low Watermark (Forwarding Control.MFIB/MFIB)

mfibTableSize

type=long
default=0
minimum=0
maximum=40959
units=entries
Displayed(tab/group)=Table Size (Forwarding Control.MFIB/MFIB)

numberOfMeshSdpBindings The number of mesh SDP Bindings directly connected to this site.

type=int
access=read-only
default=0

pimSnpgEnabled

type=boolean
default=false
Displayed(tab/group)=Pim Snooping Enabled (/Pim Snooping)

radiusDiscoveryAdminState Specifies whether RADIUS auto-discovery is enabled on this service. If RADIUS auto-discovery is enabled, the spoke/mesh sdp binding can not be manually created on this service.

type=vpls.RadiusDiscoveryAdminState
access=read-only
default=down
Displayed(tab/group)=Administrative State (Auto Discovery.General/RADIUS)

rvplsEnabled Specifies whether or not the site is enabled for Routed VPLS.

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

shcvAction Specifies the action to be taken for hosts on this interface whose host connectivity checking fails. "Alarm" will raise an alarm indicating that a host is disconnected on this SAP. "Remove" will raise an alarm and remove the DHCP state and release allocated resources.

type=service.ShcvAction
default=alarm
Displayed(tab/group)=SHCV Action (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvInterval The default value depends whether the NE supports SHCV: if NE supports SHCV the default value is 10 minutes, otherwise is 0. The interval specifies the time, in minutes, within which hosts on a SAP should be verified. The interval starts for each host individually, when it is created. Dynamic and static hosts are treated in the same way. The actual rate dependents on the number of known hosts and the interval. Interval value '0' means SHCV is administratively disabled.

type=int
default=0
minimum=0
maximum=6000
units=minutes
Displayed(tab/group)=SHCV Interval (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvPolicyIPv4Pointer Specifies the Subscriber Host Connectivity Verification (SHCV) policy for both IPv4 only. A non empty value is only allowed while the value of shcvInterval is equal to zero and while the value of shcvPolicyPointer is empty

type=Pointer
default=
Displayed(tab/group)=SHCV IPv4 Policy (Subscriber Management.Host Connectivity/SHCV IPv4 Policy)

shcvRetryCount Specifies the number of connectivity check retransmissions. Setting the value to (n) specifies that, for any given host, at most (n+1) probes are done each interval, and (n+1) missed replies are considered as a connectivity failure.

type=int
default=2
minimum=2
maximum=29
Displayed(tab/group)=SHCV Retry Count (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvRetryTimeout Specifies the timeout in seconds before a connectivity check retransmission.

type=int
default=10
minimum=10
maximum=60
units=seconds
Displayed(tab/group)=SHCV Retry Timeout (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvSourceIpAddress The IP address to be used as the source for the UC ARP packets. A source IP address of 0.0.0.0 is valid and will prevent the host installing the ARP entry.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=SHCV Source IP Address (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvSourceIpAddressType

type=rtr.InetAddressType
default=ipv4

valid enums=ipv4 (Where implied is one of (multicast.IngrPathMgmtInfoPolicy))

shcvSourceMacAddress The MAC address to be used as the source for the UC ARP packets. If an all 0 MAC address is specified, the 7x50 will use the MAC address for the CPM known in the context of the VPLS service.

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=SHCV Source MAC Address (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

spiLoadBalancing Specifies specifies whether SPI use in hashing is enabled on this service.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=SPI Load Balancing (/Load Balancing)

svcAllowL2ptXstpBpdu Specifies whether 802.1D STP Layer 2 protocol termination BPDUs are enabled on the site or not.

type=vpls.L2PtXstpBpduType
access=read-create
default=unspecified
Displayed(tab/group)=Allow L2Pt Xstp BPDU

svcCustomerVcId This attribute is a property of 7210 SAS nodes.

type=int
access=read-create
default=0
minimum=0
maximum=4094
Displayed(tab/group)=Customer VID

svcSapType Specifies the type of SAPs which can be configured on the service site. The SAP type determines the encapsulation type (tagging behavior) for packets processed on the SAP.

type=vpls.SapType
access=read-create
default=nullStar
Displayed(tab/group)=SAP Type

svt.MeshSdpBinding-Set type=Children-Set
svt.SpokeSdpBinding-Set type=Children-Set
teidLoadBalancing Specifies whether TEID load balancing is enabled for this service.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=TEID Load Balancing (/Load Balancing)

topologyAutoCompletion IMPORTANT: Used internally by NFM-P, clients - other than NFM-P GUI - should not use this property. Value is copied from the parent (service). Whether NMS should automatically create the Mesh SDP bindings. If 'false' the user has to manually create the SDP bindings.

type=boolean
access=read-only

vpls.SiteMldSnooping-Set type=Children-Set
vpls.SitePimSnooping-Set type=Children-Set
vpls.SitePimSnoopingV6-Set type=Children-Set
vplsId The VPLS-ID of this VPLS Instance is BGP-AD is supported. This value will be used to uniquely identify this service. This attribute will could be displayed on the GUI if the use enables BGP-AD at the site level. This step has to be done manually at each instance site level. This value will be taken from the NFM-P service object.

type=string
access=read-only
default=0:0
minimum=3
maximum=32

vxlanSrcTepIpAddr Specifies the tunnel source IP address when doing VXLAN encapsulation of frames for this service (source VTEP).

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Source IP Address (/VXLAN Tunnel End Point)

vxlanSrcTepIpAddrType Specifies the type of IP address associated with vxlanSrcTepIpAddr.

type=rtr.InetAddressType
default=ipv4

 
Overridden Properties
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.

 
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 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 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
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6