Zero Downtime Migration ZDMCLI Command Reference

D Zero Downtime Migration ZDMCLI Command Reference

The following topics describe the Zero Downtime Migration ZDMCLI command usage and options.

add imagetype
Configures a new image type of the specified name and its associated useractions.
add useraction
Configures a new user action of the specified name with its associated script and action file.
migrate database
Performs a migration of a database to the Oracle Cloud.
modify useraction
Modifies the configuration of the useraction with the specified name.
query job
Gets the current status of the scheduled job with the specified job ID.

add imagetype

Configures a new image type of the specified name and its associated useractions.

Syntax

zdmcli add imagetype -imagetype image_type -basetype 
 {SOFTWARE |
         ORACLEGISOFTWARE |
         ORACLEDBSOFTWARE |
         ORACLEGGSOFTWARE |
         LINUXOS |
         CUSTOM_PLUGIN} 
 [-useractions user_action_list]

Options

Table D-1 ZDMCLI add imagetype Options

Option	Description
-imagetype image_type	Name of the imagetype to be created
-basetype {SOFTWARE \| ORACLEGISOFTWARE \| ORACLEDBSOFTWARE \| ORACLEGGSOFTWARE \| LINUXOS \| CUSTOM_PLUGIN}	The base image type for which the image type is created
-useractions user_action_list	Comma-separated list of useraction names

Note:

The -basetype CUSTOM_PLUGIN value is not shown in the help output for this command, but it is a valid value.

Parent topic: Zero Downtime Migration ZDMCLI Command Reference

add useraction

Configures a new user action of the specified name with its associated script and action file.

Syntax

zdmcli add useraction -useraction user_action_name -actionscript script_name 
 [-actionfile file_name] 
 {-pre |
  -post} -optype 
 {IMPORT_IMAGE |
  ADD_WORKINGCOPY |
  DELETE_WORKINGCOPY |
  ADD_DATABASE |
  DELETE_DATABASE |
  ADD_PDB_DATABASE |
  DELETE_PDB_DATABASE |
  MOVE_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 } 
 [-phase <operation phase>]
 [-onerror
       {ABORT |
        CONTINUE}]
 [-runscope
       {ONENODE |
        ALLNODES |
        AUTO |
        FIRSTNODEONRHPS |
        LASTNODEONRHPS |
        ALLNODESONRHPS}]

Options

Table D-2 ZDMCLI add useraction Options

Option	Description
-useraction user_action_name	Name of the useraction
-actionscript script_name	Script file to be run
-actionfile file_name	File associated with and needed by the useraction
-pre	Runs the useraction before the operation
-post	Runs the useraction after the operation
-optype {IMPORT_IMAGE \| ADD_WORKINGCOPY \| DELETE_WORKINGCOPY \| ADD_DATABASE \| DELETE_DATABASE \| ADD_PDB_DATABASE \| DELETE_PDB_DATABASE \| MOVE_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}	Operation for which the useraction is configured
-phase phase of operation	Operation phase for which the useraction is configured
-onerror {ABORT \| CONTINUE}	The response if the useraction encounters an error during execution
-runscope {ONENODE \| ALLNODES \| AUTO \| FIRSTNODEONRHPS \| LASTNODEONRHPS \| ALLNODESONRHPS}	The servers on which the useraction is run. Specify AUTO to choose the run scope based on the other command options. Specify FIRSTNODEONRHPS, LASTNODEONRHPS, or ALLNODESONRHPS to run the useraction script on RHPS when the operation is performed on the first server, last server, or all servers.

Parent topic: Zero Downtime Migration ZDMCLI Command Reference

migrate database

Performs a migration of a database to the Oracle Cloud.

Syntax

zdmcli migrate database 
 {-sourcedb db_name |
  -sourcesid source_oracle_sid} -sourcenode node_name -targetnode node_name -targethome target_home -rsp zdm_template 
  [-eval] 
  [-imagetype] 
  [-tdekeystorepasswd] 
  [-tdemasterkey] 
  [-useractiondata user_action_data] -backupuser user_name 
  [{-srcroot |
         -srccred cred_name |
         -srcuser user_name |
             {-srcsudouser sudo_user_name -srcsudopath sudo_binary_path} |
             {-srcauth plugin_name  
             [-srcarg1 name1:value1 
             [-srcarg2 name2:value2...]]}}]
  {-tgtroot |
   -tgtcred cred_name |
   -tgtuser user_name |
       {-tgtsudouser sudo_user_name -tgtsudopath sudo_binary_path} |
       {-tgtauth plugin_name 
           [-tgtarg1 name1:value1 
           [-tgtarg2 name2:value2...]]}} 
  [-schedule 
       { timer_value |
         NOW }] 
  [-pauseafter phase] 
  [-listphases] 
  [-ignoremissingpatches patch_name
       [,patch_name...]] 
  [-ignore 
       {ALL|
        WARNING|
        PATCH_CHECK}]

Options

Table D-3 ZDMCLI migrate database Options

Option	Description
-sourcedb db_name	Name of the source database you want to migrate
-sourcenode node_name	Host on which the source database is running
-targetnode node_name	Target server to which the source database is migrated
-targethome target_home	Location of the target database ORACLE_HOME
-imagetype image_type	Name of the useraction imagetype
-useractiondata user_action_data	Value to be passed to useractiondata parameter of the useraction script
-rsp zdm_template	Zero Downtime Migration template
-sourcesid source_oracle_sid	ORACLE_SID of the source single instance database without Grid Infrastructure
-eval	Evaluate without executing the command
-backupuser user_name	Name of the user allowed to backup or restore the database
-srcroot	Directs Zero Downtime Migration to use root credentials to access the source database server
-srccred cred_name	Credential name with which to associate the username and password credentials to access the source database server
-srcuser user_name	Name of the privileged user performing operations on the source database server
-srcsudouser username	Perform super user operations as sudo user name on the source database server
-srcsudopath sudo_binary_path	Location of sudo binary on the source database server
-srcauth plug-in_name [plug-in_args]	Use an authentication plug-in to access the source database server
-tgtroot	Use root credentials to access the target database server
-tgtcred cred_name	Credential name with which to associate the username and password credentials to access the target database server
-tgtuser user_name	Name of the user performing operations on the target database server
-tgtsudouser username	Perform super user operations as sudo user name on the target database server
-tgtsudopath sudo_binary_path	Location of sudo binary on the target database server
-tgtauth plugin_name [plugin_args]	Use an authentication plug-in to access the target database server
-tdekeystorepasswd	TDE keystore password, required for password based keystore/wallet
-tdemasterkey	TDE master encryption key
-schedule timer_value	Scheduled time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05
-pauseafter phase	Pause the job after running the specified phase
-ignoremissingpatches	Proceed with the move/upgrade even though the specified patches, which are present in the source path or working copy, might be missing from the destination path or working copy
-ignore {ALL\|WARNING\|PATCH_CHECK}	Ignore all checks or specific type of checks
-listphases	List the phases for this operation

Parent topic: Zero Downtime Migration ZDMCLI Command Reference

modify useraction

Modifies the configuration of the useraction with the specified name.

Syntax

zdmcli modify useraction -useraction user_action_name 
 [-actionscript script_name] 
 [-actionfile file_name] 
 [-pre |
  -post] 
 [-optype
        {IMPORT_IMAGE |
         ADD_WORKINGCOPY |
         DELETE_WORKINGCOPY |
         ADD_DATABASE |
         DELETE_DATABASE |
         ADD_PDB_DATABASE |
         DELETE_PDB_DATABASE |
         MOVE_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 } ] 
 [-phase phase] 
 [-onerror 
      {ABORT |
       CONTINUE}] 
 [-runscope 
      {ONENODE |
       ALLNODES |
       AUTO |
       FIRSTNODEONRHPS |
       LASTNODEONRHPS |
       ALLNODESONRHPS]

Options

Table D-4 ZDMCLI modify useraction Options

Option	Description
-useraction user_action_name	Name of the useraction
-actionscript script_name	Script file to be run
-actionfile file_name	Accompanying file needed by the useraction
-pre	Runs the useraction before the operation
-post	Runs the useraction after the operation
-optype {IMPORT_IMAGE \| ADD_WORKINGCOPY \| DELETE_WORKINGCOPY \| ADD_DATABASE \| DELETE_DATABASE \| ADD_PDB_DATABASE \| DELETE_PDB_DATABASE \| MOVE_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}	Operation for which the useraction is configured
-onerror {ABORT \| CONTINUE}	The outcome if the useraction encounters an error during execution
-runscope {ONENODE \| ALLNODES \| AUTO \| FIRSTNODEONRHPS \| LASTNODEONRHPS \| ALLNODESONRHPS}	The servers where the useraction will be run. Specify AUTO to choose the run scope based on the other command options. Specify FIRSTNODEONRHPS, LASTNODEONRHPS or ALLNODESONRHPS to run the useraction script on RHPS when the operaton is performed on the first server, last server, or all servers.

Parent topic: Zero Downtime Migration ZDMCLI Command Reference

query job

Gets the current status of the scheduled job with the specified job ID.

Syntax

zdmcli query job
 [-jobid <job_id>] 
 [-status 
     {SCHEDULED |
      EXECUTING |
      UNKNOWN |
      TERMINATED |
      FAILED |
      SUCCEEDED |
      PAUSED |
      ABORTED}] 
 [-dbname <database_name>] 
 [-since <timer_value>] 
 [-upto <timer_value>] 
 [-brief]

Options

Table D-5 ZDMCLI query job Options

Option	Description
-jobid jobid	Unique integer job ID value for the scheduled job, which is obtained while scheduling the job
-status {SCHEDULED \| EXECUTING \| UNKNOWN \| TERMINATED \| FAILED \| SUCCEEDED \| PAUSED \| ABORTED}	Job status for which to get the jobs
-dbname unique_db_name	Name of the database (DB_UNIQUE_NAME)
-since timer_value	Date from which to get the jobs, in ISO-8601 format. For example: 2016-12-21T19:13:17+05
-upto timer_value	Upper limit time to which to get the jobs, in ISO-8601 format. For example: 2016-12-21T19:13:17+05
-brief	Job details summary only

Parent topic: Zero Downtime Migration ZDMCLI Command Reference