Class synthetic:Context (CONCRETE)

Class ID:4242
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [aaa, admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]



Naming Rules
RN FORMAT: context-{name}

    [1] PREFIX=context- PROPERTY = name




DN FORMAT: 

[0] synthuni/context-{name}

                


Diagram

Super Mo: synthetic:AContext,
Container Mos: synthetic:Universe (deletable:yes),
Contained Mos: aaa:DomainRef, aaa:RbacAnnotation, synthetic:EpGroup, synthetic:RelETest, tag:Annotation, tag:Tag,
Relations To: l1:PhysIf,
Relations: synthetic:RsPhysIf,


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] synthetic:Universe 
 
 ├
[V] synthetic:Context 


Contained Hierarchy
[V] synthetic:Context 
 ├
[V] aaa:DomainRef A reference to the domain that the parent object belongs to.
 
 ├
[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] aaa:RtDomainRef The target relation to resolve an RBAC domain.
 
 ├
[V] aaa:RtLSubjToDomainRef 
 
 ├
[V] aaa:RtScriptHandlerStateToDomainRef A target relation to a reference to the domain that the parent object belongs.
 
 ├
[V] aaa:RtSessionToDomainRef 
 
 ├
[V] aaa:RtTenantToDomainRef 
 
 ├
[V] aaa:RtVDevDomainRefContToDomainRef 
 
 ├
[V] aaa:RtVDevToDomainRef A target relation to a reference to the domain that the parent object belongs.
 
 ├
[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: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] 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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] synthetic:EpGroup 
 
 ├
[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] synthetic:Ep 
 
 
 ├
[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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] synthetic:RelETest 
 
 ├
[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] synthetic:RsPhysIf A source relation to the object that represents the Layer 1 physical Ethernet interface 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] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 ├
[V] synthetic:Object 
 
 
 ├
[V] synthetic:AContext 
 
 
 
 ├
[V] synthetic:Context 


Events
                synthetic:Context:creation__synthetic_Context
synthetic:Context:modification__synthetic_Context
synthetic:Context:deletion__synthetic_Context


Faults
                


Fsms
                synthetic:Context:Test2
synthetic:Context:Test3


Properties Summary
Defined in: synthetic:Context
synthetic:TestIfIndexArray1024
          base:IfIndexArray1024
aIfIndexArray  (synthetic:Context:aIfIndexArray)
          
synthetic:TestArray1024
          base:BitArray1024
abitarray  (synthetic:Context:abitarray)
          
l1:AdminSt
          scalar:Enum8
adminSt  (synthetic:Context:adminSt)
           The administrative state of the object or policy.
address:MAC amac  (synthetic:Context:amac)
          
address:Ip anip  (synthetic:Context:anip)
          
mo:Annotation
          string:Basic
annotation  (synthetic:Context:annotation)
           NO COMMENTS
address:Ip anotherip  (synthetic:Context:anotherip)
          
synthetic:TestArray16_20
          base:Uint16Array20
auint16array  (synthetic:Context:auint16array)
          
synthetic:TestArray20
          base:Uint32Array20
auint32array  (synthetic:Context:auint32array)
          
synthetic:TestArray64_20
          base:Uint64Array20
auint64array  (synthetic:Context:auint64array)
          
synthetic:TestArray8_20
          base:Uint8Array20
auint8array  (synthetic:Context:auint8array)
          
synthetic:BitState
          scalar:Bitmask8
bits  (synthetic:Context:bits)
          
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (synthetic:Context:extMngdBy)
           NO COMMENTS
naming:Name
          string:Basic
name  (synthetic:Context:name)
           Overrides:naming:NamedObject:name
           The name of the object.
scalar:Uint32 numEps  (synthetic:Context:numEps)
          
scalar:Uint32 numGroups  (synthetic:Context:numGroups)
          
scalar:Bitmask64 pmCfgFailedBmp  (synthetic:Context:pmCfgFailedBmp)
          
scalar:Time pmCfgFailedTs  (synthetic:Context:pmCfgFailedTs)
          
scalar:UByte pmCfgState  (synthetic:Context:pmCfgState)
          
scalar:Uint32 secKey  (synthetic:Context:secKey)
          
scalar:Enum8 state  (synthetic:Context:state)
           Represents the state of the relationship.
scalar:Enum8 state2  (synthetic:Context:state2)
          
synthetic:TrigState
          scalar:Enum8
trig  (synthetic:Context:trig)
          
Defined in: synthetic:AContext
scalar:Enum8 adminState  (synthetic:AContext:adminState)
           The destination policy administrative state. If enabled, the system uses the destination policy when an error matching the associated cause is encountered. Otherwise, the system ignores the policy even if a matching error occurs. By default, all policies are enabled.
scalar:Bitmask64 pcmCfgFailedBmp  (synthetic:AContext:pcmCfgFailedBmp)
          
scalar:Time pcmCfgFailedTs  (synthetic:AContext:pcmCfgFailedTs)
          
scalar:UByte pcmCfgState  (synthetic:AContext:pcmCfgState)
          
Defined in: synthetic:Object
naming:Descr
          string:Basic
descr  (synthetic:Object:descr)
          
Defined in: naming:NamedIdentifiedObject
naming:Id
          scalar:Uint64
id  (naming:NamedIdentifiedObject:id)
           An identifier .
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

aIfIndexArray

Type: synthetic:TestIfIndexArray1024
Primitive Type: base:IfIndexArray1024

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



abitarray

Type: synthetic:TestArray1024
Primitive Type: base:BitArray1024

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



adminSt

Type: l1:AdminSt
Primitive Type: scalar:Enum8

Like: l1:If:adminSt
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
down 1 down Admin state shut
up 2 up Admin state up
DEFAULT down(1) down Admin state shut





adminState

Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The destination policy administrative state. If enabled, the system uses the destination policy when an error matching the associated cause is encountered. Otherwise, the system ignores the policy even if a matching error occurs. By default, all policies are enabled.
Constants
enabled 11 enabled NO COMMENTS
disabled 12 disabled NO COMMENTS
DEFAULT enabled(11) enabled NO COMMENTS





amac

Type: address:MAC

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



anip

Type: address:Ip

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
wildcard base::Ip(0) Wildcard NO COMMENTS
DEFAULT wildcard(base::Ip(0)) Wildcard NO COMMENTS





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



anotherip

Type: address:Ip

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



auint16array

Type: synthetic:TestArray16_20
Primitive Type: base:Uint16Array20

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



auint32array

Type: synthetic:TestArray20
Primitive Type: base:Uint32Array20

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



auint64array

Type: synthetic:TestArray64_20
Primitive Type: base:Uint64Array20

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



auint8array

Type: synthetic:TestArray8_20
Primitive Type: base:Uint8Array20

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



bits

Type: synthetic:BitState
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
bit1 1 bit1 NO COMMENTS
bit2 2 bit2 NO COMMENTS
bit3 4 bit3 NO COMMENTS
DEFAULT 0 --- 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





descr

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:



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





id

Type: naming:Id
Primitive Type: scalar:Uint64

Like: naming:Identified:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
An identifier .



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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "16" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



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



numEps

Type: scalar:Uint32

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
    Comments:



numGroups

Type: scalar:Uint32

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
    Comments:



pcmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:



pcmCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:



pcmCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:



pmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
synthetic:ContextlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
synthetic:ContextextMngdBy_failed_flag 1048576ull --- NO COMMENTS
synthetic:Contextauint64array_failed_flag 131072ull --- NO COMMENTS
synthetic:Contextanotherip_failed_flag 16384ull --- NO COMMENTS
synthetic:Contextname_failed_flag 1ull --- NO COMMENTS
synthetic:Contextamac_failed_flag 2048ull --- NO COMMENTS
synthetic:ContextnumEps_failed_flag 2097152ull --- NO COMMENTS
synthetic:ContextmodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
synthetic:ContextaIfIndexArray_failed_flag 256ull --- NO COMMENTS
synthetic:Contextauint8array_failed_flag 262144ull --- NO COMMENTS
synthetic:ContextnameAlias_failed_flag 2ull --- NO COMMENTS
synthetic:Contextauint16array_failed_flag 32768ull --- NO COMMENTS
synthetic:Contextanip_failed_flag 4096ull --- NO COMMENTS
synthetic:ContextnumGroups_failed_flag 4194304ull --- NO COMMENTS
synthetic:Contextuid_failed_flag 4611686018427387904ull --- NO COMMENTS
synthetic:Contextid_failed_flag 4ull --- NO COMMENTS
synthetic:Contextabitarray_failed_flag 512ull --- NO COMMENTS
synthetic:Contextbits_failed_flag 524288ull --- NO COMMENTS
synthetic:Contexttrig_failed_flag 536870912ull --- NO COMMENTS
synthetic:Contextauint32array_failed_flag 65536ull --- NO COMMENTS
synthetic:ContextsecKey_failed_flag 67108864ull --- NO COMMENTS
synthetic:Contextannotation_failed_flag 8192ull --- NO COMMENTS
synthetic:Contextdescr_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





pmCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:



pmCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    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.



secKey

Type: scalar:Uint32

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
    Comments:



state

Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Represents the state of the relationship.
Constants
enabled 11 enabled NO COMMENTS
disabled 12 disabled NO COMMENTS
DEFAULT enabled(11) enabled NO COMMENTS





state2

Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
enabled 11 enabled NO COMMENTS
disabled 12 disabled NO COMMENTS
DEFAULT enabled(11) enabled NO COMMENTS





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.






trig

Type: synthetic:TrigState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
untriggered 0 untriggered NO COMMENTS
fsm1 1 fsm1 NO COMMENTS
fsm2 2 fsm2 NO COMMENTS
fsm 3 fsm NO COMMENTS
task-local 4 task-local NO COMMENTS
task-remote 5 task-remote NO COMMENTS
task 6 task NO COMMENTS
DEFAULT untriggered(0) untriggered NO COMMENTS





uid

Type: scalar:Uint16

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