Class policy:PolicyScopeFsmStage (CONCRETE)

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

NO COMMENTS


Naming Rules
RN FORMAT: stage-[name]

    [1] PREFIX=stage- PROPERTY = name




DN FORMAT: 

[0] extpol/reg/clients/client-[id]/scope-cont-[appType]/context-[name]/scope-[policyType]-[resolveType]-[policyName]/fsm/stage-[name]

[1] extpol/reg/controllers/contro-[id]/scope-cont-[appType]/context-[name]/scope-[policyType]-[resolveType]-[policyName]/fsm/stage-[name]

[2] extpol/reg/providers/prov-[type]/scope-cont-[appType]/context-[name]/scope-[policyType]-[resolveType]-[policyName]/fsm/stage-[name]

[3] extpol/reg/scope-cont-[appType]/context-[name]/scope-[policyType]-[resolveType]-[policyName]/fsm/stage-[name]

[4] policy-ep/scope-cont-[appType]/context-[name]/scope-[policyType]-[resolveType]-[policyName]/fsm/stage-[name]

                



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.
 ├
extpol:Ep
 
 ├
extpol:Registry
 
 
 ├
extpol:ClientCont
 
 
 
 ├
extpol:Client
 
 
 
 
 ├
policy:PolicyScopeCont PolicyScopeCont class is to keep track of a policy provider and version for the resolved policy changes.
 
 
 
 
 
 ├
policy:PolicyScopeContext
 
 
 
 
 
 
 ├
policy:PolicyScope PolicyScope class is to keep track of context, policy class id and policy name in resolve-policy request, where the combination of context, policy class id and policy name is unique.
 
 
 
 
 
 
 
 ├
policy:PolicyScopeFsm
 
 
 
 
 
 
 
 
 ├
policy:PolicyScopeFsmStage
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
extpol:Ep
 
 ├
extpol:Registry
 
 
 ├
extpol:ControllerCont
 
 
 
 ├
extpol:Controller
 
 
 
 
 ├
policy:PolicyScopeCont PolicyScopeCont class is to keep track of a policy provider and version for the resolved policy changes.
 
 
 
 
 
 ├
policy:PolicyScopeContext
 
 
 
 
 
 
 ├
policy:PolicyScope PolicyScope class is to keep track of context, policy class id and policy name in resolve-policy request, where the combination of context, policy class id and policy name is unique.
 
 
 
 
 
 
 
 ├
policy:PolicyScopeFsm
 
 
 
 
 
 
 
 
 ├
policy:PolicyScopeFsmStage
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
extpol:Ep
 
 ├
extpol:Registry
 
 
 ├
extpol:ProviderCont
 
 
 
 ├
extpol:Provider
 
 
 
 
 ├
policy:PolicyScopeCont PolicyScopeCont class is to keep track of a policy provider and version for the resolved policy changes.
 
 
 
 
 
 ├
policy:PolicyScopeContext
 
 
 
 
 
 
 ├
policy:PolicyScope PolicyScope class is to keep track of context, policy class id and policy name in resolve-policy request, where the combination of context, policy class id and policy name is unique.
 
 
 
 
 
 
 
 ├
policy:PolicyScopeFsm
 
 
 
 
 
 
 
 
 ├
policy:PolicyScopeFsmStage
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
extpol:Ep
 
 ├
extpol:Registry
 
 
 ├
policy:PolicyScopeCont PolicyScopeCont class is to keep track of a policy provider and version for the resolved policy changes.
 
 
 
 ├
policy:PolicyScopeContext
 
 
 
 
 ├
policy:PolicyScope PolicyScope class is to keep track of context, policy class id and policy name in resolve-policy request, where the combination of context, policy class id and policy name is unique.
 
 
 
 
 
 ├
policy:PolicyScopeFsm
 
 
 
 
 
 
 ├
policy:PolicyScopeFsmStage
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
policy:PolicyEp PolicyEp is a singleton class to hold PolicyScopeContMO on policy client side.
 
 ├
policy:PolicyScopeCont PolicyScopeCont class is to keep track of a policy provider and version for the resolved policy changes.
 
 
 ├
policy:PolicyScopeContext
 
 
 
 ├
policy:PolicyScope PolicyScope class is to keep track of context, policy class id and policy name in resolve-policy request, where the combination of context, policy class id and policy name is unique.
 
 
 
 
 ├
policy:PolicyScopeFsm
 
 
 
 
 
 ├
policy:PolicyScopeFsmStage


Contained Hierarchy
policy:PolicyScopeFsmStage

Inheritance
fsm:Stage
 ├
policy:PolicyScopeFsmStage

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: policy:PolicyScopeFsmStage
fsm:FsmStage
          scalar:Enum32
name  (policy:PolicyScopeFsmStage:name)
           Overrides:fsm:Stage:name
           NO COMMENTS
Defined in: fsm:Stage
naming:Descr
          string:Basic
descr  (fsm:Stage:descr)
           NO COMMENTS
fsm:DateTime
          scalar:Date
lastUpdateTime  (fsm:Stage:lastUpdateTime)
           NO COMMENTS
scalar:Uint16 order  (fsm:Stage:order)
           NO COMMENTS
scalar:UByte retry  (fsm:Stage:retry)
           NO COMMENTS
fsm:FsmStageStatus
          scalar:Enum8
stageStatus  (fsm:Stage:stageStatus)
           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

descr

Type: naming:Descr
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
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" />

lastUpdateTime

Type: fsm:DateTime
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
0ull NO COMMENTS
defaultValue 0 NO COMMENTS

name

Type: fsm:FsmStage
Primitive Type: scalar:Enum32
Overrides:fsm:Stage:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
nop 0u NO COMMENTS
ReleasePolicyFsmBegin 1342u NO COMMENTS
ReleasePolicyFsmRelease 1343u NO COMMENTS
ReleaseOperationFsmBegin 1344u NO COMMENTS
ReleaseOperationFsmRelease 1345u NO COMMENTS
ReleaseStorageFsmBegin 1346u NO COMMENTS
ReleaseStorageFsmRelease 1347u NO COMMENTS
ResolveManyPolicyFsmBegin 1348u NO COMMENTS
ResolveManyPolicyFsmResolveMany 1349u NO COMMENTS
ResolveManyOperationFsmBegin 1350u NO COMMENTS
ResolveManyOperationFsmResolveMany 1351u NO COMMENTS
ResolveManyStorageFsmBegin 1352u NO COMMENTS
ResolveManyStorageFsmResolveMany 1353u NO COMMENTS
ReleaseManyPolicyFsmBegin 1354u NO COMMENTS
ReleaseManyPolicyFsmReleaseMany 1355u NO COMMENTS
ReleaseManyOperationFsmBegin 1356u NO COMMENTS
ReleaseManyOperationFsmReleaseMany 1357u NO COMMENTS
ReleaseManyStorageFsmBegin 1358u NO COMMENTS
ReleaseManyStorageFsmReleaseMany 1359u NO COMMENTS
ResolveAllPolicyFsmBegin 1360u NO COMMENTS
ResolveAllPolicyFsmResolveAll 1361u NO COMMENTS
ResolveAllOperationFsmBegin 1362u NO COMMENTS
ResolveAllOperationFsmResolveAll 1363u NO COMMENTS
ResolveAllStorageFsmBegin 1364u NO COMMENTS
ResolveAllStorageFsmResolveAll 1365u NO COMMENTS
ReleaseAllPolicyFsmBegin 1366u NO COMMENTS
ReleaseAllPolicyFsmReleaseAll 1367u NO COMMENTS
ReleaseAllOperationFsmBegin 1368u NO COMMENTS
ReleaseAllOperationFsmReleaseAll 1369u NO COMMENTS
ReleaseAllStorageFsmBegin 1370u NO COMMENTS
ReleaseAllStorageFsmReleaseAll 1371u NO COMMENTS
ReleaseAllOperationFsmFail 1432u NO COMMENTS
ReleaseAllOperationFsmSuccess 1433u NO COMMENTS
ReleaseAllPolicyFsmFail 1434u NO COMMENTS
ReleaseAllPolicyFsmSuccess 1435u NO COMMENTS
ReleaseAllStorageFsmFail 1436u NO COMMENTS
ReleaseAllStorageFsmSuccess 1437u NO COMMENTS
ReleaseManyOperationFsmFail 1438u NO COMMENTS
ReleaseManyOperationFsmSuccess 1439u NO COMMENTS
ReleaseManyPolicyFsmFail 1440u NO COMMENTS
ReleaseManyPolicyFsmSuccess 1441u NO COMMENTS
ReleaseManyStorageFsmFail 1442u NO COMMENTS
ReleaseManyStorageFsmSuccess 1443u NO COMMENTS
ReleaseOperationFsmFail 1444u NO COMMENTS
ReleaseOperationFsmSuccess 1445u NO COMMENTS
ReleasePolicyFsmFail 1446u NO COMMENTS
ReleasePolicyFsmSuccess 1447u NO COMMENTS
ReleaseStorageFsmFail 1448u NO COMMENTS
ReleaseStorageFsmSuccess 1449u NO COMMENTS
ResolveAllOperationFsmFail 1450u NO COMMENTS
ResolveAllOperationFsmSuccess 1451u NO COMMENTS
ResolveAllPolicyFsmFail 1452u NO COMMENTS
ResolveAllPolicyFsmSuccess 1453u NO COMMENTS
ResolveAllStorageFsmFail 1454u NO COMMENTS
ResolveAllStorageFsmSuccess 1455u NO COMMENTS
ResolveManyOperationFsmFail 1456u NO COMMENTS
ResolveManyOperationFsmSuccess 1457u NO COMMENTS
ResolveManyPolicyFsmFail 1458u NO COMMENTS
ResolveManyPolicyFsmSuccess 1459u NO COMMENTS
ResolveManyStorageFsmFail 1460u NO COMMENTS
ResolveManyStorageFsmSuccess 1461u NO COMMENTS
DEFAULT nop(0u) NO COMMENTS

order

Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

retry

Type: scalar:UByte
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
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

stageStatus

Type: fsm:FsmStageStatus
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
fail 0 NO COMMENTS
success 1 NO COMMENTS
skip 2 NO COMMENTS
pending 3 NO COMMENTS
inProgress 4 NO COMMENTS
throttled 5 NO COMMENTS
nop 255 NO COMMENTS
DEFAULT pending(3) 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.