C H A P T E R  10

Disk Control and Monitoring

This chapter describes the Disk Control and Monitoring (DCM) application for the Sun Fire X4500 or X4540 server running Microsoft Windows Server 2003 R2 or R2 SP2.



Note - DCM is not currently supported for use with Windows Server 2008.


Information about DCM is described in the following sections:


Overview

DCM is a multi-document application for the Sun Fire X4500 or X4540 server running Microsoft Windows Server 2003 R2 and R2 SP2 operating system. DCM assists with drive insertion and removal, reports changes in disk configuration and, using the Microsoft IPMI system management driver, synchronizes the disk FRU (Field Replaceable Unit) information with information stored in the Sun Fire X4500 or X4540 server’s Baseboard Management Controller (BMC, also known as the Service Processor).


Installation

Before you can begin, DCM and its supporting software must be installed on your server. You will need to perform the following tasks if they have not already been done:


Starting DCM

To start the DCM application, double-click the Disk Control and Monitoring icon on the Windows desktop.

DCM consists of two documents, the Disk View document (default document) and the Volume View document. shows an example of the Disk View for the X4500 server, shows an example of Disk View for the X4540 server.

FIGURE 10-1 Example DCM Disk View Document for the X4500 Server


 [ D ]

 


Illustration #

Description

1

Disk Pane

2

Volume Pane

3

FRU Pane

4

Disk Map Pane




Note - The Drive Map Pane feature is only available for the Sun Fire X4500 server. It is not available for the Sun Fire X4540 server.


FIGURE 10-2 Example DCM Disk View Document for the X4540 Server


This is a picture of the DCM Disk View Document which includes the Disk pane, FRU pane, and Volume pane.

 


Illustration #

Description

1

Disk Pane

2

Volume Pane

3

FRU Pane



Viewing Information

DCM provides configuration and status information about the Sun Fire X4500 or X4540 server’s hard disks. The DCM Disk View Document is made up of four panes: Disk, Volume, FRU and Drive Map. The tables below describe each pane in detail. See Icons Used in DCM for details on icons associated with DCM commands.


TABLE 10-1 Disk Pane

Column

Description

Alerts (unlabeled column)

Shows icon alerts associated to a disk:

No icon - Normal working operation.

Warning - This icon will be displayed if the disk is seen as Foreign, Not ready, or No media.

Error - This icon will be displayed if the disk is seen as Failed, Missing, or Unknown.

Sync FRU - This icon will be displayed if the disk FRU information in DCM is not synchronized with information in the Baseboard Management Controller (BMC or Service Processor).

Disk Number

The Windows drive number.

DriveBay/Slot

The physical disk drive number.

Capacity

Formatted capacity of the disk.

Unallocated

Free disk space not assigned to any volume.

Type

There are two types of disks:

  • Basic - Basic disks use the basic partition scheme and contain basic volumes (primary partitions and extended partitions with logical drives). Basic disks use the Master Boot Record (MBR) partition style which was created for x86 systems and is backwards compatible with earlier versions of Windows.
  • Dynamic - Dynamic disks support dynamic volumes and include support for combining disks (using simple, spanned, and striped volumes) and fault tolerant volumes (using mirrored and RAID-5 volumes).

Status

Possible status for disks:

  • Online - The disk is accessible and healthy.
  • Not Initialized - The disk is unallocated and does not contain a partition.
  • Not Ready - The disk is not ready for use.
  • Foreign - The foreign status applies to disks that were once part of a volume, but disconnected and reconnected.
  • Failed - The disk is not readable and may be bad due to an error.
  • Missing - This status message indicates a dynamic disk is corrupted, turned off, or removed.
  • Unknown - Failed to obtain any disk properties.

 


TABLE 10-2 Volume Pane

Column

Description

Volume

The volume drive letter (e.g., D:\).

Partition

Identifies the primary boot device. (Boot drive only.)

Type

The volume types:

  • For Basic disks - Primary or Extended.
  • For Dynamic disks - Mirrored, RAID5, Simple, Spanned or Striped.

File System

File system on a volume (FAT32 or NTFS).

Status

Current state of a drive, such as formatting or healthy.

Capacity

Formatted capacity of a volume.

Size in Disk

The volume size on a disk.

Free Space

Unused volume space.

Fault Tolerance

Is displayed if the volume is fault tolerant. The values are: “Yes” or “No”.



Icons Used in DCM


TABLE 10-3 FRU Pane

Column

Description

FRU Entry

The various entries captured from the disk FRU (Field Replaceable Unit) information stored in the server’s Baseboard Management Controller (BMC or Service Processor).

Value

  • Vendor - Drive manufacturer.
  • Product - The product identification string.
  • Revision - The firmware version number.
  • Serial number.
  • Type/Size - The disk’s interface and unformatted capacity.


TABLE 10-4 Drive Map Pane--Available for X4500 Servers ONLY

Column

Description

Drive Base Slot number

The upper, left hand white number

Serial Number

In left hand gray bar

LED Status

  • Green light - drive OK
  • Blue light - drive location
  • Yellow light - drive error

Disk Number

Windows number

Dynamic Disk Type

Blue font - DDT

Basic Disk Type

Gray font - BDT

Uninitialized Drive

Red font - UD


The following section lists the icons used in DCM.


TABLE 10-5 Icons Used In DCM

Icon

Meaning


The Warning icon is displayed if the disk status is Foreign, Not Ready, Unallocated or No media.


The Error icon is displayed if the disk status is Failed, Missing or Unknown.


The SyncFru icon is displayed if the BMC FRU and Disk FRU are not synchronized.


The Add Disk icon is used to add a disk to a volume.


The Remove icon is used to remove a disk from a volume.


The Reactivate Disk returns a disk to a volume.


The Rescan icon refreshes the Disk View document with the current state of the BMC.


The Warning and Locate icon is displayed a warning if there is a possible disk problem.


The Locate icon is displayed when a drive location is enabled.


The Error and Locate icon is displayed when there is a possible disk problem.


The Remove Preview icon is displayed the volumes and disk drives to be removed.


The View Volume Information icon is displayed the Volume document.


The SyncFRU icon synchronizes a FRU with the BMC.


The View Slot (or Drive Map) icon toggles viewing of the Drive Map.


The Create Volume icon creates Dynamic volumes.


The Disk icon is displayed the Disk View document.


Locate Disk - Turns on a disk’s blue LED.


Stop Locate Disk - Turns off a disk’s blue LED.


Stop Locate All - Turns off all disk’s blue LEDs.



Menus and Toolbars

Performing DCM operations are done using commands in the menu bar and toolbar as illustrated below.

FIGURE 10-3 DCM Menu Bar and Toolbar


This is a picture of the Disk View document Menu bar and Toolbar.

You can navigate back and forth from the View menu and see the panels in each Disk and Volume View document.


Disk View Commands

This section describes the commands in the Disk View document.

File Menu

The File Menu includes the Save Report and Exit commands.

FIGURE 10-4 Disk View File Menu


 [ D ]

TABLE 10-6 File Menu

File Menu Item

Command Description

Save Report

Save Report - Saves the Disk View document panes to a Comma Separated Values (CSV) or XML file.

Exit

To exit DCM.

View Menu

The View menu includes FRU, Volume, and Drive commands.

FIGURE 10-5 View Menu


 [ D ]

TABLE 10-7 View Menu

View Menu Item

Command Description

FRU

Shows or hides FRU pane in the Disk View document.

Volume

Shows or hides Volume pane in the Disk View document.

Drives

Shows or hides Drive Map pane in the Disk View document.

Manage Menu

The Disk View Manage menu includes the following commands:

FIGURE 10-6 Disk View Manage Menu


 [ D ]

These commands are explained further below:

Add Disk

 


This command is used to add unused or unallocated disks to a volume. The Add Disk command changes a Basic disk to a Dynamic disk.

1. Select a disk to be added.

2. Click the Add Disk command.

DCM performs the following actions:

Remove Disk

 


This command is used to remove a Dynamic disk from a volume. The Remove Disk command changes a Dynamic disk to a Basic disk.



caution icon Caution - The Remove Disk command deletes the volume(s) on the selected disk. Do not perform this action on disks with data you want to keep because the data will be lost. If you are removing a RAID disk, refer to Removing a Disk That is Part of a RAID Volume.


1. Select the Dynamic disk to be removed.

2. Click the Remove Disk command.

If you are removing a disk that contains fault-tolerant volumes, DCM warns you with the following dialog box.

FIGURE 10-7 Remove Disk Dialog Box


 [ D ]



caution icon Caution - If you receive this warning, do not proceed unless you are sure your data is backed-up, or you no longer need it. Proceeding with this remove command will make any fault-tolerant volumes using this disk inaccessible.


DCM performs the following actions:

Removing a Disk That is Part of a RAID Volume

To remove a disk that is part of a RAID volume, you can use one of the following procedures:

Physically hot-remove the hard disk drive. When using this method, both the system software and Windows RAID will recognize that the disk has been removed.

a. Start Windows Disk Manager.

b. Select the hard disk drive in RAID volume to remove.

c. Right-click the drive and select offline.

d. Remove the disk from the system.

For a Sun Fire X4500 or X4540 server running Windows Server 2003, RAID disk volumes are configured and managed by Windows Disk Manager. For additional information about Windows Disk Manager, go to the following URLs:

http://support.microsoft.com/kb/816307
http://technet2.microsoft.com/WindowsServer/en/library/2c4910c6-1b83-40e5-810a-023993aa8b941033.mspx

Reactivate Disk

 


The Reactivate disk command adds a disk back to the fault tolerant volume.

1. Remove a disk from a fault tolerant volume.

2. Reinsert the disk.

3. Select the reinserted disk.

4. Click the Reactivate Disk command.

DCM performs the following actions:

Rescan

 


Rescan allows you to scan for updated disk configurations such as added or removed disks.

single-step bullet  Click the Rescan command to start the process.

DCM performs the following actions:

Remove Preview

 


Remove Preview shows disk drives and their associated volumes that would be affected if a disk were removed.

single-step bullet  Click the Remove Preview command.

FIGURE 10-8 Remove Preview


 [ D ]

Locate Disk

 


Turns on the blue LED that physically locates a disk drive in the server’s drive bay and the Drive Map pane.

1. Select a disk to be located.

2. Click the Locate Disk command.

DCM performs the following actions:

Stop Locate Disk

 


Turns off the blue LED that physically locates a disk drive in the server’s drive bay and the Drive Map pane.

1. Select a disk to be stopped.

2. Click the Stop Locate Disk command.

DCM performs the following actions:

Stop Locate All

 


Turns off all blue LEDs that physically locate all disk drives in the server’s drive bay and the Drive Map pane.

single-step bullet  Click the Stop Locate Disk command.

DCM performs the following actions:

Create Volume

 


The Create Volume command starts a Wizard that creates volumes on Dynamic disks.

1. Select a Dynamic disk.

2. Click the Create Volume command.

FIGURE 10-9 Create Volume Wizard Welcome


This is a picture of the Create Volume Wizard.

FIGURE 10-10 Create Volume Wizard - Select Volume Type


 [ D ]

3. Select the Volume Type you want to create.

Sync FRU

 


The Sync FRU command synchronizes the selected disk information with the IPMI FRU.

1. Select a disk.

2. Click the Sync FRU command.

DCM performs the following actions:

Right-Click Disk View Manage Menu

You can also right-click on a selected disk to invoke the Manage menu items as illustrated below.

FIGURE 10-11 Right-Click Disk View Manage Menu


 [ D ]

Window Menu

The Window menu includes the following commands:

FIGURE 10-12 Disk View Window Menu


 [ D ]


Menu Item

Command Description

Disk

View the Disk View document

Volume

View the Volume document


Help Menu

The Help menu includes the following commands:

FIGURE 10-13 Disk View Help Menu


 [ D ]


Menu Item

Command Description

Help

Content and Index is displayed in Help content.

About Disk Control and Monitoring

Displays the current version of the application.



Volume View Commands

This section describes the commands in the Volume View document.

FIGURE 10-14 Example Volume View for X4500 Server


 [ D ]

File Menu

The File Menu includes the following commands:

FIGURE 10-15 Volume View File Menu


This is a picture of the Volume View document, pointing out the File Menu


Menu Item

Command Description

Save Report

Saves the Volume View document panes to Comma Separated Values (CSV) or XML file.

Exit

To exit DCM.


View Menu

The View Menu includes the following commands:

FIGURE 10-16 Volume View View Menu


This is a picture of the Volume View document, pointing out the View Menu.


Menu Item

Command Description

Disk

Shows or hides the Disk pane in the Volume View document.

Drive

Shows or hides the Disk pane in the Volume View document.


Manage Menu

The Manage Menu includes the following commands:

FIGURE 10-17 Volume View Manage Menu


 [ D ]

Rescan

 


Rescan allows you to scan for updated disk configurations such as added or removed disks.

single-step bullet  Click the Rescan command.

DCM performs the following actions:

Delete Volume

Delete Volume deletes volumes on one or more disk drives.

1. Select a Dynamic Volume to delete.

2. Click the Delete Volume command.

DCM performs the following actions:

Locate Volume

 


Turns on the blue LED for all the disks associated with the selected volume.

1. Select the Volume to locate.

2. Click the Locate Volume command.

DCM performs the following actions:

Stop Locate Volume

 


Turns off a blue LED that physically locate a disk associated with the selected volume.

1. Select the volume to stop locating

2. Click the Stop Locate command.

DCM performs the following actions:

Stop Locate All

 


Turns off all blue LEDs that physically locate all the disks associated with the volumes.

single-step bullet  Click the Stop Locate All command.

DCM performs the following actions:

Right-Click Volume View Manage Menu

You can also right-click on a selected disk to invoke the Manage menu items, as illustrated below.

FIGURE 10-18 Right-Click Manage menu Volume View


 [ D ]

Window Menu

The Window Menu includes the following commands:

FIGURE 10-19 Volume View Window Menu


 [ D ]


Menu Item

Command Description

Disk

View the Disk View document.

Volume

View the Volume View document.


Help Menu

The Help menu includes the following commands:

FIGURE 10-20 Volume View Help Menu


 [ D ]


Menu Item

Command Description

Help

Contents and Index displays Help content.

About Disk Control and Monitoring

Displays the current version of the application.


 
TABLE 10-8 Volume View Help Menu Descriptions

Menu Item

Command Description

Help

Contents and Index displays Help content

About SUN Control and Monitoring

Displays the current version of the application


Uncontrolled Disk Insertion and Removal

DCM supports automatic detection of disk removal and insertion. If you remove or insert a disk (uncontrolled), the disk is detected and displayed in DCM.


Installing the DCM Remote Client

The Remote Client (CLI) is a method to obtain the information displayed in the DCM Disk View and Volume View documents.

Before you use the DCM Remote Client,

1. Download and install the Microsoft. NET Framework 2.0 from the following download site:

http://www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en

2. Copy the DCMRemoteSetup1.0.1.msi file to the remote machine and install as Administrator. Double-click to start the installation wizard.

DCM Remote Client Wizard Setup

1. The DCM Remote Client Setup Wizard takes you through the steps required to install DCM Remote Client on your computer.

FIGURE 10-21 DCM Remote Client - Select Installation Folder


 [ D ]

2. Select the folder where you want to install the DCM Remote Client.

FIGURE 10-22 DCM Remote Client Setup Wizard


This is a picture of the DCM Remote Client Setup Wizard screen.

3. Confirm the installation. The DCM Remote Client Wizard confirms the completion of the installation.

FIGURE 10-23 DCM Remote Client - Installation Complete


 [ D ]

4. The installation is complete. Close window.

FIGURE 10-24 Confirm Installation of DCM Remote Client


This is a picture of the DCM Remote Client Installation Complete screen.

Remote Client Sample Scripts

The DCM Remote Client Sample Scripts are stored in the DCM Remote Client folder, located at C:\Program Files\Sun\DCM Remote Client\Sample Scripts.

FIGURE 10-25 DCM Remote Client Folder


This is a picture of the DCM Remote Client folder and the Sample Scripts.

Modifying Each Sample Script

Each script must be modified with the Sun Fire server host name on the following line:

Set DCMService = CreateObject (“DCM.DCMService”, “Server Machine Name”)

where “Server Machine Name” is the host name of your Sun Fire server.


procedure icon  To Run the Remote Scripts

To run the remote scripts you use the Windows runas command.

1. Open a terminal window.

2. Enter the following command:


runas  /netonly /user:Administrator  "cmd.exe /K cscript c:\progra~1\SUN\DCMREM~1\SAMPLE~1\scriptname.vbs"

Where the script name.vbs is the name of the remote script you want to run.

You see the following output on the screen:


Enter the password for Administrator: 

1. Enter your server Administrator password.

2. Press Return or Enter.

You see the following output on the screen:


Attempting to start cmd.exe /K cscript c:\progra~1\SUN\DCMREM~1\SAMPLE~1\Disklist.vbs as user "ORION\Administrator" ...

A new command window appears with the results of the script.

Usage of DCM Remote Sample Scripts



Note - Each Create script needs to be modified prior to use.



TABLE 10-9 Usage of DCM Remote Sample Scripts

Script Name

Usage

Add Disk.vbs

Adds Unallocated (or) Basic (or) Foreign disk to Dynamic’pack.

Usage: AddDisk.vbs <DiskIndex>

CreateMirrorVol.vbs

Creates Mirrored volume

Usage: CreateMirrorVol.vbs <Create>

Modify the following input values:

  1. Change the Server Machine Name to your remote machine name.
  2. Change the disk index from ’13’, ’14’ to the disk index of the disks you want. You can use DiskList.vbs to get the disk index. Also, change the disk size from ’1073741824’ to the size of the disks.
  3. Change the accessPath from ’J:’ to a drive letter or an empty folder on NTFS.
  4. Change the ’DCMTestMirror’ to any name that you want to label the volume.

CreateRAID-5Vol.vbs

Creates RAID-5Vol

Usage: CreateRAID-5Vol.vbs <Create>

Modify the following input values:

  1. Change the Server Machine Name to your remote machine name.
  2. Change the disk index from ’20’, ’21’, ’22’ to the disk index of the disks you want. You can use DiskList.vbs to get the disk index. Also, change the disk size from ’1073741824’ to the size of the disks.
  3. Change the accessPath from ’I:’ to a drive letter or an empty folder on NTFS.
  4. Change DCMTestRAID-5 to any name that you want to label the volume.

CreateSimpleVol.vbs

Creates Simple volume

Usage: CreateSimpleVol.vbs <Create>

Modify the following input values:

  1. Change the Server Machine Name to your remote machine name.
  2. Change the disk index from ’15’ to the disk index of the disks you want. You can use the DiskList.vbs to get the disk index. Also, change the disk size from ’1073741824’ to the size of the disks.
  3. Change the access Path from ’L:’ to a drive letter or an empty folder on NTFS.
  4. Change DCMTestSimple to any name that you want to label the volume.

CreateSpannedVol.vbs

Creates Spanned volume

Usage: CreateSpannedVol.vbs <Create>

Modify the following input values:

  1. Change the ’Server Machine Name’ to your remote machine name.
  2. Change the disk index from ’16’, ’17’, ’18’ to the disk index of the disks you want. You can use DiskList.vbs to get the disk index. Also, change the disk size from ’1073741824’ to the size of the disks.
  3. Change the accessPath from ’K:’ to a drive letter or an empty folder on NTFS.
  4. Change DCMTestSpanned to any name that you want to label the volume.

CreateStripedVol.vbs

Creates Striped volume

Usage: CreateStripedVol.vbs <Create>

Modify the following input values:

  1. Change the Server Machine Name to your remote machine name.
  2. Change the disk index from ’16’, ’17’, ’18’ to the disk index of the disks you want. You can use DiskList.vbs to get the disk index. Also, change the disk size from ’1073741824’ to the size of the disks.
  3. Change the accessPath from ’H:’ to a drive letter or an empty folder on NTFS.
  4. Change DCMTestStriped to any name that you want to label the volume.

DiskList.vbs

Lists all disk indexes, their disk number, and slot number.

Usage: DiskList.vbs

LocateDisk.vbs

Locates the disk.

Usage: LocateDisk.vbs <Disk Index> <start/stop/stopAll>

RemoveDisk.vbs

Removes the disk from current dynamic pack.

Usage: RemoveDisk.vbs <Disk Index>

VolumeList.vbs

List all available volumes.



DCM Classes

Disk Control and Monitoring (DCM) provides classes that expose methods for querying, configuring, and maintaining Sun Fire X4500 or X4540 server disks. The following table lists available Classes.


TABLE 10-10 DCM Classes

Classes

Description

CDCMService

DCM Service that initializes and populates disk objects and volume objects.

CDCMDisk

Class provides method to query and configure disks.

CDCMBasicDisk

Class provides method to configure basic disks.

CDCMDynamicDisk

Class provides method to configure dynamic disks.

CDCMForeignDisk

Class provides method to configure foreign disks.

CDCMUnInitializedDisk

Class provides method to configure Unallocated disks.

CDCMDiskFRUInfo

Class provides method to get the disk FRU information.

CDCMDiskExtent

Class provides method to get the details of the extent on a disk.

CDCMVolume

Class provides method to query and configure volumes.

CDCMBasicVolume

Class provides method to configure basic volume.

CDCMDynamicVolume

Class provides method to configure dynamic volume.

CDCMVolumeExtent

Class provides methods to get the details of the volume extent.

CDCMCreateVolumeIntf

Class provides methods to create volume.


CDCMService


Method

Description

getNumDisk

Returns the number of disks.

getDisk

Returns the disk corresponding to the index.

getNumVolume

Returns the number of volumes.

getVolume

Returns the volume corresponding to the volume number.

init

Initializes the service.

scan

Scans for any changes.

scan

Returns the disk object of the specified Slot.

getSlotLEDStatus

Returns the LED status of the specified Slot.

getStatusChange

Gets the status change.


getNumDisk

ULONG getNumDisk(void);

This method returns the number of disk objects available in DCM Service.

Parameters

This method has no parameters.

Return Values

Returns the number of disks.

getDisk

CDCMDisk getDisk(ULONG DiskIx);

This method returns the disk object at the specified index.

Parameters

DiskIx

[in] Index of the disk in the DCM Service.

Return Values

Returns the disk object for the given index.

getNumVolume

ULONG getNumVolume(void);

This method returns the number of volume objects available in DCM Service.

Parameters

This method has no parameters.

Return Values

Returns the number of volume available in the DCM Service.

getVolume

CDCMVolume getVolume(ULONG VolNum);

This method returns the volume object for the given volume number.

Parameters

VolNum

[in] Internal volume number of the DCM Service.

Return Values

Returns the volume object for the given number.

init

ULONG init(void);

This method initializes the DCM Service.

Parameters

This method has no parameters.

Return Values

Returns 0 if the initialization is successful, otherwise -1.

scan

ULONG scan(void);

This method scans for changes and populates all the Disk and Volume objects.

Parameters

This method has no parameters.

Return Values

Returns 0 if scan operation successful, otherwise -1.

getDiskAtSlot

ULONG getDiskAtSlot(
   ULONG SlotNum
 );

This method returns the internal disk index of the given Slot number.

Parameters

SlotNum

[in] Slot Number of the physical disk.

Return Values

Returns the Disk index for the given slot number.

getSlotLEDStatus

ULONG getSlotLEDStatus(
   ULONG SlotNum
 );

This method returns the slot LED status.

Parameters

SlotNum

[in] Slot number of the disk.

Return Values

Returns the LED status for the given slot number.


LED Status

Value

Ready

1

Fault

2

OK To Remove

4


getStatusChange

ULONG getStatusChange(void);

This method returns the last event type. Returns 1, if a disk is removed from the system. Returns 2, if a disk is added to the system.

Parameters

This method has no parameters.

Return Values

Returns the last event type.

CDCMDisk


Method

Description

getDiskNum

Returns the disk number for the disk.

getPhysicalLocation

Returns the physical location of the disk.

getCapacity

Returns the size of the disk.

getStatus

Returns the current status of the disk.

getType

Returns the type of the disk.

getUnallocated

Returns the unallocated size of the disk.

locate

Locates the disk by blinking LEDs.

getFRU

Returns the FRU from the disk.

getBMCFRU

Returns the FRU information stored in the BMC.

getDiskImp

Returns the disk implementer interface.

getNumExtent

Returns the number of extents in the disk.

getExtent

Returns the extent corresponding to the index.

syncFRU

Synchronizes the FRU information.

getPartitionType

Returns the Partition type of the disk.

getDiskGUID

Returns the GUID of the disk.


getDiskNum

ULONG getDiskNum(void);
Parameters

This method has no parameters.

Return Values

This method returns the windows disk number. If the windows disk number is not present, the value 100 or greater than hundred will be returned.

getPhysicalLocation

BSTR getPhysicalLocation(void);
Parameters

This method has no parameters.

Return Values

This method returns the Drive Bay/Slot Number string. If the slot number is not present, the string "-" will be returned.

getCapacity

ULONGLONG getCapacity(void);
Parameters

This method has no parameters.

Return Values

This method returns the total size of the disk.

getStatus

ULONG getStatus(void);
Parameters

This method has no parameters.

Return Values

This method returns the availability of a physical disk A disk can return status online, even if the containing pack returns offline.

Disk Status

Disk Status

Value

Online

1

Not Ready

2

No Media

3

Failed

4

Missing

5


getType

ULONG getType(void);

Returns the type of the disk.

Parameters

This method has no parameters.

Return Values

This method returns the type of the disk.


Disk Type

Value

Basic

0

Dynamic

1

Foreign

2

Unallocated

3


getUnallocated

ULONGLONG getUnallocated(void);

Unallocated space available in the disk.

Parameters

This method has no parameters.

Return Values

This method returns the unallocated space in the disk.

locate

HRESULT locate(
   ULONG flag
 );
Parameters

flag

[in] value to indicate whether to start or stop locate disk. If the value is 1, DCM will start locate the disk. If the value is 0, DCM will stop locating the disk.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

getFRU

CDCMDiskFRUInfo getFRU(void);

This method returns the disk FRU information object CDCMDiskFRUInfo

Parameters

This method has no parameters.

Return Values

Returns the disk FRU information object.

getBMCFRU

CDCMDiskFRUInfo getBMCFRU(void);

This method fetches the FRU information stored in BMC (Baseboard Management Controller) for the disk.

Parameters

This method has no parameters.

Return Values

Returns the FRU information stored in the BMC.

getDiskImp

CDCMDisk getDiskImp(void);

This method returns the Disk implementation object based on the disk type.

Parameters

This method has no parameters.

Return Values

Returns either of the following disk objects based on the disk type

CDCMBasicDisk

CDCMDynamicDisk

CDCMUnallocatedDisk

CDCMForeignDisk

getNumExtent

ULONG getNumExtent(void);

This method returns the number of extents for the disk.

Parameters

This method has no parameters.

Return Values

Returns the number of disk extents.

getExtent

CDCMDiskExtent getExtent(
   ULONG ExtentIx
 );

This method returns the Disk Extent object (CDCMDiskExtent) for the specified index.

Parameters

ExtentIx

[in] Index of the disk Extent.

Return Values

Returns the Disk extent object.

syncFRU

HRESULT syncFRU();

This method synchronizes the disk FRU information in the BMC.

Parameters

This method has no parameters.

Return Values

This method returns the standard values S_OK and E_FAIL.

getPartitionType

ULONG getPartitionType(void);

This method returns the partition type of the disk.

Parameters

This method has no parameters.

Return Values

Returns the partition type of the disk.


Partition Style

Value

MBR (Master boot record)

0

GPT (GUID partition table)

1

Unknown

2


getDiskGUID

GUID getDiskGUID(void);

This method returns the GUID of the disk.

Parameters

This method has no parameters

Return Values

Returns the GUID of the disk.

CDCMBasicDisk


Method

Description

add

Adds the basic disk to the online pack


add

HRESULT add (void)

The add method adds the basic disk into the dynamic online pack. Converts the basic to dynamic disk.

Parameters

This method has no parameters.

Returns

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

CDCMDynamicDisk


Method

Description

remove

Reactivates failing or failed disk.

reactivate

Reactivates failing or failed disk.


remove

HRESULT remove();

This method removes the disk from online dynamic pack. After removing from the dynamic pack, the disk becomes a basic disk.

Parameters

This method has no parameters.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

reactivate

HRESULT reactivate();

The reactivate method returns a failing or failed disk to a healthy state, if possible. Although this method attempts to return a disk to a healthy state, it does not always succeed.

Parameters

This method has no parameters.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

CDCMForeignDisk


Method

Description

importToPack

Imports the disk to the online dynamic pack.


importToPack

Imports the disk to the online dynamic pack.

HRESULT importToPack();

This method imports all the disks from the same pack or disk group to online dynamic pack.

Parameters

This method has no parameters.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

CDCMUnInitializedDisk


Method

Description

add

Adds to the pack


add

HRESULT add();

The add method adds a disk to a online dynamic pack. This method initializes a disk that has no partitioning defined and adds it to the pack.

Parameters

This method has no parameters.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

CDCMDiskFRUInfo


Method

Description

vendor

Returns the vendor string

model

Returns Model

serialNum

Returns serial number

FWVersion

Returns FW Version

capacity

Returns capacity


vendor

BSTR vendor(void);

This method returns the vendor name string of the disk.For devices that have no vendor identifier, the value is zero.

Parameters

This method has no parameters.

Return Values

Returns the vendor name string.

model

BSTR model(void);

This method returns the model of the disk. For devices that have no model string, the value is zero.

Parameters

This method has no parameters.

Return Values

Returns the model of the disk.

serialNum

BSTR serialNum(void);

This method returns the serial number of the disk.For devices that have no serial number, the value is zero.

Parameters

This method has no parameters.

Return Values

Returns the serial number of the disk.

FWVersion

BSTR FWVersion(void);

This method returns the Firmware version of the disk. For devices that have no product revision, the value is zero.

Parameters

This method has no parameters.

Return Values

Returns the Firmware version.

capacity

BSTR capacity(void);

This method returns the capacity of the disk in bytes.

Parameters

This method has no parameters.

Return Values

Returns the capacity of the disk in bytes.

CDCMDiskExtent


Method

Description

getVolumeNum

Returns the volume number of this extent.

getOffset

Returns the offset of this disk extent.

getSize

Returns the size of the extent.


getVolumeNum

ULONG getVolumeNum(void);

This method returns the internal volume number.

Parameters

This method has no parameters.

Return Values

Returns the internal volume number.

getOffset

ULONGLONG getOffset(void);

This method returns the disk offset.

Parameters

This method has no parameters.

Return Values

Returns the disk offset.

getSize

ULONGLONG getSize(void);

This method returns the size of the extent in bytes.

Parameters

This method has no parameters.

Return Values

Returns the size of the extent.

CDCMVolume


Method

Description

getType

Returns the type of the volume.

getPath

Returns the path string.

getFileSystem

Returns the file system type.

getStatus

Returns the status of the volume.

getSize

Returns the size of the volume.

getFreeSpace

Returns the free space in the volume.

getNumExtent

Returns the number of extents in the volume.

getExtent

Returns the extent corresponding to the index.

getVolumeImp

Returns the underlying volume.

getVolumeGUID

Returns the GUID of the Volume.

getHealth

Returns the health of the volume.


getType

LONG getType(void);

This method returns the type of the volume.

Parameters

This method has no parameters.

Return Values

Returns the type of the volume.


Volume Type

Value

Basic

0

Dynamic

1


getPath

BSTR getPath(void);

This method returns the path to the volume.

Parameters

This method has no parameters.

Return Values

Returns the path to the volume.

getFileSystem

ULONG getFileSystem(void);

This method returns the file system type.

Parameters

This method has no parameters.

Return Values

Returns the file system type.


Volume Status

Value

Unknown

0

Online

1

No Media

2

Failed

3


getStatus

ULONG getStatus(void);

This method returns the status of the volume.

Parameters

This method has no parameters.

Return Values

Returns the status of the volume.


Volume Status

Value

Unknown

0

Online

1

No Media

2

Failed

3


getSize

ULONGLONG getSize(void);

This method returns the size of the volume.

Parameters

This method has no parameters.

Return Values

Returns the size of the volume.

getFreeSpace

ULONGLONG getFreeSpace(void);

This method returns the free space available in the volume.

Parameters

This method has no parameters.

Return Values

Returns the free space available in the volume.

getNumExtent

ULONG getNumExtent(void);

This method returns the number of extents available in the volume.

Parameters

This method has no parameters.

Return Values

Returns the number of extents available in the volume.

getExtent

CDCMVolumeExtent getExtent(
   ULONG ix, 
 );

This method returns the volume extent object.

Parameters

ix

[in] Index of the disk extent.

Return Values

Returns the volume extent object.

getVolumeImp

CDCMVolme getVolumeImp(void);

This method returns the underlying volume implementation.

Parameters

This method has no parameters.

Return Values

Returns the underlying volume implementation. The following are the possible volume object types:

CDCMBasicVolume

CDCMDynamicVolume

getVolumeGUID

BSTR getVolumeGUID(void);

This method returns the GUID of the volume.

Parameters

This method has no parameters.

Return Values

Returns the GUID of the volume.

getHealth

ULONG getHealth(void);

This method returns the health of the volume object.

Parameters

This method has no parameters.

Return Values

Returns the health of the volume object.


Health

Value

Unknown

0

Healthy

1

Rebuilding

2

Stale

3

Failing

4

Failing Redundancy

5

Failed Redundancy

6

Failed Redundancy Failing

7

Failed

8


CDCMBasicVolume


Method

Description

getPartitionType

Returns the partition type.


getPartitionType

ULONG getPartitionType(void);

This method returns the partition type of the volume.

Parameters

This method has no parameters.

Return Values

This method returns the partition type of the volume.


Partition Style

Value

MBR (Master Boot Record)

0

GPT (GUID partition table)

1

Unknown

2


CDCMDynamicVolume

Returns the volume type


Method

Description

getVolumeType

Returns the volume type.

isFaultTolerant

Returns 1 if fault tolerant.

IsOnline

Returns whether the volume is in online pack.

deleteVolume

Deletes the current volume.


getVolumeType

ULONG getVolumeType(void);

This method returns the volume type.


Volume Type

Value

Simple

0

Spanned

1

Striped

2

Mirrored

3

RAID-5

4

Unknown

5


Parameters

This method has no parameters.

Return Values

Returns the volume type.

isFaultTolerant

ULONG isFaultTolerant(void);

This method returns whether the volume is fault tolerant. Returns 1 if it is fault tolerant, otherwise 0.

Parameters

This method has no parameters.

Return Values

Returns whether the volume is fault tolerant.

IsOnline

ULONG IsOnline(void);

This method returns whether the volume is in online pack. Returns 1 if it is in online pack, otherwise 0.

Parameters

This method has no parameters.

Return Values

Returns whether the volume is in online pack.

deleteVolume

HRESULT deleteVolume();

Deletes the volume from the system.

Parameters

This method has no parameters.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

CDCMVolumeExtent

Method Description


Method

Description

getDisk

Returns the disk

getSize

method getSize


getDisk

LONG getDisk(void);

This method returns the DCM internal disk number.

Parameters

This method has no parameters.

Return Values

Returns the disk number.

getSize

ULONGLONG getSize(void);

This method returns the size of the extent in bytes.

Parameters

This method has no parameters.

Return Values

Returns the size of the extent.

CDCMCreateVolumeIntf

Method Description


Method

Description

addAccessPath

Adds the access Path to the new volume.

addInputDisk

Adds the input disk parameters for the new volume.

create

Creates new volume.

init

Initialize the Create volume Interface.

setFormatInfo

Set the parameters to format the new volume.


addAccessPath

HRESULT addAccessPath(
    BSTR accessPath
 );

Adds an access path. An access path can be a path to an empty folder or a drive letter.

Parameters

accessPath

[in] String indicating the access path. If the access path is a drive letter, you must include a trailing backslash; "E:' is an example.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

addInputDisk

HRESULT addInputDisk(
     ULONG 	diskIx, 
     ULONGLONG  diskSize
 );

Adds the input disk parameters. If you want to add N disk parameters, you have to call this method N times.

Parameters

diskIx

[in] Index value of the disk.

diskSize

[in] Size of the disk in bytes.

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

create

HRESULT create(
    LONG volumeType
 );

Creates the specified type of volume.

Parameters

volumeType

[in] Volume types are simple, spanned, striped (RAID-0), mirrored, or striped with parity (RAID-5).


Volume Type

Value

Simple

10

Spanned

11

Striped

12

Mirrored

13

RAID-5

14


Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

init

HRESULT init()

Initializes the create volume interface.

Parameters

This method has no parameters

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).

setFormatInfo

HRESULT setFormatInfo(
    LONG fileSystemType, 
    BSTR volumeLabel,
    ULONG allocationUnitSize, 
    LONG force,
    LONG quickFormat, 
    LONG enableCompression
 );

The setFormatInfo method specifies the attributes to format a file system on the current volume.

Parameters

fileSystemType

[ in ] File system type

File System Type

File System Type

Value

RAW

1

FAT

2

FAT32

3

NTFS

4

CDFS

5

UDF

6


volumeLabel

[in] String representing the file system label

allocationUnitSize

[in] The size of the allocation unit for the file system in bytes, which is usually between 512 and 65536.

force

[in] If the value is 1, then the file system is formatted unconditionally even while in use; otherwise, the operation fails.

quickFormat

[in] If the value is 1, DCM performs a quick format (it does not verify each sector on the volume).

enableCompression

[in] If the value is 1, compression is enabled on the newly formatted file system. Compression is a feature of NTFS, and is ignored for FAT and FAT32

Return Values

This method returns the standard values S_OK (0x00000000L) and E_FAIL (0x80004005L).