| Properties Summary |
addr
Type: address:Ip
Like: hcbgp:Peer:addr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The peer IP address.
af
Type: hcbgp:AfT
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| ipv4-ucast |
1 |
IPv4 unicast address family |
ipv4 unicast
|
| vpnv4-ucast |
2 |
Vpnv4 unicast address family |
vpnv4 unicast
|
| ipv6-ucast |
3 |
IPv6 unicast address family |
ipv6 unicast
|
| vpnv6-ucast |
4 |
Vpnv6 unicast address family |
vpnv6 unicast
|
| l2vpn-evpn |
5 |
L2Vpn EVpn address family |
l2vpn evpn
|
| rtfilter-ucast |
6 |
Route target filter address family |
rtfilter unicast
|
| DEFAULT |
ipv4-ucast(1) |
IPv4 unicast address family |
ipv4 unicast
|
|
asn
Type: rtcom:AS
Primitive Type: scalar:Uint32
Like: hcbgp:Peer:asn
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: (long)1l max: (long)0xffffffffl
Comments:
-
A number that uniquely identifies an autonomous system.
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: hcbgp:PeerAfControl
Primitive Type: scalar:Bitmask32
Like: hcbgp:PeerAf:ctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The control state.
| |
| Constants |
| activate |
128u |
Activate |
Activate
|
| dis-peer-as-check |
16u |
Disable Peer AS Check |
Disable checking of peer AS number while advertising
|
| send-com |
1u |
Send Community |
Send community
|
| soft-reconfig-inbound |
256u |
Soft Reconfig Inbound |
Soft Reconfig Inbound
|
| send-ext-com |
2u |
Send Extended Community |
Send extended community
|
| allow-self-as |
32u |
Allow Self AS |
Allows local AS number in the AS path
|
| rr-client |
4u |
Route Reflector Client |
Router reflector client
|
| nh-unchanged |
512u |
Next Hop Unchanged |
Next Hop Unchanged
|
| as-override |
64u |
As Override |
Overrides AS number of originating router to that of
sending BGP router
|
| nh-self |
8u |
Next-hop Self |
Nexthop self
|
| DEFAULT |
0 |
--- |
Peer Address Family Control
|
|
descr
Type: naming:Descr
Primitive Type: string:Basic
Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "128"
Allowed Chars:
Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
Comments:
-
Specifies a description of the policy definition.
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.
name
Type: naming:Name
Primitive Type: string:Basic
Overrides:naming:NamedObject:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "64"
Allowed Chars:
Regex: [a-zA-Z0-9_.:-]+
Comments:
-
null
nameAlias
Type: naming:NameAlias
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "63"
Allowed Chars:
Regex: [a-zA-Z0-9_.-]+
Comments:
-
NO COMMENTS
ownerKey
Type: naming:Descr
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "128"
Allowed Chars:
Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
Comments:
-
The key for enabling clients to own their data for entity correlation.
ownerTag
Type: naming:Descr
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "64"
Allowed Chars:
Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
Comments:
-
A tag for enabling clients to add their own data. For example, to indicate who created this object.
password
Type: string:Password
Like: hcbgp:Peer:password
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The administrative password.
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.
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.
|
|
ttl
Type: hcbgp:TtlVal
Primitive Type: scalar:Uint16
Like: hcbgp:Peer:ttl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: 1 max: 255
Comments:
-
Specifies time to live (TTL).
| |
| Constants |
| defaultValue |
1 |
--- |
NO COMMENTS
|
|
![[V]](styles/eye.gif)