Skip Headers
Oracle® Database Global Data Services Concepts and Administration Guide
12c Release 1 (12.1)

E22100-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

A Global Data Services Control Utility (GDSCTL) Reference

This appendix includes a complete reference for the Global Data Services utility (GDSCTL) for Oracle Database.

This appendix includes the following topics:


About GDSCTL

This section contains topics that about using the GDSCTL utility.


GDSCTL Overview

The GDSCTL utility is a command-line interface for configuring and managing the Global Data Services framework. To run some commands, GDSCTL must establish a connection to a global service manager, a Global Data Services catalog database, or a database in the Global Data Services configuration.


Operational Notes

Note:

Unless specified, GDSCTL resolves connect strings with the current name resolution methods (such as TNSNAMES). The exception is the global service manager name. GDSCTL queries the gsm.ora file to resolve the global service manager name.

To start GDSCTL, enter the following command at the operating system prompt:

$ gdsctl

The preceding command starts GDSCTL and displays the GDSCTL command prompt. You can enter GDSCTL commands at either the operating system prompt or the GDSCTL command prompt, as shown in the following examples:

$ gdsctl add gsm -gsm gsm1 -catalog 127.0.0.1:1521:db1

GDSCTL> add gsm -gsm gsm1 -catalog 127.0.0.1:1521:db1

Both of the preceding commands achieve the same result. The first command is run at the operating system command prompt while the second command is run at the GDSCTL command prompt. The command syntax examples in this document use the GDSCTL command prompt.

Notes:

  • Many GDSCTL commands require you to first connect to the Global Data Services catalog before running the command.

    If you run commands from the GDSCTL prompt, then you must execute the connect command before the first GDSCTL command that requires connection to the Global Data Services catalog. The connect command needs only to be run once in a GDSCTL session.

  • A net service name may be specified instead of a connect descriptor when adding a database or broker configuration to a GDS configuration. If a net service name is specified, it must be resolvable at each global service manager in the GDS configuration to a connect descriptor that allows connectivity to the entity that is being added.

Alternatively, you can gather all the GDSCTL commands in one file and run them as a batch with GDSCTL, as follows:

$ gdsctl @script_file_name

The preceding command starts GDSCTL and runs the commands contained in the specified script file.

Using GDSCTL Help

You can display help for GDSCTL, as follows:

  • GDSCTL> help: The help command displays a summary of all GDSCTL commands. If you specify a command name after help, then the help text for that command displays.

  • GDSCTL> command -h: This syntax displays help text for the specified command, where command is the command name.

The following examples display identical help text for the start command:

GDSCTL> help start
GDSCTL> start -h

Privileges and Security

Only users with the proper privileges can run GDSCTL commands.

See Also:

"Overview of Global Data Services Administration" for more information about GDSCTL privileges and security

Special Topic Discussion

GDSCTL Connections

For certain operations GDSCTL must connect to a global service manager. To connect to a global service manager, GDSCTL must be running on the same host as the global service manager. When connecting to a global service manager, GDSCTL looks for the gsm.ora file associated with the local global service manager. Table A-1 lists the GDSCTL operations that require a connection to a global service manager.

Table A-1 Operations That Require a Connection to a Global Service Manager

GSM Operation Description

add gsm

Add a global service manager.

start gsm

Start the global service manager.

stop gsm

Stop the global service manager.

modify gsm

Modify the configuration parameters of the global service manager.

status gsm

Obtain the status of a global service manager.

set inbound_connect_level

Set the INBOUND_CONNECT_LEVEL listener parameter.

set trace_level

Set the trace level for the listener associated with the specified global service manager.

set outbound_connect_level

Set the timeout value for the outbound connections for the listener associated with a specific global service manager.

set log_level

Set the log level for the listener associated with a specific global service manager.


For all other operations, GDSCTL uses Oracle Net Services to connect to the Global Data Services catalog database or another database in the Global Data Services configuration. For these connections you can run GDSCTL from any client or host that has the necessary network configuration.


GDSCTL Reference

GDSCTL Command Syntax and Options

GDSCTL commands, objects, and options; database names, instance names, Global Data Services region names, Global Data Services pool names, and service names are all case insensitive. Passwords and server pool names are also case sensitive. GDSCTL uses the following command syntax:

$ gdsctl command [object] [options] [argument]
or
GDSCTL> command [object] [options] [argument]

In GDSCTL syntax:

  • command: A verb such as add, start, stop, or remove

  • object (also known as a noun): The target or object on which GDSCTL performs the command, such as service or database. You can find a list of objects in Table A-3.

  • options: Optional flags that extend the use of a preceding command combination to include additional parameters for the command. For example, the -gdspool option indicates that the name of a specific Global Data Services pool follows. If a comma-delimited list follows an option, then do not use spaces between the items in the list.

  • argument: Additional variables for the GDSCTL command to specify actions for an object, or to specify actions for GDSCTL without an object.

Table A-2 Summary of GDSCTL Commands

Command Description

add

Add a global service manager, region, database, database pool, invitednode, Oracle Data Guard broker configuration, or service to the Global Data Service management framework.

config

Display the static configuration for databases, database pools, global service managers, services, and valid node checking for registration (VNCR).

configure

Set the GDSCTL parameters.

connect

Specify the credentials to use for the current GDSCTL session.

create catalog

Create a Global Data Services catalog in a specified database.

delete catalog

Delete a Global Data Services catalog.

disable service

Disable a global service.

enable service

Enable a global service.

modify

Modify catalog, databases, database pools, regions, or services.

relocate service

Move a global service from one database to another.

remove

Remove global service managers, regions, databases, database pools, invitednode, services, or Oracle Data Guard broker configurations.

services

Display information about the services registered with a specific global service manager.

set

Set the current global service manager for the current session and sets various run-time parameters of the local global service manager.

start

Start a global service manager or global services.

status

Show status of global service managers, regions, databases, database pools, or services.

stop

Stop a global service manager or global services.

sync brokerconfig

Synchronize the Oracle Data Guard broker configuration in the global service manager with the configuration in the database pool.

sync database on page

Bring attributes of global services and GDS related parameters of a pool database in synchronization with the contents of the GDS catalog.

validate catalog

Cross check the Global Data Services catalog, global service manager run-time status, and pool databases, and reports any inconsistencies and errors.


GDSCTL Objects Summary

Table A-3 lists the keywords that you can use for the object portion of GDSCTL commands. You can use either the full name or the abbreviation for each object keyword. The Purpose column describes the object and the actions that can be performed on that object.

Table A-3 Object Keywords and Abbreviations for GDSCTL

Object Keyword (Abbreviations) Purpose

Global Data Services catalog

autovncr

Enables or disables valid node checking for registration (VNCR) list for database registration

Oracle Data Guard broker configuration

brokerconfig

To add, modify, and manage the Oracle Data Guard broker configuration. The Oracle Data Guard broker logically groups primary and standby databases into a broker configuration that enables the broker to manage and monitor them together as an integrated unit.

Global Data Services catalog

catalog

To manage the Global Data Services catalog stored in an Oracle database.

Database

database

To add, modify, and remove database configuration information about databases.

Global Data Services pool

gdspool

To add, modify, and manage a Global Data Services pool. A Global Data Services pool is a set of databases within a GDS configuration that provides a unique set of global services and belongs to a certain administrative domain.

Global service manager

gsm

To add, modify, and manage a global service manager. A global service manager is a software component that provides service-level load balancing and centralized management of services within the Global Data Services configuration.

Global Data Services catalog

invitednode

Adds host address information to the valid node checking for registration (VNCR) list in the Global Data Services catalog.

Global Data Services catalog

invitedsubnet

Adds subnet information to the valid node checking for registration (VNCR) list in the Global Data Services catalog

Global Data Services Region

region

To add, modify, and manage a Global Data Services Region, which is a logical boundary that contains database clients and servers that are considered to be geographically close to each other.

Service

service

To add, modify, list the configuration of, enable, disable, start, stop, obtain the status of, relocate, and remove global services.



add

The gdsctl add command adds elements to the global service manager configuration. Table A-4 describes the add command variations.

Table A-4 gdsctl add command Summary

Command Description

add brokerconfig

Adds an Oracle Data Guard configuration to a Global Data Services pool

add database

Adds a database to a Global Data Services region or Global Data Services pool

add gdspool

Adds a Global Data Services pool to the configuration and optionally configures pool administrator users

add gsm

Adds a global service manager to the configuration

add invitednode (add invitedsubnet)

Adds a host or IP address to a VNCR list in the Global Data Services catalog

add region

Adds a Global Data Services region to the configuration

add service

Adds a global service to the configuration


add brokerconfig

Adds an Oracle Data Guard broker configuration to a Global Data Services pool.

Syntax and Options

Use the gdsctl add brokerconfig command with the following syntax:

add brokerconfig [-gdspool gdspool_name] -connect connect_identifier 
    [-region region_name] [-pwd password] [-savename]

Table A-5 gdsctl add brokerconfig Options

Option Description
-gdspool gdspool_name

The pool to which the databases of the Oracle Data Guard broker configuration are to be added.

If the specified Global Data Services pool already contains databases or another configuration, GDSCTL returns an error.

-connect connect_identifier

Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor.

-region region_name

The Global Data Services region to which the databases belong. If you specify a region, then all the databases are added to that region. If you do not specify a region, then all databases are added with a region of UNASSIGNED. If the region is UNASSIGNED, then you must use the modify database command to change the region.

-pwd password

The password for the GSMUSER. If -pwd is not specified, then you are prompted for the password.

-savename

Specify this option to store a net service name specified with the -connect option in the Global Data Services catalog, rather than the connect descriptor mapped to that net service name.


Usage Notes

  • You must connect to the Global Data Services catalog database as a user with the pool administrator privileges, using the connect command before running this command

Examples

Add the Oracle Data Guard broker configuration for the DB1 database to the Global Data Services pool MYREADERFARM and the WEST region.

GDSCTL> add brokerconfig -connect 192.168.1.1:1521:sid -region west -gdspool myreaderfarm

Exceptions or Error Codes

GDSCTL returns the errors listed in Table A-6 if you use this command incorrectly.

Table A-6 gdsctl add brokerconfig Exceptions or Error Codes

Exception Description

ERROR-44866

A pool can only contain one Data Guard broker configuration. If a Global Data Services pool already contains an Oracle Data Guard broker configuration, then GDSCTL returns error 44866 because a database must be added using Oracle Data Guard in this case.


add database

Adds databases to a Global Data Services region and Global Data Services pool.

Syntax and Options

Use the gdsctl add database command with the following syntax:

add database -connect connect_identifier -[region region_name]
    [-gdspool gdspool_name] [-pwd password] [-savename]

Table A-7 gdsctl add database Options

Option Description
-connect connect_identifier

Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor.

-region region_name

The Global Data Services region to which the database belongs.

-gdspool gdspool_name

The Global Data Services pool to which the database belongs.

-pwd password

The password for the GSMUSER. If -pwd is not specified, then 6you are prompted for the password.

-savename

Specify this option to store a net service name specified with the -connect option in the Global Data Services catalog, rather than the connect descriptor mapped to that net service name.


Usage Notes

  • You must connect to the Global Data Services catalog database as a user with the pool administrator privileges, using the connect command before running this command.

  • If -savename is not specified, then GDSCTL replaces what you specify for the net service name with the full connection string before saving the configuration to the catalog.

  • The default for GDSCTL is for autovncr to be enabled for the catalog. If autovncr has been disabled for the catalog, before configuring Global Data Services pools and adding databases to the Global Data Services configuration, the nodes where those databases run must be part of the valid node checking for registration (VNCR) list for database registration. Use the add invitednode (add invitedsubnet) command to define the valid nodes.

Example

Adds database DB1 to the WEST region and Global Data Services pool MYREADERFARM.

GDSCTL> add database -connect 127.0.0.1:1521:db1 -region west -gdspool
   myreaderfarm

Adds a database using myalias instead of the IP address connection string.

GDSCTL> add database -connect myalias -gdspool myreaderfarm

Exceptions or Error Codes

GDSCTL returns the errors listed in Table A-8 if you use this command incorrectly.

Table A-8 gdsctl add database Exceptions or Error Codes

Exception Description

ERROR-44866

If a pool already contains an Oracle Data Guard broker configuration, then GDSCTL returns an error; you must add databases using Oracle Data Guard in this case. That is, if a pool contains an Oracle Data Guard broker configuration, then additional databases can only be added to the pool by adding them to that DG broker configuration.

ERROR-44868

If the database being added is part of a Oracle Data Guard broker configuration, then GDSCTL returns an error; you must use the add brokerconfig command in this case.


add gdspool

Adds a Global Data Services pool to the Global Data Services framework. When the Global Data Services catalog is created, a default pool named DBPOOLORA is created, automatically.

Syntax and Options

Use the gdsctl add gdspool command with the following syntax:

add gdspool -gdspool database_pool_list [-users user_list]

Table A-9 gdsctl add gdspool Options

Option Description
-gdspool database_pool_list

A comma-delimited list of Global Data Services pool names.

A Global Data Services pool must have a unique name within its GDS configuration. If you do not specify a name for the pool when you create it, then the name defaults to oradbpool. The pool name can be up to 30 bytes long and can be any valid identifier (an alphabetical character followed by zero or more alphanumeric ASCII characters or the underscore (_)).

-users user_list

A comma-delimited list of users that are granted the pool administrator role.


Usage Notes

  • You must connect to the Global Data Services catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.

  • The default for GDSCTL is for autovncr to be enabled for the catalog. If autovncr has been disabled for the catalog, then before configuring Global Data Services pools and adding databases to the Global Data Services configuration, the nodes where those databases run must be part of the valid node checking for registration (VNCR) list for database registration. Use the add invitednode (add invitedsubnet) command to define the valid nodes.

Example

Add a Global Data Services pool named MYREADERFARM to the configuration:

GDSCTL> add gdspool -gdspool myreaderfarm

add gsm

Adds a global service manager to the Global Data Services framework. You must specify the Global Data Services catalog database when using this command.

Syntax and Options

Use the gdsctl add gsm command with the following syntax:

add gsm -gsm gsm_name -catalog connect_id [-pwd password] [-wpwd password]
   [-region region_name] [-localons ons_port] [-remoteons ons_port]
   [-listener listener_port] [-endpoint gmsendpoint]
   [-remote_endpoint remote_endpoint] [-trace_level level]

Table A-10 gdsctl add gsm Options

Option Description
-gsm gsm_name

Specify the name of the global service manager that you want to add. If you do not specify a name, then GDSCTL uses the current global service manager name for the session (specified with the set gsm command).

-catalog connect_id

Specify the connect identifier for the Global Data Services catalog database. If a network service name is specified, it must be resolvable by the local naming method to a connect descriptor that allows the global service manager being added to connect to the catalog database.

-pwd password

Specify the password for a user with the Global Data Services administrator role. If you do not specify a password, then you are prompted to enter one.

-wpwd password

If specified, then the PKCS #12 wallet is password protected, and it is not possible to modify the wallet's content without providing the password.

-region region_name

Specify the region to which the global service manager belongs. The value for region_name must match the name of an existing Global Data Services region. If you do not specify a region, then GDSCTL adds the global service manager without assigning a region.

-localons ons_port

Specify the local ONS port. If you do not specify this option, then GDSCTL uses the default ONS port (which is 6123 on most platforms).

-remoteons ons_port

Specify the remote ONS port. If you do not specify this option, then GDSCTL uses the default ONS port (which is 6234 on most platforms).

-listener listener_port

Specify the listener port. The default port is 1522.

-endpoint gsmendpoint

Specifies the protocol address that the global services manager listens on for client connection requests. If you use this option, the value that you specify overrides the default endpoint.

-remote_endpoint remote_endpoint

Specifies the protocol address that is used by the global service manager to receive database registration requests and communicate with other global service managers in the configuration. If you use this option, the value that you specify overrides the default endpoint.

-trace_level level

Specify the global service manager trace level (to be used as directed by Oracle Support Services).


Usage Notes

  • You must run this command, locally, on the computer where you want to add the global service manager.

  • You must have operating system privileges on the computer where you want to add the global service manager to run this command.

  • When you run this command, GDSCTL connects to the Global Data Services catalog as the GSMCATUSER user and prompts you for the GSMCATUSER password.

Example

Add a global service manager named gsm1, specifying the location of the Global Data Services catalog database, DB1.

GDSCTL> add gsm -gsm gsm1 -catalog 127.0.0.1:1521:db1

add invitednode (add invitedsubnet)

Adds host address or subnet information to the valid node checking for registration (VNCR) list in the catalog. This command enables you to add a host or a subnet to the VNCR list before starting the first global service manager (by establishing a direct connection to the Global Data Services catalog database).

VNCR enables or denies access from specified IP addresses to Oracle services. See Oracle Database Net Services Administrator's Guide for more information about VNCR.

Syntax and Options

Use the gdsctl add invitednode command with the following syntax:

add {invitednode | invitedsubnet} [-group group_name] 
   [-catalog catalog_dbname [-user user_name/password]] vncr_id

Table A-11 gdsctl add invitednode Options

Option Description
-group group_name

Specify an alias which defines a group of invited nodes. This alias can be referenced in other commands related to invited nodes.

-catalog catalog_dbname

Specify the Global Data Services catalog database net alias or connect string. If you enter an invalid address or connect string, then GDSCTL uses the pre-established connection created with the connect command.

-user user_name[/password]

Specify the user credentials for the Global Data Services administrator in the catalog database. If you do not specify a user or a password, then GDSCTL prompts you this information.

vncr_id

Specify the list of nodes that can register with the global service manager. The list can include host names or CIDR notation for IPv4 and IPv6 addresses. The wildcard format (*) is supported for IPv4 addresses. The presence of a host name in the list results in the inclusion of all IP addresses mapped to the host name. The host name should be consistent with the public network interface.


Usage Notes

  • You must connect to the Global Data Services catalog database as a user with the pool administrator privileges, using the connect command before running this command.

  • The default for GDSCTL is that autovncr is enabled for the catalog. If autovncr has been disabled for the catalog, before configuring Global Data Services pools and adding databases to the Global Data Services configuration, then the nodes where those databases run must be part of the valid node checking for registration (VNCR) list for database registration. Use the add invitednode (add invitedsubnet) command to define the valid nodes.

Examples

Add the netmask 255.255.255.248 to the catalog.

GDSCTL> add invitednode 255.255.255.248 

Add the server east1.example.com to the catalog in the alias group EAST_SRV.

GDSCTL> add invitednode east1.example.com

Add the server east2.example.com to the catalog in the alias group EAST_SRV.

GDSCTL> add invitednode east2.example.com

add region

Adds a Global Data Services region to the Global Data Services framework. When the Global Data Services catalog is created, the REGIONORA region is created automatically.

Syntax and Options

Use the gdsctl add region command with the following syntax:

add region -region region_list [-buddy region_name]

Table A-12 gdsctl add region Options

Option Description
-region region_list

Specify a comma-delimited list of Global Data Services region names.

A Global Data Services region should have a name that is unique within the corresponding Global Data Services configuration. If no name is specified at the first region creation time, the default name, oraregion, is given to the region. The region name can be up to 30 characters long and can be any valid identifier - an alphabetical character followed by zero or more alphanumeric ASCII characters or '_'.

-buddy region_name

Specify the name of the buddy region.


Usage Notes

  • You must connect to the Global Data Services catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command

Example

Add two Global Data Services regions, EAST and WEST to the current configuration:

GDSCTL> add region -region east,west

add service

Add a global service to a Global Data Services pool.

Syntax and Options

Use the gdsctl add service command with the following syntax:

add service [-gdspool gdspool_name] -service service_name
   {-preferred_all | -preferred dbname_list [-available dbname_list] }
   [-locality {ANYWHERE | LOCAL_ONLY [-region_failover]}]
   [-role {PRIMARY | PHYSICAL_STANDBY [-failover_primary] | LOGICAL_STANDBY
      | SNAPSHOT_STANDBY}] [-lag {lag_value | ANY}]
   [-notification {TRUE | FALSE}] [-rlbgoal {SERVICE_TIME | THROUGHPUT}]
   [-dtp {TRUE | FALSE}] [-sql_translation_profile stp_name] 
   [-clbgoal {SHORT | LONG}] [-tafpolicy {BASIC | NONE | PRECONNECT}]
   [-policy policy] [-failovertype {NONE | SESSION | SELECT | TRANSACTION}]
   [-failovermethod {NONE | BASIC}] [-failoverretry failover_retries]
   [-failoverdelay failover_delay] [-edition edition_name] 
   [-commit_outcome {TRUE | FALSE}] [-retention retention_seconds]
   [-session_state {DYNAMIC | STATIC}] 
   [-replay_init_time replay_init_time] [-pdbname pdbname]

Table A-13 gdsctl add service Options

Option Description
-gdspool gdspool_name

Specify the name of the Global Data Services pool to which you want to add a service. If the pool name is not specified and there is only one gdspool with access granted to the user, then this the gdspool with access granted is used as the default gdspool.

-service service_name

Specify the name of the global service.

The service name specified in the add service command can be domain qualified (for example, sales.example.com) or not (for example, sales). If the specified name is not domain qualified, the service is created with the default domain name <GDS_pool_name>.<GDS_configuration_name>, however the shorter non-domain qualified name can be used with subsequent gdsctl commands to manage the service. If the specified name is domain qualified, the full domain qualified service name must be used in all subsequent gdsctl commands used to manage the service.

A global service name must be unique within a GDS pool and when qualified by domain, must also be unique within a GDS configuration. A global service cannot be created at a database if a local or global service with the same name already exists at that database.

A global service name can contain alphanumeric characters, underscore (_), and period (.). The first character must be alphanumeric. The maximum length of a global service name is 64 characters. The maximum length of a domain qualified global service name is 250 characters.

An Oracle Net connect descriptor used to connect to a global service must contain a domain qualified service name.

-preferred_all

Specifies that all the databases in the Global Data Services pool are preferred databases. Any databases you later add to the pool are configured as preferred databases for this service.

You cannot use this option with the -preferred and -available options.

-preferred dbname_list

Specify a comma-delimited list of preferred databases on which the service runs. You cannot specify preferred instances, only databases. You can use the modify service command to specify instance-level preferences.

The list of preferred databases must be mutually exclusive with the list of available databases.

You cannot use this option with the -preferred_all option.

-available dbname_list

Specify a comma-delimited list of available databases on which the service runs if the preferred databases are not available. You cannot specify a list of available instances, only databases. You can use the modify service command with the -server_pool parameter to specify instance-level preferences.

The list of available databases must be mutually exclusive with the list of preferred databases.

You cannot use this option with the -preferred_all option.

-locality {ANYWHERE | LOCAL_ONLY}

Specify the service region locality. If you do not specify this option, then GDSCTL uses the default value of ANYWHERE for the service.

-region_failover

Indicates that the service is enabled for region failover. You can only use this option when you specify LOCAL_ONLY for the -locality option.

-role {[PRIMARY] | [PHYSICAL_STANDBY] [-failover_primary] |[LOGICAL_STANDBY] |[SNAPSHOT_STANDBY]}

Specify the database role that the database must be for this service to start on that database. This applies only to Global Data Services pools that contain an Oracle Data Guard broker configuration.

See Also: Oracle Data Guard Concepts and Administration for more information about database roles

-failover_primary

If you set the -role option to PHYSICAL_STANDBY, then you can use this option to enable the service for failover to the primary database.

-lag {lag_value | ANY}

Specify the lag for the service in seconds. You can use the keyword ANY to indicate that there is no upper threshold on the lag time. This parameter specifies the maximum lag that a provider of this service may have. The service cannot be provided by a database whose lag exceeds this value.

The default value for lag is ANY.

-rlbgoal {SERVICE_TIME | THROUGHPUT}

Run-time Load Balancing Goal (for the Load Balancing Advisory). Set this parameter to SERVICE_TIME to balance connections by response time. Set this parameter to THROUGHPUT to balance connections by throughput.

If you do not use this option, then the value defaults to SERVICE_TIME for the run-time load balancing goal.

-dtp {TRUE | FALSE}

Indicates whether Distributed Transaction Processing should be enabled for this service. This service can either be a singleton service in a policy-managed database or a preferred service on a single node in an administrator-managed database.

-sql_translation_profile stp_name

Use this option to specify a SQL translation profile for a service that you are adding after you have migrated applications from a non-Oracle database to an Oracle database.

This option corresponds to the SQL translation profile parameter in the DBMS_SERVICE service attribute.

Notes:

  • Before using the SQL translation feature, you must migrate all server-side application objects and data to the Oracle database.

  • Use the config service command to display the SQL translation profile.

See Also: Oracle Database Migration Guide for more information about SQL translation

-clbgoal {SHORT | LONG}

Connection Load Balancing Goal. Use a value of SHORT for this parameter for run-time load balancing, or if using an integrated connection pool. Use a value of LONG for this parameter for long running connections, such as batch jobs, that you want balanced by the number of sessions for each node for the service.

The default value for this option is SHORT.

-tafpolicy {BASIC | NONE }

TAF policy specification (for administrator-managed databases only).

-notification {TRUE | FALSE}

Enable Fast Application Notification (FAN) for OCI connections.

-policy {AUTOMATIC | MANUAL}

Specify the management policy for the service.

If you specify AUTOMATIC (the default), then the service automatically starts when the database restarts, either by a planned restart or after a failure. Automatic restart is also subject to the service role.

If you specify MANUAL, then the service is never automatically restarted upon planned restart of the database. A MANUAL setting does not prevent the global service manager from monitoring the service when it is running and restarting it if a failure occurs.

-failovertype {NONE | SESSION | SELECT | TRANSACTION}

Specify the failover type.

To enable Application Continuity for Java, set this parameter to TRANSACTION. To enable Transparent Application Failover (TAF) for OCI, set this parameter to SELECT or SESSION.

-failovermethod {NONE | BASIC}

TAF failover method (for backward compatibility only).

If the failover type (-failovertype) is set to a value other than NONE, then you should choose BASIC for this parameter.

-failoverretry failover_retries

For Application Continuity and TAF, this parameter determines the number of attempts to connect after an incident.

-failoverdelay failover_delay

For Application Continuity and TAF, this parameter specifies the time delay (in seconds) between reconnect attempts for each incident at failover.

-edition edition_name

Specify the initial session edition of the service.

When an edition is specified for a service, all subsequent connections that specify the service use this edition as the initial session edition. However, if a session connection specifies a different edition, then the edition specified in the session connection is used for the initial session edition.

GDSCTL does not validate the specified edition name. During connection, the connect user must have USE privilege on the specified edition. If the edition does not exist or if the connect user does not have USE privilege on the specified edition, then an error is raised.

-commit_outcome {TRUE | FALSE}

Enable Transaction Guard; when set to TRUE, the commit outcome for a transaction is accessible after the transaction's session fails due to a recoverable outage.

-retention retention_seconds

If commit_outcome is set to TRUE, then this parameter determines the amount of time (in seconds) that the commit outcome is retained in the database.

-session_state 
{DYNAMIC | STATIC}

For Application Continuity, this parameter specifies whether the session state that is not transactional is changed by the application. A setting of DYNAMIC is recommended for most applications.

-replay_init_time replay_init_time

For Application Continuity, this parameter specifies the time (in seconds) after which replay cannot be initiated. The default value is 300 seconds.

-pdbname pdb_name

Specify the pluggable database name.


Examples

Add a service named sales_report to the Global Data Services pool MYREADERFARM with a value of ANYWHERE for the locality.

GDSCTL> add service -gdspool myreaderfarm -service sales_report -locality ANYWHERE

Add a service named daily_sales_rept to the Global Data Services pool MYDGPOOL with preferred instance set to DB1 and the available instances set to DB3 and DB4. The service should use the basic transaction failover policy.

GDSCTL> add service -gdspool mydgpool -s daily_sales_rept -preferred db1 
  -available db3,db4 -tafpolicy BASIC

config

The gdsctl config command displays the static configuration of the specified component or set of components. This configuration data is retrieved from the catalog database. You can also use this command with no options to display the configuration data for all components defined for the configuration. When using the config command, it does not matter if the components (except for the catalog database) are started.

Table A-14 gdsctl config Summary

Command Description

config database

Displays the static configuration data for the specified database.

config gdspool

Displays the static configuration data for the specified database pool.

config gsm

Displays the static configuration data for the specified global service manager.

config region

Displays the static configuration data for the specified region.

config service

Displays the static configuration data for the specified region.

config vncr

Displays the VNCR configuration data for the specified global service manager.


config database

Displays the static configuration data stored in the catalog for the specified database.

Syntax and Options

Use the gdsctl config database command with the following syntax:

config database [-database db_name]

Table A-15 gdsctl config database Options

Syntax Description
-database db_name

Specify the name of a database. If you do not specify a database name, then GDSCTL displays the configuration data for all databases in the Global Data Services configuration.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Examples

Display the static configuration data stored in the catalog for all the databases in the Global Data Services configuration.

GDSCTL>config database

The gdsctl config database command returns information similar to the following:

Name     Pool     Status     Region
----     ----     ------     ------
dbcat    sales    Ok         east
dbcat1   sales    Ok         west
dbcat3   sales    Ok         west

config gdspool

Displays the static configuration data that is stored in the catalog for the specified database pool.

Syntax and Options

Use the gdsctl config gdspool command with the following syntax:

config gdspool [-gdspool gdspool_name]

Table A-16 gdsctl config gdspool Options

Syntax Description
-gdspool gdspool_name

Specify the name of a database pool. If you do not specify a database pool name, then GDSCTL displays the configuration data for all database pools.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Display the static configuration data stored in the catalog for all Global Data Services pools.

GDSCTL>config gdspool

The gdsctl config gdspool command returns output similar to the following:

Name          Broker
----          ------ 
dbpoolora     No 
mkt           No 
sales         No 
marketing     No 

The following command shows the configuration detail of Global Data Services pool marketing.

GDSCTL>config gdspool -gdspool marketing

The above example returns output similar to the following:

GDS Pool administrators
------------------------
 
Databases
------------------------
dbcat2                         
dbcat1                         
dbcat3                         
 
 
Services
------------------------
sales_report                 
sales_analysis                 
sales_estimation                 
sales_peragent                 
sales_global

config gsm

Displays the static configuration data stored in the catalog for the specified global service manager.

Syntax and Options

Use the gdsctl config gsm command with the following syntax:

config gsm [-gsm gsm_name]

Table A-17 gdsctl config gsm Options

Syntax Description
-gsm gsm_name

Specify the name of a global service manager. If you do not specify a global service manager name, then GDSCTL displays the static configuration data for all global service managers in the cloud.


Usage Notes

  • You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command

Example

Display the static configuration data stored in the catalog for the global service manager mygsm:

GDSCTL>config gsm -gsm mygsm

The gdsctl config gsm command returns information similar to the following:

Name: mygsm
Endpoint 1: (ADDRESS=(HOST=stcal.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
Endpoint 2: (ADDRESS=(HOST=stcal.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
Local ONS port: 6123
Remote ONS port: 6234
Region: east
Buddy
------------------------

config region

Displays the static configuration data for the specified region.

Syntax and Options

Use the gdsctl config region command with the following syntax:

config region [-region gsm_name]

Table A-18 gdsctl config region Options

Syntax Description
-region gsm_name

Specify the name of a global service manager.


Example

Displays the static configuration data for the specified region.

GDSCTL>config region -region eastcoast

Displays the following output:

Databases
------------------------
debug
msvc4
 
GSM
------------------------
mygsm

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.

Syntax and Options

Use the gdsctl config service command with the following syntax:

config service [-gdspool gdspool_name] [-service service_name]

Table A-19 gdsctl config service Options

Syntax Description
-gdspool gdspool_name

Specify the name of the database pool that contains the services. If the name is not specified, and there is only one gdspool with access granted to the user, it is used as the default gdspool.

-service service_name

Specify a comma-delimited list of service names. If you do not use this option, then GDSCTL displays the configuration data for all services in the specified database pool.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Show all the services in the user's Global Data Services pool:

GDSCTL>config service 

The gdsctl config service command returns information similar to the following:

Name        Network name                  Pool     Started Preferred all
----        ------- ----                  ----     ------- --------- ---
sales_svc1  sales_svc1.sales.oradbcloud   sales    Yes     Yes          
sales_svc2  sales_svc2.sales.oradbcloud   sales    NO      Yes          
sales_svc3  sales_svc3.sales.oradbcloud   sales    Yes     Yes          
mkt_svc1    mkt_svc1.mkt.oradbcloud       mkt      NO     Yes          

Display the static configuration data stored in the Global Data Services catalog for sales_svc1:

GDSCTL>config service -service sales_svc1

returns:

Name: sales_svc1
Network name: sales_svc1.sales.oradbcloud
Pool: sales
Started: Yes
Preferred all: Yes
Locality: ANYWHERE
Region Failover: No
Role: NONE
Primary Failover: No
Lag: ANY
Runtime Balance: SERVICE_TIME
Connection Balance: SHORT
Notification: Yes
TAF Policy: NONE
Policy: AUTOMATIC
DTP: No
Failover Method: NONE
Failover Type: NONE
Failover Retries: 
Failover Delay: 
Edition: 
PDB: 
Commit Outcome: 
Retention Timeout: 
Replay Initiation Timeout: 
Session State Consistency: 
SQL Translation Profile: 
 
 
Supported services
------------------------
Database            Preferred Status    
--------            --------- ------    
dbcat2              Yes       Enabled   
dbcat1              Yes       Enabled   
dbcat3              Yes       Enabled   

config vncr

Displays the static configuration data stored in the catalog for valid node checking for registration (VNCR).

Syntax and Options

Use the gdsctl config vncr command with the following syntax:

config vncr [-group gsm_name]

Table A-20 gdsctl config invitednode Options

Syntax Description
-group gsm_name

Specify the name of a global service manager.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Displays the list of hosts in the VNCR list:

GDSCTL>config vncr

The gdsctl config vncr command returns information similar to the following:

Name         Group           ID
----         -----           --
example      
22.231.113.64   
example.com

configure

The gdsctl configure command sets the GDSCTL parameters.

Syntax and Options

Use the gdsctl configure command with the following syntax:

configure [-gsmport port] [-timeout seconds] [-show] [-driver {THIN | OCI}] 
    [-resolve {IP | HOSTNAME | QUAL_HOSTNAME}] 
    [-log {ALL|OFF|INFO|FINE|FINER|FINEST|SEVERE|WARNING}] [-log_file log_file] 
    [-gsm gsm_name]

Table A-21 gdsctl configure Options

Syntax Description
-gsmport port

Default global service manager port.

-timeout seconds

Global service manager requests timeout in seconds.

-show

Show the configuration.

-driver THIN | OCI

Oracle JDBC driver.

-resolve IP | HOSTNAME| 
   QUAL_HOSTNAME

Default host resolution for global service manager endpoint.

-log {ALL | OFF | INFO | FINE |
   FINER | FINEST | SEVERE |
   WARNING}

Set the logging level. The default is OFF.

-log_file log_file

Set the location of the log file. The default is $TNS_ADMIN/GDSTL.log.

-gsm gsm_name

Set current global service manager.


Example

Set the mygsm driver to OCI:

configure -driver OCI mygsm

connect

The gdsctl connect command specifies the credentials to administer a global service management environment. Credentials must be specified to perform certain operations using GDSCTL.

Syntax and Options

Use the gdsctl connect command with the following syntax:

connect [user_name[/password]]@connect_identifier

Table A-22 gdsctl connect Options

Syntax Description
user_name

Specify the name of the user to connect as. The user that you specify must have either the Global Data Services administrator or the pool administrator role. If you specify no user name, then you are prompted for a user name.

password

Specify the password for the specified user. If you do not specify a password, then you are prompted to enter a password. The password is obscured when entered.

connect_identifier

Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor.


Usage Notes

  • You must connect to the catalog database as a user with either the Global Data Services administrator or the pool administrator privileges, depending on which command you want to run after you connect

    WARNING:

    Specifying a password as a connect command option is a security risk. You can avoid this risk by omitting the password, and entering it only when the system prompts for it.

Examples

Connect as the gsmadmin user to the private cloud:

GDSCTL> connect gsmadmin/gsmadmin_password@mycloud

Connect as the gsmadmin user to the private cloud without specifying the password:

GDSCTL> connect gsmadmin@mycloud
Enter password: 

Connect using a connect descriptor, without specifying a username and password:

GDSCTL> connect (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=myhost)(PORT=1521)))
Enter username: 

create catalog

The gdsctl create catalog command creates a Global Data Services catalog for global service management in a specific database.

Syntax and Options

Use the gdsctl create catalog command with the following syntax:

create catalog -database connect_id [-user user_name[/password] [-region region_list]
    [-gdspool gdspool_list] [-configname config_name] [-autovncr {ON | OFF}]

Table A-23 gdsctl create catalog Options

Syntax Description
-database connect_id

Specify the connect identifier for the database in which you want to create catalog.

-user user_name[/password]

Specify a user (and optionally, the password) that has the Global Data Services administrator privileges on the catalog database. If you do not use this option, then GDSCTL prompts you for the name and the password of a user with Global Data Services administrator privileges. If you specify a user name but not the password for the user, then GDSCTL prompts you for the password.

-region region_list

Specify a comma-delimited list of region names. This command creates each region and adds the regions to the catalog. If you do not specify a region, then a default region named REGIONORA is created.

-gdspool gdspool_list

Specify a comma-delimited list of database pool names. When you use this option, the specified database pools are created as part of the catalog creation. If you do not specify this option, then GDSCTL creates a default database pool named DBPOOLORA.

-configname config_name

Specify the name of the GDS configuration. The default configuration name is ORADBCLOUD.

The configuration name can be up to 32 bytes long and can contain an alphabetical character followed by zero or more alphanumeric ASCII characters, '_', or '#' and possibly separated by periods if there are multiple identifiers.

-autovncr {ON | OFF}

This option enables (ON) or disables (OFF) autovncr mode. The default value is ON.


Usage Notes

  • You must have the Global Data Services administrator privileges on the computer where you want to create the Global Data Services catalog

Example

Create a Global Data Services catalog for global service management in the database named DB1. Also create the regions EAST and WEST, and the database pool READERFARM.

GDSCTL> create catalog -database db1 -region west,east -gdspool readerfarm

delete catalog

The gdsctl delete catalog command deletes the Global Data Services catalog.

Syntax and Options

Use the gdsctl delete catalog command with the following syntax:

delete catalog [-connect connect_identifier]

Table A-24 gdsctl delete catalog Options

Syntax Description
-connect connect_identifier

Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor.

If you do not use this option, then GDSCTL deletes the Global Data Services catalog that is used by the global service manager associated with the current session.


Usage Notes

  • You must have the Global Data Services administrator privileges on the computer where the database resides from which you want to delete the Global Data Services catalog

Example

Delete the Global Data Services catalog located in the database named DB1.

GDSCTL> delete catalog -connect db1.example.com

disable service

The gdsctl disable service command disables specified services. The specified services are also stopped.

Syntax and Options

Use the gdsctl disable service command with the following syntax:

disable service [-gdspool gdspool_name] [ -service service_name_list]
   -database db_name

Table A-25 gdsctl disable service Options

Syntax Description
-gdspool gdspool_name

Specify the database pool in which the services are located. If not specified and there is only one gdspool with access granted to the user, then this one is used as the default gdspool.

-service service_name_list

Specify a comma-delimited list of global service names. If you do not use -service to specify an individual global service or to specify a list of global services, then all the services in the database pool are disabled.

-database db_name

Specify the name of the database on which to the service is located. If you do not specify this option, then the service is disabled, globally.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Disable and stop the service G_SALES_REPORT on all databases in the database pool READERFARM.

GDSCTL> disable service -gdspool readerfarm -service g_sales_report

enable service

The gdsctl enable service command enables the specified services. If the cardinality for a service has not been reached, then this command also starts that service.

Syntax and Options

Use the gdsctl enable service command with the following syntax:

enable service [-gdspool gdspool_name] [-service service_name] -database db_name

Table A-26 gdsctl enable service Options

Syntax Description
-gdspool gdspool_name

Specify the database pool in which the services are located. If not specified and there is only one gdspool with access granted to the user, it is used as the default gdspool.

-service service_name

Specify a comma-delimited list of global service names. If you do not use -service to specify an individual global service or to specify a list of global services, then all the services in the database pool are disabled.

-database db_name

Specify the name of the database on which the service is located. If you do not specify this option, then the service is enabled globally.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Enable the service G_SALES_REPORT on the database DB1 in the database pool READERFARM.

GDSCTL> enable service -gdspool readerfarm -service g_sales_report -database  db1

modify

The gdsctl modify command changes the configuration parameters for components in the global service manager configuration.

Table A-27 gdsctl modify Summary

Command Description

modify catalog

Modifies the catalog attributes.

modify database

Modifies the configuration parameters of the databases

modify gdspool

Add or remove a user from the list of database pool administrators

modify gsm

Modifies the configuration options for a global service manager

modify region

Modifies the regions currently defined for the global service management framework

modify service

Modifies the preferred or available databases for a service, or other service attributes


modify catalog

The gdsctl modify catalog command modifies the properties of the global service manager catalog. To use this command, there must be a least one global service manager running and a connection with the catalog database must have already been established (see the connect command).

Syntax and Options

Use the gdsctl modify catalog command with the following syntax:

modify catalog [-autovncr {ON | OFF}]

Table A-28 gdsctl modify catalog Options

Syntax Description
-autovncr {ON | OFF}

This option enables (ON) or disables (OFF) autovncr mode. The default value is ON.


Usage Notes

  • You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command

Example

Turn off autovncr mode for the catalog database.

connect gsmadmin@mycloud 
GDSCTL> modify catalog -autovcnr off

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. For all parameters except for the GDS region, first the appropriate changes must be done by the database administrator and then the modify database command must be run to update the modified parameters in the GDS catalog. Alternatively, you can use the sync database command for this purpose.

Syntax and Options

Use the gdsctl modify database command with the following syntax:

modify database -database dbname_list [-region region_name]
    [-gdspool gdspool_name] [-connect connect_identifier] [-pwd password]
    [-scan scan_address [-ons port]] [-savename]

Table A-29 gdsctl modify database Options

Option Description
-database dbname_list

Specify a comma-delimited list of database names.

-region region_name

Specify the region to which the databases belong.

-gdspool gdspool_name

Specify the database pool to which the databases belong.

-connect connect_identifier

Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor.

-pwd password

Specify the password for the GSMUSER.

-scan scan_address

Specify the SCAN address for a cluster.

-ons port

Specify the ONS port.

-savename

Specify this option to store a net service name specified with the -connect option in the Global Data Services catalog, rather than the connect descriptor mapped to that net service name.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Change the region of databases DB1 and DB3 to EAST.

GDSCTL> modify database -database db1,db3 -region east

modify gdspool

Adds and removes users from the list of pool administrators for one or more database pools.

Syntax and Options

Use the gdsctl modify gdspool command with the following syntax:

modify gdspool -gdspool database_pool_list 
   {-removeuser user_name | -adduser user_name}

Table A-30 gdsctl modify gdspool Options

Option Description
-gdspool database_pool_list

Specify a comma-delimited list of database pool names.

-removeuser user_name

Specify the user to remove from the list of database pool administrators. This option revokes the pool administrator role from the specified user.

-adduser user_name

Specify the user to add to the list of database pool administrators. This option grants the pool administrator role to the specified user.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Add PETER to the list of database pool administrators for the pool MYREADERFARM:

GDSCTL> modify gdspool -gdspool myreaderfarm -adduser peter

modify gsm

Modifies the configuration parameters of the global service manager. The changes take effect after the global service manager is restarted.

Syntax and Options

Use the gdsctl modify gsm command with the following syntax:

modify gsm -gsm gsm_name [-catalog catalogdb_name [-pwd password]]
    [-region region_name] [-localons ons_port] [-remoteons ons_port]
    [-endpoint gmsendpoint [-remote_endpoint remote_endpoint]]
    [-listener listener_port]

Table A-31 gdsctl modify gsm Options

Option Description
-gsm gsm_name

Enter the name of the global service manager that you want to modify. If you do not specify a name, then the current global service manager name for the session (specified with the set gsm command) is used.

-catalog catalog_dbname

Specify the catalog database name

-pwd password

The password for the user with the Global Data Services administrator role. If you do not specify a password, then you are prompted to enter one.

-region region_name

Specify the region to which the global service manager belongs.

-localons ons_port

Specify the new local ONS port.

-remoteons ons_port

Specify the new remote ONS port.

-listener listener_port

Specify the new listener port.

-endpoint gsmendpoint

Specify the protocol address that the global services manager listens on for client connection requests. If you use this option, the value you specify overrides the default endpoint.

-remote_endpoint remote_endpoint

Specify the protocol address that is used by the global service manager to receive database registration requests and communicate with other global service managers in the configuration. If you use this option, the value you specify overrides the default endpoint.


Usage Notes

  • You must run this command locally on the computer where you want to modify the global service manager.

  • This command can be run only by the operating system user who started the global service manager.

  • When you run this command, GDSCTL connects to the Global Data Services catalog as the GSMCATUSER user and prompts you for the GSMCATUSER password.

Example

Modify the global service manager named gsm1 so that it is in the EAST region.

GDSCTL> modify gsm -gsm gsm1 -region east

modify region

This command modifies the configuration for a region.

Syntax and Options

Use the gdsctl modify region command with the following syntax:

modify region -region region_list -buddy region_name

Table A-32 gdsctl modify region Options

Option Description
-region region_list

Specify a comma-delimited list of region names

-buddy region_name

Specify the name of the buddy region


Usage Notes

  • You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.

Example

Modify two regions, EAST and WEST, as follows:

GDSCTL> modify region -region west -buddy east

modify service

Modifies the service attributes. Use this command to:

  • Add databases to the preferred or available lists for the service

  • Move a service from one database to another database

  • Change an available database to a preferred database or a preferred database to an available database

  • Modify the high availability attributes of the service

If you want to temporarily move a service from one database to a different database, then use the relocate service command.

Syntax and Options

Use the gdsctl modify service command to manage services.

To add additional preferred or available databases to a service:

modify service [-gdspool gdspool_name] -service service_name
    {-preferred dbname_list | -available dbname_list}

To modify the high availability attributes of a service:

modify service [-gdspool gdspool_name] -service service_name
   [-locality {ANYWHERE | LOCAL_ONLY [-region_failover]}]
   [-role {PRIMARY | PHYSICAL_STANDBY [-failover_primary] | LOGICAL_STANDBY
      | SNAPSHOT_STANDBY}] [-lag {lag_value | ANY}]
   [-notification {TRUE | FALSE}] [-rlbgoal {SERVICE_TIME | THROUGHPUT}]
   [-dtp {TRUE | FALSE}] [-sql_translation_profile stp_name] 
   [-clbgoal {SHORT | LONG}] [-tafpolicy {BASIC | NONE | PRECONNECT}]
   [-policy policy] [-failovertype {NONE | SESSION | SELECT}]
   [-failovermethod {NONE | BASIC}] [-failoverretry failover_retries]
   [-failoverdelay failover_delay] [-edition edition_name] 
   [-commit_outcome {TRUE | FALSE}] [-retention retention_seconds]
   [-session_state {DYNAMIC | STATIC}] 
   [-replay_init_time replay_init_time]]

To change an available database to a preferred databases for a service:

modify service [-gdspool gdspool_name] -service service_name
   -available dbname_list -preferred

To change preferred and available status of a database for a service:

modify service [-gdspool gdspool_name] -service service_name
   {-preferred_all | -modifyconfig -preferred dbname_list 
      [-available dbname_list]}
   [-force]

To modify properties for a global service that are specific to an Oracle RAC database:

modify service [-gdspool gdspool_name] -service service_name -database db_name
   [-server_pool server_pool_name] -cardinality {UNIFORM | SINGLETON}

Table A-33 gdsctl modify service Options

Option Description
-gdspool gdspool_name

Specify the name of the database pool to which the service belongs. If not specified and there is only one gdspool with access granted to user, it is used as the default gdspool.

-service service_name

Specify the name of the global service.

-preferred_all

Specifies that all the databases in the database pool are preferred databases. Any new databases added to the pool are configured as preferred databases for this service.

This option cannot be used with the -preferred and -available options.

-preferred dbname_list

Specify a comma-delimited list of preferred databases on which the service runs. When changing a database from available to preferred, you do not specify a value for the -preferred option.

The list of preferred instances must be mutually exclusive with the list of available instances.

If you attempt to add a preferred or available database to a service that was configured with -preferred_all, then GDSCTL returns an error.

-available dbname_list

Specify a comma-delimited list of available databases on which the service runs, if the preferred databases are not available.

The list of available instances must be mutually exclusive with the list of preferred instances.

If you attempt to add a preferred or available database to a service that was configured with -preferred_all, then GDSCTL returns an error.

-locality {ANYWHERE | LOCAL_ONLY}

The service region locality. If you do not use this option, then the default value of ANYWHERE is used for the service.

-region_failover

Indicates that the service is enabled for region failover. You can only use this option when you specify LOCAL_ONLY for the -locality option.

-role {[PRIMARY] | [PHYSICAL_STANDBY]
[-failover_primary] |
[LOGICAL_STANDBY] |
[SNAPSHOT_STANDBY]}

Specify the database role that the database must be for this service to start on that database. This applies only to database pools that contain an Oracle Data Guard broker configuration.

See Also: Oracle Data Guard Concepts and Administration for more information about database roles

-failover_primary

If you set the -role option to PHYSICAL_STANDBY, then you can use this option to enable the service for failover to the primary database.

-lag {lag_value | ANY}

Specify the lag for the service in seconds. You can use the keyword ANY to indicate that there is no upper threshold on the lag time.

The default value for the -lag option is ANY.

-rlbgoal {SERVICE_TIME | THROUGHPUT}

Run-time Load Balancing Goal. Set this parameter to SERVICE_TIME to balance connections by response time. Set this parameter to THROUGHPUT to balance connections by throughput.

If you do not use this option, then the value defaults to SERVICE_TIME for the run-time load balancing goal.

-dtp {TRUE | FALSE}

Indicates whether Distributed Transaction Processing should be enabled for this service. This ensures that the service is offered at exactly one instance at a time for XA affinity.

-sql_translation_profile stp_name

Use this option to specify a SQL translation profile for a service that you are adding after you have migrated applications from a non-Oracle database to an Oracle database.

This option corresponds to the SQL translation profile parameter in the DBMS_SERVICE service attribute.

Notes:

  • Before using the SQL translation feature, you must migrate all server-side application objects and data to the Oracle database.

  • Use the config service command to display the SQL translation profile.

See Also: Oracle Database Migration Guide for more information about SQL translation

-clbgoal {SHORT | LONG}

For connection load balancing goal: set to SHORT if using run-time load balancing, set to LONG for long running connections such as batch jobs or older SQL*Forms style.

The default value for this option is SHORT.

-tafpolicy {BASIC | NONE }

TAF policy specification (for administrator-managed databases only).

-notification {TRUE | FALSE}

Enable Fast Application Notification (FAN) for OCI connections.

-policy {AUTOMATIC | MANUAL}

Specify the management policy for the service.

If you specify AUTOMATIC (the default), then the service automatically starts when the database restarts, either by a planned restart or after a failure. Automatic restart is also subject to the service role.

If you specify MANUAL, then the service is never automatically restarted upon planned restart of the database. A MANUAL setting does not prevent the global service manager from monitoring the service when it is running and restarting it if a failure occurs.

-failovertype {NONE | SESSION | SELECT | TRANSACTION}

Specify the failover type.

To enable Application Continuity for Java, set this parameter to TRANSACTION. To enable Transparent Application Failover (TAF) for OCI, set this parameter to SELECT or SESSION.

-failovermethod {NONE | BASIC}

TAF failover method (for backward compatibility only).

If failovertype is set to either SESSION or SELECT, then choose BASIC for this option.

-failoverretry failover_retries

For Application Continuity and TAF, the number of attempts to connect after an incident.

-failoverdelay failover_delay

For Application Continuity and TAF, the time delay (in seconds) between reconnect attempts for each incident at failover.

-edition edition_name

Specify the initial session edition of the service.

When an edition is specified for a service, all subsequent connections that specify the service use this edition as the initial session edition. However, if a session connection specifies a different edition, then the edition specified in the session connection is used for the initial session edition.

GDSCTL does not validate the specified edition name. During connection, the connect user must have USE privilege on the specified edition. If the edition does not exist or if the connect user does not have USE privilege on the specified edition, then an error is raised.

-commit_outcome {TRUE | FALSE}

Enable Transaction Guard; when set to TRUE, the commit outcome for a transaction is accessible after the transaction's session fails due to a recoverable outage.

-retention retention_seconds

For Transaction Guard (commit_outcome set to TRUE), this parameter determines the amount of time (in seconds) that the commit outcome is retained in the database.

-session_state 
{DYNAMIC | STATIC}

For Application Continuity, this parameter specifies whether the session state that is not transactional is changed by the application. A value of DYNAMIC is recommended for most applications.

-replay_init_time replay_init_time

For Application Continuity, this parameter specifies the time (in seconds) after which replay is not initiated. Default value is 300 seconds.

-pdbname pdb_name

Specify the pluggable database name.

-old_db database_name

Specify the name of the old database on which the service runs.

If you attempt to move a service that was configured with -preferred_all, then GDSCTL returns an error.

-new_db database_name

Specify the name of the new database on which the service runs.

If you attempt to move a service that was configured with -preferred_all, then GDSCTL returns an error.

-modifyconfig

Use this option to indicate that you are changing the current list of preferred and available databases for the service. If you use this option, then any databases that are not specified in either the preferred or available list, but were previously assigned, are removed from the list of databases on which the service can run.

-force

If you use this option, then all sessions are disconnected when the service is moved, requiring the sessions using the service to reconnect (potentially to a different instance).

If you do not use this option, then the sessions that are connected to a database using this service stay connected, but all new sessions cannot be established to the service.

-server_pool server_pool_name

Specify the name of the server pool in which the service is available (for a policy-managed Oracle RAC database).

-cardinality {UNIFORM | SINGLETON}

Specify the cardinality option for a service running on a policy-managed Oracle RAC database. Services with cardinality set to UNIFORM are offered on all database instances. Services with cardinality set to SINGLETON are offered on only one database instance.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Examples

Add the database DB3 as a preferred database for the service G_SALES_REPORT in the database pool MYREADERFARM.

GDSCTL> modify service -gdspool myreaderfarm -service g_sales_report -preferred db3

Modify the service G_DAILY_SALES_REPT in the database pool MYREADERFARM to change the run-time load balancing goal to THROUGHPUT.

GDSCTL> modify service -gdspool myreaderfarm -service g_daily_sales_rept
  -rlbgoal THROUGHPUT

Move the service G_SALES_REPORT in the database pool MYREADERFARM from the database DB1 to DB4.

GDSCTL> modify service -gdspool myreaderfarm -service g_sales_report
  -old_db db1 -new_db db4

Upgrade the DB3 database from an available database to a preferred database for the service G_SALES_REPORT in the database pool READFARM.

GDSCTL> modify service -gdspool readfarm -service g_sales_report
  -available db3 -preferred

Assume the service G_SALES_REPORT currently has the databases DB1 and DB2 assigned as preferred databases, and the database DB3 assigned as an available database. Exchange the preferred and available databases DB1 and DB3, and remove the DB2 database for the service SALES_REPORT in the database pool READFARM.

GDSCTL> modify service -gdspool readfarm -service g_sales_report -modifyconfig
  -available db3 -preferred db1

Modify the properties of the service G_SALES_REPORT in the database pool READFARM to specify that it should run only in the server pool named SALESPOOL for the policy-managed Oracle RAC database DB1.

GDSCTL> modify service -gdspool readfarm -service g_sales_report -database db1
-server_pool salespool

relocate service

The gdsctl relocate service command stops a service on one database and starts the service on a different database. Unlike using the modify service command to change the location of a service, this command does not change the underlying configuration. This command temporarily relocates a service to run on another database.

Note:

If you attempt to use this command on a service that was previously configured with the -preferred_all option, then GDSCTL returns an error.

Syntax and Options

Use the gdsctl relocate service command with the following syntax:

relocate service [-gdspool gdspool_name] -service service_name -old_db db_name
    -new_db db_name [-force] [-override [-sourcepwd password]
    [-targetpdw password]]

Table A-34 gdsctl relocate service Options

Option Description
-gdspool gdspool_name

Specify the name of the database pool where the service is located. If not specified and there is only one gdspool with access granted to user, it is used as the default gdspool.

-service service_name

Specify the name of the service you are relocating.

-old_db db_name

Specify the name of the database where the service is currently located.

-new_db db_name

Specify the name of the database to which you want to move the service.

-force

If you use this option, then all sessions are disconnected when the service is moved, requiring the sessions using the service to reconnect (potentially to a different instance).

If you do not use this option, then the sessions that are connected to a database using this service stay connected, but new sessions cannot be established to the service.

-override

This option causes the command to execute without updating the global service manager catalog. You can use this option when the catalog database is unavailable.

During normal operation, you should not use this option.

-sourcepwd password

Specify the password for the GSMUSER in the source database, or the database where the service is currently located.

-targetpwd password

Specify the password for the GSMUSER in the database to which the service is being relocated (the target database).


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Relocate the service SALES_REPORT in the READFARM database pool from the DB2 database to the DB3 database.

GDSCTL> relocate service -gdspool readfarm -service sales_report -old_db db1 -new_db db3

remove

The gdsctl remove command removes components from the global service management configuration.

Table A-35 gdsctl remove Summary

Command Description

remove brokerconfig

Removes the Oracle Data Guard broker configuration from a database pool

remove database

Removes a database from a Global Data Services pool

remove gdspool

Removes a database pool

remove gsm

Removes a global service manager from the configuration

remove invitednode (remove invitedsubnet)

Removes VNCR information from the catalog database

remove region

Removes a region from the current configuration

remove service

Removes a service from a database pool


remove brokerconfig

Removes an Oracle Data Guard broker configuration from a GDS pool.

Syntax and Options

Use the gdsctl remove brokerconfig command with the following syntax:

remove brokerconfig [-gdspool gdspool_name]

Table A-36 gdsctl remove brokerconfig Options

Syntax Description
-gdspool gdspool_name

Specify the GDS pool from which you want to remove the Oracle Data Guard broker configuration (not required--if not specified and there is only one GDS pool with access granted to the user, it is used by default).


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

  • If a GDS pool does not contain a Data Guard Broker configuration, an error is returned.

Example

Remove the Oracle Data Guard broker configuration from the database pool MYDGPOOL.

GDSCTL> remove brokerconfig -gdspool myreaderfarm

remove database

Removes databases from a database pool.

Syntax and Options

Use the gdsctl remove database command with the following syntax:

remove database {-gdspool gdspool_name -all | [-gdspool gdspool_name]
    -database db_name_list } [-force]

Table A-37 gdsctl remove database Options

Option Description
-all

Removes all databases in the database pool.

-database dbname_list

Specify a comma-delimited list of database names that you want to remove from the database pool.

You cannot specify a database that was added through an Oracle Data Guard broker configuration; you must use Oracle Data Guard to remove these databases.

-force

Removes the database from the catalog even if the database is not available.

Using this option can result in global services not being removed from the database.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Example

Remove the database DB1 from the global service management configuration.

GDSCTL> remove database -database db1

remove gdspool

Removes a database pool from the current configuration.

Syntax and Options

Use the gdsctl remove gdspool command with the following syntax:

remove gdspool -gdspool database_pool_list

Table A-38 gdsctl remove gdspool Options

Option Description
-gdspool database_pool_list

Specify a comma-delimited list of database pool names.


Usage Notes

  • You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.

Example

Remove the database pools tempreaders and myfarm from the Global Data Services framework.

GDSCTL> remove gdspool -gdspool tempreaders,myfarm

remove gsm

Removes a global service manager from the configuration.

Note:

The removal of a global service manager requires at least one global service manager to be running to perform cleanup of Global Data Services databases. If there is only one global service manager in the Global Data Services configuration, then it has to be running to be removed.

Syntax and Options

Use the gdsctl remove gsm command with the following syntax:

remove gsm [-gsm gsm_name]

Table A-39 gdsctl remove gsm Options

Syntax Description
-gsm gsm_name

Specify the name of the global service manager that you want to remove. If the name is not specified, then the current global service manager is removed.


Usage Notes

  • You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.

Example

Remove the global service manager named gsm5 from the configuration.

GDSCTL> remove gsm -gsm gsm5

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.

Syntax and Options

Use the gdsctl remove invitednode command with the following syntax:

remove invitednode {[-group group_name]|vncr_id}

Table A-40 gdsctl remove invitednode Options

Option Description
-group group_name

Specify an alias which defines a group of VNCRs. This alias can be referenced in other commands related to invited nodes.

vncr_id

The host address information, which can be an IPv4 or IPv6 address, a host name, a netmask, or other identifier for a server. The host address information cannot contain any spaces.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Examples

Remove the invitednode 194.66.82.32 from the catalog.

GDSCTL> remove invitednode 194.66.82.32

Remove the VNCR alias group EAST_SRV from the catalog.

GDSCTL> remove invitednode -group east_srv

remove region

Removes the specified regions from the global service management framework.

Syntax and Options

Use the gdsctl remove region command with the following syntax:

remove region -region region_list

Table A-41 gdsctl remove region Options

Option Description
-region region_list

Specify a comma-delimited list of region names


Usage Notes

  • You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.

Example

Remove the region named SOUTH from the configuration.

GDSCTL> remove region -region south

remove service

Removes a service from a database pool.

Syntax and Options

Use the gdsctl remove service command with the following syntax:

remove service [-gdspool gdspool_name] -service service_name [-force]

Table A-42 gdsctl remove service Options

Option Description
-gdspool gdspool_name

Specify the name of the database pool from which you want to remove the service. If not specified and there is only one gdspool with access granted to user, then it is used as the default gdspool.

-service service_name

Specify the name of the service that you want to remove.

-force

Indicates this action should be performed even if one or more databases in the database pool are not available.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command

Example

Remove the service sales_report from the database pool MYREADERFARM.

GDSCTL> remove service -gdspool myreaderfarm -service sales_report

services

The gdsctl services command retrieves the information about the services that are registered with the specified global service manager.

Syntax and Options

Use the gdsctl services command with the following syntax:

services [-gsm gsm_name] [-service service_name]

Table A-43 services Options

Option Description
-gsm gsm_name

Specify the name of a global service manager. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL set gsm command).

-service service_name

Specify a fully qualified service name. If the service name is not specified, then the information about all the services registered with the global service manager is retrieved.


Usage Notes

  • You must run this command on the host where the global service manager for which you want to retrieve service information resides

  • You must have the privileges of the user who started the global service manager to run this command

Example

Display information about the services registered with global service manager mygsm:

GDSCTL> services -gsm mygsm

The gdsctl services command returns output similar to the following:

GDSCTL>services -gsm mygsm
Service "localsvc.dbpoolora.oradbcloud" has 2 instance(s). Affinity: LOCALPREF
   Instance "dbpoolora%1", name: "gdscat", db: "gdscat", region: "regionora",
 status: ready.
   Instance "dbpoolora%11", name: "gdscat2", db: "gdscat2", region: "regionora",
 status: ready.
Service "sales_report1.dbpoolora.oradbcloud" has 2 instance(s). Affinity:
 LOCALONLY
   Instance "dbpoolora%1", name: "gdscat", db: "gdscat", region: "regionora",
 status: ready.
   Instance "dbpoolora%11", name: "gdscat2", db: "gdscat2", region: "regionora",
 status: ready.
Service "sales_report2.dbpoolora.oradbcloud" has 2 instance(s). Affinity: ANYWHERE
   Instance "dbpoolora%1", name: "gdscat", db: "gdscat", region: "regionora",
 status: ready.
   Instance "dbpoolora%11", name: "gdscat2", db: "gdscat2", region: "regionora",
 status: ready.

Note:

Affinity values can be LOCALONLY when the service locality is defined as local_only, LOCALPREF when the service locality is defined as local_only with the region_failover option enabled, and ANYWHERE when the service locality is defined as anywhere.

Display the status of mthly_report service:

GDSCTL>services -service mthly_report.sales.oradbcloud

Returns output similar to the following:

Service "mthly_report.sales.oradbcloud" has 1 instance(s). Affinity:
ANYWHERE
    Instance "sales%1", name: "debug", db: "debug", region: "eastcoast",
status: ready.

set

The gdsctl set command is used to configure the context of the current GDSCTL session.

Table A-44 gdsctl set Summary

Command Description

set gsm

Sets the name of the global service manager for the current session.

set inbound_connect_level

Sets the INBOUND_CONNECT_LEVEL listener parameter.

set log_level

Sets the LOG_LEVEL listener parameter.

set outbound_connect_level

Sets the OUTBOUND_CONNECT_LEVEL listener parameter.

set trace_level

Sets the TRACE_LEVEL listener parameter.


set gsm

Sets the global service manager for the current session. This command establishes to which global service manager the successive commands apply. The specified global service manager name is resolved in the gsm.ora configuration file.

Syntax and Options

Use the gdsctl set gsm command with the following syntax:

set gsm -gsm gsm_name

Table A-45 gdsctl set gsm Options

Syntax Description
-gsm gsm_name

Specify the name of the global service manager to work with in the current session. If you do not specify a specific global service manager, then GDSCTL uses the default global service manager name of GSMORA.


Usage Notes

  • You must run this command on the host where the global service manager that you want to set for the current session resides.

  • You must have the privileges of the user who started the global service manager to run this command.

Example

Set the global service manager for the current session to gsm1.

GDSCTL> set gsm -gsm gsm1

set inbound_connect_level

Sets the INBOUND_CONNECT_LEVEL listener parameter.

Syntax and Options

Use the gdsctl set inbound_connect_level command with the following syntax:

set inbound_connect_level [-gsm gsm_name] timeout_value

Table A-46 gdsctl set inbound_connect_level Options

Option Description
-gsm gsm_name

Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the set gsm command).

timeout_value

Specify in seconds the connection timeout value.


Usage Notes

  • You must run this command on the host where the global service manager for which you want to set the INBOUND_CONNECT_LEVEL listener parameter resides

  • You must have the privileges of the user who started the global service manager to run this command

Example

Set the INBOUND_CONNECT_LEVEL listener parameter for mygsm to time out in 60 seconds:

GDSCLTL> set inbound_connect_level -gsm mygsm 60

set log_level

Sets the log level for the listener associated with a specific global service manager.

Syntax and Options

Use the gdsctl set log_level command with the following syntax:

set log_level [-gsm gsm_name] log_level

Table A-47 gdsctl set log_level Options

Option Description
-gsm gsm_name

Specify the name of the global service manager.

log_level

Specify the level of detail to write to the log. Valid values are ON or OFF.


Usage Notes

  • You must run this command on the host where the global service manager for which you want to set the listener log level resides

  • You must have the privileges of the user who started the global service manager to run this command

Example

Set logging on for global service manager mygsm:

GDSCTL> set log_level -gsm mygsm ON

set outbound_connect_level

Sets the timeout value for the outbound connections for the listener associated with a specific global service manager.

Syntax and Options

Use the gdsctl set outbound_connect_level command with the following syntax:

set outbound_connect_level [-gsm gsm_name] timeout_value

Table A-48 gdsctl set outbound_connect_level Options

Option Description
-gsm gsm_name

Specify the name of the global service manager

timeout_value

Specify the connection timeout value


Usage Notes

  • You must run this command on the host where the global service manager for which you want to set the timeout value of outbound connections for the listener resides.

  • You must have the privileges of the user who started the global service manager to run this command.

Example

Set timeout value for all outbound connections:

GDSCTL> set outbound_connect_level 60 

set trace_level

Sets the trace level for the listener associated with the specified global service manager.

Syntax and Options

Use the gdsctl set trace_level command with the following syntax:

set trace_level [-gsm gsm_name] trace_level

Table A-49 gdsctl set trace_level Options

Option Description
-gsm gsm_name

Specify the name of the global service manager. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL set gsm command).

trace_level

Specify the trace level for the global service manager listener. Valid values are

USER - provides traces to identify user-induced error conditions

ADMIN - provides traces to identify installation-specific problems

SUPPORT - provides trace with troubleshooting information for Oracle Support Services

OFF - provides no tracing


Usage Notes

  • You must run this command on the host where the global service manager for which you want to set the listener trace level resides.

  • You must have the privileges of the user who started the global service manager to run this command.

Example

Set the trace level for all listeners associated with mygsm to ADMIN

GDSCTL> set trace_level -gsm mygsm ADMIN

start

The gdsctl start command starts components that are part of the global service management framework.

Table A-50 gdsctl start Summary

Command Description

start gsm

Starts the global service manager

start service

Starts the specified services


start gsm

Starts a specific global service manager.

Syntax and Options

Use the gdsctl start gsm command with the following syntax:

start gsm [-gsm gsm_name]

Table A-51 gdsctl start gsm Options

Option Description
-gsm gsm_name

Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the set gsm command).


Usage Notes

  • You must run GDSCTL on the same host where the global service manager you want to start is located.

  • You must have operating system privileges on the computer where you want to start the global service manager to run this command.

Example

Start the global service manager gsm1 on the local host.

GDSCTL> start gsm -gsm gsm1

start service

Starts specific services.

Syntax and Options

Use the gdsctl start service command with the following syntax:

start service [-gdspool gdspool_name] -service service_name
    [{-database db_name | -override [-pwd password] -connect connect_identifier}]

Table A-52 gdsctl start service Options

Option Description
-gdspool gdspool_name

Specify the name of the database pool in which the services that you want to start are located. If not specified and there is only one gdspool with access granted to the user, it is used as the default gdspool.

-service service_name

Specify a comma-delimited list of global service names. If you do not use this option, then GDSCTL starts all the services in the database pool.

-database db_name

Specify the name of the database on which you want to start the service. If you do not specify this option, then GDSCTL starts the services on all preferred databases.

-override

This option causes the command to run without updating the global service manager catalog. You can use this option when the catalog database is unavailable.

During normal operation, you should not use this option.

-pwd password

Specify the password of the GSMUSER in the specified database.

-connect connect_identifier

Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Example

Start the service SALES_REPORT, located in the READERFARM database pool.

GDSCTL> start service -gdspool readerfarm -service sales_report

status

The gdsctl status command displays the running status of a specific component or set of components. For example, you can use the gdsctl status command to check whether a component is started.

Table A-53 gdsctl status Summary

Command Description

status database

Displays the status of a specific database

status gsm

Displays the status of a specific global service manager

status service

Displays the status of one or more services in a specific database pool


status database

Displays the status of all databases.

Syntax and Options

Use the gdsctl status database command with the following syntax:

{status database | databases} [-gsm gsm_name][-database db_name]
   [-gdspool gdspool_name]

Table A-54 gdsctl status database Options

Option Description
-gsm gsm_name

Specify the name of a global service manager to check. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL set gsm command).

-database db_name

Specify the name of the database on which you want to start the service. If you do not specify this option, then GDSCTL starts the services on all preferred databases.

-gdspool gdspool_name

Specify the name of the database pool in which the services you want to start are located. If not specified and there is only one gdspool with access granted to the user, it is used as the default gdspool.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Example

Display the status of all databases:

GDSCTL>status database

The gdsctl status database command returns output similar to the following:

Database: "dbcat1" Registered: Y State: Ok ONS: N. Role: PRIMARY Instances: 1
 Region: east
   
   Service: "sales_svc2" Globally started: N Started: N
            Scan: Y Enabled: Y Preferred: Y
   Service: "sales_svc1" Globally started: Y Started: Y
            Scan: N Enabled: Y Preferred: Y
   Registered instances:
     sales%11
Database: "dbcat2" Registered: Y State: Ok ONS: N. Role: PRIMARY Instances: 1
 Region: east
   Service: "sales_svc2" Globally started: N Started: N
            Scan: Y Enabled: Y Preferred: Y
   Service: "sales_svc1" Globally started: Y Started: Y
            Scan: N Enabled: Y Preferred: Y
   Registered instances:
     sales%1

status gsm

Displays the status of a specific global service manager.

Syntax and Options

Use the gdsctl status gsm command with the following syntax:

status gsm [-gsm gsm_name]

Table A-55 gdsctl status gsm Options

Option Description
-gsm gsm_name

Specify the name of a global service manager to check. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL set gsm command).


Usage Notes

  • You must run GDSCTL on the same host where the global service manager for which you want to display the status is located.

  • You must have operating system privileges on the computer where you want to display the global service manager status to run this command.

Example

Display status of mygsm:

GDSCTL> status gsm -gsm mygsm

The gdsctl status gsm command returns output similar to the following:

Alias MYGSM
Version 12.1.0.0.2
Start Date 03-JUL-2012 16:48:54
Trace Level support
Listener Log File /u01/ORACLE/mygsm/alert/log.xml
Listener Trace File /u01/ORACLE/mygsm/trace/ora_14816_47568108067776.trc
Endpoint summary (ADDRESS=(HOST=mymv.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
GSMOCI Version 0.1.8
Mastership Y
Connected to GDS catalog Y
Process Id 14818
Number of reconnections 0
Pending tasks. Total 0
Tasks in process. Total 0
Regional Mastership TRUE
Total messages published 28599
Time Zone -07:00
Orphaned Buddy Regions:
None
GDS region regionora

status service

Displays the status of a specific service. This command is similar to services.

Syntax and Options

Use the gdsctl status service command with the following syntax:

{status service | services} [-gsm gsm_name] [-service service_name] [{-raw|-verbose|-support}]

Table A-56 gdsctl status service Options

Option Description
-gsm gsm_name

Specify the name of a global service manager. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL set gsm command).

-service service_name

Specify a comma-delimited list of global service names. If you do not specify any services, then GDSCTL displays the status of all services in the database pool.

-verbose

Display extra information related to load balancing.

-support

Display more detailed information concerning load balancing.

-raw

Used by oracle internal components.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Example

Display the status of service sales_report1.sales.oradbcloud:

GDSCTL>status service -service sales_report1.sales.oradbcloud

The gdsctl status service command returns output similar to the following:

Service "sales_report1.sales.oradbcloud" has 3 instance(s). Affinity: ANYWHERE
   Instance "sales%1", name: "dbcat2", db: "dbcat2", region: "east",
 status: ready.
   Instance "sales%11", name: "dbcat1", db: "dbcat1", region: "west",
 status: ready.
   Instance "sales%31", name: "dbcat3", db: "dbcat3", region: "east",
 status: ready.

stop

The gdsctl stop command stops components that are part of the Global Service Management framework.

Table A-57 gdsctl stop Summary

Command Description

stop gsm

Stops a specific global service manager on the local host

stop service

Stops a specific service


stop gsm

Stops a specific global service manager. You must run GDSCTL on the same host where the global service manager that you want to stop is located.

Syntax and Options

Use the gdsctl stop gsm command with the following syntax:

stop gsm [-gsm gsm_name]

Table A-58 gdsctl stop gsm Options

Option Description
-gsm gsm_name

Specify the name of a global service manager you want to stop. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the set gsm command).


Usage Notes

  • You must run GDSCTL on the same host where the global service manager that you want to stop is located.

  • You must have operating system privileges on the computer where you want to start the global service manager to run this command.

Example

Stop the global service manager gsm1 on the local host.

GDSCTL> stop gsm -gsm gsm1

stop service

Stops a specific service.

Syntax and Options

Use the gdsctl stop service command with the following syntax:

stop service [-gdspool gdspool_name] [-service service_name]
    [{-database db_name | -override [-pwd password] -connect connect_identifier}]
    [-force]

Table A-59 gdsctl stop service Options

Option Description
-gdspool gdspool_name

Specify the name of the database pool in which the service that you want to stop is located. If not specified and there is only one gdspool with access granted to user, that gdspool is used as the default gdspool.

-service service_name

Specify a comma-delimited list of global service names you want to stop. If you do not use this option, then GDSCTL stops all the services in the database pool.

-database db_name

Specify the name of the database on which you want to stop the service. If you do not specify this option, then GDSCTL stops the services on all databases on which the service is currently running.

-override

This option causes the command to execute without updating the global service manager catalog. You can use this option when the catalog database is unavailable.

During normal operation, you should not use this option.

-pwd password

Specify the password of the GSMUSER in the specified database.

-connect connect_identifier

Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor.

-force

If you use this option, then GDSCTL disconnects all sessions when the service is stopped, requiring the sessions using the service to reconnect (potentially to a different instance).

If you do not use this option, then the sessions that are connected to a database using this service remain connected, but new sessions cannot be established to the service.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Example

Stop the service SALES_REPORT, on all databases in the database pool READERFARM.

GDSCTL> stop service -gdspool readerfarm -service sales_report

sync brokerconfig

The gdsctl sync brokerconfig command synchronizes the Oracle Data Guard broker configuration in the global service manager with the configuration in the database pool.

Syntax and Options

Use the gdsctl sync brokerconfig command with the following syntax:

sync brokerconfig [-gdspool gdspool_name] [-database db_name]

Table A-60 gdsctl sync brokerconfig Options

Option Description
-gdspool gdspool_name

Specify the database pool to which the Oracle Data Guard broker configuration belongs. If not specified and there is only one gdspool with access granted to user, that gdspool is used as the default gdspool.

If the specified database pool does not contain an Oracle Data Guard broker configuration, then GDSCTL returns an error.

-database db_name

Specify the name of a database in the database pool to use as a referential database, from which the configuration is queried.

If you do not use this option, then GDSCTL uses the primary database as the referential database. If a primary database does not exist in the Oracle Data Guard broker configuration, then GDSCTL uses a random database from the pool as the referential database.


Usage Notes

  • You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.

Example

Synchronize the Oracle Data Guard broker configuration in the database pool MYREADERFARM with the configuration stored in the Global Data Services catalog.

GDSCTL> sync brokerconfig -gdspool myreaderfarm

sync database

The gdsctl sync database command brings attributes of global services and GDS related parameters of a pool database in synchronization with the contents of the GDS catalog.

Syntax and Options

Use the gdsctl sync database command with the following syntax:

sync database [-gdspool gdspool_name] [-database database_name]

Table A-61 gdsctl sync database Options

Option Description
-gdspool gdspool_name

Specify the GDS pool to which the database belongs. If not specified and there is only one GDS pool with access granted to user, it is used as the default GDS pool.

-database database_name

Specify the name of a database in the database pool to use as a referential database, from which the configuration is queried.


Usage Notes

  • If database has no GDS region assigned, an error is returned.

  • If a GDS pool is specified and the database option is not specified, then each database in the pool is synchronized.

Example

Synchronize a database in the default database pool with the database mydb.

GDSCTL> sync database -database mydb

validate catalog

The gdsctl validate catalog command cross checks the Global Data Services catalog, global service manager run-time status, and pool databases, and reports inconsistencies and errors.

Syntax and Options

Use the gdsctl validate catalog command with the following syntax:

validate [catalog] [-gsm gsm_name] [ {-config | -database db_name} ]

Table A-62 gdsctl validate catalog Options

Option Description

-gsm gsm_name

Specify the global service manager name. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the set gsm command).

-config

Indicates that the validation should be performed on the Global Data Services catalog configuration only.

-database db_name

Indicates the name of the database for which the cross-check validation should be performed.


Example

Validate the catalog:

GDSCTL> validate

The output should be similar to the following:

Validation results:
VLD2: Region "regionora" does not have buddy region
VLD11: GDS pool "marketing" does not contain any databases
VLD12: GDS pool "marketing" does not contain any global services
VLD11: GDS pool "sales" does not contain any databases
VLD12: GDS pool "sales" does not contain any global services
VLD11: GDS pool "mkt" does not contain any databases
VLD12: GDS pool "mkt" does not contain any global services