Class maint:CtrlrMaintP (CONCRETE)

Class ID:390
Class Label: Controller Maintenance Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, fabric-protocol-util]
Read Access: [admin, fabric-protocol-util]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

The controller maintenance policy specification describes when and how maintenance takes place.

Naming Rules
RN FORMAT: ctrlrmaintpol

    [1] PREFIX=ctrlrmaintpol


DN FORMAT: 

[1] uni/controller/ctrlrmaintpol

                


Diagram

Super Mo: maint:AMaintP,
Container Mos: ctrlr:Inst (deletable:no),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: pol:DefRelnHolder,
Relations To: trig:SchedP, trig:Triggerable,
Relations: maint:RsPolCtrlrScheduler, maint:RtAectrlrmaintp, trig:RsTriggerable,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] ctrlr:Inst An instance of the controller.
 
 
 
 
 
 
 
 ├
[V] maint:CtrlrMaintP The controller maintenance policy specification describes when and how maintenance takes place.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] ctrlr:Inst An instance of the controller.
 
 
 ├
[V] maint:CtrlrMaintP The controller maintenance policy specification describes when and how maintenance takes place.


Contained Hierarchy
[V] maint:CtrlrMaintP The controller maintenance policy specification describes when and how maintenance takes place.
 ├
[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] 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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] maint:RsPolCtrlrScheduler A source relation to the scheduler policy.
 
 ├
[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] 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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] maint:RtAectrlrmaintp A target relation to the controller maintenance policy.
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 
 ├
[V] trig:RsTriggerable A source relation to the container for a triggerable object.
 
 ├
[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] 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] tag:Annotation 
 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] trig:Executable The container for executable policies.
 
 
 
 ├
[V] maint:AMaintP The maintenance policy specifies when and how maintenance takes place.
 
 
 
 
 ├
[V] maint:CtrlrMaintP The controller maintenance policy specification describes when and how maintenance takes place.


Events
                maint:CtrlrMaintP:creation__maint_CtrlrMaintP
maint:CtrlrMaintP:modification__maint_CtrlrMaintP
maint:CtrlrMaintP:deletion__maint_CtrlrMaintP
trig:Executable:trig_Executable_execTrig


Faults
                


Fsms
                


Properties Summary
Defined in: maint:CtrlrMaintP
firmware:AdminStatus
          scalar:Enum8
adminState  (maint:CtrlrMaintP:adminState)
          
mo:Annotation
          string:Basic
annotation  (maint:CtrlrMaintP:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (maint:CtrlrMaintP:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (maint:CtrlrMaintP:monPolDn)
           The monitoring policy attached to this observable object.
scalar:Bool parallel  (maint:CtrlrMaintP:parallel)
           Flag to turn on parallel upgrade of APICs, trades off availability to speed.
Defined in: maint:AMaintP
scalar:Bool graceful  (maint:AMaintP:graceful)
           Graceful maintenance. Describe graceful maintenance
scalar:Bool ignoreCompat  (maint:AMaintP:ignoreCompat)
           A property that specifies whether compatibility checks should be ignored when applying the firmware policy.
string:Basic internalLabel  (maint:AMaintP:internalLabel)
           The firmware label. This is for internal use only.
maint:NotifCond
          scalar:Enum8
notifCond  (maint:AMaintP:notifCond)
           Specifies under what pause condition will admin be notified via email/text as configured. This notification mechanism is independent of events/faults.
maint:RunMode
          scalar:Enum8
runMode  (maint:AMaintP:runMode)
           Specifies whether to proceed automatically to next set of nodes once a set of nodes have gone through maintenance successfully.
scalar:Bool srUpgrade  (maint:AMaintP:srUpgrade)
           NO COMMENTS
cap:Version
          string:Basic
srVersion  (maint:AMaintP:srVersion)
           srFirmware version desired.
cap:Version
          string:Basic
version  (maint:AMaintP:version)
           The version of the compatibility catalog.
trig:AdminState
          scalar:Enum8
versionCheckOverride  (maint:AMaintP:versionCheckOverride)
           The version check override. This is a directive to ignore the version check for the next install. The version check, which occurs during a maintenance window, checks to see if the desired version matches the running version. If the versions do not match, the install is performed. If the versions do match, the install is not performed. The version check override is a one-time override that performs the install whether or not the versions match.
Defined in: trig:Executable
trig:ExecState
          scalar:Enum8
adminSt  (trig:Executable:adminSt)
           The administrative state of the executable policies.
scalar:Bool internalSource  (trig:Executable:internalSource)
           NO COMMENTS
trig:TriggerCount
          scalar:Uint32
seqNum  (trig:Executable:seqNum)
           An ISIS link-state packet sequence number.
trig:DateTime
          scalar:Date
triggerTime  (trig:Executable:triggerTime)
           null
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

adminSt

Type: trig:ExecState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The administrative state of the executable policies.
Constants
untriggered 0 No NO COMMENTS
triggered 1 Yes NO COMMENTS
DEFAULT untriggered(0) No NO COMMENTS





adminState

Type: firmware:AdminStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
up 0 Up NO COMMENTS
down 1 Down NO COMMENTS
DEFAULT up(0) Up NO COMMENTS





annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





graceful

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Graceful maintenance. Describe graceful maintenance
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





ignoreCompat

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A property that specifies whether compatibility checks should be ignored when applying the firmware policy.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





internalLabel

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The firmware label. This is for internal use only.



internalSource

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO 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





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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



notifCond

Type: maint:NotifCond
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Specifies under what pause condition will admin be notified via email/text as configured. This notification mechanism is independent of events/faults.
Constants
notifyOnlyOnFailures 0 notifyOnlyOnFailures Notify admin after a maintenance set, only if there were failures in the set.
notifyAlwaysBetweenSets 1 notifyAlwaysBetweenSets Always notify admin after a maintenance set.
notifyNever 2 notifyNever Never notify admin after a maintenance set.
DEFAULT notifyOnlyOnFailures(0) notifyOnlyOnFailures Notify admin after a maintenance set, only if there were failures in the set.





parallel

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Flag to turn on parallel upgrade of APICs, trades off availability to speed.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.



runMode

Type: maint:RunMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Specifies whether to proceed automatically to next set of nodes once a set of nodes have gone through maintenance successfully.
Constants
pauseOnlyOnFailures 0 Pause upon upgrade failure Pause the scheduler upon a failure of maintenance operation.
pauseAlwaysBetweenSets 1 Pause in between set of upgrades Pause the scheduler after running a maintenance set irrespective of upgrade status of nodes in the set.
pauseNever 2 Do not pause on failure and do not wait on cluster health Do not pause the scheduler after a maintenance set, irrespective of upgrade status of nodes in the set.
DEFAULT pauseOnlyOnFailures(0) Pause upon upgrade failure Pause the scheduler upon a failure of maintenance operation.





seqNum

Type: trig:TriggerCount
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An ISIS link-state packet sequence number.
Constants
defaultValue 0u --- NO COMMENTS





srUpgrade

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





srVersion

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
srFirmware version desired.



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.






triggerTime

Type: trig:DateTime
Primitive Type: scalar:Date

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



uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



version

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The version of the compatibility catalog.



versionCheckOverride

Type: trig:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The version check override. This is a directive to ignore the version check for the next install. The version check, which occurs during a maintenance window, checks to see if the desired version matches the running version. If the versions do not match, the install is performed. If the versions do match, the install is not performed. The version check override is a one-time override that performs the install whether or not the versions match.
Constants
trigger-immediate 0 trigger-immediate NO COMMENTS
trigger 1 trigger NO COMMENTS
triggered 2 triggered NO COMMENTS
untriggered 3 untriggered NO COMMENTS
DEFAULT untriggered(3) untriggered NO COMMENTS