2 Global Data Services Control Utility (GDSCTL) Command Reference

This appendix includes a complete reference of the Global Data Services utility (GDSCTL) commands for use with a Global Data Services or Oracle Globally Distributed AI Database configuration.

  • add brokerconfig
    Adds an Oracle Data Guard broker configuration to a Global Data Services pool.
  • add cdb
    Add a cdb to the shard catalog.
  • add credential
    Adds a credential which can be used by the remote scheduler agent to execute shard jobs.
  • add database
    Adds databases to a Global Data Services region and Global Data Services pool.
  • add file
    Adds the contents of a file to the catalog which can be used by subsequent GDSCTL commands.
  • add gdspool
    Adds a Global Data Services pool to the Global Data Services framework.
  • add gsm
    Adds a global service manager to the Global Data Services framework.
  • add invitednode (add invitedsubnet)
    Adds host address or subnet information to the valid node checking for registration (VNCR) list in the catalog, before starting the first global service manager, by establishing a direct connection to the Global Data Services catalog database.
  • add region
    Adds a region to a Global Data Services framework or an Oracle Globally Distributed AI Database configuration.
  • add service
    Adds a global service to a Global Data Services pool.
  • add shard
    Add a shard to the shard catalog.
  • add shardgroup
    Add a shardgroup to a shardspace.
  • add shardspace
    Add a shardspace to the shard catalog.
  • alter move
    Suspend, resume, or cancel scheduled chunk move operations on a sharded database.
  • alter task
    Suspend, resume, or cancel scheduled chunk or replication unit management operations on a sharded database.
  • config
    Displays the configuration data for all components defined for the configuration.
  • config backup
    Configure Sharded Database (SDB) Backup
  • config cdb
    Displays properties of a specified CDB.
  • config chunks
    Displays properties of a specified chunk.
  • config credential
    Displays remote credentials currently available for shard jobs.
  • config database
    Displays the static configuration data stored in the catalog for the specified database.
  • config file
    Displays file objects currently available that can be specified in GDSCTL commands.
  • config gdspool
    Displays the static configuration data that is stored in the catalog for the specified database pool.
  • config gsm
    Displays the static configuration data stored in the catalog for the specified global service manager.
  • config region
    Displays the static configuration data for the specified region.
  • config sdb
    Displays the static configuration data stored in the catalog for the sharded database.
  • config service
    Displays the static configuration data stored in the Global Data Services catalog for the specified services that are located in a database pool.
  • config shard
    Displays properties of a specified shard.
  • config shardgroup
    Displays properties of a specified shardgroup.
  • config shardspace
    Displays properties of a specified shardspace.
  • config table family
    Displays information about all table families in the sharded database.
  • config task
    Display chunk or replication unit management tasks and their statuses.
  • config vncr
    Displays the static configuration data stored in the catalog for valid node checking for registration (VNCR).
  • configure
    Sets the GDSCTL parameters.
  • connect
    Specifies the credentials to administer a global service management environment. Credentials must be specified to perform certain operations using GDSCTL.
  • copy ru
    To instantiate or repair a follower member of a replication unit you can copy another follower in that replication unit from another shard.
  • create gdscatalog
    Creates a Global Data Services catalog for global service management in a specific database.
  • create restorepoint
    Create Global Restore Points.
  • create shardcatalog
    Creates a shard catalog for the sharded database.
  • databases
    Displays the status of all databases.
  • delete backup
    Deletes sharded database (SDB) backups identified with specific tags from the recovery repository.
  • delete catalog
    Deletes the specified catalog.
  • deploy
    Deploys the sharded database.
  • disable backup
    Disable Sharded Database (SDB) Backup Jobs.
  • disable service
    Disables specified global services.
  • enable backup
    Enable Sharded Database (SDB) Backup Jobs.
  • enable service
    Enables the specified global services.
  • exit
    Quit GDSCTL utility.
  • export catalog
    Saves the current catalog configuration to a local file.
  • help
    Provides a list of the GDSCTL commands supported in the current release. When followed by a command name, it returns the help page associated with the command.
  • import catalog
    Restores the catalog configuration from the specified file, created using export catalog command.
  • list backup
    List Sharded Database (SDB) Backups
  • list restorepoint
    List Global Restore Points.
  • modify catalog
    Modifies the properties of the GDS catalog or shard catalog.
  • modify cdb
    Modify cdb attributes.
  • modify credential
    Modifies an existing credential which will be used by the remote Scheduler agent to execute shard jobs.
  • modify database
    Modifies the configuration parameters of the databases in a GDS pool, such as region, connect identifier, global service manager password, SCAN address, and ONS port.
  • modify file
    Updates the contents of a file in the catalog which can be used by subsequent GDSCTL commands.
  • modify gdspool
    Modifies the configuration parameters of GDS pools.
  • modify gsm
    Modifies the configuration parameters of the global service manager. The changes take effect after the global service manager is restarted.
  • modify region
    Modifies the configuration parameters for a region.
  • modify service
    Modifies the service attributes.
  • modify shard
    Modify shard attributes.
  • modify shardgroup
    Modify shardgroup attributes.
  • modify shardspace
    Modify shardspace parameters.
  • move chunk
    Moves a listed set of chunks from one shard to another shard or multiple shards.
  • move ru
    Move a member replica of a replication unit from one shard to another.
  • quit
    Quit GDSCTL utility.
  • recover shard
    Executes all DDL statements on the specified shard (database), starting from the one that was previously executed with errors. The command is intended to perform all skipped DDL changes after database administrator fixes shard issues.
  • relocate chunk
    This command moves a list of chunks in all the replicas of the specified source RU to all the replicas in the target ru.
  • relocate service
    Stops a service on one database and starts the service on a different database.
  • remove brokerconfig
    Removes an Oracle Data Guard broker configuration from a GDS pool.
  • remove cdb
    Removes one or more CDBs from the shard catalog, but does not destroy it.
  • remove credential
    Removes an existing credential.
  • remove database
    Removes databases from a GDS pool.
  • remove file
    Removes an existing file object from the catalog.
  • remove gdspool
    Removes a GDS pool from the current configuration.
  • remove gsm
    Removes a global service manager from the configuration.
  • remove invitednode (remove invitedsubnet)
    Remove host address information from the valid node checking for registration (VNCR) list in the Global Data Services catalog. This command removes either the specified invitednode or all invitednodes that correspond to an alias.
  • remove region
    Removes the specified regions from the global service management framework.
  • remove ru
    Remove empty replication unit from a sharded database configuration.
  • remove service
    Removes a service from a database pool.
  • remove shard
    Removes one or more shards from the sharded database.
  • remove shardgroup
    Removes a shardgroup from the shard catalog.
  • remove shardspace
    Removes a shardspace from the shard catalog.
  • restore backup
    The restore backup command is used to restore a sharded database to a specific global restore point.
  • resume services
    Resumes global service activity and traffic routing to the database, previously blocked by SUSPEND SERVICES command.
  • rman
    Allow users to submit RMAN commands to a list of shards for execution.
  • run backup
    Run Sharded Database (SDB) Backup Jobs.
  • services
    Retrieves information about the services that are registered with the specified global service manager.
  • set dataguard_property
    Dynamically updates the value of a specified property of a broker configuration or database.
  • set gsm
    Sets the global service manager for the current session.
  • set inbound_connect_timeout
    Sets the INBOUND_CONNECT_TIMEOUT listener parameter.
  • set log_status
    Sets the LOG_STATUS listener parameter.
  • set outbound_connect_timeout
    Sets the OUTBOUND_CONNECT_TIMEOUT listener parameter.
  • set trace_level
    Sets the trace level for the listener associated with the specified global service manager.
  • set trc_level
    Sets the TRC_LEVEL listener parameter.
  • show ddl
    Shows DDL statements execution status.
  • split chunk
    Splits each of the specified chunks into two chunks with an equal number of records. After the split, the chunks remain in the same shard.
  • sql
    Executes a SQL statement or a PL/SQL stored procedure against a sharded database.
  • start gsm
    Starts a specific global service manager.
  • start observer
    Starts specific services.
  • start ru
    Starts a specified replication unit.
  • start service
    Starts specific services.
  • status
    Displays the running status and runtime information for the global service manager.
  • status backup
    View the detailed state on the scheduled backup jobs in the specified shards.
  • status database
    Displays the runtime status of databases, such as registration information, services, and so on.
  • status gsm
    Displays the status of a specific global service manager.
  • status routing
    Displays the runtime routing information status.
  • status ru
    Displays runtime information about replication units for Oracle Globally Distributed AI Database native Raft replication.
  • status service
    Displays the status of a specific service.
  • stop gsm
    Stops a specific global service manager.
  • stop ru
    Stops a specified replication unit.
  • stop service
    Stops the specified global services.
  • suspend services
    This command allows users to block database on all GSM listeners.
  • switchover ru
    Switch leadership for the given replication unit to the specified database.
  • sync brokerconfig (synchronize brokerconfig)
    Synchronizes the Oracle Data Guard broker configuration in the global service manager with the configuration in the database pool. The synchronize brokerconfig command has the same options and usage.
  • sync database (synchronize database)
    Synchronizes attributes of global services and GDS related parameters of a GDS pool database with the contents of the GDS catalog. The synchronize database command has the same options and usage.
  • sync ru
    Synchronizes data of the specified replication unit on all shards, erases RAFT logs, and resets log index and term.
  • sync schema (synchronize schema)
    Allows common shared schemas across the existing databases to be retrieved. The command compares the schemas on all of the databases and retrieves those that are common.
  • validate backup
    The validate backup command provides sharded database (SDB) backup validation.
  • validate catalog
    Cross checks the Global Data Services catalog, global service manager run-time status, and pool databases, and reports inconsistencies and errors.
  • validate
    Cross checks the GDS catalog, global service manager run-time status, and databases from the GDS pool and reports any inconsistencies and errors.