Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class fv:EPgToCollection (ABSTRACT)

Class ID:1897
Class Label: Super Class for Each Epg to Collection Relation
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Non-Regular MO, like stat/health... - APIC NX Processing: Disabled
Write Access: []
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The super class for all relations from EPG to contract/bundle/group.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: pol:NToRef,
Sub Mos: fv:RsCons, fv:RsIntraEpg, fv:RsProv,
Contained Mos: fv:CollectionCont,


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.
 
 		 
 		 
 		 ├
 		[V] fv:RsIntraEpg  Intra EPg contract: Represents that the EPg is moving from "allow all within epg" mode to a "deny all within epg" mode. The only type of traffic allowed between EPs in this EPg is the one specified by contracts EPg associates to with this relation.
 
 		 
 		 
 		 ├
 		[V] fv:RsProv A contract for which the EPG will be a provider.


Events


Faults 
                pol:NToRef:mismatchTarget


Fsms


Properties Summary
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:ClassId
          scalar:Enum16 		tCl  (reln:Inst:tCl)
           The class ID of the target object. This property is managed internally and should not be modified by the user.
reln:Dn
          reference:BinRef 		tDn  (reln:Inst:tDn)
           The distinguished name of the target.
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




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




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.


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




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

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The class ID of the target object. This property is managed internally and should not be modified by the user.
Constants
unspecified 0 unspecified NO COMMENTS
DEFAULT unspecified(0) unspecified 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




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




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






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail