Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class firmware:SystemFsmStage (CONCRETE)

Class ID:1598
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

NO COMMENTS

Naming Rules 
RN FORMAT: stage-[name]

    [1] PREFIX=stage- PROPERTY = name




DN FORMAT: 

[0] sys/fw-system/fsm/stage-[name]


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.
 
 		 ├
 		firmware:System Represents system firmware. i.e, the firmware package for the whole system
 
 		 
 		 ├
 		firmware:SystemFsm
 
 		 
 		 
 		 ├
 		firmware:SystemFsmStage


Contained Hierarchy
firmware:SystemFsmStage
Inheritance
fsm:Stage
 ├
 		firmware:SystemFsmStage
Events


Faults


Fsms


Properties Summary
Defined in: firmware:SystemFsmStage
fsm:FsmStage
          scalar:Enum32 		name  (firmware:SystemFsmStage:name)
           Overrides:fsm:Stage:name
           NO COMMENTS
Defined in: fsm:Stage
naming:Descr
          string:Basic 		descr  (fsm:Stage:descr)
           NO COMMENTS
fsm:DateTime
          scalar:Date 		lastUpdateTime  (fsm:Stage:lastUpdateTime)
           NO COMMENTS
scalar:Uint16 order  (fsm:Stage:order)
           NO COMMENTS
scalar:UByte retry  (fsm:Stage:retry)
           NO COMMENTS
fsm:FsmStageStatus
          scalar:Enum8 		stageStatus  (fsm:Stage:stageStatus)
           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

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

descr

Type: naming:Descr
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+

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

lastUpdateTime

Type: fsm:DateTime
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
0ull NO COMMENTS
defaultValue 0 NO COMMENTS

name

Type: fsm:FsmStage
Primitive Type: scalar:Enum32
Overrides:fsm:Stage:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
nop 0u NO COMMENTS
DeployBegin 1308u NO COMMENTS
DeployWaitForDeploy 1309u NO COMMENTS
DeployResolveDistributableNames 1310u NO COMMENTS
DeployResolveDistributable 1311u NO COMMENTS
DeployResolveImages 1312u NO COMMENTS
DeployActivateUCSM 1313u NO COMMENTS
DeployPollActivateOfUCSM 1314u NO COMMENTS
DeployUpdateIOM 1315u NO COMMENTS
DeployPollUpdateOfIOM 1316u NO COMMENTS
DeployActivateIOM 1317u NO COMMENTS
DeployPollActivateOfIOM 1318u NO COMMENTS
DeployActivateRemoteFI 1319u NO COMMENTS
DeployPollActivateOfRemoteFI 1320u NO COMMENTS
DeployWaitForUserAck 1321u NO COMMENTS
DeployActivateLocalFI 1322u NO COMMENTS
DeployPollActivateOfLocalFI 1323u NO COMMENTS
ApplyCatalogPackBegin 1324u NO COMMENTS
ApplyCatalogPackResolveDistributableNames 1325u NO COMMENTS
ApplyCatalogPackResolveDistributable 1326u NO COMMENTS
ApplyCatalogPackResolveImages 1327u NO COMMENTS
ApplyCatalogPackActivateCatalog 1328u NO COMMENTS
ApplyCatalogPackFail 1404u NO COMMENTS
ApplyCatalogPackSuccess 1405u NO COMMENTS
DeployFail 1406u NO COMMENTS
DeploySuccess 1407u NO COMMENTS
DeployInternalBackup 1937u NO COMMENTS
DeployPollInternalBackup 1938u NO COMMENTS
DeployPollWaitForUserAck 1963u NO COMMENTS
DeployDownloadImages 1995u NO COMMENTS
DeployCopyAllImagesToPeer 1996u NO COMMENTS
DeployFabEvacOnRemoteFI 2201u NO COMMENTS
DeployPollFabEvacOnRemoteFI 2202u NO COMMENTS
DeployFabEvacOffRemoteFI 2203u NO COMMENTS
DeployPollFabEvacOffRemoteFI 2204u NO COMMENTS
DeployFailOverToRemoteFI 2205u NO COMMENTS
DeployPollFailOverToRemoteFI 2206u NO COMMENTS
DeployActivateUCSMServicePack 2207u NO COMMENTS
DeployPollActivateOfUCSMServicePack 2208u NO COMMENTS
DEFAULT nop(0u) NO COMMENTS

order

Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

retry

Type: scalar:UByte
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
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

stageStatus

Type: fsm:FsmStageStatus
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
fail 0 NO COMMENTS
success 1 NO COMMENTS
skip 2 NO COMMENTS
pending 3 NO COMMENTS
inProgress 4 NO COMMENTS
throttled 5 NO COMMENTS
nop 255 NO COMMENTS
DEFAULT pending(3) 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.

Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming