call_home ‑modify

Updates the Call‑Home settings.

SYNOPSIS

call_home ‑modify 
   [{‑enableEventTrigger |‑disableEventTrigger}]
   [{‑enableLargeFile | ‑disableLargeFile}]
   [{‑enableStandardPeriodic | ‑disableStandardPeriodic}]
   [{‑enableLargerPeriodic | ‑disableLargerPeriodic}]
   [‑numberOfEvents number‑of‑events‑to‑include]
   [{ ‑callHomeDestination https‑server_ip_or_dns
         [{‑proxy
            ‑proxyIp proxy_ip
            ‑proxyPort proxy_port
            ‑proxyConnection {http | socks4 | socks5}
            [{‑enableAuthentication 
              ‑proxyUsername proxy-username
            | ‑noEnableAuthentication}]
         | ‑noProxy}]
    | ‑localDestination local_server_ip_or_dns
      ‑directory local_directory
      ‑userName user_name
   }]
   [ ‑schedulePeriodic {standard | large}
     ‑interval { daily | weekly | monthly}
     ‑frequency interval_frequency
     ‑startTime date‑time
   ]

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

DESCRIPTION

Use the call_home ‑modify command to configure or update the Call‑Home options. You can use the command to add a proxy server that resolves the name of the destination Oracle server.

You can enable or disable the Call‑Home feature that are triggered by system events. Some options disable the Auto Service Request (ASR) feature. If you disable ASR configure the ‑localDestination Call‑Home server and implement some other means to monitor the Oracle FS System.

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

OPTIONS

‑callHomeDestination

Specifies that the Call‑Home data is to be sent to the Oracle server. The data must be sent using the HTTPS protocol.

To use a proxy server to send the data, you can include the ‑proxy option. In this scenario, you must specify the following options:

‑proxyIp
‑proxyPort
‑proxyConnection

If you omit the ‑proxy option, or if you specify the ‑noProxy option, no proxy server is used.

‑directory

Identifies the full directory path on the local Call‑Home server in which to store the Call‑Home log bundles.

‑disableEventTrigger

Disables the Call‑Home feature for system events. This feature, when enabled, disables ASR functionality.

‑disableLargeFile

Specifies that Call‑Home log bundles only include the header information, resulting in smaller file size. Selecting this option disables the system from sending any event or manual logs to the Oracle server.

If ‑disableLargeFile is enabled and a system event occurs, you will need to manually download the logs and upload them to My Oracle Support (MOS).

When the ‑disableLargeFile option and the ‑disableLargerPeriodic option are used together, the effect is the same as using the ‑enableStandardPeriodic option.

‑disableLargerPeriodic

Disables the periodic transmission of a larger amount of Call‑Home data to the designated destination server.

Note: Do not use this option unless you are using the ‑localDestination Call‑Home server and you have implemented some other means to monitor the Oracle FS System.

‑disableStandardPeriodic

Disables the periodic sending of the Call‑Home header data to the designated destination server.

Use of this option disables the ASR feature. The option also disables the periodic heartbeat that is sent to My Oracle Support (MOS) and triggers an automatic service request for a missing system heartbeat.

Note: Do not use this option unless you are using the ‑localDestination Call‑Home server and you have implemented some other means to monitor the Oracle FS System.

‑enableAuthentication

Indicates that the proxy server requires authentication. Use with the ‑proxyUsername option to require users to supply a password.

‑enableEventTrigger

Enables the Call‑Home feature to send status messages for selected system events to the designated server. Enable ‑enableEventTrigger option to support the ASR feature.

You can also designate a local server by using the ‑localDestination option. Using a local Call‑Home server disables all ASR functionality.

‑enableLargeFile

Enables the transmission of diagnostic logs to the designated server.

During a system event, if this option is not enabled, the system does not send debug or other diagnostic logs to the Oracle server. Instead, you would need to manually send the diagnostic logs to a specific service request (SR) on My Oracle Support (MOS).

‑enableLargerPeriodic

Enables the periodic transmission of a larger amount of Call‑Home data to the designated destination server.

If the transmission of larger Call‑Home files is disabled by specifying the ‑disableLargeFile option, enabling the periodic transmission of larger amounts of data has the same effect as enabling standard periodic transfers by means of the ‑enableStandardPeriodic option.

Define the time interval and the frequency for this data transmission by specifying the ‑schedulePeriodic large option.

Use the following option values to keep the ASR feature active:

‑interval weekly
‑frequency 1

You may also specify a ‑startTime with the ‑schedulePeriodic option.

‑enableStandardPeriodic

Enables the periodic transmission of the Call‑Home data to the designated destination server.

Define the time interval and the frequency for this data transmission by specifying the ‑schedulePeriodic standard option.

Use the following options and values to keep the ASR feature active and to prevent My Oracle System (MOS) from creating any unnecessary service requests for missing heartbeats.

‑interval daily
‑frequency 1

You may also specify a ‑startTime with the ‑schedulePeriodic option.

‑frequency

Defines the number of time units as specified by the ‑interval option between the time when one task is run and the time when the next task is run. The value must be a positive integer.

Use the following frequency values for each ‑interval option:

daily: 1 through 100
weekly: 1 through 14
monthly: 1 through 3

‑interval

Defines the time unit to use as the basis for the repeating interval between the following tasks. Valid values:

daily: Specifies that the interval is in days.
weekly: Specifies that the interval is in weeks.
monthly: Specifies that the interval is in months.

‑localDestination

Specifies the IP address or DNS address of the local server where the Call‑Home logs should be sent.

Using a local server disables all Auto Service Request (ASR) functionality, which means that Oracle Customer Support is not notified of any system events.

‑noEnableAuthentication

Indicates that the proxy server does not require authentication. This is the default.

‑noProxy

Specifies that Call‑Home does not use a proxy server.

Note: If your environment does not use a proxy, configure at least one DNS server. Ensure that the DNS server resolves to the host name of the Oracle server: callhome.support.pillardata.com.

‑numberOfEvents

Defines the maximum number of system events to include in a Call‑Home bundle. Specify the operand as an integer that is greater than or equal to 0.

Note: Do not change this value if the ASR feature is used.

‑proxy

Specifies that Call‑Home uses a proxy server to provide the connection to the Oracle server.

To use the ‑proxy option, you must specify the following options:

‑proxyIp
‑proxyPort
‑proxyConnection

‑proxyConnection

Identifies the routing protocol to use.

Valid protocols:

http
socks4
socks5

‑proxyIp

Identifies the IP address of the proxy server.

‑proxyPort

Identifies the TCP port on the proxy server to use.

‑proxyUsername

Indicates that the proxy server requires authentication. Use with the ‑enableAuthentication option to require the user to supply a password.

‑schedulePeriodic

Specifies the size of the periodic log bundles that the system sends to the designated server. The schedule can be set for the following periodic bundle sizes:

standard

Specifies that the system sends standard sized log bundles to the designated server.

Use the following options and values to keep the ASR feature active and to prevent My Oracle System (MOS) from creating any unnecessary service requests for missing daily heartbeats.

‑interval daily
‑frequency 1

large

Specifies that the system sends large sized log bundles to the designated server.

Use the following options and values to keep the ASR feature active and to prevent My Oracle System (MOS) from creating any unnecessary service requests for missing weekly heartbeats.

‑interval weekly
‑frequency 1

‑startTime

Defines the time and the date of when the task is to begin.

Use the following format for the date and the time:

YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+|-HH:mm]

where:

YYYY-MM-DD: Designates a 4‑digit year, a 2‑digit month, and a 2‑digit day. If the remaining values are omitted, the time is set to 12:00:00.000+00:00.
T: A separator that designates the start of the time portion of the string.
HH:mm:SS.xxx: Designates the hours, the minutes, and the seconds (to three decimals) in terms of a 24-hour clock. If only HH is defined, the remaining values default to 00.
HH:mm: Designates the time zone as an offset from Coordinated Universal Time (UTC) in hours and minutes.

‑userName

Specifies the user log in name to the ‑localDestination server.

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 Call‑Home settings for the Oracle FS System.

Parameters

The size of the periodic log bundles: standard
The interval at which to send the log bundles: weekly
The frequency at which to send the log bundles: 2
The start time at which to begin the process of sending the log bundles: 2014-08-01

$ fscli call_home -modify ‑schedulePeriodic standard ‑interval weekly -frequency 2 ‑startTime 2014‑08‑01