Class analytics:Profile (CONCRETE)

Class ID:9027
Class Label: Profile
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: 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 ]

Analytics profile

Naming Rules
RN FORMAT: prof-{name}

    [1] PREFIX=prof- PROPERTY = name




DN FORMAT: 

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

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

                


Diagram

Super Mo: pol:Instr,
Container Mos: analytics:Inst (deletable:yes),
Contained Mos: analytics:PayloadLenBin, analytics:RcvWindowSzBin, analytics:TCPOptHdrLenBin,
Relations From: analytics:FwdInstTarget,
Relations: analytics:RtProfAtt,


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:Profile  Analytics profile
[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:Profile  Analytics profile


Contained Hierarchy
[V] analytics:Profile  Analytics profile
 ├
[V] analytics:PayloadLenBin  Payload length bin
 ├
[V] analytics:RcvWindowSzBin  Receive window size bin
 ├
[V] analytics:RtProfAtt  Reference to profile
 ├
[V] analytics:TCPOptHdrLenBin  TCP options header length bin
 ├
[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.


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:Profile  Analytics profile


Events
                analytics:Profile:creation__analytics_Profile
analytics:Profile:modification__analytics_Profile
analytics:Profile:deletion__analytics_Profile


Faults
                


Fsms
                


Properties Summary
Defined in: analytics:Profile
analytics:BurstIntvlShift
          scalar:UByte
burstIntvlShift  (analytics:Profile:burstIntvlShift)
           Burst interval shift
analytics:CollIntvl
          scalar:Uint32
collectIntvl  (analytics:Profile:collectIntvl)
           Collect interval
naming:Descr
          string:Basic
descr  (analytics:Profile:descr)
           Overrides:pol:Instr:descr
          
analytics:IpPktIdShift
          scalar:UByte
ipPktIdShift  (analytics:Profile:ipPktIdShift)
           IP packet id shift
analytics:Mtu
          scalar:Uint16
mtu  (analytics:Profile:mtu)
           Collector export packet MTU
naming:Name
          string:Basic
name  (analytics:Profile:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
          
analytics:NetflowCollIntvl
          scalar:Uint32
netflowCollectorIntvl  (analytics:Profile:netflowCollectorIntvl)
           Collector interval
analytics:ThresholdT
          scalar:Uint32
seqNumGuessThreshHi  (analytics:Profile:seqNumGuessThreshHi)
           Sequence number guess threshold high
analytics:ThresholdT
          scalar:Uint32
seqNumGuessThreshLo  (analytics:Profile:seqNumGuessThreshLo)
           Sequence number guess threshold low
analytics:L4Port
          scalar:Uint32
srcPort  (analytics:Profile:srcPort)
           Source port
analytics:TemplIntvl
          scalar:Uint32
templateIntvl  (analytics:Profile:templateIntvl)
           Template interval
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

burstIntvlShift

Type: analytics:BurstIntvlShift
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)255
    Comments:
Burst interval shift
Constants
defaultValue 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





collectIntvl

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:
Collect interval
Constants
defaultValue 100u --- NO COMMENTS





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.



ipPktIdShift

Type: analytics:IpPktIdShift
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)255
    Comments:
IP packet id shift
Constants
defaultValue 0 --- 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





mtu

Type: analytics:Mtu
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 576  max: 9216
    Comments:
Collector export packet MTU
Constants
defaultValue 1500 --- 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:



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



netflowCollectorIntvl

Type: analytics:NetflowCollIntvl
Primitive Type: scalar:Uint32

Units: s
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)60l  max: (long)36000l
    Comments:
Collector interval
Constants
defaultValue 60u --- 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.



seqNumGuessThreshHi

Type: analytics:ThresholdT
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4294967295l
    Comments:
Sequence number guess threshold high
Constants
defaultValue 0u --- NO COMMENTS





seqNumGuessThreshLo

Type: analytics:ThresholdT
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4294967295l
    Comments:
Sequence number guess threshold low
Constants
defaultValue 0u --- NO COMMENTS





srcPort

Type: analytics:L4Port
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)65535l
    Comments:
Source port



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.






templateIntvl

Type: analytics:TemplIntvl
Primitive Type: scalar:Uint32

Units: s
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)60l  max: (long)64000l
    Comments:
Template interval
Constants
defaultValue 300u --- NO COMMENTS





uid

Type: scalar:Uint16

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