Class pol:Dom (ABSTRACT)

Class ID:4600
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: []
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Represents the policy definition or resolution domain.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: pol:Cont,
Sub Mos: auth:ASvrGroup, comp:ProvP, ctrlr:Dom, dbgexp:TSDomain, fabric:Dom, fv:ADomP, fv:AppCtxRefCont, fv:EpCPCont, fv:EpCont, fv:EpPCont, fv:FailedXlateCont, fv:L3EpCont, fv:Tenant, infra:Infra, l3ext:PolRefCont, opflex:AODevRslt, opflex:AODevTask, planner:Cont, pol:Uni, rtctrl:ConsSubjDefCont,


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:Cont Represents entities that contain policy definitions.
 
 
 ├
[V] pol:Dom Represents the policy definition or resolution domain.
 
 
 
 ├
[V] auth:ASvrGroup 
 
 
 
 
 ├
[V] auth:SvrGroup 
 
 
 
 ├
[V] comp:ProvP The VM provider profile, which enables you to configure policies for a VM provider such as VMware or Microsoft.
 
 
 
 
 ├
[V] vmm:ProvP The VMM provider profile stores the policies of VMM systems from a particular vendor (VMware or Microsoft). This container is automatically created by the system.
 
 
 
 ├
[V] ctrlr:Dom A controller domain.
 
 
 
 
 ├
[V] ctrlr:Inst An instance of the controller.
 
 
 
 ├
[V] dbgexp:TSDomain  Reference to
 
 
 
 ├
[V] fabric:Dom Abase class for fabric policies.
 
 
 
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 
 ├
[V] fv:ADomP A base class for domain profiles.
 
 
 
 
 ├
[V] infra:ADomP The domain profile in the infrastructure is used for carving the infra-elements including, but not limited to, port, vlan, etc.
 
 
 
 
 
 ├
[V] infra:DomP An abstraction of an infrastructure domain profile associated with application endpoint groups. This is used for carving the infra elements including, but not limited to, port, VLAN, etc.
 
 
 
 
 
 
 ├
[V] comp:DomP A virtual machine management domain.
 
 
 
 
 
 
 
 ├
[V] vmm:DomP The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. For example, the VM controllers can share VLAN or VXLAN space and application endpoint groups. The APIC communicates with the controller to publish network configurations such as port groups that are then applied to the virtual workloads.
 
 
 
 
 
 
 
 ├
[V] vmm:DomPDef A container for distributed virtual switch policies. This is an object in the iLeaf (switch).
 
 
 
 
 
 
 ├
[V] edm:GroupP 
 
 
 
 
 
 
 
 ├
[V] extdev:GroupP  External Device Group Profile is a policy pertaining to single External Device Management domain that also corresponds to a single policy enforcement domain: a UCSM Instance (a cluster of UCS FIs) forms such domain. This maps into UCS VLAN Group concept.
 
 
 
 
 
 
 ├
[V] extnw:DomP The base class for the external bridged and external routed domain profiles. The external bridged domain profile is a policy for managing the physical infrastructure, such as ports/VLANS, that can be used by an L2 network bridged outside the fabric. The external routed domain profile is a policy for managing the physical infrastructure, such as ports/VLANS, that can be used by an L3 routed outside network.
 
 
 
 
 
 
 
 ├
[V] l2ext:ADomP The abstraction of the external routed domain profile is a policy for managing the physical infrastructure, such as ports/VLANS, that can be used by an L3 routed outside network.
 
 
 
 
 
 
 
 
 ├
[V] l2ext:DomDef This is generated and used only by internal processes.
 
 
 
 
 
 
 
 
 ├
[V] l2ext:DomP The external bridged domain profile is a policy for managing the physical infrastructure, such as ports/VLANS, that can be used by an L2 network bridged outside the fabric.
 
 
 
 
 
 
 
 ├
[V] l3ext:ADomP The abstraction of the external routed domain profile, which is a policy for managing the physical infrastructure, such as ports/VLANS, that can be used by an L3 routed outside network.
 
 
 
 
 
 
 
 
 ├
[V] l3ext:DomDef This is generated and used only by internal processes.
 
 
 
 
 
 
 
 
 ├
[V] l3ext:DomP The external routed domain profile is a policy for managing the physical infrastructure, such as ports/VLANS, that can be used by an L3 routed outside network.
 
 
 
 
 
 
 ├
[V] fc:DomP  FC domain profile is a policy pertaining to single FC Management domain that also corresponds to a single policy enforcement domain: representing the FC bindings.
 
 
 
 
 
 
 ├
[V] phys:DomP The physical domain profile stores the physical resources (ports and port-channels) and encap resources (VLAN/VXLAN) that should be used for endpoint groups associated with this domain.
 
 
 
 ├
[V] fv:AppCtxRefCont  App Ctx Reference Container
 
 
 
 ├
[V] fv:EpCPCont The definition objects.
 
 
 
 ├
[V] fv:EpCont An endpoint container. This is an internal object used for deploying endpoints.
 
 
 
 ├
[V] fv:EpPCont The container for an endpoint profile.
 
 
 
 ├
[V] fv:FailedXlateCont 
 
 
 
 ├
[V] fv:L3EpCont  L3 Ep Container: Contains EndPoints per VRF @@@ This Mo exists only on PE
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 ├
[V] infra:Infra A container for all tenant infra configurations.
 
 
 
 ├
[V] l3ext:PolRefCont The L3 outside level policy reference container.
 
 
 
 ├
[V] opflex:AODevRslt  Singleton
 
 
 
 
 ├
[V] dbgexp:TSVmmRslt 
 
 
 
 
 ├
[V] opflexp:TechSuppVmmRslt 
 
 
 
 ├
[V] opflex:AODevTask 
 
 
 
 
 ├
[V] dbgexp:TSVmmTask 
 
 
 
 ├
[V] planner:Cont 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 ├
[V] rtctrl:ConsSubjDefCont  SubjDef Container for Shared Service Consumers Public Subnets with resolved policies


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: pol:Dom
naming:Descr
          string:Basic
ownerKey  (pol:Dom:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Dom:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
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: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





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.



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.