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

Class maint:CatUpgJob (CONCRETE)

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

Specification for catalog policy enforcement status, which exists on every node where the policy is enforced.

Naming Rules 
RN FORMAT: catupgjob

    [1] PREFIX=catupgjob


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/catfwstatuscont/catupgjob

[1] sys/catfwstatuscont/catupgjob


Diagram

Container Mos: firmware:CatFwStatusCont (deletable:yes),


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:CatFwStatusCont The container for managed objects that represent the controller status.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] maint:CatUpgJob Specification for catalog policy enforcement status, which 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:CatFwStatusCont The container for managed objects that represent the controller status.
 
 		 
 		 ├
 		[V] maint:CatUpgJob Specification for catalog policy enforcement status, which exists on every node where the policy is enforced.


Contained Hierarchy
[V] maint:CatUpgJob Specification for catalog policy enforcement status, which exists on every node where the policy is enforced.


Inheritance
[V] maint:CatUpgJob Specification for catalog policy enforcement status, which exists on every node where the policy is enforced.


Events


Faults


Fsms


Properties Summary
Defined in: maint:CatUpgJob
scalar:Date creationDate  (maint:CatUpgJob:creationDate)
           Timestamp when the node was first aware of a maintenance policy i.e.
cap:Version
          string:Basic 		desiredVersion  (maint:CatUpgJob:desiredVersion)
           Desired version.
scalar:Date endDate  (maint:CatUpgJob:endDate)
           Timestamp when the node upgrade completed. i.e.
reference:URI
          string:Basic 		iUrl  (maint:CatUpgJob:iUrl)
           Internal URL of firmware used for upgrade.
naming:Name
          string:Basic 		scheduler  (maint:CatUpgJob:scheduler)
           Name of the associated scheduler policy.
scalar:Date startDate  (maint:CatUpgJob:startDate)
           Timestamp when the node started actual upgrade. i.e.
maint:CatUpgradeStatus
          scalar:Enum8 		upgradeStatus  (maint:CatUpgJob:upgradeStatus)
           Upgrade status of a node where a maintenance policy is being enforced.
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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date 		modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.


iUrl

Type: reference:URI
Primitive Type: string:Basic

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


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




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




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.


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:CatUpgradeStatus
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.
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.
DEFAULT scheduled(0) Scheduled A maintenance is scheduled for this node in future.






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