Cisco System Model: Classpolicy:ControlledTypeFsmTask

Overview

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Naming

Class policy:ControlledTypeFsmTask (CONCRETE)

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

NO COMMENTS

Naming Rules

RN FORMAT: task-[item]

    [1] PREFIX=task- PROPERTY = item




DN FORMAT: 

[0] sys/control-ep-[type]/ctrlled-type-[type]/task-[item]

[1] sys/control-ep-[type]/comm-ctrl/ctrlled-type-[type]/task-[item]

[2] sys/control-ep-[type]/cfg-backup-ctrl/ctrlled-type-[type]/task-[item]

[3] sys/control-ep-[type]/datetime-ctrl/ctrlled-type-[type]/task-[item]

[4] sys/control-ep-[type]/discovery-ctrl/ctrlled-type-[type]/task-[item]

[5] sys/control-ep-[type]/dns-ctrl/ctrlled-type-[type]/task-[item]

[6] sys/control-ep-[type]/equipment-ctrl/ctrlled-type-[type]/task-[item]

[7] sys/control-ep-[type]/fault-ctrl/ctrlled-type-[type]/task-[item]

[8] sys/control-ep-[type]/fabric-fw-ctrl/ctrlled-type-[type]/task-[item]

[9] sys/control-ep-[type]/mep-ctrl/ctrlled-type-[type]/task-[item]

[10] sys/control-ep-[type]/monitoring-ctrl/ctrlled-type-[type]/task-[item]

[11] sys/control-ep-[type]/portconfig-ctrl/ctrlled-type-[type]/task-[item]

[12] sys/control-ep-[type]/powermgmt-ctrl/ctrlled-type-[type]/task-[item]

[13] sys/control-ep-[type]/psu-ctrl/ctrlled-type-[type]/task-[item]

[14] sys/control-ep-[type]/security-ctrl/ctrlled-type-[type]/task-[item]

[15] sys/control-ep-[type]/storage-autoconfig-ctrl/ctrlled-type-[type]/task-[item]

Containers Hierarchies

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Communication

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:ConfigBackup

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Control Abstract class to specify control information for a policy

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:DateTime

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Discovery

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Dns

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Equipment

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Fault

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:InfraFirmware

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:MEp

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Monitoring

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:PortConfig

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:PowerMgmt

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Psu

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:Security

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├	top:System Provides general information about this system, such as the name, IP address and current time.

├

policy:ControlEp This Mo contains control information for each admin policy

├

policy:StorageAutoConfig

├

policy:ControlledType

├

policy:ControlledTypeFsmTask

Contained Hierarchy

policy:ControlledTypeFsmTask

Inheritance

fsm:Task A base abstract class for all FSM tasks

├	policy:ControlledTypeFsmTask

Events

Faults

Fsms

Properties Summary

Defined in: policy:ControlledTypeFsmTask
fsm:Flags scalar:Bitmask64	flags (policy:ControlledTypeFsmTask:flags) Overrides:fsm:Task:flags NO COMMENTS
fsm:Item scalar:Enum32	item (policy:ControlledTypeFsmTask:item) Overrides:fsm:Task:item NO COMMENTS

Defined in: fsm:Task
fsm:Completion scalar:Enum8	completion (fsm:Task:completion) Runtime status of the task
fsm:SequenceId scalar:Uint32	seqId (fsm:Task:seqId) 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

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

completion

Type: fsm:Completion
Primitive Type: scalar:Enum8

Units: null

Encrypted: false

Access: implicit

Category: TopLevelRegular

Property Validators:

Comments:

Runtime status of the task

Constants
scheduled	0	The task is scheduled to run in the future
processing	1	The task is currently being processed
completed	2	The task has completed
cancelled	3	The task has been cancelled
DEFAULT	scheduled(0)	The task is scheduled to run in the future

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" />

flags

Type: fsm:Flags
Primitive Type: scalar:Bitmask64

Overrides:fsm:Task:flags

Units: null

Encrypted: false

Access: implicit

Category: TopLevelRegular

Property Validators:

Comments:

NO COMMENTS

Constants
defaultValue	0ull	NO COMMENTS

item

Type: fsm:Item
Primitive Type: scalar:Enum32

Overrides:fsm:Task:item

Units: null

Encrypted: false

Naming Property -- [NAMING RULES]

Access: naming

Category: TopLevelRegular

Property Validators:

Comments:

NO COMMENTS

Constants
nop	0u	NO COMMENTS
Operate	1479u	NO COMMENTS
DEFAULT	nop(0u)	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

seqId

Type: fsm:SequenceId
Primitive Type: scalar:Uint32

Units: null

Encrypted: false

Access: implicit

Category: TopLevelRegular

Property Validators:

Comments:

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.