Cisco System Model: Classmo:KvCfgHolder

Overview

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Naming

Class mo:KvCfgHolder (CONCRETE)

Class ID:2488
Encrypted: false - Exportable: true - Persistent: true
Privileges: [See Containers Hierarchies]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.78.5

A container for configured MO annotations

Naming Rules

RN FORMAT: cfg-kv

    [1] PREFIX=cfg-kv


DN FORMAT: 

[0] sys/chassis-[id]/blade-[slotId]/cfg-kv

[1] sys/rack-unit-[id]/cfg-kv

[2] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/cfg-kv

[3] org-[name]/tier-[name]/ls-[name]/cfg-kv

[4] org-[name]/ls-[name]/cfg-kv

[5] org-[name]/cfg-kv

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

├

ls:Server Logical Server Definition. Holds and Regulates Specification of: identity connectivity applied to the physical compute node like compute:Blade upon association. Logical Server can serve the following purposes: associatable instance initialization template persistent ...

├

mo:KvCfgHolder
Privileges: admin, ls-compute, ls-config, ls-server

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

mo:KvCfgHolder
Privileges: admin, ls-compute, ls-config, ls-server

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

├

mo:KvCfgHolder
Privileges: admin, org-management

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.

├

compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.

├

mo:KvCfgHolder
Privileges: admin, pn-equipment, pn-maintenance, pn-policy

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.

├

equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.

├

compute:Blade A physical compute blade. Physical compute item in blade form factor.

├

mo:KvCfgHolder
Privileges: admin, pn-equipment, pn-maintenance, pn-policy

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.

├

compute:Cartridge A physical compute cartridge.

├

compute:ServerUnit A server instance on a cartridge.

├

mo:KvCfgHolder
Privileges: admin, pn-equipment, pn-maintenance, pn-policy

Contained Hierarchy

mo:KvCfgHolder

├	mo:AbstractCfgKv An abstract representation of a configured annotation.

Inheritance

mo:KvCfgHolder

Events

Faults

Fsms

Properties Summary

Defined in: mo:KvCfgHolder
mo:FileTxAdminState scalar:Enum8	fileTxAdminState (mo:KvCfgHolder:fileTxAdminState) Specifies if file transfer is enabled between Host OS and BMC.
mo:AnnotationOperState scalar:Enum8	operState (mo:KvCfgHolder:operState) 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

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

fileTxAdminState

Type: mo:FileTxAdminState
Primitive Type: scalar:Enum8

Units: null

Encrypted: false

Access: admin

Category: TopLevelRegular

Property Validators:

Comments:

Specifies if file transfer is enabled between Host OS and BMC.

Constants
disabled	0	File transfer is disabled between Host OS and BMC
enabled	1	File transfer is enabled between Host OS and BMC
DEFAULT	enabled(1)	File transfer is enabled between Host OS and BMC

operState

Type: mo:AnnotationOperState
Primitive Type: scalar:Enum8

Units: null

Encrypted: false

Access: implicit

Category: TopLevelRegular

Property Validators:

Comments:

NO COMMENTS

Constants
ok	0	Annotations are configured.
not-supported	1	Endpoint does not support Annotation Capability
config-failure	2	Failure to configure annotations
DEFAULT	ok(0)	Annotations are configured.

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.