Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class power:Group (CONCRETE)

Class ID:849
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, power-mgmt]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.99.6

Group represents the power group.

Naming Rules 
RN FORMAT: group-[name]

    [1] PREFIX=group- PROPERTY = name




DN FORMAT: 

[0] sys/power-ep/group-[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.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		power:Ep top level container
 
 		 
 		 ├
 		power:Group


Contained Hierarchy
power:Group
 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
 ├
 		power:GroupMember Abstract member of a group
Inheritance
naming:NamedObject
 ├
 		policy:Object
 
 		 ├
 		policy:Definition
 
 		 
 		 ├
 		compute:QualifiedPolicy
 
 		 
 		 
 		 ├
 		power:AGroup
 
 		 
 		 
 		 
 		 ├
 		power:Group
Events


Faults 
                power:Group:PowerGroupBudgetIncorrect

                power:Group:PowerGroupInsufficientBudget


Fsms


Properties Summary
Defined in: power:Group
power:Budget
          scalar:Uint32 		adminCommitted  (power:Group:adminCommitted)
           user entered committed budget
power:Budget
          scalar:Uint32 		adminPeak  (power:Group:adminPeak)
           user entered peak budget
power:Budget
          scalar:Uint32 		curReqPower  (power:Group:curReqPower)
           NO COMMENTS
power:Budget
          scalar:Uint32 		currentPower  (power:Group:currentPower)
           group level enforcement of budget. SLA driven or best-effort property name="enforcement" type="Enforcement" owner="management" mod="explicit" / current power consumption. added for gui/cli
scalar:Uint64 fltAggr  (power:Group:fltAggr)
           NO COMMENTS
power:Budget
          scalar:Uint32 		maxReqPower  (power:Group:maxReqPower)
           NO COMMENTS
power:Budget
          scalar:Uint32 		minReqPower  (power:Group:minReqPower)
           minimum required budget to operate hardware in the group assuming every piece of hardware can be capped to the maximum
naming:Name
          string:Basic 		name  (power:Group:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
power:Budget
          scalar:Uint32 		operCommitted  (power:Group:operCommitted)
           ucsm calculated committed budget depending on system
power:Budget
          scalar:Uint32 		operPeak  (power:Group:operPeak)
           ucsm calculated peak budget depending on system
power:GroupState
          scalar:Bitmask8 		operState  (power:Group:operState)
           group oper state
power:Reallocation
          scalar:Enum8 		realloc  (power:Group:realloc)
           number of simultaneous boots allowed property name="adminBootStaggerLimit" type="StaggerLimit" owner="management" mod="explicit" />
Defined in: compute:QualifiedPolicy
naming:Name
          string:Basic 		qualifier  (compute:QualifiedPolicy:qualifier)
           NO COMMENTS
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: 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

adminCommitted

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
user entered committed budget
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

adminPeak

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
user entered peak budget
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u 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

curReqPower

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
NO COMMENTS
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

currentPower

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
group level enforcement of budget. SLA driven or best-effort property name="enforcement" type="Enforcement" owner="management" mod="explicit" / current power consumption. added for gui/cli
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

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

fltAggr

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

Comments:
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

maxReqPower

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
NO COMMENTS
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

minReqPower

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
minimum required budget to operate hardware in the group assuming every piece of hardware can be capped to the maximum
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  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:
NO COMMENTS

operCommitted

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
ucsm calculated committed budget depending on system
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

operPeak

Type: power:Budget
Primitive Type: scalar:Uint32
Units: W
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)10000000l
    Range:  min: (long)0xFFFFFFFFl  max: (long)0xFFFFFFFFl

Comments:
ucsm calculated peak budget depending on system
Constants
unbounded 0xFFFFFFFFu NO COMMENTS
defaultValue 0u NO COMMENTS

operState

Type: power:GroupState
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
group oper state
Constants
cap-ok 1 NO COMMENTS
cap-insufficient 2 cap insufficient to support hardware/ops
cap-mismatch 4 newly entered cap is insufficient
DEFAULT cap-ok(1) NO COMMENTS

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

qualifier

Type: naming:Name
Primitive Type: string:Basic
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

realloc

Type: power:Reallocation
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
number of simultaneous boots allowed property name="adminBootStaggerLimit" type="StaggerLimit" owner="management" mod="explicit" />
Constants
chassis 0 NO COMMENTS
none 1 NO COMMENTS
DEFAULT chassis(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  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming