A Server Control Utility Reference

Using SRVCTL

This section includes topics that relate to using the SRVCTL utility.

• Overview of SRVCTL

• Operational Notes for SRVCTL

• Additional Topics on SRVCTL

Overview of SRVCTL

Use SRVCTL to manage configuration information. You can use SRVCTL commands to add, remove, start, stop, modify, enable, and disable a number of entities, such as databases, instances, listeners, SCAN listeners, services, grid naming service (GNS), and Oracle ASM.

Some SRVCTL operations modify the configuration data stored in the Oracle Cluster Registry (OCR). SRVCTL performs other operations, such as starting and stopping instances, by sending requests to the Oracle Clusterware process (CRSD), which then starts or stops the Oracle Clusterware resources.

Operational Notes for SRVCTL

SRVCTL is installed on each node by default.

This section discusses the following topics:

• Usage Information

• Character Set and Case Sensitivity of Object Values

• Summary of Tasks for Which SRVCTL Is Used

• Using SRVCTL Help

• Privileges and Security

Usage Information

To use SRVCTL, log in to the operating system of a node and enter the SRVCTL command and its options in case-sensitive syntax as described in "SRVCTL Command Reference".

Guidelines for using SRVCTL are:

• Only use the version of SRVCTL that is provided with Oracle Database 11g on Oracle RAC databases that are created or upgraded for Oracle Database 11g. The version of SRVCTL must be the same as the version of the object (listeners, Oracle ASM instances, Oracle RAC databases and their instances, and services) being managed. To ensure the versions are the same release, issue SRVCTL commands from the Oracle home of the database or object you are managing.

• SRVCTL does not support concurrent executions of commands on the same object. Therefore, run only one SRVCTL command at a time for each database, service, or other object.

Using Comma-Delimited Lists

When specifying a comma-delimited list as part of a SRVCTL command, there should not be any spaces between the items in the list. For example:

srvctl add database -g serverpool1,serverpool3

When you specify a comma-delimited list in a Windows environment, you must enclose the list in double quotation marks (""). You can enclose a comma-delimited list in double quotation marks in a Linux or UNIX environment but they will be ignored.

Specifying a Continuation of Command Line Entries

If you are entering a SRVCTL command, and you want to continue the input on a new line, then you can use the operating system continuation character. In Linux, this is the backslash (\) symbol.

SRVCTL Command Feedback

A SRVCTL command that produces no output is a successful command. Not all SRVCTL commands return a message when it completes, successfully. However, if a SRVCTL command fails, then it always returns an error message.

Character Set and Case Sensitivity of Object Values

SRVCTL interacts with many different types of objects. The character set and name length limitations, and whether or not the object name is case sensitive, can vary between object types.

db_domain

db_unique_name

diskgroup_name

instance_name

listener_name

node_name

scan_name

server_pool

service_name

volume_name

Summary of Tasks for Which SRVCTL Is Used

SRVCTL is used to manage databases, instances, cluster databases, cluster database instances, Oracle ASM instance and disk groups, services, listeners, or other clusterware resources.

• Cluster Database Configuration Tasks

  • Add, modify, and delete cluster database configuration information.

  • Add an instance or a service to, and delete an instance or service from the configuration of a cluster database.

  • Move instances and services in a cluster database configuration and modify service configurations.

  • Set and unset the environment for an instance or service in a cluster database configuration.

  • Set and unset the environment for an entire cluster database in a cluster database configuration.

• General Cluster Database Administration Tasks

  • Start and stop cluster databases

  • Start and stop cluster database instances

  • Start, stop, and relocate cluster database services

  • Obtain statuses of cluster databases, cluster database instances, or cluster database services

• Node-Level Tasks

  • Adding and deleting node level applications, server pools, and VIPs

  • Setting and unsetting the environment for node-level applications

  • Administering disk groups

  • Administering server pools

  • Administering node applications

  • Administering Oracle ASM instances

  • Starting and stopping a group of programs that includes virtual IP addresses (VIPs), listeners, and Oracle Notification Services

Using SRVCTL Help

To see help for all SRVCTL commands, from the command line enter:

srvctl -h

To see the command syntax and a list of options for each SRVCTL command, from the command line enter:

srvctl command (or verb) object (or noun) -h

To see the SRVCTL version number enter:

$ srvctl -V

Privileges and Security

To use SRVCTL to change your Oracle RAC database configuration, log in to the operating system as the software owner of the home that you want to manage.

For example, if different users installed Oracle Database and the Grid Infrastructure, then log in as the database software owner (for example, ora_db) to manage databases and log in as the Grid Infrastructure software owner (for example, ora_asm) to manage the Oracle ASM instances.

Users who are members of the OSDBA operating system group can start and stop the database. To stop and start an Oracle ASM instance, you must be a member of the OSASM operating system group.

To create or register objects such as listeners, Oracle Notification Services, and services, you must be logged in to the operating system as the software owner of the Oracle home. The objects you create or register for that Oracle home will run under the user account of the owner of the Oracle home. Databases run as the database installation owner of the home from which they run.

To perform srvctl add operations on any object, you must be logged in as the Oracle account owner of the home on which the object runs.

For some SRVCTL commands, on Linux and UNIX systems, you must be logged in as root, and on Windows systems, you must be logged in as a user with Administrator privileges to run them. In this appendix, those commands are preceded by the root prompt (#) in the command examples.

Additional Topics on SRVCTL

Difference between Using SRVCTL and CRSCTL

Use SRVCTL to manage Oracle-supplied resources such as listener, instances, disk groups, and networks, and CRSCTL for managing Oracle Clusterware and its resources.

Stopping Active SRVCTL Commands

Although you may be able to cancel running SRVCTL commands by pressing the Control-C keys, you may corrupt your configuration data by doing this.

You are strongly advised not to attempt to terminate SRVCTL in this manner.

Deprecated Subprograms or Commands

The following command options have been deprecated for Oracle Database 11g release 2 (11.2):

srvctl add asm

-n node_name

-i instance_name

-o Oracle_home

-p spfile

srvctl add database

-A {name | IP_address}/netmask

srvctl add listener

-n node_name

srvctl config database

-t

srvctl config listener

-n node_name

srvctl config nodeapps

-n node_name

-l

srvctl config asm

-i instance_name

srvctl disable nodeapps

-n node_name

srvctl enable asm

-i instance_name

srvctl enable nodeapps

-n node_name

srvctl getenv instance

-d db_unique_name

-i instance_name

-t "name=val_list"

srvctl getenv nodeapps

-n node_name

srvctl getenv service

-d db_unique_name

-s service_name

-t "name=val_list"

srvctl modify asm

-o Oracle_home

srvctl modify instance

-s asm_inst_name

-r

srvctl remove asm

-n node_name

-i instance_name

srvctl remove listener

-n node_name

srvctl remove nodeapps

-n "node_name_list"

srvctl setenv instance

-d db_unique_name

-i instance_name

-t "name=val_list"

-T "name=val"

srvctl setenv nodeapps

-n node_name

srvctl setenv service

-d db_unique_name

-s service_name

-t "name=val_list"

-T "name=val"

srvctl start asm

-i instance_name

srvctl status instance

-S level

srvctl status nodeapps

-n node_name

srvctl stop asm

-i instance_name

srvctl unsetenv instance

-d db_unique_name

-i instance_name

-t "name=val_list"

srvctl unsetenv nodeapps

-n node_name

srvctl unsetenv service

-d db_unique_name

-s service_name

-t "name=val_list"

SRVCTL Command Reference

SRVCTL Command Syntax and Options

SRVCTL commands, object names, and options are case sensitive. Database, instance, listener, and service names are case insensitive and case preserving. You cannot create listener names that differ only in case, such as LISTENER and listener. SRVCTL uses the following command syntax:

srvctl command object [options]

In SRVCTL syntax:

• command is a verb such as start, stop, or remove

• object is the target or object on which SRVCTL performs the command, such as database or instance. You can also use object abbreviations.

• options extend the use of a preceding command combination to include additional parameters for the command. For example, the -i option indicates that a comma-delimited list of preferred instance names follows; sometimes the -i option only permits one value and not a list of names. The -n option indicates that a node name or a comma-delimited list of node names follows. Do not use spaces between the items in a comma-delimited list.

SRVCTL Objects Summary

Table A-4 lists the keywords that can be used for the object portion of SRVCTL 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.

add

The srvctl add command adds the configuration and the Oracle Clusterware applications to OCR for the cluster database, named instances, named services, or for the named nodes. To perform srvctl add operations, you must be logged in as the database administrator and be the Oracle account owner on Linux and UNIX systems, or you must be logged on as a user with Administrator privileges on Windows systems.

When adding an instance, the name that you specify with -i must match the ORACLE_SID parameter. The database name given with -d db_unique_name must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME. Also, the domain name given with -m db_domain must match the DB_DOMAIN setting.

srvctl add asm

Adds a record for an Oracle ASM instance to the entire cluster. This command needs to be run only one time from the Oracle Grid Infrastructure home.

Syntax and Options

Use the srvctl add asm command with the following syntax:

srvctl add asm [-l listener_name]

This command has only one option, -l, which calls for the name of a listener. If you do not specify this option, then the listener name defaults to LISTENER.

Example

To add a clusterware resource for Oracle ASM on every node in the cluster, use the following command:

srvctl add asm

srvctl add cvu

Starting with Oracle Database 11g Release 2 (11.2.0.2), this command adds the Cluster Verification Utility (CVU) to an Oracle Clusterware configuration.

Syntax and Options

Use the srvctl add cvu command with the following syntax:

srvctl add cvu [-t check_interval_in_minutes]

-t check_interval_in_minutes

Examples

An example of this command to add CVU with a check interval of 6 hours is:

$ srvctl add cvu -t 360

srvctl add database

Adds a database configuration to your cluster database configuration.

Syntax and Options

Use the srvctl add database command with the following syntax:

srvctl add database -d db_unique_name -o oracle_home
     [-x node_name] [-m domain_name] [-p spfile]
     [-c  {RACONENODE | RAC | SINGLE} [-e server_list] [-i instance_name] [-w timeout]]
     [-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | SNAPSHOT_STANDBY}]
     [-s start_options] [-t stop_options] [-n db_name -j "acfs_path_list"]
     [-y {AUTOMATIC | MANUAL | NORESTART}] [-g server_pool_list] [-a disk_group_list]

-d db_unique_name

-o oracle_home

-x node_name

-m db_domain

-p spfile

-c {RACONENODE | RAC | SINGLE}

-e server_list

-i instance_name

-w timeout

-r {PRIMARY | PHYSICAL_STANDBY |
 LOGICAL_STANDBY |
 SNAPSHOT_STANDBY}

-s start_options

-t stop_options

-n db_name

-j "acfs_path_list"

-y {AUTOMATIC | MANUAL |
 NORESTART}

-g "server_pool_list"

-a "disk_group_list"

Examples

An example of this command to add a policy-managed database is:

srvctl add database -d crm -o /u01/oracle/product/112/mydb -m foo.com
     -p +diskgroup1/crm/spfilecrm.ora -r PHYSICAL_STANDBY -s MOUNT -t NORMAL
     -n database2 -y MANUAL -g svrpool1,svrpool2 -a "diskgroup1,diskgroup2"

An example of this command to add an administrator-managed database is:

srvctl add database -d crm -o /u01/oracle/product/112/mydb -m foo.com

srvctl add filesystem

Adds a disk device to Oracle ACFS. This command needs to be run only one time from the Oracle Grid Infrastructure home.

An Oracle ACFS file system resource is typically created for use with application resource dependency lists. For example, if an Oracle ACFS file system is configured for use as an Oracle Database home, then a resource created for the file system can be included in the resource dependency list of the Oracle Database application. This will cause the file system and stack to be automatically mounted as a result of the start action of the database application.

Syntax and Options

Use the srvctl add filesystem command with the following syntax:

srvctl add filesystem -d volume_device -v volume_name -g diskgroup_name
                      [-m mountpoint_path] [-u user_name]

-d volume_device

-v volume_name

-g diskgroup_name

-m mountpoint_path

-u user_name

Example

An example of this command is the following:

srvctl add filesystem -d /dev/asm/d1volume1-295 -v VOLUME1 -d RAC_DATA \
  -m /oracle/cluster1/acfs1

srvctl add gns

Use this command to add the Grid Naming Service (GNS) to a cluster when you are using a DHCP public network.

Syntax and Options

Use the srvctl add gns command with the following syntax:

srvctl add gns -i ip_address -d domain

-i ip_address

-d domain

Example

An example of this command is:

srvctl add gns -i 192.168.16.17 -d cluster.mycompany.com

srvctl add instance

Adds a configuration for an instance to your cluster database configuration.

You can only use this command for administrator-managed databases. If you have a policy-managed database, then use the srvctl modify srvpool command to add an instance to increase either the maximum size, minimum size, or both, of the server pool used by the database.

Syntax and Options

Use the srvctl add instance command with the following syntax:

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

-d db_unique_name

-i instance_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

srvctl add listener

Adds a listener to every node in a cluster.

Syntax and Options

Use the srvctl add listener command with the following syntax:

srvctl add listener [-l listener_name] [-o Oracle_home] 
    [-p "[TCP:]port_list[/IPC:key][/NMP:pipe_name][/TCPS:s_port][/SDP:port]"]
    [-k network_number] [-s]

-l listener_name

-o oracle_home

-p "[TCP:]port_list [/IPC:key]
[/NMP:pipe_name]
[/TCPS:s_port]
[/SDP:port]

-k network_number

-s

Example

The following command adds a listener named listener112 that is listening on port 1341 and runs from the /ora/ora112 home directory on every node in the cluster:

$ srvctl add listener -l listener112 -p 1341 -o /ora/ora112

srvctl add network

Adds a DHCP or static network. If your server connects to more than one network, then you can use this command to configure an additional network interface for Oracle RAC, allowing you to create VIPs on multiple public networks. You can also use the LISTENER_NETWORKS database initialization parameter to control client redirects to the appropriate network

Syntax and Options

Use the srvctl add network command with the following syntax:

srvctl add network [-k net_number] -S subnet/netmask[/if1[|if2|...]]
  [-w network_type] [-v]

-k net_number

-S subnet/netmask
[/if1[|if2|...]]

-w network_type

-v

Example

An example of this command is:

$ srvctl add network -k 3 -S 1.2.3.4/255.255.255.0

srvctl add nodeapps

Adds a node application configuration to the specified node.

Syntax and Options

Use the srvctl add nodeapps command with one the following syntax models:

srvctl add nodeapps -n node_name -A {name | ip}/netmask[/if1[|if2|...]]
  [-e em_port] [-l ons_local_port] [-r ons_remote-port]
  [-t host[:port][,host[:port],...]] [-v]
 

srvctl add nodeapps -S subnet/netmask[/if1[|if2|...]] [-e em_port]
  [-l ons_local_port] [-r ons_remote-port]
  [-t host[:port][,host[:port],...]] [-v]

-n node_name

-A {name | ip}
/netmask[/if1
|[if2|...]]

-S subnet/netmask
[/if1 [| if2 |...]]

-e em_port

-l ons_local_port

-r ons_remote_port

-t host[:port],
[host[:port],[...]

-v

Example

An example of this command is:

# srvctl add nodeapps -n crmnode1 -A 1.2.3.4/255.255.255.0

srvctl add oc4j

Adds an OC4J instance to all the nodes in the cluster.

Syntax and Options

srvctl add oc4j [-v]

This command has only one option, -v, which displays verbose output.

Example

An example of this command is:

srvctl add oc4j

srvctl add ons

Adds an Oracle Notification Service daemon to an Oracle Restart configuration.

Syntax and options

srvctl add ons [-l ons_local_port] [-r ons_remote_port] 
    [-t host[:port][,host[:port]][...]] [-v]

-l ons_local_port

-r ons_remote_port

-t host[:port][,host[:port]][...]

-v

Example

An example of this command is:

$ srvctl add ons -l 6200

srvctl add scan

Adds Oracle Clusterware resources for the given SCAN. This command creates the same number of SCAN VIP resources as the number of IP addresses that SCAN resolves to, or 3 when network_number identifies a DHCP network and Oracle GNS configuration.

Syntax and Options

Use the srvctl add scan command with the following syntax:

srvctl add scan -n scan_name [-k network_number]
  [-S subnet/netmask[/if1[|if2|...]]]

-n scan_name

-k network_number

-S subnet/netmask
[/if1 [|if2|...]]

Example

An example of this command is:

# srvctl add scan -n scan.mycluster.example.com

srvctl add scan_listener

Adds Oracle Clusterware resources to the SCAN listeners. The number of SCAN listener resources created is the number of SCAN VIP resources.

Syntax and Options

Use the srvctl add scan_listener command with the following syntax:

srvctl add scan_listener [-l lsnr_name_prefix] [-s]
  [-p "[TCP:]port_list[/IPC:key][/NMP:pipe_name][/TCPS:s_port] [/SDP:port]"]

-l lsnr_name_prefix

-s

-p "[TCP:]port_list
[/IPC:key][/NMP:pipe_name]
[/TCPS:s_port]
[/SDP:port]"

Example

An example of this command is:

# srvctl add scan_listener -l myscanlistener

srvctl add service

Adds services to a database and assigns them to instances. If you have multiple instances of a cluster database on the same node, then always use only one instance on that node for all of the services that node manages.

Syntax and Options

Use the srvctl add service command to create a service, using the first of the following syntax models, or to update an existing service, using the second syntax model:

srvctl add service -d db_unique_name -s service_name {-r "preferred_list"
   [-a "available_list"] [-P {BASIC | NONE | PRECONNECT}] | -g server_pool
   [-c {UNIFORM | SINGLETON]} [-k network_number]
   [-l [PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | SNAPSHOT_STANDBY]
   [-y {AUTOMATIC | MANUAL}] [-q {TRUE | FALSE}] [-x {TRUE | FALSE}]
   [-j {SHORT | LONG}][-B {NONE | SERVICE_TIME | THROUGHPUT}]
   [-e {NONE | SESSION | SELECT}] [-m {NONE | BASIC}] [-z failover_retries]
   [-w failover_delay]

srvctl add service -d db_unique_name -s service_name
   -u {-r preferred_list | -a available_list} [-f]

Table A-17 lists and describes all the srvctl add service options and whether they can be used when adding a service to a noncluster or Oracle RAC database.

-d db_unique_name

-s service_name

-r preferred_list

-a available_list

-P {BASIC | NONE | PRECONNECT}

-g server_pool

-c {UNIFORM | SINGLETON}

-k network_number

-l {[PRIMARY] |
[PHYSICAL_STANDBY] |
[LOGICAL_STANDBY] |
[SNAPSHOT_STANDBY]}

-y {AUTOMATIC | MANUAL}

-x {TRUE | FALSE}

-j {SHORT | LONG}

-B {NONE | SERVICE_TIME | THROUGHPUT}

-e {NONE | SESSION | SELECT}

-m {NONE | BASIC}

-z failover_retries

-w failover_delay

-u

-f

Examples

Use this example syntax to add the gl.example.com service to the my_rac database with AQ HA notifications enabled, a failover method of BASIC, a Connection Load Balancing Goal of LONG, a failover type of SELECT, and 180 failover retries with a delay of 5:

srvctl add service -d my_rac -s gl.example.com -m BASIC -e SELECT \
-z 180 -w 5 -j LONG

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

srvctl add srvpool

Adds a server pool that is configured to host Oracle databases to a cluster.

Syntax and Options

Use the srvctl add srvpool command with the following syntax:

srvctl add srvpool -g server_pool [-i importance] [-l min_size] [-u max_size]
     [-n node_list] [-f]

-g server_pool

-i importance

-l min_size

-u max_size

-n node_names

Example

An example of this command is:

$ srvctl add srvpool -g SP1 -i 1 -l 3 -u 7 -n mynode1,mynode2

srvctl add vip

Adds a VIP to a node.

Syntax and Options

Use the srvctl add vip command with the following syntax:

srvctl add vip -n node_name -A {name|ip}/netmask[/if1[if2|...]]
     [-k network_number] [-v]

-n node_name

-A {name|ip}/netmask
[/if1[|if2|...]]

-k network_number

-v

Example

An example of this command is:

# srvctl add vip -n node7 -A 192.168.16.17/255.255.255.0 -k 2

The preceding example creates a network number, 2, for the VIP just added. You can specify the network number after the -k option in other SRVCTL commands.

config

The srvctl config command displays the configuration stored in the Oracle Clusterware resource attributes.

srvctl config asm

Displays the configuration for all Oracle ASM instances.

Syntax and Options

Use the srvctl config asm command with the following syntax:

srvctl config asm [-a]

-a

Example

An example of this command is:

srvctl config asm -a

srvctl config cvu

Starting with Oracle Database 11g Release 2 (11.2.0.2), this command displays the time interval, in minutes, between CVU checks.

Syntax and Options

Use the srvctl config cvu command with the following syntax:

srvctl config cvu

This command has no options.

Examples

The srvctl config cvu command returns output similar to the following:

CVU is configured to run once every 360 minutes

srvctl config database

Displays the configuration for an Oracle RAC database or lists all configured databases that are registered with Oracle Clusterware.

Syntax and Options

Use the srvctl config database command with the following syntax:

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

-d db_unique_name

-a

Examples

To list the configuration of all databases, use the following example:

srvctl config database -d myDB

The following is example output from the srvctl config database command:

$ srvctl config database -d myDB
Database unique name: myDB
Database name:
Oracle home: /scott_st2/oracle
Oracle user: scott
Spfile:
Domain:
Start options: open
Stop options: immediate
Database role: PRIMARY
Management policy: AUTOMATIC
Server pools: myDB
Database instances:
Disk Groups:
Services: scottsvc1
Type: RACOneNode
Online relocation timeout: 30
Instance name prefix: myDB
Candidate servers: node1 node2
Database is administrator managed

The preceding sample output shows the database type as RACOneNode, an Oracle RAC One Node database. Other potential types are RAC and SingleInstance. The Online relocation timeout, Instance name prefix, and Candidate servers fields only apply to Oracle RAC One Node databases and do not display for the other two database types. Similarly, the Database instances field is empty because the database type is RACOneNode.

srvctl config filesystem

Displays the configuration for an Oracle Automatic Storage Management Cluster File System (Oracle ACFS) device.

Syntax and Options

Use the srvctl config filesystem command with the following syntax:

srvctl config filesystem -d volume_device_path

-d volume_device_path

Examples

The following example shows how to retrieve the configuration for an Oracle ACFS file system:

srvctl config filesystem -d /dev/asm/d1volume293

srvctl config gns

Displays the configuration for GNS.

Syntax and Options

Use the srvctl config gns command with the following syntax:

srvctl config gns [-a] [-d] [-k] [-m] [-n node_name] [-p] [-s] [-V]
[-q name] [-l] [-v]

-a

-d

-k

-m

-n node_name

-p

-s

-V

-q name

-l

-v

srvctl config listener

Displays a list of configured listeners that are registered with Oracle Clusterware or displays detailed configuration information for a specific listener.

Syntax and Options

Use the srvctl config listener command with the following syntax:

srvctl config listener [-l listener_name] [-a]

-l listener_name

-a

Example

An example of this command is:

srvctl config listener

srvctl config nodeapps

Displays the VIP configuration for each node in the cluster.

Syntax and Options

Use the srvctl config nodeapps command with the following syntax:

srvctl config nodeapps [-a] [-g] [-s]

-a

-g

-s

Example

An example of this command is:

$ srvctl config nodeapps -a -g -s

srvctl config oc4j

Displays configuration information for the OC4J instance.

srvctl config oc4j

srvctl config ons

Displays configuration information for the Oracle Notification Service daemon.

srvctl config ons

srvctl config scan

Displays the configuration information for all SCAN VIPs, by default, or a specific SCAN VIP identified by ordinal_number.

Syntax and Options

Use the srvctl config scan command with the following syntax:

srvctl config scan [-i ordinal_number]

The only option available for this command is -i ordinal_number, which identifies any one of the three SCAN VIPs, and can take a range of values from 1 to 3.

Example

An example of this command is:

$ srvctl config scan -i 1

srvctl config scan_listener

Displays the configuration information for all SCAN listeners, by default, or a specific listener identified by ordinal_number.

Syntax and Options

Use the srvctl config scan_listener command with the following syntax:

srvctl config scan_listener [-i ordinal_number]

The only option available for this command is -i ordinal_number, which identifies any one of the three SCAN VIPs, and can take a range of values from 1 to 3.

Example

An example of this command is:

$ srvctl config scan_listener -i 1

srvctl config service

Displays the configuration for a service.

Syntax and Options

Use the srvctl config service command with the following syntax:

srvctl config service -d db_unique_name [-s service_name]

-d db_unique_name

-s service_name

Examples

An example output of this command is for a policy-managed database is:

$ srvctl config service -d mjkpdb -s mjkpsvc1
Service name: mjkpsvc1
Service is enabled
Server pool: mjksrvpool1
Cardinality: SINGLETON
Disconnect: false
Service role: PRIMARY
Management policy: AUTOMATIC
DTP transaction: false
AQ HA notifications: false
Failover type: NONE
Failover method: NONE
TAF failover retries: 0
TAF failover delay: 0
Connection Load Balancing Goal: LONG
Runtime Load Balancing Goal: NONE
TAF policy specification: NONE
Service is enabled on nodes:
Service is disabled on nodes:
Edition: "my Edition"

An example output of this command is for an administrator-managed database is:

$ srvctl config service -d mjkdb -s mjksvc1
Service name: mjksvc1
Service is enabled
Server pool: mjkdb
Cardinality: 1
Disconnect: false
Service role: PRIMARY
Management policy: AUTOMATIC
DTP transaction: false
AQ HA notifications: false
Failover type: NONE
Failover method: NONE
TAF failover retries: 0
TAF failover delay: 0
Connection Load Balancing Goal: LONG
Runtime Load Balancing Goal: NONE
TAF policy specification: NONE
Preferred instances: mjkdb_1
Available instances:
Edition: "my Edition"

Service configuration for administrator-managed Oracle RAC One Node databases displays the one instance as preferred.

srvctl config srvpool

Displays configuration information including name, minimum size, maximum size, importance, and a list of server names, if applicable, for a specific server pool in a cluster.

Syntax and Options

Use the srvctl config srvpool command with the following syntax:

srvctl config srvpool [-g server_pool]

Example

An example of this command is:

$ srvctl config srvpool -g dbpool

srvctl config vip

Displays all VIPs on all networks in the cluster except for user VIPs.

Syntax and Options

Use the srvctl config vip command with one of the following syntax models:

srvctl config vip -n node_name

srvctl config vip -i vip_name

-n node_name

-i vip_name

Example

An example of this command is:

$ srvctl config vip -n crmnode1

convert

Starting with Oracle Database 11g Release 2 (11.2.0.2), the srvctl convert command converts a database either to or from an Oracle RAC One Node database.

Syntax and Options

Use the srvctl convert database command with one of the following syntax models:

srvctl convert database -d db_unique_name -c RACONENODE [-i instance_name] [-w timeout]

srvctl convert database -d db_unique_name -c RAC [-n node_name]

-d db_unique_name

-c RACONENODE | RAC

-i instance_name

-w timeout

-n node_name

Example

An example of this command is:

$ srvctl convert database -d myDB -c RACONENODE -i instance_name

disable

Disables a specified object (cluster database, database instance, Oracle ASM instance, or service). Use the srvctl disable command when you must shut down an object for maintenance. The disabled object does not automatically restart.

When you issue the disable command, the object is disabled and unavailable to run under Oracle Clusterware for automatic startup, failover, or restart. Additionally, you cannot run the srvctl start command on a disabled object until you first re-enable the object. If you specify -i instance_name or -n node_name, then SRVCTL only disables the object on the specified instance or node.

If you do not specify -i instance_name or -n node_name, then the disable action applies to the object that you specified, globally, on all nodes in the cluster. Any object you disable globally is also disabled on any nodes you add to the cluster in the future.

Disabling an object globally is not the same as disabling an object locally on each node in the cluster. For example, if you disable a database on several nodes, individually, in a cluster, then, when you run the srvctl start database command, the database starts only on nodes where the database is enabled. If, however, you disable the database globally, then the srvctl start database is rejected because the database is disabled, clusterwide.

srvctl disable asm

Disables the Oracle ASM proxy resource. Oracle ASM will restart if it contains Oracle Clusterware data or if the node restarts and it was running before the node failed. The srvctl disable asm command also prevents the srvctl start asm command from starting Oracle ASM instances.

Disabling the Oracle ASM proxy resource prevents the databases and disk groups from starting because they depend on the Oracle ASM proxy resource.

Syntax and Options

Use the srvctl disable asm command with the following syntax:

srvctl disable asm [-n node_name]

-n node_name

Example

An example of this command is:

$ srvctl disable asm -n crmnode1

srvctl disable cvu

Starting with Oracle Database 11g Release 2 (11.2.0.2), this command disables the Cluster Verification Utility (CVU) for Oracle Clusterware management, if enabled.

Syntax and Options

Use the srvctl disable cvu command with the following syntax:

srvctl disable cvu [-n node_name]

You can specify a particular node on which to disable CVU.

-n node_name

Examples

An example of this command to disable CVU on a single node of a cluster is:

$ srvctl disable cvu -n crmnode1

srvctl disable database

Disables a database. If the database is a cluster database, then its instances are also disabled.

Syntax and Options

Use the srvctl disable database command with the following syntax:

srvctl disable database -d db_unique_name [-n node_name]

-d database_name

-n node_name

Example

An example of this command is:

$ srvctl disable database -d mydb1

srvctl disable diskgroup

Disables a specific disk group on a number of specified nodes.

Syntax and Options

Use the srvctl disable diskgroup command with the following syntax:

srvctl disable diskgroup -g diskgroup_name [-n node_list]

-g diskgroup_name

-n node_list

Example

An example of this command is:

$ srvctl disable diskgroup -g diskgroup1 -n mynode1, mynode2

srvctl disable filesystem

Disables an Oracle ACFS volume.

Syntax and Options

Use the srvctl disable filesystem command with the following syntax:

srvctl disable filesystem -d volume_device_name

-d volume_device_name

Example

An example of this command is:

$ srvctl disable filesystem -d /dev/asm/d1volume293

srvctl disable gns

Disables GNS for a specific node, or all available nodes in the cluster.

Syntax and Options

Use the srvctl disable gns command with the following syntax:

srvctl disable gns [-n node_name]

-n node_name

Example

An example of this command is:

$ srvctl disable gns -n crm7

srvctl disable instance

Disables an instance. If the instance that you disable with this command is the last enabled instance, then this operation also disables the database.

Syntax and Options

Use the srvctl disable instance command with the following syntax:

srvctl disable instance -d db_unique_name -i instance_name_list

-d db_unique_name

-i instance_name_list

Example

An example of this command is:

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

srvctl disable listener

Disables a listener resource.

Syntax and Options

Use the srvctl disable listener command with the following syntax:

srvctl disable listener [-l listener_name] [-n node_name]

-l listener_name

-n node_name

Example

An example of this command is:

$ srvctl disable listener -l listener_crm -n node5

srvctl disable nodeapps

Disables node applications on all nodes in the cluster.

Syntax and Options

Use the srvctl disable nodeapps command with the following syntax:

srvctl disable nodeapps [-g] [-v]

-g

-v

Example

An example of this command is:

$ srvctl disable nodeapps -g -v

srvctl disable oc4j

Disables the OC4J instance on all nodes or on a specific node.

Syntax and Options

Use the srvctl disable oc4j command with the following syntax:

srvctl disable oc4j [-n node_name] [-v]

-n node_name

-v

Example

An example of this command is:

$ srvctl disable oc4j -n crm3

srvctl disable ons

Disables the Oracle Notification Service daemon for Oracle Restart installations.

srvctl disable ons [-v]

The only option for this command is -v, which indicates that verbose output should be displayed.

srvctl disable scan

Disables all SCAN VIPs, by default, or a specific SCAN VIP identified by ordinal_number.

Syntax and Options

Use the srvctl disable scan command with the following syntax:

srvctl disable scan [-i ordinal_number]

The only option available for this command is -i ordinal_number, which represents which identifies any one of the three SCAN VIPs, and can take a range of values from 1 to 3.

Example

An example of this command is:

$ srvctl disable scan -i 1

srvctl disable scan_listener

Disables all SCAN listeners, by default, or a specific listener identified by ordinal_number.

Syntax and Options

Use the srvctl disable scan_listener command with the following syntax:

srvctl disable scan_listener [-i ordinal_number]

The only option available for this command is -i ordinal_number, which identifies any one of the three SCAN listeners, and can take a range of values from 1 to 3.

Example

An example of this command is:

$ srvctl disable scan_listener -i 1

srvctl disable service

Disables a service. Disabling an entire service affects all of the instances, disabling each one. When the entire service is already disabled, a srvctl disable service operation on the entire service affects all of the instances and disables them; it just returns an error. This means that you cannot always use the entire set of service operations to manipulate the service indicators for each instance.

Syntax and Options

Use the srvctl disable service command with the following syntax:

srvctl disable service -d db_unique_name
      -s "service_name_list" [-i instance_name | -n node_name]

If you do not specify either the -i instance_name or -n node_name options, then the command disables the service on all nodes.

-d db_unique_name

-s "service_name_list"

-i instance_name

-n node_name

Examples

The following example globally disables two services for the CRM database:

$ srvctl disable service -d crm -s "crm,marketing"

The following example disables a service for the CRM database that is running on the CRM1 instance, resulting in the service still being available for the database, but on one less instance:

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

srvctl disable vip

Disables a specific VIP.

Syntax and Options

Use the srvctl disable vip command with the following syntax:

srvctl disable vip -i vip_name [-v]

-i vip_name

-v

Example

An example of this command is:

$ srvctl disable vip -i vip1 -v

downgrade

Starting with Oracle Database 11g Release 2 (11.2.0.2), you can use the downgrade command to downgrade the database configuration after you manually downgrade the database.

srvctl downgrade database

The srvctl downgrade database command downgrades the configuration of a database and its services from its current version to the specified lower version.

Syntax and Options

Use the srvctl downgrade database command as follows:

srvctl downgrade database -d db_unique_name -o Oracle_home -t to_version

-d db_unique_name

-o Oracle_home

-t to_version

enable

The srvctl enable command enables the specified object so that it can run under Oracle Clusterware for automatic startup, failover, or restart. The Oracle Clusterware application supporting the object may be up or down to use this function. The default value is enable. If the object is already enabled, then the command is ignored. Enabled objects can be started, and disabled objects cannot be started.

srvctl enable asm

Enables an Oracle ASM instance.

Syntax and Options

Use the srvctl enable asm command with the following syntax:

srvctl enable asm [-n node_name]

-n node_name

Example

An example of this command is:

$ srvctl enable asm -n crmnode1

srvctl enable cvu

Starting with Oracle Database 11g Release 2 (11.2.0.2), this command enables the Cluster Verification Utility (CVU) for Oracle Clusterware management if disabled.

Syntax and Options

Use the srvctl enable cvu command with the following syntax:

srvctl enable cvu [-n node_name]

You can specify a particular node on which to enable CVU.

-n node_name

Examples

An example of this command to enable CVU on a single node of a cluster is:

$ srvctl enable cvu -n crmnode1

srvctl enable database

Enables a cluster database and its instances.

Syntax and Options

Use the srvctl enable database command with the following syntax:

srvctl enable database -d db_unique_name [-n node_name]

-d database_name

-n node_name

Example

An example of this command is:

$ srvctl enable database -d mydb1

srvctl enable diskgroup

Enables a specific disk group on a number of specified nodes.

Syntax and Options

Use the srvctl enable diskgroup command with the following syntax:

srvctl enable diskgroup -g diskgroup_name [-n node_list]

-g diskgroup_name

-n node_list

Example

An example of this command is:

$ srvctl enable diskgroup -g diskgroup1 -n mynode1,mynode2

srvctl enable filesystem

Enables an Oracle ACFS volume.

Syntax and Options

Use the srvctl enable filesystem command with the following syntax:

srvctl enable filesystem -d volume_device_name 

-d volume_device_name

Example

An example of this command is:

$ srvctl enable filesystem  -d /dev/asm/d1volume293

srvctl enable gns

Enables GNS on all nodes or a specific node.

Syntax and Options

Use the srvctl enable gns command with the following syntax:

srvctl enable gns [-n node_name]

-n node_name

Example

An example of this command is:

$ srvctl enable gns

srvctl enable instance

Enables an instance for an Oracle RAC database. If you use this command to enable all instances, then the database is also enabled.

Syntax and Options

Use the srvctl enable instance command with the following syntax:

srvctl enable instance -d db_unique_name -i instance_name_list

-d db_unique_name

-i instance_name_list

Example

An example of this command is:

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

srvctl enable listener

Enables a listener resource.

Syntax and Options

Use the srvctl enable listener command with the following syntax:

srvctl enable listener [-l listener_name] [-n node_name]

-l listener_name

-n node_name

Example

An example of this command is:

$ srvctl enable listener -l listener_crm -n node5

srvctl enable nodeapps

Enables the node applications on all nodes in the cluster.

Syntax and Options

Use the srvctl enable nodeapps command with the following syntax:

srvctl enable nodeapps [-g] [-v]

-g

-v

Example

An example of this command is:

$ srvctl enable nodeapps -g -v

srvctl enable oc4j

Enables the OC4J instance on all nodes or on a specific node.

Syntax and Options

Use the srvctl enable oc4j command with the following syntax:

srvctl enable oc4j [-n node_name] [-v]

-n node_name

-v

Example

An example of this command is:

$ srvctl enable oc4j -n crm3

srvctl enable ons

Enables the Oracle Notification Service daemon.

Syntax and Options

Use the srvctl enable ons command with the following syntax:

srvctl enable ons [-v]

The only option for this command is -v, which indicates that verbose output should be displayed.

Example

An example of this command is:

$ srvctl enable ons

srvctl enable scan

Enables all SCAN VIPs, by default, or a specific SCAN VIP identified by its ordinal_number.

Syntax and Options

Use the srvctl enable scan command with the following syntax:

srvctl enable scan [-i ordinal_number]

The only option available for this command is -i ordinal_number, which identifies any one of the three SCAN VIPs, and takes a range of values from 1 to 3.

Example

An example of this command is:

$ srvctl enable scan -i 1

srvctl enable scan_listener

Enables all SCAN listeners, by default, or a specific listener identified by its ordinal_number.

Syntax and Options

Use the srvctl enable scan_listener command with the following syntax:

srvctl enable scan_listener [-i ordinal_number]

The only option available for this command is -i ordinal_number, which identifies any one of the three SCAN listeners, and takes a range of values from 1 to 3.

Example

An example of this command is:

$ srvctl enable scan_listener -i 1

srvctl enable service

Enables a service for Oracle Clusterware. Enabling an entire service also affects the enabling of the service over all of the instances by enabling the service at each one. When the entire service is already enabled, an srvctl enable service operation does not affect all of the instances and enable them. Instead, this operation returns an error. Therefore, you cannot always use the entire set of service operations to manipulate the service indicators for each instance.

Syntax and Options

Use the srvctl enable service command with the following syntax:

srvctl enable service -d db_unique_name -s "service_name_list"
     [-i instance_name | -n node_name]

-d db_unique_name

-s service_name_list

-i instance_name

-n node_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

srvctl enable vip

Enables a specific VIP.

Syntax and Options

Use the srvctl enable vip command with the following syntax:

srvctl enable vip -i vip_name [-v]

-i vip_name

-v

Example

An example of this command is:

$ srvctl enable vip -i crm1-vip -v

getenv

Gets and displays values for the environment variables from the configuration file. Use SRVCTL with the setenv, getenv, and unsetenv verbs to administer the environment configurations for databases, instances, services, and node applications.

srvctl getenv asm

Displays the values for environment variables associated with Oracle ASM.

Syntax and Options

Use the srvctl getenv asm command with the following syntax:

srvctl getenv asm [-t "name_list"]

-t "name_list"

Example

The following example displays the current values for all the environment variables used by Oracle ASM:

$ srvctl getenv asm

srvctl getenv database

Displays the values for environment variables associated with a database.

Syntax and Options

Use the srvctl getenv database command with the following syntax:

srvctl getenv database -d db_unique_name [-t "name_list"]

-d db_unique_name

-t "name_list"

Example

The following example gets the environment configuration for the CRM database:

$ srvctl getenv database -d crm

srvctl getenv listener

Gets the environment variables for the specified listener.

Syntax and Options

Use the srvctl getenv listener command with the following syntax:

srvctl getenv listener [-l listener_name] [-t "name_list"]

-l listener_name

-t "name_list"

Example

The following example lists all environment variables for the default listener:

$ srvctl getenv listener

srvctl getenv nodeapps

Gets the environment variables for the node application configurations.

Syntax and Options

Use the srvctl getenv nodeapps command with the following syntax:

srvctl getenv nodeapps [-a] [-g] [-s] [-t "name_list"] [-v]

-a

-g

-s

-t "name_list"

-v

Example

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

$ srvctl getenv nodeapps -a

srvctl getenv vip

Gets the environment variables for the specified VIP.

Syntax and Options

Use the srvctl getenv vip command with the following syntax:

srvctl getenv vip -i vip_name [-t "name_list"] [-v]

-i vip_name

-t "name_list"

-v

Example

The following example lists all environment variables for the specified VIP:

$ srvctl getenv vip -i node1-vip

modify

Enables you to modify the instance configuration without removing and adding Oracle Clusterware resources. Using modify preserves the environment in the OCR configuration that would otherwise need to be re-entered. The configuration description is modified in the OCR configuration, and a new Oracle Clusterware profile is generated and registered. The change takes effect when the application is next restarted.

srvctl modify asm

Modify the listener used by Oracle ASM, the disk group discovery string used by Oracle ASM, or the SPFILE used by Oracle ASM for a noncluster database or a cluster database.

Syntax and Options

Use the srvctl modify asm command with the following syntax:

srvctl modify asm [-n node_name] [-l listener_name] 
     [-d asm_diskstring] [-p spfile_path_name]

-n node_name

-l listener_name

-d asm_diskstring

-p spfile_path_name

Example

An example of this command to modify the configuration of Oracle ASM is:

$ srvctl modify asm -l lsnr1

srvctl modify cvu

Starting with Oracle Database 11g Release 2 (11.2.0.2), this command modifies the check interval for CVU in an Oracle Clusterware configuration.

Syntax and Options

Use the srvctl modify cvu command with the following syntax:

srvctl modify cvu [-t check_interval_in_minutes]

-t check_interval_in_minutes

Examples

An example of this command to modify CVU to a check interval of 4 hours is:

$ srvctl modify cvu -t 240

srvctl modify database

Modifies the configuration for a database.

Syntax and Options

Use the srvctl modify database command with the following syntax:

srvctl modify database -d db_unique_name [-n db_name]
     [-o oracle_home] [-u user_name] [-m db_domain] [-p spfile] 
     [-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | SNAPSHOT_STANDBY}]
     [-s start_options] [-t stop_options] [-y {AUTOMATIC | MANUAL | NORESTART}]
     [-g "server_pool_list"] [{-a "diskgroup_list" | -z}]
     [-e server_list] [-w timeout] [-j "acfs_path_list"]

-d db_unique_name

-n db_name

-o oracle_home

-u user_name

-m db_domain

-p spfile

-r role [PRIMARY |
 PHYSICAL_STANDBY |
 LOGICAL_STANDBY |
 SNAPSHOT_STANDBY]

-s start_options

-t stop_options

-y [AUTOMATIC |
 MANUAL | NORESTART]

-g "server_pool_list"

-a "diskgroup_list"

-z

-e server_list

-w timeout

-j "acfs_path_list"

Usage Notes

• The srvctl modify database command can convert administrator-managed databases to policy-managed databases. For a running administrator-managed database, if the server list is supplied, then the node where the database is running must be on that list. The instance name prefix cannot be modified after running the srvctl add database command.

• You cannot change the management policy from AUTOMATIC (using the -y option) for Oracle RAC One Node databases. Any attempt to do so results in an error message. The same is true for the -x option, which is used to change the node on which a noncluster database runs.

• For policy-managed Oracle RAC One Node databases, you can use the -g option to move an Oracle RAC One Node database between server pools but you can only specify one server pool. Specifying a list of server pools returns an error.

Examples

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

$ srvctl modify database -d crm -r logical_standby

The following example directs the racTest database to use the SYSFILES, LOGS, and OLTP Oracle ASM disk groups.

$ srvctl modify database -d racTest -a "SYSFILES,LOGS,OLTP"

srvctl modify filesystem

Modifies the name of the user that is authorized to mount and unmount the Oracle ACFS volume.

Syntax and Options

Use the srvctl modify filesystem command with the following syntax:

srvctl modify filesystem -d volume_device_name -u user_name 

-d volume_device_name

-u user_name

Examples

The following example changes the authorized user to sysad for the RACVOL1 volume:

$ srvctl modify filesystem -d /dev/asm/racvol1 -u sysad

srvctl modify gns

Modifies the IP address or domain used by GNS

Syntax and Options

Use the srvctl modify gns command with the following syntax:

srvctl modify gns [-i ip_address] [-d domain]

-i ip_address

-d domain

Example

An example of this command is:

$ srvctl modify gns -i 192.000.000.003

srvctl modify instance

For an administrator-managed database, this command modifies the configuration for a database instance from its current node to another node. For a policy-managed database, this command defines an instance name to use when the database runs on the specified node.

Syntax and Options

Use the srvctl modify instance command with the following syntax:

srvctl modify instance -d db_unique_name -i instance_name
     {-n node_name | -z}

-d db_unique_name

-i instance_name

-n node_name

-z

Examples

The following example to changes the configuration of an administrator-managed database, amdb, so that the database instance, amdb1, runs on the specified node, mynode:

$ srvctl modify instance -d amdb -i amdb1 -n mynode

The following example causes the policy-managed database pmdb, when and if it runs on mynode, to use the instance name pmdb1:

$ srvctl modify instance -d pmdb -i pmdb1 -n mynode

The following example removes the directive established by the previous example:

$ srvctl modify instance -d pmdb -i pmdb1 -z

srvctl modify listener

Modifies the listener name, ORACLE_HOME path or the listener endpoints, either for the default listener, or a specific listener, or for all the listeners represented in a given list of listener names, that are registered with Oracle Restart or with Oracle Clusterware on the specified node.

If you want to change the name of a listener, then use the srvctl remove listener and srvctl add listener commands.

Syntax and Options

Use the srvctl modify listener command with the following syntax:

srvctl modify listener [-l listener_name] [-o oracle_home] [-u user_name]
     [-p "[TCP:]port_list[/IPC:key][/NMP:pipe_name][/TCPS:s_port][/SDP:port]"]
     [-k network_number]

-l listener_name

-o oracle_home

-u user_name

-p "[TCP:]port_list [/IPC:key][/NMP:pipe_name]
[/TCPS:s_port][/SDP:port]"

-k network_number

Example

The following example changes the TCP ports for the default listener on the node mynode1:

$ srvctl modify listener -n mynode1 -p "TCP:1521,1522"

srvctl modify network

Modifies the subnet for a specified network.

Syntax and Options

Use the srvctl modify network command with one of the following syntax models:

srvctl modify network [-k network_number [-S subnet/netmask[/if1[|if2|...]]]
     [-w network_type] [-v]

-k network_number

-S subnet/netmask
[/if1[|if2|...]]

-w network_type

-v

Examples

The following example changes the subnet number, netmask, and interface list:

$ srvctl modify network -S 192.168.2.0/255.255.255.0/eth0

The following example changes the second network to DHCP:

$ srvctl modify network -k 2 -w dhcp

srvctl modify nodeapps

Modifies the configuration for a node application.

Syntax and Options

Use the srvctl modify nodeapps command with one of the following syntax models:

srvctl modify nodeapps [-n node_name -A new_vip_address]
[-S subnet/netmask[/if1[|if2|...]] [-u network_type]
     [-e em_port] [-l ons_local_port] [-r ons_remote_port]
     [-t host[:port][,host:port,...]] [-v]

-n node_name

-A new_vip_address/
netmask

-S subnet/netmask
[/if1[|if2|...]]

-u network_type

-e em_port

-l ons_local_port

-r ons_remote_port

-t host:port, [host:port,...]

-v

Example

The following example changes the nodeapps resource on mynode1 to use the application VIP of 100.200.300.40 with a subnet mask of 255.255.255.0 on the network interface eth0:

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

srvctl modify oc4j

Modifies the RMI port for the OC4J instances.

Syntax and Options

Use the srvctl modify oc4j command with the following syntax:

srvctl modify oc4j -p oc4j_rmi_port [-v]

-p oc4j_rmi_port

-v

Example

An example of this command is:

$ srvctl modify oc4j -p 5385

srvctl modify ons

Modifies the ports used by the Oracle Notification Service daemon that is registered with Oracle Restart.

Syntax and Options

Use the srvctl modify ons command with the following syntax:

srvctl modify ons [-l ons_local_port] [-r ons_remote_port]
     [-t host[:port][,host[:port]][...]] [-v]

-l ons_local_port

-r ons_remote_port

-t host[:port]
[,host[:port]][...]]

srvctl modify scan

Modifies the number of SCAN VIPs to the match the number of IP addresses returned by looking up the scan_name you specify in DNS. Presumably the scan_name has not changed, but DNS was changed to add or remove IP addresses, and now you must adjust the Oracle Clusterware resource configuration to match.

Syntax and Options

Use the srvctl modify scan command with the following syntax:

srvctl modify scan -n scan_name

The only option available for this command is -n scan_name, which identifies the SCAN name that resolves to the SCAN VIPs that you want to use.

Example

Assume your system currently has a SCAN named scan_name1, and it resolves to a single IP address in DNS. If you modify the SCAN scan_name1 in DNS to resolve to three IP addresses, then use the following command to create the additional SCAN VIP resources:

$ srvctl modify scan -n scan_name1

srvctl modify scan_listener

Modifies the SCAN listener to match SCAN VIP's or modifies the SCAN listener endpoints.

Syntax and Options

Use the srvctl modify scan_listener command with the following syntax:

srvctl modify scan_listener {-p [TCP:]port[/IPC:key][/NMP:pipe_name]
     [/TCPS:s_port][/SDP:port] | -u }

-p [TCP:]port[/IPC:key]
[/NMP:pipe_name]
[/TCPS:s_port][/SDP:port]

-u

Example

Assume your system currently has a SCAN named scan_name1, and you recently modified the DNS entry to resolve to three IP addresses instead of one. After running the srvctl modify scan command to create additional SCAN VIP resources, use the following command to create Oracle Clusterware resources for the additional two SCAN listeners to go with the two additional SCAN VIPs:

$ srvctl modify scan_listener -u

srvctl modify service

Moves a service member from one instance to another. Additionally, this command changes which instances are to be the preferred and the available instances for a service. This command supports some online modifications to the service, such as:

• Service attributes from DBMS_SERVICE (for example, failover delay, Runtime Load Balancing Goal, and so on) can be changed online but the changes take effect only when the service is next (re)started.

• When a service configuration is modified so that a new preferred or available instance is added, the running state of the existing service is not affected. However, the newly added instances will not automatically provide the service, until a srvctl start service command is issued as described.

• When there are available instances for the service, and the service configuration is modified so that a preferred or available instance is removed, the running state of the service may change unpredictably:

  • The service is stopped and then removed on some instances according to the new service configuration.

  • The service may be running on some instances that are being removed from the service configuration.

  • These services will be relocated to the next free instance in the new service configuration.

As a result of these considerations, when the online service is being modified, users may experience a brief service outage on some instances even if the instances are not being removed. Or users may experience a brief service outage on instances that are being removed from the service.

Syntax and Options

Use one of the following forms of the srvctl modify service command with the specified syntax:

To move a service from one instance to another:

srvctl modify service -d db_unique_name -s service_name -i old_instance_name
  -t new_instance_name [-f]

-d db_unique_name

-s service_name

-i old_instance_name

-t new_instance_name

-f

To change an available instance to a preferred instance for a service:

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

-d db_unique_name

-s service_name

-t edition_name

-i available_inst_name

-r

-f

To change the available and preferred status for multiple instances:

srvctl modify service -d db_unique_name -s service_name -n -i preferred_list 
     [-a available_list] [-f]

-d db_unique_name

-s service_name

-n

-i preferred_instance_list

-a available_instance_list

-f

To modify other service attributes or to modify a service for Oracle Clusterware:

srvctl modify service -d db_unique_name -s service_name
     [-g server_pool] [-c {UNIFORM|SINGLETON}] [-P {BASIC|PRECONNECT|NONE}] 
     [-l {[PRIMARY] | [PHYSICAL_STANDBY] | [LOGICAL_STANDBY] | [SNAPSHOT_STANDBY]}
     [-q {TRUE|FALSE}] [-x {TRUE|FALSE}] [-j {SHORT|LONG}] 
     [-B {NONE|SERVICE_TIME|THROUGHPUT}] [-e {NONE|SESSION|SELECT}] 
     [-m {NONE|BASIC}] [-z failover_retries] [-w failover_delay]
     [-y {AUTOMATIC | MANUAL}]

-d db_unique_name

-s service_name

-g server_pool

-c {UNIFORM | SINGLETON}

-P {BASIC|PRECONNECT|NONE}

-l {[PRIMARY] | [PHYSICAL
_STANDBY] | [LOGICAL
_STANDBY] | [SNAPSHOT
_STANDBY]}

-q {TRUE | FALSE}

-x {TRUE | FALSE}

-j {SHORT | LONG}

-B {NONE | SERVICE_TIME | THROUGHPUT}

-e {NONE | SESSION | SELECT}

-m {NONE | BASIC}

-z failover_retries

-w failover_delay

-y {AUTOMATIC | MANUAL}

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

The following command exchanges a preferred and available instance:

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

srvctl modify srvpool

Modifies a server pool in a cluster. If minimum size, maximum size, and importance are numerically increased, then the CRS daemon may attempt to reassign servers to this server pool, if by resizing other server pools have comparatively lower minimum size and importance, to satisfy new sizes of this server pool.

Syntax and Options

Use the srvctl modify srvpool command with the following syntax:

srvctl modify srvpool -g server_pool [-i importance] [-l min_size]
     [-u max_size] [-n node_name_list] [-f]

-g server_pool

-i importance

-l min_size

-u max_size

-n node_name_list

-f

Example

The following example changes the importance rank to 0, the minimum size to 2, and the maximum size to 4 for the server pool srvpool1 on the nodes mynode3 and mynode4:

$ srvctl modify srvpool -g srvpool1 -i 0 -l 2 -u 4 -n mynode3, mynode4

relocate

The relocate command causes the specified object to run on a different node. The specified object must be running already.

The relocation of the object is temporary until you modify the configuration. The previously described modify command permanently changes the configuration.

srvctl relocate cvu

Starting with Oracle Database 11g release 2 (11.2.0.2), this command temporarily relocates the CVU to another node in a cluster.

Syntax and Options

Use the srvctl relocate cvu command with the following syntax:

srvctl relocate cvu [-n node_name]

-n node_name

Examples

An example of this command to temporarily relocate CVU to another node in a cluster is:

$ srvctl relocate cvu -n crmnode2

srvctl relocate database

Starting with Oracle Database 11g release 2 (11.2.0.2), the srvctl relocate database command initiates the relocation of an Oracle RAC One Node database from one node to another node. This command also cleans up after a failed relocation.

The srvctl relocate database command can only be used for relocating Oracle RAC One Node databases.

Syntax and Options

Use the srvctl relocate database command with the following syntax:

srvctl relocate database -d db_unique_name {[-n target_node] [-w timeout] | -a
 [-r]} [-v]

-d db_unique_name

-n target

-w timeout

-a

-r

-v

Usage Notes

• If the Oracle RAC One Node database you want to relocate is not running, then the command returns an error.

• If another online database relocation is active for this Oracle RAC One Node database, then the command returns an error.

• If an online database relocation for this Oracle RAC One Node database has failed and the target nodes are not the same for either relocation, then the command returns an error instructing you to abort the failed online database relocation and then initiate a new one.

• If an online database relocation for this Oracle RAC One Node database has failed and the target nodes are the same (or you do not specify the target), then the command attempts to relocate the database.

Example

The following example relocates an Oracle RAC One Node database named rac1 to a server called node7.

srvctl relocate database -d rac1 -n node7

srvctl relocate gns

Relocates GNS from its current hosting node to another node within the cluster.

Syntax and Options

Use the srvctl relocate gns command with the following syntax:

srvctl relocate gns [-n node_name]

-n node_name

Example

An example of this command is:

$ srvctl relocate gns -n node1

srvctl relocate oc4j

Relocates an OC4J instance from its current hosting node to another node within the cluster.

Syntax and Options

Use the srvctl relocate oc4j command with the following syntax:

srvctl relocate oc4j [-n node_name] [-v]

-n node_name

Example

An example of this command is:

$ srvctl relocate oc4j -n staih01 -v

srvctl relocate scan

Relocates a specific SCAN VIP from its current hosting node to another node within the cluster.

Syntax and Options

Use the srvctl relocate scan command with the following syntax:

srvctl relocate scan -i ordinal_number [-n node_name]

-i ordinal_number

-n node_name

Example

An example of this command is:

$ srvctl relocate scan -i 1 -n node1

srvctl relocate scan_listener

Relocates a specific SCAN listener from its current hosting node to another node within the cluster.

Syntax and Options

Use the srvctl relocate scan_listener command with the following syntax:

srvctl relocate scan_listener -i ordinal_number [-n node_name]

-i ordinal_number

-n node_name

Example

An example of this command is:

$ srvctl relocate scan_listener -i 1 -n node3

srvctl relocate server

Relocates servers to a server pool in the cluster.

Syntax and Options

Use the srvctl relocate server command with the following syntax:

srvctl relocate server -n "server_name_list" -g server_pool_name [-f]

-n "server_name_list"

-g server_pool_name

-f

Example

An example of this command is:

$ srvctl relocate server -n "server1, server2" -g sp3

srvctl relocate service

Relocates the named service names from one named instance to another named instance. The srvctl relocate command works on only one source instance and one target instance at a time, relocating a service from a single source instance to a single target instance. The target instance must be on the preferred or available list for the service.

Syntax and Options

Use the srvctl relocate service command with the following syntax:

srvctl relocate service -d db_unique_name -s service_name
    {-c source_node -n target_node | -i old_instance_name -t new_instance_name}
    [-f]

-d db_unique_name

-s service_name

-c source_node

-n target_node

-i old_instance_name

-t new_instance_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

srvctl relocate vip

Relocates a specific VIP from its current hosting node to another node within the cluster.

Syntax and Options

Use the srvctl relocate vip command with the following syntax:

srvctl relocate vip -i vip_name [-n node_name] [-f]

-i vip_name

-n node_name

-f

Example

An example of this command is:

$ srvctl relocate vip -i vip1 -n node3

remove

Removes the configuration information for the specified target from Oracle Clusterware. Environment settings for the object are also removed. Using this command does not destroy the specified target.

Use the remove verb to remove the associated resource from the management of Oracle Clusterware or Oracle Restart. Depending on the noun used, you can remove databases, services, nodeapps, Oracle ASM, Oracle Notification Service, and listeners.

If you do not use the force flag (-f), then Oracle Clusterware or Oracle Restart prompts you to confirm whether to proceed. If you use the force (-f) option, then the remove operation proceeds without prompting and continues processing even when it encounters errors. Even when the Oracle Clusterware resources cannot be removed, the OCR configuration is removed, so that the object now appears not to exist, but there are still Oracle Clusterware resources. Use the force flag (-f) option with extreme caution because this could result in an inconsistent OCR.

To use the remove verb, you must first stop the node applications, database, instance, or service for which you are specifying srvctl remove. Oracle recommends that you perform a disable operation before using this command, but this is not required. You must stop the target object before running the srvctl remove command. See the stop command.

srvctl remove asm

Removes the Oracle ASM resource.

Syntax and Options

Use the srvctl remove asm command with the following syntax:

srvctl remove asm [-f]

The -f option is the only option you can use with this command and it forcefully removes an Oracle ASM resource.

Example

An example of this command is:

$ srvctl remove asm -f

srvctl remove cvu

Starting with Oracle Database 11g Release 2 (11.2.0.2), this command removes CVU from an Oracle Clusterware configuration.

Syntax and Options

Use the srvctl remove cvu command with the following syntax:

srvctl remove cvu [-f]

Use the -f option to remove a running or starting CVU.

Examples

An example of this command to remove CVU is:

$ srvctl remove cvu -f

srvctl remove database

Removes a database configuration.

Syntax and Options

Use the srvctl remove database command with the following syntax:

srvctl remove database -d db_unique_name [-f] [-y]

-d db_unique_name

-f

-y

Example

An example of this command is:

$ srvctl remove database -d crm

srvctl remove diskgroup

Removes a specific Oracle ASM disk group resource from Oracle Clusterware or Oracle Restart.

Syntax and Options

Use the srvctl remove diskgroup command with the following syntax:

srvctl remove diskgroup -g diskgroup_name [-n node_list] [-f]

-g diskgroup_name

-n node_list

-f

Example

An example of this command is:

$ srvctl remove diskgroup -g DG1 -f

srvctl remove filesystem

Removes a specific Oracle ACFS volume resource.

Syntax and Options

Use the srvctl remove filesystem command with the following syntax:

srvctl remove filesystem -d volume_device_name [-f]

-d volume_device_name

-f

Example

An example of this command is:

$ srvctl remove filesystem -d /dev/asm/d1volume293

srvctl remove gns

Removes GNS from the cluster.

Syntax and Options

Use the srvctl remove gns command with the following syntax:

srvctl remove gns [-f]

The only option for this command is -f, which indicates GNS should be removed regardless of any errors that might occur.

Example

An example of this command is:

$ srvctl remove gns

srvctl remove instance

Removes the configurations for an instance of an administrator-managed database. To remove the configurations of a policy-managed database, you must shrink the size of the server pool with the srvctl modify srvpool command.

If you use the -f option, then any services running on the instance stop. Oracle recommends that you reconfigure services to not use the instance to be removed as a preferred or available instance before removing the instance.

Syntax and Options

Use the srvctl remove instance command with the following syntax:

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

-d db_unique_name

-i instance_name

-f

Example

An example of this command is:

$ srvctl remove instance -d crm -i crm01

srvctl remove listener

Removes the configuration of the specified listener from Oracle Clusterware or Oracle Restart.

Syntax and Options

Use the srvctl remove listener command with the following syntax:

srvctl remove listener [-l listener_name] [-a] [-f]

-l listener_name

-a

-f

Examples

The following command removes the configuration of the listener named lsnr01:

$ srvctl remove listener -l lsnr01

srvctl remove nodeapps

Removes the node application configuration. You must have full administrative privileges to run this command. On Linux and UNIX systems, you must be logged in as root and on Windows systems, you must be logged in as a user with Administrator privileges.

Syntax

Use the srvctl remove nodeapps command as follows:

srvctl remove nodeapps [-f] [-y] [-v]

Example

An example of this command is:

# srvctl remove nodeapps

-f

-y

-v

srvctl remove oc4j

Removes the OC4J instance from the Oracle Clusterware configuration.

Syntax and Options

Use the srvctl remove oc4j command with the following syntax:

srvctl remove oc4j [-f] [-v]

-f

-v

srvctl remove ons

Removes Oracle Notification Service from the Grid Infrastructure home.

Syntax and Options

Use the srvctl remove ons command with the following syntax:

srvctl remove ons [-f] [-v]