HELP

Format

HELP [command_name];

Command Parameters

command_name

The command for which help information is desired. If a command is not specified, then all commands are listed.

@ Execute DGMGRL script file
!     Host operating system command
/     Repeat the last command
--     Comment to be ignored by DGMGRL
add     Adds a member to the broker configuration
connect     Connects to an Oracle database instance
convert     Converts a database from one type to another
create     Creates a broker configuration or far sync instance
disable     Disables a configuration, a member, or fast-start failover
edit     Edits a configuration or a member
enable         Enables a configuration, a member, or fast-start failover
exit           Exits the program
export         Export Data Guard Broker configuration to a file.
failover       Changes a standby database to be the primary database
help           Displays description and syntax for a command
host           Host operating system command
import         Import Data Guard Broker configuration from a file.
migrate        Migrate a pluggable database from one configuration to another.
prepare        Prepare a primary database for a Data Guard environment.
quit           Exits the program
reinstate      Changes a database marked for reinstatement into a viable standby
rem            Comment to be ignored by DGMGRL
remove         Removes a configuration or a member
set            Set a DGMGRLI CLI property to a specified value
show           Displays information about a configuration or a member
shutdown       Shuts down a currently running Oracle database instance
spool          store input and output of DGMGRL CLI in a file
sql            Executes a SQL statement
start          Starts the fast-start failover observer
startup        Starts an Oracle database instance
stop           Stops the fast-start failover observer
switchover     Switches roles between a primary and standby database
validate       Performs an exhaustive set of validations for a member

Enter help command_name to see syntax for individual commands.

Usage Notes

A database connection is not required to execute this command.

Command Example

The following example gets help on the EDIT commands.

DGMGRL> HELP FAILOVER
Changes a standby database to be the primary database

Syntax:

  FAILOVER TO <standby db-unique-name> [IMMEDIATE];

  FAILOVER TO PLUGGABLE DATABASE <standby pluggable database name>
    AT <target CDB> [IMMEDIATE];