Class maint:UpgJob (CONCRETE)

Class ID:382
Class Label: Maintenance Upgrade Job for a Node
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-equipment]
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: true, HasHealth: true, HasEventRules: true ]

Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.

Naming Rules
RN FORMAT: upgjob

    [1] PREFIX=upgjob


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ctrlrfwstatuscont/upgjob

[1] sys/ctrlrfwstatuscont/upgjob

[2] topology/pod-{id}/node-{id}/sys/fwstatuscont/upgjob

[3] sys/fwstatuscont/upgjob

                


Diagram

Container Mos: firmware:CtrlrFwStatusCont (deletable:yes), firmware:FwStatusCont (deletable:yes),
Contained Mos: maint:NodeInMaint, maint:UpgJobFault,
Relations To: trig:Window,
Relations: maint:RsWindowStarted,


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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] firmware:CtrlrFwStatusCont Firmware status container object for a controller contains objects that represent the status of the firmware management of a controller.
 
 
 
 
 
 ├
[V] maint:UpgJob Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] firmware:CtrlrFwStatusCont Firmware status container object for a controller contains objects that represent the status of the firmware management of a controller.
 
 
 ├
[V] maint:UpgJob Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] firmware:FwStatusCont The container of managed objects that represent the firmware policy status.
 
 
 
 
 
 ├
[V] maint:UpgJob Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] firmware:FwStatusCont The container of managed objects that represent the firmware policy status.
 
 
 ├
[V] maint:UpgJob Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.


Contained Hierarchy
[V] maint:UpgJob Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] maint:RsWindowStarted A source relation to the container for scheduled windows.
 ├
[V] maint:UpgJobFault 
 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] maint:UpgJob Specification for the maintenance policy enforcement status on a node. This object exists on every node where the policy is enforced.


Events
                maint:UpgJob:maint_UpgJob_upgradeStatus
maint:UpgJob:maint_UpgJob_upgradeStatus
maint:UpgJob:maint_UpgJob_installStage


Faults
                maint:UpgJob:UpgradeFailed


Fsms
                


Properties Summary
Defined in: maint:UpgJob
scalar:Date creationDate  (maint:UpgJob:creationDate)
           Timestamp when the node was first aware of a maintenance policy i.e.
cap:Version
          string:Basic
desiredVersion  (maint:UpgJob:desiredVersion)
           Desired version.
scalar:Date endDate  (maint:UpgJob:endDate)
           Timestamp when the node upgrade completed. i.e.
naming:Name
          string:Basic
fwGrp  (maint:UpgJob:fwGrp)
           Name of the associated firmware group.
naming:Name
          string:Basic
fwPolName  (maint:UpgJob:fwPolName)
           Name of the associated firmware policy.
reference:BinRef grpPriKey  (maint:UpgJob:grpPriKey)
          
reference:URI
          string:Basic
iUrl  (maint:UpgJob:iUrl)
           Internal URL of firmware used for upgrade.
string:Basic installId  (maint:UpgJob:installId)
           Install id - A cookie passed by script invoking the installation.
maint:InstallStage
          scalar:Enum8
installStage  (maint:UpgJob:installStage)
           Installation stage.
maint:InstallProgPercent
          scalar:Uint16
instlProgPct  (maint:UpgJob:instlProgPct)
          
string:Basic internalLabel  (maint:UpgJob:internalLabel)
          
scalar:Date lastInstallDate  (maint:UpgJob:lastInstallDate)
           Timestamp when the node successfully upgraded.
naming:Name
          string:Basic
maintGrp  (maint:UpgJob:maintGrp)
           Name of the associated maintenance group.
reference:BinRef monPolDn  (maint:UpgJob:monPolDn)
           The monitoring policy attached to this observable object.
scalar:Uint32 numAttempts  (maint:UpgJob:numAttempts)
           Number of attempts of upgrade task.
scalar:Uint32 numAttemptsToBootupReady  (maint:UpgJob:numAttemptsToBootupReady)
           Number of attempts, waiting on policy download completion.
naming:Name
          string:Basic
polName  (maint:UpgJob:polName)
           Name of the associated policy.
naming:Name
          string:Basic
scheduler  (maint:UpgJob:scheduler)
           Name of the associated scheduler policy.
cap:Version
          string:Basic
srDesiredVer  (maint:UpgJob:srDesiredVer)
           SR Desired version.
scalar:Bool srUpg  (maint:UpgJob:srUpg)
           SR Upgrade.
scalar:Date startDate  (maint:UpgJob:startDate)
           Timestamp when the node started actual upgrade. i.e.
maint:NodeUpgradeStatus
          scalar:Enum8
upgradeStatus  (maint:UpgJob:upgradeStatus)
           Upgrade status of a node where a maintenance policy is being enforced.
string:Basic upgradeStatusStr  (maint:UpgJob:upgradeStatusStr)
           Upgrade status string.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
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





creationDate

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Timestamp when the node was first aware of a maintenance policy i.e.



desiredVersion

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Desired version.



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.



endDate

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Timestamp when the node upgrade completed. i.e.



fwGrp

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Name of the associated firmware group.



fwPolName

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Name of the associated firmware policy.



grpPriKey

Type: reference:BinRef

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



iUrl

Type: reference:URI
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Internal URL of firmware used for upgrade.



installId

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Install id - A cookie passed by script invoking the installation.



installStage

Type: maint:InstallStage
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Installation stage.
Constants
InstallNotStarted 0 InstallNotStarted Not started
ctrlrPreUpgradePhase 1 Controller Preupgrade phase Controller Preupgrade phase
ctrlrImageVerification 2 Controller Image Verification Image verification
ctrlrPartitionVerification 3 Controller Partition Verification Partition verification
ctrlrImageExtraction 4 Controller Image Extraction Image extraction
ctrlrUpdatingBootorder 5 Updating Grub/efiboot Boot Manager Updating grub/efiboot boot manager
switchCopyImage 10 Copying Images Intentionally leaving some numbers for APIC upgrade stages Switch upgrade: copy images
switchInitializing 11 Initializing Switch upgrade: Initializing
switchExtracting 12 Extracting Switch upgrade: Image extraction
switchVerifying 13 Verification of Images Switch upgrade: Verification of images
switchSrgCollect 14 SRG Collection Switch upgrade: SRG collection
switchSrgProcessing 15 SRG Processing Switch upgrade: SRG processing
switchRuntimeCheck 16 Performing Runtime Checks Switch upgrade: Performing runtime checks
switchSyncImage 17 Syncing Images Switch upgrade: Syncing images to standby
switchUpgLcImage 18 Upgrading Linecard Switch upgrade: Upgrading linecard
switchUpgFex 19 Upgrading Fex Switch upgrade: Upgrading fex
switchPerformReboot 20 Performing reboot Switch upgrade: Performing reboot
DEFAULT InstallNotStarted(0) InstallNotStarted Not started





instlProgPct

Type: maint:InstallProgPercent
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 0 --- NO COMMENTS





internalLabel

Type: string:Basic

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



lastInstallDate

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Timestamp when the node successfully upgraded.



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





maintGrp

Type: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Name of the associated maintenance group.



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:
The monitoring policy attached to this observable object.



numAttempts

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Number of attempts of upgrade task.



numAttemptsToBootupReady

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Number of attempts, waiting on policy download completion.



polName

Type: naming:Name
Primitive Type: string:Basic

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



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: naming:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Name of the associated scheduler policy.



srDesiredVer

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SR Desired version.



srUpg

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SR Upgrade.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





startDate

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Timestamp when the node started actual upgrade. i.e.



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.






upgradeStatus

Type: maint:NodeUpgradeStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Upgrade status of a node where a maintenance policy is being enforced.
Constants
scheduled 0 Scheduled A maintenance is scheduled for this node in future.
inqueue 1 In Queue Node is polling the scheduler(running on IFC) to obtain permission to upgrade.
inprogress 2 In Progress Node is upgrading its firmware.
completeok 4 Completed Successfully Node has completed upgrade to desired firmware.
completenok 5 Failed Upgrade failed, and the node is either running last firmware before upgrade or golden firmware.
notscheduled 6 No Maintenance Scheduled A maintenance is not scheduled for this node in future.
incompatible 7 Failed Due to Incompatible Desired Version Firmware version is not compatible
inretryqueue 8 Queued for Retry Queued for retry
waitonbootup 9 Waiting on bootup completion Node is waiting for bootup readiness(all policies downloaded)
downloadimgmmode 10 Downloading image in Maintenance Mode Download status for firmware in maintenence mode.
DEFAULT scheduled(0) Scheduled A maintenance is scheduled for this node in future.





upgradeStatusStr

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Upgrade status string.