Class sysdebug:TechSupportCmdOpt (CONCRETE)

Class ID:1022
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, operations]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.125.20

Mo holding the command options for a tech support file creation.


Naming Rules
RN FORMAT: tech-support-cmd-opt

    [1] PREFIX=tech-support-cmd-opt


DN FORMAT: 

[0] sys/tech-support-files/tech-support-[creationTS]/tech-support-cmd-opt

                



Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
top:System Provides general information about this system, such as the name, IP address and current time.
 
 ├
sysdebug:TechSupFileRepository Repository for tech-support files
 
 
 ├
sysdebug:TechSupport A tech-support file.
 
 
 
 ├
sysdebug:TechSupportCmdOpt


Contained Hierarchy
sysdebug:TechSupportCmdOpt

Inheritance
sysdebug:TechSupportCmdOpt

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: sysdebug:TechSupportCmdOpt
sysdebug:TSCmdOptCartridgeCIMCId
          scalar:Uint16
cartridgeCIMCId  (sysdebug:TechSupportCmdOpt:cartridgeCIMCId)
           NO COMMENTS
sysdebug:TSCmdOptChassisCartridgeId
          scalar:Uint16
chassisCartridgeId  (sysdebug:TechSupportCmdOpt:chassisCartridgeId)
           NO COMMENTS
sysdebug:TSCmdOptChassisCIMCId
          scalar:Uint16
chassisCimcId  (sysdebug:TechSupportCmdOpt:chassisCimcId)
           NO COMMENTS
sysdebug:TSCmdOptChassisId
          scalar:Uint16
chassisId  (sysdebug:TechSupportCmdOpt:chassisId)
           NO COMMENTS
sysdebug:TSCmdOptChassisIOMId
          scalar:Uint16
chassisIomId  (sysdebug:TechSupportCmdOpt:chassisIomId)
           NO COMMENTS
sysdebug:TSCmdOptChassisCIMCAdapterId
          scalar:Uint16
cimcAdapterId  (sysdebug:TechSupportCmdOpt:cimcAdapterId)
           NO COMMENTS
sysdebug:TSCmdOptCmdOptions
          scalar:Bitmask32
commandOptions  (sysdebug:TechSupportCmdOpt:commandOptions)
           NO COMMENTS
sysdebug:TSCmdOptFexId
          scalar:Uint16
fabExtId  (sysdebug:TechSupportCmdOpt:fabExtId)
           NO COMMENTS
sysdebug:TSCmdOptMajorType
          scalar:Enum8
majorOptType  (sysdebug:TechSupportCmdOpt:majorOptType)
           NO COMMENTS
sysdebug:TSCmdOptServerAdapterId
          scalar:Uint16
rackServerAdapterId  (sysdebug:TechSupportCmdOpt:rackServerAdapterId)
           NO COMMENTS
sysdebug:TSCmdOptServerId
          scalar:Uint16
rackServerId  (sysdebug:TechSupportCmdOpt:rackServerId)
           NO COMMENTS
sysdebug:TSCmdOptServerIdList
          string:Basic
serverIdList  (sysdebug:TechSupportCmdOpt:serverIdList)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8
sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           This property controls the life cycle of a managed object

Properties Detail

cartridgeCIMCId

Type: sysdebug:TSCmdOptCartridgeCIMCId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 2
Comments:
NO COMMENTS
Constants
defaultValue 1 NO COMMENTS

chassisCartridgeId

Type: sysdebug:TSCmdOptChassisCartridgeId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 8
Comments:
NO COMMENTS
Constants
all 0 NO COMMENTS
DEFAULT all(0) NO COMMENTS

chassisCimcId

Type: sysdebug:TSCmdOptChassisCIMCId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 8
Comments:
NO COMMENTS
Constants
all 0 NO COMMENTS
DEFAULT all(0) NO COMMENTS

chassisId

Type: sysdebug:TSCmdOptChassisId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 255
Comments:
NO COMMENTS
Constants
defaultValue 1 NO COMMENTS

chassisIomId

Type: sysdebug:TSCmdOptChassisIOMId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 2
Comments:
NO COMMENTS
Constants
all 0 NO COMMENTS
DEFAULT all(0) NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:
Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

cimcAdapterId

Type: sysdebug:TSCmdOptChassisCIMCAdapterId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 8
Comments:
NO COMMENTS
Constants
all 0 NO COMMENTS
DEFAULT all(0) NO COMMENTS

commandOptions

Type: sysdebug:TSCmdOptCmdOptions
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
ucsm-exclude-commands 1u NO COMMENTS
ucsm-include-fi-detail 2u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:
Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

fabExtId

Type: sysdebug:TSCmdOptFexId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 255
Comments:
NO COMMENTS
Constants
defaultValue 1 NO COMMENTS

majorOptType

Type: sysdebug:TSCmdOptMajorType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
chassis 0 Techical support data for a UCS blade chassis
fex 1 Techical support data for a Fabric Extender
server 2 Techical support data for a rack server
ucsm 3 Techical support data for the entire UCSM instance
ucsm-mgmt 4 Techical support data for the UCSM management services (excluding fabric interconnects)
server-memory 5 NO COMMENTS
DEFAULT ucsm(3) Techical support data for the entire UCSM instance

rackServerAdapterId

Type: sysdebug:TSCmdOptServerAdapterId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 8
Comments:
NO COMMENTS
Constants
all 0 NO COMMENTS
DEFAULT all(0) NO COMMENTS

rackServerId

Type: sysdebug:TSCmdOptServerId
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 255
Comments:
NO COMMENTS
Constants
defaultValue 1 NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:
Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:
Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

serverIdList

Type: sysdebug:TSCmdOptServerIdList
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:
Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.