DGMGRL commands for Exadata

98 commands, grouped by what they do.

Check status and configuration

  • SHOW CONFIGURATION;

    Displays the top-level Data Guard Broker configuration summary, including member roles and overall broker status. It is usually the first read-only DGMGRL check during Data Guard triage.

    Read only

  • SHOW DATABASE <DB_UNIQUE_NAME>;

    Displays broker status and key properties for one primary or standby database member. It is a read-only member-level check used when the overall configuration needs targeted follow-up.

    Read only

  • SHOW CONFIGURATION VERBOSE;

    Displays detailed Data Guard Broker configuration status, including member state, protection mode, warnings, and broker properties. It is a read-only way to review the full broker-managed configuration before troubleshooting or role transitions.

    Read only

  • SHOW DATABASE VERBOSE <DB_UNIQUE_NAME>;

    Displays expanded Broker information for one Data Guard database member. It is read-only and surfaces role, state, transport/apply behavior, lag, properties, warnings, and member-specific configuration details.

    Read only

  • dgmgrl /

    Starts DGMGRL and connects using operating system authentication. The command itself does not change broker state, but it can open a privileged broker session depending on the OS user and Oracle home.

    Caution

  • dgmgrl sys/<PASSWORD>@<DB_UNIQUE_NAME>

    Starts DGMGRL and connects to a broker-managed database using explicit SYS credentials and a connect identifier. The command itself does not change Data Guard state, but it can expose privileged credentials if typed or logged carelessly.

    Caution

  • SHOW CONNECTION;

    Shows the current DGMGRL connection context, including the connected instance and authentication context when available. It is read-only.

    Read only26ai

  • SHOW INSTANCE <instance_name> [ON DATABASE <db_unique_name>];

    Displays broker status for a database instance, usually in a RAC member. It is read-only and helps confirm broker health at instance level.

    Read only

  • SHOW ALL;

    Shows the values of DGMGRL CLI properties such as echo, time, trace level, and observer configuration file. It is read-only.

    Read only

  • SHOW CONFIGURATION TAG [<tag_name>];

    Displays all tags or a specific tag on the broker configuration. It reads broker metadata without changing it.

    Read only26ai

  • SHOW OBSERVER [<observer_name>];

    Displays observer information for the broker configuration, including role, host, and ping status when available. It is read-only.

    Read only

  • SHOW DATABASE <DB_UNIQUE_NAME> StatusReport;

    Shows the broker StatusReport property for one database member. It is a read-only detail check used when a member reports WARNING or ERROR and the DBA needs the specific broker messages.

    Read only

  • SHOW DATABASE <DB_UNIQUE_NAME> InconsistentProperties;

    Shows broker properties for the selected database that are inconsistent across instances or members. It is a read-only diagnostic command for finding configuration drift before role transitions or broker-managed repair work.

    Read only

  • EXIT;

    Exits the DGMGRL command-line interface and returns to the operating system. It is an interactive client command only.

    Read only

  • SHOW ObserverConfigFile;

    Shows the current DGMGRL ObserverConfigFile runtime property and attempts to parse the pointed file. It is read-only.

    Read only

  • SHOW CONFIGURATION WHEN PRIMARY IS <db_unique_name>;

    Displays how the broker configuration would look when the specified member is primary. It is a read-only view useful for validating future role topology.

    Read only

  • SHOW OBSERVERS [FOR <cfg_group_name>];

    Displays observer information across configurations or a configuration group using the observer configuration file. It is read-only.

    Read only

  • HELP [<command>];

    Displays DGMGRL help text for all commands or for a specified command. It is read-only and local to the client session output.

    Read only

  • QUIT;

    Quits the DGMGRL command-line interface. It is equivalent to EXIT and affects only the client session.

    Read only

  • SHOW DATABASE <db_unique_name> TAG [<tag_name>];

    Displays all tags or a named tag for a broker database member. It reads member metadata only.

    Read only26ai

  • SHOW PLUGGABLE DATABASE <pdb_name> AT <target_db_unique_name> [ALL];

    Displays information and property values for a protected pluggable database at a target CDB. It is read-only and focused on DG PDB state.

    Read only26ai

  • SHOW FAR_SYNC [VERBOSE] <db_unique_name> [<property_name>];

    Displays status, properties, or selected property values for a far sync member. It is read-only and helps validate far sync health and configuration.

    Read only

  • SHOW MEMBER <db_unique_name> TAG [<tag_name>];

    Displays all tags or a selected tag for a generic broker member. It reads member metadata without changing it.

    Read only26ai

  • SHOW FAR_SYNC <db_unique_name> TAG [<tag_name>];

    Displays all tags or a specified tag for a far sync broker member. It reads broker metadata only.

    Read only26ai

  • SHOW RECOVERY_APPLIANCE [VERBOSE] <db_unique_name> [<property_name>] [<initialization_parameter_name>];

    Displays status, properties, or initialization parameter values for a broker-managed Recovery Appliance member. It is read-only.

    Read only

Collect diagnostics

  • VALIDATE DATABASE <DB_UNIQUE_NAME>;

    Runs Broker validation checks for a specific Data Guard database member. It reports readiness issues, configuration problems, and warnings that matter before switchover, failover, or maintenance.

    Read only

  • VALIDATE NETWORK CONFIGURATION FOR ALL;

    Checks broker network connectivity between all members in a Data Guard broker configuration. It validates whether members and static connect identifiers can be reached before a role transition or after listener, SCAN, DNS, or TNS changes.

    Read only

  • VALIDATE DATABASE <db_unique_name> SPFILE;

    Compares server parameter file settings for a Data Guard database member. It is read-only and reports parameter differences relevant to broker operations.

    Read only

  • VALIDATE STATIC CONNECT IDENTIFIER FOR ALL;

    Validates static connect identifiers for all databases in the Data Guard Broker configuration. It is a read-only readiness check for broker connectivity during startup, switchover, failover, and reinstate workflows.

    Read only

  • VALIDATE DATABASE <db_unique_name> DATAFILE {<datafile_number> | ALL} [OUTPUT=<file_name>];

    Compares data files for a broker database member and can write output to a trace-side file. It performs validation checks and does not intentionally modify database data.

    Read only

  • VALIDATE DGConnectIdentifier <db_unique_name>;

    Checks whether the connect identifier configured for the DGConnectIdentifier property resolves and connects correctly for the target member. It reports connection translation and environment details.

    Read only26ai

  • MIGRATE PLUGGABLE DATABASE [VERIFY] [IMMEDIATE] <pdb_name> TO CONTAINER <dest_cdb_name> USING <xml_description_file> [CONNECT AS {/@<dest_cdb_connect_identifier> | <user>/<password>@<dest_cdb_connect_identifier>}] [SECRET <secret> KEYSTORE IDENTIFIED BY (EXTERNAL STORE | <wallet_password>)] [STANDBY FILES {/@<asm_instance_connect_identifier> | <sysasm_user>/<sysasm_pass>@<asm_instance_connect_identifier>}] [SOURCE STANDBY <source_standby_cdb_name> [DESTINATION STANDBY <dest_standby_cdb_name>]] [TIMEOUT <seconds>] [KEYFILE <key_file>] [SOURCE KEYSTORE IDENTIFIED BY (EXTERNAL STORE | <source_wallet_password>)];

    Migrates a PDB from one CDB to another in a Data Guard broker environment. In 26ai it can also reuse standby data files for eligible DG PDB moves.

    Dangerous

  • VALIDATE FAR_SYNC <db_unique_name>;

    Runs validation checks for a far sync member, including redo-related readiness details. It reports status and configuration issues without changing state.

    Read only

  • VALIDATE PLUGGABLE DATABASE <pdb_name> AT <db_unique_name>;

    Runs validation checks for a protected pluggable database at a target CDB. It is a read-only DG PDB readiness/status check.

    Read only26ai

Start, stop and move

  • SHOW FAST_START FAILOVER;

    Displays fast-start failover status, targets, observer information, and configured failover conditions. It is read-only.

    Read only

  • SWITCHOVER TO PLUGGABLE DATABASE <pdb_name> AT <target_db_unique_name>;

    Switches over DG PDB roles so the target PDB becomes the primary protected PDB. It is a planned PDB-level role transition.

    Dangerous26ai

  • VALIDATE FAST_START FAILOVER;

    Checks fast-start failover configuration and readiness, including observer, target, and configured failover conditions. It reports blockers or warnings without changing FSFO settings.

    Read only

  • REINSTATE DATABASE <DB_UNIQUE_NAME>;

    Reinstates an eligible failed or former primary database as a standby in the current broker configuration. Eligibility depends on broker state, flashback/recovery prerequisites, and the prior failover scenario.

    Dangerous

  • ENABLE DATABASE <DB_UNIQUE_NAME>;

    Enables Broker management for one database member in a Data Guard configuration. This returns the member to broker control after maintenance, repair, or initial configuration work.

    Caution

  • DISABLE CONFIGURATION;

    Disables broker management for the Data Guard configuration and its databases. The databases keep running, but broker monitoring, management, and enforcement are disabled until the configuration is enabled again.

    Caution

  • ENABLE FAST_START FAILOVER [OBSERVE ONLY];

    Enables fast-start failover for the broker configuration, optionally in observe-only mode. It permits broker and observers to evaluate or perform automatic failover according to the configured FSFO policy.

    Caution

  • ENABLE CONFIGURATION;

    Enables broker management for the Data Guard configuration and its member databases. Broker resumes monitoring and management, so member state, connectivity, and properties should be correct before running it.

    Caution

  • DISABLE DATABASE <DB_UNIQUE_NAME>;

    Disables Broker management for one database member in a Data Guard configuration. The database is not dropped, but Broker stops managing that member until it is enabled again.

    Caution

  • DISABLE FAR_SYNC <db_unique_name>;

    Disables broker management of a far sync instance. It changes the intended broker state for that far sync member but does not remove it from the configuration.

    Caution

  • SWITCHOVER TO <STANDBY_DB_UNIQUE_NAME>;

    Performs a broker-managed planned role transition to the named standby database. It exchanges primary and standby roles and should only be used when both sides are healthy and the application routing plan is ready.

    Caution

  • STARTUP [FORCE] [RESTRICT] [PFILE=<filename>] [MOUNT | OPEN [<open_options>] | NOMOUNT];

    Starts an Oracle database instance from DGMGRL and can mount, open, or start nomount. FORCE first aborts the current instance before restarting it.

    Dangerous

  • STOP OBSERVING [<cfg_group_name>];

    Submits stop-observer requests for configurations listed in the observer configuration file, optionally limited to a configuration group. It is used from a superobserver workflow.

    Caution

  • FAILOVER TO PLUGGABLE DATABASE <pdb_name> AT <target_db_unique_name> [IMMEDIATE];

    Fails over a protected PDB so the target PDB assumes the source role. IMMEDIATE can be used when data loss is possible and must be explicitly accepted.

    Dangerous26ai

  • STOP OBSERVER [<observer_name>];

    Stops a fast-start failover observer process. It changes observer availability for FSFO but does not directly change database data.

    Caution

  • DISABLE FAST_START FAILOVER CONDITION <condition>;

    Removes a configured database health condition or Oracle error condition from the set that can trigger fast-start failover. It changes failover policy but does not change database data.

    Caution

  • DISABLE RECOVERY_APPLIANCE <db_unique_name>;

    Disables broker management of a Zero Data Loss Recovery Appliance member in the broker configuration. The member remains configured but broker management is stopped.

    Caution

  • FAILOVER TO <STANDBY_DB_UNIQUE_NAME>;

    Performs a broker-managed failover to the named standby database, making it the new primary. This is a major role transition and can require reinstating or rebuilding the former primary depending on the failure and protection state.

    Dangerous

  • ENABLE FAR_SYNC <db_unique_name>;

    Enables broker management of a configured far sync instance. It lets broker resume managing the far sync member state and redo routing.

    Caution

  • ENABLE FAST_START FAILOVER CONDITION <condition>;

    Adds a condition that can trigger fast-start failover, such as a database health condition or ORA error. It changes the automatic failover policy for the configuration.

    Caution

  • SET FAST_START FAILOVER TARGET TO <db_unique_name>;

    Changes the designated target standby for fast-start failover. It updates the FSFO policy so broker and observers prefer the specified target.

    Caution

  • ENABLE RECOVERY_APPLIANCE <db_unique_name>;

    Enables broker management of a configured Zero Data Loss Recovery Appliance member. Broker resumes managing that member in the Data Guard configuration.

    Caution

  • DISABLE FAST_START FAILOVER [FORCE];

    Disables fast-start failover for the broker configuration. It stops automatic failover decisions until FSFO is enabled again.

    Caution

  • SHUTDOWN [ABORT | IMMEDIATE | NORMAL];

    Shuts down the currently connected Oracle instance from DGMGRL. With no option it behaves as SHUTDOWN NORMAL.

    Dangerous

Create and change

  • EDIT DATABASE <DB_UNIQUE_NAME> SET STATE=APPLY-ON;

    Changes the broker state of the specified standby database so managed redo apply starts or resumes. This affects Data Guard recovery behavior and can create catch-up workload after maintenance or an apply outage.

    Caution

  • EDIT DATABASE <DB_UNIQUE_NAME> SET STATE=TRANSPORT-ON;

    Changes the broker-managed transport state so redo shipment resumes for the specified database. This affects Data Guard protection and should be paired with checks for archive destinations, network reachability, and standby receive/apply health.

    Caution

  • EDIT DATABASE <DB_UNIQUE_NAME> SET STATE=APPLY-OFF;

    Sets the broker state for the named database to APPLY-OFF, stopping redo apply on the standby. Redo transport may continue, but apply lag will grow until apply is turned back on.

    Caution

  • EDIT DATABASE <DB_UNIQUE_NAME> SET STATE=TRANSPORT-OFF;

    Sets the broker state for the named database to TRANSPORT-OFF, stopping redo transport for the affected broker-managed destination. This can reduce data protection while disabled and must be time bounded.

    Caution

  • EDIT CONFIGURATION SET PROTECTION MODE [AS] {MaxProtection | MaxAvailability | MaxPerformance};

    Changes the Data Guard broker configuration protection mode. The new mode controls redo transport and data-loss guarantees when the configuration is enabled.

    Caution

  • SPOOL [<spool_file_name> [CREATE | REPLACE | APPEND] | OFF];

    Records DGMGRL input and output to a spool file, shows current spooling when run alone, or stops spooling with OFF. It writes a local client log file only.

    Safe

  • ADD DATABASE <DB_UNIQUE_NAME> AS CONNECT IDENTIFIER IS <CONNECT_IDENTIFIER>;

    Adds a standby database to an existing Data Guard broker configuration. The connect identifier becomes the broker communication endpoint for that database and must resolve correctly from all members.

    Caution

  • SET MASTEROBSERVER TO <observer_name>;

    Sets which registered observer is the master observer for a broker configuration. It changes FSFO observer coordination metadata.

    Caution

  • SET MASTEROBSERVERHOSTS [FOR <cfg_group_name>] TO <host_name>;

    Sets the host where the master observer should run for a configuration or configuration group. It controls observer placement for FSFO operations.

    Caution

  • EDIT DATABASE <db_unique_name> SET STATE='<state>';

    Changes the broker intended state for a database member, such as enabling or disabling redo transport or apply. It affects Data Guard operations for the named member.

    Caution

  • SET ECHO [ON | OFF];

    Controls whether DGMGRL echoes commands at the prompt or from scripts. It affects client output only.

    Read only

  • SET TIME [ON | OFF];

    Turns timestamp printing on or off in DGMGRL output. It affects only client display for the current session.

    Read only

  • EDIT PLUGGABLE DATABASE <pdb_name> AT <db_unique_name> SET STATE=<state_name>;

    Changes the broker state for a protected pluggable database at a target CDB. It is used to turn DG PDB apply behavior on or off.

    Caution26ai

  • SET TRACE_LEVEL {USER | SUPPORT};

    Sets the DGMGRL tracing level for diagnostic output. SUPPORT produces more detailed trace information than USER.

    Safe

  • SET ObserverConfigFile = <filename>;

    Sets the full path and file name of the observer configuration file for the DGMGRL client session. It is a runtime property and is not stored in broker metadata.

    Safe

  • EDIT CONFIGURATION RENAME TO <new_configuration_name>;

    Renames the broker configuration. This changes the broker display/configuration name but does not change the database unique names.

    Caution

  • CREATE CONFIGURATION <CONFIGURATION_NAME> AS PRIMARY DATABASE IS <PRIMARY_DB_UNIQUE_NAME> CONNECT IDENTIFIER IS <CONNECT_IDENTIFIER>;

    Creates a new Data Guard broker configuration and defines the primary database member. The connect identifier is used by broker to communicate with the primary database.

    Caution

  • EDIT DATABASE <db_unique_name> RENAME TO <new_db_unique_name>;

    Renames the database object as recorded in the broker configuration. It updates broker metadata for the member name after the underlying DB_UNIQUE_NAME identity has been corrected.

    Caution

  • EDIT DATABASE <db_unique_name> SET TAG <tag_name>=<value>;

    Sets a tag value on a broker database member. The tag is member metadata used for identification, grouping, or automation.

    Caution26ai

  • ADD CONFIGURATION <CONFIGURATION_NAME> CONNECT IDENTIFIER IS <CONNECT_IDENTIFIER>;

    Adds another broker configuration to the current Data Guard broker configuration and establishes a relationship between the two configurations. In the 26ai docs this is used for multi-configuration/PDB protection workflows.

    Caution26ai

  • ADD RECOVERY_APPLIANCE <APPLIANCE_NAME> AS CONNECT IDENTIFIER IS <CONNECT_IDENTIFIER>;

    Adds a Zero Data Loss Recovery Appliance to an existing Data Guard broker configuration. Broker uses the connect identifier to communicate with the appliance member.

    Caution

  • EDIT CONFIGURATION RESET TAG <tag_name>;

    Removes a named broker tag from the configuration. It updates configuration metadata used for labeling or automation.

    Caution26ai

  • ADD FAR_SYNC <FAR_SYNC_NAME> AS CONNECT IDENTIFIER IS <CONNECT_IDENTIFIER>;

    Adds an existing far sync instance to a Data Guard broker configuration. Broker then manages it as a member used for redo transport topology.

    Caution

  • ADD PLUGGABLE DATABASE <TARGET_PDB> AT <TARGET_CONFIGURATION> SOURCE IS <SOURCE_PDB> AT <SOURCE_CONFIGURATION> [PDBFileNameConvert IS '<SOURCE_PATTERN>', '<TARGET_PATTERN>'];

    Adds a pluggable database to broker management for Data Guard PDB protection. It associates a target PDB/configuration with its source PDB/configuration and can include file-name conversion rules.

    Caution26ai

  • CREATE FAR_SYNC <db_unique_name> AS CONNECT IDENTIFIER IS <connect_identifier> [SPFILE [PARAMETER_VALUE_CONVERT '<string_pair_values>'] [SET <parameter_name>=<value>]... [RESET <parameter_name>]...];

    Creates a new far sync instance and adds it to the broker configuration. The command can invoke RMAN DUPLICATE and requires wallet-based authentication, SYSDBA, and an auxiliary instance on the target host.

    Caution26ai

  • EDIT CONFIGURATION PREPARE DGPDB;

    Prepares a broker configuration for Data Guard protection of pluggable databases. It prompts for DGPDB_INT account passwords and prepares the participating CDBs for DG PDB operations.

    Caution26ai

  • EDIT CONFIGURATION SET TAG <tag_name>=<value>;

    Sets a named tag value on the broker configuration. The tag is metadata for identifying or classifying the configuration.

    Caution26ai

  • EDIT DATABASE <db_unique_name> RESET TAG <tag_name>;

    Removes a named tag from a broker database member. It updates metadata on that member only.

    Caution26ai

  • EDIT FAR_SYNC <db_unique_name> RENAME TO <new_db_unique_name>;

    Renames the far sync object in the broker configuration. It changes broker metadata for the far sync member name.

    Caution

  • EDIT FAR_SYNC <db_unique_name> RESET TAG <tag_name>;

    Removes a named tag from a far sync broker member. It changes only broker metadata for that member.

    Caution26ai

  • EDIT FAR_SYNC <db_unique_name> SET TAG <tag_name>=<value>;

    Sets a tag value on a far sync broker member. The tag stores metadata for labeling or automation around that far sync instance.

    Caution26ai

  • EDIT MEMBER <db_unique_name> RESET TAG <tag_name>;

    Removes a tag from a generic broker member. It is useful when the same tag operation should apply without using database- or far-sync-specific syntax.

    Caution26ai

  • EDIT MEMBER <db_unique_name> SET TAG <tag_name>=<value>;

    Sets a tag value on a broker member using member-generic syntax. It updates broker metadata used for labeling or automation.

    Caution26ai

  • EDIT RECOVERY_APPLIANCE <db_unique_name> RENAME TO <new_db_unique_name>;

    Renames the Recovery Appliance object recorded in broker metadata. The command changes the name used by broker to refer to that member.

    Caution

Remove and drop

  • REMOVE DATABASE <db_unique_name> [PRESERVE DESTINATIONS];

    Removes a database member from the broker configuration. It deletes the broker metadata for that member and can clear related redo destinations unless preserved.

    Dangerous

  • REMOVE PLUGGABLE DATABASE <pdb_name> AT <db_unique_name>;

    Stops recovery at a target PDB and drops the target PDB from DG PDB protection. It ends Data Guard protection for that source PDB at the target.

    Dangerous26ai

  • REMOVE FAR_SYNC <db_unique_name> [PRESERVE DESTINATIONS];

    Removes a far sync instance from the broker configuration. It deletes broker metadata for that far sync member and can alter related destination settings.

    Dangerous

  • REMOVE INSTANCE <instance_name> ON DATABASE <db_unique_name>;

    Removes an instance entry from a RAC database member in the broker configuration. It changes broker metadata for that database but does not drop the database instance itself.

    Caution

  • REMOVE RECOVERY_APPLIANCE <db_unique_name> [PRESERVE DESTINATIONS];

    Removes a Zero Data Loss Recovery Appliance member from the broker configuration and terminates broker management of it. The Recovery Appliance profile is deleted from broker metadata.

    Dangerous

  • REMOVE CONFIGURATION [PRESERVE DESTINATIONS];

    Removes the entire broker configuration from broker management. PRESERVE DESTINATIONS keeps redo destination settings instead of clearing them.

    Dangerous

Search every command