Class analytics:RecordSsx (CONCRETE)

Class ID:16194
Class Label: SSX Record
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

SSX Record

Naming Rules
RN FORMAT: recordssx-{name}

    [1] PREFIX=recordssx- PROPERTY = name




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/analytics/inst-{mode}/recordssx-{name}

[1] sys/analytics/inst-{mode}/recordssx-{name}

                


Diagram

Super Mo: pol:Instr,
Container Mos: analytics:Inst (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: analytics:Monitor,
Relations: analytics:RtRecordSsxAtt,


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:RecordSsx SSX Record
[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:RecordSsx SSX Record


Contained Hierarchy
[V] analytics:RecordSsx SSX Record
 ├
[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] analytics:RtRecordSsxAtt  Relation to record
 ├
[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] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] analytics:RecordSsx SSX Record


Events
                analytics:RecordSsx:creation__analytics_RecordSsx
analytics:RecordSsx:modification__analytics_RecordSsx
analytics:RecordSsx:deletion__analytics_RecordSsx


Faults
                


Fsms
                


Properties Summary
Defined in: analytics:RecordSsx
mo:Annotation
          string:Basic
annotation  (analytics:RecordSsx:annotation)
           NO COMMENTS
analytics:CollectParamsSsx
          scalar:Bitmask64
collectssx  (analytics:RecordSsx:collectssx)
           Export parameters for the ssx record
naming:Descr
          string:Basic
descr  (analytics:RecordSsx:descr)
           Overrides:pol:Instr:descr
           The description of this configuration item.
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (analytics:RecordSsx:extMngdBy)
           NO COMMENTS
scalar:Bitmask64 flow_agentCfgFailedBmp  (analytics:RecordSsx:flow_agentCfgFailedBmp)
           NO COMMENTS
scalar:Time flow_agentCfgFailedTs  (analytics:RecordSsx:flow_agentCfgFailedTs)
           NO COMMENTS
scalar:UByte flow_agentCfgState  (analytics:RecordSsx:flow_agentCfgState)
           NO COMMENTS
analytics:CollIntvl
          scalar:Uint32
interval  (analytics:RecordSsx:interval)
           The time interval in milliseconds that the peer keepalives should be sent.
naming:Name
          string:Basic
name  (analytics:RecordSsx:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
analytics:OperSt
          scalar:Enum8
operSt  (analytics:RecordSsx:operSt)
           The runtime state of the object or policy.
analytics:OperStQual
          scalar:Bitmask8
operStQual  (analytics:RecordSsx:operStQual)
           The chassis operational status qualifier.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           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.
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





collectssx

Type: analytics:CollectParamsSsx
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Export parameters for the ssx record
Constants
ingress-q-peak 16ull Ingress Queue Peak Ingress Queue Peak
egress-q-drops 1ull Egress Queue Drops Egress Queue Drops
egress-q-peak 2ull Egress Queue Peak Egress Queue Peak
egress-q-depth 4ull Egress Queue Depth Egress Queue Depth
ingress-q-depth 8ull Ingress Queue Depth Ingress Queue Depth
DEFAULT egress-q-drops(1ull) Egress Queue Drops Egress Queue Drops





descr

Type: naming:Descr
Primitive Type: string:Basic

Overrides:pol:Instr:descr
Paths: 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:
The description of this configuration item.



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





flow_agentCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
analytics:RecordSsxlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
analytics:RecordSsxmodTs_failed_flag 1152921504606846976ull --- NO COMMENTS
analytics:RecordSsxcollectssx_failed_flag 16ull --- NO COMMENTS
analytics:RecordSsxname_failed_flag 1ull --- NO COMMENTS
analytics:RecordSsxuserdom_failed_flag 2305843009213693952ull --- NO COMMENTS
analytics:RecordSsxnameAlias_failed_flag 2ull --- NO COMMENTS
analytics:RecordSsxextMngdBy_failed_flag 32ull --- NO COMMENTS
analytics:RecordSsxuid_failed_flag 4611686018427387904ull --- NO COMMENTS
analytics:RecordSsxdescr_failed_flag 4ull --- NO COMMENTS
analytics:RecordSsxinterval_failed_flag 512ull --- NO COMMENTS
analytics:RecordSsxannotation_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





flow_agentCfgFailedTs

Type: scalar:Time

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



flow_agentCfgState

Type: scalar:UByte

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



interval

Type: analytics:CollIntvl
Primitive Type: scalar:Uint32

Units: ms
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)100l  max: (long)64000l
    Comments:
The time interval in milliseconds that the peer keepalives should be sent.
Constants
defaultValue 100u --- 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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
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 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



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.





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.






uid

Type: scalar:Uint16

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



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS