| Properties Summary |
| Defined in: bgp:APeerDef |
bgp:MaxPfxAct
scalar:Enum8
|
action (bgp:APeerDef:action)
The action required when the condition is met.
|
bgp:MaxPfx
scalar:Uint32
|
maxPfx (bgp:APeerDef:maxPfx)
The maximum number of prefixes allowed from the peer.
|
bgp:MaxPfxDuration
scalar:Uint16
|
restartTime (bgp:APeerDef:restartTime)
The period of time (minutes) before restarting the peer when the prefix limit is reached.
|
bgp:MaxPfxThresh
scalar:UByte
|
thresh (bgp:APeerDef:thresh)
The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
|
action
Type: bgp:MaxPfxAct
Primitive Type: scalar:Enum8
Like: bgp:MaxPfxP:action
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The action required when the condition is met.
| |
| Constants |
| reject |
0 |
Reject |
Reject prefixes beyond the configured limit
|
| log |
1 |
Log |
Log a warning
|
| shut |
2 |
Shutdown |
Shut the peer
|
| restart |
3 |
Restart |
Restart the peer
|
| DEFAULT |
reject(0) |
Reject |
Reject prefixes beyond the configured limit
|
|
addr
Type: address:Ip
Like: bgp:Peer:addr
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Comments:
-
The IP address of the BGP peer.
allowedSelfAsCnt
Type: bgp:AllowedSelfAsCnt
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The number of occurrences of a local Autonomous System Number (ASN).
| |
| Constants |
| defaultValue |
3 |
--- |
NO COMMENTS
|
|
childAction
Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Comments:
-
Delete or ignore. For internal use only.
| |
| Constants |
| deleteAll |
16384u |
deleteAll |
NO COMMENTS
|
| ignore |
4096u |
ignore |
NO COMMENTS
|
| deleteNonPresent |
8192u |
deleteNonPresent |
NO COMMENTS
|
| DEFAULT |
0 |
--- |
This type is used to
|
|
ctrl
Type: bgp:PeerControlPol
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The peer controls specify which Border Gateway Protocol (BGP) attributes are sent to a peer.
| |
| Constants |
| send-com |
1 |
Send Community |
Send community
|
| send-ext-com |
2 |
Send Extended Community |
Send extended community
|
| nh-self |
8 |
Next-hop Self |
Nexthop self
|
| dis-peer-as-check |
16 |
Disable Peer AS Check |
Disable checking of peer AS number while advertising
|
| allow-self-as |
32 |
Allow Self AS |
Allows local AS number in the AS path
|
| defaultValue |
0 |
--- |
NO COMMENTS
|
|
descr
Type: naming:Descr
Primitive Type: string:Basic
Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
Specifies the description of a policy component.
dn
Type: reference:BinRef
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Comments:
-
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
maxPfx
Type: bgp:MaxPfx
Primitive Type: scalar:Uint32
Like: bgp:MaxPfxP:maxPfx
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The maximum number of prefixes allowed from the peer.
| |
| Constants |
| defaultValue |
20000u |
--- |
NO COMMENTS
|
|
name
Type: naming:Name
Primitive Type: string:Basic
Overrides:naming:NamedObject:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
null
nameAlias
Type: naming:NameAlias
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
NO COMMENTS
password
Type: string:Password
Like: bgp:Peer:password
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Comments:
-
Administrative state
peerCtrl
Type: bgp:PeerPControlType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The peer controls.
| |
| Constants |
| bfd |
1 |
Bidirectional Forwarding Detection |
Bidirectional Forwarding Detection
|
| dis-conn-check |
2 |
Disable Connected Check |
Disable checking whether single-hop
eBGP peer is directly connected
|
| defaultValue |
0 |
--- |
NO COMMENTS
|
|
privateASctrl
Type: bgp:PrivateASControl
Primitive Type: scalar:Bitmask8
Like: bgp:Peer:privateASctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
Remove private AS
| |
| Constants |
| remove-exclusive |
1 |
Remove private AS |
Enable removal of private AS exclusively if no public AS exist
|
| remove-all |
2 |
Remove all private AS |
Remove private AS even if public AS's exist
|
| replace-as |
4 |
Replace private AS with local AS |
Replace private AS with local AS
|
| defaultValue |
0 |
--- |
Default is disabled
|
|
restartTime
Type: bgp:MaxPfxDuration
Primitive Type: scalar:Uint16
Like: bgp:MaxPfxP:restartTime
Units: min
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The period of time (minutes) before restarting the peer when the prefix limit is reached.
| |
| Constants |
| infinite |
0xffff |
Infinite |
NO COMMENTS
|
| DEFAULT |
infinite(0xffff) |
Infinite |
NO COMMENTS
|
|
rn
Type: reference:BinRN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Comments:
-
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
sessionT
Type: bgp:SessionT
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
Peer Session Type
| |
| Constants |
| peer |
1 |
Peer |
Instantiate a normal session with the peer
|
| client |
2 |
Client |
Instantiate a client session with the peer
|
| DEFAULT |
peer(1) |
Peer |
Instantiate a normal session with the peer
|
|
status
Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Comments:
-
The upgrade status. This property is for internal use only.
| |
| Constants |
| created |
2u |
created |
In a setter method: specifies that an object should be created.
An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
|
| modified |
4u |
modified |
In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
|
| deleted |
8u |
deleted |
In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
|
| DEFAULT |
0 |
--- |
This type controls the life cycle of objects passed in the XML API.
When used in a setter method (such as configConfMo), the ModificationStatus
specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual
operation that was performed. For example, the ModificationStatus is set to "created"
if the object was created. The ModificationStatus is not set if the object was neither
created, modified, deleted or removed.
When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus
is not set, the system automatically determines if the object should be created or modified.
|
|
thresh
Type: bgp:MaxPfxThresh
Primitive Type: scalar:UByte
Like: bgp:MaxPfxP:thresh
Units: percentage
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
| |
| Constants |
| defaultValue |
75 |
--- |
NO COMMENTS
|
|
ttl
Type: bgp:TtlVal
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
Specifies time to live (TTL).
| |
| Constants |
| defaultValue |
1 |
--- |
NO COMMENTS
|
|
weight
Type: rtmap:Weight
Primitive Type: scalar:Uint16
Like: bgp:PeerAf:weight
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Comments:
-
The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.
![[V]](styles/eye.gif)