Class firmware:Ack (CONCRETE)

Class ID:1407
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.50.1

Ack object used by Install-All to get user's acknowledgement before rebooting primary FI


Naming Rules
RN FORMAT: ack

    [1] PREFIX=ack


DN FORMAT: 

[0] fabric/lan/ack

[1] fabric/san/ack

[2] sys/fw-system/ack

[3] fabric/lan/classes/ack

                



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.
 ├
fabric:Ep The root container of all fabric configuration objects.
 
 ├
fabric:LanCloud A container for logical Ethernet configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Ethernet configuration, including fabric A and B, VLANs, pin groups, flow control policy, QoS policy, threshold policy, and port profiles.
 
 
 ├
firmware:Ack
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
fabric:Ep The root container of all fabric configuration objects.
 
 ├
fabric:LanCloud A container for logical Ethernet configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Ethernet configuration, including fabric A and B, VLANs, pin groups, flow control policy, QoS policy, threshold policy, and port profiles.
 
 
 ├
qosclass:Definition
 
 
 
 ├
firmware:Ack
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
fabric:Ep The root container of all fabric configuration objects.
 
 ├
fabric:SanCloud A container for logical Fibre Channel configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Fibre Channel configuration, including fabric A and B, VSANs, pin groups, and threshold policy.
 
 
 ├
firmware:Ack
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.
 
 ├
firmware:System Represents system firmware. i.e, the firmware package for the whole system
 
 
 ├
firmware:Ack


Contained Hierarchy
firmware:Ack
 ├
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.
 ├
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:SchedWindow Scheduled Window.

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
trig:Triggerable Triggerable object that must be triggered according to the schedule
 
 
 
 ├
trig:Ack
 
 
 
 
 ├
firmware:Ack

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: firmware:Ack
aaa:UserName
          string:Basic
ackedBy  (firmware:Ack:ackedBy)
           Overrides:trig:Ack:ackedBy
           NO COMMENTS
aaa:UserName
          string:Basic
changeBy  (firmware:Ack:changeBy)
           Overrides:trig:Ack:changeBy
           NO COMMENTS
naming:Name
          string:Basic
name  (firmware:Ack:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
Defined in: trig:Ack
scalar:Date acked  (trig:Ack:acked)
           A timestamp indicating when this object was acknowledged
trig:AckChangeDetails
          scalar:Bitmask64
changeDetails  (trig:Ack:changeDetails)
           NO COMMENTS
trig:AckChanges
          scalar:Bitmask32
changes  (trig:Ack:changes)
           NO COMMENTS
trig:AckDisr
          scalar:Bitmask32
disr  (trig:Ack:disr)
           NO COMMENTS
scalar:Date modified  (trig:Ack:modified)
           A timestamp indicating when this object was last updated
trig:TrigOperState
          scalar:Enum8
operState  (trig:Ack:operState)
           Overrides:trig:Triggerable:operState
           NO COMMENTS
trig:TrigOperState
          scalar:Enum8
prevOperState  (trig:Ack:prevOperState)
           NO COMMENTS
trig:TrigState
          scalar:Enum8
triggerConfigState  (trig:Ack:triggerConfigState)
           NO COMMENTS
Defined in: trig:Triggerable
trig:AdminState
          scalar:Enum8
adminState  (trig:Triggerable:adminState)
           Admin state set by the user
scalar:Bool autoDelete  (trig:Triggerable:autoDelete)
           Flag to determine whether an auto deletion should occur when a schedule expires or when all children are removed
scalar:Bool ignoreCap  (trig:Triggerable:ignoreCap)
           This property is set to specify whether the maximum job cap should be considered
reference:Object operScheduler  (trig:Triggerable:operScheduler)
           NO COMMENTS
naming:Name
          string:Basic
scheduler  (trig:Triggerable:scheduler)
           Schedule set by user
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

acked

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
A timestamp indicating when this object was acknowledged

ackedBy

Type: aaa:UserName
Primitive Type: string:Basic
Overrides:trig:Ack:ackedBy
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
Comments:
NO COMMENTS

adminState

Type: trig:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Admin state set by the user
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

autoDelete

Type: scalar:Bool
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
Comments:
Flag to determine whether an auto deletion should occur when a schedule expires or when all children are removed
Constants
yes true NO COMMENTS
defaultValue false NO COMMENTS

changeBy

Type: aaa:UserName
Primitive Type: string:Basic
Overrides:trig:Ack:changeBy
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
Comments:
NO COMMENTS

changeDetails

Type: trig:AckChangeDetails
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
graphics-card-mode 0x1000000000000000ull NO COMMENTS
storage-snic-config 0x100000000000000ull NO COMMENTS
oob-local-storage-config 0x10000000000000ull NO COMMENTS
bootmode-config 0x1000000000000ull NO COMMENTS
bmc-update-bios-fw 0x100000000000ull NO COMMENTS
host-eth-if-qos-host-control 0x10000000000ull NO COMMENTS
checkpoint 0x1000000000ull NO COMMENTS
pin 0x100000000ull NO COMMENTS
adaptor-host-fw 0x10000000ull NO COMMENTS
blade-identity 0x1000000ull NO COMMENTS
boot-local-storage 0x100000ull NO COMMENTS
ip 0x10000ull NO COMMENTS
host-fcoe-if 0x1000ull NO COMMENTS
host-virt-fc-if-pers-bind 0x100ull NO COMMENTS
host-eth-if-qos 0x10ull NO COMMENTS
binding 0x1ull NO COMMENTS
local-disk-data-loss 0x2000000000000000ull NO COMMENTS
fan-speed-config 0x200000000000000ull NO COMMENTS
remote-storage-config 0x20000000000000ull NO COMMENTS
secureboot-config 0x2000000000000ull NO COMMENTS
host-if-pcie 0x200000000000ull NO COMMENTS
local-disk-fw 0x20000000000ull NO COMMENTS
implicit-reboot 0x2000000000ull NO COMMENTS
sol 0x200000000ull NO COMMENTS
adaptor-nw-fw 0x20000000ull NO COMMENTS
agent-policy 0x2000000ull NO COMMENTS
boot-virt-pxe 0x200000ull NO COMMENTS
boot-order 0x20000ull NO COMMENTS
vif 0x2000ull NO COMMENTS
host-nonvirt-fc-if-pers-bind 0x200ull NO COMMENTS
host-eth-if-nw-ctrl 0x20ull NO COMMENTS
host-virt-eth-if 0x2ull NO COMMENTS
local-storage-security 0x4000000000000000ull NO COMMENTS
sas-exp-reg-fw 0x400000000000000ull NO COMMENTS
vmedia-config 0x4000000000000ull NO COMMENTS
flexflash-config 0x400000000000ull NO COMMENTS
implicit-host-eth-if-profile-redeploy 0x40000000000ull NO COMMENTS
implicit-host-fc-if-profile-redeploy 0x4000000000ull NO COMMENTS
ep-auth 0x400000000ull NO COMMENTS
mgmt-controller-fw 0x40000000ull NO COMMENTS
bios-fw 0x4000000ull NO COMMENTS
boot-nonvirt-pxe 0x400000ull NO COMMENTS
boot-virt-vnic 0x40000ull NO COMMENTS
vlan 0x4000ull NO COMMENTS
host-fc-if-profile 0x400ull NO COMMENTS
host-virt-fc-if 0x40ull NO COMMENTS
host-nonvirt-eth-if 0x4ull NO COMMENTS
nvme-mswitch-fw 0x8000000000000000ull NO COMMENTS
asset-tag-config 0x800000000000000ull NO COMMENTS
powercap-config 0x8000000000000ull NO COMMENTS
storage-path 0x80000000000ull NO COMMENTS
board-controller-fw 0x8000000000ull NO COMMENTS
bios-profile 0x800000000ull NO COMMENTS
local-disk-policy 0x80000000ull NO COMMENTS
storage-controller-fw 0x8000000ull NO COMMENTS
boot-nonvirt-vnic 0x80000ull NO COMMENTS
vsan 0x8000ull NO COMMENTS
host-fc-if-qos 0x800ull NO COMMENTS
host-nonvirt-fc-if 0x80ull NO COMMENTS
host-eth-if-profile 0x8ull NO COMMENTS
graphics-card-fw 0x9000000ull NO COMMENTS
storage-sas-expander-fw 0x9800000ull NO COMMENTS
defaultValue 0ull NO COMMENTS

changes

Type: trig:AckChanges
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
boot-order 0x10u NO COMMENTS
server-assignment 0x20u NO COMMENTS
operational-policies 0x40u NO COMMENTS
local-storage 0x80u NO COMMENTS
server-identity 1u NO COMMENTS
storage 2u NO COMMENTS
networking 4u NO COMMENTS
vnic-vhba-placement 8u 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

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

disr

Type: trig:AckDisr
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
ac-power-cycle 0x00000002u NO COMMENTS
local-storage-config-deployment-userack 0x4u NO COMMENTS
local-storage-config-deployment-immediate 0x8u NO COMMENTS
up-time 1u NO COMMENTS
defaultValue 0u 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" />

ignoreCap

Type: scalar:Bool
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
This property is set to specify whether the maximum job cap should be considered
Constants
yes true NO COMMENTS
defaultValue 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

modified

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
A timestamp indicating when this object was last updated

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

operScheduler

Type: reference:Object
Refers: trig:Sched
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

operState

Type: trig:TrigOperState
Primitive Type: scalar:Enum8
Overrides:trig:Triggerable:operState
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
untriggered 0 NO COMMENTS
evaluation-pending 1 NO COMMENTS
evaluated 2 NO COMMENTS
waiting-for-user 3 NO COMMENTS
waiting-for-maint-window 4 NO COMMENTS
apply-pending 5 NO COMMENTS
applied 6 NO COMMENTS
waiting-for-dependency 7 NO COMMENTS
none 8 There is no schedule defined
expired 9 Schedule has expired
pending 10 There are future schedule windows
active 11 Schedule is currently active
DEFAULT untriggered(0) 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

prevOperState

Type: trig:TrigOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
untriggered 0 NO COMMENTS
evaluation-pending 1 NO COMMENTS
evaluated 2 NO COMMENTS
waiting-for-user 3 NO COMMENTS
waiting-for-maint-window 4 NO COMMENTS
apply-pending 5 NO COMMENTS
applied 6 NO COMMENTS
waiting-for-dependency 7 NO COMMENTS
none 8 There is no schedule defined
expired 9 Schedule has expired
pending 10 There are future schedule windows
active 11 Schedule is currently active
DEFAULT untriggered(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

scheduler

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: trig:Sched
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
Schedule set by user

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.


triggerConfigState

Type: trig:TrigState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0 NO COMMENTS
waiting-for-next-boot 1 NO COMMENTS
DEFAULT none(0) NO COMMENTS