Class analytics:RecordP (CONCRETE)

Class ID:9020
Class Label: Flow 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: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Flow Record

Naming Rules
RN FORMAT: recordp-{name}

    [1] PREFIX=recordp- PROPERTY = name




DN FORMAT: 

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

[1] sys/analytics/inst-{mode}/recordp-{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:RtRecordPAtt,


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:RecordP  Flow 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:RecordP  Flow Record


Contained Hierarchy
[V] analytics:RecordP  Flow 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:RtRecordPAtt  Relation to record
 ├
[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 


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:RecordP  Flow Record


Events
                analytics:RecordP:creation__analytics_RecordP
analytics:RecordP:modification__analytics_RecordP
analytics:RecordP:deletion__analytics_RecordP


Faults
                analytics:RecordP:recordFailure


Fsms
                


Properties Summary
Defined in: analytics:RecordP
mo:Annotation
          string:Basic
annotation  (analytics:RecordP:annotation)
           NO COMMENTS
analytics:CollectParams
          scalar:Bitmask64
collect  (analytics:RecordP:collect)
           Collect parameters for the flow record
naming:Descr
          string:Basic
descr  (analytics:RecordP:descr)
           Overrides:pol:Instr:descr
          
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (analytics:RecordP:extMngdBy)
           NO COMMENTS
analytics:MatchParams
          scalar:Bitmask64
match  (analytics:RecordP:match)
           Match parameters for the flow record
reference:BinRef monPolDn  (analytics:RecordP:monPolDn)
           Monitoring policy attached to this observable object
naming:Name
          string:Basic
name  (analytics:RecordP:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
          
scalar:Bitmask64 nfmCfgFailedBmp  (analytics:RecordP:nfmCfgFailedBmp)
           NO COMMENTS
scalar:Time nfmCfgFailedTs  (analytics:RecordP:nfmCfgFailedTs)
           NO COMMENTS
scalar:UByte nfmCfgState  (analytics:RecordP:nfmCfgState)
           NO COMMENTS
analytics:OperSt
          scalar:Enum8
operSt  (analytics:RecordP:operSt)
           The runtime state of the object or policy.
analytics:OperStQual
          scalar:Bitmask8
operStQual  (analytics:RecordP:operStQual)
           The chassis operational status qualifier.
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

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





collect

Type: analytics:CollectParams
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Collect parameters for the flow record
Constants
src-intf 128ull Source Interface Source interface
ts-first 16ull First pkt timestamp First packet timestamp
count-bytes 1ull Bytes counter Bytes counter
count-pkts 2ull Pkts counter Packets counter
ts-recent 32ull Recent pkt timestamp Recent packet timestamp
sampler-id 4ull Sampler ID Sampler Id
tcp-flags 64ull TCP flags TCP flags
pkt-disp 8ull Pkt disposition Packet disposition
DEFAULT src-intf(128ull) Source Interface Source interface





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:



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





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





match

Type: analytics:MatchParams
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Match parameters for the flow record
Constants
unspecified 0ull Unspecified Unspecified
src-port 1024ull Source Port Source port
dst-ipv4 128ull Destination IPv4 Destination IPv4
proto 16ull IP Protocol IP protocol
ethertype 1ull Ethertype Ethertype
dst-port 2048ull Destination Port Destination port
src-ipv6 256ull Source IPv6 Source IPv6
dst-mac 2ull Destination MAC Destination MAC
tos 32ull IP TOS IP type of service
src-ip 4096ull Source IPv4/6 Source IPv4/v6
src-mac 4ull Source MAC Source MAC
dst-ipv6 512ull Destination IPv6 Destination IPv6
src-ipv4 64ull Source IPv4 Source IPv4
dst-ip 8192ull Destination IPv4/6 Destination IPv4/v6
vlan 8ull VLAN VLAN
DEFAULT unspecified(0ull) Unspecified Unspecified





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



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:



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



nfmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
analytics:RecordPlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
analytics:RecordPmonPolDn_failed_flag 128ull --- NO COMMENTS
analytics:RecordPcollect_failed_flag 16ull --- NO COMMENTS
analytics:RecordPname_failed_flag 1ull --- NO COMMENTS
analytics:RecordPmodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
analytics:RecordPnameAlias_failed_flag 2ull --- NO COMMENTS
analytics:RecordPextMngdBy_failed_flag 32ull --- NO COMMENTS
analytics:RecordPuid_failed_flag 4611686018427387904ull --- NO COMMENTS
analytics:RecordPdescr_failed_flag 4ull --- NO COMMENTS
analytics:RecordPmatch_failed_flag 64ull --- NO COMMENTS
analytics:RecordPannotation_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.





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.