snmp_host ‑modify

Modifies the settings of an existing SNMP trap or query host.

SYNOPSIS

snmp_host ‑modify 
   ‑snmpHost snmp‑host‑id‑or‑fqn
   [‑name new‑snmp‑host‑name]
   [‑ip snmp‑host‑ip‑or‑dns]
   [‑community snmp‑community]
   [{ ‑newTrap ‑trapPort port‑number
      [‑trapEvent {informational | warning | critical}]
    | ‑removeTrap
    } ]

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

DESCRIPTION

To modify the settings for an existing SNMP trap host, identify the host by providing its name preceded by a forward slash ( / ) character, or its unique ID. Run the snmp_host ‑list command to display the names and IDs of all of the SNMP trap host entries.

To define a new event severity threshold, run the snmp_host ‑modify ‑newTrap command. If the SNMP trap host entry already has SNMP traps defined, the new trap definitions replace the previous definitions. For example, if you have previously set the event severity threshold to informational, your SNMP trap host currently receives informational, warning and critical events. If you now set the severity to critical, only the critical events are sent to the SNMP trap host.

To disable the SNMP service for a given host, run the snmp_host ‑modify ‑removeTrap command. This will still allow that host to send SNMP queries, but will no longer send traps to the specified host.

Note: Administrators with primary administrator or admin1 roles are authorized to run the snmp_host ‑modify command.

OPTIONS

‑community: Identifies the community string for the Oracle FS System to use when it sends an event trap to the SNMP host.
Note: Do not use the community strings public or private. This community string must match the string configured on the query or trap host.
‑ip: Specifies the IP address or name of a host to which the Oracle FS System sends SNMP trap information.
‑name: Specifies a unique name that you provide to identify the SNMP trap host. The name that you provide can be any name and does not need to be the hostname. Use double quotation marks around names that contain spaces or dashes.
‑newTrap: Identifies a new trap setting for the SNMP trap host. The ‑newtrap option is followed by the ‑trapPort or the ‑trapEvent option.
‑removeTrap: Instructs the Oracle FS System to stop sending event traps to the SNMP trap host.
‑snmpHost: Specifies the unique ID or the name of an existing SNMP trap host. Include a forward slash ( / ) character before the name.
‑trapEvent: Identifies the severity threshold for events that are sent in event traps to the SNMP trap host. Event traps are sent when the specified and more severe level is reached.
‑trapPort: Identifies the SNMP trap host port number to use for sending an event trap. The default universally defined port (UDP) is port 162. Do not specify another value unless your host is configured to receive traps on another port. If you do not provide this option, no traps are sent to the SNMP trap host.

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

Set a new event trap for an SNMP trap host.

Parameters

The name of the SNMP trap host preceded by a forward slash ( / ): /⁠snmp_trap_agent_1
The new event trap category: critical

$ fscli snmp_host -modify ‑id /⁠snmp_trap_agent_1 ‑trapEvent critical