RHPCTL Command Reference

RHPCTL Overview

RHPCTL is the command-line utility for administering Oracle Fleet Patching and Provisioning Servers, Clients, images, roles, sites, image series, and working copies. Commands follow the rhpctl command object [parameters] structure, where verbs specify actions, objects identify managed resources, and keyword-value parameters refine execution.

Using RHPCTL Help

RHPCTL provides context-sensitive help for discovering command usage, syntax, and parameters. Use rhpctl -help to list all commands, or rhpctl command object -help to display detailed information for a specific command and object.

archive Commands

The archive commands manage the lifecycle of Oracle Fleet Patching and Provisioning gold images: rhpctl archive image -image image_name archives an image that has no associated working copy, while rhpctl unarchive image -image image_name restores an archived image for use.

audit Commands

Audit commands manage Fleet Patching and Provisioning audit records. Administrators can delete all records or those up to a specified date, change the maximum number of stored records, and query records using filters such as operation, entity, user, client, date range, record position, record ID, or configuration details.

backup and restore Commands

Backup and restore commands protect and recover the Oracle Fleet Patching and Provisioning Server. rhpctl backup server -path backup_path creates a full server backup in a writable directory, while rhpctl restore server -backup backup_location restores or relocates a server from the specified backup.

client Commands

Client commands add, authorize, disable, discover, export, modify, query, update, verify, and delete Fleet Patching and Provisioning Clients. They support remote-node authentication, role mappings, response-file generation and validation for Oracle Clusterware deployment, client data export, enablement and credential changes, image updates, detailed configuration queries, and controlled removal; most administrative operations run from the Fleet Patching and Provisioning Server, and clients require Oracle Grid Infrastructure 12.2 or later.

credentials Commands

Credential commands add or remove remote-access credentials in the Oracle Cluster Registry. rhpctl add credentials stores either root or sudo-based access under a credential name for reuse by other commands, while rhpctl delete credentials removes the specified credential.

database Commands

Database commands provision, modify, move, upgrade, query, and remove Oracle databases and pluggable databases associated with Fleet Patching and Provisioning working copies. They support RAC, RAC One Node, single-instance, multitenant CDB/PDB operations, administrator-managed RAC node changes, rolling and nonrolling database moves, scheduling, evaluation, authentication methods, patch and datapatch controls, service draining, recovery actions, and zero-downtime upgrades; the deprecated ZDU command uses GoldenGate and cloned storage to upgrade RAC and RAC One Node databases with minimal interruption.

datapatch Commands

The datapatch command applies SQL patches to databases associated with a specified working copy. It can target selected databases or exclude named databases, operate on remote targets with root, sudo, credential, or plugin authentication, evaluate planned node batches without execution, and run immediately or through scheduled jobs.

exadata Commands

The Exadata command patches Oracle Exadata database nodes, storage cells, InfiniBand switches, or RoCE switches. It supports images, patch manager and ISO repositories, backups, rollbacks, downgrades, live-update scopes, node batching with continuation or abort controls, email notifications, scheduled execution, remote clients or servers, and evaluation mode; its documented primary use is database-node patching.

gihome Commands

These commands manage Oracle Grid Infrastructure homes and nodes: rhpctl addnode gihome provisions Grid Infrastructure on new nodes, deletenode gihome removes it, move gihome relocates or transparently upgrades the Grid home with rolling, batching, patching, database, scheduling, and recovery controls, and upgrade gihome upgrades from a working copy or unmanaged home to a destination working copy with evaluation, batching, rollback, and authentication options.

home Commands

The home command family supports Oracle FPP Local Mode home deployment through rhpctl deploy home, which provisions Grid Infrastructure or Oracle AI Database software from a gold-image ZIP to a specified target path, optionally using a source home and bypassing prerequisite checks.

image Commands

These commands manage FPP gold images throughout their lifecycle: images can be created from working copies, imported, registered, deployed, copied from peer servers, promoted between states, modified, queried, deleted or archived, and granted or revoked for users and roles; Local Mode also supports downloading patched images recommended by Oracle Update Advisor and stopping replication from peer servers.

imagetype Commands

These commands administer image types and their associated user actions. Administrators can create custom types from supported base types, modify or delete custom definitions, grant or revoke access for users and roles, and query image-type configuration locally or across matching FPP servers; built-in image types cannot be deleted.

job Commands

The job commands control scheduled FPP operations. rhpctl delete job removes one scheduled job or all jobs, optionally forcibly, while rhpctl query job reports job details, status, execution information, evaluation or migration jobs, and results filtered by identifier, client, user, or time; both commands run on the FPP Server.

osconfig Commands

These commands manage operating-system configuration backups for client clusters: configurations can be collected, compared by backup identifiers, enabled with schedules, frequencies, retention counts, and immediate collection, disabled with optional cleanup, and queried for historical collection details and storage information.

patch Commands

The patch commands evaluate, apply, roll back, and monitor one-off or advisor-driven patches. Working copies can be patched in place from images or staged patch locations, including online database patches and optional datapatch execution; rollback supports selected patch IDs, while evaluation reports health and recommendations and can generate patched images in Local Mode, and query operations track Oracle Update Advisor requests.

peerserver Commands

The rhpctl query peerserver command displays information about a registered peer Fleet Patching and Provisioning Server and can optionally show that server’s image policy.

updateadvisor Commands

The rhpctl manage updateadvisor command registers one SSO user per FPP Server for Oracle Update Advisor access, with optional proxy and endpoint settings, or unregisters the currently registered user.

role Commands

Role commands administer FPP authorization: roles can be created with included permissions, deleted when not built in, granted to users, client users, or other roles, queried for associated roles and users, and revoked through direct assignments or role-to-user mappings; administration is performed on the FPP Server by appropriately privileged users.

series Commands

These commands manage ordered image series. Administrators can create and delete series, insert or remove images, query series locally or across peer servers, and subscribe or unsubscribe users, optionally associated with client clusters; deleting a series does not delete its images, while forced deletion can remove a series that still contains images.

server Commands

Server commands manage FPP Server relationships and repository data: configuration can be queried, repository information exported for a peer, a peer FPP Server registered using a data file and remote authentication, and an existing peer unregistered, optionally with force.

tag Commands

Tag commands provide metadata management for FPP entities. Tags can be created, queried, modified, deleted with optional force, and assigned or removed from database or site targets using comma-separated tag lists and target identifiers.

user Commands

User commands manage FPP user email registration and repository membership. Administrators can register, modify, or unregister RFC 822 email addresses for users locally or on client clusters, and delete users subject to ownership constraints; owned working copies prevent deletion, while image and series ownership is reassigned to the internal user when applicable.

useraction Commands

The useraction commands manage custom actions associated with Fleet Patching and Provisioning operations. Use rhpctl add useraction to define an action script, optional action file, execution timing, operation type, phase, error behavior, node scope, and execution context; use delete to remove a configuration, modify to update it, and query to display configured actions by name, image type, or operation type. User actions may run before, after, or during evaluation, and some options, such as -runninginstance, are restricted to specific operation types.

workingcopy Commands

The workingcopy commands create and manage software or database working copies across client clusters and target nodes. add workingcopy provisions a copy from an image or series with options for storage, Oracle homes, databases, Grid Infrastructure, cluster nodes, authentication, scheduling, notifications, patch comparison, and read-only deployment; addnode extends a RAC database to additional nodes; delete removes a working copy or only its metadata, subject to active database restrictions; query displays configuration, drift, image, client, or metadata details; and register records an existing working copy in the FPP repository. Commands support evaluation, scheduling, user-action data, remote access, software-only provisioning, and site-specific configuration.
Read More: workingcopy Commands