Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class storage:ControllerRef (CONCRETE)

Class ID:2251
Encrypted: false - Exportable: false - Persistent: true
Privileges: [read-only]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.118.6

Represents ownership for server,controller combination

Naming Rules 
RN FORMAT: server-[serverId]-controller-[controllerType]-[controllerId]

    [1] PREFIX=server- PROPERTY = serverId


    [2] PREFIX=-controller- PROPERTY = controllerType


    [3] PREFIX=- PROPERTY = controllerId




DN FORMAT: 

[0] sys/chassis-[id]/blade-[slotId]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[1] sys/rack-unit-[id]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[2] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[3] sys/chassis-[id]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[4] sys/chassis-[id]/blade-[slotId]/board/storage-[type]-[id]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[5] sys/rack-unit-[id]/board/storage-[type]-[id]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[6] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/board/storage-[type]-[id]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]

[7] sys/chassis-[id]/storage-[type]-[id]/enc-[id]/disk-slot-[id]/server-[serverId]-controller-[controllerType]-[controllerId]


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.
 ├
 		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.
 
 		 
 		 ├
 		compute:Board Motherboard contained by physical compute item.
 
 		 
 		 
 		 ├
 		storage:Controller
 
 		 
 		 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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.
 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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.
 
 		 
 		 
 		 ├
 		compute:Board Motherboard contained by physical compute item.
 
 		 
 		 
 		 
 		 ├
 		storage:Controller
 
 		 
 		 
 		 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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.
 
 		 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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:Cartridge A physical compute cartridge.
 
 		 
 		 
 		 ├
 		compute:ServerUnit A server instance on a cartridge.
 
 		 
 		 
 		 
 		 ├
 		compute:Board Motherboard contained by physical compute item.
 
 		 
 		 
 		 
 		 
 		 ├
 		storage:Controller
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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:Cartridge A physical compute cartridge.
 
 		 
 		 
 		 ├
 		compute:ServerUnit A server instance on a cartridge.
 
 		 
 		 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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.
 
 		 
 		 ├
 		storage:Controller
 
 		 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef
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.
 
 		 
 		 ├
 		storage:Enclosure
 
 		 
 		 
 		 ├
 		storage:EnclosureDiskSlotEp Indicates the disk slot in an enclosure. When the slot is populated, peerDn references the disk present. This is the same as the LocalDiskSlotEp mo. This mo was created because of a conflict between LocalDiskSlotEp and LocalDisk. Both have the same rn and therefore cannot be contained under the same container.
 
 		 
 		 
 		 
 		 ├
 		storage:ControllerRef


Contained Hierarchy
storage:ControllerRef
Inheritance
storage:ASlot Represents abstract class to store ownership for controllers
 ├
 		storage:ControllerRef
Events


Faults


Fsms


Properties Summary
Defined in: storage:ControllerRef
equipment:Id
          scalar:Uint32 		controllerId  (storage:ControllerRef:controllerId)
           NO COMMENTS
storage:ControllerType
          scalar:Enum8 		controllerType  (storage:ControllerRef:controllerType)
           NO COMMENTS
fsm:Lifecycle
          scalar:Enum8 		lc  (storage:ControllerRef:lc)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		serverId  (storage:ControllerRef:serverId)
           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

controllerId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

controllerType

Type: storage:ControllerType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
SAS 1 NO COMMENTS
SATA 2 NO COMMENTS
FLASH 3 NO COMMENTS
SD 4 NO COMMENTS
PT 5 NO COMMENTS
PCH 6 NO COMMENTS
external 7 NO COMMENTS
NVME 8 NO COMMENTS
HBA 9 NO COMMENTS
M2 10 NO COMMENTS
DEFAULT SAS(1) 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" />

lc

Type: fsm:Lifecycle
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
available 0 NO COMMENTS
allocated 1 NO COMMENTS
deallocated 2 NO COMMENTS
repurposed 3 NO COMMENTS
DEFAULT available(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

serverId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
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.

Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming