/
/ $Header: opatch/source/oracle/opatch/rollbackdeploy_help.txt /main/3 2010/07/04 22:45:14 vganesan Exp $
/
/ rollbackdeploy_help.txt
/
/ Copyright (c) 2009, Oracle. All Rights Reserved.
/
/   NAME
/     rollbackdeploy_help.txt - <one-line expansion of the name>
/
/   DESCRIPTION
/     <short description of component this file declares/defines>
/
/   NOTES
/     <other useful comments, qualifications, etc.>
/
/   MODIFIED   (MM/DD/YY)
/   supal          11/15/09 - Domain can be optional
/   akmaurya       10/27/09 - Use of property files for WLS credentials
/   supal          08/17/09 - Help text for rollback (FMW) command
/   supal          08/17/09 - Creation
/
DESCRIPTION
    Rollback an existing one-off patch indicated by the reference-id.

    The -domain <DOMAIN_NAME> option has to be specified along with the
    -auto option for automated rollout to the Fusion Middleware domain.
    If only a single domain has been created out of the Oracle Home
    you can omit specifying the domain name.

    Only certain patches which have been certified by Oracle Product 
    Development can be rolled out using the -auto option.
    OPatch will pose questions to query for information necessary for 
    accessing the Fusion Middleware domain such as Admin Server URL, 
    Admin Server User, Admin Server Password, Node Manager User and
    Node Manager Password.

SYNTAX
opatch rollback -id <ID> -auto
                [-domain <DOMAIN_NAME>]
                [-mw_home <MW_HOME> ]
		[-delay <value>] 
		[-init <parameters for the init script in escaped double
                 quotes> [-opatch_init_end] ]
                [-invPtrLoc <Path to oraInst.loc> ]
                [-jre <LOC> ]
		[-no_inventory]
		[-no_relink] [-no_sysmod]
		[-oh <ORACLE_HOME>] [-ph <Patch Location>]           
                [-post <parameters for the post script in escaped
                 double quotes>[ -opatch_post_end] ] 
		[-pre <parameters for the pre
                 script in escaped double quotes> [-opatch_pre_end] ]
                [-property_file <path to property file>]
                [-remote_nodes <List of remote nodes (node1,node2)>]
		[-retry <value>] [-report] [-silent]
		[-verbose]

OPTIONS
       -domain
              The name of the Fusion Middleware domain to which the
              patched artifacts will be redeployed. For patches to
              'No Stage' mode applications OPatch performs only the
              necessary lifecycle operations for the specified domain

       -auto
              This option has to be specified for automated rollout of 
              the patch to the specified domain

       -mw_home
              The Middleware Home to work on. This takes precedence over
              the environment variable MW_HOME.

       -delay
              If -retry is specified, this option tells OPatch how
              many seconds it should wait before attempting to lock
              inventory again in case of a previous failure.

       -id
              Use 'lsinventory' option to display all patch id's.
              Each one-off patch is indicated by its id. To rollback
              a patch the id for that patch must be supplied

       -init
              This option is used to pass parameters to the init
              script. This script is executed before prerequisite checks
              are run. The value for this option have to be enclosed
              in double quotes. This option should be ended by 
              option 'opatch_init_end'. 

       -invPtrLoc
              Used to locate the oraInst.loc file. Needed when the
              installation used the invPtrLoc flag. This should be
              the path to the oraInst.loc file

       -jre
              This option tells OPatch to use JRE (java) from the
              specified location instead of the default location
              under Oracle Home.

       -no_inventory
              This option specifies not to update the inventory, it 
              just updates the files in the system.
              If inventory is readable, then OPatch tries to read the
              inventory. 
              NOTE: ph has to be used to specify the patch location.

       -no_relink
              Do not perform the make operations in the patch. This
              option can be used during multiple patch removals and
              perform the compilation step only once

       -no_sysmod
              This option specifies not to update the files in the
              system. It just updates the inventory. It also will not
              execute the pre and post scripts

       -oh
              The oracle home to work on. This takes precedence over
              the environment variable ORACLE_HOME

       -opatch_init_end
              This option is used to mark the end of init options.
              Without this option everything after init till end of
              the command is passed into init. This option is
              meaningless without -init option.

       -opatch_post_end
              This option is used to mark the end of post options.
              Without this option everything after post till end of
              the command is passed into post. This option is
              meaningless without -post option.

       -opatch_pre_end
              This option is used to mark the end of pre options.
              Without this option everything after pre till end of
              the command is passed into pre. This option is
              meaningless without -pre option.

       -ph
              Specify the valid patch directory area. Rollback will
              use the command types found in the patch directory to
              identify what commands are to be used for the current
              operating system

       -post
              This option is used to pass parameters to the post
              script.  This script is executed after removal of the
              patch. The value for this option have to be enclosed
              in double quotes. This option should be ended by
              option 'opatch_post_end'.

       -pre
              This option is used to pass parameters to the pre
              script.  This script is executed before removal of the
              patch. The value for this option have to be enclosed in
              double quotes. This option should be ended by option
              'opatch_pre_end'.

       -property_file
              The user defined property file for OPatch to use. The
              path to the property file should be absolute. This
              property file takes precedence over the one that is
              supplied with OPatch
              For FMW components, 'userConfigFile', 'userKeyFile',
              'NodeManagerConfigFile' and 'NodeManagerKeyFile'
              location can be specified as keys with corresponding files
              as values. They refer to encrypted, decrypted files for Admin
              user, Admin password, Node Manager user and Node Manager
              password. Similarly, Admin Server URL (key as AdminServerURL),
              Domain Home (key as DomainHome) and Applications Directory (key
              as ApplicationsDir) can be given as keys with corresponding
              values. The Key, value pair is of the format 'x=y' where 'x' is 
              OPatch understood key and each pair is separated by newline in
              the property file.

       -report
              Just prints out the actions, without executing

       -retry
              This option tells OPatch how many times should retry in
              case of an inventory lock failure.

       -silent
              This suppresses any user-interaction and defaults any
              Y|N question to Y. This option is not supported on
              RAC yet

       -verbose
              This option prints more OPatch output to the screen
              as well as to the log file

PARAMETERS
       Patch ID of the patch to be rolled back unless the command is
       invoked within a patch area.
