ups ‑add

Configures the Oracle FS System to receive SNMP traps that are sent by SNMP-enabled UPS devices.

SYNOPSIS

ups ‑add 
   ‑name ups‑name
   ‑ip ip‑address
   ‑community community

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

DESCRIPTION

Before the Oracle FS System can receive SNMP traps, it must be configured as an SNMP trap host. Issue the snmp_host ‑add command to create an SNMP trap host entry for the Oracle FS System. Provide the following information:
Name
Provide a name to identify the Oracle FS System as an SNMP trap host that receives UPS traps. Example: UPS_trap_host.
Public IP address
Enter the public IP address for the Oracle FS System.
Community
Enter the unique community string that the UPS device vendor provides.
Trap Port
Enter port 162 for SNMP trap hosts.

After creating an SNMP trap host entry for the Oracle FS System, run the ups ‑add command to configure the Oracle FS System to receive SNMP traps from the specified UPS device. Be sure to specify the same community string that you specified when you defined the Oracle FS System as an SNMP trap host.

Only administrators with primary administrator or admin1 roles are authorized to run this command.

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

OPTIONS

‑name
Specifies the name of the UPS that you are adding to the Oracle FS System. The name that you provide is used to create the fully qualified name (FQN) after you power up the UPS and the Oracle FS System discovers it. Use double quotation marks around names containing dashes or spaces. The following characters are invalid in a UPS name:

  • Non-printable characters, including ASCII 0 through 31, decimal

  • / (slash) and \ (backslash)

  • . (dot) and .. (dot dot)

  • Tabs

The Oracle FS System removes leading spaces and trailing spaces. Names are case sensitive.
‑ip

Specifies the IP address of a UPS device that the Oracle FS System is monitoring on the management network.

‑community

Identifies the community string for the Oracle FS System to authenticate the SNMP traps that are sent by UPS devices. Use the unique community string that is provided by the UPS vendor. The string you specify must match the community string that you specify when you configure the Oracle FS System to be an 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

Configure the Oracle FS System to receive SNMP traps from a battery-backed power source.

Parameters

  • The name of the Oracle FS System as an SNMP trap host: UPS_trap_host

  • The name of the Oracle FS System as an SNMP query host: UPS_query_host

  • The shared IP address for the Oracle FS System: 10.50.4.50

  • The SNMP host port number for trap hosts: 162

  • The SNMP host port number for query hosts: 161

  • The name of the UPS device: Bldg7UPS

  • The IP address of the UPS device: 20.33.44.5

  • The community string: 12269VmDC12

$ fscli snmp_host ‑add ‑name UPS_trap_host ‑ip 10.50.4.50 ‑community 12269VmDC12 ‑trapPort 162
$ fscli snmp_host ‑add ‑name UPS_query_host ‑ip 10.50.4.50 ‑community 12269VmDC12 ‑trapPort 161
$ fscli ups ‑add ‑name ‑Bldg7UPS ‑ip 20.33.44.5 ‑community 12269VmDC12
Related reference
ups
snmp_host ‑add

Copyright © 2005, 2016, Oracle and/or its affiliates. All rights reserved.  Legal Notices