Class analytics:FwdInstTarget (CONCRETE)

Class ID:8289
Class Label: Forward Instance Target
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: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

Forwarding instance based target

Naming Rules
RN FORMAT: fwdinst-{id}

    [1] PREFIX=fwdinst- PROPERTY = id




DN FORMAT: 

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

[1] sys/analytics/inst-{mode}/fwdinst-{id}

                


Diagram

Super Mo: analytics:Target,
Container Mos: analytics:Inst (deletable:yes),
Relations To: analytics:Monitor, analytics:Policy, analytics:Profile,
Relations: analytics:RsMonitorAtt, analytics:RsPolicyAtt, analytics:RsProfAtt,


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:FwdInstTarget  Forwarding instance based target
[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:FwdInstTarget  Forwarding instance based target


Contained Hierarchy
[V] analytics:FwdInstTarget  Forwarding instance based target
 ├
[V] analytics:RsMonitorAtt  Reference to monitor
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] analytics:RsPolicyAtt  Reference to policy
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] analytics:RsProfAtt  Reference to profile
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[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] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] analytics:Target  Abstract target
 ├
[V] analytics:FwdInstTarget  Forwarding instance based target


Events
                analytics:FwdInstTarget:creation__analytics_FwdInstTarget
analytics:FwdInstTarget:modification__analytics_FwdInstTarget
analytics:FwdInstTarget:deletion__analytics_FwdInstTarget


Faults
                


Fsms
                


Properties Summary
Defined in: analytics:FwdInstTarget
analytics:DefPolicyT
          scalar:Enum8
DefPolicy  (analytics:FwdInstTarget:DefPolicy)
           Default filtering policy
analytics:CollectorId
          scalar:Uint32
collectorId  (analytics:FwdInstTarget:collectorId)
           Collector identifier provided by the analytics controller
analytics:FwdInstTargetId
          scalar:Uint32
id  (analytics:FwdInstTarget:id)
           Identifier
reference:BinRef monPolDn  (analytics:FwdInstTarget:monPolDn)
           Monitoring policy attached to this observable object
analytics:ResolutionFactor
          scalar:UByte
resFactor  (analytics:FwdInstTarget:resFactor)
           Tetration Latency Resolution Factor
Defined in: analytics:Target
analytics:DirectionT
          scalar:Enum8
dir  (analytics:Target:dir)
           Direction
analytics:FltType
          scalar:Enum8
fltType  (analytics:Target:fltType)
           IP filter type
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

DefPolicy

Type: analytics:DefPolicyT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Default filtering policy
Constants
permit 0 Permit Permit
deny 1 Deny Deny
DEFAULT permit(0) Permit Permit





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





collectorId

Type: analytics:CollectorId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)65535l
    Comments:
Collector identifier provided by the analytics controller



dir

Type: analytics:DirectionT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Direction
Constants
in 1 Ingress Ingress
out 2 Egress Egress
both 3 Both Both
DEFAULT in(1) Ingress Ingress





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.



fltType

Type: analytics:FltType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
IP filter type
Constants
ipv4 1 Ipv4 type Ipv4 filter type
ipv6 2 Ipv6 type Ipv6 filter type
ce 3 CE type CE filter type
DEFAULT ipv4(1) Ipv4 type Ipv4 filter type





id

Type: analytics:FwdInstTargetId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)16777215l
    Comments:
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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Monitoring policy attached to this observable object



resFactor

Type: analytics:ResolutionFactor
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Tetration Latency Resolution Factor



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.