Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class trig:BaseSched (ABSTRACT)

Class ID:1493
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin]
SNMP OID:

Generic Scheduler. A user-defined schedule that can be used to trigger configuration at a specified date and time in the future. The schedule is defined in the system and can be referred by name from policies that require a schedule. For example, maintenance policies and firmware auto-install policies can refer to user-defined schedules. The schedule can have a list of one-time occurrences and/or a list of recurring occurrences. The schedule also specifies how to run tasks concurrently. When multiple configuration tasks are triggered at the same time (such as multiple Service Profile associations), the schedule can indicate how many of these tasks can run concurrently and how long to wait between tasks.

Naming Rules 


DN FORMAT: 

[0] sys/


Inheritance
naming:NamedObject
 ├
 		policy:Object
 
 		 ├
 		policy:Definition
 
 		 
 		 ├
 		trig:Inst An abstraction of a generalized system trigger.
 
 		 
 		 
 		 ├
 		trig:BaseSched
 
 		 
 		 
 		 
 		 ├
 		trig:LocalSched A locally defined user-defined schedule. The schedule is contained locally by the Managed Object that needs the schedule, as opposed to being referred by name.
 
 		 
 		 
 		 
 		 ├
 		trig:Sched A user-defined schedule that can be used to trigger configuration at a specified date and time in the future. The schedule is defined in the system and can be referred by name from policies that require a schedule. For example, maintenance policies and firmware auto-install policies can refer to user-defined schedules. The schedule can have a list of one-time occurrences and/or...
Events


Faults


Fsms


Properties Summary
Defined in: trig:BaseSched
scalar:Bool flgInitialActive  (trig:BaseSched:flgInitialActive)
           NO COMMENTS
Defined in: trig:Inst
trig:AdminState
          scalar:Enum8 		adminState  (trig:Inst:adminState)
           NO COMMENTS
trig:OperState
          scalar:Enum8 		operState  (trig:Inst:operState)
           Indicates the operational state of this schedule
Defined in: policy:Definition
naming:Descr
          string:Basic 		descr  (policy:Definition:descr)
           NO COMMENTS
policy:InternalId
          scalar:Uint32 		intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8 		policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Defined in: policy:Object
naming:Name
          string:Basic 		name  (policy:Object:name)
           Overrides:naming:NamedObject:name
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

adminState

Type: trig:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
trigger-immediate 0 Administratively specifies the job should be triggered immediately.
trigger 1 NO COMMENTS
triggered 2 NO COMMENTS
untriggered 3 NO COMMENTS
user-ack 4 NO COMMENTS
user-discard 5 NO COMMENTS
DEFAULT untriggered(3) NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u 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: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+

Comments:
NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

flgInitialActive

Type: scalar:Bool
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
no false NO COMMENTS

intId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

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: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

operState

Type: trig:OperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
Indicates the operational state of this schedule
Constants
pending 0 Indicates the schedule has never been triggered yet, or there are pending jobs because of scheduling constraints (max concurrent jobs, interval between jobs, etc). The schedule may have one-time or recurring occurrences that will be triggered in the future.
in-progress 1 Indicates a one-time or recurring occurrence has been triggered, and jobs are getting executed as a result.
failed 2 Indicates some error occured.
triggered 3 Indicates the schedule has been triggered at least once. The schedule may have additional occurrences that will be triggered in the future.
cap-reached 4 NO COMMENTS
DEFAULT pending(0) Indicates the schedule has never been triggered yet, or there are pending jobs because of scheduling constraints (max concurrent jobs, interval between jobs, etc). The schedule may have one-time or recurring occurrences that will be triggered in the future.

policyLevel

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
"local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Constants
local 0 NO COMMENTS
policy 1 NO COMMENTS
pending-policy 2 NO COMMENTS
DEFAULT local(0) NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail