san_host ‑modify

Changes the properties of a SAN host entry.

SYNOPSIS

san_host ‑modify 
   ‑sanhost sanhost‑id‑or‑fqn
   [‑name new‑sanhost‑name]
   [{‑hpuxCompatibility | ‑noHpuxCompatibility}]
   [‑fcInitiatorPort [fcinitiator‑wwn[/fcinitiatorport‑alias]
                     [ ,fcinitiatorport‑wwn[/fcinitiatorport‑alias] ]... ] ]
   [‑lunSettings lun‑id‑or‑fqn/load‑balance‑type
                  [, lun‑id‑or‑fqn/load‑balance‑type]... ]
   [{‑reconcileMappings | ‑noReconcileMappings}]
   [{ ‑associateGroup host‑group‑id‑or‑fqn
      [‑suppressWarnings]
    | ‑unAssociateGroup
      {‑removeMappings | ‑preserveMappings}
    }]

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

DESCRIPTION

Use the san_host ‑modify command to change the attributes of the SAN host entry. You can also update the host group association of the SAN host entry. When removing a host group association you have the option to retain or remove the LUN mappings that are associated with the LUNs that are mapped to the host group.

Note: Only administrators with primary administrator, admin1, or admin2 roles are authorized to run the san_host ‑modify command.

OPTIONS

‑associateGroup

Specifies the ID or the fully qualified name (FQN) of the host group with which to associate the SAN host.

The system updates all of the LUN mappings for the SAN host so that the mappings are associated with the specified group while retaining those mappings with LUNs that are not mapped by the host group.

If the SAN host is mapped to a LUN that is already mapped by the host group, the host mapping is replaced by the host group mapping.
If the association of the SAN host to the host group is removed, the host retains the host group mappings to the LUN until the host LUN mapping is changed.
If LUN mappings exist that will be changed to that of the host group, the user is informed and prompted to confirm the association with the host group.

‑fcInitiatorPort

Specifies the Fibre Channel (FC) HBA ports on the SAN host that can connect to the Oracle FS System. The system recognizes the following two formats for specifying HBA ports:

Required: 16 hexadecimal digits that are separated by colons, as in xx:xx:xx:xx:xx:xx:xx:xx, where each xx is a hexadecimal number.
Note: The colons are optional.
Optional: an alias for the port consisting of a slash character ( / ) that is followed by the text of the alias.

Include all of the desired ports in the list. If you omit an existing port, that port is deleted from the host entry. If no FC ports are specified for the ‑fcInitiatorPort option, all of the FC ports are removed.

Note: The ‑fcInitiatorPort option should not be used for the host entries that are created and managed by Oracle FS Path Manager (FSPM), which is running on the SAN host.

‑hpuxCompatibility

Identifies the host as using the HP-UX addressing mode for LUNs.

‑lunSettings

Specifies, for the specified LUNs, the load balancing mechanism that is to be used by the Oracle FS Path Manager (FSPM) software that is running on the host to manage the paths from the host to the Controllers. If FSPM is not running on the host, or if the version of FSPM on the host does not allow load balancing to be set from the Oracle FS System, this option is ignored. Valid values:

static: Uses a single host-to-Controller path until the path becomes unavailable, then uses the next higher priority path, and so forth.
roundRobin: Rrotates among the host-to-Controller paths at the host, using the highest priority path group.

Note: The ‑lunSettings option has no impact on the behavior of hosts that are not using FSPM.

‑name

Specifies a new name for the SAN host. The name that you provide causes the system to replace the previously defined fully qualified name of the host as well. To prevent parsing errors, use double quotation marks around names containing one or more spaces or dashes.

Note: The ‑name option should not be used for the host entries that are created and managed by Oracle FS Path Manager (FSPM), which is running on the SAN host.

‑noHpuxCompatibility

Disables the HP-UX LUN addressing mode for the SAN host.

‑noReconcileMappings

Disables the automatic fixing of any LUN mappings for this host that cause mapping conflicts.

‑preserveMappings

Retains the host group LUN mappings after the SAN host is removed from the host group.

‑reconcileMappings

Specifies that any subsequent LUN mappings for this host that cause a conflict are automatically fixed. If this option is omitted, ‑noReconcileMappings is the default.

‑removeMappings

Removes the LUN mappings that were established for the SAN host while it was associated with the host group when the association between the host and host group is removed.

‑sanhost

Specifies the ID or the fully qualified name (FQN) of the SAN host.

‑suppressWarnings

Prevents the system from prompting for a confirmation that the LUN mappings for the SAN host will be changed to the mappings of the host group.

‑unAssociateGroup

Removes the host from the specified host group.

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

Change the properties of a SAN host entry to specify that any subsequent LUN mappings for this host that cause a conflict are automatically fixed.

Parameters

The FQNs of the SAN host to modify: /⁠sanhost_1

$ fscli san_host ‑modify ‑sanhost /⁠sanhost_1 ‑reconcileMappings