Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class trig:SchedWindow (ABSTRACT)

Class ID:1820
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: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A container for absolute or recurring scheduled windows.

Naming Rules 


DN FORMAT: 

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


Diagram

Super Mo: trig:Window,
Sub Mos: trig:AbsWindow, trig:RecurrWindow,
Container Mos: trig:Sched (deletable:yes),
Relations From: maint:UpgJob,
Relations: trig:RtWindowStarted,


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:AbsWindow A schedule event with absolute start and end times.
 
 		 
 		 ├
 		[V] trig:RecurrWindow A schedule window that recurs periodically for the execution of a task.


Events


Faults


Fsms


Properties Summary
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:Name
          string:Basic 		name  (naming:NamedObject:name)
           The name of the object.
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.
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




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.


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




name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.


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






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail