| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
Specifies whether the prefix should be monitored or not.
type=topology.State default=down Displayed(tab/group)=Monitor State |
| alarmSuppress |
Specifies whether an alarm is raised for the monitored prefix.
When the Suppress Alarms parameter is enabled for an alarm type, the alarm is not raised even if a threshold crossing alarm is configured.
type=topology.BgpMonPrefAlarmMask default=3 Displayed(tab/group)=Suppress Alarms (/Alarms) |
| alarmThreOverride |
Specifies whether a threshold value other than the global threshold value can be set for the monitored prefix.
When an option is enabled, you can set a user-defined threshold for that alarm type.
type=topology.BgpMonPrefAlarmMask default=unspecified Displayed(tab/group)=Override Alarm Thresholds (/Alarms) |
| asPathLenThreshold |
Specifies a threshold value other than the global threshold crossing alarm value that is set for the monitored prefix.
This parameter takes effect only when the Override Alarm Thresholds parameter (alarmThreOverride) is enabled.
type=long default=0 minimum=0 maximum=4294967296 units=AS Displayed(tab/group)=AS Path Length Threshold (/Alarms) |
| bgpASPointer |
Pointer to the bgp AS
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=BGP AS |
| description |
The description (user configurable).
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description |
| displayedName |
The displayed name.
type=string access=read-create default= minimum=0 maximum=32 Mandatory on create Displayed(tab/group)=Name |
| prefAddr |
Prefix Address.
type=InetAddress access=read-create Mandatory on create Displayed(tab/group)=IP Address |
| prefAddrType |
type=rtr.InetAddressType access=read-create default=ipv4 valid enums=ipv4, ipv6 (Where parent is one of (topology.BgpAutonomousSystem)) |
| prefLen |
Prefix Length
type=int access=read-create minimum=1 maximum=128 Mandatory on create Displayed(tab/group)=Prefix Length |
| prefRd |
Specifies the route distinguisher of the prefix.
type=string access=read-create default= minimum=0 maximum=32 Mandatory on create Displayed(tab/group)=Route Distinguisher (/VPN IPv4/IPv6) |
| prefType |
Specifies the type of BGP prefix to monitor.
type=topology.BGPAddressType access=read-create Mandatory on create Displayed(tab/group)=Address Type |
| rdType |
Specifies the type of route distinguisher attached to routes.
This parameter works in conjunction with the Route Distinguisher (prefRd) parameter.
type=l3fwd.RouteDistinguisherTypes access=read-create default=none Displayed(tab/group)=Route Distinguisher Type (/VPN IPv4/IPv6) |
| redLossThreshold |
Specifies a threshold value other than the global threshold crossing alarm value that is set for the monitored prefix.
This parameter takes effect only when the Override Alarm Thresholds parameter (alarmThreOverride) is enabled.
type=long default=0 minimum=0 maximum=7 units=Next Hops Displayed(tab/group)=Redundancy Loss Threshold (/Alarms) |
| topology.BgpMonPrefixStatus-Set |
type=Children-Set |
| Properties inherited from topology.BgpASContainedObject |
|---|
| asNumber, subAsNumber |
| 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.
prefMonToDeleteList
: List (string) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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