Class maint:UpgStatus (CONCRETE)

Class ID:388
Class Label: Status of a Maintenance Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, fabric-protocol-util]
Read Access: [admin, fabric-equipment, fabric-protocol-util]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Scheduler - one per maintenance policy. The Administrator can change the status from paused to running. This object exists only on the controller.

Naming Rules
RN FORMAT: maintupgstatus-{polName}

    [1] PREFIX=maintupgstatus- PROPERTY = polName




DN FORMAT: 

[0] maintupgstatuscont/maintupgstatus-{polName}

                


Diagram

Container Mos: maint:UpgStatusCont (deletable:yes),
Contained Mos: maint:NodeInMaint, maint:UpgWindowStats,
Relations To: maint:MaintP,
Relations: maint:RsReltomaintp,


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] maint:UpgStatusCont Container for maintenance policy scheduler status objects.
 
 ├
[V] maint:UpgStatus Scheduler - one per maintenance policy. The Administrator can change the status from paused to running. This object exists only on the controller.


Contained Hierarchy
[V] maint:UpgStatus Scheduler - one per maintenance policy. The Administrator can change the status from paused to running. This object exists only on the controller.
 ├
[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] maint:NodeInMaint A scheduler keeps a list consisting only of nodes with an upgrade in progress. This object is used by the scheduler to keep track of nodes in the installation and only exists on the controller.
 
 ├
[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] maint:RsReltomaintp 
 
 ├
[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] maint:UpgWindowStats The upgrade-related statistics on a per time window basis for the maintenance policy scheduler associated to a set of nodes.


Inheritance
[V] maint:UpgStatus Scheduler - one per maintenance policy. The Administrator can change the status from paused to running. This object exists only on the controller.


Events
                maint:UpgStatus:creation__maint_UpgStatus
maint:UpgStatus:modification__maint_UpgStatus
maint:UpgStatus:deletion__maint_UpgStatus


Faults
                maint:UpgStatus:SchedulerPausedOnClusterHealth
maint:UpgStatus:SchedulerPausedOnMemberUpgradeFailure


Fsms
                


Properties Summary
Defined in: maint:UpgStatus
reference:BinRef faultDelegateKey  (maint:UpgStatus:faultDelegateKey)
          
scalar:Uint32 maxConcurrent  (maint:UpgStatus:maxConcurrent)
           Max concurrent nodes with install in progress.
naming:Name
          string:Basic
polName  (maint:UpgStatus:polName)
           TBD: status is mostly implicit. Only time its set externally is to let a paused job continue.
maint:SchedulerStatus
          scalar:Enum8
runStatus  (maint:UpgStatus:runStatus)
           The run status of the maintenance policy scheduler.
scalar:Bool waitOnClusterHealth  (maint:UpgStatus:waitOnClusterHealth)
           The Waiting for Cluster Convergence message appears if the cluster does not immediately converge and is not fully fit, the upgrade will wait until the cluster converges and is fully fit.
naming:Name
          string:Basic
windowName  (maint:UpgStatus:windowName)
           Name of the window.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

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





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.



faultDelegateKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    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





maxConcurrent

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max concurrent nodes with install in progress.



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





polName

Type: naming:Name
Primitive Type: string:Basic

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:
TBD: status is mostly implicit. Only time its set externally is to let a paused job continue.



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.



runStatus

Type: maint:SchedulerStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The run status of the maintenance policy scheduler.
Constants
running 0 Running Scheduler is running, scheduling maintenance operations in suitable windows.
paused 1 Paused Scheduler is paused, waiting for admin intervention. Admin can resume the scheduler.
DEFAULT running(0) Running Scheduler is running, scheduling maintenance operations in suitable windows.





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.



waitOnClusterHealth

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The Waiting for Cluster Convergence message appears if the cluster does not immediately converge and is not fully fit, the upgrade will wait until the cluster converges and is fully fit.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





windowName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Name of the window.