Class firmware:CatalogPack (CONCRETE)

Class ID:1397
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, operations]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.52.13

A specification of Catalog Pack, providing the catalog to be used/applied for the system


Naming Rules
RN FORMAT: fw-catalog-pack-[name]

    [1] PREFIX=fw-catalog-pack- PROPERTY = name




DN FORMAT: 

[0] org-[name]/fw-catalog-pack-[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.
 ├
org:Org
 
 ├
firmware:CatalogPack


Contained Hierarchy
firmware:CatalogPack
 ├
firmware:BackupVersionHolder Class definition for BackUp firmware
 
 ├
firmware:PackItem A piece of firmware that is part of Deployable Pack.
 
 
 ├
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.
 ├
firmware:PackItem A piece of firmware that is part of Deployable Pack.
 
 ├
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.

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
firmware:Pack An abstraction of set of firmware images that are deployed together against specific set of end-points. Pack can contain none, some or all applicable images.
 
 
 
 ├
firmware:CatalogPack

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: firmware:CatalogPack
string:Basic catalogName  (firmware:CatalogPack:catalogName)
           NO COMMENTS
firmware:Version
          string:Basic
catalogVersion  (firmware:CatalogPack:catalogVersion)
           NO COMMENTS
firmware:CatalogPackConfigState
          scalar:Enum8
configState  (firmware:CatalogPack:configState)
           NO COMMENTS
string:Basic configStatusMessage  (firmware:CatalogPack:configStatusMessage)
           NO COMMENTS
naming:Name
          string:Basic
name  (firmware:CatalogPack:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
Defined in: firmware:Pack
scalar:Enum8 mode  (firmware:Pack:mode)
           indicates the mode of update:
  • staged: update is performed in stages where a given number of corresponding resources is updated simultaneously.
  • one-shot: update is performed to all participating instances simultaneously

Note that for virtualized resources, in both modes, update occurs upon initial association as well as discovery (if applies.) In case of discovery, a default Deployable Pack policy is picked. Default Pack is the pack that is instantiated under root org with name "default". Default packs are automatically composed and updated by the "internal" firware management mechanisms.
scalar:Uint16 stageSize  (firmware:Pack:stageSize)
           Identifies how many resources can be update simultaneously. Enforced only when mode is set to staged.
scalar:Date updateTrigger  (firmware:Pack:updateTrigger)
           specifies when automatic update should kick in. Immediate implies that update will proceed immediately.
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

catalogName

Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

catalogVersion

Type: firmware:Version
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
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

configState

Type: firmware:CatalogPackConfigState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
ok 0 NO COMMENTS
not-applied 1 NO COMMENTS
failed 2 NO COMMENTS
DEFAULT ok(0) NO COMMENTS

configStatusMessage

Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
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" />

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

mode

Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
indicates the mode of update:

Note that for virtualized resources, in both modes, update occurs upon initial association as well as discovery (if applies.) In case of discovery, a default Deployable Pack policy is picked. Default Pack is the pack that is instantiated under root org with name "default". Default packs are automatically composed and updated by the "internal" firware management mechanisms.
Constants
staged 0 update is performed in stages where a given number of corresponding resources is updated simultaneously.
one-shot 1 update is performed to all participating instances simultaneously
DEFAULT 0 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
Constants
defaultValue "default" 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

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

stageSize

Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Identifies how many resources can be update simultaneously. Enforced only when mode is set to staged.

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.


updateTrigger

Type: scalar:Date
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
specifies when automatic update should kick in. Immediate implies that update will proceed immediately.
Constants
immediate 0ull NO COMMENTS
DEFAULT 0 NO COMMENTS