controller ‑modify

Modifies the configuration of a Controller.

SYNOPSIS

controller ‑modify    
    ‑controller controller‑id‑or‑fqn
     { ‑serviceType {san}
       ‑buddyController controller‑id‑or‑fqn
     | [‑displayNumber controller‑display‑number]
       [‑comment controller‑descriptive‑command]
     | ‑linkAggregation (
         ‑slot hba‑slot
         [{‑aggregate | ‑noAggregate}]
         [‑priority aggregation‑priority]
      )...
     }

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

DESCRIPTION

The following attributes can be modified without the assistance of Oracle Customer Support:

The display number
The informational comment string
The partner Controller assignments
The port provisioning settings
The link aggregation settings

Contact Oracle Customer Support for assistance with changing the service type setting.

Caution

Changing the display number, the partner Controller assignment, or the service type results in an immediate system shut down and restart.

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

OPTIONS

‑aggregate

Specifies that all ports on the HBA will appear as one port on the network. If this option is not provided, the default is to aggregate.

‑buddyController

Specifies the fully qualified name (FQN) or unique identifier (ID) of the Controller to configure as the partner Controller.

‑comment

Specifies a string of 256 characters that further identifies the Controller.

‑controller

Specifies the fully qualified name (FQN) or unique identifier (ID) of the Controller to modify.

‑displayNumber

Specifies the number that is displayed on the outside of the Controller. Values range from 01 to 99 and A0 to FF. The display number is included in the fully qualified name (FQN) of the Controller.

‑linkAggregation

Indicates that the individual HBA ports are linked and their combined throughput is presented to the network as a single port. Only two ports on a given HBA card can be link aggregated. Specify the following syntax for each set of ports to link aggregate:

-linkAggregation ( -slot hba-slot[ {-aggregate | -noAggregate} ][-priority aggregationPriority])
-linkAggregation ( -slot hba-slot[ {-aggregate | -noAggregate} ][-priority aggregationPriority])

Note: Depending on your operating system, you might have to escape the parentheses to use this option.

‑noAggregate

Reverses the link aggregation configuration that was previously set for the network interface HBA ports. Presents the ports as individual ports to the network.

‑priority

Specifies the priority for the link aggregation operation. Values range from 0 to 65535. Higher values indicate a lower priority. The value is used by the Oracle FS System as part of the link identity. If you do not specify a priority, the default value is 60000.

‑serviceType

Specifies the type of protocol that the Oracle FS System supports: san. The correct service type for your system is specified on the Sales Order and the System Customer Information Documents and should not be changed. If the installed hardware in the Controllers does not allow the changed service type, the system will not boot. Modify the service type only as instructed by Oracle Customer Support.

This option can only be used on Controllers that do not have a Service Type. After you change the Service Type, you must then run the haltpoint ‑resume command to resume the system restart.

‑slot

Specifies the slot number for the HBA card to provision. If this option is provided with the ‑linkAggregation option, the slot number specifies the HBA card to link aggregate.

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 display number of a Controller.

Parameters

The name of the Controller preceded by a forward slash: /⁠CONTROLLER-00
The new display number: 05

$ fscli controller ‑modify  ‑controller /⁠CONTROLLER-00 ‑displayNumber 05