Skip to main content
Hitachi Vantara Knowledge

Overview of embedded CCI

The embedded CCI software allows you to perform storage system configuration and provisioning operations on Hitachi Virtual Storage Platform E series Hitachi Virtual Storage Platform F350, F370, F700, F900 (VSP F350, F370, F700, F900) and Hitachi Virtual Storage Platform G350, G370, G700, G900 (VSP G350, G370, G700, G900) storage systems by issuing Command Control Interface (CCI) raidcom commands directly to the controller of the storage system.

About embedded CCI

Embedded CCI is factory-installed on the GUM component of the storage system controllers and is accessed from an SSH client on the management LAN. Embedded CCI starts and runs automatically when GUM (Gateway for Unified Management) is started. The following figure shows the system configuration for embedded CCI.

CCI Embedded system configuration: SSH client on management LAN
NoteThis document describes and provides instructions for using the embedded CCI software.
  • For information about the use of CCI raidcom commands to configure and provision your storage system, see the Command Control Interface User and Reference Guide.
  • For details about the raidcom commands (for example, syntax, options and parameters, output, examples), see the Command Control Interface Command Reference.
  • For details about provisioning operations, see the Provisioning Guide.

Supported commands

Embedded CCI supports all of the CCI raidcom commands (for example, raidcom get ldev, raidcom modify pool). The other CCI commands (for example, paircreate, horctakeover) are not supported.

The following raidcom command options are not supported by embedded CCI:

  • -login [<user_name> <password>]

    When this option is specified in embedded CCI, [EX_INVARG] (invalid argument) is returned.

  • -logout

    When this option is specified in embedded CCI, [EX_INVARG] (invalid argument) is returned.

  • -store <file name>

    When this option is specified in embedded CCI, [EX_INVARG] (invalid argument) is returned.

  • -zt <file name>

    When this option is specified in embedded CCI, [EX_INVOPT] (invalid option) is returned.

  • -load <file name>

    When this option is specified in embedded CCI, [EX_INVOPT] (invalid option) is returned.

  • -I[M][H][SI][TC]x (where x = natural number)

    When this option is specified in embedded CCI, [EX_INVARG] (invalid argument) is returned.

NoteThe help command (raidcom -h) displays all of the raidcom command options, including the options not supported by embedded CCI.
Supported shell commands

Embedded CCI supports the following shell commands:

  • exit

    Logs out from the GUM processor

  • logout

    Logs out from the GUM processor

  • echo $?

    Shows the return value of the raidcom command

Notes and restrictions for raidcom commands

Observe the following notes and restrictions when executing the raidcom command in embedded CCI:

  • Up to 20 simultaneous SSH connections to a GUM processor are supported.
  • The connection between embedded CCI and the storage system is disconnected when no raidcom command is issued for 60 minutes. If you run a raidcom command after the timeout, the [EX_ESSINV] error is returned. To run raidcom commands after the timeout, you must disconnect and then make the SSH connection.
  • The asynchronous command results are deleted when the SSH client is disconnected or when the timeout occurs. To confirm the command results before the SSH client is disconnected or the session times out, run the raidcom get command_status command.
  • User-defined script files cannot be created in an embedded CCI environment. If you want to use script files, use host-based CCI.
  • Instance numbers cannot be specified by the -I option.

Sessions and instances for embedded CCI

User sessions

An embedded CCI session is created when the SSH connection to the GUM processor is successfully established. If the session creation fails (because the SSH connection did not succeed), the raidcom command returns the [EX_ESNRDY] error message. The session is deleted when the following events occur:

  • The SSH connection is disconnected.
  • A timeout occurs (no raidcom command is issued for 60 minutes).
  • The storage system is rebooted.

If you run a raidcom command after the session has ended, the [EX_ESSINV] error message is returned.

Instances

Embedded CCI does not use instance numbers. Embedded CCI instances start and end automatically as follows:

  • When the GUM processor is booted, the embedded CCI instance starts.
  • When the GUM processor is turned off, the embedded CCI instance ends.
  • When the internal address of the GUM processor is changed, the embedded CCI instance reboots.
Note
  • An error occurs when instances with instance numbers are specified.
  • If you issue a raidcom command while the instance is not started, the [EX_ATTHOR] error message is returned.
  • When the GUM processor fails to boot, instances retry to start every 10 minutes.
  • The configuration definition file (HORCM file) for embedded CCI is created automatically on the GUM processor when an instance starts. You do not need to create the configuration definition file, and you cannot edit the file.

SSH specifications and requirements

The specifications and requirements for the SSH connection for embedded CCI are as follows:

  • Listen port20522(TCP)

    Use this port in management LAN and maintenance LAN.

  • Protocol versionV2
  • Encryption
    • DSA (1024-bit)
    • RSA (2048-bit)
  • Maximum connections20 connections per 1 GUM processor
  • Timeout between SSH server and GUMNone
  • Change key pair of serverNot supported
  • Refer to fingerprintNot supported
  • SCP/SFTPNot supported

Users and user authentication specifications

The user authentication environment for embedded CCI is the same as that for maintenance utility. Users who are displayed in the User Administration window of the maintenance utility can use embedded CCI using the same user name and password as for maintenance utility.

For details about adding and managing users, see the System Administrator Guide for the storage system.

The user authentication support specifications for embedded CCI are as follows:

  • User name
    • Number of characters: 1 to 63
    • Supported characters: letters, numbers, - . @ _
    • Default user name: maintenance

    The following user names cannot be used (an error message is returned when they are used):

    • sysadmin
    • root
    • avahi
    • messagebus
    • sshd
    • ntp
    • stunnel
    • daemon
    • admin
  • Password
    • Number of characters: 6 to 63
    • Supported characters: letters, numbers, - . @ _
    • Default password: raid-maintenance
  • Challenge-response authenticationNot supported
  • Public key authenticationNot supported
  • External authenticationSupported
  • Password authenticationNot supported

Using embedded CCI

You can use embedded CCI to issue CCI raidcom commands from an SSH client on the management LAN directly to the storage system. Before you can use embedded CCI, the storage system must be fully booted (the CCI instance starts when the GUM processor is booted). The CCI user session is created when the SSH client connects successfully.

Example of using embedded CCI

The following example shows how to change the threshold value of a pool using embedded CCI. In this example, the serial number of the storage system is 480002 and CTL 1 is used, so the command prompt is 480002-1:$.

  1. In the SSH client, specify the IP address of the controller and the connection port (20522) to connect to the GUM processor.

    The embedded CCI user session is created.

  2. Check the pool status:
    480002-1:$ raidcom get pool -key opt
  3. Change the threshold of the pool (pool ID = 6) to 70%:
    480002-1:$ raidcom modify pool -pool 6 -user_threshold 70
  4. Confirm that the threshold of the pool has changed to 70%:
    480002-1:$ raidcom get pool -key opt

Audit logs for embedded CCI

The audit logs for embedded CCI are created when the SSH connection is opened or closed and when raidcom commands are used. The audit logs are stored in the storage system (on the GUM processor).

  • When you open an SSH connection to the GUM processor:
    GUM,[BASE],Login,,Normal end,Seq.=xxxxxxxxxx
  • When you close an SSH connection to the GUM processor:
    GUM,[BASE],Logout,,Normal end,Seq.=xxxxxxxxxx

The IP address of the SSH client is output as the host identification value.

The audit logs for embedded CCI commands are output in the same format as the audit logs for host-based CCI. The IP address of the GUM processor is output as the host identification value.

You can use the embedded CCI audit logs to identify the user client who executed a raidcom command. To identify the user client who executed an embedded CCI command:

  1. Refer to the embedded CCI audit logs to determine the user name of the user who executed the command and the date and time at which the command was executed.
  2. In the audit logs of the storage system, locate the Login operation that meets all of the following conditions:
    • The Login operation was performed earlier than the time at which the command was executed (determined in step 1).
    • The Logout operation was not performed earlier than the time at which the command was executed (determined in step 1).
  3. In the log of the Login operation that you located in step 2, locate the host identification. The host identification value is the IP address of the SSH client from which the command was executed.

Error codes for embedded CCI session errors

The following table lists and describes the error messages displayed when session errors occur in raidcom commands. For details about other error messages returned by raidcom commands, see the Command Control Interface User and Reference Guide.

Error code

Error message

Description

Action

Return value

EX_ATTDBG

Can't be attached to a Debug layer.

CCI is starting.

Wait for a while, and execute the command again.

250

EX_ATTHOR

Can't be attached to HORC manage.

CCI has not started.

Confirm the storage system status is READY. Wait for 15 minutes and reexecute the command.

251

EX_ESSINV

The session information is invalid. Log in again.

Either of the following occurred:

  • The storage system was restarted while user logged on.
  • Timeout occurred.

Make the SSH connection again

195

EX_ESNRDY

This command cannot be executed in this session. Check if storage system is ready and log in again.

You are trying to log in before the storage system has fully started.

Make the SSH connection after you confirmed that the storage system has started.

196

 

  • Was this article helpful?