Class callhome:Policy (CONCRETE)

Class ID:535
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, fault]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.12.5

NO COMMENTS


Naming Rules
RN FORMAT: policy-[cause]

    [1] PREFIX=policy- PROPERTY = cause




DN FORMAT: 

[0] call-home/policy-[cause]

                



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


Contained Hierarchy
callhome:Policy

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:Item
 
 ├
callhome:Policy

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: callhome:Policy
callhome:PolicyAdminState
          scalar:Enum8
adminState  (callhome:Policy:adminState)
           NO COMMENTS
condition:CallHomeCause
          scalar:Enum32
cause  (callhome:Policy:cause)
           NO COMMENTS
Defined in: callhome:Item
naming:Descr
          string:Basic
descr  (callhome:Item:descr)
           NO COMMENTS
naming:Name
          string:Basic
name  (callhome:Item:name)
           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

adminState

Type: callhome:PolicyAdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
enabled 1 NO COMMENTS
disabled 2 NO COMMENTS
DEFAULT enabled(1) NO COMMENTS

cause

Type: condition:CallHomeCause
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unspecified 0u NO COMMENTS
version-incompatible 10u NO COMMENTS
identity-unestablishable 11u NO COMMENTS
equipment-inaccessible 12u NO COMMENTS
configuration-failure 13u NO COMMENTS
association-failed 14u NO COMMENTS
power-problem 15u NO COMMENTS
equipment-problem 16u NO COMMENTS
voltage-problem 17u NO COMMENTS
fru-problem 18u NO COMMENTS
equipment-disabled 19u NO COMMENTS
equipment-inoperable 1u NO COMMENTS
limit-reached 20u NO COMMENTS
equipment-offline 21u NO COMMENTS
inventory-failed 22u NO COMMENTS
port-failed 23u NO COMMENTS
vif-ids-mismatch 24u NO COMMENTS
equipment-degraded 25u NO COMMENTS
arp-targets-config-error 26u NO COMMENTS
ndisc-targets-config-error 27u NO COMMENTS
health-led-amber-blinking 28u NO COMMENTS
health-led-amber 29u NO COMMENTS
thermal-problem 2u NO COMMENTS
near-max-limit 30u NO COMMENTS
memory-error 31u NO COMMENTS
adaptor-mismatch 32u NO COMMENTS
equipment-removed 36u NO COMMENTS
psu-insufficient 37u NO COMMENTS
psu-mixed-mode 38u NO COMMENTS
connectivity-problem 3u NO COMMENTS
not-supported 48u NO COMMENTS
equipment-missing 49u NO COMMENTS
license-graceperiod-expired 4u NO COMMENTS
configuration-mismatch 50u NO COMMENTS
kernel-mem-critical-threshold 51u NO COMMENTS
fan-removal 52u NO COMMENTS
health-critical 53u NO COMMENTS
health-major 58u NO COMMENTS
equipment-deprecated 59u NO COMMENTS
mgmtif-down 5u NO COMMENTS
equipment-unhealthy 60u NO COMMENTS
image-unusable 61u NO COMMENTS
equipment-unacknowledged 62u NO COMMENTS
backplane-port-problem 63u NO COMMENTS
pci-config-issue 64u NO COMMENTS
fabric-evacuated 65u NO COMMENTS
mgmt-db-corruption 66u NO COMMENTS
hardware-mismatch 67u NO COMMENTS
chassis-intrusion 68u NO COMMENTS
config-problem 69u NO COMMENTS
link-down 6u NO COMMENTS
hardware-inventory-mismatch 70u NO COMMENTS
pci-config-mismatch 71u NO COMMENTS
equipment-non-optimal 72u NO COMMENTS
unsupported-config 73u NO COMMENTS
config-mismatch 74u NO COMMENTS
election-failure 7u NO COMMENTS
management-services-failure 8u NO COMMENTS
management-services-unresponsive 9u NO COMMENTS
DEFAULT unspecified(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

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

name

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

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.