1. Oracle Fleet Patching and Provisioning Administrator's Guide
  2. RHPCTL Command Reference
  3. RHPCTL Command Reference

RHPCTL Command Reference

This section describes RHPCTL command usage information, and lists and describes RHPCTL commands.

Note:

A multitenant container database is the only supported architecture in Oracle Database 21c and later releases. While the documentation is being revised, legacy terminology may persist. In most cases, "database" and "non-CDB" refer to a CDB or PDB, depending on context. In some contexts, such as upgrades, "non-CDB" refers to a non-CDB from a previous release.

  • archive Commands
    Use commands with the archive keyword to archive gold images and unarchive keyword to unarchive gold images.
  • audit Commands
    Use commands with the audit keyword to delete, modify, and query audit records.
  • backup and restore Commands
    Use commands with the backup and restore keywords to backup Oracle FPP Server and restore from the backup.
  • client Commands
    Use commands with the client keyword to add, delete, and manage Oracle Fleet Patching and Provisioning clients.
  • credentials Commands
    Use commands with the credentials keyword to add credentials to and delete credentials from the Oracle Cluster Registry (OCR).
  • database Commands
    Use commands with the database keyword to add, delete, move, and upgrade databases.
  • datapatch Commands
    Use commands with the datapatch keyword to apply patches to the specified Oracle Database.
  • exadata Commands
    Use commands with the exadata keyword to patch an Oracle Exadata system.
  • gihome Commands
    Use commands with the gihome keyword to add or delete nodes to Oracle Grid Infrastructure home and, move and upgrade Oracle Grid Infrastructure home.
  • image Commands
    Use commands with the image keyword to add, delete, import, and manage gold images.
  • image Commands
    Use commands with the image keyword to add, delete, import, and manage gold images.
  • imagetype Commands
    Use commands with the imagetype keyword to add, delete, modify, and manage an image type.
  • job Commands
    Use commands with the job keyword to delete or query schedule jobs.
  • osconfig Commands
    Use commands with the osconfig keyword to backup, compare, and manage operating system configuration information.
  • patch Commands
    Use commands with the patch keyword to apply or rollback one-off patches to the specified working copy using the in-place patching method.
  • peerserver Commands
    Use commands with the peerserver keyword to display information for a peer server.
  • role Commands
    Use commands with the role keyword to add, delete, and manage roles.
  • series Commands
    Use commands with the series keyword to add, delete, subscribe, and manage a series.
  • server Commands
    Use commands with the server keyword to export, register, unregister, and query Oracle Fleet Patching and Provisioning Server.
  • tag Commands
    Use commands with the tag keyword to add, query, modify, delete, set, and unset tags.
  • user Commands
    Use commands with the user keyword to delete, modify, register, and unregister users.
  • useraction Commands
    Use commands with the useraction keyword to add, delete, and modify user actions.
  • workingcopy Commands
    Use commands with the workingcopy keyword to create, update, extend, and delete working copies.

Parent topic: RHPCTL Command Reference

job Commands

Use commands with the job keyword to delete or query schedule jobs.

Parent topic: RHPCTL Command Reference

rhpctl delete job

Deletes a specific scheduled job from the repository.

Syntax

rhpctl delete job [-jobid job_id] [-force]

Parameters

Table A-1 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

Parent topic: job Commands

rhpctl query job

Queries the current status of a scheduled job with a specific job ID.

Syntax

rhpctl query job [-jobid job_id] [-status {FAILED | SUCCEEDED | SCHEDULED 
   | EXECUTING | UNKNOWN | TERMINATED }] [-client client_name] [-user user_name]
  [-since timer_value] [-summary] [-eval] [-migrate]

Parameters

Table A-2 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. The job Id is obtained while scheduling the job.

If you choose this parameter, then the only other option you can specify is -summary. If you do not choose this parameter, then all jobs are queried.

-status {EXECUTED | TIMER_RUNNING | EXECUTING | UNKNOWN | TERMINATED }
Optionally, you can specify any of the following states of a job that you want to query:

  • EXECUTED: The job is complete.

  • TIMER_RUNNING: The timer for the job is still running.

  • EXECUTING: The timer for the job has expired and is running.

  • UNKNOWN: There is an unexpected failure due to issues such as a server going down, nodes going down, or any resource failures.

  • TERMINATED: There is an abrupt failure or the operation has stopped.

-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:
2018-07-25T19:13:17+05
-summary

Optionally, you can use this parameter to return only job details.
-eval

Optionally, you can use this parameter to query only evaluation jobs.
-migrate

Optionally, you can use this parameter to query only migration jobs.

Usage Notes

You must run this command on the Fleet Patching and Provisioning Server.

Example

To query a specified scheduled job:
$ rhpctl query job –jobid 1
This command returns output similar to the following:
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.example.com: Audit ID: 4
slc05amw.example.com: Creating a new ACFS file system for image "DB-Image1" ...
slc05amw.example.com: Copying files...
slc05amw.example.com: Copying home contents...
slc05amw.example.com: Changing the home ownership to user fred...
slc05amw.example.com: Changing the home ownership to user fred...

Parent topic: job Commands

rhpctl delete job

Deletes a specific scheduled job from the repository.

Syntax

rhpctl delete job [-jobid job_id] [-force]

Parameters

Table A-3 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

Parent topic: job Commands