Class troubleshoot:Session (CONCRETE)

Class ID:6241
Class Label: Troubleshoot session MO
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, ops]
Read Access: [admin, ops]
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 ]

****************** MOs *********************

Naming Rules
RN FORMAT: session-{name}

    [1] PREFIX=session- PROPERTY = name




DN FORMAT: 

[1] uni/fabric/session-{name}

                


Diagram

Super Mo: trig:Executable,
Container Mos: fabric:Inst (deletable:yes),
Contained Mos: troubleshoot:SpanPktUrl,
Relations From: pol:DefRelnHolder,
Relations To: trig:Triggerable, trig:SchedP,
Relations: trig:RsTriggerable, troubleshoot:RsSessionScheduler, troubleshoot:RtTroubleshootSessionRel,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] troubleshoot:Session  ****************** MOs *********************
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] troubleshoot:Session  ****************** MOs *********************


Contained Hierarchy
[V] troubleshoot:Session  ****************** MOs *********************
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] trig:RsTriggerable A source relation to the container for a triggerable object.
 
 ├
[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] troubleshoot:RsSessionScheduler  Relation from session to scheduler 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] troubleshoot:RtTroubleshootSessionRel 
 ├
[V] troubleshoot:SpanPktUrl  Span Packet Capture URL


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:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] trig:Executable The container for executable policies.
 
 
 
 ├
[V] troubleshoot:Session  ****************** MOs *********************


Events
                trig:Executable:trig_Executable_execTrig
troubleshoot:Session:creation__troubleshoot_Session
troubleshoot:Session:modification__troubleshoot_Session
troubleshoot:Session:deletion__troubleshoot_Session


Faults
                


Fsms
                


Properties Summary
Defined in: troubleshoot:Session
string:Basic analyzerIP  (troubleshoot:Session:analyzerIP)
          
scalar:Date createTime  (troubleshoot:Session:createTime)
          
string:Basic dstEP  (troubleshoot:Session:dstEP)
          
string:Basic dstExtIP  (troubleshoot:Session:dstExtIP)
          
string:Basic dstExtMac  (troubleshoot:Session:dstExtMac)
          
string:Basic dstExtOut  (troubleshoot:Session:dstExtOut)
          
string:Basic dstIP  (troubleshoot:Session:dstIP)
          
string:Basic dstMAC  (troubleshoot:Session:dstMAC)
          
scalar:Date endTime  (troubleshoot:Session:endTime)
          
troubleshoot:Format
          scalar:Enum8
format  (troubleshoot:Session:format)
          
string:Basic internalType  (troubleshoot:Session:internalType)
           NO COMMENTS
scalar:Bool isDstRemote  (troubleshoot:Session:isDstRemote)
           Flag to tell if destination end point is on remote site
scalar:Bool isSrcRemote  (troubleshoot:Session:isSrcRemote)
           Flag to tell if source end point is on remote site
scalar:Uint32 latestMin  (troubleshoot:Session:latestMin)
          
reference:BinRef monPolDn  (troubleshoot:Session:monPolDn)
           Monitoring policy attached to this observable object
span:Mtu
          scalar:Uint16
mtu  (troubleshoot:Session:mtu)
          
naming:Name
          string:Basic
name  (troubleshoot:Session:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
          
string:Basic scheduler  (troubleshoot:Session:scheduler)
          
string:Basic spanSrcPrefix  (troubleshoot:Session:spanSrcPrefix)
          
string:Basic spanStartApicId  (troubleshoot:Session:spanStartApicId)
          
string:Basic srcEP  (troubleshoot:Session:srcEP)
          
string:Basic srcExtIP  (troubleshoot:Session:srcExtIP)
          
string:Basic srcExtMac  (troubleshoot:Session:srcExtMac)
          
string:Basic srcExtOut  (troubleshoot:Session:srcExtOut)
          
string:Basic srcIP  (troubleshoot:Session:srcIP)
          
string:Basic srcMAC  (troubleshoot:Session:srcMAC)
          
scalar:Date startTime  (troubleshoot:Session:startTime)
          
string:Basic type  (troubleshoot:Session:type)
          
Defined in: trig:Executable
trig:ExecState
          scalar:Enum8
adminSt  (trig:Executable:adminSt)
           The administrative state of the executable policies.
trig:TriggerCount
          scalar:Uint32
seqNum  (trig:Executable:seqNum)
           An ISIS link-state packet sequence number.
trig:DateTime
          scalar:Date
triggerTime  (trig:Executable:triggerTime)
           null
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
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

adminSt

Type: trig:ExecState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The administrative state of the executable policies.
Constants
untriggered 0 No NO COMMENTS
triggered 1 Yes NO COMMENTS
DEFAULT untriggered(0) No NO COMMENTS





analyzerIP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    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





createTime

Type: scalar:Date

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



descr

Type: naming:Descr
Primitive Type: string:Basic

Like: 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:
Specifies the description of a policy component.



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.



dstEP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



dstExtIP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



dstExtMac

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



dstExtOut

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



dstIP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



dstMAC

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



endTime

Type: scalar:Date

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
unspecified 0ull unspecified NO COMMENTS
DEFAULT unspecified(0ull) unspecified NO COMMENTS





format

Type: troubleshoot:Format
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
json 0 json NO COMMENTS
xml 1 xml NO COMMENTS
txt 2 txt NO COMMENTS
pdf 3 pdf NO COMMENTS
html 4 html NO COMMENTS
DEFAULT pdf(3) pdf NO COMMENTS





internalType

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS



isDstRemote

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Flag to tell if destination end point is on remote site
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





isSrcRemote

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Flag to tell if source end point is on remote site
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





latestMin

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)5l  max: (long)525600l
    Comments:
Constants
unspecified 0u unspecified NO COMMENTS
defaultValue 240u --- 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



mtu

Type: span:Mtu
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 64  max: 9216
    Comments:
Constants
defaultValue 1518 --- 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



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.



scheduler

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



seqNum

Type: trig:TriggerCount
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An ISIS link-state packet sequence number.
Constants
defaultValue 0u --- NO COMMENTS





spanSrcPrefix

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



spanStartApicId

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



srcEP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



srcExtIP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



srcExtMac

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



srcExtOut

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



srcIP

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



srcMAC

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



startTime

Type: scalar:Date

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
unspecified 0ull unspecified NO COMMENTS
DEFAULT unspecified(0ull) unspecified NO COMMENTS





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.






triggerTime

Type: trig:DateTime
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null



type

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:



uid

Type: scalar:Uint16

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