Class diag:SrvCtrl (CONCRETE)

Class ID:896
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, pn-equipment, pn-maintenance]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.33.6

NO COMMENTS


Naming Rules
RN FORMAT: diag

    [1] PREFIX=diag


DN FORMAT: 

[0] sys/chassis-[id]/blade-[slotId]/diag

[1] sys/rack-unit-[id]/diag

[2] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/diag

[3] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/diag

                



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.
 
 ├
compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.
 
 
 ├
diag:SrvCtrl
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.
 
 ├
equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 
 ├
compute:Blade A physical compute blade. Physical compute item in blade form factor.
 
 
 
 ├
diag:SrvCtrl
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.
 
 ├
equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 
 ├
compute:Cartridge A physical compute cartridge.
 
 
 
 ├
compute:ServerUnit A server instance on a cartridge.
 
 
 
 
 ├
diag:SrvCtrl


Contained Hierarchy
diag:SrvCtrl
 ├
diag:Rslt
 
 ├
diag:LogEp
 ├
diag:RunPolicy
 
 ├
diag:Test
 ├
ether:ServerIntFIo Represents a server-facing physical Ethernet port on an IO Card. IO Modules on a UCS chassis and IO modules on a FEX have Ethernet ports that are connected to a Fabric Interconnect and Ethernet ports that are connected to the servers. This object represents the Ethernet ports on the IO Card that are connected to the servers.
 
 ├
equipment:Xcvr
 
 ├
ether:ErrStats
 
 
 ├
ether:ErrStatsHist
 
 ├
ether:LossStats
 
 
 ├
ether:LossStatsHist
 
 ├
ether:PauseStats
 
 
 ├
ether:PauseStatsHist
 
 ├
ether:RxStats
 
 
 ├
ether:RxStatsHist
 
 ├
ether:ServerIntFIoFsm
 
 
 ├
ether:ServerIntFIoFsmStage
 
 ├
ether:ServerIntFIoFsmTask
 
 ├
ether:TxStats
 
 
 ├
ether:TxStatsHist
 
 ├
event:Inst
 
 ├
fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
 
 ├
lldp:Acquired
 
 ├
port:DomainEp
 
 ├
port:TrustMode
 
 ├
sw:Ulan

Inheritance
diag:Ctrl
 ├
diag:SrvCtrl

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: diag:SrvCtrl
diag:Progress
          scalar:UByte
overallProgress  (diag:SrvCtrl:overallProgress)
           NO COMMENTS
diag:RunPolicyName
          string:Basic
runPolicyName  (diag:SrvCtrl:runPolicyName)
           Name reference to run policy
Defined in: diag:Ctrl
diag:AdminState
          scalar:Enum8
adminState  (diag:Ctrl:adminState)
           NO COMMENTS
diag:TestTime
          scalar:Date
endTs  (diag:Ctrl:endTs)
           NO COMMENTS
diag:TestTimeMonotonic
          scalar:Uint64
endTsM  (diag:Ctrl:endTsM)
           NO COMMENTS
string:Basic errorDescr  (diag:Ctrl:errorDescr)
           NO COMMENTS
diag:StatusIssues
          scalar:Bitmask64
operQualifier  (diag:Ctrl:operQualifier)
           NO COMMENTS
diag:Status
          scalar:Enum8
operState  (diag:Ctrl:operState)
           NO COMMENTS
diag:TestTime
          scalar:Date
startTs  (diag:Ctrl:startTs)
           NO COMMENTS
diag:TestTimeMonotonic
          scalar:Uint64
startTsM  (diag:Ctrl:startTsM)
           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

adminState

Type: diag:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
ready 0 NO COMMENTS
trigger 1 transient
cancel 2 transient
DEFAULT ready(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

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" />

endTs

Type: diag:TestTime
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT never(0ull) NO COMMENTS

endTsM

Type: diag:TestTimeMonotonic
Primitive Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT never(0ull) NO COMMENTS

errorDescr

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

operQualifier

Type: diag:StatusIssues
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
not-applicable 0ull NO COMMENTS
stage-failed 16ull NO COMMENTS
test-failure 1ull NO COMMENTS
run-cancelled 2ull NO COMMENTS
component-error 4ull NO COMMENTS
stages-completed 8ull NO COMMENTS
DEFAULT not-applicable(0ull) NO COMMENTS

operState

Type: diag:Status
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
idle 1 NO COMMENTS
completed 2 NO COMMENTS
in-progress 3 NO COMMENTS
failed 4 NO COMMENTS
cancelled 5 NO COMMENTS
DEFAULT idle(1) NO COMMENTS

overallProgress

Type: diag:Progress
Primitive Type: scalar:UByte
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)100
Comments:
NO COMMENTS
Constants
defaultValue 0 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 ="../" />

runPolicyName

Type: diag:RunPolicyName
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
Name reference to run policy
Constants
defaultValue "default" NO COMMENTS

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

startTs

Type: diag:TestTime
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT never(0ull) NO COMMENTS

startTsM

Type: diag:TestTimeMonotonic
Primitive Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT never(0ull) 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.