hostmap ‑list

Displays a list of host maps or available LUN numbers.

SYNOPSIS

hostmap ‑list 
   [‑details]
   [{ ‑unmapped
     | [{ ‑lun lun‑or‑clone‑id‑or‑fqn [, lun‑or‑clone‑id‑or‑fqn]...
        | ‑availableLunNumbers
        }]
       [{ ‑host host‑id‑or‑fqn [, host‑id‑or‑fqn]...
        | ‑hostmap hostmap‑id‑or‑fqn [, hostmap‑id‑or‑fqn]...
        | ‑hostGroup host‑group‑id‑or‑fqn [, host‑group‑id‑or‑fqn]...
        | ‑hostGroupMap host‑group‑map‑id‑or‑fqn 
            [, host‑group‑map‑id‑or‑fqn]... 
        }]
    }]

   [{‑sessionKey | ‑u admin‑user ‑oracleFS oracle‑fs‑system}]
   [{‑outputformat | ‑o} { text | xml }]
   [{‑timeout timeout‑in‑seconds | ‑verify | ‑usage | ‑example | ‑help}]

DESCRIPTION

Displays a list of the fully qualified names (FQNs) of the hosts, and the LUNs to which they are mapped. Use the ‑details option to see hostmap or hostgroupmap FQNs and unique identifiers (IDs), LUN numbers, and mapping types. Use the ‑unmapped option to display a list of the LUNs which have no mappings.

Note: Only administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the hostmap ‑list command.

OPTIONS

‑availableLunNumbers

Returns a list of all of the logical unit numbers that are available on the Oracle FS System, for a given SAN host or hostmap or SAN host group or hostgroup map. If neither hosts, host groups, nor maps are provided, then the globally available numbers are returned.

‑details

Provides the following information for each host mapping:

The fully qualified name (FQN) and unique identifier (ID) of the LUN or of the Clone LUN
The logical unit number of the LUN or of the Clone LUN
The FQN and the ID of the SAN host
The FQN and the ID of each initiator that is associated with the SAN host

‑host

Specifies a host entry which represents a computer on the customer SAN. You identify a host by providing a unique ID (ID) or a fully qualified name (FQN) for the host entry.

The list of host mappings are returned only for the specified SAN hosts.

‑hostGroup

Specifies a group of computers on the customer SAN. You identify the host group by providing a unique ID (ID) or a fully qualified name (FQN) for the group.

The list of host mappings are returned only for the specified host groups.

‑hostGroupMap

Specifies a mapping between a LUN and a host group. You identify the host group mapping by providing a fully qualified name (FQN) or a unique ID (ID).

The list of host mappings are returned only for the specified host group maps.

‑hostmap

Identifies a mapping between a LUN and a SAN host. You identify the hostmap by providing a unique ID (ID) or a fully qualified name (FQN).

The list of host mappings are returned only for the specified host maps.

‑lun

Specifies the ID or the fully qualified name (FQN) of a LUN that resides on the Oracle FS System. An FQN begins with a forward slash character ( / ) and is followed by a path expression to locate the LUN.

‑unmapped

Returns a list of LUNs which have no mappings. Only the fully qualified name (FQN) of the LUNs are returned. To display the FQNs and the unique identifiers (IDs) of the LUNs, include the -outputformat xml option. The -details option provides no additional information when used with hostmap -list -unmapped.

GLOBAL OPTIONS FOR SUBCOMMANDS

The following global options can be used for fscli command-subcommand pairs that do not include other command-line options:

‑help: Returns the context-sensitive help for the specified subcommand.
‑usage: Returns the subcommand syntax for the given command, including all of the options that are available for the command-subcommand pair.

GLOBAL OPTIONS FOR COMMANDS

The following global options can be used for fully formed fscli commands:

‑example

Returns sample output from the specified command.

Note: To see the output in XML format, include the ‑o xml option.

‑timeout timeout-in-seconds

Specifies the length of time (timeout-in-seconds) that the command line interface waits before another command is allowed to run. If the command takes longer to run than the specified time limit, the system continues processing the command, but the command prompt is made available so that you can issue another command. If the -timeout option is omitted, the command line interface blocks until the one of the following conditions is met:

The command completes successfully.
The command returns with an error.
The session times out.

Note: Be sure to check the state of the system after initiating a long running command with the ‑timeout option. Many fscli commands run a series of underlying commands in sequence. When the timeout value is reached before all of the underlying commands have completed, the fscli command does not complete with the outstanding tasks reporting a failure status.

‑outputformat | ‑o { text | xml }: Controls the type of the output the system returns from a command. If the ‑outputformat option is not included, the format of the output defaults to simple text. If xml is provided, the output is a collection of XML elements.
Note: For XML output, if internal errors occur during command execution, each error is included in a separate <ErrorList> tag.

‑verify: Inspects the validity of the command syntax, not the semantics. Used to test the structure of a command without running the command. Does not determine whether errors would be produced if you issue a structurally correct command with the input provided.
‑sessionkey: Directs the CLI to prompt you to supply a session key when you issue the command. The CLI displays Sessionkey: as the prompt. To obtain a session key, log in with the ‑returnKey option specified. After the session is established, the session key is displayed in STDOUT. If you request a session key, the ‑sessionkey option is required syntax for all commands that are issued in a given session. In environments with more than one Oracle FS System, the session key is used to determine to which Oracle FS System to direct the command for validation. Session keys are also used to establish two or more CLI sessions when using a shared administrator account.
‑u admin-user ‑oracleFS oracle‑fs-system: Routes the command to a particular Oracle FS System for execution. This option passes the name of the administrator account to use when opening the session on the specified system. Identify a specific Oracle FS System by its IP address or by the name that is recorded in the domain name system (DNS). When logging in to the Oracle FS System using the ‑u option and the ‑oracleFS option, the fscli application prompts you for a password on the command line interface for access. The Oracle FS System and the account login information are used to authenticate the current session. Establishing a login session by specifying an Oracle FS System and an account does not change the credentials that are associated with the active sessions that are running on other clients.
Caution
Oracle recommends that you not use the Cygwin command line interface to run the fscli application on Windows platforms. If you are running the Cygwin interface and include the ‑u option as a part of the ‑list subcommand, the password for the specified account is included in the results. Exposing the password can cause a breach in security.

EXAMPLE

Task

Display a detailed list of host maps that are associated with a given LUN.

Parameters

The details option

$ fscli hostmap ‑list ‑details