F Fleet Patching and Provisioning Control (RHPCTL) Command Reference
Use the Fleet Patching and Provisioning Control (RHPCTL) utility to manage Fleet Patching and Provisioning in your cluster.
This appendix contains reference information for Fleet Patching and Provisioning commands, including utility usage information and a comprehensive listing of the RHPCTL commands.
RHPCTL Overview
RHPCTL is a command-line utility with which you perform Fleet Patching and Provisioning operations and manage Fleet Patching and Provisioning Servers and Clients. RHPCTL uses the following syntax:
rhpctl command object [parameters]
In RHPCTL syntax:
-
command
is a verb such asadd
,delete
, orquery
-
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 thevalue
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 Fleet Patching and Provisioning operations, including:
-
Fleet Patching and Provisioning Client operations, such as creating a Fleet Patching and 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 Fleet Patching and 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.
RHPCTL Command Reference
This section describes RHPCTL command usage information, and lists and describes RHPCTL commands.
rhpctl delete audit
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.
rhpctl modify audit
Syntax
rhpctl modify audit -maxrecord number
Usage Notes
Specify the maximum number of audit records to store.
rhpctl query audit
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 Fleet Patching and Provisioning operations. |
-client cluster_name |
Optionally, you can choose to run a query audit on a particular client cluster where Fleet Patching and 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 |
-before timestamp |
Optionally, you can specify a time before which to run an audit query. Timestamp must be in the format |
-since timestamp |
Optionally, you can specify a time after which to run an audit query. Timestamp must be in the format |
-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. |
rhpctl add client
Adds a Fleet Patching and Provisioning Client to the Fleet Patching and Provisioning Server configuration.
Syntax
rhpctl add client -client cluster_name [-toclientdata path] [-targetnode node_name
{-sudouser sudo_user_name -sudopath sudo_binary_location | -root |
-cred cred_name} | -auth plugin_name [-arg1 name1:value1...]]
[-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 Fleet Patching and 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 Fleet Patching and Provisioning Client. |
-sudouser sudo_user_name -sudopath sudo_binary_location | -root | -cred cred_name |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. |
-auth plugin_name [-arg1 name1:value1...] |
Alternative to |
-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 |
Usage Notes
-
Only clusters running Oracle Grid Infrastructure 12c release 2 (12.2) or later can be configured and added as Fleet Patching and Provisioning Clients. Clusters running earlier versions of Oracle Grid Infrastructure, and servers running no Oracle Grid Infrastructure, can be managed directly by the Fleet Patching and Provisioning Server.
-
You can only run this command on the Fleet Patching and Provisioning Server.
Examples
To add a client to the Fleet Patching and Provisioning Server:
$ rhpctl add client -client ClientCluster3 -toclientdata Grid_home/RHPserver/info
rhpctl delete client
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 Fleet Patching and Provisioning Client before you run this command or use the
-force
option.
Example
ClientCluster3
:$ rhpctl delete client -client ClientCluster3
rhpctl discover client
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 | -cred cred_name | -auth plugin_name
[-arg1 name1:value1...]} [-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: |
-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 | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
You must choose either If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-user gi_user_name |
Specify the name of the Oracle Grid Infrastructure installation user. |
-scan scan_name |
Specify the SCAN name. |
rhpctl export client
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 Fleet Patching and Provisioning Server.
Example
mjk9394
to a client data file, /tmp/mjk9394.xml
:$ rhpctl export client -client mjk9394 -clientdata /tmp/mjk9394.xml
rhpctl modify client
Modifies a Fleet Patching and 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 |
---|---|
|
Specify the name of the client cluster that you want to modify. |
|
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 |
|
Optionally, you can specify a password to recreate the Fleet Patching and Provisioning Client credentials. |
Example
To disable a Fleet Patching and Provisioning Client named RHPClient001
:
$ rhpctl modify client -client RHPClient001 -enabled FALSE
rhpctl query client
Syntax
rhpctl query client [–client cluster_name]
Usage Notes
Specify the name of the client cluster in which the Fleet Patching and Provisioning Client resides for which you want to display the configuration information
Example
/rhpctl query client -client mbcluster-13
Site: mbcluster-13
Fleet Patching and 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: 8896
RHP Enabled: true
Standalone: false
Managed: true
rhpctl update client
Syntax
rhpctl update client -image image_name {-targetnode node_name
| -batches '(node_name)'} -root
Parameters
Table F-6 rhpctl update client Command Parameters
Parameter | Description |
---|---|
-image image_name |
Specify the name of the image that you want to update. |
-targetnode node_name |
Specify the name of the node on which you want to update the Fleet Patching and Provisioning Client. |
-batches '(node_name)' |
Alternative to specifying a target node, you can specify batches of nodes. Note: If you use this parameter for Oracle Database Appliance nodes, then run the command twice, in succession, specifying any one Oracle Database Appliance node for the first run, and another Oracle Database Appliance node for the second run. |
–root |
You must specify this parameter if you use either the –targetnode or –batches parameters.
|
Usage Notes
You can only run this command from a Fleet Patching and Provisioning Server.
Examples
The following example uses the –targetnode
parameter:
$ rhpctl update client -image ODA1 -targetnode rac07box1 -root
The two following examples use the –batches
parameter:
$ rhpctl update client -image ODA1 -batches '(rac07box1)' -root
$ rhpctl update client -image ODA1 -batches '(rac07box2)' -root
rhpctl verify client
Syntax
rhpctl verify client -image image_name -responsefile response_file_name
[-clusternodes node_list] {-root | -sudouser sudo_username -sudopath
sudo_binary_path | -cred cred_name} | -auth plugin_name [-arg1 name1:value1...]
[-user gi_user_name] [-client cluster_name] [-scan scan_name]
[-oraclehome oracle_home_path] [-ignorewarn] [-fixup [-setupSSH]]
Parameters
Table F-7 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: |
-root | -sudouser sudo_username -sudopath sudo_binary_path | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
You must choose either If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-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 |
rhpctl add credentials
Syntax
rhpctl add credentials -cred cred_name {-root | -sudouser sudo_user_name
-sudopath sudo_binary_location}
Parameters
Table F-8 rhpctl add credentials Command Parameters
Parameter | Description |
---|---|
-cred cred_name |
Specify a credential name to associate the user and password credentials to access a remote node. |
-root | -sudouser sudo_user_name -sudopath sudo_binary_location |
You must choose either to provide |
rhpctl delete credentials
Syntax
rhpctl delete credentials -cred cred_name
Usage Notes
Specify only the name of the credentials you want to delete.
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 | -cred cred_name
| -auth plugin_name [-arg1 name1:value1...]}] [-targetnode node_name]
[-useractiondata user_action_data] [-schedule timer_value] [-eval]
Parameters
Table F-9 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 ( |
-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 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 non-Hub 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 Fleet Patching and 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 | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-targetnode node_name |
Optionally, you can specify the name of a node in a remote cluster that has no Fleet Patching and Provisioning Client. |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
Usage Notes
If you choose to use the -schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
Examples
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.rhpctl addnode database
Syntax
rhpctl addnode database -workingcopy workingcopy_name
-dbname unique_db_name -node node_list
[-root | -cred cred_name | -sudouser sudo_user_name
-sudopath sudo_binary_location |
-auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]]
[-useractiondata user_action_data] [-eval] [-schedule timer_value]
Parameters
Table F-10 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 ( |
-node node_list |
Specify a node or comma-delimited list of several nodes on which to create the database. |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
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 Fleet Patching and Provisioning Client or on the Fleet Patching and 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 Fleet Patching and Provisioning Client.
-
If you choose to use the
-schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
rhpctl addpdb database
After you create a working copy of a gold image and provision that working copy to a target, and create a database as a multitenant container database, you can add a pluggable database to the container database on the working copy.
Syntax
rhpctl addpdb database -workingcopy workingcopy_name -cdbName cdb_name
-pdbName new_pdb_name [-pdbDatafileDestination pdb_datafile_destination_path]
[-root | -cred cred_name | -auth plugin_name [-arg1 name1:value1...]
| -sudouser user_name -sudopath sudo_binary_path] [-targetnode node_name]
[-useractiondata user_action_data] [-schedule timer_value]
Parameters
Table F-11 rhpctl addpdb database Command Parameters
Parameter | Description |
---|---|
-workingcopy workingcopy_name |
Specify the name of an existing working copy for the pluggable database that you want to add. |
-cdbName cdb_name |
Specify the name of the multitenant container database to which you want to add the pluggable database. |
-pdbName new_pdb_name |
Specify a name for the pluggable database you are adding. |
-pdbDatafileDestination pdb_datafile_destination |
Optionally, you can specify the path to the data file destination location for the pluggable database. |
-root | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] | -sudouser user_name -sudopath sudo_binary_path |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-targetnode node_name |
Optionally, you can specify the name of a node in the cluster on which you want to run this operation. |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
Usage Notes
The working copy can be on Fleet Patching and Provisioning Server, a Fleet Patching and Provisioning Client, or a non-Fleet Patching and Provisioning Client target.
Example
The following example creates a pluggable database called pdb183
on a container database called raccdb183
on a working copy called wc_db183
:
$ rhpctl addpdb database -workingcopy wc_db183 -cdbName raccdb183 -pdbName pdb183
rhpctl deletepdb database
Syntax
rhpctl deletepdb database -workingcopy workingcopy_name -cdbName cdb_name
-pdbName pdb_name
[-root | -cred cred_name | -auth plugin_name [-arg1 name1:value1...]
| -sudouser user_name -sudopath sudo_binary_path] [-targetnode node_name]
[-useractiondata user_action_data] [-schedule timer_value]
Parameters
Table F-12 rhpctl deletepdb database Command Parameters
Parameter | Description |
---|---|
-workingcopy workingcopy_name |
Specify the name of an existing working copy for the pluggable database that you want to delete. |
-cdbName cdb_name |
Specify the name of the multitenant container database from which you want to delete the pluggable database. |
-pdbName pdb_name |
Specify the name of the pluggable database you want to delete. |
-root | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] | -sudouser user_name -sudopath sudo_binary_path |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-targetnode node_name |
Optionally, you can specify the name of a node in the cluster on which you want to run this operation. |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
Usage Notes
The working copy can be on Fleet Patching and Provisioning Server, a Fleet Patching and Provisioning Client, or a non-Fleet Patching and Provisioning Client target.
Examples
The following example deletes a pluggable database called pdb183
from a container database called raccdb183
on a working copy called wc_db183
:
$ rhpctl deletepdb database -workingcopy wc_db183 -cdbName raccdb183 -pdbName pdb183
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 Fleet Patching and Provisioning Server or on a Fleet Patching and 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 Fleet Patching and Provisioning Client.Syntax
rhpctl delete database –workingcopy workingcopy_name -dbname unique_db_name
{-sudouser sudo_user_name -sudopath sudo_binary_path | -root | -cred cred_name
| -auth plugin_name [-arg1 name1:value1...]} [-targetnode node_name]
[-useractiondata user_action_data]
Parameters
Table F-13 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 ( |
-sudouser user_name -sudopath sudo_binary_path | -root | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-targetnode node_name |
Optionally, you can specify the name of a node in a remote cluster that has no Fleet Patching and Provisioning Client. |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
rhpctl deletenode database
Syntax
rhpctl deletenode database -workingcopy working_copy_name -dbname unique_db_name
-node node_list {-root | -sudouser sudo_username -sudopath sudo_binary_path
| -cred cred_name | -auth plugin_name [-arg1 name1:value1...]} [-force]
[-failover] [-drain_timeout timeout] [-stopoption stop_option]
[-useractiondata user_action_data] [-schedule timer_value] [-eval]
Parameters
Table F-14 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 ( |
-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 | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
Choose either If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-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 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: |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
Usage Notes
-
If the working copy is on a Fleet Patching and Provisioning Client or on the Fleet Patching and 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 Fleet Patching and Provisioning Client.
-
If you choose to use the
-schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
rhpctl move database
Moves one or more databases from a source working copy or any Oracle Database home to a 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 | -excludedblist db_name_list]
[-nonrolling | -forcerolling | -batches list_of_batches | -smartmove [-saf availability]
[-separate]] [-eval] [schedule timer_value] [-ignorewcpatches] [-keepplacement]
[-disconnect [-noreplay]] [-drain_timeout time] [-stopoption stop_option]
[-nodatapatch] [-targetnode node_name] [-notify [-cc user_list]] |
-continue [-skip] | -revert | -abort}
[-root | -cred cred_name | -sudouser sudo_user_name
-sudopath sudo_binary_location |
-auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]]
[-useractiondata user_action_data] [-schedule timer_value]
Parameters
Table F-15 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 |
-client cluster_name |
Specify the name of the client cluster. |
-dbname db_name_list |
Specify the unique names of the databases ( Note: If you are moving a non-clustered (single-instance) database, then, for the value of the |
-excludedblist db_name_list |
Alternative to using the |
-nonrolling | -forcerolling -batches list_of_batches | -smartmove [-saf availability] [–separate] |
Optionally, you can choose one of the three following methods to move a database:
Use the |
–eval |
Use the |
-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 |
-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: |
–nodatapatch |
Use this parameter to indicate not to run |
-targetnode node_name |
Optionally, you can specify the name of a node in a remote cluster that has no Fleet Patching and 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] |
If a batch-mode |
—revert |
If a batch-mode or non-batch-mode |
—abort |
If a batch-mode or non-batch-mode |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
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]
-
If you choose to use the
-schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
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
To move a non-clustered (single-instance) database with a SID of SID101
running on a patched working copy named myDB12Home1patched
:
$ rhpctl move database -patchedwc myDB12Home1patched -sourcehome
/u01/app/oracle/product/12.2.0/db_1 -targetnode vm02 -dbname SIDl01
-sudouser oracle -sudopath /usr/bin/sudo
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.
rhpctl movepdb database
The source and destination single-instance container databases can be running in a provisioned database working copy. The working copy can be on the Fleet Patching and Provisioning Server, a Fleet Patching and Provisioning Client, or a non-Fleet Patching and Provisioning Client target, which is a target without a Fleet Patching and Provisioning Client configured and running. The destination single-instance container database can be at a higher patch level, which facilitates patching of a pluggable database to a higher patch level.
Syntax
rhpctl movepdb database -sourcecdb source_cdb_name -destcdb destination_cdb_name
{-pdbname pdb_name_list | -excludepdblist pdb_name_list}
[-root | -cred cred_name | -sudouser sudo_user_name
-sudopath sudo_binary_location |
-auth plugin_name [-arg1 name1:value1
[-arg2 name2:value2 ...]]] [-client client_name | -targetnode node_name]
[-useractiondata user_action_data] [-schedule timer_value]
Parameters
Table F-16 rhpctl movepdb database Command Parameters
Parameter | Description |
---|---|
-sourcecdb source_cdb_name |
Specify the name of the Oracle Multitenant container database from which you want to move the pluggable database. |
-destcdb destination_cdb_name |
Specify the name of the multitenant container database to which you want to move the pluggable database. |
-pdbname pdb_name_list |
Specify a comma-separated list of names of pluggable databases that you want to move. |
-excludepdblist pdb_name_list |
Specify a list of pluggable databases that you want to excluded from the move operation. |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-client client_name | -targetnode node_name |
Optionally, you can specify either the name of the client cluster or the node on which the operation is to be run. |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value | NOW |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
You can also specify |
Usage Notes
You can only use this command if both the source and destination single-instance container databases are on the same node.
Examples
rhpctl movepdb database -sourcecdb srccdb -pdbname pdb1,pdb2,pdb3 -destcdb dstcdb
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 | -cred cred_name | -sudouser sudo_username -sudopath path_to_sudo_binary
| -auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]]
-destwc destination_workingcopy_name [-image image_name [-path where_path]]
-dbname unique_db_name [-useractiondata user_action_data] [-eval [-preupg]
[-schedule timer_value]
Parameters
Table F-17 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 |
-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 Fleet Patching and Provisioning Client on which to provision a working copy. |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-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 |
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
Usage Notes
If you choose to use the -schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
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
rhpctl zdtupgrade database
Syntax
rhpctl zdtupgrade database -dbname unique_db_name -destwc destination_workingcopy_name
[-sourcewc source_workingcopy_name | -sourcehome oracle_home_path]
-ggsrcwc golden_gate_source_workingcopy_name
-ggdstwc golden_gate_dest_workingcopy_name
[-clonedatadg diskgroup_name [-cloneredodg diskgroup_name]
[-clonerecodg diskgroup_name]]
[-rmanlocation backup_location]
[-targetnode node_name
{-root | -cred cred_name | -sudouser sudo_user_name
-sudopath sudo_binary_location |
-auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]}]
[-useractiondata user_action_data]
Parameters
Table F-18 rhpctl zdtupgrade database Command Parameters
Parameter | Description |
---|---|
-dbname unique_db_name |
Specify the unique name of the database that you want to upgrade. |
-destwc destination_workingcopy_name |
Specify the name of the destination working copy to which the database is to be upgraded. |
-sourcewc source_workingcopy_name |
Optionally, you can 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. |
-ggsrcwc golden_gate_source_workingcopy_name |
Specify the name of the Oracle GoldenGate source working copy. |
-ggdstwc golden_gate_dest_workingcopy_name |
Specify the name of the Oracle GoldenGate destination working copy. |
-clonedatadg diskgroup_name |
Optionally, you can specify the name of an Oracle ASM disk group to use as a data file location for the cloned database. |
-cloneredodg diskgroup_name |
Optionally, you can specify the name of an Oracle ASM disk group to use as a redo log location for the clones database. |
-clonerecodg diskgroup_name |
Optionally, you can specify the name of an Oracle ASM disk group to use as a recovery area for the cloned database. |
-rmanlocation backup_location |
Optionally, you can specify the source RMAN backup location. |
-targetnode node_name |
Optionally, you can specify the name of a node in a remote cluster with no Fleet Patching and Provisioning Client on which to provision a working copy. |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-useractiondata user_action_data |
Optionally, you can use this parameter to specify a value to be passed to the useractiondata parameter of a useraction script |
rhpctl addnode gihome
Syntax
rhpctl addnode gihome {-workingcopy workingcopy_name | -client cluster_name}
-newnodes node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]
{-root | -cred cred_name | -sudouser sudo_user_name
-sudopath sudo_binary_location |
-auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]}
[-targetnode node_name] [-force] [-setupssh] [-useractiondata user_action_data]
[-eval] [-schedule timer_value]
Parameters
Table F-19 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: |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
You must choose either Choose |
-targetnode node_name |
Optionally, you can specify the name of a node in a remote cluster that has no Fleet Patching and Provisioning Client. |
–force |
Optionally, you can use this parameter to forcibly add nodes ignoring any previously failed add-node operation. |
-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 |
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
-schedule timer_value |
Optionally, you can schedule a time to run this command in ISO-8601 format. For example: 2018-01-21T19:13:17+05. |
Usage Notes
-
You can specify the target for the operation using the working copy name or, if the target is a Fleet Patching and Provisioning Client, then using the client cluster name.
-
You must provide either
root
credentials, a credential name, asudo
user, or an authentication plugin. -
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.
rhpctl deletenode gihome
Syntax
rhpctl deletenode gihome {-workingcopy workingcopy_name | -client cluster_name}
-node node_list {-root | -sudouser sudo_username -sudopath sudo_binary_path
-cred cred_name | -auth plugin_name [-arg1 name1:value1...]}
[-targetnode node_name] [-useractiondata user_action_data] [-eval]
Parameters
Table F-20 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 | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
You must choose either If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-targetnode node_name |
Name of a node in a remote cluster with no Fleet Patching and Provisioning Client. |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
Usage Notes
-
You can specify the target for the operation using the working copy name or, if the target is a Fleet Patching and Provisioning Client, then using the client cluster name.
-
You must provide either
root
credentials or asudo
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.
rhpctl move gihome
Moves the Oracle Grid Infrastructure software stack from one home to another.
Syntax
rhpctl move gihome {-destwc destination_workingcopy_name |
-desthome destination_oracle_home_path}
{{-sourcewc source_workingcopy_name | -sourcehome oracle_home_path}
[-targetnode target_node_name] [-ignorewcpatches] [-nonrolling]
[-keepplacement] [-auto -dbhomes mapping_of_Oracle_homes [-dblist db_name_list
| -excludedblist db_name_list] [-nodatapatch] [-disconnect]
[-stopoption stop_option] [-drain_timeout timeout]]
[-batches list_of_batches | -smartmove [-saf availability]]
[-schedule timer_value] | -continue | -revert |-abort}
[-root | -cred cred_name | -sudouser sudo_username -sudopath path_to_sudo_binary
| -auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]] [-cleanpids]
[-useractiondata user_action_data] [-schedule timer_value] [-eval]
Parameters
Table F-21 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. |
-desthome destination_oracle_home_path |
Alternative to specifying the name of the destination working copy, you can specify the path to the destination for the move of an Oracle home when you are moving the Oracle Grid Infrastructure home. |
-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 Fleet Patching and Provisioning) Oracle home, then specify the path to the Oracle home from which you want to move Oracle Grid Infrastructure. |
-targetnode target_node_name |
Name of a node in a remote cluster with no Fleet Patching and 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 |
Optionally, you can use this parameter to indicate not to run |
-disconnect |
Optionally, you can use this parameter to disconnect all sessions before stopping or relocating services. |
-stopoption stop_option |
Optionally, you can choose one of the following stop options for the database: ABORT, IMMEDIATE, NORMAL, TRANSACTIONAL, or TRANSACTIONAL_LOCAL. |
-drain_timeout session_drain_time |
Optionally, you can use this parameter to specify a service drain timeout, in seconds. |
-batches list_of_batches |
Optionally, you can 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 ( |
-smartmove [-saf availability |
Alternatively, you can use the Optionally, you can use the |
-schedule timer_value |
Optionally, you can schedule a time to run this command in ISO-8601 format. For example: 2018-01-21T19:13:17+05. |
-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 | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-cleanpids |
When using a persistent home path for both the source and destination working copies, specify |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
-eval |
Use this parameter to evaluate the |
Usage Notes
If you choose to use the -schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
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
rhpctl upgrade gihome
Syntax
rhpctl upgrade gihome {-sourcewc source_workingcopy_name | -sourcehome oracle_home_path
-targetnode target_node_name} -destwc destination_workingcopy_name
{-root | -sudouser sudo_user_name -sudopath sudo_binary_location]
-cred cred_name | -auth plugin_name [-arg1 name1:value1...]}
[-ignoreprereq]
Parameters
Table F-22 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 Fleet Patching and Provisioning Client. |
-destwc destination_workingcopy_name |
Specify the name of the destination working copy to which the Oracle Grid Infrastructure home is to be upgraded. |
-root | -sudouser sudo_username -sudopath sudo_binary_path | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-ignoreprereq |
Use this parameter to ignore the CVU prerequisite checks. |
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 Fleet Patching and 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-23 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. |
-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
See Also:
Patching Oracle Database Software for details about how to use this command in the workflow for creating patched Oracle Database software homesExample
An example of this command is:
$ rhpctl add image -image DB12201_PATCH -workingcopy temp_wcpy_db12201_patch
rhpctl allow image
Syntax
rhpctl allow image -image image_name {-user user_name [-client cluster_name]
| -role role_name}
Parameters
Table F-24 rhpctl allow image Command Parameters
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:
|
Examples
$ rhpctl allow image -image PRODIMAGE -user mjk -client GHC1
rhpctl delete image
Deletes a specific image.
Syntax
rhpctl delete image -image image_name [-schedule timer_value]
Usage Notes
-
Specify the name of the image you want to delete
-
Optionally, you can use the
-schedule
parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:2018-07-25T19:13:17+05
If you choose to use this parameter, then you must run this command on the Fleet Patching and Provisioning Server.
-
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
rhpctl deploy image
Syntax
rhpctl deploy image -image image_name [-targetnode node_name
{-sudouser sudo_user_name -sudopath sudo_binary_path | -root}]
Parameters
Table F-25 rhpctl deploy image Command Parameters
Parameter | Description |
---|---|
-image image_name |
Specify the name of the image you want to deploy. |
-targetnode node_name |
Optionally, you can specify the name of a node to which you want to deploy the image. This parameter is required if the node hosting the home is not a Fleet Patching and Provisioning Client. |
-sudouser sudo_user_name -sudopath sudo_binary_path | -root] |
If you use the |
Usage Notes
You can only run this command from a Fleet Patching and Provisioning Server.
Example
The following example deploys an Oracle Database Appliance image to a node:
$ rhpctl deploy image -image ODA1 -targetnode racgbox1 -root
rhpctl disallow image
Syntax
rhpctl disallow image -image image_name {-user user_name [-client client_name]
| -role role_name}
Parameters
Table F-26 rhpctl disallow image Command Parameters
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:
|
Examples
$ rhpctl disallow image -image PRODIMAGE -user mjk -client GHC1
rhpctl import image
Creates an image on the Fleet Patching and Provisioning Server.
Use the rhpctl import image
command to create an image by copying the entire software contents from the specified path to the Fleet Patching and Provisioning Server.
Syntax
rhpctl import image -image image_name -path path
[-imagetype image_type] [-version software_version] [-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] [-schedule timer_value]
Parameters
Table F-27 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 |
-imagetype image_type |
Specify the software type. Use ORACLEDBSOFTWARE (default) for Oracle database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, ODAPATCHSOFTWARE, for engineered systems (Oracle Data Appliance), or SOFTWARE for all other software. For a custom image type, use the image type name. |
-version software_version |
Optionally, you can specify the version of the software you are importing. |
-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. This parameter is required if the node hosting the home is not an Fleet Patching and Provisioning Client. |
-sudouser sudo_user_name -sudopath sudo_binary_path | -root] |
If you use the |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
Usage Notes
-
You can only run this command on a Fleet Patching and Provisioning Server.
-
When you import an Oracle Database or Oracle Grid Infrastructure software home, the version of the home must be one of the versions that Fleet Patching and Provisioning supports for provisioning and patching.
Examples
The following example imports an image:
$ rhpctl import image -image PRODIMAGEV1 -path /u01/app/product/12.1.0/dbhome -pathowner orcl
The following example imports an engineered system image:
$ rhpctl import image -image ODA1 -imagetype ODAPATCHSOFTWARE -path /tmp/ODAPatchBundle -version 12.1.2.8.0
rhpctl instantiate image
Syntax
rhpctl instantiate image -server server_cluster_name {-image image_name
| -series series_name | -imagetype image_type | -all}
Parameters
Table F-28 rhpctl instantiate image Command Parameters
Parameter | Description |
---|---|
-server server_cluster_name |
Specify a Fleet Patching and Provisioning Server cluster from which you want to request images. |
-image image_name | -series series_name | -imagetype image_type | -all |
You can request copies of gold images from a peer Fleet Patching and Provisioning Server, specifically, by image name, series name, or image type. Alternatively, you can use the If you choose to request images by image type, then specify |
Usage Notes
-
User actions associated with an image being copied are not themselves copied.
-
Groups configuration of a gold image is replicated in copies sent to peers.
-
Copies of gold images are in the PUBLISHED state.
rhpctl modify image
Syntax
rhpctl modify image -image image_name -imagetype image_type
Parameters
Table F-29 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. |
rhpctl query image
Syntax
rhpctl query image [[-image image_name [-dbtemplate]] | [[-imagetype image_type]
[-version version] [-platform platform]]]
Parameters
Table F-30 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 |
-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
, andIntel_Solaris_AMD64
rhpctl promote image
Syntax
rhpctl promote image -image image_name -state {TESTABLE | RESTRICTED | PUBLISHED}
Parameters
Table F-31 rhpctl promote image Command Parameters
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:
|
Example
$ rhpctl promote image -image PRODIMAGE -state RESTRICTED
rhpctl uninstantiate image
Syntax
rhpctl uninstantiate image -server server_cluster_name {-image image_name
| -series series_name | -imagetype image_type | -all}
Parameters
Table F-32 rhpctl uninstantiate image Command Parameters
Parameter | Description |
---|---|
-server server_cluster_name |
Specify a Fleet Patching and Provisioning Server cluster from which you want to stop updates. |
-image image_name | -series series_name | -imagetype image_type | -all |
You can updates from a peer Fleet Patching and Provisioning Server, specifically, by image name, series name, or image type. Alternatively, you can use the If you choose to stop updates by image type, then specify |
rhpctl add imagetype
Configures a new image type and its associated user actions.
Syntax
rhpctl add imagetype -imagetype image_type -basetype {SOFTWARE |
ORACLEGISOFTWARE | ORACLEDBSOFTWARE | ORACLEGGSOFTWARE}
[-useractions user_action_list]
Parameters
Table F-33 rhpctl add imagetype Command Parameters
Parameter | Description |
---|---|
-imagetype image_type |
Specify the name of the image type you are creating. |
-basetype {SOFTWARE | ORACLEGISOFTWARE | ORACLEDBSOFTWARE | ORACLEGGSOFTWARE} |
Specify a base image type on which the image type you are creating is based. Use |
-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
rhpctl allow imagetype
Syntax
rhpctl allow imagetype -imagetype image_type {-user user_name [-client cluster_name] | -role role_name}
Parameters
Table F-34 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 |
-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 |
-role role_name |
Alternative to the |
rhpctl delete imagetype
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.
rhpctl disallow imagetype
Syntax
rhpctl disallow imagetype -imagetype image_type {-user user_name [-client cluster_name] | -role role_name}
Parameters
Table F-35 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 |
-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 |
-role role_name |
Alternative to the |
rhpctl modify imagetype
Syntax
rhpctl modify imagetype -imagetype image_type -useractions user_action_list
Parameters
Table F-36 rhpctl modify imagetype Command Parameters
Parameter | Description |
---|---|
-imagetype image_type |
Specify the name of the image type you want to modify. Use |
-useractions user_action_list |
Specify a comma-delimited list of names of user actions |
rhpctl query imagetype
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.
rhpctl delete job
Syntax
rhpctl delete job [-jobid job_id] [-force]
Parameters
Table F-37 rhpctl delete job Command Parameters
Parameter | Description |
---|---|
-jobid job_id |
Optionally, you can specify the job ID value for the job you want to delete that you obtained while scheduling the job. If you choose not to use this parameter, then RHPCTL deletes all jobs. |
–force |
Use this parameter to forcibly delete a job. |
Usage Notes
You must run this command on the Fleet Patching and Provisioning Server.
Example
To delete a job with a job ID of 1
:
$ rhpctl delete job –jobid 1
rhpctl query job
Syntax
rhpctl query job [-jobid job_id] [-status {EXECUTED | TIMER_RUNNING
| EXECUTING | UNKNOWN | TERMINATED }] [-client client_name] [-user user_name]
[-since timer_value] [-summary]
Parameters
Table F-38 rhpctl query job Command Parameters
Parameter | Description |
---|---|
-jobid job_id |
Optionally, you can specify the job ID value for the job you want to query that you obtained while scheduling the job. If you choose not to use this parameter, then RHPCTL queries all jobs. |
-status {EXECUTED | TIMER_RUNNING
| EXECUTING | UNKNOWN | TERMINATED } |
Optionally, you can specify any of the following states of a job that you want to query:
|
-client client_namek |
Optionally, you can specify the name of a client cluster for which you want to query jobs. |
-user user_name |
Optionally, you can specify the user name of the user for whom a software home is being provisioned. |
-since timer_value |
Optionally, you can specify a date from which to query the jobs, in ISO-8601 format, as in the following example:
|
-summary |
Optionally, you can use this parameter to return only job details. |
Usage Notes
You must run this command on the Fleet Patching and Provisioning Server.
Example
$ rhpctl query job –jobid 1
Job ID: 1
User: fred
Client: fredlinux4
Scheduled job command: "rhpctl import image -image DB-Image1 -imagetype ORACLEDBSOFTWARE -path /ade/fred_linux4/esw1 -schedule 2018-07-27T13:38:57Z"
Scheduled job execution start time: 2018-07-27T05:38:57-08. Equivalent local time: 2018-07-27 05:38:57
Current status: EXECUTED
Result file path: "/scratch/rhp_storage/chkbase/scheduled/job-1-2017-11-27-05:39:14.log"
Job execution start time: 2018-07-27 05:39:14
Job execution end time: 2018-07-27 05:43:09
Job execution elapsed time: 3 minutes 55 seconds
Result file "/scratch/rhp_storage/chkbase/scheduled/job-1-2018-07-27-05:39:14.log" contents:
slc05amw.foo.com: Audit ID: 4
slc05amw.foo.com: Creating a new ACFS file system for image "DB-Image1" ...
slc05amw.foo.com: Copying files...
slc05amw.foo.com: Copying home contents...
slc05amw.foo.com: Changing the home ownership to user fred...
slc05amw.foo.com: Changing the home ownership to user fred...
rhpctl collect osconfig
Syntax
rhpctl collect osconfig -client cluster_name [-targetnode node_name
{-sudouser sudo_user_name -sudopath sudo_binary_location | -root}]
Parameters
Table F-39 rhpctl collect osconfig Command Parameters
Parameter | Description |
---|---|
-client cluster_name |
Specify the name of the client cluster. |
-targetnode node_name |
Optionally, you can specify the name of a particular node in a cluster from which to collect configuration information. |
-sudouser sudo_user_name -sudopath sudo_binary_path | -root] |
If you use the |
rhpctl compare osconfig
Syntax
rhpctl compare osconfig -client cluster_name -node node_name -id1 identifier -id2 identifier
Parameters
Table F-40 rhpctl compare osconfig Command Parameters
Parameter | Description |
---|---|
-client cluster_name |
Specify the name of the client cluster in which you want to compare operating system configurations. |
-node node_name |
Specify the name of a node in a remote cluster. |
-id1 identifier |
Specify an identifier of an operating system configuration to be considered as a reference. |
-id2 identifier |
Specify an identifier of an operating system configuration to be compared. |
rhpctl disable osconfig
Syntax
rhpctl disable osconfig [-client cluster_name] [-clean]
Usage Notes
-
Optionally, you can specify a client cluster name on which you want to disable collection of operating system configuration information.
-
Optionally, you can use the
–clean
parameter to delete all operating system configuration backups.
rhpctl enable osconfig
Syntax
rhpctl enable osconfig -client cluster_name [-retaincopies count]
[-start timer_value] [-frequency collect_frequency] [-collectnow
[-targetnode node_name {-sudouser sudo_user_name -sudopath sudo_binary_location
| -root}]] [-force]
Parameters
Table F-41 rhpctl enable osconfig Command Parameters
Parameter | Description |
---|---|
-client cluster_name |
Specify the name of the client cluster. |
-retaincopies count |
Optionally, you can specify the number of scheduled backups you want to be maintained. The default value is |
-start timer_value |
Optionally, you can specify a start date and time to run configuration collection according to the following example: 2018-07-23T00:00:00-07 |
-frequency collect_frequency |
Optionally, you can specify the configuration collection interval in number of days. |
-collectnow |
Optionally, you can use this parameter to collect configuration information, immediately. |
-targetnode node_name |
Optionally, you can specify the name of a particular node in a cluster from which to collect configuration information. |
-sudouser sudo_user_name -sudopath sudo_binary_path | -root] |
If you use the |
-force |
Optionally, you can use this parameter to forcibly modify the count for the |
rhpctl query osconfig
Syntax
rhpctl query osconfig -client client_name
Usage Notes
Provide the name of the client cluster that you want to query operating system configuration collection information.
Example
This command returns output similar to the following:
$ rhpctl query osconfig -client rhpdemocluster
OSConfig Enabled: true
Collection start time: “00:00:00"
Collection frequency: "1"
retaincopies count: "35"
OSConfig periodic Job ID: "38"
Collection storage path: "/scratch/rhp_storage/chkbase/osconfig/rhpdemocluster"
Latest list of nodes for collections : "mjk00fwc"
OSConfig ID: "22" Collected on: "Jul 27, 2018 22:00:58 PM"
OSConfig ID: "21" Collected on: "Jul 26, 2018 22:00:47 PM"
OSConfig ID: "20" Collected on: "Jul 25, 2018 22:00:29 PM"
rhpctl query peerserver
Syntax
rhpctl query peerserver [-server server_cluster_name [-serverPolicy]]
Parameters
Table F-42 rhpctl query peerserver Command Parameters
Parameter | Description |
---|---|
-server server_cluster_name |
Optionally, you can specify the name of the Fleet Patching and Provisioning Server cluster for which you want to view the information. |
-serverPolicy |
Optionally, you can specify the image policy for the peer Fleet Patching and Provisioning Server for which you want to view the information. |
rhpctl add role
See Also:
Syntax
rhpctl add role –role role_name -hasRoles roles
Parameters
Table F-43 rhpctl add role Command Parameters
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.
|
Usage Notes
-
You can only run this command on the Fleet Patching and Provisioning Server.
-
You must be assigned the GH_ROLE_ADMIN role to run this command.
Example
$ rhpctl add role -role hr_admin -hasRoles GH_WC_USER,GH_IMG_USER
rhpctl delete role
Deletes a role from the list of existing roles on the Fleet Patching and 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 Fleet Patching and Provisioning Server
Example
To delete a role from the Fleet Patching and Provisioning Server:
$ rhpctl delete role -role hr_admin
rhpctl grant 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-44 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 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. |
[ |
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 |
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
rhpctl query 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 Fleet Patching and Provisioning Server
Example
$ 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
rhpctl revoke role
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-45 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 |
-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 ( |
rhpctl add series
Syntax
rhpctl add series -series series_name [-image image_name]
Parameters
Table F-46 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
$ rhpctl add series –series DB12_series
rhpctl delete series
Deletes a series from the Fleet Patching and 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
rhpctl deleteimage series
Syntax
rhpctl deleteimage series -series series_name -image image_name
Parameters
Table F-47 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
$ rhpctl deleteimage series -series PRODDBSERIES -image PRODIMAGEV0
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-48 rhpctl insertimage series Command Parameters
Parameter | Description |
---|---|
|
Specify the name of the series into which you want to insert an image. |
|
Specify the name of the image that you want to insert into a series. |
|
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
rhpctl query series
Syntax
rhpctl query series [-series series_name | -image image_name]
Parameters
Table F-49 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
$ rhpctl query series
Image series: DB12_series
Image series: GRID_series
Image series: DB112_series
rhpctl subscribe series
Syntax
rhpctl subscribe series -series series_name [-user user_name [-client cluster_name]]
Parameters
Table F-50 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. |
rhpctl unsubscribe series
Syntax
rhpctl unsubscribe series -series series_name [-user user_name [-client cluster_name]]
Parameters
Table F-51 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. |
rhpctl export server
Syntax
rhpctl export server -server peer_server_name -serverdata file_path
Usage Notes
-
Specify the name of a peer server cluster.
-
Specify the path to the file containing the Fleet Patching and Provisioning Server data.
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
Fleet Patching and Provisioning Server (RHPS): rhps-myserver
Storage base path: /u01/app/RHPImages
Disk Groups: RHPDATA
Port number: 8896
rhpctl register server
Syntax
rhpctl register server -server server_cluster_name -serverdata file
{-root | -cred cred_name | -sudouser sudo_username -sudopath path_to_sudo_binary
| -auth plugin_name [-arg1 name1:value1 [-arg2 name2:value2 ...]]}
Parameters
Table F-52 rhpctl register server Command Parameters
Parameter | Description |
---|---|
-server server_cluster_name |
Specify the name of the Fleet Patching and Provisioning Server cluster that you want to register. |
-serverdata file |
Specify the path to the file containing the Fleet Patching and Provisioning Server data. |
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
Choose |
rhpctl unregister server
Syntax
rhpctl unregister server -server server_cluster_name
Usage Notes
Specify the name of the Fleet Patching and Provisioning Server you want to unregister as a peer.
rhpctl delete user
Syntax
rhpctl delete user -user user_name [-client cluster_name]
Parameters
Table F-53 rhpctl delete user Command Parameters
Parameter | Description |
---|---|
-user user_name |
Specify the name of the user you want to delete from a Fleet Patching and 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
scott
on the server cluster from the Fleet Patching and Provisioning repository:$ rhpctl delete user -user scott
rhpctl modify user
Syntax
rhpctl modify user -user user_name -email email_address [-client client_name]
Parameters
Table F-54 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. |
rhpctl register user
Syntax
rhpctl register user -user user_name -email email_address [-client client_name]
Parameters
Table F-55 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 Fleet Patching and 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 Fleet Patching and 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
rhpctl unregister user
Syntax
rhpctl unregister user -user user_name [-client client_name]
Parameters
Table F-56 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. |
rhpctl add useraction
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-57 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 |
-optype option |
Optionally, you can specify the operation for which the user action is configured. Options include:
|
-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 |
rhpctl delete useraction
Syntax
rhpctl delete useraction -useraction user_action_name
Usage Notes
Specify the name of a user action you want to delete.
rhpctl modify useraction
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-58 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 |
-optype option |
Optionally, you can specify the operation for which the user action is configured. Options include:
|
-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. Optionally, you can specify the nodes where the user action is run. Choose |
rhpctl query useraction
Syntax
rhpctl query useraction [-useraction user_action_name | -imagetype image_type]
[-optype option]
Parameters
Table F-59 rhpctl query useraction Command Parameters
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:
|
rhpctl add workingcopy
Creates a working copy on a client cluster.
Syntax
To add a working copy to a client cluster:
rhpctl add workingcopy -workingcopy workingcopy_name
{-image image_name | -series series_name}
[-oraclebase oraclebase_path] [-path where_path]
[-storagetype {LOCAL | RHP_MANAGED}] [-user user_name]
[-client cluster_name] [-ignoreprereq | -fixup]
[-responsefile response_file_path] [-clusternodes node_list]
[-groups group_list] [-root | -cred cred_name | -sudouser sudo_username
-sudopath path_to_sudo_binary | -auth plugin_name [-arg1 name1:value1
[-arg2 name2:value2 ...]]]
[-notify [-cc users_list]] [-asmclientdata data_path]
[-gnsclientdata data_path] [-clustermanifest data_path] [-softwareonly]
[-local] [-inventory inventory_path] [-targetnode target_node_name]
[-agpath read_write_path -aupath gold_image_path] [-setupssh]
[-useractiondata user_action_data] [-eval] [-schedule timer_value]
[-checkwcpatches -sourcehome source_home_path] [-scan scan_name]
[-diskDiscoveryString disk_discovery_string] [-dbnodes db_node_list]
[-cells cell_list] [-ibswitches ibswitch_list] [-fromnode node_name]
[-unkey] [-smtpfrom "address"] [-smtpto "addresses"] [-precheckonly]
[-modifyatprereq] [-resetforce] [-force] [-help options]
Parameters
Table F-60 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 | -series series_name} |
Specify the name of a configured image from which to create a working copy or the name of an image series from which RHPCTL takes the latest image when adding a working copy. |
-oraclebase oracle_base_path |
Specify an Note: This parameter is required only for the |
-inventory inventory_path |
Specify the location of the Oracle Inventory directory. |
-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 Note: This parameter is required for |
-storagetype {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 |
-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 cluster node information on which to provision Oracle Clusterware. |
-groups "OSDBA|OSOPER|OSASM|OSBACKUP|OSDG|OSKM|OSRAC=group_name[,...]" |
Specify a comma-delimited list of Oracle groups, enclosed in double quotation marks ( For example:
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 If you use the
Notes:
|
-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_location | -auth plugin_name plugin_args |
If you choose to use the Choose |
-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 Fleet Patching and Provisioning Server is on a domain services cluster and you are creating a member cluster. |
-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 |
Use this parameter to provision only Oracle Grid Infrastructure software. |
-targetnode target_node_name |
Specify the name of a node in a remote cluster with no Fleet Patching and Provisioning Client on which you want to provision a working copy. |
-agpath read_write_path -aupath gold_image_path |
Use |
-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 |
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
-checkwcpatches -sourcehome source_home_path |
Optionally, you can use the |
-scan scan_name |
Optionally, you can use this parameter to specify a SCAN name. |
-diskDiscoveryString disk_discovery_string |
Optionally, you can use this parameter to specify a disk discovery string. |
-dbnodes db_node_list |
Optionally, you can use this parameter to specify a file containing the list of database servers that you want to patch, one node name in each line. |
-cells cell_list |
Optionally, you can use this parameter to specify a file containing a list of storage servers that you want to patch, one node name in each line. |
-ibswitches ibswitch_list |
Optionally, you can use this parameter to specify a file containing a list of InfiniBand switches that you want to patch, one node name in each line. |
-fromnode node_name |
Optionally, you can specify a database server node name from where the patch manager is to be run. |
–unkey |
Optionally, you can use this parameter to remove passwordless SSH access to the Oracle Exadata patch nodes from the database server node from where the patch manager is run before exit. |
-smtpfrom "address" |
Optionally, you can specify an email address enclosed in double quotation marks ( |
-smtpto "addresses" |
Optionally, you can specify several email address enclosed in double quotation marks ( |
-precheckonly |
Optionally, you can use this parameter to run only the patching precheck operations. |
-modifyatprereq |
Optionally, you can use this parameter to run the |
-resetforce |
Optionally, you can use this parameter to run the |
-force |
Optionally, you can use this parameter to run the |
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 | GRIDHOMEPROV | SWONLYGRIDHOMEPROV | STANDALONEPROVISIONING | GGHOMEPROVISIONING]
-
If you choose to use the
-schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
Examples
-
To create a working copy on a client cluster for yourself or another user:
rhpctl add workingcopy -workingcopy workingcopy_name {-image image_name | -series series_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 | -series series_name} -oraclebase oracle_base_path -storagetype {LOCAL | RHP_MANAGED} [-path absolute_path]
-
To create and configure a working copy of Oracle Grid Infrastructure:
rhpctl add workingcopy -workingcopy workingcopy_name {-image image_name | -series series_name} {-root | -cred cred_name | -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 | -series series_name} -softwareonly -path Grid_home_path -oraclebase oracle_base_path [-local | -client cluster_name [-groups "Oracle_group=user_group[,...]"] [-node client_node_name] | {-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_path} -targetnode node_name]
-
To provision a working copy on a node or a cluster where Fleet Patching and Provisioning does not exist:
rhpctl add workingcopy -workingcopy workingcopy_name {-image image_name | -series series_name} -oraclebase oracle_base_path -user user_name -node node_name [-path absolute_path] {-root | -cred cred_name | -sudouser sudo_user_name -sudopath sudo_binary_path}
Note:
If you are provisioning Oracle database software to a Fleet Patching and Provisioning Client that has been configured with an Oracle ASM disk group, then do not specify the -path
parameter, so as to enable the Fleet Patching and Provisioning Client to use storage provided by Fleet Patching and Provisioning.
If the Fleet Patching and Provisioning Client is not configured with an Oracle ASM disk group, then specify the -storagetype
parameter with LOCAL
, in addition to specifying the -path
parameter.
rhpctl addnode workingcopy
Syntax
rhpctl addnode workingcopy -workingcopy workingcopy_name -node node_list
[-targetnode node_name {-root | -sudouser sudo_username -sudopath sudo_binary_path
| -cred cred_name | -auth plugin_name [-arg1 name1:value1...]} -setupssh]
[-ignoreprereq] [-useractiondata user_action_data] [-eval]
Parameters
Table F-61 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 | -cred cred_name | -auth plugin_name [-arg1 name1:value1...] |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-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 |
–eval |
Optionally, you can use this parameter to evaluate the impact of this command on the system without actually running the command. |
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.
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 -cred cred_name | -auth plugin_name [-arg1 name1:value1...]}
[-useractiondata user_action_data] [-schedule timer_value]
Parameters
Table F-62 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 Fleet Patching and 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_username -sudopath sudo_binary_path | -cred cred_name |
If you choose to use the If you choose Optionally, you can choose to specify a credential name to associate the user and password credentials to access a remote node. Alternative to |
-useractiondata user_action_data |
Optionally, you can pass a value to the |
-schedule timer_value |
Optionally, you can use this parameter to schedule a time to run this operation, in ISO-8601 format, as in the following example:
|
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
. -
If you choose to use the
-schedule
parameter, then you must run this command on the Fleet Patching and Provisioning Server.
Examples
To delete a working copy:
$ rhpctl delete workingcopy -workingcopy wc1
rhpctl query workingcopy
Displays the configuration information of an existing working copy.
Syntax
rhpctl query workingcopy [-workingcopy workingcopy_name [-metadataonly] | [-image image_name] [-client cluster_name]]
Parameters
Table F-63 rhpctl query workingcopy Command Parameters
Parameter | Description |
---|---|
|
Specify the name of a working copy for which you want to display the configuration information. |
|
Use this paramter only when you use the |
|
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. |
rhpctl update workingcopy
Syntax
Note:
You can only use this command with Oracle Exadata.rhpctl update workingcopy -image image_name -root {[-dbnodes db_node_list]
[-cells cell_list] [-ibswitches ibswitch_list]}
[-fromnode node_name] [-unkey] [-smtpfrom "address"] [-smtpto "addresses"]
[-precheckonly] [-modifyatprereq] [-resetforce] [-force]
Parameters
Table F-64 rhpctl update workingcopy Command Parameters
Parameter | Description |
---|---|
-image image_name |
Specify the name of a configured image from which to update a working copy |
-dbnodes db_node_list |
You can use this parameter to specify a file containing the list of database servers that you want to patch, one node name in each line. |
-cells cell_list |
Optionally, you can use this parameter to specify a file containing a list of storage cells that you want to patch, one cell name in each line. |
-ibswitches ibswitch_list |
Optionally, you can use this parameter to specify a file containing a list of InfiniBand switches that you want to patch, one switch name in each line. |
-fromnode node_name |
Optionally, you can specify a database server node name from where the patch manager is to be run. |
–unkey |
Optionally, you can use this parameter to remove passwordless SSH access to the Oracle Exadata patch nodes from the database server node from where the patch manager is run before exit. |
-smtpfrom "address" |
Optionally, you can specify an email address enclosed in double quotation marks ( |
-smtpto "addresses" |
Optionally, you can specify several email address enclosed in double quotation marks ( |
-precheckonly |
Optionally, you can use this parameter to run only the patching precheck operations. |
-modifyatprereq |
Optionally, you can use this parameter to run the |
-resetforce |
Optionally, you can use this parameter to run the |
-force |
Optionally, you can use this parameter to run the |
Examples
(Optional) List and briefly describe the examples for executing the command here.