Class trig:RecurrWindowP (CONCRETE)

Class ID:1813
Class Label: Recurring Window Trigger
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin]
Read Access: [admin]
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 ]

A schedule window that triggers a task every 24 hours.

Naming Rules
RN FORMAT: recurrwinp-{name}

    [1] PREFIX=recurrwinp- PROPERTY = name




DN FORMAT: 

[1] uni/controller/schedp-{name}/recurrwinp-{name}

[3] uni/fabric/schedp-{name}/recurrwinp-{name}

                


Diagram

Super Mo: trig:SchedWindowP,
Container Mos: trig:SchedP (deletable:yes),
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] 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] trig:SchedP The scheduler policy enables you to schedule a recurring or one-time window for the execution of a task. Multiple scheduler policies can be created for the same time period.
 
 
 
 
 
 
 
 
 ├
[V] trig:RecurrWindowP A schedule window that triggers a task every 24 hours.
[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] trig:SchedP The scheduler policy enables you to schedule a recurring or one-time window for the execution of a task. Multiple scheduler policies can be created for the same time period.
 
 
 
 ├
[V] trig:RecurrWindowP A schedule window that triggers a task every 24 hours.
[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] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] trig:SchedP The scheduler policy enables you to schedule a recurring or one-time window for the execution of a task. Multiple scheduler policies can be created for the same time period.
 
 
 
 
 
 
 
 
 ├
[V] trig:RecurrWindowP A schedule window that triggers a task every 24 hours.
[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] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] trig:SchedP The scheduler policy enables you to schedule a recurring or one-time window for the execution of a task. Multiple scheduler policies can be created for the same time period.
 
 
 
 ├
[V] trig:RecurrWindowP A schedule window that triggers a task every 24 hours.


Contained Hierarchy
[V] trig:RecurrWindowP A schedule window that triggers a task every 24 hours.
 ├
[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:SchedWindowP Container for absolute or recurring scheduled windows.
 
 
 ├
[V] trig:RecurrWindowP A schedule window that triggers a task every 24 hours.


Events
                trig:RecurrWindowP:creation__trig_RecurrWindowP
trig:RecurrWindowP:modification__trig_RecurrWindowP
trig:RecurrWindowP:deletion__trig_RecurrWindowP


Faults
                


Fsms
                


Properties Summary
Defined in: trig:RecurrWindowP
trig:Day
          scalar:Enum8
day  (trig:RecurrWindowP:day)
           The day of the week that the recurring window begins.
trig:Hour
          scalar:Uint16
hour  (trig:RecurrWindowP:hour)
           The hour that the recurring window begins.
trig:Minute
          scalar:Uint16
minute  (trig:RecurrWindowP:minute)
           The minute that the recurring window begins.
naming:Name
          string:Basic
name  (trig:RecurrWindowP: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: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: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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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





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.



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



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.