9 Patch Manager Command Reference

This chapter describes the commands used to validate and apply patches, to run the Product Family Report, the Patches Applied Report and the Patching Report.

For more information, see the topics:

Validate Patches

The fapmgr validate command reads the actions in the patch driver file to determine whether a patch is compatible with your environment and can be applied successfully. It looks for the status of impacted servers, patch conflicts, and prerequisites, but it does not perform any updates. Validation can be performed in offline mode.

Patch Manager automatically performs patch validation when run the fapmgr apply command. The steps for validating a patch are provided here because Oracle recommends validate every patch before applying it, especially those patches that contain updates to SOA composites. The validation will reduce downtime and potential failures during patching. For more information about resolving these issues, see the Troubleshoot SOA Composite Validation Failures section.

Validation performs the following actions:

  • Checks if prerequisite patches have been applied.

  • Checks whether required taxonomy details can be successfully retrieved.

  • Checks whether the servers that are required for automated deployment of the Oracle Fusion Middleware artifacts in the patch are running.

  • Checks whether an Oracle Fusion Middleware artifact will be copied based on version checking.

  • Checks for patch conflicts.

  • Determines if the patch can be applied in hotpatch mode, if -hotpatch is used.

Use the following syntax for the validate command:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh validate -patchtop (or grouptop) patchtop_directory \
[-patchingplan path_to_patch_plan_xml_file][-hotpatch] [-taxonomyurl hostname:portnumber]
[-logfile log_file_name][-loglevel log level]

The following table lists the options available for the validate command:

Table 9-1 validate Command Options

Option Description Mandatory

patchtop

Identifies the directory where the patch is unzipped

Yes, unless applying patches in a patch plan

grouptop

Identifies the directory where the patches in a patch plan are unzipped

Yes, when applying patches in a patch plan

patchingplan

Identifies the directory path to the patch plan XML file

Yes, when applying patches in a patch plan

taxonomyurl

Identifies the host name and port number that overrides the default taxonomy information stored in the environment properties file. The Administration Server passes this value to Patch Manager

Conditionally required only when the value present in the environment properties file has to be overridden and when using the online option

hotpatch

Determines if patch can be applied in hotpatch mode

No

logfile

Overrides the default log file name and sends the processing information to the file you specify, under the APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR directory. If you enter an existing file name, the output is appended to the file

No, the utility generates a log file under APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR using this naming convention: FAPatchManager_validate_timestamp.log

loglevel

Records messages in the log file at the level you specify. See the Oracle Fusion Applications Patch Manager Logging section

No, default value is INFO

help

Displays help

No

Apply the Patches

To run the Oracle Identity Management Patcher, use the command line utility, idmpatch, located in the $IDM_LCM_TOP/patch/bin directory. Its shell script sets the environment and calls the utility. The following command shows the basic syntax for the idmpatch utility:

(UNIX) $IDM_LCM_TOP/patch/bin/idmpatch.sh run 

OPTIONAL: To run only the prerequisites, use the prereq option . This will not stop and start the services or apply and rollback patches. The syntax to run the idmpatch is as follows:

(UNIX)$IDM_LCM_TOP/patch/bin/idmpatch.sh run -prereq

Product Families Report

The Product Families report provides a list of installed product families along with each associated Oracle Universal Installer (OUI) component name and version. The report can run for all product families or specific product families can be selected. This report reads the local patch inventory and the current view snapshot.

The report includes the following information:

  • OUI Component: Component name assigned to the product family

  • Version: The version of the product family

  • Product Family: The product family name

  • Description: The product family description

Run the Patches Applied Report

Before running the Patches Applied report, ensure that the snapshot is current for the environment.

Use the following syntax to run the Patches Applied report:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -listpatches [optional parameters]

The following table describes the parameters used by the Patches Applied report:

Table 9-2 Patches Applied Report Parameters

Parameter Mandatory Description

comps

No

Supply a comma-separated list of product families (components) desired on the report. The report includes all product families if you do not use this parameter

outputfile

No

Sends the report output to the file specified after this parameter. The existing file name cannot be reused. If this parameter is not use, no output file is created

logfile

No

Overrides the default log file name and sends the processing information to the file specified, under the APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR directory. If an existing file name is entered, the output is appended to the file. If the paremeter is not use, the utility generates a log file under APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR, using this naming convention:

FAPatchManager_report-listpatches_timestamp.log 

loglevel

No

Records messages in the log file at the level you specified. See the Oracle Fusion Applications Patch Manager Logging section

reportwidth

No

Sets the column width to either 80 columns or 132 columns by specifying NORMAL or WIDE. The default value is 80 columns, or NORMAL

Run Patching Reports

Run fapmgr report command for generate Patch Manager reports. The patch-related information can be viewed from different perspectives to plan the patching strategy. These reports provide information that can be useful before and after of apply patches.

Note that the Online Patch Progress report is generated by Patch Manager automatically every five minutes during patch application.

The following table describes the patching reports that can be generated by Patch Manager:

Table 9-3 Patching Reports

Report Name Report Option Description Variations

Patch Impact Report

-patchimpact

Displays the impact of a patch in terms of bug fixes, prerequisites, and product families, by displaying what exists on your system. Also provides a list of artifact types, along with related servers and required manual actions

None

Product Families Report

-listcomps

Displays a list of installed components (product families) and their versions

Specifies a list of product families or see all product families

Patches Applied Report

-listpatches

Displays information about patches and bug fixes that have been applied to your system

Specifies a list of product families or see all product families

Patch Status Report

-isapplied

Tells you whether specific patches or bug fixes were applied to your system

None

Diagnostics Report

Not applicable, as this report is run automatically by Patch Manager

Online Patch Progress report displays the progress of a patching session that is currently running and the Diagnostics reports displays the same information at the end of the patching session

The progress report runs automatically every five minutes during a patching session and the diagnostics report runs at the end of the patching session

The fapmgr report command requires an option to specify which report has to run, followed by mandatory and optional parameters.

Use the following syntax to run a report:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -report_option 
-mandatory parameters [optional parameters]

Run the Patch Status Report

Use the following syntax to run the Patch Status report:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -isapplied -bug or -patch
[comma-separated_list_of_patches/bug_fixes [optional parameters]

The following table describes parameters used by the Patch Status report:

Table 9-4 Patch Status Report Parameters

Parameter Mandatory Description

bug

Yes, unless the patch parameter is used

Supply a comma-separated list of bug fixes. In case of request language bug fixes, append the language code to the bug number, for example, 123456:KO

patch

Yes, unless the bug parameter is used

Supply a comma-separated list of patches. In case of request language patches, append the language code to the patch number, for example, 123456:KO

outputfile

No

Sends the report output to the file specified after this parameter. Do not use an existing file name. If this parameter is not used, no out file is created

logfile

No

Overrides the default log file name and sends the processing information to the file specified, under the APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR directory. In case of enter an existing file name, the output is appended to the file. If this parameter is not used, the utility generates a log file under APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR using this naming convention:

FAPatchManager_report-listpatches_timestamp.log 

loglevel

No

Records messages in the log file at the level specified. See the Oracle Fusion Applications Patch Manager Logging section

reportwidth

No

Sets the column width to either 80 columns or 132 columns by specifying NORMAL or WIDE. The default value is 80 columns, or NORMAL

Patch Status Report

The Patch Status shows if specific patches or bug fixes have been applied to an environment. When running the report, a list of patch numbers or bug fixes is provided. The output indicates whether each patch or bug fix has been applied. This report queries the local patch inventory and current view snapshot.

The report output contains a table with the following columns:

  • Bug Number: The bug number.

  • OUI Component: Component name associated with the product family. This column displays Not Applied if the patch was not applied.

  • Status: Possible values are Applied and Not Applied.

  • Patch: The patch number. This column displays Not Applied if the patch was not applied.

  • Date Applied: The date the patch was applied. This column is null if the patch was not applied.

Example Syntax for the Patches Applied Report

Examples of the command syntax for running the Patches Applied report follow:

How to show all patches applied and set the report width to 132

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -listpatches -reportwidth WIDE 

How to show all patches applied for a list of product families

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -listpatches -comps oracle.fusionapps.fin,oracle.fusionapps.crm 

Patches Applied Report

The Patches Applied report provides information about patches that have been applied to an environment. It is possible to run the report for specific product families or all product families. This report depends on a current snapshot having been run.

The report is organized by product family (OUI component) and each product family section contains the following information:

  • Patch Number: The patch number

  • Patch Type: Possible values are Standard or ONE-OFF

  • Date Applied: The date the patch was applied

  • Bugs Fixed: The bug fixes included in each patch that was applied

Example Syntax for the Product Families Report

Examples of the command syntax for running the Product Families report follow:

How to show all installed product families and their versions

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -listcomps

How to show specific product families and specify the report output file name and log file name

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -listcomps -comps oracle.fusionapps.crm, oracle.fusionapps.fin 
-outputfile listproducts.txt -logfile /log/listproducts.log

Run the Patch Impact Report

The Patch Impact report can be run when applying only one patch or multiple patches downloaded in a patch plan. Before running the Patch Impact Report, ensure that the snapshot is current for the environment.

Use the following syntax to run the Patch Impact report for a single patch:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -patchimpact -patchtop   
 path_to_unzipped_patch [optional parameters]

Use the following syntax to run the Patch Impact report for a single patch:

(UNIX)FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -patchimpact -grouptoptop_directory_for_patches -patchingplanfull_path_to_patching_plan [optional parameters]

Run the Product Families Report

Before to run the Product Families report, ensure that the snapshot is current for the environment.

Use the following syntax to run the Product Families report:

(UNIX) FA_ORACLE_HOME/lcm/ad/bin/fapmgr.sh report -listcomps [optional parameters]

The following table describes the parameters used by the Product Families report:

Table 9-5 Product Families Report Parameters

Parameter Mandatory Description

comps

No

Supply a comma-separated list of product families (components) that want to see on the report. If this parameter is not used, the report will include all product families

outputfile

No

Sends the report output to the file specified after this parameter. Do not use an existing file name. If this parameter is not used, no output file is created

logfile

No

Overrides the default log file name and sends the processing information to the file specified, under the APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR directory. If an existing file name is entered, the output is appended to the file. If this parameter is not used, the utility generates a log file under APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR using this naming convention:

FAPatchManager_report-listcomps_timestamp.log 

loglevel

No

Records messages in the log file at the level you specify. See the Oracle Fusion Applications Patch Manager Logging section

reportwidth

No

Sets the column width to either 80 columns or 132 columns by specifying NORMAL or WIDE. The default value is 80 columns, or NORMAL

Online Patch Progress Report and Diagnostics Report

During every patching session, the Online Patch Progress report is automatically generated so that you can view the results of the session. This report is updated every five minutes during the patching session. The report output is in HTML format so that it can be viewed from a browser and is located in the APPLICATIONS_CONFIG/lcm/logs/<Fusion Applications Release Version>/FAPMGR/directory. The file name is FAPMgrDiagnosticsSummary_mode_timestamp.html, where mode can be apply or validate and timestamp is represented in YYYYMMDDHHmmSS format. After the completion of every patching session, the Online Patch Progress report is replaced by the Diagnostics report so that you can view the results of the session.

Both the Online Patch Progress report and the Diagnostics report contain the following sections, unless otherwise noted. The Online Patch Progress report is not available during application of multiple patches.

Module Execution Summary

The Module Execution Summary displays high-level information about the tools used during a patching session, such as Patch Manager, OPatch, and AutoPatch. For each tool, the report displays the following information:

  • Module: Tool called during the patching session, such as Patch Manager

  • Status: Completion status of the task, such as Success, Failed, or Skipped

  • Duration: Total time that the module ran

  • Start Time: Time and date the module started

  • End Time: Time and date the module ended

  • Log Files: Link to the Log Summary generated by Patch Manager. For more information, see the Log Summary section.

Module Phase Summary

The Module Phase Summary displays summary information about tasks executed by Patch Manager. The tasks are summarized by each AutoPatch and OPatch phase and the following information is displayed:

  • Mode: The patching mode is either Generic, Database or Middleware

  • Phase: The name of the patching phase

  • Duration: Total time the task ran

  • Start Time: Time and date the task started

  • End Time: Time and date the task ended

  • Task Count: Total number of tasks within the phase

  • Skipped: The number of tasks that were skipped during the phase

  • Failed: The number of tasks that failed during the phase

  • Completed: The number of tasks that completed successfully during the phase

  • Percent Complete: The percentage of tasks that completed successfully during the phase

Tasks With Warnings or Failures

This section displays the following detailed information about each task that produced a warning or failed:

  • Mode: The patching mode is either Generic, Database or Middleware

  • Phase: The name of the patching phase and sub-phase

  • Product Family: The short name of the product family, which displays only for database tasks.

  • Task: The name of the artifact related to the task including the full path, and the domain, if applicable.

  • Status: Completion status of the task, such as Failed or Skipped.

  • Warning/Error Message: The error message is displayed if the task failed. Nonfatal messages appear as warning messages. The message also includes additional steps that are required to resolve the failure, if applicable.

  • Log File: The name and location of the log file.

  • Line Number: The line numbers within the log file that pertain to the task.

Module Task Details

The Module Task Details section displays the following detailed information about each task executed by Patch Manager:

  • Mode: The patching mode is Database, Middleware, or Generic. In Generic mode, database validation and taxonomy URL validation are performed.

  • Phase: The name of the patching phase, such as Patch Validation, Environment Validation, and Patch Application.

  • Product Family: The short name of the product family, which displays only for database tasks.

  • Task: The name of the artifact related to the task including the full path, and the domain, if applicable.

  • Status: Completion status of the task, such as Success, Failed, or Skipped.

  • Duration: Total time the task ran.

  • Start Time: Time and date the task started.

  • End Time: Time and date the task ended.

  • Warning/Error Message: The error message is displayed if the task failed. Nonfatal messages appear as warning messages. The message also includes additional steps that are required to resolve the failure, if applicable.

  • Log File: The name and location of the log file.

  • Line Number: The line numbers within the log file that pertain to the task.

Tasks to be Completed (Online Progress Report Only)

The Tasks to be Completed section displays a summary of the tasks that have not yet been attempted by Patch Manager, and are waiting in the queue to run. The following information is displayed:

  • Mode: The patching mode is Database, Middleware, or Generic. In Generic mode, database validation and taxonomy URL validation are performed.

  • Phase: The name of the patching phase, such as Patch Validation, Environment Validation, and Patch Application.

  • Product Family: The short name of the product family, which displays only for database tasks.

  • Task: The description of the task that must be performed.