| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| addressFamily |
What type of family address is supported(7XXX is support both).
type=l3fwd.AddressFamily default=ipv4 Displayed(tab/group)=Address Family applicable=false (Where parent is one of (vprn.DVRSSite)) |
| allowExportBgpInactive |
Specifies whether or not inactive VPRN-BGP routes are exported to the MP-BGP domain. If the
value of allowExportBgpInactive is 'true', inactive VPRN-BGP routes will be exported to the
MP-BGP domain. If the value is 'false', inavtive VPRN-BGP routes are not exported to
the MP-BGP domain.
type=boolean default=false Displayed(tab/group)=Allow BGP Export Inactive |
| allowExportBgpInactiveEnhanced |
Specifies whether or not inactive BGP routes in the VPRN BGP instance are
exported to the MP-BGP domain when the best route is any other route.
If the value is 'true', inactive BGP routes will be exported to the MP-BGP domain,
this overrides any setting of Allow Export BGP Inactive.
If the value is 'false', inactive BGP routes are not exported to the MP-BGP domain.
type=boolean default=false Displayed(tab/group)=Allow BGP Export Inactive Enhanced |
| allowExportBgpVpn |
Specifies that the vrf-export and vrf-target exporting functions will consider BGP-VPN routes
installed in the route table of the vprn. If the value is 'true', BGP-VPN routes will be
exported. If the value is 'false', BGP-VPN routes will not be exported. This is supported in
7750, 7450 MM, 7950 and 7710.
type=boolean default=false Displayed(tab/group)=Allow Export BGP VPN |
| allowLocalManage |
Specifies whether to enable or disable traffic from GRT-leaking enabled VPRN instances
to reach local interfaces in the base routing instance.
type=boolean default=false Displayed(tab/group)=Allow Local Management (/GRT Lookup) |
| allowSnmpAccess |
The value specifies whether SNMP requests are allowed on this VPRN.
type=boolean default=false Displayed(tab/group)=Allow SNMP Access |
| attributeSetExport |
Specifies whether or not inactive BGP routes in the VPRN BGP instance are
exported to the MP-BGP domain when the best route is any other route.
If the value is 'true', inactive BGP routes will be exported to the MP-BGP domain,
this overrides any setting of Allow Export BGP Inactive.
If the value is 'false', inactive BGP routes are not exported to the MP-BGP domain.
type=boolean default=false Displayed(tab/group)=Export (/Attribute Set) |
| attributeSetImport |
Specifies whether or not inactive BGP routes in the VPRN BGP instance are
exported to the MP-BGP domain when the best route is any other route.
If the value is 'true', inactive BGP routes will be exported to the MP-BGP domain,
this overrides any setting of Allow Export BGP Inactive.
If the value is 'false', inactive BGP routes are not exported to the MP-BGP domain.
Specifies the action taken in attribute-set import:
-ignore (1): instructs BGP to ignore ATTR_SET in VPN-IP routes when
importing them into this specific VPRN; the ATTR_SET attribute
is transmitted unchanged to the CE (default for backwards compatibility).
-accept (2): instructs BGP to process ATTR_SET in VPN-IP routes when importing them
into this specific VPRN; as part of the normal processing, the ATTR_SET
attribute is removed before the route is advertised to CEs.
-drop (3): instructs BGP to ignore ATTR_SET in VPN-IP routes when importing them
into this specific VPRN; the ATTR_SET attribute is removed before
the route is advertised to CEs"
type=int default=ignore Displayed(tab/group)=Import (/Attribute Set) enums= 1: ignore - Ignore 2: accept - Accept 3: drop - Drop |
| autoRD |
Specifies that the SR system will automatically select a value for the route-distinguisher
type=generic.TruthValue default=false Displayed(tab/group)=Auto Route Distinguisher (/Route Distinguisher) |
| bgpCirRate |
type=long default=4000 minimum=-1 maximum=100000000 Displayed(tab/group)=CIR Rate (/BGP Shared Queue) |
| bgpPirRate |
type=long default=4000 minimum=-1 maximum=100000000 Displayed(tab/group)=PIR Rate (/BGP Shared Queue) |
| bgpSharedQueue |
The value of bgpSharedQueue specifies whether BGP shared queue is
supported on this VPRN service.
type=boolean default=false Displayed(tab/group)=BGP Shared Queue Enabled (/BGP Shared Queue) |
| carrierCarrierVpn |
The value of carrierCarrienVpn specifies whether Carrier Supporting Carrier model is
supported on this VPRN service.
type=boolean default=false Displayed(tab/group)=Carrier Carrier VPN |
| confederationAutonomousSystemNumber |
This specifies the confederation AS number for the virtual router.
A non-0 value is to be configured first before any member can be added to this confederation AS.
A value of 0 means no confederation AS, thus deletion of all its contained members.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Confederation Autonomous System |
| creationOrigin |
type=svt.L2RouteOriginType access=read-create default=manual |
| customProperties |
This is used for some GNE nodes needs more data which specific to this GNE .
type=Map (string to string) applicable=false (Where parent is one of (vprn.DVRSSite)) |
| dPathLengthIgnore |
Specifies if VPRN RTM ignores the D-PATH domain segment length for best path selection.
type=boolean default=false Displayed(tab/group)=Length Ignore (/D-Path) |
| enableEcmpUnequalCost |
specifies the selection of multipaths ignores differences in next-hop cost compared to the best path.
type=boolean default=false Displayed(tab/group)=Enable ECMP Unequal Cost applicable=false (Where parent is one of (vprn.DVRSSite)) |
| enableGrtLookup |
Specifies if a route lookup is done in the
Global Route Table (GRT) when the lookup in the local VRF fails. When
the value of this object is set to 'false', route lookup in the GRT is
disabled.
type=boolean default=false Displayed(tab/group)=Enable GRT Lookup (/GRT Lookup) |
| enableL2Access |
The value of enableL2Access specifies whether L2 access
is enabled for MG TWAG on this VPRN service.
type=boolean default=false Displayed(tab/group)=Enable L2-Access |
| enforceMaxNumberOfIPv6Routes |
If 'true' the maximum number of routes are validated by NFM-P
(whether maxIPv6RouteNumber is within the allowed range).
The value is automatically set to 'true' when maxIPv6RouteNumber = -1,
or 'false' otherwise.
type=boolean default=false Displayed(tab/group)=Enforce Maximum Number Of IPv6 Routes (/Maximum Number of IPv6 Routes) |
| enforceMaxNumberOfRoutes |
If 'true' the maximum number of routes are validated by NFM-P
(whether maxNumberOfRoutes is within the allowed range).
The value is automatically set to 'true' when maxNumberOfRoutes = -1,
or 'false' otherwise.
type=boolean default=false Displayed(tab/group)=Enforce Maximum Number Of Routes (/Maximum Number of Routes) |
| entropyLabel |
The value of entropyLabel specifies whether the use of entropy-label is enabled or not for the router instance.
type=boolean default=false Displayed(tab/group)=Enable Entropy Label applicable=false (Where parent is one of (vprn.DVRSSite)) |
| ignoreNextHopMetric |
type=boolean default=false Displayed(tab/group)=Ignore NH Metric |
| ipPoolDistribution |
The value of the object ipPoolDistribution specifies whether the
UE IP allocation is distributed across configured IP pools when more
than one IP pool is configured.
type=boolean default=false Displayed(tab/group)=IP Pool Distribution |
| ipVpnMplsAdminState |
The value of ipvpnMplsAdminState specifies the adminstrative
state of BGP IP VPN MPLS for the service..
Turned Down when l3fwd.ServiceSite.autoRD is set to 'false' and l3fwd.ServiceSite.routeDistinguisher is reset.
type=int default=2 Displayed(tab/group)=BGP-IPVPN MPLS Administrative State enums= 1: up - Up 2: down - Down |
| ipVpnMplsDomainId |
Specifies the Domain ID used in D-Path for routes advertisement for BGP IVPN MPLS service.
type=string default=0:0 Displayed(tab/group)=IP-VPN MPLS Domain ID (/D-Path) |
| ipVpnMplsDomainIdHexValue |
Specifies the HEX format of l3fwd.ServiceSite.ipVpnMplsDomainId
type=string access=read-only default=00 00 00 00 00 00 |
| ipVpnMplsDynamicEgressLabelLimit |
This value determines whether, when BGP resolves routes, it accounts for the presence of control-word,
ethernet-segment label etc or not.
type=boolean default=false Displayed(tab/group)=BGP-IPVPN MPLS Dynamic Egress Label Limit |
| ipv6MaxNumRoutesLogOnly |
The value of vRtrIPv6MaxNumRoutesLogOnly specifies the action to
be taken when the maximum number of IPv6 routes that can be held
within a given VRF context is reached. If the value is 'true'
the event is logged (a trap is sent) and the learning of
new routes is not disabled. If the value is 'false' the event
is logged and the learning of new routes is disabled.
type=generic.TruthValue default=false Displayed(tab/group)=Log Only (/Maximum Number of IPv6 Routes) |
| ipv6MaxNumRoutesThresHold |
specifies the mid-level water marker for the number of IPv6 routes which this VRF may hold.
When this limit is exceeded a tmnxVRtrIPv6MidRouteTCA notification is generated.
A value of 0 (zero) for this object indicates that the threshold
is infinite, and the notification will never be sent.
type=long default=0 minimum=0 maximum=100 units=% Displayed(tab/group)=Threshold (/Maximum Number of IPv6 Routes) |
| labelMode |
The value of labelMode specifies the mode of allocation of service labels to the routes exported
by the VPRN as BGP-VPN routes. If the value of labelMode is set to 'nexthop(2)', the service
labels are allocated per next-hop. By default the value of labelMode is set to 'vrf(1)' which
means the service labels are allocated per VRF (Virtual Routing and Forwarding).
type=l3fwd.VprnLabelMode default=vrf Displayed(tab/group)=Label Mode |
| localEcmpEgress |
The value of localEcmpEgress specifies whether option to
program only the local ecmp route in fib is configured.
type=l3fwd.LocalEcmpEgressStatus default=disabled Displayed(tab/group)=Local Ecmp Egress |
| localRoutesDomainId |
Specifies the Domain ID used in D-Path for local-routes advertisement.
type=string default=0:0 Displayed(tab/group)=Local Routes Domain ID (/D-Path) |
| localRoutesDomainIdHexValue |
Specifies the HEX format of l3fwd.ServiceSite.localRoutesDomainId
type=string access=read-only default=00 00 00 00 00 00 |
| localTTLPropagate |
Specifies whether or not to enable the propagation of time to live (TTL) at
Ingress LER from the header of IP packet into all labels in the stack for all local packets.
When the value is set to 'inherit', the VPRN instance inherits the base router instance
configuration.
type=l3fwd.VPRNTTLPropagateType default=inherit Displayed(tab/group)=Local TTL Propagate (/TTL Propagate) |
| maxIPv6RouteNumber |
The maximum number of IPv6 routes that can be configured on this virtual router.
If the value is -1, then there is no limit.
type=long default=-1 minimum=-1 maximum=2147483647 Displayed(tab/group)=Maximum Number Of IPv6 Routes (/Maximum Number of IPv6 Routes) |
| maxNumberOfRoutes |
The maximum number of routes that can be configured on this virtual router.
If the value is -1, then there is no limit
(and enforceMaxNumberOfRoutes is automatically set to 'true').
type=long default=-1 minimum=1 maximum=2147483647 Displayed(tab/group)=Maximum Number Of Routes (/Maximum Number of Routes) |
| maxNumberOfRoutesLogOnly |
type=generic.TruthValue default=false Displayed(tab/group)=Log Only (/Maximum Number of Routes) |
| mgGroupId |
The value of mgGroupId uniquely identifies a mobile system
group.
type=int default=0 minimum=0 maximum=15 Displayed(tab/group)=Group ID |
| mgParentRouterPointer |
The value of mgParentRouterPointer specifies the parent router instance.
type=Pointer default= Displayed(tab/group)=Parent Virtual Router |
| midRouteThreshold |
type=int default=0 minimum=0 maximum=100 units=% Displayed(tab/group)=Threshold (/Maximum Number of Routes) |
| operationalRD |
Indicates the route distinguisher value in use by the system for this service.
type=string access=read-only default= Displayed(tab/group)=Operational Route Distinguisher (/Route Distinguisher) |
| rdGeneration |
The value specifies the way of the Route Distinguisher is generated.
type=service.RdRtGeneration access=read-only default=manual |
| routeDistinguisher |
type=string access=read-only default=00 00 00 00 00 00 00 00 |
| routeDistinguisherType |
type=l3fwd.RouteDistinguisherTypes default=none Displayed(tab/group)=Route Distinguisher Type (/Route Distinguisher) |
| rtExportGeneration |
The value specifies the way of the export Route Target is generated.
type=service.RdRtGeneration access=read-only default=manual |
| rtImportGeneration |
The value specifies the way of the import Route Target is generated.
type=service.RdRtGeneration access=read-only default=manual |
| serviceId |
type=long access=read-only default=0 Displayed(tab/group)=Service ID (/Service) |
| serviceName |
type=string access=read-only default= Displayed(tab/group)=Service Name (/Service) |
| subscriberId |
type=long access=read-only default=0 Displayed(tab/group)=Customer ID (/Customer) |
| subscriberName |
type=string access=read-only default= maximum=255 Displayed(tab/group)=Customer Name (/Customer) |
| transitTTLPropagate |
Specifies whether or not to enable the propagation of time to live (TTL) at Ingress LER from the
header of IP packet into all labels in the stack for all transit packets.
When the value is set to 'inherit', the VPRN instance inherits the base router instance
configuration.
type=l3fwd.VPRNTTLPropagateType default=inherit Displayed(tab/group)=Transit TTL Propagate (/TTL Propagate) |
| type0AdministrativeValue |
type=int default=1 minimum=1 maximum=65535 Displayed(tab/group)=Type 0 Administrative Value (/Route Distinguisher/Type 0) |
| type0AssignedValue |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Type 0 Assigned Value (/Route Distinguisher/Type 0) |
| type1AssignedValue |
type=int default=1 minimum=0 maximum=65535 Displayed(tab/group)=Type 1 Assigned Value (/Route Distinguisher/Type 1) |
| type1IpAddrType |
type=rtr.InetAddressType default=ipv4 |
| type1IpAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Type 1 IP Address (/Route Distinguisher/Type 1) |
| type2AdministrativeValue |
type=long default=65536 minimum=65536 maximum=4294967295 Displayed(tab/group)=Type 2 Administrative Value (/Route Distinguisher/Type 2) |
| type2AssignedValue |
type=int default=0 minimum=0 maximum=65535 Displayed(tab/group)=Type 2 Assigned Value (/Route Distinguisher/Type 2) |
| vpnBackupFamily |
Specifies the address families for which the computation and use of a
backup path is enabled for BGP-VPN routes imported into the VPRN.
type=l3fwd.VpnIpBackupFamilyMask default=0 Displayed(tab/group)=Enable Backup BGP-VPN Routes (/Backup BGP-VPN Routes) |
| vpnId |
try to use serviceId to this format:
Each VPN ID defined by RFC 2685. OUI:vpnIndex
The IEEE Registration Authority assigns OUIs
to any company, it has 3 octet hex number .
vpnIndex: 4 octet hex number
type=string default= minimum=0 maximum=15 Displayed(tab/group)=VPN-ID applicable=false (Where parent is one of (vprn.DVRSSite)) |
| vprnType |
type=l3fwd.VprnType default=regular Displayed(tab/group)=Type |
| vrfExportTarget |
type=string access=read-only default= |
| vrfExportTargetASValue |
type=int default=1 minimum=0 maximum=65535 Displayed(tab/group)=Export Target AS Value (VRF Target/AS-Based Export Target) |
| vrfExportTargetASValue4Byte |
type=long default=65536 minimum=65536 maximum=4294967295 Displayed(tab/group)=Export Target AS Value (4Byte) (VRF Target/AS-4Byte Export Target) |
| vrfExportTargetCommunityValue |
type=int default=0 minimum=0 maximum=65535 Displayed(tab/group)=Export Target Community Value (VRF Target/IP Address-Based Export Target), Export Target Community Value (VRF Target/AS-4Byte Export Target) |
| vrfExportTargetExtendedCommunityValue |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Export Target Extended Community Value (VRF Target/AS-Based Export Target) |
| vrfExportTargetFormat |
type=l3fwd.VrfTargetFormat default=none Displayed(tab/group)=Export Target Format (VRF Target/Export Target) |
| vrfExportTargetIpAddrType |
type=rtr.InetAddressType default=ipv4 |
| vrfExportTargetIpAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Export Target IP Address (VRF Target/IP Address-Based Export Target) |
| vrfImportTarget |
type=string access=read-only default= |
| vrfImportTargetASValue |
type=int default=1 minimum=0 maximum=65535 Displayed(tab/group)=Import Target AS Value (VRF Target/AS-Based Import Target) |
| vrfImportTargetASValue4Byte |
type=long default=65536 minimum=65536 maximum=4294967295 Displayed(tab/group)=Import Target AS Value (4Byte) (VRF Target/AS-4Byte Import Target) |
| vrfImportTargetCommunityValue |
type=int default=0 minimum=0 maximum=65535 Displayed(tab/group)=Import Target Community Value (VRF Target/IP Address-Based Import Target), Import Community Value (VRF Target/AS-4Byte Import Target) |
| vrfImportTargetExtendedCommunityValue |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Import Target Extended Community Value (VRF Target/AS-Based Import Target) |
| vrfImportTargetFormat |
type=l3fwd.VrfTargetFormat default=none Displayed(tab/group)=Import Target Format (VRF Target/Import Target) |
| vrfImportTargetIpAddrType |
type=rtr.InetAddressType default=ipv4 |
| vrfImportTargetIpAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Import Target IP Address (VRF Target/IP Address-Based Import Target) |
| vrfName |
type=string access=read-only default= maximum=32 Displayed(tab/group)=VRF Name applicable=false (Where parent is one of (vprn.DVRSSite)) |
| vrfTarget |
type=string access=read-only default= |
| vrfTargetASValue |
type=int default=1 minimum=0 maximum=65535 Displayed(tab/group)=Target AS Value (VRF Target/AS-Based Target) |
| vrfTargetASValue4Byte |
type=long default=65536 minimum=65536 maximum=4294967295 Displayed(tab/group)=Target AS Value (4Byte) (VRF Target/AS-4Byte Target) |
| vrfTargetCommunityValue |
type=int default=0 minimum=0 maximum=65535 Displayed(tab/group)=Target Community Value (VRF Target/IP Address-Based Target), Target Community Value (VRF Target/AS-4Byte Target) |
| vrfTargetExtendedCommunityValue |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Target Extended Community Value (VRF Target/AS-Based Target) |
| vrfTargetFormat |
type=l3fwd.VrfTargetFormat default=none Displayed(tab/group)=Target Format (VRF Target/Default Target) |
| vrfTargetIpAddrType |
type=rtr.InetAddressType default=ipv4 |
| vrfTargetIpAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Target IP Address (VRF Target/IP Address-Based Target) |
| vrfTargetType |
type=l3fwd.VrfTargetTypes default=none Displayed(tab/group)=VRF Target Type (VRF Target) |
| Overridden Properties | |
|---|---|
| ingrPathMgmtPolicyPointer |
Pointer to the instance of the multicast Ingress PathMgmt Info policy.
applicable=false (Where parent is one of (vprn.DVRSSite)) |
| reachableTime |
Specifies the time an IPv6 neighbor remains in reachable state. While in this state, no neighbor-unreachability detection has to be done.
applicable=false (Where parent is one of (vprn.DVRSSite)) |
| staleTime |
Specifies the time an IPv6 neighbor cache entry remains in stale state, for all applicable interfaces in this virtual router instance.
When this time has elapsed, the system removes the neighbor cache entry.
applicable=false (Where parent is one of (vprn.DVRSSite)) |
| Properties inherited from fwd.Site |
|---|
| siteId, siteName |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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.
neId
: string - The Network Element ID. This value must be a valid NE ID and cannot be null nor empty.
routeDistinguisherType
: l3fwd.RouteDistinguisherTypes - At this time only type0(0) is supported.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
routeDistinguisher
: string - Returns the generated Route Distinguisher.
The format of Route Distinguisher is: "value1:value2".
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.
neId
: string - The Network Element ID. This value must be a valid NE ID and cannot be null nor empty.
vrfTargetFormat
: l3fwd.VrfTargetFormat - The VRF Target Format, asBased (2) or ipAddressBased(3).
At this time only asBased(2) is supported.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
vrfTarget
: string - Returns the generated VRF Target.
The format of VRF Target is: "value1:value2".
servicePointer
: Pointer - The fully distinguished name of the VPRN service.
routeDistinguisherType
: l3fwd.RouteDistinguisherTypes - At this time only type0(0) is supported.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
vrfTargets
: Set (string) - Returns the set of Route Distinguishers used by this VPRN service.
The format of each Route Distinguisher entry is: "value1:value2".
servicePointer
: Pointer - The fully distinguished name of the VPRN service.
vrfTargetFormat
: l3fwd.VrfTargetFormat - The VRF Target Format, asBased (2) or ipAddressBased(3).
At this time only asBased(2) is supported.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
vrfTargets
: Set (string) - Returns the set of VRF Targets used by this VPRN service.
The format of each VRF Target entry is: "value1:value2".