Class callhome:TestAlert (CONCRETE)

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

NO COMMENTS


Naming Rules
RN FORMAT: testalert

    [1] PREFIX=testalert


DN FORMAT: 

[0] call-home/testalert

                



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.
 ├
callhome:Ep
 
 ├
callhome:TestAlert


Contained Hierarchy
callhome:TestAlert

Inheritance
policy:Item The base class for all objects contained by policy:Definition. Though no containment rules are specified here, by convention policy:Item must be contained by either policy:Definition or another policy:Item.
 ├
callhome:TestAlert

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: callhome:TestAlert
string:Basic description  (callhome:TestAlert:description)
           NO COMMENTS
callhome:AlertGroup
          scalar:Enum8
group  (callhome:TestAlert:group)
           NO COMMENTS
callhome:AlertLevel
          scalar:Enum8
level  (callhome:TestAlert:level)
           NO COMMENTS
callhome:AlertMessageSubtype
          scalar:Enum8
messageSubtype  (callhome:TestAlert:messageSubtype)
           NO COMMENTS
callhome:AlertMessageType
          scalar:Enum8
messageType  (callhome:TestAlert:messageType)
           NO COMMENTS
scalar:Bool sendNow  (callhome:TestAlert:sendNow)
           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

description

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

group

Type: callhome:AlertGroup
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
diagnostic 0 NO COMMENTS
environmental 1 NO COMMENTS
unknown 100 NO COMMENTS
DEFAULT unknown(100) NO COMMENTS

level

Type: callhome:AlertLevel
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
debug 0 NO COMMENTS
normal 1 NO COMMENTS
notify 2 NO COMMENTS
warning 3 NO COMMENTS
minor 4 NO COMMENTS
major 5 NO COMMENTS
critical 6 NO COMMENTS
fatal 7 NO COMMENTS
unknown 100 NO COMMENTS
DEFAULT unknown(100) NO COMMENTS

messageSubtype

Type: callhome:AlertMessageSubtype
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
nosubtype 0 NO COMMENTS
test 1 NO COMMENTS
full 2 NO COMMENTS
delta 3 NO COMMENTS
minor 4 NO COMMENTS
major 5 NO COMMENTS
goldnormal 6 NO COMMENTS
goldminor 7 NO COMMENTS
goldmajor 8 NO COMMENTS
unknown 100 NO COMMENTS
DEFAULT unknown(100) NO COMMENTS

messageType

Type: callhome:AlertMessageType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
inventory 0 NO COMMENTS
syslog 1 NO COMMENTS
test 2 NO COMMENTS
diag 3 NO COMMENTS
env 4 NO COMMENTS
conf 5 NO COMMENTS
telemetry 6 NO COMMENTS
unknown 100 NO COMMENTS
DEFAULT unknown(100) 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

sendNow

Type: scalar:Bool
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
no false 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.