pim
Site

PIM Site represents an instance of the PIM protocol running within a virtual router.



public class Site

Stats:
pim.PimGenSiteStats

Properties
addressFamilyIpV4

type=pim.PIMAddressFamily
access=read-only
default=ipv4Multicast

administrativeStateIpV4

type=netw.AdministrativeState
default=pimUp
Displayed(tab/group)=IPv4 Administrative State (RP Behavior.IPv4/States)

applyTo

type=pim.PimApplyToType
default=none
Displayed(tab/group)=Apply To (/PIM General Configurations)

autoDiscovery The value of vRtrPimNgAFGenMvpnAutoDiscovery specifies if auto-discovery via BGP is enabled. When auto-discovery is enabled, PIM peering on the inclusive provider tunnel is disabled.

type=generic.TruthValue
default=false
Displayed(tab/group)=Auto-Discovery (MVPN.General)

autoRPDiscovery Specifies whether auto RP is enabled in discovery mode for this PIM protocol instance.

type=generic.TruthValue
default=false
Displayed(tab/group)=Auto RP Discovery Enabled (RP Behavior.IPv4/Auto RP Discovery)

autoRPDiscoveryCandidate Specifies whether auto RP is enabled to advertise candidate-rp information for this PIM protocol instance.

type=boolean
default=false
Displayed(tab/group)=Candidate (RP Behavior.IPv4/Auto RP Discovery)

autoRPDiscoveryMappingAgent Specifies whether auto RP is enabled to behave as a mapping-agent for this PIM protocol instance.

type=boolean
default=false
Displayed(tab/group)=Mapping Agent (RP Behavior.IPv4/Auto RP Discovery)

bgpNextHopOverride Specifies whether VRF-Import extended community should not be applied to determine BGP next hop. By default it is false, as such the RPF is checked against VRF-Import extended community. When it is true, RPF to be checked against the IPv4-VPN address family nexthop.

type=boolean
default=false
Displayed(tab/group)=BGP Next Hop Override (/PIM General Configurations)

bsrAddress

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=BSR Address (RP Behavior.IPv4/Elected BootStrap Router)

bsrAddressType

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

bsrCandidateAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=CBSR Address (RP Behavior.IPv4/Candidate BootStrap Router)

bsrCandidateAddressType

type=rtr.InetAddressType
default=ipv4

bsrCandidateAdminState

type=netw.AdministrativeState
default=pimDown
Displayed(tab/group)=CBSR Admin State (RP Behavior.IPv4/Candidate BootStrap Router)

bsrCandidateHashMaskLength

type=int
default=30
minimum=0
maximum=32
Displayed(tab/group)=CBSR Hash Mask Length (RP Behavior.IPv4/Candidate BootStrap Router)

bsrCandidateOperState

type=netw.OperationalState
access=read-only
default=pimUp
Displayed(tab/group)=CBSR Operational State (RP Behavior.IPv4/Candidate BootStrap Router)

bsrCandidatePriority

type=int
default=0
minimum=0
maximum=255
Displayed(tab/group)=CBSR Priority (RP Behavior.IPv4/Candidate BootStrap Router)

bsrExpiryTime

type=long
access=read-only
units=seconds
Displayed(tab/group)=BSR Expiry Time (RP Behavior.IPv4/Elected BootStrap Router)

bsrHashMaskLength

type=int
access=read-only
Displayed(tab/group)=BSR Hash Mask Length (RP Behavior.IPv4/Elected BootStrap Router)

bsrPriority

type=int
access=read-only
Displayed(tab/group)=BSR Priority (RP Behavior.IPv4/Elected BootStrap Router)

bsrRpfIfIndex

type=int
access=read-only

bsrRpfInterfaceName

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=BSR RPF Interface (RP Behavior.IPv4/Elected BootStrap Router)

bsrState

type=pim.BSRState
access=read-only
Displayed(tab/group)=BSR State (RP Behavior.IPv4/BootStrap Router)

bsrUpTime

type=Time
access=read-only
Displayed(tab/group)=BSR Up Time (RP Behavior.IPv4/Elected BootStrap Router)

crpAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=C-RP Address (RP Behavior.IPv4/Candidate Rendezvous Point)

crpAddressType

type=rtr.InetAddressType
default=ipv4

crpHoldTime

type=long
default=150
minimum=5
maximum=255
units=seconds
Displayed(tab/group)=C-RP HoldTime (RP Behavior.IPv4/Candidate Rendezvous Point)

crpInterval

type=long
default=60
minimum=1
maximum=26214
units=seconds
Displayed(tab/group)=C-RP Interval (RP Behavior.IPv4/Candidate Rendezvous Point)

crpPriority

type=int
default=192
minimum=0
maximum=255
Displayed(tab/group)=C-RP Priority (RP Behavior.IPv4/Candidate Rendezvous Point)

dataMdtDelayInterval

type=long
default=3
minimum=3
maximum=180
units=seconds
Displayed(tab/group)=Data MDT Delay Interval (MDT/MDT Configurations), Delay Interval (MVPN Selective Tunnel.General/Data MDT)

dataMdtJoinTlvPack

type=generic.TruthValue
default=true
Displayed(tab/group)=Pack Data MDT Join TLV (MDT/MDT Configurations), Pack Data Join TLV (MVPN Selective Tunnel.PIM)

dataMdtPrefix

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Data MDT Prefix (MDT/MDT Configurations), PIM Prefix (MVPN Selective Tunnel.PIM)

dataMdtPrefixLength

type=int
default=0
minimum=0
maximum=32
Displayed(tab/group)=Data MDT Prefix Length (MDT/MDT Configurations), PIM Prefix Length (MVPN Selective Tunnel.PIM)

dataMdtPrefixType

type=rtr.InetAddressType
default=ipv4

ecmpBalance The value of specifies whether the multicast balancing of traffic over ECMP links is enabled or not. If the value is 'true', each and every multicast stream that needs to be forwarded over an ECMP link will be re-evaluated for the total multicast bandwidth utilization. Re-evaluation will happen on the ECMP interface in question." The value of ecmpBalance is mutually exclusive with the value of ecmpHashing in the same context.

type=generic.TruthValue
default=true
Displayed(tab/group)=ECMP Balancing Enabled (/ECMP)

ecmpBalanceHoldTime The value of specifies the hold time in minutes that applies after an interface has been added to the ECMP link.

type=long
default=1
minimum=1
maximum=600
units=minutes
Displayed(tab/group)=Hold Time (/ECMP)

ecmpHashing Specifies whether or not the multicast balancing of traffic over ECMP links is hash based. If ecmpHashing is 'true' then the multicast balancing of traffic over ECMP links is done based on Upstream Multicast Hop(UMH) algorithm. The value of ecmpHashing is mutually exclusive with the value of ecmpBalance in the same context.

type=boolean
default=false
Displayed(tab/group)=ECMP Hashing Enabled (/ECMP)

ecmpHashingRebalance Specifies whether the multicast balancing of the ECMP links which is hash based is triggered when a source is added. If ecmpHashingRebalance is 'false' then the multicast balancing of traffic over ECMP links is done after nexthop change event for individual Source address.

type=boolean
default=false
Displayed(tab/group)=Re-Balancing Enabled (/ECMP)

ecmpRebalancingInProgress The value of indicates whether or not multicast ECMP re-balancing is currently in progress or not.

type=generic.TruthValue
access=read-only
Displayed(tab/group)=Re-Balancing In Progress (/ECMP)

ecmpRebalancingOptionalThreshold The value indicates the optional threshold for ECMP balancing. This property is obsoleted from SR 6.0.

type=long
access=read-only

ecmpRebalancingTimeLast The value indicates the time when the last re-balancing occurred if the value of ecmpRebalancingInProgress is 'false'.

type=Time
access=read-only
Displayed(tab/group)=Last Re-Balancing Time (/ECMP)

ecmpRebalancingType The value indicates the type of ECMP rebalance.

type=pim.EcmpBalanceType
access=read-only
Displayed(tab/group)=Last Re-Balancing Type (/ECMP)

enableAsmDataMdt Specifies whether RP join on egress is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Enable ASM Data MDT (MVPN Selective Tunnel.PIM)

enableSptMdt Specifies whether or not Shortest Path Tree(SPT) switchover is enabled for the default Multicast Data Tunnel(MDT). If set to 'true' then SPT switchover is enabled and if set to 'false' SPT switchover is disabled. Additionally, whenever we change the value, the PIM instance must reset all MDTs and re-initiate setup.

type=boolean
default=false
Displayed(tab/group)=Enable SPT Switchover for Default MDT (/PIM General Configurations)

groupAddressMode The value of vRtrPimNgAFGenMvpnGrpAddrMode specifies which PIM mode to use, ASM or SSM, for PIM based inclusive provider tunnels.

type=pim.GroupAddMode
default=none
Displayed(tab/group)=Provider Tunnel Inclusive PIM Mode (MVPN Inclusive Tunnel.PIM)

groupPrefixAny Specifies whether join requests received by the MVPN, will be redirected to base instance or not.

type=generic.TruthValue
default=false
Displayed(tab/group)=Group Prefix Any (GRT Extranet.General/Group Prefix Any)

interSiteShared "Specifies whether to use inter-site shared C-trees or not. When the value is set to 'enabled', the use of inter-site shared C-trees is enabled. When the value is set to 'disabled', the use of inter-site shared C-trees is disabled."

type=generic.TruthValue
default=true
Displayed(tab/group)=Inter-Site Shared (MVPN.General)

lagUsageOptimize whether the router should optimize usage of the LAG such that traffic for a given multicast stream destined to an IP interface using the LAG is sent only to the forwarding complex that owns the LAG link on which it will actually be forwarded. If this optimization is turned off, the traffic will be sent to all the forwarding complexes that own at least one link in the LAG. Changing the value of this object causes the PIM protocol to be restarted."

type=generic.TruthValue
default=false
Displayed(tab/group)=Lag Usage Optimization (/Lag Usage)

maxMdts

type=int
access=read-only
Displayed(tab/group)=Max MDTs (MDT/MDT Configurations)

mcastFastFailover Specifies whether multicast fast-failover is enabled for this PIM protocol instance.

type=generic.TruthValue
default=false
Displayed(tab/group)=Multicast Fast-failover (/PIM General Configurations)

mcastSignaling The value of vRtrPimNgAFGenMvpnCMcastSignal specifies which protocol to use, BGP or PIM, for PE-to-PE signaling of CE multicast states. When vRtrPimNgAFGenMvpnCMcastSignal is set to 'pim' and neighbor discovery via BGP is disabled, PIM peering will be enabled on the inclusive tree.

type=pim.McastSignaling
default=pim
Displayed(tab/group)=MCast Signaling (MVPN.General)

mdtGroupIPAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=MDT Default Group Address (MDT/MDT Configurations), Group Address (MVPN Inclusive Tunnel.PIM/Group IP)

mdtGroupIPAddressType

type=rtr.InetAddressType
default=ipv4

mdtSafiAutoDiscovery The value of vRtrPimNgAFGenMvpnAD specifies the auto-discovery mechanism to be used for discovering peers using BGP. When the value of vRtrPimNgAFGenMvpnAD is set to 'none(0)', auto-discovery via BGP is disabled. When the value is set to 'default(1)', auto-discovery via BGP is enabled using default IPMSI AD format. When the value is set to 'mdtSafi(2)', auto-discovery via BGP is enabled using MDT-SAFI format

type=pim.AutoDiscoveryType
default=none
Displayed(tab/group)=Auto-Discovery (MVPN.General)

mtIfIndex

type=int
access=read-only
Displayed(tab/group)=MT IF Index (MDT/MDT Configurations)

mtuOverHead Specifies mtu size to be accounted for the PIM control packets sent over BIER tunnels.Valid values 0|44|76|140|268|536.

type=int
default=0
minimum=0
maximum=536
Displayed(tab/group)=MTU Overhead (/PIM General Configurations)

mvpnAutoDiscoveryDisabled The value of vRtrPimNgAFGenMvpnSpmsiAutoDisc specifies if auto-discovery-disable via BGP is disabled. When the value of vRtrPimNgAFGenMvpnSpmsiAutoDisc is set to 'true', then C-trees to P-tunnels binding auto-discovery via BGP is disabled and it is signaled using PIM join TLVs.

type=int
default=disabled
Displayed(tab/group)=Auto-Discovery (MVPN Selective Tunnel.PIM)
enums=
    2: enabled - Enabled
    1: disabled - Disabled

mvpnIpmsiType

type=pim.ProviderTunnelType
default=none
Displayed(tab/group)=Inclusive Tunnel Type (MVPN.General)

mvpnMdtType The MDT Type parameter specifies whether the PE node is a sender, receiver or both. When the parameter is set to 'Receiver Only', the PE node does not initiate and set up a P2MP I/S-PMSI that is originating locally. When the parameter is set to 'Sender Only', the PE node initiates and sets up a P2MP I-PMSI towards other receiver PE nodes. The PE node will set up a S-PMSI based on the configured threshold. When the parameter is set to 'Sender and Receiver', the PE node initiates and sets up a P2MP I-PMSI while also receiving from other sender PE nodes.

type=pim.MvpnMdtTypeOptions
default=senderReceiver
Displayed(tab/group)=MDT Type (MVPN.General)

mvpnSourceAddress This value specifies the source IP address to use in MVPN PIM signaling.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=MVPN Source Address (MVPN.General)

mvpnSourceAddressType The value of mvpnSourceAddressType specifies the address type of mvpnSourceAddress address.

type=rtr.InetAddressType
default=ipv4

mvpnSpmsiMaxLimit Specifies the maximum number of RSVP/mLDP P2MP S-PMSI tunnels for the mVPN.

type=long
default=10
minimum=1
maximum=4000
Displayed(tab/group)=P2MP Maximum Spmsi (MVPN Selective Tunnel.RSVP), P2MP Maximum Spmsi (MVPN Selective Tunnel.MLDP)

mvpnSpmsiType

type=pim.ProviderTunnelType
default=none
Displayed(tab/group)=Selective Tunnel Type (MVPN.General)

mvpnWildcardSpmsi Specifies whether (C-*,C-*) SPMSI is to be used instead of IPMSI.

type=boolean
default=false
Displayed(tab/group)=Wildcard SPMSI (MVPN.General)

mvpnWildcardSpmsiBsrSig Specifies how the BSR is signalled. This is applicable only when mvpnWildcardSpmsi is set to true.

type=pim.MvpnWildcardSpmsiBsrSigType
default=none
Displayed(tab/group)=Wildcard SPMSI BSR Signal (MVPN.General)

nonDrAttractTraffic

type=generic.TruthValue
default=false
Displayed(tab/group)=Non DR Attract Traffic (/PIM General Configurations)

operationalStateIpV4

type=netw.OperationalState
access=read-only
default=pimUp
Displayed(tab/group)=IPv4 Operational State (RP Behavior.IPv4/States)

persistentType5Adv Specifies whether the RP will keep advertising the source active route (SA). If the value is set to 'true', it will force the RP to send the SA on getting a register pdu from the source and RP will not withdraw that SA as long as the null register timer is running.

type=generic.TruthValue
default=false
Displayed(tab/group)=Persistent Type 5 Advertisement (MVPN.General)

pim.AnyCastRP-Set type=Children-Set
pim.DataMdtThreshold-Set type=Children-Set
pim.DataMtInterface-Set type=Children-Set
pim.EmbeddedRPGroupRange-Set type=Children-Set
pim.ExportBootstrapPolicy-Set type=Children-Set
pim.GroupPrefix-Set type=Children-Set
pim.Groups-Set type=Children-Set
pim.GrtExtranet-Set type=Children-Set
pim.ImportBootstrapPolicy-Set type=Children-Set
pim.ImportJoinPrunePolicy-Set type=Children-Set
pim.ImportRegisterPolicy-Set type=Children-Set
pim.Interface-Set type=Children-Set
pim.MultiStreamSPmsi-Set type=Children-Set
pim.MvpnProviderTunnelBier-Set type=Children-Set
pim.MvpnProviderTunnelMldp-Set type=Children-Set
pim.MvpnProviderTunnelRsvp-Set type=Children-Set
pim.MvpnProviderTunnelSegmentRouting-Set type=Children-Set
pim.MvpnProviderTunnelUMHSRateMonitoring-Set type=Children-Set
pim.MvpnUmhPEBackup-Set type=Children-Set
pim.RPSet-Set type=Children-Set
pim.RedundantSource-Set type=Children-Set
pim.RpfSelect-Set type=Children-Set
pim.SSMGroup-Set type=Children-Set
pim.SiteExtension-Set type=Children-Set
pim.SptSwitchOvrThreshold-Set type=Children-Set
pim.StaticRP-Set type=Children-Set
pimDenseAdminState

type=pim.PIMAdminState
default=disable
Displayed(tab/group)=Dense Admin state (/Dense Mode)

pimDmStateRefreshLimitInterval

type=int
default=0
minimum=0
maximum=65535
units=ticks
Displayed(tab/group)=State Refresh Limit Interval (/Dense Mode)

pimDmStateRefreshTimeToLive

type=int
default=16
minimum=0
maximum=255
units=seconds
Displayed(tab/group)=State Refresh TTL (/Dense Mode)

pimInterfaceElectionPeriod

type=int
default=65535
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Interface Election (/Notifications Period)

pimInvalidJoinPeriod

type=int
default=65535
minimum=10
maximum=65535
units=seconds
Displayed(tab/group)=Invalid Join (/Notifications Period)

pimInvalidRegisterPeriod

type=int
default=65535
minimum=10
maximum=65535
units=seconds
Displayed(tab/group)=Invalid Register (/Notifications Period)

pimKeepalivePeriod

type=int
default=210
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Keepalive / Source LifeTime (/Timer)

pimNeighborLossPeriod

type=int
default=0
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Neighbor Loss (/Notifications Period)

pimRPMappingPeriod

type=int
default=65535
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=RP Mapping (/Notifications Period)

pimSmMaxRPs

type=int
default=32
minimum=1
maximum=100
Displayed(tab/group)=Max RPs (/Sparse Mode)

pimSmProbeTime

type=int
default=5
minimum=1
maximum=300
units=seconds
Displayed(tab/group)=Probe Time (/Sparse Mode)

pimSmRPThreshold

type=int
default=1
minimum=0
maximum=2147483647
units=bps
Displayed(tab/group)=RP Threshold (/Sparse Mode)

pimSmRegisterChecksum

type=pim.CheckSumType
default=header
minimum=1
maximum=300
Displayed(tab/group)=Register Checksum (/Sparse Mode)

pimSmRegisterSuppressTime

type=int
default=60
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Register Suppress Timeout (/Sparse Mode)

pimSmSPTStatus

type=generic.TruthValue
default=false
Displayed(tab/group)=SPT Status (/Sparse Mode)

pimSparseAdminState

type=pim.PIMAdminState
default=disable
Displayed(tab/group)=Sparse Admin State (/Sparse Mode)

pimStateRefreshInterval

type=int
default=60
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=State Refresh Interval (/Dense Mode)

registerMessageSourceAddress This value indicates the source IP address of a static value for register messages

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Register Message IPv4 (RP Behavior.IPv4/Source Address)

registerMessageSourceAddressType The value of registerMessageSourceAddressType indicates the type of static address for IPv4 register messages

type=rtr.InetAddressType
default=ipv4

rpCandidateAdminState

type=netw.AdministrativeState
default=pimDown
Displayed(tab/group)=Administrative State (RP Behavior.IPv4/Candidate Rendezvous Point)

rpCandidateOperState

type=netw.OperationalState
access=read-only
default=pimUp
Displayed(tab/group)=Operational State (RP Behavior.IPv4/Candidate Rendezvous Point)

rpfLookupSequence

type=pim.RpfLookUpSeqType
default=ucastRouteTable
Displayed(tab/group)=IPv4 RPF Lookup Sequence (RP Behavior.IPv4/PIM General Configurations)

rpfVectorFlags Specifies whether proxy RPF vectors are used for inter-AS rosen MVPN. RPF vectors can be used to propagate SG joins in inter-AS rosen MVPN options B and C.

mvpn - enables mvpn RPF vector processing for Inter-AS Option B/C MVPN based on RFC 5496 and RFC6513. If a core RPF vector is received, it will be dropped before a message is processed.
core - enables core RPF vector (no RD) processing for Inter-AS Option B/C MVPN, which allows SROS interoperability as P-router with third-party vendors that do not encode RD in the RPF vector for Inter-AS MVPN.
core mvpn - enables RPF Vector processing for both MVPN and core RPF vectors, which allows interoperability with RFC-compliant MVPN solutions and core RPF vector based solutions. If PIM join message is to be propagated, the RPF vector will be encoded as required by MVPN RFCs.

type=pim.RpfVectorFlags
Displayed(tab/group)=RPF Vectors (/PIM General Configurations)

selectiveGroupAddMode Specifies which PIM mode to use, ASM or SSM, for PIM based selective provider tunnels.

type=pim.GroupAddMode
default=none
Displayed(tab/group)=PIM Group Address Mode (MVPN Selective Tunnel.PIM)

ssmAsrtCompMode Specifies whether SSM assert is enabled in compatibility mode for this PIM protocol instance.

type=boolean
default=false
Displayed(tab/group)=SSM Assert Compatible Mode (/PIM General Configurations)

ssmDefaultRange

type=boolean
default=false
Displayed(tab/group)=IPv4 SSM Default Range Disabled (RP Behavior.IPv4/PIM General Configurations)

ssmScaling Specifies whether PIM SSM Scaling should be applied or not.

type=boolean
default=false
Displayed(tab/group)=SSM Scaling (/PIM General Configurations)

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

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

type5AdvWithdraw Specifies whether to withdraw Type 5 routes or not. If the value is set to 'true' then the expiry of KAT timer triggers withdrawal of Type 5 routes. The withdrawal happens regardless of the value of persistentType5Adv

type=generic.TruthValue
default=false
Displayed(tab/group)=Kat Type 5 Advertisement Withdraw (MVPN.General)

umhRateMonitoringRevertiveTimer The value of umhRateMonitoringRevertiveTimer indicates the revertive timer in seconds. once rate is recovered, this timer indicates after this amount of time the traffic is switched back to primary PMSI

type=int
default=0
minimum=0
maximum=3600
units=seconds
Displayed(tab/group)=Revertive Timer (MVPN Inclusive Tunnel.General/UMH Rate Monitoring)

umhRateMonitoringTrafficRateDelta The value of umhRateMonitoringTrafficRateDelta indicates the traffic rate 'delta' in kilobits per second(kbps). This value determines the rate difference threshold between two PMSIs. When the delta drops below the configured value, the traffic is switched.

type=long
default=0
minimum=0
maximum=4294967294
units=kbps
Displayed(tab/group)=Traffic Rate Delta (MVPN Inclusive Tunnel.General/UMH Rate Monitoring)

umhSelection The value of vRtrPimNgAFGenMvpnUMHSelection specifies the selection mechanism to use for selecting Upstream Multicast Hop(UMH). When the value of vRtrPimNgAFGenMvpnUMHSelection is set to 'highestip', the highest IP Address is selected as UMH. When the value is set to 'hashbased', UMH selection is based on the hash based procedures. When the value is set to 'tunnelstatus', UMH selection is based on the state of the tunnel as well as the available unicast routes through the tunnel.

type=pim.UmSelectionType
default=highestip
Displayed(tab/group)=US Multicast Hop Selection (MVPN.General)

 
Overridden Properties
administrativeState

default=pimUp

displayedName

default=PIM

operationalState

default=pimUp

 
Properties inherited from rtr.ProtocolSite
creationOrigin, serviceId, serviceType, subscriberId
 
Properties inherited from rtr.RouterSite
routerId, routerName, routingInstancePointer
 
Properties inherited from netw.NetworkSite
displayedName, siteId, siteName
 
Properties inherited from netw.SubnetworkConnection
domain
 
Properties inherited from netw.Connection
administrativeState, application, connectionId, operationalState
 
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:
pim.Site.configureException
Methods inherited from rtr.ProtocolSite
shutDown, turnUp
 
Supported Network Elements
7750 SR Supported until 16.0.R4
  • Excluded chassis types: VSR, VSR-I
Supported from 16.0.R4
7705 SAR Gen 2
7450 ESS Supported from 8.0.R1 until 10.0.R1
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
  • Required Capabilities: MixedMode
Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
OS6850/6850E
OS6855
OS9700E/9800E
Generic NE
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6360
OS6465
7950 XRS
7705 SAR Supported from 6.0.R1
7705 SAR H Supported from 6.1.R1
7210 SAS M Supported from 7.0.R1
  • Required Capabilities: NetworkMode
7210 SAS R Supported from 7.0.R1
7210 SAS T Supported from 8.0.R1
  • Required Capabilities: NetworkMode
7210 SAS Mxp
7210 SAS S/Sx Supported from 9.0.R1
7210 SAS X Supported from 7.0.R1
7250 IXR
7210 SAS K Supported from 10.0.R5
  • Required Capabilities: NetworkMode
Product Specifics
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 (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
OS6360 (all versions)
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6465 (all versions)
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 (all versions)
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 (all versions)
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E (all versions)
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 (all versions)
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N (all versions)
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 (all versions)
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 (all versions)
OS6870 8.10
OS6900 (all versions)
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 (all versions)
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6