Managing Adapter

Table 1 lists the commands used for managing adapters.

Table 1  Managing Adapter

Command

IOC

IOP

ROC

Description

get

Get configuration information of VD, PD, array, HBA, or driver.

info

Display information on adapter (hba), virtual disk (vd), disk array, physical disk (pd), Port multiplexer (pm), expander (exp), block disk (blk) or spare drive information.

pause

Pause all background activities on specified adapter/controller.

set -o hba

Set configuration parameters of HBA.

set -o aes 

 

 

Set configuration for AES encryption

set -o aeslink 

 

 

Set configuration for AES Link

get

Use get to display the properties of virtual disks, physical disks, arrays, HBA (adapter/controller), and the driver.

The syntax for the get command (including all required and optional parameters) is as follows:

get -o <vd|array|pd|hba|aes|aeslink|driver> [-i <VD id|array id|PD id|HBA id|aes port id>] [-h]

Table 2 describes the required and optional parameters for the get command.

Table 2  Command Parameters: get

Syntax

Description

Required Parameter

-o <vd|array|pd|hba|aes|aeslink|driver>

Use one of the following options to select the object:

   vd (virtual disk)

   array (disk array)

   pd (physical disk)

   hba (adapter/controller)

   aes (AES)

   aeslink (AES link)

   driver (driver)

Note: CLI does not support get -o driver in Linux or Mac OS X.

Optional Parameters

[-i <VD id|array id|PD id|HBA id|aes port id>]

Use to specify object ID.

Note: This parameter is not applicable to objects aeslink and driver. If this parameter is not included in the command line for all other objects, CLI displays properties for all instances of the object.

[-h]

Use to display help text on get command.

Example

get -o hba -i 1

Display properties of adapter/controller 1.

info

Use info for information on all hardware and software components.

The syntax for the info command (including all required and optional parameters) is as follows:

info -o <hba|vd|pd|array|pm|exp|blk|spare|bbu> [-i <id>] [-h]

Table 3 describes the required and optional parameters for the info command.

Table 3  Command Parameters: info

Syntax

Description

Required Parameter

-o <hba|vd|pd|array|pm|exp|blk|spare|bbu>

Use one of the following options to select the object:

   hba (adapter/controller)

   vd (virtual disk)

   pd (physical disk)

   pm (port multiplexer)

   exp (expander)

   spare (spare drives)

   bbu (battery backup unit)

Optional Parameters

[-i <id>]

Use to specify object ID.

Note: If this parameter is not included in the command line, CLI displays information for all instances of the object.

[-h]

Use to display help text on info command.

Example

info -o hba

Display information on all HBAs.

pause

Use pause to pause all background activities on the selected controller.

The syntax for the pause command (including all required and optional parameters) is as follows:

pause -c <controller id> [-h]

Table 4 describes the required and optional parameters for the pause command.

Table 4  Command Parameters: pause

Syntax

Description

Required Parameter

-c <controller id>

Use to specify controller ID.

Optional Parameter

[-h]

Use to display help text on pause command.

Example

pause -c 1

Pause all background activities on controller 1.

set -o hba

The syntax for the set -o hba command (including all required and optional parameters) is as follows:

set -o hba [<--autorebuildon|--autorebuildoff>] [--optimizeon|--optmizeoff] [<--smarton|--smartoff>] [<--alarmon|--alarmoff>] [<--virtualatapidisable|--virtualatapienable>] [<--moduleconsolidateon|--moduleconsolidateoff>] [-r <BGA rate>]

Table 5 describes the required and optional parameters for the set -o hba command.

Table 5  Command Parameters: set -o hba

Syntax

Description

Required Parameter

None

n/a

Optional Parameters

[<--autorebuildon|--autorebuildoff>]

Use one of the following options to enable/disable auto rebuild:

   --autorebuildon (enable)

   --autorebuildoff (disable)

[--optimizeon|--optmizeoff]

Use one of the following options to enable/disable optimization:

   --optimizeon (enable)

   --optimizeoff (disable)

[<--smarton|--smartoff>]

Use one of the following options to enable/disable S.M.A.R.T.:

   --smarton (enable)

   --smartoff (disable)

[<--alarmon|--alarmoff>]

Use one of the following options to enable/disable alarm

   --alarmon (enable)

   --alarmoff (disable)

[<--virtualatapidisable|--virtualatapienable>]

Use one of the following options to enable/disable Virtual ATAPI:

   --virtualatapidisable (disable)

   --virtualatapienable (enable)

[<--moduleconsolidateon|
--moduleconsolidateoff>]

Use one of the following options to enable/disable module consolidation:

   --moduleconsolidateon (enable)

   --moduleconsolidateoff (disable)

[-r <BGA rate>]

Use to specify the BGA (background activity) rate (between 0 and 100).

Example

set -o hba --autorebuildon --smarton --alarmon

Enable auto rebuild, S.M.A.R.T, and alarm on the HBA.

set -o aes

The syntax for the set -o aes command (including all required and optional parameters) is as follows:

set -o aes -i <port id> <--aeson|--aesoff> [--keyclear|--key128|--key256] <-k key> [-h]

Table 6 describes the required and optional parameters for the set -o aes command.

Table 6  Command Parameters: set -o aes

Syntax

Description

Required Parameters

-i <port id>

Use to specify Port ID

<--aeson|--aesoff>

Use one of the following options to enable/disable AES:

   --aeson (enable AES)

   --aesoff (disable AES)

<-k key>

Replace key with a key-phrase that will generate the AES key for encryption.

Optional Parameters

[--keyclear|--key128|--key256]

Use one of the following options to specify the AES key bit-level:

   --keyclear (use to clear encryption)

   --key128 (128-bit)

   --key256 (256-bit)

[-h]

Use to display help text on set - o aes command.

Example

set -o aes -i 1 --aeson --key128 -k marvell

Enable 128-bit AES encryption on port 1 using key-phrase marvell.

set -o aeslink

The syntax for the set -o aeslink command (including all required and optional parameters) is as follows:

set -o aeslink -i <port id> -e <entry id> [-h]

Table 7 describes the required and optional parameters for the set -o aeslink command.

Table 7  Command Parameters: set -o aeslink

Syntax

Description

Required Parameters

-i <port id>

Use to specify Port ID.

-e <entry id>

Use to specify Entry ID.

Optional Parameter

[-h]

Use to display help text on set - o aeslink command.

Example

set -o aeslink -i 2 -e 1

Enable (configured) AES encryption on port 2 for entry 1.