Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class pim:Dom (CONCRETE)

Class ID:8404
Class Label: PIM Domain
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

PIM domain (VRF) information.

Naming Rules 
RN FORMAT: dom-{name}

    [1] PREFIX=dom- PROPERTY = name




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/pim/inst/dom-{name}

[1] sys/pim/inst/dom-{name}


Diagram

Super Mo: rtdmc:ADom,
Container Mos: pim:Inst (deletable:no),
Contained Mos: pim:ASMPatP, pim:AcastRPFuncP, pim:AutoRPP, pim:BSRP, pim:BidirPatP, pim:Db, pim:DomStats, pim:If, pim:InterVRFP, pim:ResP, pim:SSMPatP, pim:StaticRPP, pim:TrafficStats,


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] fabric:Topology The root for IFC topology.
 
 		 ├
 		[V] fabric:Pod A pod.
 
 		 
 		 ├
 		[V] fabric:Node The root node for the APIC.
 
 		 
 		 
 		 ├
 		[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 		 
 		 
 		 
 		 ├
 		[V] pim:Entity PIM control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pim:Inst PIM instance information.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pim:Dom PIM domain (VRF) information.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 		 ├
 		[V] pim:Entity PIM control plane entity information.
 
 		 
 		 ├
 		[V] pim:Inst PIM instance information.
 
 		 
 		 
 		 ├
 		[V] pim:Dom PIM domain (VRF) information.


Contained Hierarchy
[V] pim:Dom PIM domain (VRF) information.
 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
 		[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 		 ├
 		[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 		 ├
 		[V] tag:Annotation 
 
 		 ├
 		[V] tag:Tag 
 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] pim:ASMPatP The any-source multicast pattern policy.
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:RegTrP PIM register traffic policy
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:SGRangeExpP  This object holds (S,G) expiry timer policy for specified range
 
 		 ├
 		[V] pim:SharedRangeP Shared tree group range
 ├
 		[V] pim:AcastRPFuncP The Anycast RP function policy. Specifies the Anycast and local interface for the Anycast RP and all the peer's local info.
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:AcastRPPeer The Anycast RP peer info.
 ├
 		[V] pim:AutoRPP The Auto-RP policy.
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:MAFilterP Mapping agent (MA) filter policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:MAFuncP Auto-RP mapping agent (MA) function policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:RPFilterP The RP filter policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:RPFuncP RP function policy.
 
 		 
 		 ├
 		[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.
 
 		 
 		 ├
 		[V] pim:RPGrpRange The RP multicast group range.
 ├
 		[V] pim:BSRP The Bootstrap Router (BSR) policy.
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:BSRFilterP The PIM Bootstrap Router (BSR) filter policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:BSRFuncP The Bootstrap Router (BSR) function policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:RPFilterP The RP filter policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:RPFuncP RP function policy.
 
 		 
 		 ├
 		[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.
 
 		 
 		 ├
 		[V] pim:RPGrpRange The RP multicast group range.
 ├
 		[V] pim:BidirPatP The Bidirectional multicast (BiDir) pattern.
 
 		 ├
 		[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.
 ├
 		[V] pim:Db PIM databases.
 
 		 ├
 		[V] pim:AutoRPPInfo The Auto-RP policy information.
 
 		 ├
 		[V] pim:BSRInfo The Bootstrap Router (BSR) information.
 
 		 ├
 		[V] pim:RPGrange The RP group range.
 
 		 
 		 ├
 		[V] pim:RtRP2Grange 
 
 		 ├
 		[V] pim:RPInfo RP information
 
 		 
 		 ├
 		[V] pim:RsRP2Grange 
 
 		 ├
 		[V] pim:Route  PIM Group/Src MOs
 
 		 
 		 ├
 		[V] pim:Oif  PIM OIF list MOs
 ├
 		[V] pim:DomStats PIM domain statistics.
 ├
 		[V] pim:If PIM interface information.
 
 		 ├
 		[V] nw:RtPathToIf A target relation to the interface information.
 
 		 ├
 		[V] pim:AdjEp PIM neighbor information.
 
 		 
 		 ├
 		[V] pim:AdjStats PIM neighbor related statistics.
 
 		 ├
 		[V] pim:Db PIM databases.
 
 		 
 		 ├
 		[V] pim:AutoRPPInfo The Auto-RP policy information.
 
 		 
 		 ├
 		[V] pim:BSRInfo The Bootstrap Router (BSR) information.
 
 		 
 		 ├
 		[V] pim:RPGrange The RP group range.
 
 		 
 		 
 		 ├
 		[V] pim:RtRP2Grange 
 
 		 
 		 ├
 		[V] pim:RPInfo RP information
 
 		 
 		 
 		 ├
 		[V] pim:RsRP2Grange 
 
 		 
 		 ├
 		[V] pim:Route  PIM Group/Src MOs
 
 		 
 		 
 		 ├
 		[V] pim:Oif  PIM OIF list MOs
 
 		 ├
 		[V] pim:HelloTrP  This object holds the hello traffic policy
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:IfStats  This object holds the pim interface related statistics
 
 		 ├
 		[V] pim:JPTrP Join/prune traffic policy.
 
 		 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:RtIfDefToPimIf  Relationship to the PIM interfaces
 
 		 ├
 		[V] pim:TrafficStats  This object holds the pim control traffic stats
 ├
 		[V] pim:InterVRFP  This object holds policy for Inter VRF
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:InterVRF  This object holds policy for Static RP Entry
 ├
 		[V] pim:ResP Resource (router state) limit policy.
 
 		 ├
 		[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.
 ├
 		[V] pim:SSMPatP Source-specific multicast pattern
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:SSMRangeP Source-specific group range
 ├
 		[V] pim:StaticRPP Static RP policy
 
 		 ├
 		[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.
 
 		 ├
 		[V] pim:StaticRP Static RP information. If the RP address is configured locally, the router assumes RP functionality.
 
 		 
 		 ├
 		[V] pim:RPGrpRange The RP multicast group range.
 
 		 
 		 ├
 		[V] pim:RtLbIfToStaticRP 
 ├
 		[V] pim:TrafficStats  This object holds the pim control traffic stats


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.
 
 		 
 		 
 		 ├
 		[V] nw:ProtDom A protocol domain abstraction.
 
 		 
 		 
 		 
 		 ├
 		[V] l3:ProtDom A layer 3 protocol domain abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] rtdmc:ADom  This objects hold per routed multicast domain (vrf) information
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pim:Dom PIM domain (VRF) information.


Events


Faults 
                pim:Dom:NwIssue


Fsms


Properties Summary
Defined in: pim:Dom
reference:BinRef monPolDn  (pim:Dom:monPolDn)
           Monitoring policy attached to this observable object
naming:Name
          string:Basic 		name  (pim:Dom:name)
           Overrides:nw:CpDom:name | nw:Conn:name
           PIM domain (VRF) name.
pim:NwIssuesType
          scalar:Bitmask64 		nwIssues  (pim:Dom:nwIssues)
           PIM domain (VRF) network issues to trigger faults.
reference:BinRef policyDn  (pim:Dom:policyDn)
           pimCtxP DN. This is used to delegate any faults
Defined in: rtdmc:ADom
nw:AdminSt
          scalar:Enum8 		adminSt  (rtdmc:ADom:adminSt)
           Admin State
rtdmc:DomCtrl
          scalar:Bitmask16 		ctrl  (rtdmc:ADom:ctrl)
           Per-Dom Controls
rtdmc:Mtu
          scalar:Uint32 		mtu  (rtdmc:ADom:mtu)
           Protocol packet MTU
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

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Admin State
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT disabled(2) Disabled Disabled




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: rtdmc:DomCtrl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Per-Dom Controls
Constants
flush-on-restart 1 Flush Routes on Restart Flush all routes on process restart
fast-conv 2 Fast Convergence Fast Convergence Attract external traffic to border leaf, but do not forward to the fabric. In case of border leaf reboots, traffic can be quickly put onto the fabric to reduce multicast traffic loss duration
bfd-enable 4 Enable BFD Enable bidirectional forwarding detection (BFD) on all interfaces in this domain
strict-rfc-compliant 8 Strict RFC Compliant Enable strict RFC compliance on this domain
DEFAULT 0 --- Domain Control




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




monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Monitoring policy attached to this observable object


mtu

Type: rtdmc:Mtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Protocol packet MTU
Constants
defaultValue 1500u --- NO COMMENTS




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:CpDom:name  |  nw:Conn:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
PIM domain (VRF) name.


nwIssues

Type: pim:NwIssuesType
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
PIM domain (VRF) network issues to trigger faults.
Constants
ok 0ull ok NO COMMENTS
multicast-not-supported-on-platform 0x1ull multicast is not supported on this node. NO COMMENTS
DEFAULT ok(0ull) ok NO COMMENTS




policyDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
pimCtxP DN. This is used to delegate any faults


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.







Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail