controller ‑modifyAgentHaFlags

Modifies the high availability (HA) settings for a Controller.

SYNOPSIS

controller ‑modifyAgentHaFlags 
   [‑controller controller‑id‑or‑fqn ]
   { [‑noWarmstart]
     [‑noFailover]
     [‑clearWsCounter]
     [‑debugMode]
   | ‑clearFlags
   }

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

DESCRIPTION

When troubleshooting a Controller, an Oracle Customer Support representative might change one or more of the high availability (HA) settings. The HA flags modify the normal operating behaviors of the Controllers in the following ways:

The no warm start HA flag instructs the Oracle FS System to convert all attempts to perform a soft reboot (warmstart) into a Controller failure so that all resources are failed over to the peerController.
The no Failover HA flag instructs the Oracle FS System to prevent the Controller from failing when the warm start counter reaches a value of four. The clear HA flag undoes the no Failover HA flag.
The clear warm start HA flag instructs the Oracle FS System to clear the number of warm starts that have been recorded for the specified Controller.
The debug HA flag instructs the Oracle FS System to capture additional information that can assist Oracle Customer Support with troubleshooting the Controller.

Note: Do not run the controller ‑modifyAgentHAFlags command unless instructed to do so by Oracle Customer Support. Only administrators with support roles are authorized to run the controller ‑modifyAgentHaFlags command.

OPTIONS

‑controller: Specifies the fully qualified name (FQN) or unique identifier (ID) of the Controller if you are resetting the Agent HA flags for a specific Controller. If no controller is specified, the HA flags are reset for all Controllers.
‑noWarmstart: Indicates that if the Oracle FS System attempts to perform a warmstart on the Controller, the warmstart attempt is re-initialized as a Controller failure. The Controller fails over to the peer. Then, the Controller attempts to re-initialize and fail back.
‑noFailover: Indicates that on the fourth attempt, the Oracle FS System will warm start the Controller instead of failing over the Controller to its peer.
‑clearWsCounter: Resets the warm start counter. If you clear the warm start counter for a Controller before the possibility of a fourth warm start occurring, the fourth warm start will not be converted into a Controller failure.
‑debugMode: Places the Controller in a debugging mode.
‑clearFlags: Clears all high availability (HA) indicators and returns the settings to the default values, including the warm start counter.
Note: The Oracle FS System maintains the failure history of the Controller on the Pilot. Clearing the warm start counter does not affect the failure history. To reset the failure history, run the controller ‑reenable command.

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

For diagnostic purposes, Oracle Customer Support changes the high availability (HA) settings for a Controller. The Oracle Customer Support representatives sets a specific flag to prevent the Controller from failing over to the partner Controller.

Parameters

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

$ fscli controller ‑modifyAgentHaFlags ‑controller /⁠CONTROLLER-00 ‑noFailover