Class callhome:PeriodicSystemInventory (CONCRETE)

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

NO COMMENTS


Naming Rules
RN FORMAT: periodicsysteminventory

    [1] PREFIX=periodicsysteminventory


DN FORMAT: 

[0] call-home/periodicsysteminventory

                



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


Contained Hierarchy
callhome:PeriodicSystemInventory

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

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: callhome:PeriodicSystemInventory
callhome:AdminState
          scalar:Enum16
adminState  (callhome:PeriodicSystemInventory:adminState)
           NO COMMENTS
callhome:PeriodicSystemInventoryIntervalDays
          scalar:Uint32
intervalDays  (callhome:PeriodicSystemInventory:intervalDays)
           NO COMMENTS
callhome:Date
          scalar:Date
lastDeadline  (callhome:PeriodicSystemInventory:lastDeadline)
           NO COMMENTS
callhome:PeriodicSystemInventoryMaximumRetryCount
          scalar:Uint32
maximumRetryCount  (callhome:PeriodicSystemInventory:maximumRetryCount)
           NO COMMENTS
callhome:PeriodicSystemInventoryMinimumSendNowIntervalSeconds
          scalar:Uint32
minimumSendNowIntervalSeconds  (callhome:PeriodicSystemInventory:minimumSendNowIntervalSeconds)
           NO COMMENTS
callhome:Date
          scalar:Date
nextDeadline  (callhome:PeriodicSystemInventory:nextDeadline)
           NO COMMENTS
callhome:PeriodicSystemInventoryPollIntervalSeconds
          scalar:Uint32
pollIntervalSeconds  (callhome:PeriodicSystemInventory:pollIntervalSeconds)
           NO COMMENTS
scalar:Uint32 retryCount  (callhome:PeriodicSystemInventory:retryCount)
           NO COMMENTS
callhome:PeriodicSystemInventoryRetryDelayMinutes
          scalar:Uint32
retryDelayMinutes  (callhome:PeriodicSystemInventory:retryDelayMinutes)
           NO COMMENTS
scalar:Bool sendNow  (callhome:PeriodicSystemInventory:sendNow)
           NO COMMENTS
callhome:PeriodicSystemInventoryTimeOfDayHour
          scalar:Uint32
timeOfDayHour  (callhome:PeriodicSystemInventory:timeOfDayHour)
           NO COMMENTS
callhome:PeriodicSystemInventoryTimeOfDayMinute
          scalar:Uint32
timeOfDayMinute  (callhome:PeriodicSystemInventory:timeOfDayMinute)
           NO COMMENTS
callhome:Date
          scalar:Date
timeOfLastAttempt  (callhome:PeriodicSystemInventory:timeOfLastAttempt)
           NO COMMENTS
callhome:Date
          scalar:Date
timeOfLastSuccess  (callhome:PeriodicSystemInventory:timeOfLastSuccess)
           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:AdminState
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
off 0 NO COMMENTS
on 1 NO COMMENTS
DEFAULT off(0) 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

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

intervalDays

Type: callhome:PeriodicSystemInventoryIntervalDays
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)30l
Comments:
NO COMMENTS
Constants
defaultValue 30u NO COMMENTS

lastDeadline

Type: callhome:Date
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

maximumRetryCount

Type: callhome:PeriodicSystemInventoryMaximumRetryCount
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)5l
Comments:
NO COMMENTS
Constants
defaultValue 1u NO COMMENTS

minimumSendNowIntervalSeconds

Type: callhome:PeriodicSystemInventoryMinimumSendNowIntervalSeconds
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)2000000000l
Comments:
NO COMMENTS
Constants
defaultValue 5u NO COMMENTS

nextDeadline

Type: callhome:Date
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT never(0ull) NO COMMENTS

pollIntervalSeconds

Type: callhome:PeriodicSystemInventoryPollIntervalSeconds
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)10l  max: (long)3600l
Comments:
NO COMMENTS
Constants
defaultValue 300u NO COMMENTS

retryCount

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

retryDelayMinutes

Type: callhome:PeriodicSystemInventoryRetryDelayMinutes
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)60l
Comments:
NO COMMENTS
Constants
defaultValue 10u 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.


timeOfDayHour

Type: callhome:PeriodicSystemInventoryTimeOfDayHour
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)23l
Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

timeOfDayMinute

Type: callhome:PeriodicSystemInventoryTimeOfDayMinute
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)59l
Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

timeOfLastAttempt

Type: callhome:Date
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

timeOfLastSuccess

Type: callhome:Date
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT never(0ull) NO COMMENTS