Class hcbgp:PfxLeakP (CONCRETE)

Class ID:14836
Class Label: Prefix Route Leak Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Enabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-connectivity, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

This objects holds route leak policy for a given network

Naming Rules
RN FORMAT: pfxleak-{[pfx]}

    [1] PREFIX=pfxleak- PROPERTY = pfx




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/bgp/inst/dom-{name}/af-{type}/pfxleak-{[pfx]}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/bgp/inst/dom-{name}/af-{type}/pfxleak-{[pfx]}

                


Diagram

Super Mo: rtleak:PfxLeakP,
Container Mos: hcbgp:DomAf (deletable:yes),


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hcbgp:Entity  Holds bgp control plane entity information
 
 
 
 
 
 
 
 ├
[V] hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:DomAf  This object holds per address family bgp vrf information
 
 
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:PfxLeakP  This objects holds route leak policy for a given network
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcbgp:Entity  Holds bgp control plane entity information
 
 
 
 
 
 ├
[V] hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp
 
 
 
 
 
 
 ├
[V] hcbgp:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] hcbgp:DomAf  This object holds per address family bgp vrf information
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:PfxLeakP  This objects holds route leak policy for a given network


Contained Hierarchy
[V] hcbgp:PfxLeakP  This objects holds route leak policy for a given network
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] rtleak:LeakP A container for the leak policy. Leak policies are categorized into intra protocol, inter protocol, and default route leak policies. These policies describe the routes to be injected into a given destination protocol domain. The destination domain where the routes are injected contains this leak policy.
 
 
 
 ├
[V] rtleak:PfxLeakP  This objects holds prefix leak policy
 
 
 
 
 ├
[V] hcbgp:PfxLeakP  This objects holds route leak policy for a given network


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcbgp:PfxLeakP
address:Ip pfx  (hcbgp:PfxLeakP:pfx)
           Overrides:rtleak:PfxLeakP:pfx
           The OSPF route prefix.
Defined in: rtleak:PfxLeakP
rtleak:PfxControl
          scalar:Bitmask8
ctrl  (rtleak:PfxLeakP:ctrl)
           The control state.
rtleak:Scope
          scalar:Enum8
scope  (rtleak:PfxLeakP:scope)
           Overrides:rtleak:LeakP:scope
           The domain applicable to the capability.
Defined in: rtleak:LeakP
string:Basic rtMap  (rtleak:LeakP:rtMap)
           The name of the default route leak policy route map. This route map name is used to control distribution.
Defined in: pol:Instr
naming:Descr
          string:Basic
descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

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: rtleak:PfxControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
skip-rib-check 1 Skip RIB route check Skip RIB route check
DEFAULT 0 --- Prefix Control





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.



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.



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never 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



pfx

Type: address:Ip

Overrides:rtleak:PfxLeakP:pfx
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The OSPF route prefix.



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.



rtMap

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the default route leak policy route map. This route map name is used to control distribution.



scope

Type: rtleak:Scope
Primitive Type: scalar:Enum8

Overrides:rtleak:LeakP:scope
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The domain applicable to the capability.
Constants
intra 1 Intra protocol leak Intra protcol
inter 2 Inter protocol leak Inter protcol
defrt 3 Default route leak Default route
pfx 4 Prefix leak Prefix
DEFAULT pfx(4) Prefix leak Prefix





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.