A P P E N D I X B

Storage Redirection Command-Line Modes, Syntax, and Usage

The Storage Redirection CLI supports both an interactive and non-interactive mode for entering commands. The interactive mode is useful when you need to enter a series of Storage Redirection commands. The non-interactive mode is useful when you need to run a batch procedure or script. The syntax required for entering the Storage Redirection commands in either of these modes is as follows.

- Interactive shell mode syntax

    <storageredir> <command> <command options> <sub-commands> <sub-command options>

To launch the Storage Redirection CLI and execute the commands directly from an interactive shell, you must first navigate to the location where the Storage Redirection Client was installed and launch the Storage Redirection CLI by issuing the java -jar StorageRedir.jar command. For instructions, see Launch Storage Redirection CLI Using a Command Window or Terminal.

- Non-interactive shell mode syntax

    $ java -jar StorageRedir.jar <command> <command options> <sub-commands> <sub-command options>

To launch the Storage Redirection CLI and execute the commands directly from a non-interactive shell, you must enter the Storage Redirection command (`java`
-`jar StorageRedir.jar`) at the shell prompt (`$`) followed by the commands you want to execute. For instructions, see, Launch Storage Redirection CLI Using a Command Window or Terminal.

#### Supported Storage Redirection Commands and Options

The following tables describe the supported commands and options you can issue in the Storage Redirection CLI.

- TABLE B-1 Storage Redirection Command

- TABLE B-2 Storage Redirection Command Options

- TABLE B-3 Storage Redirection Sub-Commands

- TABLE B-4 Storage Redirection Sub-Command Options

TABLE B-1 Storage Redirection Command
Command Name | Description
--- | ---
    java -jar StorageRedir.jar
| The `java -jar` command is used to launch the Storage Redirection client (`StorageRedir.jar`) from a command window or terminal.
`storageredir` | The `storagedir` command performs all storage redirection operations.

TABLE B-2 Storage Redirection Command Options
Option Name | Description
--- | ---
`- h` | The `- h` command option displays the command-line Help information.
`- v` | The `-v` command option displays the Java command version information.

TABLE B-3 Storage Redirection Sub-Commands
Sub-Command Name | Description
--- | ---
    list
| The `list` sub-command provides a list of the currently active storage redirections on one or all remote SPs. Syntax usage example:
    storageredir list [-p storageredir_port] [remote_SP]
    start
| The `start` sub-command invokes the specified redirection between the local host and the remote host server. If the authentication password is not provided, the system will prompt for it. Syntax usage example:
    storageredir start -r redir_type -t redir_type_path -u remote_username [-s remote_user_password] [-p storageredir_port] remote_SP
Note - You must specify a valid Admin or Console role account in ILOM to start the redirection of storage device on a remote server.
    stop
| The `stop` sub-command stops the specified redirection between the local host and the remote host server. If the authentication password is not provided, the system will prompt for it. Syntax usage example:
    storageredir stop -r redir_type -u remote_username[-s remote_user_password] [-p storageredir_port] remote_SP
Note - You must specify a valid Admin or Console role account in ILOM to stop the redirection of storage device on a remote server.
    test-service
| The `test-service` sub-command verifies whether the storage redirection service connection is active on the local host. Syntax usage example:
    storageredir test-service [-p storageredir_port]
    stop-service
| The stop-service sub-command stops the storage redirection service connection to the remote host server. Syntax usage example:
    storageredir stop-service [-p storageredir_port]

TABLE B-4 Storage Redirection Sub-Command Options
Sub-Command Option Name | Description
--- | ---
    -r redir_type
| The `-r` redir_type identifies the type of storage media being redirected. Valid device values for redir_type include: CD-ROM device Syntax:`-r` `cdrom` CD-ROM image: Syntax:`-r` `cdrom_img` Floppy device: Syntax:`-r` `floppy` Floppy image: Syntax:`-r` `floppy_img`
    -t redir_type_path
| The `-t` redir_type_path identifies the full path to where the storage redirection media is stored or mounted. Example:
    -t /home/username/JRC_Test_Images/CDROM.iso
    -u remote_username
| The `-u` remote_username identifies the user name required to log in to the ILOM SP. Example: `-u` john_smith Note - Any valid user account in ILOM can install or launch the Storage Redirection service or client on their local system. However, a valid Admin or Console role in ILOM is required to start or stop the redirection of a storage device on a remote server.
    -s remote_user_password
| The `-s` remote_user_password identifies the password required to log in to the ILOM SP. If this password command is not specified at the command line, the system will automatically prompt you for it.
    -p storageredir_port
| The `-p` storageredir_port identifies the storage redirection communication port on the local host. The default port provided is 2121. Example: `-p 2121`

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.