Class analytics:RsCollectorAtt (CONCRETE)

Class ID:9025
Class Label: Reference to Collector
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Non-Regular MO, like stat/health... - APIC NX Processing: Disabled
Relationship Type: explicit
Relationship Cardinality: n-to-m
Relationship From: analytics:CollectorBucket
Relationship From Rel: analytics:RsCollectorAtt
Relationship To: analytics:Collector
Relationship To Rel: analytics:RtCollectorAtt
Enforceable: true
Resolvable: true
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Relation to collector

Naming Rules
RN FORMAT: rscollectorAtt-{[tDn]}

    [1] PREFIX=rscollectorAtt- PROPERTY = tDn




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/analytics/inst-{mode}/monitor-{name}/collectorbucket-{id}/rscollectorAtt-{[tDn]}

[1] sys/analytics/inst-{mode}/monitor-{name}/collectorbucket-{id}/rscollectorAtt-{[tDn]}

                


Diagram

Super Mo: reln:To,
Container Mos: analytics:CollectorBucket (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,


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] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] analytics:Entity 
 
 
 
 
 
 ├
[V] analytics:Inst  Holds netflow and analytics instance information
 
 
 
 
 
 
 ├
[V] analytics:Monitor  Flow Monitor
 
 
 
 
 
 
 
 ├
[V] analytics:CollectorBucket  Collector bucket info
 
 
 
 
 
 
 
 
 ├
[V] analytics:RsCollectorAtt  Relation to collector
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] analytics:Entity 
 
 
 ├
[V] analytics:Inst  Holds netflow and analytics instance information
 
 
 
 ├
[V] analytics:Monitor  Flow Monitor
 
 
 
 
 ├
[V] analytics:CollectorBucket  Collector bucket info
 
 
 
 
 
 ├
[V] analytics:RsCollectorAtt  Relation to collector


Contained Hierarchy
[V] analytics:RsCollectorAtt  Relation to collector
 ├
[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 


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] analytics:RsCollectorAtt  Relation to collector


Events
                analytics:RsCollectorAtt:creation__analytics_RsCollectorAtt
analytics:RsCollectorAtt:modification__analytics_RsCollectorAtt
analytics:RsCollectorAtt:deletion__analytics_RsCollectorAtt


Faults
                analytics:RsCollectorAtt:ResolveFail


Fsms
                


Properties Summary
Defined in: analytics:RsCollectorAtt
mo:Annotation
          string:Basic
annotation  (analytics:RsCollectorAtt:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (analytics:RsCollectorAtt:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (analytics:RsCollectorAtt:monPolDn)
           Monitoring policy attached to this observable object
scalar:Bitmask64 nfmCfgFailedBmp  (analytics:RsCollectorAtt:nfmCfgFailedBmp)
           NO COMMENTS
scalar:Time nfmCfgFailedTs  (analytics:RsCollectorAtt:nfmCfgFailedTs)
           NO COMMENTS
scalar:UByte nfmCfgState  (analytics:RsCollectorAtt:nfmCfgState)
           NO COMMENTS
analytics:OperSt
          scalar:Enum8
operSt  (analytics:RsCollectorAtt:operSt)
           The runtime state of the object or policy.
analytics:OperStQual
          scalar:Bitmask8
operStQual  (analytics:RsCollectorAtt:operStQual)
           The chassis operational status qualifier.
reln:ClassId
          scalar:Enum16
tCl  (analytics:RsCollectorAtt:tCl)
           Overrides:reln:Inst:tCl
          
reln:Dn
          reference:BinRef
tDn  (analytics:RsCollectorAtt:tDn)
           Overrides:reln:Inst:tDn
          
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.
reln:TargetType
          scalar:Enum8
tType  (reln:To:tType)
           The type of target.
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

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





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:
Monitoring policy attached to this observable object



nfmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
analytics:RsCollectorAttlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
analytics:RsCollectorAttannotation_failed_flag 128ull --- NO COMMENTS
analytics:RsCollectorAttstate_failed_flag 16ull --- NO COMMENTS
analytics:RsCollectorAtttCl_failed_flag 1ull --- NO COMMENTS
analytics:RsCollectorAttmodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
analytics:RsCollectorAttextMngdBy_failed_flag 256ull --- NO COMMENTS
analytics:RsCollectorAtttDn_failed_flag 2ull --- NO COMMENTS
analytics:RsCollectorAttstateQual_failed_flag 32ull --- NO COMMENTS
analytics:RsCollectorAttuid_failed_flag 4611686018427387904ull --- NO COMMENTS
analytics:RsCollectorAttforceResolve_failed_flag 4ull --- NO COMMENTS
analytics:RsCollectorAttmonPolDn_failed_flag 512ull --- NO COMMENTS
analytics:RsCollectorAtttType_failed_flag 64ull --- NO COMMENTS
analytics:RsCollectorAttrType_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





nfmCfgFailedTs

Type: scalar:Time

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



nfmCfgState

Type: scalar:UByte

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



operSt

Type: analytics:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The runtime state of the object or policy.
Constants
undefined 0 Not-Applicable Operational state is not defined
enabled 1 enabled Operational state is Enabled
disabled 2 disabled Operational state is Disabled
DEFAULT disabled(2) disabled Operational state is Disabled





operStQual

Type: analytics:OperStQual
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The chassis operational status qualifier.
Constants
hwprog-fail 1 Hardware Programming Failed Hardware programming failed
swprog-fail 2 Software programming failed Software programming failed
hwprog-fail-tcam-full 4 Hardware programming failed as TCAM was full Hardware programming failed tcam full
platform-unsupported 8 Platorm not supported Platorm not supported Entity MO
feature-prio-mismatch 16 Feature priority mismatch Feature priority mismatch Inst MO
configured-params-mismatch 32 Configured parameters mismatch Configured parameters mismatch RsMonitor MO
collector-limit-exceeded 64 Version 9 collector limit exceeded Collector limit exceeded Collector MO
collector-dest-unreachable 128 Collector destination host unreachable Collector destination host unreachable Collector MO
DEFAULT 0 --- Reasons for rule being disabled.





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:
Constants
unspecified 0 unspecified NO COMMENTS
analyticsCollector 9021 --- NO COMMENTS
DEFAULT analyticsCollector(9021) --- NO COMMENTS





tDn

Type: reln:Dn
Primitive Type: reference:BinRef

Overrides:reln:Inst:tDn
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators:
    Comments:



tType

Type: reln:TargetType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type of target.
Constants
name 0 name NO COMMENTS
mo 1 mo NO COMMENTS
all 2 all NO COMMENTS
DEFAULT mo(1) mo NO COMMENTS





uid

Type: scalar:Uint16

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