Class fv:RsCons (CONCRETE)

Class ID:1904
Class Label: Contract Consumer
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Enabled - Abstraction Layer: Non-Regular MO, like stat/health... - APIC NX Processing: Disabled
Relationship Type: named
Relationship Cardinality: n-to-m
Relationship From: fv:EPg
Relationship From Rel: fv:RsCons
Relationship To: vz:BrCP
Relationship To Rel: vz:RtCons
Enforceable: true
Resolvable: true
Write Access: [admin, tenant-epg, tenant-network-profile]
Read Access: [admin, tenant-epg, tenant-network-profile, tenant-security]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The Consumer contract profile information.

Naming Rules
RN FORMAT: rscons-{tnVzBrCPName}

    [1] PREFIX=rscons- PROPERTY = tnVzBrCPName




DN FORMAT: 

        Too Many Containers: 79
                


Containers Hierarchies
Too Many containers: 79


Contained Hierarchy
[V] fv:RsCons The Consumer contract profile information.
 ├
[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] 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] fv:CollectionCont The collection container.
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:AInst The label instance, which is contained by the taggable object.
 
 ├
[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] tag:Annotation 
 ├
[V] tag:Tag 
 ├
[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] 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] 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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[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] 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] 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] tag:Annotation 
 
 ├
[V] tag:Tag 


Inheritance
[V] reln:Inst This is generated and used only by internal processes.
 ├
[V] reln:To This is generated and used only by internal processes.
 
 ├
[V] pol:NToRef Represents a source name.
 
 
 ├
[V] fv:EPgToCollection The super class for all relations from EPG to contract/bundle/group.
 
 
 
 ├
[V] fv:RsCons The Consumer contract profile information.


Events
                fv:RsCons:creation__fv_RsCons
fv:RsCons:modification__fv_RsCons
fv:RsCons:deletion__fv_RsCons


Faults
                fv:RsCons:ResolveFail
pol:NToRef:mismatchTarget


Fsms
                


Properties Summary
Defined in: fv:RsCons
mo:Annotation
          string:Basic
annotation  (fv:RsCons:annotation)
           NO COMMENTS
vz:DeplInfo
          scalar:Bitmask8
deplInfo  (fv:RsCons:deplInfo)
           null
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (fv:RsCons:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (fv:RsCons:monPolDn)
           The monitoring policy attached to this observable object.
qos:TenantPrio
          scalar:Enum8
prio  (fv:RsCons:prio)
           The system class determines the quality of service and priority for the consumer traffic.
reln:ClassId
          scalar:Enum16
tCl  (fv:RsCons:tCl)
           Overrides:reln:Inst:tCl
           null
naming:Name
          string:Basic
tnVzBrCPName  (fv:RsCons:tnVzBrCPName)
           The consumer contract name.
Defined in: fv:EPgToCollection
fv:CtrctUpd
          scalar:Enum8
ctrctUpd  (fv:EPgToCollection:ctrctUpd)
           Indicates if the information about the contract/bundle/group an endpoint group is associated to will be sent from the endpoint group shard or contract shard.
fv:TriggerSt
          scalar:Enum8
triggerSt  (fv:EPgToCollection:triggerSt)
           The ability to trigger a task
scalar:Bool updateCollection  (fv:EPgToCollection:updateCollection)
           NO COMMENTS
Defined in: pol:NToRef
reln:Dn
          reference:BinRef
tContextDn  (pol:NToRef:tContextDn)
           Specifies the target context distinguished name.
string:Basic tRn  (pol:NToRef:tRn)
           Specifies the target's related name.
reln:TargetType
          scalar:Enum8
tType  (pol:NToRef:tType)
           Overrides:reln:To:tType
           Represents the type of target. The target type for this object is named.
Defined in: reln:To
scalar:Bool forceResolve  (reln:To:forceResolve)
           Whether the relation should force pull the target.
reln:ResolverType
          scalar:Enum8
rType  (reln:To:rType)
           Represents the type of resolver.
reln:State
          scalar:Enum8
state  (reln:To:state)
           Represents the state of the relationship.
reln:StateQual
          scalar:Enum8
stateQual  (reln:To:stateQual)
           Represents the state qualifier of the relationship.
Defined in: reln:Inst
reln:Dn
          reference:BinRef
tDn  (reln:Inst:tDn)
           The distinguished name of the target.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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

annotation

Type: mo:Annotation
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:
NO COMMENTS



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





ctrctUpd

Type: fv:CtrctUpd
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates if the information about the contract/bundle/group an endpoint group is associated to will be sent from the endpoint group shard or contract shard.
Constants
ctrct 0 ctrct NO COMMENTS
not_defined 0 not_defined NO COMMENTS
epg 1 epg NO COMMENTS
DEFAULT not_defined(0) not_defined NO COMMENTS





deplInfo

Type: vz:DeplInfo
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
None 0 None NO COMMENTS
PCTag_Not_Allocated 1 PCTag_Not_Allocated NO COMMENTS
Not_Associated_To_Context 2 Not_Associated_To_Context NO COMMENTS
No_Subjects 4 No_Subjects NO COMMENTS
No_Matching_Provider 8 No_Matching_Provider NO COMMENTS
DEFAULT 0 --- NO COMMENTS





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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





forceResolve

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Whether the relation should force pull the target.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





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:
The monitoring policy attached to this observable object.



prio

Type: qos:TenantPrio
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (byte)0  max: (byte)9
    Comments:
The system class determines the quality of service and priority for the consumer traffic.
Constants
unspecified 0 Unspecified NO COMMENTS
level3 1 Level3 (Default) User configurable classes
level2 2 Level2 NO COMMENTS
level1 3 Level1 NO COMMENTS
level6 7 Level6 NO COMMENTS
level5 8 Level5 NO COMMENTS
level4 9 Level4 NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





rType

Type: reln:ResolverType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the type of resolver.
Constants
mo 1 mo NO COMMENTS
service 2 service NO COMMENTS
local 3 local NO COMMENTS
DEFAULT mo(1) mo NO COMMENTS





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.



state

Type: reln:State
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the state of the relationship.
Constants
unformed 0 unformed the relationship is not formed
formed 1 formed the relationship is formed with the target object
missing-target 2 missing-target target does not exist
invalid-target 4 invalid-target invalid target DN
cardinality-violation 5 cardinality-violation cardinality violation - When relations are created such that they violate the cardinality, state of the relation would be set to this.
DEFAULT unformed(0) unformed the relationship is not formed





stateQual

Type: reln:StateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the state qualifier of the relationship.
Constants
none 0 none no issue
mismatch-target 1 mismatch-target target not found, using default
default-target 2 default-target target not specified, using default
DEFAULT none(0) none no issue





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.






tCl

Type: reln:ClassId
Primitive Type: scalar:Enum16

Overrides:reln:Inst:tCl
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
null
Constants
unspecified 0 unspecified NO COMMENTS
vzBrCP 1300 --- NO COMMENTS
DEFAULT vzBrCP(1300) --- NO COMMENTS





tContextDn

Type: reln:Dn
Primitive Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the target context distinguished name.



tDn

Type: reln:Dn
Primitive Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The distinguished name of the target.



tRn

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the target's related name.



tType

Type: reln:TargetType
Primitive Type: scalar:Enum8

Overrides:reln:To:tType
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
Represents the type of target. The target type for this object is named.
Constants
name 0 name NO COMMENTS
mo 1 mo NO COMMENTS
all 2 all NO COMMENTS
DEFAULT name(0) name NO COMMENTS





tnVzBrCPName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
The consumer contract name.



triggerSt

Type: fv:TriggerSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The ability to trigger a task
Constants
not_triggerable 0 not_triggerable NO COMMENTS
triggerable 1 triggerable NO COMMENTS
DEFAULT not_triggerable(0) not_triggerable NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



updateCollection

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS