Rapid Home Provisioning Control (RHPCTL) Command Reference

F.1.1 RHPCTL Overview

RHPCTL is a command-line utility with which you perform Rapid Home Provisioning operations and manage Rapid Home Provisioning Servers and Clients. RHPCTL uses the following syntax:

rhpctl command object [parameters]

In RHPCTL syntax:

command is a verb such as add, delete, or query
object (also known as a noun) is the target or object on which RHPCTL performs the command, such as client or image.
parameters extend the use of a preceding command combination to include additional parameters for the command. Specify parameters as -keyword value. If the value field contains a comma-delimited list, then do not use spaces between the items in the list.

You can use RHPCTL commands to perform several Rapid Home Provisioning operations, including:

Rapid Home Provisioning Client operations, such as creating a Rapid Home Provisioning Client configuration.
Role operations, such as adding and deleting roles, and granting and revoking roles for users.
Site operations, such as obtaining configuration information for Rapid Home Provisioning Servers.
Image operations, such as adding, deleting, and importing images.
Image series operations, such as adding and deleting image series.
Working copy operations, such as adding and deleting working copies.

F.1.2 Using RHPCTL Help

To see help for all RHPCTL commands, from the command line enter:

rhpctl -help

To see the command syntax and a list of parameters for each RHPCTL command, from the command line enter:

rhpctl command (or verb) object (or noun) -help

F.1.3 rhpctl delete audit

Deletes the Rapid Home Provisioning audit records.

Syntax

rhpctl delete audit [-to timestamp]

Usage Notes

Optionally, you can specify a date up to which audit records will be deleted, in the format YYYY-MM-DD. Otherwise, this command deletes all audit records.

F.1.4 rhpctl modify audit

Modifies the maximum number of audit records to store.

Syntax

rhpctl modify audit -maxrecord number

Usage Notes

Specify the maximum number of audit records to store.

F.1.5 rhpctl query audit

Displays the Rapid Home Provisioning audit records.

Syntax

rhpctl query audit [[[-operation {add | delete | modify | grant | revoke | move | verify | discover
  | upgrade | allow | disallow | deleteimage | insertimage | promote | addnode | deletenode | register | unregister | export | import | query
  | subscribe | unsubscribe}]
  [-entity {client | role | audit | image | imagetype | useraction | series | workingcopy | database | server | user | audit | imagetype | useraction}]
  | [-user user_name] [-client cluster_name] | [-from timestamp -to timestamp]
  | -before timestamp | -since timestamp | -first number | -last number]
  | -record record_id | -config]

Parameters

Table F-1 rhpctl query audit Command Parameters

Parameter	Description
`-operation {add \| delete \| modify \| grant \| revoke \| move \| verify \| discover \| upgrade \| allow \| disallow \| deleteimage \| insertimage \| promote \| addnode \| deletenode \| register \| unregister \| export \| import \| query \| subscribe \| unsubscribe}`	Specify the type of operation for which you want an audit query.
`-entity {client \| role \| image \| series \| workingcopy \| database \| server \| user \| audit \| imagetype \| useraction}`	Specify the entity for which you want an audit query.
`-user user_name`	Optionally, you can choose to run a query audit on a particular user who performed Rapid Home Provisioning operations.
`-client cluster_name`	Optionally, you can choose to run a query audit on a particular client cluster where Rapid Home Provisioning operations were performed.
`-from timestamp -to timestamp`	Optionally, you can specify a time interval for which to run an audit query. Timestamps must be in the format `YYYY-MM-DD`.
`-before timestamp`	Optionally, you can specify a time before which to run an audit query. Timestamp must be in the format `YYYY-MM-DD`.
`-since timestamp`	Optionally, you can specify a time after which to run an audit query. Timestamp must be in the format `YYYY-MM-DD`.
`-first number`	Optionally, you can specify a number of the first audit records for a given time.
`-last number`	Optionally, you can specify a number of the last audit records for a given time.
`-record record_id`	Optionally, you can specify a particular audit record ID.
`–config`	You can choose this parameter to show the maximum record configuration.

F.1.6 rhpctl add client

Adds a Rapid Home Provisioning Client to the configuration.

Syntax

rhpctl add client -client cluster_name [-toclientdata path] [-targetnode node_name
  {-sudouser sudo_user_name -sudopath sudo_binary_location | -root}]
  [-maproles role=user_name[,role=user_name[,...]]]
  [-version version]

Parameters

Table F-2 rhpctl add client Command Parameters

Parameter	Description
`-client client_name`	Specify the name of the cluster in which you want to create the client.
`-toclientdata path`	Optionally, you can specify the path to the XML file that is created by the Rapid Home Provisioning Server (specific to the client cluster), which contains the information the client needs to configure its connection to the server.
`-targetnode node_name`	Optionally, you can specify the name of a node in a remote cluster that has no Rapid Home Provisioning Client.
`-sudouser sudo_user_name -sudopath sudo_binary_location \| -root`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-maproles role=user_name[,...]`	You can specify either built-in roles or roles that you have defined, and you can assign multiple uses to each role. Use commas to separate multiple roles and users.
`-version version`	Optionally, you can specify the version of the credentials file format, such as `12.2.0.0.0`.

Usage Notes

You can only run this command on the Rapid Home Provisioning Server.

Examples

To add a client to the Rapid Home Provisioning Server:

$ rhpctl add client -client ClientCluster3 -toclientdata Grid_home/RHPserver/info

F.1.7 rhpctl delete client

Deletes a specific Rapid Home Provisioning Client from the configuration.

Syntax

rhpctl delete client –client cluster_name [-force]

Usage Notes

Specify the name of the client cluster that you want to delete from the configuration.
You must stop the Rapid Home Provisioning Client before you run this command or use the -force option.

Example

To delete the Rapid Home Provisioning Client ClientCluster3:

$ rhpctl delete client -client ClientCluster3

F.1.8 rhpctl discover client

Validates the input provided and discovers parameters on the given nodes, and generates a response file that you can use for configuring Oracle Clusterware.

After completing this command, use to validate the response file and prepare the target nodes for Oracle Clusterware deployment.

Syntax

rhpctl discover client -image image_name -generatepath response_file_path
  {-responsefile response_file_name | -clusternodes node_list -client cluster_name -oraclehome oracle_home_path}
  {-root | -sudouser sudo_username -sudopath sudo_binary_path} [-user gi_user_name] [-scan scan_name]

Parameters

Table F-3 rhpctl discover client Command Parameters

Parameter	Description
`-image image_name`	Specify the name of the Oracle Grid Infrastructure Gold Image which the resulting response file will support.
`-generatepath response_file_path`	Specify a file path where the response file that RHPCTL generates will be copied. The RHPCTL command generates name of the response file and displays it while the command is running.
`-responsefile response_file_name`	If you have a partially complete response file and you want it to be completed with reference to the target nodes, then specify the response file name using this parameter. Note: The response file must include the node list, client name, and Oracle home path.
`-clusternodes node_list`	Specify a comma-delimited list of nodes on which you plan to provision Oracle Clusterware (using the resulting response file) in the following format: `node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]`
`-client cluster_name`	Specify the name of the target cluster to be probed.
`-oraclehome oracle_home_path`	Specify the location of the Oracle home.
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	You must choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-user gi_user_name`	Specify the name of the Oracle Grid Infrastructure installation user.
`-scan scan_name`	Specify the SCAN name.

F.1.9 rhpctl export client

Exports data from the repository on the Rapid Home Provisioning Server to a client data file.

Syntax

rhpctl export client -client cluster_name -clientdata file_path

Parameters

Table F-4 rhpctl export client Command Parameters

Parameter	Description
`-client cluster_name`	Specify the name of the client cluster that you want to export.
`-clientdata file_path`	Specify the path to the location of the client data file.

Usage Notes

You can only run this command on the Rapid Home Provisioning Server.

Example

To export repository data from a Rapid Home Provisioning Client named mjk9394 to a client data file, /tmp/mjk9394.xml:

$ rhpctl export client -client mjk9394 -clientdata /tmp/mjk9394.xml

F.1.10 rhpctl modify client

Modifies a Rapid Home Provisioning Client.

Syntax

rhpctl modify client –client cluster_name [-enabled {TRUE | FALSE}]
  [-maproles role=user_name[+user_name...][,role=user_name[+user_name...],...]]] [-password]]

Parameters

Table F-5 rhpctl modify client Command Parameters

Parameter	Description
`-client cluster_name`	Specify the name of the client cluster that you want to modify.
`-enabled {TRUE \| FALSE}`	Specify whether the client is enabled.
`-maproles role=user_name[+user_name...][,...]`	You can modify either built-in roles or roles that you have defined, and you can assign multiple uses to each role. When you use the `-maproles` parameter, use a plus sign (`+`) to map more than one user to a specific role. Separate additional role/user pairs with commas.
`-password`	Optionally, you can specify a password to recreate the Rapid Home Provisioning Client credentials.

Example

To disable a Rapid Home Provisioning Client named RHPClient001:

$ rhpctl modify client -client RHPClient001 -enabled FALSE

F.1.11 rhpctl query client

Displays the configuration information of a specific Rapid Home Provisioning Client cluster.

Syntax

rhpctl query client [–client cluster_name]

Usage Notes

Specify the name of the client cluster in which the Rapid Home Provisioning Client resides for which you want to display the configuration information

Example

This command displays output similar to the following:

/rhpctl query client -client mbcluster-13
Site: mbcluster-13
Rapid Home Provisioning Client Version: 12.2.0.1.0
Enabled: true
Host from which RHPC last registered: rhpserver01.foo.com
Port number last registered by RHPC: 23795
RHP Enabled: true
Standalone: false
Managed: true

F.1.12 rhpctl verify client

Validates the input provided and creates or completes and verifies the values in a response file that you can use to configure Oracle Clusterware.

Syntax

rhpctl verify client -image image_name -responsefile response_file_name [-clusternodes node_list]
  {-root | -sudouser sudo_username -sudopath sudo_binary_path} [-user gi_user_name]
  [-client cluster_name] [-scan scan_name] [-oraclehome oracle_home_path] [-ignorewarn] [-fixup  [-setupSSH]]

Parameters

Table F-6 rhpctl verify client Command Parameters

Parameter	Description
`-image image_name`	Specify the name of the image.
`-responsefile response_file_name`	Specify a response file to be used to provision Oracle Grid Infrastructure.
`-clusternodes node_list`	Specify a comma-delimited list of nodes on which Oracle Clusterware will be provisioned in the following format: `node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]`
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	You must choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-user gi_user_name`	Specify the name of the Oracle Grid Infrastructure installation user.
`-client cluster_name`	Specify the name of the cluster you want to verify.
`-scan scan_name`	Specify the SCAN name.
`-oraclehome oracle_home_path`	Specify the location of the Oracle home.
`-ignorewarn`	Use this parameter to ignore warnings during validation.
`–fixup [-setupSSH]`	Use this parameter to run a fixup script, which automatically applies changes to the nodes to satisfy changes that CVU recommends. Optionally, you can use the `-setupSSH` parameter to set up passwordless SSH user equivalence on the remote nodes for the provisioning user.

F.1.13 rhpctl add database

Creates a database using a specific working copy.

Syntax

rhpctl add database -workingcopy workingcopy_name -dbname unique_db_name
  [-datafileDestination datafileDestination_path] {-node node_list | -serverpool pool_name
  [-pqpool pool_name | -newpqpool pool_name -pqcardinality cardinality]
  | -newpool pool_name -cardinality cardinality [-pqpool pool_name
  | -newpqpool pool_name -pqcardinality cardinality]} [-dbtype 
  {RACONENODE | RAC | SINGLE}] [-dbtemplate file_path | image_name:relative_file_path] [-cdb] [-pdbName pdb_prefix [-numberOfPDBs pdb_count]]
  [{-sudouser user_name -sudopath sudo_binary_path} | -root]
  [-targetnode node_name] [-useractiondata user_action_data]

Parameters

Table F-7 rhpctl add database Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of an existing working copy for the database that you want to add.
`-dbname unique_db_name`	Specify the unique name of the database (`DB_UNIQUE_NAME` without `DB_DOMAIN`) that you are adding.
`-datafileDestination datafileDestination_path`	Specify the data file destination location or the name of the Oracle Automatic Storage Management (Oracle ASM) disk group. Note: You cannot specify a disk group for Oracle Database versions before Oracle Database 11g release 2 (11.2).
`-node node_list`	Specify a node or comma-delimited list of several nodes on which to create the database.
`-serverpool server_pool_name`	Specify the name of an existing server pool.
`-pqpool server_pool_name`	Specify the name of an existing server pool. Note: This parameter is only applicable in an Oracle Flex Cluster environment and refers to server pools (either already defined, as in this case, or to be created when you use the `-newpqpool` parameter) running on Leaf Nodes.
`-newpqpool server_pool_name`	Optionally, you can create a new server pool to be used for parallel queries. Specify a name for the new server pool. Note: This parameter is only applicable in an Oracle Flex Cluster environment because it refers to server pools running on Leaf Nodes.
`-pqcardinality cardinality`	If you create a new server pool, then you must specify a cardinality value for the server pool. Note: This parameter is only applicable in an Oracle Flex Cluster environment.
`-newpool server_pool_name`	Optionally, you can create a new server pool. Specify a name for the new server pool.
`-cardinality cardinality`	If you create a new server pool, then you must specify a cardinality value for the server pool.
`-dbtype {RACONENODE \| RAC \| SINGLE}`	Specify whether the database is Oracle RAC One Node, Oracle RAC, or a nonclustered database.
`-dbtemplate file_path \| image_name:relative_file_path`	Specify the absolute file path to a database template or the relative path to the image home directory on a Rapid Home Provisioning Server.
`-cdb`	Optionally, use this parameter to create a database as a container database.
`-pdbName pdb_prefix`	If you are creating one or more pluggable databases, then specify a pluggable database name prefix.
`-numberOfPDBs pdb_count`	Specify the number of pluggable databases you want to create.
`-sudouser user_name -sudopath sudo_binary_path \| -root`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-targetnode node_name`	Optionally, you can specify the name of a node in a remote cluster that has no Rapid Home Provisioning Client.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Example

To create a database on a working copy named prodhome:

$ rhpctl add database -workingcopy prodhome -dbname proddb -datafileDestination /acfs/proddata -serverpool prodpool1 -dbtype RAC

Note:

You can create multiple databases on a working copy.

F.1.14 rhpctl addnode database

Adds instances to an administrator-managed Oracle RAC database.

Syntax

rhpctl addnode database -workingcopy workingcopy_name -dbname unique_db_name -node node_list
  [-root | -sudouser sudo_username -sudopath sudo_binary_path] [-useractiondata user_action_data]

Parameters

Table F-8 rhpctl addnode database Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of a working copy.
`-dbname unique_db_name`	Specify the unique name of the database (`DB_UNIQUE_NAME` without `DB_DOMAIN`) that you are adding.
`-node node_list`	Specify a node or comma-delimited list of several nodes on which to create the database.
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	You must choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

If the specified working copy is not installed on the nodes in the node list, then you must first run rhpctl addnode workingcopy.
If the working copy is on a Rapid Home Provisioning Client or on the Rapid Home Provisioning Server, then credentials are not required. This is true whether you run the command on the Server or the Client. Credentials are required when you run the command on the Server and the working copy is on a target that is not a Rapid Home Provisioning Client.

F.1.15 rhpctl delete database

Deletes a database that was created on a working copy.

Note:

If the database is hosted on a working copy that is on the Rapid Home Provisioning Server or on a Rapid Home Provisioning Client, then credentials are not required. This is true whether you run the command on the Server or the Client. Credentials are required when you run the command on the Server and the working copy is on a target that is not a Rapid Home Provisioning Client.

Syntax

rhpctl delete database –workingcopy workingcopy_name -dbname unique_db_name
  [-sudouser sudo_user_name -sudopath sudo_binary_path | -root] [-targetnode node_name]
  [-useractiondata user_action_data]

Parameters

Table F-9 rhpctl delete database Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify a name for the working copy for the database that you want to delete.
`-dbname unique_db_name`	Specify the unique name of the database (`DB_UNIQUE_NAME`without `DB_DOMAIN`) that you are deleting.
`-sudouser user_name -sudopath sudo_binary_path \| -root`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-targetnode node_name`	Optionally, you can specify the name of a node in a remote cluster that has no Rapid Home Provisioning Client.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

F.1.16 rhpctl deletenode database

Deletes an instance, which contracts an administrator-managed Oracle RAC database.

Syntax

rhpctl deletenode database -workingcopy working_copy_name -dbname unique_db_name -node node_list
  [-root | -sudouser sudo_username -sudopath sudo_binary_path] [-force] [-failover] [-drain_timeout timeout]
  [-stopoption stop_option] [-useractiondata user_action_data]

Parameters

Table F-10 rhpctl deletenode database Command Parameters

Parameter	Description
`-workingcopy working_copy_name`	Specify the name of a working copy.
`-dbname unique_db_name`	Specify the unique name of the database (`DB_UNIQUE_NAME` without `DB_DOMAIN`) that you are deleting.
`-node node_list`	Specify a node or comma-delimited list of several nodes from which to delete the database instance.
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	Choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-force`	Use `-force` to remove the instance after forcibly stopping the instance.
`-failover`	Optionally, you can use this parameter to attempt to have services running on the instance that want to delete fail over to another instance.
`-drain_timeout timeout`	Optionally, you can use `-drain_timeout` to specify the time, in seconds, allowed for resource draining to be completed. Accepted values are an empty string (""), 0, or any positive integer. The default value is an empty string, which means that this parameter is not set. If it is set to 0, then draining occurs, immediately. The draining period is intended for planned maintenance operations. During the draining period, all current client requests are processed, but new requests are not accepted.
`-stopoption stop_option`	Optionally, you can specify a stop option for the database. Options include: `ABORT`, `IMMEDIATE`, `NORMAL`, `TRANSACTIONAL`, and `TRANSACTIONAL_LOCAL`.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

If the working copy is on a Rapid Home Provisioning Client or on the Rapid Home Provisioning Server, then credentials are not required. This is true whether you run the command on the Server or the Client. Credentials are required when you run the command on the Server and the working copy is on a target that is not a Rapid Home Provisioning Client.

F.1.17 rhpctl move database

Moves one or more databases from a source working copy or any Oracle Database home to a patched working copy.

The patched working copy need not exist and can be created dynamically, in which case you must specify an image name from which to create the patched working copy.

Syntax

rhpctl move database -patchedwc workingcopy_name {{-sourcewc workingcopy_name | -sourcehome Oracle_home_path
  [-oraclebase Oracle_base_path] [-client cluster_name]} 
  [-dbname db_name_list] [-image image_name] [-path where_path [-agpath read_write_path -aupath gold_image_path]]
  [-nonrolling | -batches list_of_batches | -smartmove [-saf availability] [-separate] [-eval]]
  [-ignorewcpatches] [-keepplacement] [-disconnect [-noreplay]] [-drain_timeout time] [-stopoption stop_option]
  [-nodatapatch] [-targetnode node_name] [-notify [-cc user_list]] | -continue [-skip] | -revert | -abort}
  [-sudouser user_name -sudopath sudo_binary_path | -root] [-useractiondata user_action_data]

Parameters

Table F-11 rhpctl move database Command Parameters

Parameter	Description
`-patchedwc workingcopy_name`	Specify the name of the working copy to where you want to move the database.
`-sourcewc workingcopy_name`	Specify the name of the working copy from which the database is to be moved.
`-sourcehome Oracle_home_path`	Alternatively, you can specify the source Oracle home path.
`-oraclebase Oracle_base_path`	Specify the ORACLE_BASE path for provisioning the Oracle database home (required only for `ORACLEDBSOFTWARE` image type).
`-client cluster_name`	Specify the name of the client cluster.
`-dbname db_name_list`	Specify the unique names of the databases (`DB_UNIQUE_NAME` without `DB_DOMAIN`) that you want to move to the patched working copy.
`-image image_name`	Optionally, you can specify the gold image used to create the destination working copy if it does not already exist.
`-path where_path`	Optionally, if you are creating the destination working copy, then you can specify the path here.
`-agpath read_write_path`	Specify the path to the read-write site-specific configuration changes to maintain a persistent home path. Note: When you use this parameter, you must also use the `-path` parameter, and the location that you specify must be empty.
`-aupath gold_image_path`	Specify the path for the read-only gold image to maintain a persistent home path. Note: When you use this parameter, you must also use the `-path` parameter, and the location that you specify must be empty.
`-nonrolling \| -batches list_of_batches \| -smartmove [-saf availability] [–separate] [–eval]`	Optionally, you can choose one of the three following methods to move a database: Use the `-nonrolling` parameter to move the database in a non-rolling mode. By default, databases move in a rolling mode. Use the `-batches` parameter to specify a comma-delimited list of batches of nodes (where each batch is a comma-delimited list of node names enclosed in parentheses) enclosed in double quotation marks (`""`) in the format: `"(nA,nB,...),(...,nY,nZ)"`. Alternatively, use the `-smartmove` parameter. Use the `-saf availability` parameter to specify a service availability factor, which is the minimum percentage of instances on which a service must remain running during the move. Use the `-separate` parameter to process batches separately. When you use this parameter, the `move` command returns after each batch. The move operation for the first batch must specify the source home and other parameters that apply to all batches (such as `-nonrolling` and `-keepplacement`). Control subsequent batches using the `-continue`, `-skip`, and `-abort` parameters. Use the `–eval` parameter to print auto-generated batches of nodes and sequence of moves without actually performing the move operation.
`-ignorewcpatches`	Optionally, you can use this parameter to ignore if a patched working copy is missing some patches which are present in the source path or working copy.
`-keepplacement`	Use this parameter to ensure that services of administrator-managed Oracle RAC or Oracle RAC One Node databases are running on the same instances before and after the move operation.
`-disconnect [-noreplay]`	Optionally, use the `-disconnect` parameter to disconnect all sessions before stopping or relocating services. If you choose to use `-disconnect`, then you can choose to use the `-noreplay` parameter to disable session replay during disconnection.
`-drain_timeout timeout`	Specify the time, in seconds, allowed for resource draining to be completed. Accepted values are an empty string (""), 0, or any positive integer. The default value is an empty string, which means that this parameter is not set. If it is set to 0, then draining occurs, immediately. The draining period is intended for planned maintenance operations. During the draining period, all current client requests are processed, but new requests are not accepted.
`-stopoption stop_option`	Optionally, you can specify a stop option for the database. Options include: `ABORT`, `IMMEDIATE`, `NORMAL`, `TRANSACTIONAL`, and `TRANSACTIONAL_LOCAL`.
`–nodatapatch`	Use this parameter to indicate not to run `datapatch` for databases you are moving.
`-targetnode node_name`	Optionally, you can specify the name of a node in a remote cluster that has no Rapid Home Provisioning Client.
`-notify [-cc user_list]`	Optionally, you can supply a list of users to whom email notifications of the move will be sent, in addition to the owner of the working copy.
`-continue [-skip] \| —revert \| —abort`	Use the `-continue` parameter to continue restarting databases on the next batch of nodes. Optionally, you can use the `-skip` parameter to skip current batch of nodes and restart databases on the next batch of nodes. Use the `-revert` parameter to revert to the source Oracle home or working copy. Use the `-abort` parameter to abort an ongoing move operation.
`[-sudouser user_name -sudopath sudo_binary_path \| -root]`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

You can obtain context sensitive help for specific use cases for the rhpctl move database command, as follows:

$ rhpctl move database -help [EXISTING_PATCHEDWC | NEW_PATCHEDWC | SRCHOME
  | SINGLEINSTANCEDB | ROLLING | NONROLLING | BATCHES | SMARTMOVE]

Examples

To move all the databases running from one working copy to another in a rolling fashion:

$ rhpctl move database -sourcewc prodHomeV1 -patchedwc prodHomeV2 -client prodcluster

In the preceding example, the patched working copy, prodHomeV2, must exist.

To move all databases running on a non-managed Oracle home at /u01/app/product/12.1.0/dbhome to a working copy named myDB12Home1:

$ rhpctl move database -sourcehome /u01/app/product/12.1.0/dbhome -oraclebase /u01/app/product/12.1.0/obase -patchedwc myDB12Home1

To move a database named SampleDB from a working copy named myDB12Home1 to a working copy named myDB12Home1patched (any other databases running on myDB12Home1 are not affected by this move):

$ rhpctl move database –sourcewc myDB12Home1 –patchedwc myDB12Home1patched –dbname SampleDB

To move all databases running on a working copy named myDB12Home1 to a working copy named myDB12Home1patched:

$ rhpctl move database –sourcewc myDB12Home1 –patchedwc myDB12Home1patched

The preceding examples are the basic form of the command. You can also move groups of databases in batches. The batch operations also support management of session connections and recovery options.

F.1.18 rhpctl upgrade database

Upgrades a database to the version of the destination working copy.

Syntax

rhpctl upgrade database [-sourcewc source_workingcopy_name | -sourcehome oracle_home_path
  [-oraclebase Oracle_base_path] [{-client cluster_name | -targetnode node_name}]]
  [-root | -sudouser sudo_user_name -sudopath sudo_binary_location]
  -destwc destination_workingcopy_name [-image image_name [-path where_path]]
  -dbname unique_db_name [-useractiondata user_action_data]

Parameters

Table F-12 rhpctl upgrade database Command Parameters

Parameter	Description
`-sourcewc source_workingcopy_name`	Specify the name of the source working copy from which you want to upgrade the database.
`-sourcehome oracle_home_path`	Alternative to specifying the name of the source working copy, you can specify the path to the source Oracle home.
`-oraclebase oraclebase_path`	If you use the `-sourcehome` parameter, then you can, optionally, specify a different `ORACLE_BASE` from the source Home.
`-client cluster_name \| -targetnode node_name`	Specify either the name of the client cluster or the name of a node in a remote cluster with no Rapid Home Provisioning Client on which to provision a working copy.
`-root \| -sudouser sudo_user_name -sudopath sudo_binary_location`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-destwc destination_workingcopy_name [-image image_name [-path where_path]]`	Specify the name of the destination working copy to which the database is to be upgraded. If the destination working copy does not exist, then specify the gold image from which to create it, and optionally, the path to where to provision the working copy.
`-dbname unique_db_name`	Specify the name of the database you are upgrading.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Example

The following example upgrades a database, testy, from Oracle Database 11g, which is on working copy db112mbc143 to Oracle Database 12c, which is on working copy db12102mbc143, both of which reside on the remote node bposvr141:

$ rhpctl upgrade database -dbname testy -sourcewc db112mbcl43 -destwc db12102mbcl43 -root -targetnode bposvr141

F.1.19 rhpctl addnode gihome

Adds one or more nodes to an Oracle Grid Infrastructure installation.

Syntax

rhpctl addnode gihome {-workingcopy workingcopy_name | -client cluster_name}
  -newnodes node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]
  {-root | -sudouser sudo_username -sudopath sudo_binary_path} [-targetnode node_name]
  [-force] [-setupssh] [-useractiondata user_action_data]

Parameters

Table F-13 rhpctl addnode gihome Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of the working copy of the active Oracle Grid Infrastructure home that you want to install and configure on the specified node.
`-client cluster_name`	Alternatively, you can specify the name of the client cluster to which to add cluster nodes.
`–node node_list`	Specify a comma-delimited list of nodes on which Oracle Clusterware will be provisioned in the following format: `node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]`
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	You must choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-targetnode node_name`	Optionally, you can specify the name of a node in a remote cluster that has no Rapid Home Provisioning Client.
`-setupssh`	Sets up passwordless SSH user equivalence on the remote nodes for the provisioning user.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

You can specify the target for the operation using the working copy name or, if the target is a Rapid Home Provisioning Client, then using the client cluster name.
You must provide either root credentials or a sudo user.
A target node is required if the target cluster is an Oracle Clusterware 11g release 2 (11.2) or 12c release 1 (12.1) cluster and must be the node name of an existing cluster node.

F.1.20 rhpctl deletenode gihome

Removes one or more nodes from an Oracle Grid Infrastructure installation.

Syntax

rhpctl deletenode gihome {-workingcopy workingcopy_name | -client cluster_name} -node node_list
  {-root | -sudouser sudo_username -sudopath sudo_binary_path} [-targetnode node_name]
  [-useractiondata user_action_data]

Parameters

Table F-14 rhpctl deletenode gihome Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of a working copy of the Oracle Grid Infrastructure home that you want to remove from the specified node.
`-client cluster_name`	Alternatively, you can specify the name of the client cluster from which to remove cluster nodes.
`–node node_list`	Specify a comma-delimited list of node names from which to delete Oracle Grid Infrastructure.
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	You must choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-targetnode node_name`	Name of a node in a remote cluster with no Rapid Home Provisioning Client.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

You can specify the target for the operation using the working copy name or, if the target is a Rapid Home Provisioning Client, then using the client cluster name.
You must provide either root credentials or a sudo user.
A target node is required if the target cluster is an Oracle Clusterware 11g release 2 (11.2) or 12c release 1 (12.1) cluster and must be the node name of an existing cluster node.

F.1.21 rhpctl move gihome

Moves the Oracle Grid Infrastructure software stack from one home to another.

Syntax

rhpctl move gihome -destwc destination_workingcopy_name {{-sourcewc source_workingcopy_name
   | -sourcehome oracle_home_path} [-image image_name -path where_path]
   [-targetnode target_node_name] [-ignorewcpatches] [-nonrolling] [-keepplacement]
   [-auto -dbhomes mapping_of_Oracle_homes [-dblist db_name_list 
   | -excludedblist db_name_list] [-nodatapatch] [-disconnect] [-drain_timeout timeout]]
   [-batches list_of_batches [-firstnode node_name] | -smartmove [-saf availability] [-eval]]
   [-aupath gold_image_path] [-agpath read_write_path] | -continue | -revert |-abort}
   [-root | -sudouser sudo_username -sudopath path_to_sudo_binary] [-cleanpids]
   [-useractiondata user_action_data]

Parameters

Table F-15 rhpctl move gihome Command Parameters

Parameter	Description
`-destwc destination_workingcopy_name`	Specify the name of the destination working copy to which you want to move Oracle Grid Infrastructure.
`-sourcewc working_copy_name`	If you want to move Oracle Grid Infrastructure from a working copy, then specify the name of the source working copy from which you want to move the Grid home.
`-sourcehome oracle_home_path`	If you are moving Oracle Grid Infrastructure from an unmanaged (not provisioned by Rapid Home Provisioning) Oracle home, then specify the path to the Oracle home from which you want to move Oracle Grid Infrastructure.
`-image image_name`	If the destination working copy does not exist, specify the gold image from which to create it.
`-path where_path`	If you are creating a working copy, then you can specify the path to which it is provisioned.
`-targetnode target_node_name`	Name of a node in a remote cluster with no Rapid Home Provisioning Client.
`-ignorewcpatches`	Use this parameter to ignore if the patched working copy is missing some patches which are present in the source path or working copy.
`-nonrolling`	Use this parameter to move the Oracle home in a non-rolling fashion.
`-keepplacement`	Specify this parameter to ensure that services of administrator-managed Oracle RAC or Oracle RAC One Node databases are running on the same instances before and after the move operation.
`-auto -dbhomes mapping_of_Oracle_homes`	Specify this parameter to automatically patch databases when you patch Oracle Grid Infrastructure.
`-dblist db_name_list`	Optionally, you can specify a list of databases on which you want to perform the patching operation.
`-excludedblist db_name_list`	Optionally, you can exclude specific databases from the patching operation.
`-nodatapatch`	Use this parameter to indicate not to run `datapatch` for databases being moved.
`-disconnect`	Use this parameter to disconnect all sessions before stopping or relocating services.
`-drain_timeout session_drain_time`	Use this parameter to specify a service drain timeout, in seconds.
`-batches list_of_batches`	Specify a comma-delimited list of batches of nodes (where each batch is a comma-delimited list of node names enclosed in parentheses) enclosed in double quotation marks (`""`) in the format: `"(nA,nB,...),(...,nY,nZ)"`.
`-firstnode node_name`	Optionally, you can specify the first node on which Oracle Clusterware is patched.
`-smartmove [-saf availability`	Alternatively, use the `-smartmove` parameter. Optionally, you can use the `-saf` parameter to specify the service availability factor, which is the minimum percentage of instances on which a service must remain running during the move.
`-eval`	Use this parameter to evaluate the `rhpctl move gihome` command and print automatically generated batches of nodes and the sequence of moves without actually running the command.
`-aupath gold_image_path`	Specify the path for the read-only gold image to maintain a persistent home path. Note: When you use this parameter, you must also use the `-path` parameter, and the location that you specify must be empty.
`-agpath read_write_path`	Specify the path to the read-write site-specific configuration changes to maintain a persistent home path. Note: When you use this parameter, you must also use the `-path` parameter, and the location that you specify must be empty.
`-continue`	Use this parameter to continue restarting the Oracle Clusterware stack on the next batch of nodes.
`-revert`	Use this parameter to revert back to before the move operation.
`-abort`	Use this parameter to abort an ongoing move operation.
`-root \| -sudouser sudo_username -sudopath path_to_sudo_binary`	Choose to either run super user operations as either `root` or a sudo user, and specify a sudo user name and path to the sudo binary.
`-cleanpids`	When using a persistent home path for both the source and destination working copies, specify `-cleanpids` to ensure processes are stopped completely on the source home.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Example

Assume there is a target cluster running Oracle Grid Infrastructure 12c release 1 (12.1.0.2) from a working copy named grid12102wcpy, and one of the nodes in the cluster is named bposvr141. After provisioning the patched working copy, called grid12102PSU (using the -softwareonly parameter with the rhpctl add workingcopy command), move the Grid home to the patched working copy, as follows:

$ rhpctl move gihome -sourcewc grid12102wcpy -destwc grid12102PSU -root -targetnode bposvr141

F.1.22 rhpctl upgrade gihome

Upgrades the Oracle Grid Infrastructure from a source working copy or source home path to a destination working copy.

Syntax

rhpctl upgrade gihome {-sourcewc source_workingcopy_name | -sourcehome oracle_home_path
  -targetnode target_node_name} -destwc destination_workingcopy_name
  [-image image_name -path where_path] [-root | -sudouser sudo_user_name -sudopath sudo_binary_location]
  [-ignoreprereq]

Parameters

Table F-16 rhpctl upgrade gihome Command Parameters

Parameter	Description
`-sourcewc source_workingcopy_name`	Specify the name of the source working copy from which the Oracle Grid Infrastructure home needs to be upgraded.
`-sourcehome oracle_home_path`	Alternative to specifying the name of the source working copy, you can specify the path to the unmanaged Oracle Grid Infrastructure home.
`-targetnode target_node_name`	In addition to specifying the source Oracle Grid Infrastructure home, you must also specify a node that is in a remote cluster that has no Rapid Home Provisioning Client.
`-destwc destination_workingcopy_name [-image image_name -path where_path]`	Specify the name of the destination working copy to which the Oracle Grid Infrastructure home is to be upgraded. You can also specify the name of the gold image from which to create the destination working copy, if it does not already exist
`-root \| -sudouser sudo_user_name -sudopath sudo_binary_location`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-ignoreprereq`	Use this parameter to ignore the CVU prerequisite checks.

F.1.23 rhpctl add image

Use the rhpctl add image command to create an image from an existing working copy and add it to the list of existing images on the Rapid Home Provisioning Server configuration.

Syntax

rhpctl add image -image image_name -workingcopy working_copy_name
   [-imagetype image_type] [-series series_name] [-state {TESTABLE | RESTRICTED | PUBLISHED}]

Parameters

Table F-17 rhpctl add image Command Parameters

Command Option	Description
`-image image_name`	Specify the name of the image that you want to add.
`-workingcopy working_copy_name`	Specify the name of the working copy from which to create the image.
`-imagetype image_type`	Specify the software type. `ORACLEDBSOFTWARE` (default) for Oracle Database software, `ORACLEGISOFTWARE` for Oracle Grid Infrastructure software, or `SOFTWARE` for all other software. If you use custom image types, then specify the name of your image type.
`-series series_name`	If you want to add an image to an image series, then specify the name of an image series.
`-state {TESTABLE \| RESTRICTED \| PUBLISHED}`	Specify the state of the image.

Usage Notes

F.1.24 rhpctl allow image

Allows access to an image by a user or a role.

Syntax

rhpctl allow image -image image_name {-user user_name [-client cluster_name]
    | -role role_name}

Parameters

Table F-18 rhpctl allow image Command Parameters

Parameter Description

Parameter	Description
`-image image_name`	Specify the name of the image to which you want to allow access.
`-user user_name [-client cluster_name \| -role role_name`	Specify the either of the following: A user for which you want to allow access to the image and, optionally, the cluster name of the client cluster with the user. The role for which you want to allow access to the image.

-image image_name

Specify the name of the image to which you want to allow access.

-user user_name [-client cluster_name | -role role_name

Specify the either of the following:

A user for which you want to allow access to the image and, optionally, the cluster name of the client cluster with the user.
The role for which you want to allow access to the image.

Examples

To allow access to an image named PRODIMAGE:

$ rhpctl allow image -image PRODIMAGE -user mjk -client GHC1

F.1.25 rhpctl delete image

Deletes a specific image.

Syntax

rhpctl delete image -image image_name

Usage Notes

Specify the name of the image you want to delete
This command will fail if the image belongs to one or more series
This command will fail if there are any provisioned working copies based on this image

Example

The following example deletes an image named PRODIMAGEV0:

$ rhpctl delete image -image PRODIMAGEV0

F.1.26 rhpctl disallow image

Disallows access to an image by a user or a role.

Syntax

rhpctl disallow image -image image_name {-user user_name [-client client_name]
    | -role role_name}

Parameters

Table F-19 rhpctl disallow image Command Parameters

Parameter Description

Parameter	Description
`-image image_name`	Specify the name of the image to which you want to disallow access.
`-user user_name [-client client_name \| -role role_name`	Specify either of the following: A user for which you want to disallow access to the image and, optionally, the cluster name of the client cluster with the user. The role for which you want to disallow access to the image.

-image image_name

Specify the name of the image to which you want to disallow access.

-user user_name [-client client_name | -role role_name

Specify either of the following:

A user for which you want to disallow access to the image and, optionally, the cluster name of the client cluster with the user.
The role for which you want to disallow access to the image.

Examples

To disallow access to an image:

$ rhpctl disallow image -image PRODIMAGE -user mjk -client GHC1

F.1.27 rhpctl import image

Creates an image on the Rapid Home Provisioning Server.

Use the rhpctl import image command to create an image by copying the entire software contents from the specified path to the Rapid Home Provisioning Server.

Syntax

rhpctl import image -image image_name -path path
   [-imagetype image_type] [-pathowner user_name]
   [-state {TESTABLE | RESTRICTED | PUBLISHED}] [-client cluster_name]
   [-targetnode node_name [-sudouser sudo_user_name -sudopath sudo_binary_path | -root]] [-useractiondata user_action_data]

Parameters

Table F-20 rhpctl import image Command Parameters

Parameter	Description
`-image image_name`	Specify the name of the image that you want to add.
`-path path`	Specify the absolute path location of the software home that you want to import (for Oracle Database images, this is the `ORACLE_HOME`).
`-imagetype image_type`	Specify the software type. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.
`-pathowner user_name`	Specify the user with read access to the files and directories under the specified path. Note: This parameter is applicable only for non-Oracle database software homes.
`-state {TESTABLE \| RESTRICTED \| PUBLISHED`	Specify whether the state of the image is testable, restricted, or published.
`-client cluster_name`	Specify the name of the client cluster.
`-targetnode node_name`	Specify the name of the node from which you want to import the image. Also this parameter is needed if the node hosting the home is not an RHP Client.
`-sudouser sudo_user_name -sudopath sudo_binary_path \| -root]`	If you use the `-targetnode` parameter, then you must specify either sudo or `root` to perform super user operations.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

When you import an Oracle Database or Oracle Grid Infrastructure software home, the version of the home must be one of the versions that Rapid Home Provisioning supports for provisioning and patching.

Example

To import an image:

$ rhpctl import image -image PRODIMAGEV1 -path /u01/app/product/12.1.0/dbhome -pathowner orcl

F.1.28 rhpctl modify image

Modifies the configuration details of an image.

Syntax

rhpctl modify image -image image_name -imagetype image_type

Parameters

Table F-21 rhpctl modify image Command Parameters

Parameter	Description
`-image image_name`	Specify the name of the image that you want to modify.
`-imagetype image_type`	You can modify the software type. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.

F.1.29 rhpctl query image

Displays the configuration of an existing image.

Syntax

rhpctl query image [[-image image_name [-dbtemplate]] | [[-imagetype image_type]
  [-version version] [-platform platform]]]

Parameters

Table F-22 rhpctl query image Command Parameters

Parameter	Description
`-image image_name [-dbtemplate]`	Specify the name of the image you want to query. Optionally, you can use the `-dbtemplate` parameter to display template file names in the default template directory.
`-imagetype image_type`	Specify the software type. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.
`–version version`	Use this parameter to specify the version of the image software you are querying.
`-platform platform`	Use this parameter to specify the operating system platform to which the image corresponds.

Usage Notes

If you use the -version parameter, then the version must have five fields, such as 12.1.0.2.4.
If you use the -platform parameter, then you can use Linux_AMD64, Linux_S390, Linux_PPC, IBM_AIX_PPC64, HP_IA64, Linux_Itanium, Solaris_SPARC64, Linux_LOP, and Intel_Solaris_AMD64

F.1.30 rhpctl promote image

Promotes an image.

Syntax

rhpctl promote image -image image_name -state {TESTABLE | RESTRICTED | PUBLISHED}

Parameters

Table F-23 rhpctl promote image Command Parameters

Parameter Description

Parameter	Description
`-image image_name`	Specify the name of the image that you want to promote.
`-state {TESTABLE \| RESTRICTED \| PUBLISHED}`	Specify one of the following as the name of the state of the image: `TESTABLE`: `RESTRICTED`: `PUBLISHED`:

-image image_name

Specify the name of the image that you want to promote.

-state {TESTABLE | RESTRICTED | PUBLISHED}

Specify one of the following as the name of the state of the image:

TESTABLE:
RESTRICTED:
PUBLISHED:

Example

To promote an image named PRODIMAGE:

$ rhpctl promote image -image PRODIMAGE -state RESTRICTED

F.1.31 rhpctl add imagetype

Configures a new image type and its associated user actions.

Syntax

rhpctl add imagetype -imagetype image_type -basetype {SOFTWARE | ORACLEGISOFTWARE | ORACLEDBSOFTWARE} [-useractions user_action_list]

Parameters

Table F-24 rhpctl add imagetype Command Parameters

Parameter	Description
`-imagetype image_type`	Specify the name of the image type you are creating.
`-basetype {SOFTWARE \| ORACLEGISOFTWARE \| ORACLEDBSOFTWARE}`	Specify a base image type on which the image type you are creating is based. Use `ORACLEDBSOFTWARE` (default) for Oracle Database software, `ORACLEGISOFTWARE` for Oracle Grid Infrastructure software, and `SOFTWARE` for all other software.
`-useractions user_action_list`	Specify a comma-delimited list of names of user actions

Example

To add a new image type:

rhpctl add imagetype -imagetype DB122_PATCH_TYPE -basetype ORACLEDBSOFTWARE

F.1.32 rhpctl allow imagetype

Grants access to an image type to a user or a role.

Syntax

rhpctl allow imagetype -imagetype image_type {-user user_name [-client cluster_name] | -role role_name}

Parameters

Table F-25 rhpctl allow imagetype Command Parameters

Parameter	Description
`-imagetype image_type`	Specify the name of the image type to which you are granting access. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.
`-user user_name`	Specify an operating system user to whom you are granting access to the image type. Either this parameter or the `-role` parameter is required.
`-client cluster_name`	Optionally, you can specify the name of the client cluster to which the operating system user belongs, if you choose to use the `-user` parameter.
`-role role_name`	Alternative to the `-user` parameter, you can specify a particular role to which to grant access to the image.

F.1.33 rhpctl delete imagetype

Deletes an existing image type.

Syntax

rhpctl delete imagetype -imagetype image_type

Usage Notes

Specify an image type to delete. You cannot delete any of the built-in image types.

F.1.34 rhpctl disallow imagetype

Revokes access to an image type from a user or a role.

Syntax

rhpctl disallow imagetype -imagetype image_type {-user user_name [-client cluster_name] | -role role_name}

Parameters

Table F-26 rhpctl disallow imagetype Command Parameters

Parameter	Description
`-imagetype image_type`	Specify the name of the image type from which you are revoking access. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.
`-user user_name`	Specify an operating system user from whom you are revoking access to the image type. Either this parameter or the `-role` parameter is required.
`-client cluster_name`	Optionally, you can specify the name of the client cluster to which the operating system user belongs, if you choose to use the `-user` parameter.
`-role role_name`	Alternative to the `-user` parameter, you can specify a particular role from which to revoke access to the image.

F.1.35 rhpctl modify imagetype

Modifies the configuration of an image type.

Syntax

rhpctl modify imagetype -imagetype image_type -useractions user_action_list

Parameters

Table F-27 rhpctl modify imagetype Command Parameters

Parameter	Description
`-imagetype image_type`	Specify the name of the image type you want to modify. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.
`-useractions user_action_list`	Specify a comma-delimited list of names of user actions

F.1.36 rhpctl query imagetype

Displays the configuration of an image type.

Syntax

rhpctl query imagetype -imagetype image_type

Usage Notes

Specify the name of the image type you want to query. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, or SOFTWARE for all other software. For a custom image type, use the image type name.

F.1.37 rhpctl add role

Creates roles and adds them to the list of existing roles on the Rapid Home Provisioning Server configuration.

Parameter	Description
`–role role_name`	Specify a name for the role that you want to create.
`-hasRoles roles`	Specify a comma-delimited list of roles to include with the new role. GH_AUDIT_ADMIN GH_USER_ADMIN GH_ROLE_ADMIN GH_SITE_ADMIN GH_SERIES_ADMIN GH_SERIES_CONTRIB GH_WC_ADMIN GH_WC_OPER GH_WC_USER GH_SUBSCRIBE_USER GH_SUBSCRIBE_ADMIN GH_IMG_ADMIN GH_IMG_USER GH_IMG_TESTABLE GH_IMG_RESTRICT GH_IMG_PUBLISH GH_IMG_VISIBILITY GH_IMGTYPE_ADMIN GH_IMGTYPE_ALLOW GH_IMGTYPE_OPER GH_SA GH_CA GH_OPER

F.1.38 rhpctl delete role

Deletes a role from the list of existing roles on the Rapid Home Provisioning Server configuration.

Syntax

rhpctl delete role –role role_name

Usage Notes

Specify the name of the role that you want to delete
You cannot delete any built-in roles
You can only run this command on the Rapid Home Provisioning Server

Example

To delete a role from the Rapid Home Provisioning Server:

$ rhpctl delete role -role hr_admin

F.1.39 rhpctl grant role

Grants a role to a client user or to another role.

Syntax

rhpctl grant role {–role role_name {-user user_name [-client cluster_name]
  | -grantee role_name}} | {[-client cluster_name]
  [-maproles role=user_name[+user_name...][,role=user_name[+user_name...][,...]}

Parameters

Table F-29 rhpctl grant role Command Parameters

Parameter	Description
`-role role_name`	Specify the name of the role that you want to grant clients or users.
`-user user_name [-client cluster_name]`	Specify the name of a user. The user name that you specify must be in the form of `user@rhpclient`, where `rhpclient` is the name of the Rapid Home Provisioning Client. Optionally, you can specify the name of the client cluster to which the user belongs.
`-grantee role_name`	Use this parameter to specify a role to which you want to grant another role.
`[-client cluster_name] -maproles role=user_name[+user_name...][,role=user_name[+user_name...][,...]`	You can map either built-in roles or roles that you have defined to either users on a specific client cluster or to specific users. When you use the `-maproles` parameter, use a plus sign (`+`) to map more than one user to a specific role. Separate additional role/user pairs with commas.

Example

The following example grants a role, ABC, to four specific users.

$ rhpctl grant role -role ABC -maproles ABC=mjk@rhpc1+dc@rhpc1+aj@rhpc1+jc@rhpc1

F.1.40 rhpctl query role

Displays the configuration information of a specific role.

Syntax

rhpctl query role [–role role_name]

Usage Notes

Specify the name of the role for which you want to display the configuration information
You can only run this command on the Rapid Home Provisioning Server

Example

This command returns output similar to the following:

$ rhpctl query role -role GH_CA

Role name: GH_CA
Associated roles: GH_IMGTYPE_ADMIN, GH_IMGTYPE_ALLOW, GH_IMGTYPE_OPER, GH_IMG_ADMIN, GH_IMG_PUBLISH, GH_IMG_RESTRICT, GH_IMG_TESTABLE, GH_IMG_VISIBILITY, GH_SERIES_ADMIN, GH_SERIES_CONTRIB, GH_SUBSCRIBE_ADMIN, GH_WC_ADMIN 
Users with this role: rhpusr@rwsdcVM13

F.1.41 rhpctl revoke role

Revokes a role from a client user.

Syntax

rhpctl revoke role {–role role_name {-user user_name 
  [-client cluster_name] | -grantee role_name}}
  | {[-client cluster_name] -maproles role=user_name[+user_name...]
  [,role=user_name[+user_name...]...]}

Parameters

Table F-30 rhpctl revoke role Command Parameters

Parameter	Description
`–role role_name`	Specify the name of the role from which you want to revoke clients or users.
`-user user_name [-client cluster_name]`	Specify the name of a user and, optionally, a client cluster from which you want to revoke a role. The user name that you specify must be in the form of `user@rhpclient`, where `rhpclient` is the name of the Rapid Home Provisioning Client.
`-grantee role_name`	Specify the grantee role name.
`[-client client_name] -maproles role=user_name[+user_name...]`	You can map either built-in roles or roles that you have defined to specific users. Use a plus sign (`+`) to map more than one user to a specific role. Separate additional role/user pairs with commas. Optionally, you can also specify a client cluster.

F.1.42 rhpctl add series

Adds a series to the Rapid Home Provisioning Server configuration.

Syntax

rhpctl add series -series series_name [-image image_name]

Parameters

Table F-31 rhpctl add series Command Parameters

Parameter	Description
`-series series_name`	Specify a name for the series that you want to add.
`-image image_name`	Optionally, you can specify the name of a configured image. This image becomes the first in the series.

Example

To add a series:

$ rhpctl add series –series DB12_series

F.1.43 rhpctl delete series

Deletes a series from the Rapid Home Provisioning Server configuration.

Syntax

rhpctl delete series -series series_name [-force]

Usage Notes

Specify the name of the series that you want to delete.
Use -force to delete an image series even if the series includes images.
Before deleting an image series, you must first remove all images from the series by using the rhpctl deleteimage series command.
This command does not delete images, only series.

Example

The following example deletes a series called PRODDBSERIES:

$ rhpctl delete series -series PRODDBSERIES

F.1.44 rhpctl deleteimage series

Deletes an image from a series.

Syntax

rhpctl deleteimage series -series series_name -image image_name

Parameters

Table F-32 rhpctl deleteimage series Command Parameters

Parameter	Description
`-series series_name`	Specify the name of the series from which you want to delete an image.
`-image image_name`	Specify the name of the image that you want to delete from a series.

Example

The following command deletes an image called PRODIMAGEV0 from a series called PRODDBSERIES:

$ rhpctl deleteimage series -series PRODDBSERIES -image PRODIMAGEV0

F.1.45 rhpctl insertimage series

Inserts an existing image into a series.

Note:

A single image can belong to one or more series.

Syntax

rhpctl insertimage series -series series_name -image image_name
   [-before image_name]

Parameters

Table F-33 rhpctl insertimage series Command Parameters

Parameter	Description
`-series series_name`	Specify the name of the series into which you want to insert an image.
`-image image_name`	Specify the name of the image that you want to insert into a series.
`-before image_name`	Optionally, you can specify the name of an image before which you want to insert the new image.

Example

To insert an image into a series:

rhpctl insertimage series -series DB12_series -image DB12102_PSU

F.1.46 rhpctl query series

Displays the configuration of a series.

Syntax

rhpctl query series [-series series_name | -image image_name]

Parameters

Table F-34 rhpctl query series Command Parameters

Parameter	Description
`-series series_name`	Specify the name of the series for which you want to display the configuration.
`-image image_name`	Alternatively, you can specify the name of a configured image.

Usage Notes

If you do not specify a series or an image by name, then CRSCTL returns information for all series.

Example

This command returns output similar to the following:

$ rhpctl query series

Image series: DB12_series
Image series: GRID_series
Image series: DB112_series

F.1.47 rhpctl subscribe series

Subscribes a specific user to an image series.

Syntax

rhpctl subscribe series -series series_name [-user user_name [-client cluster_name]]

Parameters

Table F-35 rhpctl subscribe series Command Parameters

Parameter	Description
`-series series_name`	Specify the image series to which you want to subscribe a user.
`-user user_name`	Specify an operating system user to whom you are subscribing the image series.
`-client cluster_name`	Optionally, you can specify the name of the client cluster to which the operating system user belongs.

F.1.48 rhpctl unsubscribe series

Unsubscribes a user from an image series.

Syntax

rhpctl unsubscribe series -series series_name [-user user_name [-client cluster_name]]

Parameters

Table F-36 rhpctl unsubscribe series Command Parameters

Parameter	Description
`-series series_name`	Specify the image series from which you want to unsubscribe a user.
`-user user_name`	Specify an operating system user from whom you are unsubscribing the image series.
`-client cluster_name`	Optionally, you can specify the name of the client cluster to which the operating system user belongs.

F.1.49 rhpctl query server

Displays the configuration of a server.

Syntax

rhpctl query server

Usage Notes

This command has no parameters.

Example

This command displays output similar to the following:

$ ./rhpctl query server

Rapid Home Provisioning Server (RHPS): rhps-myserver
Storage base path: /u01/app/RHPImages
Disk Groups: RHPDATA
Port number: 23795

F.1.50 rhpctl delete user

Deletes a user from the Rapid Home Provisioning repository.

Syntax

rhpctl delete user -user user_name [-client cluster_name]

Parameters

Table F-37 rhpctl delete user Command Parameters

Parameter	Description
`-user user_name`	Specify the name of the user you want to delete from a Rapid Home Provisioning Client.
`-client cluster_name`	Optionally, you can specify the name of the client cluster from which you want to delete from a specific user.

Usage Notes

You can delete non built-in users only if that user does not own any working copies.
If the user created an image or image series, then you can still delete the user, but the creator of the image or image series is changed to internal-user@GHS.
If the user was the owner of an image series, then you can delete the user, but the owner of the image series will be changed to internal-user@GHS. You can still use the affected image series as normal, such that you can still provision a working copy from the affected image series, and you can still insert or delete images from the affected image series.

Example

The following example deletes the user named scott on the server cluster from the Rapid Home Provisioning repository:

$ rhpctl delete user -user scott

F.1.51 rhpctl modify user

Modifies the email address of a specific user.

Syntax

rhpctl modify user -user user_name -email email_address [-client client_name]

Parameters

Table F-38 rhpctl modify user Command Parameters

Parameter	Description
`-user user_name`	Specify an operating system user whose email address you want to modify.
`-email email_address`	Specify the email address of the operating system user in the RFC 822 format.
`-client client_name`	Optionally, you can specify the name of the client cluster to which the operating system user belongs.

F.1.52 rhpctl register user

Registers an email address for a specific user.

Syntax

rhpctl register user -user user_name -email email_address [-client client_name]

Parameters

Table F-39 rhpctl register user Command Parameters

Parameter	Description
`-user user_name`	Specify an operating system user whose email address you want to register.
`-email email_address`	Specify the email address of the operating system user in the RFC 822 format.
`-client client_name`	Optionally, if you run the command on the Rapid Home Provisioning Server, then you can specify the name of the client cluster to which the operating system user belongs. Otherwise, the command applies to a user on the cluster (either the Rapid Home Provisioning Server or Client) where the command is run.

Example

An example of this command is:

$ rhpctl register user -user scott -email scott@company.com

F.1.53 rhpctl unregister user

Unregisters an email address for a specific user.

Syntax

rhpctl unregister user -user user_name [-client client_name]

Parameters

Table F-40 rhpctl unregister user Command Parameters

Parameter	Description
`-user user_name`	Specify an operating system user whose email address you want to unregister.
`-client client_name`	Optionally, you can specify the name of the client cluster to which the operating system user belongs.

F.1.54 rhpctl add useraction

Configures a user action and its associated script and action file.

Syntax

rhpctl add useraction -useraction user_action_name -actionscript script_name
  [-actionfile file_name] [-pre | -post] [-optype option]
  [-onerror {ABORT | CONTINUE}] [-runscope {ONENODE | ALLNODES | AUTO}]

Parameters

Table F-41 rhpctl add useraction Command Parameters

Parameter	Description
`-useraction user_action_name`	Specify the name of the user action you want to add.
`-actionscript script_name`	Associate a specific action script to run with the user action.
`-actionfile file_name`	Optionally, you can specify an action file that is required by the user action.
`-pre \| -post`	Use the `-pre` parameter to run the user action before the add operation or the `-post` parameter to run the user action after.
`-optype option`	Optionally, you can specify the operation for which the user action is configured. Options include: IMPORT_IMAGE ADD_WORKINGCOPY DELETE_WORKINGCOPY ADD_DATABASE DELETE_DATABASE MOVE_DATABASE MOVE_GIHOME UPGRADE_DATABASE UPGRADE_GIHOME ADDNODE_GIHOME DELETENODE_GIHOME ADDNODE_DATABASE DELETENODE_DATABASE ADDNODE_WORKINGCOPY
`-onerror {ABORT \| CONTINUE}`	Optionally, you can choose whether to abort or continue the operation if the user action encounters an error while it is running.
`-runscope {ONENODE \| ALLNODES \| AUTO}`	Optionally, you can specify the nodes where the user action is run. Choose AUTO for a run scope based on the other command options.

F.1.55 rhpctl delete useraction

Deletes an existing user action configuration.

Syntax

rhpctl delete useraction -useraction user_action_name

Usage Notes

Specify the name of a user action you want to delete.

F.1.56 rhpctl modify useraction

Modifies the configuration of the specified user action name.

Syntax

rhpctl modify useraction -useraction user_action_name [-actionscript script_name]
  [-actionfile file_name] [-pre | -post] [-optype option]
  [-onerror {ABORT | CONTINUE}] [-runscope {ONENODE | ALLNODES | AUTO}]

Parameters

Table F-42 rhpctl modify useraction Command Parameters

Parameter	Description
`-useraction user_action_name`	Specify the name of the user action you want to modify.
`-actionscript script_name`	Optionally, you can specify an action script to run.
`-pre \| -post`	Use the `-pre` parameter to run the user action before the modify operation or the `-post` parameter to run the user action after.
`-optype option`	Optionally, you can specify the operation for which the user action is configured. Options include: IMPORT_IMAGE ADD_WORKINGCOPY DELETE_WORKINGCOPY ADD_DATABASE DELETE_DATABASE MOVE_DATABASE MOVE_GIHOME UPGRADE_DATABASE UPGRADE_GIHOME ADDNODE_GIHOME DELETENODE_GIHOME ADDNODE_DATABASE DELETENODE_DATABASE ADDNODE_WORKINGCOPY
`-onerror {ABORT \| CONTINUE}`	Optionally, you can choose whether to abort or continue the operation if the user action encounters an error while it is running.
`-runscope {ONENODE \| ALLNODES \| AUTO}`	Optionally, you can specify the nodes where the user action is run. Choose AUTO for a run scope based on the other command options.

F.1.57 rhpctl query useraction

Displays the configuration of a user action.

Syntax

rhpctl query useraction [-useraction user_action_name | -imagetype image_type]
  [-optype option]

Parameters

Table F-43 rhpctl query useraction Command Parameters

Parameter Description

Parameter	Description
`-useraction user_action_name`	Specify the name of the user action you want to query.
`-imagetype image_type`	Alternatively, you can specify the software type. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, and SOFTWARE for all other software. For a custom image type, use the image type name.
`-optype option`	Optionally, you can specify the operation for which to run the query. Options include: IMPORT_IMAGE ADD_WORKINGCOPY DELETE_WORKINGCOPY ADD_DATABASE DELETE_DATABASE MOVE_DATABASE MOVE_GIHOME UPGRADE_DATABASE UPGRADE_GIHOME ADDNODE_GIHOME DELETENODE_GIHOME ADDNODE_DATABASE DELETENODE_DATABASE ADDNODE_WORKINGCOPY

-useraction user_action_name

Specify the name of the user action you want to query.

-imagetype image_type

Alternatively, you can specify the software type. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, and SOFTWARE for all other software. For a custom image type, use the image type name.

-optype option

Optionally, you can specify the operation for which to run the query. Options include:

IMPORT_IMAGE
ADD_WORKINGCOPY
DELETE_WORKINGCOPY
ADD_DATABASE
DELETE_DATABASE
MOVE_DATABASE
MOVE_GIHOME
UPGRADE_DATABASE
UPGRADE_GIHOME
ADDNODE_GIHOME
DELETENODE_GIHOME
ADDNODE_DATABASE
DELETENODE_DATABASE
ADDNODE_WORKINGCOPY

F.1.58 rhpctl add workingcopy

Creates a working copy on a client cluster.

Syntax

To create a working copy on a client cluster for yourself or another user:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
   -oraclebase oracle_base_path -client cluster_name [-user user_name]

To create a working copy on storage that you specify:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
   -oraclebase oracle_base_path -storagetype {NFS | LOCAL | RHP_MANAGED}
  [-path absolute_path]

To create a working copy and an administrator-managed database:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
   -oraclebase oracle_base_path -dbname unique_db_name 
   -dbtype {RACONENODE | RAC | SINGLE} -datafileDestination datafileDestination_path
   -node node_list

To create a working copy and a policy-managed database:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
    -oraclebase oracle_base_path -dbname unique_db_name 
    -dbtype {RACONENODE | RAC | SINGLE} -datafileDestination datafileDestination_path
   {-serverpool server_pool_name | -newpool server_pool_name 
    -cardinality cardinality}

To create a working copy and a database configured with parallel query pools:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
    -oraclebase oracle_base_path -dbname unique_db_name 
    -dbtype {RACONENODE | RAC | SINGLE} -datafileDestination datafileDestination_path
    -serverpool server_pool_name [-pqpool pool_name | 
    -newpqpool pool_name-pqcardinality cardinality] |
    -newpool server_pool_name -cardinality cardinality
   [-pqpool pool_name | -newpqpool pool_name
    -pqcardinality cardinality]

To create a working copy and a database using a specific database template:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
    -oraclebase oracle_base_path -dbname unique_db_name 
    -dbtype {RACONENODE | RAC | SINGLE} -datafileDestination datafileDestination_path
    -dbtemplate {file_path | image_name:relative_file_path}

To create a working copy and a container database with one or more pluggable databases:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
    -oraclebase oracle_base_path -dbname unique_db_name 
    -dbtype {RACONENODE | RAC | SINGLE} -datafileDestination datafileDestination_path
    -cdb [-pdbName pdb_prefix [-numberOfPDBs pdb_count]]

To create and configure a working copy of Oracle Grid Infrastructure:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
   {-root | -sudouser sudo_user_name -sudopath sudo_binary_path}
    -responsefile response_file_path [-clusternodes node_information]
   [-user user_name] [-oraclebase oracle_base_path]
   [-path absolute_path] [-asmclientdata data_path]
   [-gnsclientdata data_path] 
   [-ignoreprereq | -fixup]

To provision a software-only working copy of Oracle Grid Infrastructure:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
    -softwareonly -path Grid_home_path -oraclebase oracle_base_path
   [-local | -client cluster_name [-group "Oracle_group=user_group[,...]"] [-node client_node_name] |
   {-root | -sudouser sudo_user_name -sudopath sudo_binary_path}
    -targetnode node_name]

To provision a working copy on a node or a cluster where Rapid Home Provisioning does not exist:

rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
    -oraclebase oracle_base_path -user user_name
    -node node_name [-path absolute_path] 
    {-root | -sudouser sudo_user_name -sudopath sudo_binary_path}

Parameters

Table F-44 rhpctl add workingcopy Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify a name for the working copy that you want to create.
`-image image_name`	Specify the name of a configured image from which to create a working copy.
`-oraclebase oracle_base_path`	Specify an `ORACLE_BASE` path for provisioning an Oracle Database or Oracle Grid Infrastructure home. You can specify either an existing directory or a new directory. Note: This parameter is required only for the `ORACLEDBSOFTWARE` and `ORACLEGISOFTWARE` image types.
`-path absolute_path`	Specify the absolute path for provisioning the software home on the client side (this location must be empty). For Oracle Database images, this becomes the `ORACLE_HOME`. Note: This parameter is required for `NFS` and `LOCAL` storage types, and is invalid for `RHP_MANAGED`.
`-storagetype {NFS \| LOCAL \| RHP_MANAGED}`	Specify the type of storage for the software home.
`-user user_name`	Specify the name of the user that will own the working copy being provisioned. If you do not specify this parameter, then the working copy is owned by the user running the command. If you are provisioning to a remote cluster, then the user name must be a valid user on the remote cluster. The user ID need not be the same between the two clusters, but the user name must exist on both. Note: You cannot use `-user` simultaneously with the `-softwareonly` parameter.
`-dbname unique_db_name`	Specify the unique name of the database (`DB_UNIQUE_NAME` without `DB_DOMAIN`) that you are provisioning.
`-dbtype {RACONENODE \| RAC \| SINGLE}`	Specify whether the database is Oracle RAC One Node, Oracle RAC, or single instance (non-Oracle RAC). The default is `RAC`.
`-datafileDestination datafileDestination_path`	Specify the data file destination location or the name of the Oracle Automatic Storage Management (Oracle ASM) disk group. Notes: This defaults to `ORACLE_BASE/oradata` when you specify `SINGLE` for `-dbtype`. This parameter is required only for the `ORACLEDBSOFTWARE` image type. You cannot specify an Oracle ASM disk group for Oracle Databases older than 11g release 2 (11.2)
`-dbtemplate file_path \| image_name:relative_file_path`	Specify the absolute path to a database template or the relative path to the image home directory on the Rapid Home Provisioning Server. If you do not specify a database template, then RHPCTL uses the default template.
`-node node_list \| -serverpool server_pool_name`	Specify a node or a comma-delimited list of several nodes on which to create the database. Note: This parameter is required when the value of `-dbtype` is `SINGLE`. Optionally, you can specify the name of an existing server pool.
`-newpool server_pool_name -cardinality cardinality`	Optionally, you can create a server pool. Specify a name for the new server pool and specify a cardinality value for the server pool.
`-pqpool pool_name \| -newpqpool pool_name -pqcardinality cardinality`	Specify the name of an existing parallel query server pool. Optionally, you can create a parallel query server pool. Specify a name for the new server pool. If you create a parallel query server pool, then you must specify a cardinality value for the server pool. Note: These parameters are only applicable in an Oracle Flex Cluster environment and refer to server pools (either already defined as in this case, or to be created when you use the `-newpqpool` parameter) running on Leaf Nodes.
`—cdb`	Use this parameter if you want to create the database as a container database (CDB).
`-pdbName pdb_prefix [-numberOfPDBs pdb_count]`	Specify the pluggable database (PDB) name prefix if you are creating one or more PDBs. Optionally, you can specify the number of PDBs you want to create.
`-client cluster_name`	Specify the name of the client cluster.
`-ignoreprereq \| -fixup`	You can choose to ignore the Clusterware Verification Utility (CVU) checks or you can choose to run the recommended fixup script. Note: These parameters are valid only when you are provisioning Oracle Grid Infrastructure.
`-responsefile response_file_path`	Specify a response file to use when you provision Oracle Grid Infrastructure.
`-clusternodes node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]`	Specify a comma-delimited list of node information on which to provision Oracle Clusterware.
`-group "OSDBA\|OSOPER\|OSASM\|OSBACKUP\|OSDG\|OSKM\|OSRAC=group_name[,...]"`	Specify a comma-delimited list of Oracle groups, enclosed in double quotation marks (`""`), that you want to configure in the working copy. For example: `-group "OSDBA=dba,OSOPER=oper"` When you create a gold image from a source home or working copy, the gold image inherits the groups configured in the source. When you create a working copy from that gold image using `rhpctl add workingcopy`, by default, the new working copy inherits the same groups as the gold image. If you use the `-group` parameter on the command line, then: Groups configured in the gold image that you do not specify on the command line are inherited by the working copy. Groups configured in the gold image that you also specify on the command line are set to the value that you specify on the command line (command line parameters override the gold image). Groups that you specify on the command line that are not in the gold image are added to the configured groups in the gold image (the command line adds new groups). Notes: When you move or upgrade a source home (unmanaged or working copy), the groups in the destination working copy must match those of the source home. You cannot use `-group` simultaneously with the `-softwareonly` parameter.
`-root \| -sudouser sudo_user_name -sudopath sudo_binary_path`	Choose `-root` to perform super user operations as `root`. Alternatively, you can choose to perform super user operations as a sudo user by specifying a sudo user name and the path to the sudo binary. .
`-notify [-cc user_list]`	Specify this parameter to have email notifications sent to the owner of the working copy. Optionally, you can include a list of additional users who will receive notifications.
`-asmclientdata data_path`	Specify the path to a file that contains Oracle ASM client data.
`-gnsclientdata data_path`	Specify the path to a file that contains the Grid Naming Service (GNS) data.
`-clustermanifest data_path`	Optionally, you can specify the location of cluster manifest file. You can use this parameter when the Rapid Home Provisioning Server is on a domain services cluster and you are creating a member cluster.
`-softwareonly`	Use this parameter to provision only Oracle Grid Infrastructure software.
`-local`	Use this parameter to provision only Oracle Grid Infrastructure software on the local node. Note: You can only use this parameter in conjunction with the `-softwareonly` parameter, and only when running the `rhpctl add workingcopy` command on a Rapid Home Provisioning Server.
`-inventory inventory_path`	Specify the location of the Oracle Inventory directory.
`-targetnode target_node_name`	Specify the name of a node in a remote cluster with no Rapid Home Provisioning Client on which you want to provision a working copy.
`-agpath read_write_path`	Specify the path to the read-write, site-specific configuration changes to set the persistent home path.
`-aupath gold_image_path`	Specify the path for the read-only gold image to set the persistent home path.
`-supersede workingcopy_name_list`	Use this parameter to use the working copy you are creating as the target patched working copy for databases belonging to the specified working copies.
`-setupssh`	Use this parameter to set up passwordless SSH user equivalence on the remote nodes for the provisioning user.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

You can obtain context sensitive help for specific use cases for the rhpctl add workingcopy command, as follows:

$ rhpctl add workingcopy -help [REMOTEPROVISIONING | STORAGETYPE | ADMINDB
  | POLICYDB | DBWITHPQPOOLS | DBTEMPLATE | PDB | GRIDHOMEPROV | SWONLYGRIDHOMEPROV
  | STANDALONEPROVISIONING]

Examples

The following example provisions an Oracle Database software home from a gold image:

$ rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
 -oraclebase oraclebase_path

The following example provisions an Oracle Database software home and creates a policy-managed database from a gold image:

$ rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
 -oraclebase oraclebase_path -dbname unique_db_name -datafileDestination
 datafileDestination_path -serverpool pool_name

The following example provisions an Oracle Database software home on a user-specified storage location and creates a policy-managed database:

$ rhpctl add workingcopy -workingcopy workingcopy_name -image image_name
 -oraclebase oraclebase_path -storagetype LOCAL –path storage_path -dbname
 unique_db_name -datafileDestination datafileDestination_path -newpool
 server_pool_name -cardinality cardinality

Note:

If you are provisioning Oracle database software to a Rapid Home Provisioning Client that has been configured with an Oracle ASM disk group, then do not specify the -path parameter, so as to enable the Rapid Home Provisioning Client to use storage provided by Rapid Home Provisioning.

If the Rapid Home Provisioning Client is not configured with an Oracle ASM disk group, then specify the -storagetype parameter with either NFS or LOCAL, in addition to specifying the -path parameter.

F.1.59 rhpctl addnode workingcopy

Extends an Oracle RAC database to another node or nodes in a cluster.

Syntax

rhpctl addnode workingcopy -workingcopy workingcopy_name -node node_list
  [-targetnode node_name {-root | -sudouser sudo_username -sudopath sudo_binary_path} -setupssh]
  [-ignoreprereq] [-useractiondata user_action_data]

Parameters

Table F-45 rhpctl addnode workingcopy Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of a working copy that contains the Oracle database you want to extend.
`-node node_list`	Specify a node or a comma-delimited list of nodes to which you want to extend the database.
`-targetnode node_name`	Optionally, you can specify a node on which to run this command.
`-root \| -sudouser sudo_username -sudopath sudo_binary_path`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote nodes. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-ignoreprereq`	Use this parameter to ignore the CVU prerequisite checks.
`-setupssh`	Sets up passwordless SSH user equivalence on the remote nodes for the provisioning user.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

If you are extending a policy-managed database, then the database automatically starts on the new nodes.
If you are extending an administrator-managed database, then you must also run the rhpctl addnode database command to start the instance.
If the target cluster is an Oracle Clusterware 11g release 2 (11.2) or 12c release 1 (12.1) cluster, then you must provide either root credentials or provide a sudo user. You must also specify a target node that must be the node name of one of the cluster nodes.

F.1.60 rhpctl delete workingcopy

Deletes an existing working copy.

Syntax

rhpctl delete workingcopy -workingcopy workingcopy_name [-notify [-cc user_list]] [-force]
  [[-targetnode node_name] -root | -sudouser sudo_user_name -sudopath sudo_binary_path]
  [-useractiondata user_action_data]

Parameters

Table F-46 rhpctl delete workingcopy Command Parameters

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of a working copy that you want to delete.
`-notify [-cc user_list]`	Name of a node in a remote cluster with no Rapid Home Provisioning Client.
`-targetnode node_name`	Optionally, you can specify a particular node from which you want to delete a working copy.
`-force`	Use this parameter to forcibly delete the database working copy.
`-root \| -sudouser sudo_user_name -sudopath sudo_binary_path`	If you choose to use the `-targetnode` parameter, then you must choose either `sudo` or `root` to access the remote node. If you choose `sudo`, then you must specify a user name to run super-user operations, and a path to the location of the `sudo` binary.
`-useractiondata user_action_data`	Optionally, you can pass a value to the `useractiondata` parameter of the user action script.

Usage Notes

This command will not delete the working copy if there are any databases configured on it. Use the -force option to override this.
This command will not not delete the working copy if there are any running databases on it. The -force option will not override this.
This command does not delete the Oracle base that was created when you ran rhpctl add workingcopy.

Examples

To delete a working copy:

$ rhpctl delete workingcopy -workingcopy wc1

F.1.61 rhpctl query workingcopy

Displays the configuration information of an existing working copy.

Syntax

rhpctl query workingcopy [-workingcopy workingcopy_name | [-image image_name] [-client cluster_name]]

Parameters

Table F-47 rhpctl query workingcopy Command Parameters

Parameter Description

Parameter	Description
`-workingcopy workingcopy_name`	Specify the name of a working copy for which you want to display the configuration information.
`-image image_name`	Alternatively, you can specify the name of a configured image you want to query. Note: If you specify an image name, then RHPCTL lists all the working copies based on that image.
`-client cluster_name`	Optionally, you can specify a client cluster on which to query working copies.

-workingcopy
 workingcopy_name

Specify the name of a working copy for which you want to display the configuration information.

-image image_name

Alternatively, you can specify the name of a configured image you want to query.

Note: If you specify an image name, then RHPCTL lists all the working copies based on that image.

-client cluster_name

Optionally, you can specify a client cluster on which to query working copies.

F.1 RHPCTL Command Reference

F.1.1 RHPCTL Overview

F.1.2 Using RHPCTL Help

F.1.3 rhpctl delete audit

F.1.4 rhpctl modify audit

F.1.5 rhpctl query audit

F.1.6 rhpctl add client

F.1.7 rhpctl delete client

F.1.8 rhpctl discover client

F.1.9 rhpctl export client

F.1.10 rhpctl modify client

F.1.11 rhpctl query client

F.1.12 rhpctl verify client

F.1.13 rhpctl add database

F.1.14 rhpctl addnode database

F.1.15 rhpctl delete database

F.1.16 rhpctl deletenode database

F.1.17 rhpctl move database

F.1.18 rhpctl upgrade database

F.1.19 rhpctl addnode gihome

F.1.20 rhpctl deletenode gihome

F.1.21 rhpctl move gihome

F.1.22 rhpctl upgrade gihome

F.1.23 rhpctl add image

F.1.24 rhpctl allow image

F.1.25 rhpctl delete image

F.1.26 rhpctl disallow image

F.1.27 rhpctl import image

F.1.28 rhpctl modify image

F.1.29 rhpctl query image

F.1.30 rhpctl promote image

F.1.31 rhpctl add imagetype

F.1.32 rhpctl allow imagetype

F.1.33 rhpctl delete imagetype

F.1.34 rhpctl disallow imagetype

F.1.35 rhpctl modify imagetype

F.1.36 rhpctl query imagetype

F.1.37 rhpctl add role

F.1.38 rhpctl delete role

F.1.39 rhpctl grant role

F.1.40 rhpctl query role

F.1.41 rhpctl revoke role

F.1.42 rhpctl add series

F.1.43 rhpctl delete series

F.1.44 rhpctl deleteimage series

F.1.45 rhpctl insertimage series

F.1.46 rhpctl query series

F.1.47 rhpctl subscribe series

F.1.48 rhpctl unsubscribe series

F.1.49 rhpctl query server

F.1.50 rhpctl delete user

F.1.51 rhpctl modify user

F.1.52 rhpctl register user

F.1.53 rhpctl unregister user

F.1.54 rhpctl add useraction

F.1.55 rhpctl delete useraction

F.1.56 rhpctl modify useraction

F.1.57 rhpctl query useraction

F.1.58 rhpctl add workingcopy

F.1.59 rhpctl addnode workingcopy

F.1.60 rhpctl delete workingcopy

F.1.61 rhpctl query workingcopy