Class pol:ConsElem (ABSTRACT)

Class ID:4605
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 a policy consumption qualifier element.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: pol:Def,
Sub Mos: pol:If, pol:Lbl,


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:Def Represents self-contained policy document.
 
 
 ├
[V] pol:ConsElem Represents a policy consumption qualifier element.
 
 
 
 ├
[V] pol:If Represents an interface exposed or consumed by a policy.
 
 
 
 
 ├
[V] pol:ConsIf Represents a consumer interface.
 
 
 
 
 ├
[V] pol:ProvIf Represents a function or service provider interface.
 
 
 
 
 ├
[V] vz:AIf The abstraction of an interface. A contract interface and bundle interface inherits from this class.
 
 
 
 
 
 ├
[V] vz:CPIf A contract interface is used as a contract consumption interface when a consumer consumes the contract by associating it to a consumption interface provided by the provider in the consumer's domain. A consumer can associate with the contract consumption interface when it is provided by the provider in the consumer's domain. Note that a contract consumption interface represents one or more subjects defined under the contract. By associating...
 
 
 
 ├
[V] pol:Lbl Represents a policy label.
 
 
 
 
 ├
[V] dhcp:ALbl The identification of the DHCP provider. If the owner is the tenant, then the label is matched with the DHCP label present under the bridge domain (BD). If the owner is the infra, then the label is matched with the DHCP label present under the infra (and associated with the node). If n providers match the label, then all of them get configured as relay.
 
 
 
 
 
 ├
[V] dhcp:Lbl A DHCP relay label contains a name for the label, the scope, and a DHCP option policy. The scope is the owner of the relay server and the DHCP option policy supplies DHCP clients with configuration parameters such as domain, nameserver, and subnet router addresses.
 
 
 
 
 
 ├
[V] dhcp:LblDef Definition of the label.
 
 
 
 
 ├
[V] dns:ALbl The DNS profile identifier.
 
 
 
 
 
 ├
[V] dns:Lbl The network domain name label. Labels enable classifying which objects can and cannot communicate with one another.
 
 
 
 
 
 ├
[V] dns:LblDef The Label definition.
 
 
 
 
 ├
[V] extnw:ALIfP An abstract logical interface profile. This object defines the characteristics that will be applied to resources that match with the profile name.
 
 
 
 
 
 ├
[V] l2ext:AIfP The abstraction of an interface profile.
 
 
 
 
 
 
 ├
[V] l2ext:LIfP The logical interface profile defines a common configuration that can be applied to one or more interfaces.
 
 
 
 
 
 
 ├
[V] l2ext:LIfPDef The interface identifiers attached to the node profile.
 
 
 
 
 
 ├
[V] l3ext:AIfP An abstract interface profile. This encapsulates common behavior / configuration that will apply to one or more L3 external interfaces.
 
 
 
 
 
 
 ├
[V] l3ext:LIfP The logical interface profile, which defines a common configuration that can be applied to one or more interfaces.
 
 
 
 
 
 
 ├
[V] l3ext:LIfPDef The interface identifiers attached to the node profile.
 
 
 
 
 ├
[V] extnw:ALNodeP An abstract logical interface profile.
 
 
 
 
 
 ├
[V] l2ext:ALNodeP An abstract logical node profile. This defines the characteristics to be applied to resources that match with the profile name.
 
 
 
 
 
 
 ├
[V] l2ext:LNodeP The logical node profile defines a common configuration that can be applied to one or more leaf nodes.
 
 
 
 
 
 
 ├
[V] l2ext:LNodePDef The logical node profile definition. This defines the characteristics to be applied to resources that match with the profile name.
 
 
 
 
 
 ├
[V] l3ext:AConsLbl  Represents Abstraction of Logical Outside Profile Consumer Label. Defines the characteristics that will be applied to Layer3 Outside that matches with the label name
 
 
 
 
 
 
 ├
[V] l3ext:ConsLbl  Represents Logical Outside Profile Consumer Label. Defines the characteristics that will be applied to Layer3 Outside that matches with the label name
 
 
 
 
 
 
 ├
[V] l3ext:ConsLblDef  Represents Logical Outside Profile Consumer Label Definition. Defines the characteristics that will be applied to Layer3 Outside that matches with the label name
 
 
 
 
 
 ├
[V] l3ext:ALNodeP An abstract logical node profile. This defines the characteristics to be applied to resources that match with the profile name.
 
 
 
 
 
 
 ├
[V] l3ext:LNodeP The logical node profile defines a common configuration that can be applied to one or more leaf nodes.
 
 
 
 
 
 
 ├
[V] l3ext:LNodePDef The logical node profile definition. This defines the characteristics to be applied to resources that match with the profile name.
 
 
 
 
 
 ├
[V] rtctrl:LNodeP The node classification criteria for the route control context.
 
 
 
 
 
 ├
[V] rtctrl:LNodePDef The local node policy definition.
 
 
 
 
 ├
[V] infra:Lbl The tenant or provider characteristics of the port.
 
 
 
 
 
 ├
[V] infra:IfLblDef The tenant/provider's external connection characteristics of the port.
 
 
 
 
 
 ├
[V] infra:NodeLblDef The tenant or provider's external connection characteristics of the port.
 
 
 
 
 ├
[V] l3ext:AProvLbl  Represents Abstraction of Logical Outside Profile Provider Label. Defines the characteristics that will be applied to Layer3 Outside that matches with the label name
 
 
 
 
 
 ├
[V] l3ext:ProvLbl  Represents Logical Outside Profile Provider Label. Defines the characteristics that will be applied to Layer3 Outside that matches with the label name
 
 
 
 
 
 ├
[V] l3ext:ProvLblDef  Represents Logical Outside Profile Label Definition. Defines the characteristics that will be applied to Layer3 Outside that matches with the label name
 
 
 
 
 ├
[V] pol:ConsLbl Represents a consumer label
 
 
 
 
 
 ├
[V] vsvc:AConsLbl This is generated and used only by internal processes.
 
 
 
 
 
 
 ├
[V] dhcp:ConsLbl The consumer label.
 
 
 
 
 
 
 ├
[V] vsvc:ConsLbl A service consumer label.
 
 
 
 
 ├
[V] pol:ProvLbl Represents a function or service provider label.
 
 
 
 
 
 ├
[V] vsvc:AProvLbl An abstraction of the provider label.
 
 
 
 
 
 
 ├
[V] dhcp:ProvLbl The provider label.
 
 
 
 
 
 
 ├
[V] vsvc:ProvLbl A service provider label.
 
 
 
 
 ├
[V] span:ASpanLbl The abstraction of a SPAN label.
 
 
 
 
 
 ├
[V] span:SpanLbl The SPAN label is used for SPAN label parameters.
 
 
 
 
 
 ├
[V] span:SpanLblDef The SPAN label definition.
 
 
 
 
 ├
[V] vz:ALbl The labels for filtering subjects.
 
 
 
 
 
 ├
[V] vz:ACompLbl An abstraction of a complement label.
 
 
 
 
 
 
 ├
[V] vz:ACompLblDef An abstraction of a complement label definition.
 
 
 
 
 
 
 
 ├
[V] vz:ConsSubjLblDef A consumer subject label definition.
 
 
 
 
 
 
 
 ├
[V] vz:ProvLblDef A provider label definition.
 
 
 
 
 
 
 
 ├
[V] vz:ProvSubjLblDef A provider subject label definition. A subject label is used as a classification criteria for subjects being consumed/provided by the endpoint groups (EPGs) participating in the contract. The label identifies a subject being consumed by a consumer. It can be parented by 2 different methods. The first method is the relation between the consumer EPG and the contract that is used for filtering the subjects. A label should match either the subject na...
 
 
 
 
 
 
 ├
[V] vz:ConsSubjLbl A consumer subject label. In general, a subject label is used as a classification criteria for subjects being consumed/provided by the endpoint groups (EPGs) participating in the contract. The label identifies a subject being consumed by a consumer. It can be parented by 2 different methods. The first method is the relation between the consumer EPG and the contract that is used for filtering the subjects. A label should match either the subject n...
 
 
 
 
 
 
 ├
[V] vz:ProvLbl A label used by a provider for specifying its identity. The parent can be either the provider endpoint group or the relation between the provider endpoint group and a contract. A consumer with no label will consume from all the providers of the contract regardless of the provider label. A consumer with a specific label can only consume from providers matching the label.
 
 
 
 
 
 
 ├
[V] vz:ProvSubjLbl A subject label is used as classification criteria for subjects being consumed/provided by the endpoint groups (EPGs) participating in the contract. The label identifies a subject being provided by a provider. It can be parented by 2 different methods. The first method is the relation between the provider EPG and the contract that is used for filtering the subjects. A label should match either the subject name or the label present under the subje...
 
 
 
 
 
 ├
[V] vz:ALblDef An abstraction of a label definition.
 
 
 
 
 
 
 ├
[V] vz:ConsCtrctLblDef A consumer contract label definition.
 
 
 
 
 
 
 ├
[V] vz:ConsLblDef A consumer label definition.
 
 
 
 
 
 
 ├
[V] vz:ProvCtrctLblDef A provider contract label definition.
 
 
 
 
 
 ├
[V] vz:ConsCtrctLbl A consumer contract label. A contract label can be parented by the relation between an endpoint group (EPG) and security group. The EPG is associated with a group and lists all contracts it provides out of the group, as well as, optionally, contracts that it chooses to consume. If no consumption contracts are indicated, all contracts are consumed. If no provider contracts are identified, the EPG provides no contracts out of this group.
 
 
 
 
 
 ├
[V] vz:ConsLbl A label used by consumers to filter the providers. The label can be parented as follows: By the consumer endpoint group. By the relation between the consumer endpoint group and contract. By the relation between the contract interface and contract. By the relation between the consumer endpoint group and contract interface. A consumer with no label will consume from all the providers of the contract with no labels. A consumer with a specific label...
 
 
 
 
 
 ├
[V] vz:ProvCtrctLbl A label identifying a contract. A contract label can be parented by the relation between an endpoint group (EPG) and security group. The EPG is associated with a group and lists all contracts it provides out of the group, as well as, optionally, contracts that it chooses to consume. If no consumption contracts are indicated, all contracts are consumed. If no provider contracts are identified, the EPG provides no contracts out of this group.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def: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





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.



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.