B Server Control (SRVCTL) Reference

Syntax and Options

Use the srvctl add database command with the following syntax:

srvctl add database -d db_unique_name -o oracle_home [-m domain_name] [-p
spfile] [-A addr_str] [-r {PRIMARY |
PHYSICAL_STANDBY | LOGICAL_STANDBY}] [-s start_options] [-n db_name]

Example

An example of this command is:

srvctl add database -d crm -o /ora/ora10

Syntax and Options

Use the srvctl add instance command with the following syntax:

srvctl add instance -d db_unique_name -i inst_name -n node_name

Examples

Examples of this command are:

srvctl add instance -d crm -i  crm01 -n gm01
srvctl add instance -d crm -i  crm02 -n gm02
srvctl add instance -d crm -i  crm03 -n gm03

Syntax and Options

Use the srvctl add service command with the following syntax:

srvctl add service -d db_unique_name -s service_name -r preferred_list
[-a available_list] [-P TAF_policy]

Use the following syntax to add a new preferred or available instance to the service configuration:

srvctl add service -d db_unique_name -s service_name  -u [-r new_preferred_inst | -a new_available_inst]

Examples

Use this example syntax to add a named service to a database with preferred instances in list one and available instances in list two, using basic failover for the available instances:

srvctl add  service -d crm -s sales -r crm01,crm02 -a crm03

Use this example syntax to add a named service to a database with preferred instances in list one and available instances in list two, using preconnect failover for the available instances:

srvctl add  service -d crm -s sales -r crm01,crm02 -a crm03 -P Preconnect

Syntax and Options

Use the srvctl add nodeapps command with the following syntax:

srvctl add nodeapps -n node_name -o oracle_home -A addr_str

Example

An example of this is:

srvctl add nodeapps -n crmnode1 -o /ora/ora10 -A 1.2.3.4/255.255.255.0

Syntax and Options

Use the srvctl add asm command with the following syntax:

srvctl add asm -n node_name -i asm_instance_name -o oracle_home

Example

An example of this is:

srvctl add asm -n crmnode1 -i asm1 -o /ora/ora10

Syntax and Options

Use the srvctl config database command with the following syntax:

srvctl config database [-d db_unique_name [-a] [-t]]

Examples

An example of this command to list all database is:

srvctl config database

An example of this command to show sample TNS entries for a specific database is:

srvctl config database -d db_erp

Syntax and Options

Use the srvctl config service command with the following syntax:

srvctl config service -d db_unique_name [-s service_name] [-a]

Example

An example of this command is:

srvctl config service -d crm -s crm

Syntax and Options

Use the srvctl config nodeapps command with the following syntax:

srvctl config nodeapps -n node_name [-a] [-g] [-s] [-l]

Example

An example of this is:

srvctl config nodeapps -n mynode1

Syntax and Options

Use the srvctl config asm command with the following syntax:

srvctl config asm -n node_name

The only option available for this command is -n to specify the node name.

Example

An example of this is:

srvctl config asm -n mynode1

Syntax and Options

Use the srvctl enable database command with the following syntax:

srvctl enable database -d db_unique_name

The only option available for this command is -d to specify the database name.

Example

An example of this command is:

srvctl enable database -d crm

Syntax and Options

Use the srvctl enable instance command with the following syntax:

srvctl enable instance -d db_unique_name -i inst_name_list

Example

An example of this command is:

srvctl enable instance  -d crm -i "crm1,crm2"

Syntax and Options

Use the srvctl enable service command with the following syntax:

srvctl enable service -d db_unique_name {-s service_name_list | -s service_name -i inst_name}

Examples

The following example globally enables a service:

srvctl enable service -d crm -s crm

The following example enables a service to use a preferred instance:

srvctl enable service -d crm -s crm -i crm1

Syntax and Options

Use the srvctl enable asm command with the following syntax:

srvctl enable asm -n node_name [-i asm_inst_name]

Example

An example of this command is:

srvctl enable asm -n crmnode1 -i asm1

Syntax and Options

Use the srvctl disable database command with the following syntax:

srvctl disable database -d db_unique_name

The only option available for this command is -d to specify the database name.

Example

An example of this command is:

srvctl disable database -d mybd1

Syntax and Options

Use the srvctl disable instance command with the following syntax:

srvctl disable instance -d db_unique_name -i inst_name_list

Example

An example of this command is:

srvctl disable instance -d crm -i "crm1,crm3"

Syntax and Options

Use the srvctl disable service command with the following syntax:

srvctl disable service -d db_unique_name {-s service_name_list | -s service_name -i inst_name}

Examples

The following example globally disables two services:

srvctl disable service -d crm -s crm,marketing

The following example disables a service running on the preferred named instance and results in running a service on one less instance:

srvctl disable service -d crm -s crm -i crm1

Syntax and Options

Use the srvctl disable asm command with the following syntax:

srvctl disable asm -n node_name [-i asm_inst_name]

Example

An example of this command is:

srvctl disable asm -n crmnode1 -i asm1

Syntax and Options

Use the srvctl start database command with the following syntax:

srvctl start database -d db_unique_name [-o start_options] [-c connect_str | -q]

Example

An example of this command is:

srvctl start database -d crm -o open

Syntax and Options

Use the srvctl start instance command with the following syntax:

srvctl start instance -d db_unique_name -i inst_name_list [-o start_options] [-c connect_str | -q]

Example

An example of this command is:

srvctl start instance -d crm -i "crm1,crm4"

Syntax and Options

Use the srvctl start service command with the following syntax:

srvctl start service -d db_unique_name [-s service_name_list [-i inst_name]]  [-o start_options] [-c connect_str | -q]

Examples

The following example starts named service names. If the instances that support these services, including available instances that the service uses for failover, are not running but are enabled, then they are started:

srvctl start service -d crm -s crm

The following example starts a named service on a specified instance:

srvctl start service -d crm -s crm -i crm2

Syntax and Options

Use the srvctl start nodeapps command with the following syntax:

srvctl start nodeapps -n node_name

The only option available for this command is -n to specify the node name.

Example

An example of this command is:

srvctl start nodeapps -n mynode1

Syntax and Options

Use the srvctl start asm command with the following syntax:

srvctl start asm -n node_name [-i asm_inst_name] [-o start_options]

Examples

An example of this command to start a single ASM instance is:

srvctl start asm -n crmnode1 -i asm1

An example to start all ASM instances on a node is:

srvctl start asm -n crmnode2

Syntax and Options

Use the srvctl stop database command with the following syntax:

srvctl stop database -d db_unique_name [-o stop_options] [-c connect_str | -q]

Example

An example of this command is:

srvctl stop database -d crm

Syntax and Options

Use the srvctl stop instance command with the following syntax:

srvctl stop instance -d db_unique_name -i inst_name_list [-o stop_options] [-c connect_str | -q]

Example

An example of this command is:

srvctl stop instance -d crm -i crm1

Syntax and Options

Use the srvctl stop service command with the following syntax:

srvctl stop service -d db_unique_name [-s service_name_list [-i inst_name]]  [-c connect_str | -q] [-f]

Examples

The following example stops a service globally across a cluster database:

srvctl stop service -d crm -s crm

The following example stops a service on a specified instance:

srvctl stop  service -d crm -s crm -i crm2

Syntax and Options

Use the srvctl stop nodeapps command with the following syntax:

srvctl stop nodeapps -n node_name

The only option for this command is the -n option, which specifies the node name.

Example

An example of this command is:

srvctl stop nodeapps -n mynode1

Syntax and Options

Use the srvctl stop asm command with the following syntax:

srvctl stop asm -n node_name [-i inst_name] [-o stop_options]

Example

An example of this command is:

srvctl stop asm -n crmnode1 -i asm1

Syntax and Options

Use the srvctl modify database command with the following syntax:

srvctl modify database -d db_unique_name [-n db_name] [-o ohome] [-m domain_name]
 [-p spfile] [-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY}] [-s start_options] 

Example

The following example changes the role of a database to a logical standby:

srvctl modify database -d crm -r logical_standby

Syntax and Options

Use the srvctl modify instance command with the following syntax:

srvctl modify instance -d db_unique_name -i inst_name {-n node_name | -s <asm_instance_name> | -r}

Examples

An example of this command to relocate a database instance is:

srvctl modify instance -d crm -i crm1 -n my_new_node

The following example of this command establishes a dependency between an ASM instance and a database instance:

srvctl modify instance -d crm -i crm1 -s asm1

Syntax and Options

Use the srvctl modify service command with the following syntax:

srvctl modify service -d db_unique_name -s service_name -i old_inst_name  -t new_inst_name [-f]

You can also use the srvctl modify service command to change an available instance to a preferred instance as follows:

srvctl modify service -d db_unique_name -s service_name -i avail_inst_name -r [-f]

Examples

An example of moving a service member from one instance to another is:

srvctl modify service -d crm -s crm -i crm1 -t crm2

An example of changing an available instance to a preferred instance is:

srvctl modify service -d crm -s crm -i crm1 -r

To change the status of multiple instances, you can use the srvctl modify service command to list which instances are to be the preferred and which are to be the available instances for a service as follows:

srvctl modify service -d db_unique_name -s service_name -n -i pref_inst_list [-a avail_inst_list] [-f]

Example

An example of this command to exchange a preferred and available instance is:

srvctl modify service -d crm -s crm -n -i crm1 -a crm2

Syntax and Options

Use the srvctl modify nodeapps command with the following syntax:

srvctl modify nodeapps -n node_name [-o oracle_home] [-A new_vip_address]

Example

An example of this is:

srvctl modify nodeapps -n mynode1 -A 100.200.300.40/255.255.255.0/eth0

Syntax and Options

Use the srvctl relocate service command with the following syntax:

srvctl relocate service -d db_unique_name -s service_name -i old_inst_name -t new_inst_name [-f] 

Example

To temporarily relocate a named service member from crm1 to crm3:

srvctl relocate service -d crm -s crm -i crm1 -t crm3

Syntax and Options

Use the srvctl status database command with the following syntax:

srvctl status database -d db_unique_name [-f] [-v]

Example

An example of this command is:

srvctl status database -d crm -v

Syntax and Options

Use the srvctl status instance command with the following syntax:

srvctl status instance -d db_unique_name -i inst_name_list [-f] [-v]

Example

An example of this command is:

srvctl status instance -d crm -i "crm1,crm2" -v

Syntax and Options

Use the srvctl status service command with the following syntax:

srvctl status service -d db_unique_name -s service_name_list [-f] [-v]

Example

The following example obtains the status of a named service globally across the database:

srvctl status service -d crm -s crm -v

Syntax and Options

Use the srvctl status nodeapps command with the following syntax:

srvctl status nodeapps -n node_name

The only option available for this command is -n to specify the node name.

Example

An example of this command to obtain the status of all nodes supporting database applications is:

srvctl status nodeapps -n mynode1

Syntax and Options

Use the srvctl status asm command with the following syntax:

srvctl status asm -n node_name

The only option available for this command is -n to specify the node name.

Example

An example of this command is:

srvctl status asm -n crmnode1

Syntax and Options

Use the srvctl getenv database command with the following syntax:

srvctl getenv database -d db_unique_name [-t name_list]

Example

The following example gets the environment configuration for a cluster database:

srvctl getenv database -d crm

Syntax and Options

Use the srvctl getenv instance command with the following syntax:

srvctl getenv instance -d db_unique_name -i inst_name [-t name_list]

Example

The following example sets the environment configuration for an instance:

srvctl getenv instance -d -crm -i instance1

Syntax and Options

Use the srvctl getenv service command with the following syntax:

srvctl getenv service -d db_unique_name -s service_name [-t name_list]

Example

The following example lists all environment variables for a service:

srvctl getenv service -d crm -s crm

Syntax and Options

Use the srvctl getenv nodeapps command with the following syntax:

srvctl getenv nodeapps -n node_name [-t name_list]

Example

The following example lists all environment variables for the node applications:

srvctl getenv nodeapps -n crmnode1

Syntax and Options

Use the srvctl setenv database command with the following syntax:

srvctl setenv database -d db_unique_name {-t name=val[,name=val,...] | -T name=val} 

Example

The following example sets the language environment configuration for a cluster database:

srvctl setenv database -d crm -t LANG=en

Syntax and Options

Use the srvctl setenv instance with the following syntax:

srvctl setenv instance -d db_unique_name [-i inst_name] {-t name=val[,name=val,...] | -T name=val} 

Example

The following example sets the environment configuration for an instance:

srvctl setenv instance -d -crm -i instance1 -t LANG=EN

Syntax and Options

Use the srvctl setenv service command with the following syntax:

srvctl setenv service -d db_unique_name [-s service_name] {-t name=val[,name=val,...] | -T name=val}

Example

To set all environment variables for a service:

srvctl setenv service -d crm -s crm -t CLASSPATH=/usr/local/jdk/jre/rt.jar
 

Syntax and Options

Use the srvctl setenv nodeapps command as follows:

srvctl setenv nodeapps -n node_name {-t name=val[,name=<val>,...] | -T name=<val>} 

Example

To set an environment variable for a node application:

srvctl setenv nodeapps -n crmnode1 -t CLASSPATH=/usr/local/jdk/jre/rt.jar

Syntax and Options

Use the srvctl unsetenv database command as follows:

srvctl unsetenv database -d db_unique_name -t name_list

Example

The following example unsets the environment configuration for a cluster database environment variable:

srvctl unsetenv database -d crm -t CLASSPATH

Syntax and Options

Use the srvctl unsetenv instance command as follows:

srvctl unsetenv instance -d db_unique_name [-i inst_name] -t name_list

Example

The following example unsets the environment configuration for an instance:

srvctl unsetenv instance -d -crm -i instance1 -t CLASSPATH

Syntax and Options

Use the srvctl unsetenv service command as follows:

srvctl unsetenv service -d db_unique_name [-s service_name] -t name_list

Example

To unset an environment variables for a service:

srvctl unsetenv service -d crm -s crm -t CLASSPATH

Syntax and Options

Use the srvctl unsetenv nodeapps command as follows:

srvctl unsetenv nodeapps -n node_name -t name_list

Example

The following example unsets the environment configuration for a node's node applications:

srvctl unsetenv nodeapps -n crmnode1 -t name_list

Syntax and Options

Use the srvctl remove database command with the following syntax:

srvctl remove database -d db_unique_name [-f]

Example

An example of this command is:

srvctl remove database -d crm

Syntax and Options

Use the srvctl remove instance command with the following syntax:

srvctl remove instance -d db_unique_name -i inst_name [-f]

Example

An example of this command is:

srvctl remove instance -d crm -i crm01

Syntax and Options

Use the srvctl remove service command as follows:

srvctl remove service -d db_unique_name -s service_name [-i inst_name] [-f]

Examples

An example of this command is:

srvctl remove service -d crm -s sales

The following example removes the services from specific instances:

srvctl remove service -d crm -s sales -i crm01,crm02 

Syntax

Use the srvctl remove nodeapps command as follows:

srvctl remove nodeapps -n node_name_list [-f]

Example

An example of this command is:

srvctl remove nodeapps -n "mynode1,mynode2,mynode3"

Syntax and Options

Use the srvctl remove asm command with the following syntax:

srvctl remove asm -n node_name [-i asm_inst_name]

Example

An example of this command is:

srvctl remove asm -n crmnode1 -i asm1