useraction Commands

Use commands with the useraction keyword to add, delete, and modify user actions.

rhpctl add useraction

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

Syntax

rhpctl add useraction -useraction user_action_name -actionscript script_name
  [-actionfile file_name] [-pre | -post | -eval] [-optype option] [-phase operation_phase]
  [-onerror {ABORT | CONTINUE}] [-runscope {ONENODE | ALLNODES | AUTO | FIRSTNODEONRHPS | LASTNODEONRHPS | ALLNODESONRHPS}]
  [-runasroot] [-runninginstance]

Parameters

Table: 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 \| -eval`	Use `-pre` to run the user action before the operation, use `-post` to run the user action after the operation, or use `-eval` to run the user action during evaluation.
`-optype` `option`	Optionally, you can specify the operation for which the user action is configured. Options include: IMPORT_IMAGE ADD_WORKINGCOPY DELETE_WORKINGCOPY ADD_DATABASE DELETE_DATABASE MOVE_DATABASE ADD_PDB_DATABASE DELETE_PDB_DATABASE MOVE_GIHOME UPGRADE_DATABASE UPGRADE_GIHOME ADDNODE_GIHOME DELETENODE_GIHOME ADDNODE_DATABASE DELETENODE_DATABASE ADDNODE_WORKINGCOPY ZDTUPGRADE_DATABASE ZDTUPGRADE_DATABASE_SNAPDB ZDTUPGRADE_DATABASE_DBUA ZDTUPGRADE_DATABASE_SWITCHBACK MIGRATE_DATABASE UPDATE_EXADATA
`-phase`	Specify the phase of the operation for which the user action is configured.
`-onerror {ABORT \| CONTINUE}`	Optionally, you can choose whether to stop or continue the operation if the user action encounters an error while it is running.
`-runscope {ONENODE \| ALLNODES \| AUTO \| FIRSTNODEONRHPS \| LASTNODEONRHPS \| ALLNODESONRHPS}`	Optionally, you can specify the nodes where the user action is run. Choose `ONENODE` to run the user action for each database on the node on which a patch was applied to the database. Choose `ALLNODES` to run the user action for each database on every cluster node. Choose `AUTO` for a run scope based on the other command options. Specify `FIRSTNODEONRHPS`, `LASTNODEONRHPS`, or `ALLNODESONRHPS` to run the user action script on FPPS when the operation is performed on first node or last node or all nodes.
`-runasroot`	Run the `rhpctl add useraction` command as `root` user.
`-runninginstance`	Specify this parameter to run the user action only on the nodes that have a running database instance. You can use this parameter only with the `MOVE_DATABASE`, `MOVE_GIHOME`, and `UPGRADE_DATABASE` operation types.

rhpctl delete useraction

Deletes an existing user action configuration.

Syntax

rhpctl delete useraction -useraction user_action_name

Usage Notes

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

rhpctl modify useraction

Modifies the configuration of the specified user action name.

Syntax

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

Parameters

Table: 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 \| -eval`	Use `-pre` to run the user action before the operation, use `-post` to run the user action after the operation, or use `-eval` to run the user action during evaluation.
`-optype` `option`	Optionally, you can specify the operation for which the user action is configured. Options include: IMPORT_IMAGE ADD_WORKINGCOPY DELETE_WORKINGCOPY ADD_DATABASE DELETE_DATABASE MOVE_DATABASE ADD_PDB_DATABASE DELETE_PDB_DATABASE MOVE_GIHOME UPGRADE_DATABASE UPGRADE_GIHOME ADDNODE_GIHOME DELETENODE_GIHOME ADDNODE_DATABASE DELETENODE_DATABASE ADDNODE_WORKINGCOPY ZDTUPGRADE_DATABASE ZDTUPGRADE_DATABASE_SNAPDB ZDTUPGRADE_DATABASE_DBUA ZDTUPGRADE_DATABASE_SWITCHBACK MIGRATE_DATABASE UPDATE_EXADATA
`-onerror {ABORT \| CONTINUE}`	Optionally, you can choose whether to stop or continue the operation if the user action encounters an error while it is running.
`-runscope {ONENODE \| ALLNODES \| AUTO \| FIRSTNODEONRHPS \| LASTNODEONRHPS \| ALLNODESONRHPS}`	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 `ONENODE` to run the user action for each database on the node on which a patch was applied to the database. Choose `ALLNODES` to run the user action for each database on every cluster node. Choose `AUTO` for a run scope based on the other command options. Specify `FIRSTNODEONRHPS`, `LASTNODEONRHPS`, or `ALLNODESONRHPS` to run the user action script on FPPS when the operation is performed on first node or last node or all nodes.
`-runninginstance`	Specify this parameter to run the user action only on the nodes that have a running database instance. You can use this parameter only with the `MOVE_DATABASE`, `MOVE_GIHOME`, and `UPGRADE_DATABASE` operation types.

rhpctl query useraction

Displays the configuration of a user action.

Syntax

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

Parameters

Table: 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 Specify the software type. Use ORACLEDBSOFTWARE (default) for Oracle AI Database software, ORACLEGISOFTWARE for Oracle Grid Infrastructure software, ORACLEGGSOFTWARE for Oracle GoldenGate software, ODAPATCHSOFTWARE for engineered systems (Oracle Data Appliance), EXAPATCHSOFTWARE for Oracle Exadata software, or SOFTWARE for all other software. For a custom image type, use the image type name.

Parameter	Description
`-useraction` `user_action_name`	Specify the name of the user action you want to query.
`-imagetype` `image_type`	Specify the software type. Use `ORACLEDBSOFTWARE` (default) for Oracle AI Database software, `ORACLEGISOFTWARE` for Oracle Grid Infrastructure software, `ORACLEGGSOFTWARE` for Oracle GoldenGate software, `ODAPATCHSOFTWARE` for engineered systems (Oracle Data Appliance), `EXAPATCHSOFTWARE` for Oracle Exadata software, or `SOFTWARE` for all other software. For a custom image type, use the image type name.
`-optype` `option`	Optionally, you can specify the operation for which to run the query. Options include: IMPORT_IMAGE ADD_WORKINGCOPY DELETE_WORKINGCOPY ADD_DATABASE DELETE_DATABASE MOVE_DATABASE ADD_PDB_DATABASE DELETE_PDB_DATABASE MOVE_GIHOME UPGRADE_DATABASE UPGRADE_GIHOME ADDNODE_GIHOME DELETENODE_GIHOME ADDNODE_DATABASE DELETENODE_DATABASE ADDNODE_WORKINGCOPY ZDTUPGRADE_DATABASE ZDTUPGRADE_DATABASE_SNAPDB ZDTUPGRADE_DATABASE_DBUA ZDTUPGRADE_DATABASE_SWITCHBACK MIGRATE_DATABASE UPDATE_EXADATA

-optype option

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

IMPORT_IMAGE
ADD_WORKINGCOPY
DELETE_WORKINGCOPY
ADD_DATABASE
DELETE_DATABASE
MOVE_DATABASE
ADD_PDB_DATABASE
DELETE_PDB_DATABASE
MOVE_GIHOME
UPGRADE_DATABASE
UPGRADE_GIHOME
ADDNODE_GIHOME
DELETENODE_GIHOME
ADDNODE_DATABASE
DELETENODE_DATABASE
ADDNODE_WORKINGCOPY
ZDTUPGRADE_DATABASE
ZDTUPGRADE_DATABASE_SNAPDB
ZDTUPGRADE_DATABASE_DBUA
ZDTUPGRADE_DATABASE_SWITCHBACK
MIGRATE_DATABASE
UPDATE_EXADATA