Class trig:RecurrWindow (CONCRETE)

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

A schedule window that recurs periodically for the execution of a task.

Naming Rules
RN FORMAT: recurr-{name}

    [1] PREFIX=recurr- PROPERTY = name




DN FORMAT: 

[0] trigcont/pol/sched-{name}/recurr-{name}

                


Diagram

Super Mo: trig:SchedWindow,
Container Mos: trig:Sched (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: maint:UpgJob,
Relations: trig:RtWindowStarted,


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] trig:Cont The top-level container for a generic scheduler and its state.
 
 ├
[V] trig:Policy The container for scheduler policies.
 
 
 ├
[V] trig:Sched A generic scheduler.
 
 
 
 ├
[V] trig:RecurrWindow A schedule window that recurs periodically for the execution of a task.


Contained Hierarchy
[V] trig:RecurrWindow A schedule window that recurs periodically for the execution of a task.
 ├
[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] trig:RtWindowStarted A target relation to the container for scheduled windows.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] trig:Window A container for scheduled windows.
 
 ├
[V] trig:SchedWindow A container for absolute or recurring scheduled windows.
 
 
 ├
[V] trig:RecurrWindow A schedule window that recurs periodically for the execution of a task.


Events
                trig:RecurrWindow:creation__trig_RecurrWindow
trig:RecurrWindow:modification__trig_RecurrWindow
trig:RecurrWindow:deletion__trig_RecurrWindow
trig:RecurrWindow:creation__trig_RecurrWindow
trig:RecurrWindow:modification__trig_RecurrWindow
trig:RecurrWindow:deletion__trig_RecurrWindow


Faults
                


Fsms
                


Properties Summary
Defined in: trig:RecurrWindow
mo:Annotation
          string:Basic
annotation  (trig:RecurrWindow:annotation)
           NO COMMENTS
trig:Day
          scalar:Enum8
day  (trig:RecurrWindow:day)
           The day of the week that the recurring window begins.
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (trig:RecurrWindow:extMngdBy)
           NO COMMENTS
trig:Hour
          scalar:Uint16
hour  (trig:RecurrWindow:hour)
           The hour that the recurring window begins.
trig:Minute
          scalar:Uint16
minute  (trig:RecurrWindow:minute)
           The minute that the recurring window begins.
naming:Name
          string:Basic
name  (trig:RecurrWindow:name)
           Overrides:naming:NamedObject:name
           The name of the recurring schedule window.
Defined in: trig:Window
trig:WindowConcurCap
          scalar:Uint16
concurCap  (trig:Window:concurCap)
           The concurrency capacity limit. This is the maximum number of tasks that can be processed concurrently.
trig:TriggerCount
          scalar:Uint32
jobCount  (trig:Window:jobCount)
           The total number of tasks executed by this window.
trig:WindowUpgInterval
          scalar:Uint16
nodeUpgInterval  (trig:Window:nodeUpgInterval)
           Delay between node upgrades in seconds. This is applicable only for concurCap 1.
trig:WindowProcBreak
          scalar:Time
procBreak  (trig:Window:procBreak)
           A period of time taken between processing of items within the concurrency cap.
trig:WindowProcCap
          scalar:Uint16
procCap  (trig:Window:procCap)
           Processing size capacity limitation specification. Indicates the limit of items to be processed within this window.
trig:WindowTimeCap
          scalar:Time
timeCap  (trig:Window:timeCap)
           The processing time capacity limit. This is the maximum duration of the window.
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

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





concurCap

Type: trig:WindowConcurCap
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 65535
    Comments:
The concurrency capacity limit. This is the maximum number of tasks that can be processed concurrently.
Constants
unlimited 0 Unlimited NO COMMENTS
DEFAULT unlimited(0) Unlimited NO COMMENTS





day

Type: trig:Day
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The day of the week that the recurring window begins.
Constants
every-day 0 every-day NO COMMENTS
Monday 1 Monday NO COMMENTS
Tuesday 2 Tuesday NO COMMENTS
Wednesday 3 Wednesday NO COMMENTS
Thursday 4 Thursday NO COMMENTS
Friday 5 Friday NO COMMENTS
Saturday 6 Saturday NO COMMENTS
Sunday 7 Sunday NO COMMENTS
odd-day 8 odd-day NO COMMENTS
even-day 9 even-day NO COMMENTS
DEFAULT every-day(0) every-day NO COMMENTS





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





hour

Type: trig:Hour
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 23
    Comments:
The hour that the recurring window begins.
Constants
defaultValue 0 --- NO COMMENTS





jobCount

Type: trig:TriggerCount
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The total number of tasks executed by this window.
Constants
defaultValue 0u --- 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





minute

Type: trig:Minute
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 59
    Comments:
The minute that the recurring window begins.
Constants
defaultValue 0 --- 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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "16" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the recurring schedule window.



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



nodeUpgInterval

Type: trig:WindowUpgInterval
Primitive Type: scalar:Uint16

Units: seconds
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 18000
    Comments:
Delay between node upgrades in seconds. This is applicable only for concurCap 1.
Constants
defaultValue 0 --- NO COMMENTS





procBreak

Type: trig:WindowProcBreak
Primitive Type: scalar:Time

Units: dd:hh:mm:ss
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A period of time taken between processing of items within the concurrency cap.
Constants
none 0ull none NO COMMENTS
DEFAULT none(0ull) none NO COMMENTS





procCap

Type: trig:WindowProcCap
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 65535
    Comments:
Processing size capacity limitation specification. Indicates the limit of items to be processed within this window.
Constants
unlimited 0 Unlimited NO COMMENTS
DEFAULT unlimited(0) Unlimited 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.



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.






timeCap

Type: trig:WindowTimeCap
Primitive Type: scalar:Time

Units: dd:hh:mm:ss
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The processing time capacity limit. This is the maximum duration of the window.
Constants
unlimited 0ull Unlimited NO COMMENTS
DEFAULT unlimited(0ull) Unlimited NO COMMENTS





uid

Type: scalar:Uint16

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