10 Oracle Data Guard Command Reference

Use the command reference to understand how you can use the Data Guard broker command-line interface (DGMGRL) to manage your broker configuration.

DGMGRL enables you to manage a Data Guard broker configuration and its various members directly from the command line, or from batch programs or scripts. You can use the Data Guard broker command-line interface as an alternative to Oracle Enterprise Manager Cloud Control (Cloud Control) for managing a Data Guard configuration.

• Starting the Data Guard Command-Line Interface
  To start the Data Guard command-line interface (DGMGRL), enter dgmgrl at the command-line prompt on a system where Oracle is installed.
• Oracle SQLcl
  Oracle SQLcl allows you to run SQL and PL/SQL statements in interactive or batch mode.
• @ (at sign) Command
  The @ command allows you to execute DGMGRL commands stored in script files.
• / (slash) Command
  Use the DGMGRL / (slash) command to repeat the last command entered at the command prompt.
• ADD CONFIGURATION
  The ADD CONFIGURATION command establishes a relationship between two Data Guard broker configurations by adding a broker configuration to the current configuration.
• ADD DATABASE
  The DGMGRL ADD DATABASE command adds a standby database to an existing broker configuration.
• ADD FAR_SYNC
  The ADD FAR_SYNC command adds an existing far sync instance to an Oracle Data Guard broker configuration.
• ADD PLUGGABLE DATABASE
  This command instantiates a target PDB in the target database. The target PDB is used to provide data protection for a source PDB in a source database.
• ADD RECOVERY_APPLIANCE
  The ADD RECOVERY_APPLIANCE command adds a Zero Data Loss Recovery Appliance (Recovery Appliance) to an existing broker configuration.
• CONNECT
  The DGMGRL CONNECT command connects you to a database or far sync instance that is a member of a Data Guard broker configuration.
• CONVERT DATABASE
  The CONVERT DATABASE command converts a physical standby database to a snapshot standby database, or reverts the snapshot standby database back to a physical standby database.
• CREATE CONFIGURATION
  The CREATE CONFIGURATION command creates a new broker configuration that includes the specified primary database.
• CREATE FAR_SYNC
  The CREATE FAR_SYNC command creates a new far sync instance and adds it to the broker configuration. To use this command, Oracle wallet-based authentication must be configured and you must connect with SYSDBA privilege. In addition, an auxiliary instance must be started on the host where a new far sync instance is created.
• DISABLE CONFIGURATION
  The DISABLE CONFIGURATION command disables broker management of a configuration so that the configuration and all of its databases are no longer managed by the broker.
• DISABLE DATABASE
  The DISABLE DATABASE command disables broker management of the named standby database.
• DISABLE FAR_SYNC
  The DISABLE FAR_SYNC command disables broker management of a far sync instance.
• DISABLE FAST_START FAILOVER
  The DISABLE FAST_START FAILOVER command prevents the observer from initiating a failover to the target standby database.
• DISABLE FAST_START FAILOVER CONDITION
  The DISABLE FAST_START FAILOVER CONDITION command allows you to remove conditions for which a fast-start failover should be performed.
• DISABLE RECOVERY_APPLIANCE
  The DISABLE RECOVERY_APPLIANCE command disables broker management of the named Zero Data Loss Recovery Appliance (Recovery Appliance).
• EDIT ALL MEMBERS RESET (Parameter)
  The EDIT ALL MEMBERS RESET resets the specified configurable parameter for all members in the configuration.
• EDIT ALL MEMBERS RESET (Property)
  The EDIT ALL MEMBERS RESET resets the specified configurable property for all members in the configuration.
• EDIT ALL MEMBERS SET (Parameter)
  The EDIT ALL MEMBERS SET command changes the value of the specified parameter for all members in the broker configuration. Optional ALTER SYSTEM SET command options can be included. These options must be specified in quotation marks.
• EDIT ALL MEMBERS SET (Property)
  The EDIT ALL MEMBERS SET sets the specified configurable property for all members in the configuration.
• EDIT CONFIGURATION (Property)
  The EDIT CONFIGURATION SET PROPERTY command changes the value of a property for the broker configuration.
• EDIT CONFIGURATION (Protection Mode)
  The EDIT CONFIGURATION SET PROTECTION MODE AS command edits the current protection mode setting for the broker configuration.
• EDIT CONFIGURATION (RENAME)
  The EDIT CONFIGURATION RENAME TO command changes a configuration’s name.
• EDIT CONFIGURATION PREPARE DGPDB
  The EDIT CONFIGURATION PREPARE DGPDB command prepares the environment for DG PDB.
• EDIT CONFIGURATION RESET (Property)
  The EDIT CONFIGURATION RESET PROPERTY command resets the specified configuration property to its default value.
• EDIT CONFIGURATION RESET TAG
  The EDIT CONFIGURATION RESET TAG command removes the tag and its value-pair.
• EDIT CONFIGURATION SET TAG
  The EDIT CONFIGURATION SET TAG command applies the value-pair tag to the configuration.
• EDIT DATABASE (Property)
  The EDIT DATABASE command changes the value of the specified configurable property for a database member.
• EDIT DATABASE (Parameter)
  The EDIT DATABASE (Parameter) command sets the specified initialization parameter for the named database.
• EDIT DATABASE (Rename)
  The EDIT DATABASE (Rename) command changes the name used by the broker to refer to the specified database.
• EDIT DATABASE (State)
  The EDIT DATABASE (State) command changes the state of the specified database.
• EDIT DATABASE RESET (Parameter)
  The EDIT DATABASE RESET (Parameter) command resets the specified database initialization parameter for the named database to its default value.
• EDIT DATABASE RESET (Property)
  The EDIT DATABASE RESET (Property) command reset the specified property for the named database back to its default value.
• EDIT DATABASE RESET TAG
  The EDIT DATABASE RESET TAG command removes the tag and its value-pair.
• EDIT DATABASE SET TAG
  The EDIT DATABASE SET TAG command applies the value-pair tag to the database.
• EDIT FAR_SYNC
  The EDIT FAR_SYNC command changes the name, properties, or initialization parameters of a far sync instance.
• EDIT FAR_SYNC RESET (Parameter)
  The EDIT FAR_SYNC RESET PARAMETER (Parameter) command resets the specified database initialization parameter for the named far sync instance to its default value.
• EDIT FAR_SYNC RESET (Property)
  The EDIT FAR_SYNC RESET (Property) command resets the specified property for the named far sync instance to its default value.
• EDIT FAR_SYNC RESET TAG
  The EDIT FAR_SYNC RESET TAG command removes the tag and its value-pair.
• EDIT FAR_SYNC SET TAG
  The EDIT FAR_SYNC SET TAG command applies the value-pair tag to the far-sync database.
• EDIT MEMBER RESET TAG
  The EDIT MEMBER RESET TAG command removes the tag and its value-pair.
• EDIT MEMBER SET TAG
  The EDIT MEMBER SET TAG command applies the value-pair tag to the member database.
• EDIT PLUGGABLE DATABASE (State)
  The EDIT PLUGGABLE DATABASE command changes the state of the specified pluggable database (PDB).
• EDIT RECOVERY_APPLIANCE (Property)
  The EDIT RECOVERY_APPLIANCE (Property) command changes the value of the property for the named Zero Data Loss Recovery Appliance (Recovery Appliance).
• EDIT RECOVERY_APPLIANCE (Rename)
  The EDIT RECOVERY_APPLIANCE (Rename) command changes the name used by the broker to refer to the specified Recovery Appliance, as recorded in that Recovery Appliance's profile in the broker configuration.
• EDIT RECOVERY_APPLIANCE RESET (Property)
  The EDIT RECOVERY_APPLIANCE RESET (Property) command resets the specified property for the named Recovery Appliance to its default value.
• ENABLE CONFIGURATION
  The ENABLE CONFIGURATION command enables the broker to manage the broker configuration, including all of its databases.
• ENABLE DATABASE
  The ENABLE DATABASE command enables broker management of the specified standby database.
• ENABLE FAR_SYNC
  The ENABLE FAR_SYNC command enables broker management of the specified far sync instance.
• ENABLE FAST_START FAILOVER
  The ENABLE FAST_START FAILOVER command enables the broker to fail over to a specifically-chosen standby database in the event of loss of the primary database, without requiring any manual steps.
• ENABLE FAST_START FAILOVER CONDITION
  The ENABLE FAST_START FAILOVER CONDITION command specifies additional conditions for which a fast-start failover should be performed.
• ENABLE RECOVERY_APPLIANCE
  The ENABLE RECOVERY_APPLIANCE command enables broker management of the specified Zero Data Loss Recovery Appliance (Recovery Appliance).
• EXIT
  The EXIT command exits (quits) the broker’s command-line interface.
• EXPORT CONFIGURATION
  The EXPORT CONFIGURATION command enables you to save the metadata contained in the broker configuration file to a text file. Use this command to maintain an up-to-date copy of the broker configuration metadata.
• FAILOVER
  The FAILOVER command invokes a failover that transitions the named (target) standby database into the role of a primary database.
• FAILOVER TO PLUGGABLE DATABASE
  The FAILOVER TO PLUGGABLE DATABASE command invokes a failover that transitions the named target PDB into the role of a source PDB.
• HELP
  The DISPLAY command displays online help for the Data Guard command-line interface.
• HOST or ! (exclamation point)
  The DGMGRL HOST and ! commands allow you to execute operating system command(s) directly through the DGMGRL console without leaving DGMGRL.
• IMPORT CONFIGURATION
  The IMPORT CONFIGURATION command enables you to import the broker configuration metadata that was previously exported to a file in the trace directory using the EXPORT CONFIGURATION command.
• MIGRATE PLUGGABLE DATABASE
  The MIGRATE PLUGGABLE DATABASE command lets you migrate a pluggable database (PDB) from one multitenant container database (CDB) to another on the same host. You can migrate a PDB from a primary CDB to another primary CDB or failover a PDB from a standby CDB to a primary CDB.
• PREPARE DATABASE FOR DATA GUARD
  The PREPARE DATABASE FOR DATA GUARD command configures a database for use as either a primary or standby database in a Data Guard broker configuration. Database initialization parameters are set to recommended values.
• QUIT
  The QUIT command quits (exits) the Data Guard command-line interface.
• REINSTATE DATABASE
  The REINSTATE DATABASE command reinstates a database as a new standby database in the broker configuration for the current primary database.
• REMOVE CONFIGURATION
  The REMOVE CONFIGURATION command removes the Oracle Data Guard broker configuration and ends broker management of all members in the configuration.
• REMOVE DATABASE
  The REMOVE DATABASE command removes the specified standby database from the broker configuration and terminates broker management of that standby database.
• REMOVE FAR_SYNC
  The REMOVE FAR SYNC command removes a far sync instance from an Oracle Data Guard broker configuration.
• REMOVE INSTANCE
  The REMOVE INSTANCE command removes the specified instance from the broker configuration.
• REMOVE PLUGGABLE DATABASE
  This command stops recovery at a target PDB and then drops the target PDB. Dropping the target PDB ends data protection for the source PDB in a DG PDB environment.
• REMOVE RECOVERY_APPLIANCE
  The REMOVE RECOVERY_APPLIANCE command removes the specified Zero Data Loss Recovery Appliance (Recovery Appliance) from the broker configuration and terminates broker management of the Recovery Appliance.
• SET ECHO
  The SET ECHO command controls whether or not to echo commands that are issued either at the command-line prompt or from a DGMGRL script.
• SET FAST_START FAILOVER TARGET
  The SET FAST_START FAILOVER TARGET command enables you to set the fast-start failover target to the named standby database without disabling fast-start failover or modifying the fast start failover list.
• SET MASTEROBSERVER TO
  The SET MASTEROBSERVER TO command lets you manually change which observer is recognized as the master observer.
• SET MASTEROBSERVERHOSTS
  The SET MASTEROBSERVERHOSTS command sets the master observer of a broker configuration to the observer on the target host.
• SET ObserverConfigFile
  The SET ObserverConfigFile command sets the full path and file name of an observer configuration file.
• SET TIME
  The DGMGRL SET TIME command turns timestamp printing on and off.
• SET TRACE_LEVEL
  The SET TRACE_LEVEL command sets the amount of tracing done by DGMGRL. This is a client-side setting and does not impact the tracing set for the broker within the Oracle Database.
• SHOW ALL
  The SHOW ALL command shows the values of DGMGRL CLI properties.
• SHOW ALL MEMBERS (Parameter)
  The EDIT ALL MEMBERS SET command displays the value of the specified initialization parameter for all members in the configuration.
• SHOW ALL MEMBERS (Property)
  The SHOW ALL MEMBERS (Property) command displays the value of the specified property for all members in the configuration.
• SHOW CONFIGURATION
  The SHOW CONFIGURATION command displays a summary and status of the broker configuration.
• SHOW CONFIGURATION TAG
  The SHOW CONFIGURATION TAG command displays all configurations associated with tags or the named tag.
• SHOW CONFIGURATION WHEN PRIMARY IS
  The SHOW CONFIGURATION WHEN PRIMARY IS command displays the redo transport configuration that would be in effect if the specified database were the primary database.
• SHOW CONNECTION
  Shows the current database connection.
• SHOW DATABASE
  The SHOW DATABASE command displays information, property values, or initialization parameter values of the specified database and its instances.
• SHOW DATABASE TAG
  The sHOW DATABASE TAG command displays all databases associated with tags or the named tag.
• SHOW FAR_SYNC
  The SHOW FAR_SYNC command shows information about a far sync instance.
• SHOW FAR_SYNC TAG
  The SHOW FAR_SYNC TAG command displays all far-sync databases associated with tags or the named tag.
• SHOW FAST_START FAILOVER
  The SHOW FAST_START FAILOVER command displays all fast-start failover related information.
• SHOW INSTANCE
  The SHOW INSTANCE command displays information or property values for the specified instance.
• SHOW MEMBER TAG
  The SHOW MEMBER TAG command is used to display the value of a specific member-level tag or all tags for a specific database member.
• SHOW OBSERVER
  The SHOW OBSERVER command shows information about all registered observers in a Data Guard broker configuration.
• SHOW ObserverConfigFile
  The SHOW ObserverConfigFile command shows the value of the ObserverConfigFile property.
• SHOW OBSERVERS
  The SHOW OBSERVERS command shows information about all observers for all broker configurations in a specific configuration group.
• SHOW PLUGGABLE DATABASE
  This command displays the information or property values of the specified pluggable database (PDB).
• SHOW RECOVERY_APPLIANCE
  The SHOW RECOVERY_APPLIANCE command displays information, property values, or initialization parameter values of the specified Zero Data Loss Recovery Appliance (Recovery Appliance).
• SHUTDOWN
  Shuts down a currently running Oracle instance.
• SPOOL
  The SPOOL command records the input and output of DGMGRL to a file.
• SQL
  The SQL command executes a SQL statement or a PL/SQL stored procedure.
• START OBSERVER
  The START OBSERVER command starts a fast-start failover observer on this host (where the DGMGRL session is running), if there is no registered observer running on this host for this configuration.
• START OBSERVER IN BACKGROUND
  The START OBSERVER IN BACKGROUND command starts a fast-start failover observer on this host (where this DGMGRL session is running) as a background process.
• START OBSERVING
  The START OBSERVING command starts a new observer for each broker configuration in the specified group.
• STARTUP
  The STARTUP command starts an Oracle database instance, and allows you to specify a number of options.
• STOP OBSERVER
  The STOP OBSERVER command stops the fast-start failover observer.
• STOP OBSERVING
  
• SWITCHOVER
  When you issue the SWITCHOVER command, the current primary database becomes a standby database, and the specified standby database becomes the primary database. This is known as a switchover operation.
• SWITCHOVER PLUGGABLE DATABASE
  This command switches the role of a source PDB with its designated target PDB.
• VALIDATE DATABASE
  The VALIDATE DATABASE command performs a comprehensive set of checks prior to a role change. The command gives the option of running basic checks indicating whether the specified standby is ready for switchover or failover. You may also include a stricter level of checks using options available for the STRICT clause.
• VALIDATE DATABASE DATAFILE
  The VALIDATE DATABASE DATAFILE command performs validation of data files across the primary database and standby databases.
• VALIDATE DATABASE SPFILE
  The VALIDATE DATABASE SPFILE command performs a comparison of server parameter file (SPFILE) entries between the primary database and a specified standby database.
• VALIDATE DGConnectIdentifier
  The VALIDATE DGConnectIdentifier command enables users to check to see whether a connect identifier is valid for the DGConnectidentifier property.
• VALIDATE FAR_SYNC
  The VALIDATE FAR_SYNC command performs a comprehensive set of checks for a far sync instance.
• VALIDATE FAST_START FAILOVER
  The VALIDATE FAST_START FAILOVER command enables you to validate a fast-start failover configuration. It identifies misconfigurations, either while setting up or initiating fast-start failover.
• VALIDATE NETWORK CONFIGURATION
  The VALIDATE NETWORK CONFIGURATION command performs network connectivity checks between members of a configuration.
• VALIDATE PLUGGABLE DATABASE
  The VALIDATE DATABASE command performs a comprehensive set of database checks prior to a role change.
• VALIDATE STATIC CONNECT IDENTIFIER
  The VALIDATE STATIC CONNECT IDENTIFIER command validates the static connect identifier of a database.