Skip Headers
Oracle® Database Administrator's Guide
11g Release 2 (11.2)

Part Number E17120-05
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
View PDF

Stopping and Restarting Oracle Restart for Maintenance Operations

When several components in an Oracle home are managed by Oracle Restart, you can stop Oracle Restart and the components managed by Oracle Restart in the Oracle home. You can also disable Oracle Restart so that it is not restarted if the node reboots. You might need to do this when you are performing maintenance that includes the Oracle home, such as installing a patch. When the maintenance operation is complete, you can enable and restart Oracle Restart, and you can restart the components managed by Oracle Restart in the Oracle home.

Use both the SRVCTL utility and the CRSCTL utility for the stop and start operations:

To stop and start the components in an Oracle home while installing a patch:

  1. Prepare to run SRVCTL as described in "Preparing to Run SRVCTL".

  2. Use the SRVCTL utility to stop the components managed by Oracle Restart in an Oracle home:

    srvctl stop home -o oracle_home -s state_file [-t stop_options] [-f]
    

    where oracle_home is the complete path of the Oracle home and state_file is the complete path to the state file. State information for the Oracle home is recorded in the specified state file. Make a note of the state file location because it must be specified in Step 7.

    Before stopping the components in an Oracle Grid Infrastructure home, ensure that you first stop the components in a dependent Oracle Database home.

  3. If you are patching an Oracle Grid Infrastructure home, then disable and stop Oracle Restart. Otherwise, go to Step 4.

    To disable and stop Oracle Restart, use the CRSCTL utility to run the following commands:

    crsctl disable has
    
    crsctl stop has
    
  4. Perform the maintenance operation.

  5. Use the CRSCTL utility to enable automatic restart of the components managed by Oracle Restart:

    crsctl enable has
    
  6. Use the CRSCTL utility to start Oracle Restart:

    crsctl start has
    
  7. Use the SRVCTL utility to start the components that were stopped in Step 2:

    srvctl start home -o oracle_home -s state_file
    

    The state file must match the state file specified in Step 2.

  8. Optionally, use the SRVCTL utility to check the status of the components managed by Oracle Restart in the Oracle home:

    srvctl status home -o oracle_home -s state_file
    

Example 4-25 Stopping Components Managed by Oracle Restart in an Oracle Home

srvctl stop home -o /u01/app/oracle/product/11.2.0/dbhome_1 -s /usr1/or_state

Example 4-26 Starting Components Managed by Oracle Restart in an Oracle Home

srvctl start home -o /u01/app/oracle/product/11.2.0/dbhome_1 -s /usr1/or_state

Example 4-27 Displaying the Status of Components Managed by Oracle Restart in an Oracle Home

srvctl status home -o /u01/app/oracle/product/11.2.0/dbhome_1 -s /usr1/or_state

SRVCTL Command Reference for Oracle Restart

This section provides details about the syntax and options for SRVCTL commands specific to Oracle Restart. See Oracle Real Application Clusters Administration and Deployment Guide for the full list of SRVCTL commands.

SRVCTL Command Syntax and Options Overview

SRVCTL expects the following command syntax:

srvctl command object options

where:

Note:

On the Windows platform, when specifying a comma-delimited list, you must enclose the list within double-quotes ("...,..."). You must also use double-quotes on the UNIX and Linux platforms if any list member contains shell metacharacters.

Case Sensitivity SRVCTL commands and components are case insensitive. Options are case sensitive. Database and database service names are case insensitive and case preserving.

Table 4-7 Summary of SRVCTL Commands

Command Description

add

Adds a component to the Oracle Restart configuration.

config

Displays the Oracle Restart configuration for a component.

disable

Disables management by Oracle Restart for a component.

enable

Reenables management by Oracle Restart for a component.

getenv

Displays environment variables in the Oracle Restart configuration for a database, Oracle ASM instance, or listener.

modify

Modifies the Oracle Restart configuration for a component.

remove

Removes a component from the Oracle Restart configuration.

setenv

Sets environment variables in the Oracle Restart configuration for a database, Oracle ASM instance, or listener.

start

Starts the specified component.

status

Displays the running status of the specified component.

stop

Stops the specified component.

unsetenv

Unsets environment variables in the Oracle Restart configuration for a database, Oracle ASM instance, or listener.


SRVCTL Components Summary

Table 4-8 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 component keyword.

Table 4-8 Component Keywords and Abbreviations

Component Abbreviation Description

asm

asm

Oracle ASM instance

database

db

Database instance

diskgroup

dg

Oracle ASM disk group

filesystem

filesystem

Oracle ASM file system

home

home

Oracle home or Oracle Clusterware home

listener

lsnr

Oracle Net listener

service

serv

Database service

ons

ons

Oracle Notification Services (ONS)



add

The srvctl add command adds the specified component to the Oracle Restart configuration, and optionally sets Oracle Restart configuration parameters for the component. After a component is added, Oracle Restart begins to manage it, restarting it when required.

To perform srvctl add operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

Table 4-9 srvctl add Summary

Command Description

srvctl add asm

Adds an Oracle ASM instance.

srvctl add database

Adds a database.

srvctl add listener

Adds a listener.

srvctl add ons

Adds an ONS (used by Oracle Data Guard configurations with Oracle Data Guard Broker).

srvctl add service

Adds a database service managed by Oracle Restart.


Note:

There is no srvctl add command for Oracle ASM disk groups. Disk groups are automatically added to the Oracle Restart configuration when they are first mounted. If you remove a disk group from the Oracle Restart configuration and later want to add it back, connect to the Oracle ASM instance with SQL*Plus and use an ALTER DISKGROUP ... MOUNT command.

srvctl add asm

Adds an Oracle ASM instance to the Oracle Restart configuration.

Syntax and Options

Use the srvctl add asm command with the following syntax:

srvctl add asm [-l listener_name [-p spfile] [-d asm_diskstring]]

Table 4-10 srvctl add asm Options

Option Description
-l listener_name

Name of the listener with which Oracle ASM should register. A weak dependency is established with this listener. (Before starting the Oracle ASM instance, Oracle Restart attempts to start the listener. If the listener does not start, the Oracle ASM instance is still started. If the listener later fails, Oracle Restart does not restart Oracle ASM.)

If omitted, defaults to the listener named listener.

-p spfile

The full path of the server parameter file for the database. If omitted, the default SPFILE is used.

-d asm_diskstring

Oracle ASM disk group discovery string. An Oracle ASM discovery string is a comma-delimited list of strings that limits the set of disks that an Oracle ASM instance discovers. The discovery strings can include wildcard characters. Only disks that match one of the strings are discovered.



Example

An example of this command is:

srvctl add asm -l crmlistener

See Also:

Oracle Automatic Storage Management Administrator's Guide for more information about Oracle ASM disk group discovery strings

srvctl add database

Adds a database to the Oracle Restart configuration.

After adding a database to the Oracle Restart configuration, if the database then accesses data in an Oracle ASM disk group, a dependency between the database that disk group is created. Oracle Restart then ensures that the disk group is mounted before attempting to start the database.

However, if the database and Oracle ASM instance are not running when you add the database to the Oracle Restart configuration, you must manually establish the dependency between the database and its disk groups by specifying the -a option in the SRVCTL command. See the example later in this section.

Important:

When you manually add a database to the Oracle Restart configuration, you must also add the Oracle grid infrastructure software owner as a member of the OSDBA group of that database. This is because the grid infrastructure components must be able to connect to the database as SYSDBA to start and stop the database.

For example, if the host user who installed the grid infrastructure home is named grid and the OSDBA group of the new database is named dba, then user grid must be a member of the dba group.

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] 
  [-n db_name] [-p spfile] [-s start_options] [-t stop_options]
  [-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | SNAPSHOT_STANDBY}]
  [-y {automatic | manual}] [-a disk_group_list]

Table 4-11 srvctl add database Options

Syntax Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-o Oracle_home

The full path of Oracle home for the database.

-m domain_name

The domain for the database. Must match the DB_DOMAIN initialization parameter

-n db_name

If provided, must match the DB_NAME initialization parameter setting. You must include this option if DB_NAME is different from the unique name given by the -d option

-p spfile

The full path of the server parameter file for the database. If omitted, the default SPFILE is used.

-s start_options

Startup options for the database (OPEN, MOUNT, or NOMOUNT). If omitted, defaults to OPEN.

-t stop_options

Shutdown options for the database (NORMAL, IMMEDIATE, TRANSACTIONAL, or ABORT). If omitted, defaults to IMMEDIATE.

-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | SNAPSHOT_STANDBY}

The current role of the database (PRIMARY, PHYSICAL_STANDBY, SNAPSHOT_STANDBY, or LOGICAL_STANDBY). Applicable in Oracle Data Guard environments only.

-y {AUTOMATIC | MANUAL}

Management policy for the database. If AUTOMATIC (the default), the database is automatically restored to its previous running condition (started or stopped) upon restart of the database host computer. If MANUAL, the database is never automatically restarted upon restart of the database host computer. A MANUAL setting does not prevent Oracle Restart from monitoring the database while it is running and restarting it if a failure occurs.

-a disk_group_list

List of disk groups upon which the database is dependent. When starting the database, Oracle Restart first ensures that these disk groups are mounted. This option is required only if the database instance and the Oracle ASM instance are not started when adding the database. Otherwise, the dependency is recorded automatically between the database and its disk groups.



Examples

This example adds the database with the DB_UNIQUE_NAME dbcrm:

srvctl add database -d dbcrm -o /u01/app/oracle/product/11.2.0/dbhome_1

This example adds the same database and also establishes a dependency between the database and the disk groups DATA and RECOVERY.

srvctl add database -d dbcrm -o /u01/app/oracle/product/11.2.0/dbhome_1
  -a "DATA,RECOVERY"

srvctl add listener

Adds a listener to the Oracle Restart configuration.

Syntax and Options

Use the srvctl add listener command with the following syntax:

srvctl add listener [-l listener_name] [-p endpoints] [-s] [-o Oracle_home]

Table 4-12 srvctl add listener Options

Option Description
-l listener_name

Listener name. If omitted, defaults to LISTENER

-p endpoints

Comma separated TCP ports or listener endpoints. If omitted, defaults to TCP:1521. endpoints syntax is:

"[TCP:]port[, ...] [/IPC:key] [/NMP:pipe_name] [/TCPS:s_port] [/SDP:port]"
-s

Skip checking for port conflicts with the supplied endpoints

-o Oracle_home

Oracle home for the listener. If omitted, the Oracle Grid Infrastructure home is assumed.



Example

The following command adds a listener (named LISTENER) running out of the database Oracle home and listening on TCP port 1522:

srvctl add listener -p TCP:1522 -o /u01/app/oracle/product/11.2.0/dbhome_1

srvctl add ons

Adds an ONS to an Oracle Restart configuration.

ONS must be added to an Oracle Restart configuration to enable the sending of Fast Application Notification (FAN) events after an Oracle Data Guard failover.

When ONS is added to an Oracle Restart configuration, it is initially disabled. You can enable it with the srvctl enable ons command.

Syntax and Options

Use the srvctl add ons command with the following syntax:

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

Table 4-13 srvctl add ons Options

Option Description
-e em_port

ONS listening port for Oracle Enterprise Manager. The default is 2016.

-l ons_local_port

ONS listening port for local client connections. The default is 6100.

-r ons_remote_port

ONS listening port for connections from remote hosts. The default is 6200.

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

A list of host:port pairs of remote hosts that are part of the ONS network

Note: If port is not specified for a remote host, then ons_remote_port is used.

-v

Verbose output



srvctl add service

Adds a database service to the Oracle Restart configuration. Creates the database service if it does not exist. This method of creating a service is preferred over using the DBMS_SERVICE PL/SQL package.

Syntax and Options

Use the srvctl add service command with the following syntax:

srvctl add service -d db_unique_name -s service_name
  [-l [PRIMARY][,PHYSICAL_STANDBY][,LOGICAL_STANDBY][,SNAPSHOT_STANDBY]]
  [-y {AUTOMATIC | MANUAL}] [-e {NONE | SESSION | SELECT}] [-m {NONE | BASIC}]
  [-w integer] [-z integer] [-j {SHORT | LONG}]
  [-B {SERVICE_TIME | THROUGHPUT | NONE}] [-q {TRUE | FALSE}] -t edition_name

Table 4-14 srvctl add service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name

The database service name

-l [PRIMARY][,PHYSICAL_STANDBY][,LOGICAL_STANDBY][,SNAPSHOT_STANDBY]

A list of service roles. Applicable in Oracle Data Guard environments only. When this option is present, upon database startup, the service is started only when one of its service roles matches the current database role.

-y {AUTOMATIC | MANUAL}

Management policy for the service. If AUTOMATIC (the default), the service is automatically started upon restart of the database, either by a planned restart (with SRVCTL) or after a failure. Automatic restart is also subject to the service role, however (the -l option). If MANUAL, the service is never automatically restarted upon planned restart of the database (with SRVCTL). A MANUAL setting does not prevent Oracle Restart from monitoring the service when it is running and restarting it if a failure occurs.

-e {NONE |SESSION | SELECT}

Failover type. For standalone servers, applicable in Oracle Data Guard environments only.

-m {NONE | BASIC}

Failover method. For standalone servers, applicable in Oracle Data Guard environments only.

-w integer

Failover delay. For standalone servers, applicable in Oracle Data Guard environments only.

-z integer

Failover retries. For standalone servers, applicable in Oracle Data Guard environments only.

-j {SHORT | LONG}

Connection load balancing goal

-B {SERVICE_TIME | THROUGHPUT | NONE}

Runtime load balancing goal

-q {TRUE | FALSE}

Send Oracle Advanced Queuing (AQ) HA notifications. For standalone servers, applicable in Oracle Data Guard environments only.

-t edition_name

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.

SVRCTL 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.



Example

This example adds the sales service for the database with DB_UNIQUE_NAME dbcrm. The service is started only when dbcrm is in PRIMARY mode.

srvctl add service -d dbcrm -s sales -l PRIMARY

See Also:



config

The srvctl config command displays the Oracle Restart configuration of the specified component or set of components.

Table 4-15 srvctl config Summary

Command Description

srvctl config asm

Displays the Oracle Restart configuration information for the Oracle ASM instance

srvctl config database

Displays the Oracle Restart configuration information for the specified database, or lists all databases managed by Oracle Restart

srvctl config listener

Displays the Oracle Restart configuration information for all listeners or for the specified listener

srvctl config ons

Displays the current configuration information for ONS.

srvctl config service

For the specified database, displays the Oracle Restart configuration information for the specified database service or for all database services


srvctl config asm

Displays the Oracle Restart configuration information for the Oracle ASM instance.

Syntax and Options

Use the srvctl config asm command with the following syntax:

srvctl config asm [-a]

Table 4-16 srvctl config asm Options

Option Description
-a

Display enabled/disabled status also



Example

An example of this command is:

srvctl config asm -a

asm home: /u01/app/oracle/product/11.2.0/grid
ASM is enabled.

srvctl config database

Displays the Oracle Restart configuration information for the specified database, or lists all databases managed by Oracle Restart.

Syntax and Options

Use the srvctl config database command with the following syntax:

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

Table 4-17 srvctl config database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-a

Display enabled/disabled status also



Examples

An example of this command to list all Oracle Restart–managed databases is:

srvctl config database

dbcrm
orcl

An example of this command to display configuration and enabled/disabled status for the database with the DB_UNIQUE_ID orcl is:

srvctl config database -d orcl -a

Database unique name: orcl
Database name: orcl
Oracle home: /u01/app/oracle/product/11.2.0/dbhome_1
Oracle user: oracle
Spfile: +DATA/orcl/spfileorcl.ora
Domain: us.example.com
Start options: open
Stop options: immediate
Database role:
Management policy: automatic
Disk Groups: DATA
Services: mfg,sales
Database is enabled

srvctl config listener

Displays the Oracle Restart configuration information for all Oracle Restart–managed listeners or for the specified listener.

Syntax and Options

Use the srvctl config listener command with the following syntax:

srvctl config listener [-l listener_name]

Table 4-18 srvctl config listener Options

Option Description
-l listener_name

Listener name. If omitted, configuration information for all Oracle Restart–managed listeners is displayed.



Example

This example displays the configuration information and enabled/disabled status for the default listener:

srvctl config listener

Name: LISTENER
Home: /u01/app/oracle/product/11.2.0/dbhome_1
End points: TCP:1521
Listener is enabled.

srvctl config ons

Displays the current configuration information for ONS.

Syntax and Options

Use the srvctl config ons command with the following syntax:

srvctl config ons

srvctl config service

For the specified database, displays the Oracle Restart configuration information for the specified database service or for all Oracle Restart–managed database services.

Syntax and Options

Use the srvctl config service command with the following syntax:

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

Table 4-19 srvctl config service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name

Database service name. If omitted, SRVCTL displays configuration information for all Oracle Restart–managed services for the database

-a

Display detailed configuration information



Example

An example of this command is:

srvctl config service -d dbcrm -s sales

Service name: sales
Service is enabled
Cardinality: SINGLETON
Disconnect: true
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: NONE
Runtime Load Balancing Goal: NONE
TAF policy specification: NONE
Edition: e2


disable

Disables a component, which suspends management of that component by Oracle Restart. The srvctl disable command is intended to be used when a component must be repaired or shut down for maintenance, and should not be restarted automatically. When you disable a component:

To perform srvctl disable operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

See Also:

The enable command

Table 4-20 srvctl disable Summary

Command Description

srvctl disable asm

Disables the Oracle ASM instance

srvctl disable database

Disables a database

srvctl disable diskgroup

Disables an Oracle ASM disk group

srvctl disable listener

Disables the specified listener or all listeners

srvctl disable ons

Disables ONS

srvctl disable service

Disables one or more database services for the specified database


srvctl disable asm

Disables the Oracle ASM instance.

Syntax and Options

Use the srvctl disable asm command with the following syntax:

srvctl disable asm

srvctl disable database

Disables the specified database.

Syntax and Options

Use the srvctl disable database command with the following syntax:

srvctl disable database -d db_unique_name

Table 4-21 srvctl disable database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.



Example

An example of this command is:

srvctl disable database -d dbcrm

srvctl disable diskgroup

Disables an Oracle ASM disk group.

Syntax and Options

Use the srvctl disable diskgroup command with the following syntax:

srvctl disable diskgroup -g diskgroup_name

Table 4-22 srvctl disable diskgroup Options

Option Description
-g diskgroup_name

Disk group name



Example

An example of this command is:

srvctl disable diskgroup -g DATA

srvctl disable listener

Disables the specified listener or all listeners.

Syntax and Options

Use the srvctl disable listener command with the following syntax:

srvctl disable listener [-l listener_name]

Table 4-23 srvctl disable listener Options

Option Description
-l listener_name

Listener name. If omitted, all listeners are disabled.



Example

An example of this command is:

srvctl disable listener -l crmlistener

srvctl disable ons

Disables ONS.

Syntax and Options

Use the srvctl disable ons command with the following syntax:

srvctl disable ons -v

Table 4-24 srvctl disable ons Options

Option Description
-v

Verbose output



srvctl disable service

Disables one or more database services.

Syntax and Options

Use the srvctl disable service command with the following syntax:

srvctl disable service -d db_unique_name -s service_name_list

Table 4-25 srvctl disable service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name_list

Comma-delimited list of database service names



Example

The following example disables the database service sales and mfg:

srvctl disable service -d dbcrm -s sales,mfg


enable

The srvctl enable command reenables the specified disabled component so that:

If the component is already enabled, then the command is ignored.

When you add a component to the Oracle Restart configuration, it is enabled by default.

To perform srvctl enable operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

Table 4-26 srvctl enable Summary

Command Description

srvctl enable asm

Enables an Oracle ASM instance.

srvctl enable database

Enables a database.

srvctl enable diskgroup

Enables an Oracle ASM disk group.

srvctl enable listener

Enables the specified listener or all listeners.

srvctl enable ons

Enables ONS.

srvctl enable service

Enables one or more database services for the specified database.


See Also:

The disable command

srvctl enable asm

Enables an Oracle ASM instance.

Syntax and Options

Use the srvctl enable asm command with the following syntax:

srvctl enable asm

srvctl enable database

Enables the specified database.

Syntax and Options

Use the srvctl enable database command with the following syntax:

srvctl enable database -d db_unique_name

Table 4-27 srvctl enable database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.



Example

An example of this command is:

srvctl enable database -d dbcrm

srvctl enable diskgroup

Enables an Oracle ASM disk group.

Syntax and Options

Use the srvctl enable diskgroup command with the following syntax:

srvctl enable diskgroup -g diskgroup_name

Table 4-28 srvctl enable diskgroup Options

Option Description
-g diskgroup_name

Disk group name



Example

An example of this command is:

srvctl enable diskgroup -g DATA

srvctl enable listener

Enables the specified listener or all listeners.

Syntax and Options

Use the srvctl enable listener command with the following syntax:

srvctl enable listener [-l listener_name]

Table 4-29 srvctl enable listener Options

Option Description
-l listener_name

Listener name. If omitted, all listeners are enabled.



Example

An example of this command is:

srvctl enable listener -l crmlistener

srvctl enable ons

Enables ONS.

Syntax and Options

Use the srvctl enable ons command with the following syntax:

srvctl enable ons -v

Table 4-30 srvctl enable ons Options

Option Description
-v

Verbose output



srvctl enable service

Enables one or more database services for the specified database.

Syntax and Options

Use the srvctl enable service command with the following syntax:

srvctl enable service -d db_unique_name -s service_name_list

Table 4-31 srvctl enable service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name_list

Comma-delimited list of database service names



Examples

The following example enables the database services sales and mfg in the database with DB_UNIQUE_NAME dbcrm:

srvctl enable service -d dbcrm -s "sales,mfg"


getenv

Gets and displays environment variables and their values from the Oracle Restart configuration for a database, listener, or Oracle ASM instance.

Table 4-32 srvctl getenv Summary

Command Description

srvctl getenv asm

Displays the configured environment variables for the Oracle ASM instance

srvctl getenv database

Displays the configured environment variables for the specified database instance

srvctl getenv listener

Displays the configured environment variables for the specified listener


srvctl getenv asm

Displays the configured environment variables for the Oracle ASM instance.

Syntax and Options

Use the srvctl getenv asm command with the following syntax:

srvctl getenv asm [-t name_list]

Table 4-33 srvctl getenv asm Options

Options Description
-t name_list

Comma-delimited list of names of environment variables to display. If omitted, SRVCTL displays all configured environment variables for Oracle ASM.



Example

The following example displays all configured environment variables for the Oracle ASM instance:

srvctl getenv asm

srvctl getenv database

Displays the configured environment variables for the specified database.

Syntax and Options

Use the srvctl getenv database command with the following syntax:

srvctl getenv database -d db_unique_name [-t name_list]

Table 4-34 srvctl getenv database Options

Options Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-t name_list

Comma-delimited list of names of environment variables to display. If omitted, SRVCTL displays all configured environment variables.



Example

The following example displays all configured environment variables for the database with DB_UNIQUE_NAME dbcrm:

srvctl getenv database -d dbcrm

srvctl getenv listener

Displays the configured 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]

Table 4-35 srvctl getenv listener Options

Options Description
-l listener_name

Listener name. If omitted, SRVCTL lists environment variables for all listeners.

-t name_list

Comma-delimited list of names of environment variables to display. If omitted, SRVCTL displays all configured environment variables.



Example

The following example displays all configured environment variables for the listener named crmlistener:

srvctl getenv listener -l crmlistener


modify

Modifies the Oracle Restart configuration of a component. The change takes effect when the component is next restarted.

To perform srvctl modify operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

Table 4-36 srvctl modify Summary

Command Description

srvctl modify asm

Modifies the configuration for Oracle ASM

srvctl modify database

Modifies the configuration for a database

srvctl modify listener

Modifies the configuration for the specified listener or all listeners

srvctl modify ons

Modifies ONS

srvctl modify service

Modifies the configuration for a database service


srvctl modify asm

Modifies the Oracle Restart configuration for the Oracle ASM instance.

Syntax and Options

Use the srvctl modify asm command with the following syntax:

srvctl modify asm [-l listener_name] [-p spfile] [-d asm_diskstring]

Table 4-37 srvctl modify asm Options

Option Description
-l listener_name

Name of the listener with which Oracle ASM must register. A weak dependency is established with this listener. (Before Oracle ASM is started, Oracle Restart ensures that this listener is started.)

-p spfile

The full path of the server parameter file for the database. If omitted, the default SPFILE is used.

-d asm_diskstring

Oracle ASM disk group discovery string. An Oracle ASM discovery string is a comma-delimited list of strings that limits the set of disks that an Oracle ASM instance discovers. The discovery strings can include wildcard characters. Only disks that match one of the strings are discovered.



Example

An example of this command is:

srvctl modify asm -l crmlistener

See Also:

Oracle Automatic Storage Management Administrator's Guide for more information about Oracle ASM disk group discovery strings

srvctl modify database

Modifies the Oracle Restart configuration for a database.

Syntax and Options

Use the srvctl modify database command with the following syntax:

srvctl modify database -d db_unique_name [-o oracle_home] [-u oracle_user] 
  [-m domain_name] [-n db_name] [-p spfile] [-s start_options] 
  [-t stop_options] [-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | 
  SNAPSHOT_STANDBY}] [-y {automatic | manual}] [-a disk_group_list] [-z]

Table 4-38 srvctl modify database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-u oracle_user

Name of the Oracle user who owns the Oracle home directory

-z

Remove the database's dependency on Oracle ASM disk groups

(Other options)

See Table 4-11



Example

The following example changes the role of the database with DB_UNIQUE_NAME dbcrm to LOGICAL_STANDBY:

srvctl modify database -d dbcrm -r logical_standby

srvctl modify listener

Modifies the Oracle Restart configuration for the specified listener or all listeners.

Syntax and Options

Use the srvctl modify listener command with the following syntax:

srvctl modify listener [-l listener_name] [-p endpoints] [-o Oracle_home]

Table 4-39 srvctl modify listener Options

Option Description
-l listener_name

Listener name. If omitted, all listener configurations are modified.

-p endpoints

Comma separated TCP ports or listener endpoints. endpoints syntax is:

"[TCP:]port[, ...] [/IPC:key] [/NMP:pipe_name] [/TCPS:s_port] [/SDP:port]"
-o Oracle_home

New Oracle home for the listener



Example

This example modifies the TCP port on which the listener named crmlistener listens:

srvctl modify listener -l crmlistener -p TCP:1522

srvctl modify ons

Modifies ONS.

Syntax and Options

Use the srvctl modify ons command with the following syntax:

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

Table 4-40 srvctl modify ons Options

Option Description
-e em_port

ONS listening port for Oracle Enterprise Manager. The default is 2016.

-l ons_local_port

ONS listening port for local client connections

-r ons_remote_port

ONS listening port for connections from remote hosts

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

A list of host:port pairs of remote hosts that are part of the ONS network

Note: If port is not specified for a remote host, then ons_remote_port is used.

-v

Verbose output



srvctl modify service

Modifies the Oracle Restart configuration of a database service.

Important:

Oracle recommends that you limit configuration changes to the minimum requirement and that you not perform other service operations while the online service modification is in progress.

Syntax and Options

Use the srvctl modify service command with the following syntax:

srvctl modify service -d db_unique_name -s service_name]
  [-l [PRIMARY][,PHYSICAL_STANDBY][,LOGICAL_STANDBY][,SNAPSHOT_STANDBY]]
  [-y {AUTOMATIC | MANUAL}] [-e {NONE | SESSION | SELECT}] [-m {NONE | BASIC}]
  [-w integer] [-z integer] [-j {SHORT | LONG}]
  [-B {SERVICE_TIME | THROUGHPUT | NONE}] [-q {TRUE | FALSE}] -t edition_name

Table 4-41 srvctl modify service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name

Service name

-t edition_name

The initial session edition of the service

If this option is not specified, then the edition is not modified for the service.

If this option is specified but edition_name is empty, then the edition is set to NULL. A NULL edition has no effect.

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.

SVRCTL 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.

(other options)

See Table 4-14



Example

For the database with a DB_UNIQUE_NAME of dbcrm, the following command changes the Oracle Data Guard role of the database service named support to standby:

srvctl modify service -d dbcrm -s support -l standby


remove

Removes the specified component from the Oracle Restart configuration. Oracle Restart no longer manages the component. Any environment variable settings for the component are also removed.

Before you remove a component from the Oracle Restart configuration, you must use SRVCTL to stop it. Oracle recommends that you disable the component before removing it, but this is not required.

To perform srvctl remove operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

Table 4-42 srvctl remove Summary

Command Description

srvctl remove asm

Removes the Oracle ASM instance

srvctl remove database

Removes a database

srvctl remove diskgroup

Removes an Oracle ASM disk group

srvctl remove listener

Removes a listener

srvctl remove ons

Removes an ONS

srvctl remove service

Removes one or more database services


See Also:

srvctl remove asm

Removes an Oracle ASM instance.

Syntax and Options

Use the srvctl remove asm command with the following syntax:

srvctl remove asm  [-f]

Table 4-43 srvctl remove asm Options

Options Description
-f

Force remove, even when disk groups and databases that use Oracle ASM exist or when the Oracle ASM instance is running.



Example

An example of this command is:

srvctl remove asm

srvctl remove database

Removes a database. Prompts for confirmation first.

Syntax and Options

Use the srvctl remove database command with the following syntax:

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

Table 4-44 srvctl remove database Options

Options Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-f

Force. Removes the database even if it is running.

-y

Suppresses the confirmation prompt and removes immediately

-v

Verbose output. A success or failure message is displayed.



Example

An example of this command is:

srvctl remove database -d dbcrm

srvctl remove diskgroup

Removes an Oracle ASM disk group.

Syntax and Options

Use the srvctl remove diskgroup command with the following syntax:

srvctl remove diskgroup -g diskgroup_name [-f]

Table 4-45 srvctl remove diskgroup Options

Option Description
-g diskgroup_name

Disk group name

-f

Force. Removes the disk group even if files are open on it.



Examples

This example removes the disk group named DATA. An error is returned if files are open on this disk group.

srvctl remove diskgroup -g DATA

srvctl remove listener

Removes the specified listener or all listeners.

Syntax and Options

Use the srvctl remove listener command with the following syntax:

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

Table 4-46 srvctl remove listener Options

Options Description
-l listener_name

Name of the listener that you want to remove. If omitted, then the default is LISTENER.

-a

Remove all listeners

-f

Force. Removes the listener even if databases are using it.



Example

The following command removes the listener lsnr01:

srvctl remove listener -l lsnr01

srvctl remove ons

Removes ONS.

Syntax and Options

Use the srvctl remove ons command as follows:

srvctl remove ons -f -v

Table 4-47 srvctl remove ons Options

Options Description
-f

Force. Removes ONS even if it is enabled.

-v

Verbose output



srvctl remove service

Removes the specified database service.

Syntax and Options

Use the srvctl remove service command as follows:

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

Table 4-48 srvctl remove service Options

Options Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name

Service name

-f

Force. Removes the service even if the service is running. Transactions in any active sessions that are connected to the service are rolled back and sessions are disconnected.



Example

An example of this command is:

srvctl remove service -d dbcrm -s sales


setenv

The setenv command sets values of environment variables in the Oracle Restart configuration for a database, a listener, or the Oracle ASM instance.

To perform srvctl setenv operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

Table 4-49 srvctl setenv and unsetenv Summary

Command Description

srvctl setenv asm

Sets environment variables in the Oracle Restart configuration for an Oracle ASM instance

srvctl setenv database

Sets environment variables in the Oracle Restart configuration for a database instance

srvctl setenv listener

Sets environment variables in the Oracle Restart configuration for the specified listener or all listeners


srvctl setenv asm

Sets the values of environment variables in the Oracle Restart configuration for the Oracle ASM instance. Before starting the instance, Oracle Restart sets environment variables to the values stored in the configuration.

Syntax and Options

Use the srvctl setenv asm command with the following syntax:

srvctl setenv asm {-t name=val[,name=val,...] | -T name=val}

Table 4-50 srvctl setenv database Options

Options Description
-t name=val[,name=val,...]

Comma-delimited list of name/value pairs of environment variables

-T name=val

Enables single environment variable to be set to a value that contains commas or other special characters



Example

The following example sets the AIX operating system environment variable AIXTHREAD_SCOPE in the Oracle ASM instance configuration:

srvctl setenv asm -t AIXTHREAD_SCOPE=S

srvctl setenv database

Sets the values of environment variables in the Oracle Restart configuration for a database instance. Before starting the instance, Oracle Restart sets environment variables to the values stored in the configuration.

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}

Table 4-51 srvctl setenv database Options

Options Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-t name=val[,name=val,...]

Comma-delimited list of name/value pairs of environment variables

-T name=val

Enables single environment variable to be set to a value that contains commas or other special characters



Example

The following example sets the LANG environment variable in the configuration of the database with a DB_UNIQUE_NAME of dbcrm:

srvctl setenv database -d dbcrm -t LANG=en

srvctl setenv listener

Sets the values of environment variables in the Oracle Restart configuration for a listener. Before starting the listener, Oracle Restart sets environment variables to the values stored in the configuration.

Syntax and Options

Use the srvctl setenv listener command with the following syntax:

srvctl setenv listener [-l listener_name] {-t name=val[,name=val,...] | 
  -T name=val}

Table 4-52 srvctl setenv listener Options

Options Description
-l listener_name

Listener name. If omitted, sets the specified environment variables in all listener configurations.

-t name=val[,name=val,...]

Comma-delimited list of name/value pairs of environment variables

-T name=val

Enables single environment variable to be set to a value that contains commas or other special characters



Example

The following example sets the AIX operating system environment variable AIXTHREAD_SCOPE in the configuration of the listener named crmlistener:

srvctl setenv listener -l crmlistener -t AIXTHREAD_SCOPE=S


start

Starts the specified component or components.

Table 4-53 srvctl start Summary

Command Description

srvctl start asm

Starts the Oracle ASM instance

srvctl start database

Starts the specified database

srvctl start diskgroup

Starts (mounts) the specified Oracle ASM disk group

srvctl start home

Starts all of the components managed by Oracle Restart in the specified Oracle home

srvctl start listener

Starts the specified listener or all Oracle Restart–managed listeners

srvctl start ons

Starts ONS

srvctl start service

Starts the specified database service or services


srvctl start asm

Starts the Oracle ASM instance.

For this command, SRVCTL connects "/ as sysasm" to perform the operation. To run such operations, the owner of the executables in the Oracle Grid Infrastructure home must be a member of the OSASM group, and users running the commands must also be in the OSASM group.

Syntax and Options

Use the srvctl start asm command with the following syntax:

srvctl start asm [-o start_options]

Table 4-54 srvctl start asm Option

Option Description
-o start_options

Comma-delimited list of options for the startup command (OPEN, MOUNT, NOMOUNT, or FORCE). If omitted, defaults to normal startup (OPEN).



Examples

This example starts the Oracle ASM instance, which then mounts any disk groups named in the ASM_DISKGROUPS initialization parameter:

srvctl start asm

This example starts the Oracle ASM instance without mounting any disk groups:

srvctl start asm -o nomount

srvctl start database

Starts the specified database instance.

For this command, SRVCTL connects "/ as sysdba" to perform the operation. To run such operations, the owner of the Oracle executables in the database Oracle home must be a member of the OSDBA group (for example, the dba group on UNIX and Linux), and users running the commands must also be in the OSDBA group.

Syntax and Options

Use the srvctl start database command with the following syntax:

srvctl start database -d db_unique_name [-o start_options]

Table 4-55 srvctl start database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-o start_options

Comma-delimited list of options for the startup command (for example: OPEN, MOUNT, NOMOUNT, RESTRICT, PFILE=path, and so on)



Example

An example of this command is:

srvctl start database -d dbcrm -o pfile=testparm,nomount

srvctl start diskgroup

Starts (mounts) an Oracle ASM disk group.

Syntax and Options

Use the srvctl start diskgroup command with the following syntax:

srvctl start diskgroup -g diskgroup_name

Table 4-56 srvctl start diskgroup Options

Option Description
-g diskgroup_name

Disk group name



Example

An example of this command is:

srvctl start diskgroup -g DATA

srvctl start home

Starts all of the components that are managed by Oracle Restart in the specified Oracle home. The Oracle home can be an Oracle Database home or an Oracle Grid Infrastructure home.

This command starts the components that were stopped by a srvctl stop home. This command uses the information in the specified state file to identify the components to start.

Note:

Use this command to restart components after you install a patch in an Oracle home.

Syntax and Options

Use the srvctl start home command with the following syntax:

srvctl start home -o oracle_home -s state_file

Table 4-57 srvctl start home Options

Option Description

-o

Complete path of the Oracle home

-s

Complete path of the state file. The state file contains the current state information for the components in the Oracle home and is created when the srvctl stop home command or the srvctl status home command is run.



srvctl start listener

Starts the specified listener or all listeners.

Syntax and Options

Use the srvctl start listener command with the following syntax:

srvctl start listener [-l listener_name]

Table 4-58 srvctl start listener Options

Option Description
-l listener_name

Listener name. If omitted, all Oracle Restart–managed listeners are started.



Example

An example of this command is:

srvctl start listener -l listener

srvctl start ons

Starts ONS.

Syntax and Options

Use the srvctl start ons command with the following syntax:

srvctl start ons -v

Table 4-59 srvctl start ons Options

Option Description
-v

Verbose output



srvctl start service

Starts the specified database service or services.

Syntax and Options

Use the srvctl start service command with the following syntax:

srvctl start service -d db_unique_name [-s service_name_list] [-o start_options]

Table 4-60 srvctl start service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name_list

Comma-delimited list of service names. The service name list is optional and if not provided, SRVCTL starts all of the database's services

-o start_options

Options for database startup (for example: OPEN, MOUNT, NOMOUNT and so on) if the database must be started first



Example

For the database with a DB_UNIQUE_NAME of dbcrm, the following example starts the sales database service:

srvctl start service -d dbcrm -s sales


status

Displays the running status of the specified component or set of components.

Table 4-61 srvctl status Summary

Command Description

srvctl status asm

Displays the running status of the Oracle ASM instance

srvctl status database

Displays the running status of a database

srvctl status diskgroup

Displays the running status of an Oracle ASM disk group

srvctl status home

Displays the running status of all of the components that are managed by Oracle Restart in the specified Oracle home

srvctl status listener

Displays the running status of the specified listener or all Oracle Restart–managed listeners

srvctl status ons

Displays the running status of ONS

srvctl status service

Displays the running status of one or more services


srvctl status asm

Displays the running status of the Oracle ASM instance.

Syntax and Options

Use the srvctl status asm command with the following syntax:

srvctl status asm [-a]

Table 4-62 srvctl status asm Options

Option Description
-a

Display enabled/disabled status also



Example

An example of this command is:

srvctl status asm

ASM is running on dbhost

srvctl status database

Displays the running status of the specified database.

Syntax and Options

Use the srvctl status database command with the following syntax:

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

Table 4-63 srvctl status database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-f

Display a message if the database is disabled

-v

Verbose output. Lists the database services that are running.



Example

An example of this command is:

srvctl status database -d dbcrm -v

Database dbcrm is running with online services mfg,sales

srvctl status diskgroup

Displays the running status of an Oracle ASM disk group.

Syntax and Options

Use the srvctl status diskgroup command with the following syntax:

srvctl status diskgroup -g diskgroup_name [-a]

Table 4-64 srvctl status diskgroup Options

Option Description
-g diskgroup_name

Disk group name

-a

Display enabled/disabled status also



Example

An example of this command is:

srvctl status diskgroup -g DATA

Disk Group DATA is running on dbhost

srvctl status home

Displays the running status of all of the components that are managed by Oracle Restart in the specified Oracle home. The Oracle home can be an Oracle Database home or an Oracle Grid Infrastructure home.

This command writes the current status of the components to the specified state file.

Syntax and Options

Use the srvctl status home command with the following syntax:

srvctl status home -o oracle_home -s state_file

Table 4-65 srvctl status home Options

Option Description

-o

Complete path of the Oracle home

-s

Complete path of the state file



srvctl status listener

Displays the running status of the specified listener or of all Oracle Restart–managed listeners.

Syntax and Options

Use the srvctl status listener command with the following syntax:

srvctl status listener -l listener_name

Table 4-66 srvctl status listener Options

Option Description
-l listener_name

Listener name. If omitted, the status of all listeners is displayed.



Example

An example of this command is:

srvctl status listener -l crmlistener

Listener CRMLISTENER is running on dbhost

srvctl status ons

Displays the running status of ONS.

Syntax and Options

Use the srvctl status ons command with the following syntax:

srvctl status ons

srvctl status service

Displays the running status of one or more database services.

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]

Table 4-67 srvctl status service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name_list

Comma-delimited list of service names. If omitted, status is listed for all database services for the designated database.

-f

Display a message if a service is disabled

-v

Verbose output



Example

For the database with the DB_UNIQUE_NAME of dbcrm, the following example displays the running status of the service sales:

srvctl status service -d dbcrm -s sales

Service sales is running on dbhost


stop

Stops the specified component or components.

If you want a component to remain stopped after you issue a srvctl stop command, disable the component. See the disable command.

Note:

If a component is stopped and is not disabled, it could restart as a result of another planned operation. That is, although a stopped component will not restart as a result of a failure, it might be started if a dependent component is started with a srvctl start command.

Table 4-68 srvctl stop Summary

Command Description

srvctl stop asm

Stops the Oracle ASM instance

srvctl stop database

Stops the specified database instance

srvctl stop diskgroup

Stops (dismounts) the specified Oracle ASM disk group

srvctl stop home

Stops all of the components managed by Oracle Restart in the specified Oracle home

srvctl stop listener

Stops the specified listener or all listeners

srvctl stop ons

Stops ONS

srvctl stop service

Stops the specified database service or services


srvctl stop asm

Stops the Oracle ASM instance.

Syntax and Options

Use the srvctl stop asm command with the following syntax:

srvctl stop asm [-o stop_options] [-f]

Table 4-69 srvctl stop asm Option

Option Description
-o stop_options

Options for the shutdown operation, for example, NORMAL, TRANSACTIONAL, IMMEDIATE, or ABORT

-f

Force. Must be present if disk groups are currently started (mounted). This option enables SRVCTL to stop the disk groups before stopping Oracle ASM. Each dependent database instance is also stopped according to its stop options, or with the ABORT option if the configured stop options fail.



Example

An example of this command is:

srvctl stop asm -o abort -f

srvctl stop database

Stops a database.

Syntax and Options

Use the srvctl stop database command with the following syntax:

srvctl stop database -d db_unique_name [-o stop_options] [-f]

Table 4-70 srvctl stop database Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-o stop_options

SHUTDOWN command options (for example: NORMAL, TRANSACTIONAL, IMMEDIATE, or ABORT). Default is IMMEDIATE.

-f

Force. Performs a SHUTDOWN ABORT of the database.



Example

An example of this command is:

srvctl stop database -d dbcrm

srvctl stop diskgroup

Stops (dismounts) an Oracle ASM disk group.

Syntax and Options

Use the srvctl stop diskgroup command with the following syntax:

srvctl stop diskgroup -g diskgroup_name [-f]

Table 4-71 srvctl stop diskgroup Options

Option Description
-g diskgroup_name

Disk group name

-f

Force. Dismount the disk group even if some files in the disk group are open.



Examples

This example stops the disk group named DATA. An error is returned if files are open on this disk group.

srvctl stop diskgroup -g DATA

srvctl stop home

Stops all of the components that are managed by Oracle Restart in the specified Oracle home. The Oracle home can be an Oracle Database home or an Oracle Grid Infrastructure home.

This command identifies the components that it stopped in the specified state file.

Note:

  • Before stopping the components in an Oracle Grid Infrastructure home, stop the components in a dependent Oracle Database home.

  • Use this command to stop components before you install a patch in an Oracle home.

Syntax and Options

Use the srvctl stop home command with the following syntax:

srvctl stop home -o oracle_home -s state_file [-t stop_options] [-f]

Table 4-72 srvctl stop home Options

Option Description

-o

Complete path of the Oracle home

-s

Complete path of the state file

-t stop_options

SHUTDOWN command options for the database (for example: NORMAL, TRANSACTIONAL, IMMEDIATE, or ABORT). Default is IMMEDIATE.

-f

Force stop each component



srvctl stop listener

Stops the designated listener or all Oracle Restart–managed listeners. Stopping a listener does not cause databases that are registered with the listener to be stopped.

Syntax and Options

Use the srvctl stop listener command with the following syntax:

srvctl stop listener [-l listener_name] [-f]

Table 4-73 srvctl stop listener Options

Option Description
-l listener_name

Listener name. If omitted, all Oracle Restart–managed listeners are stopped.

-f

Force. Passes the stop command with the -f option to Oracle Clusterware. See Oracle Clusterware Administration and Deployment Guide for more information about the Oracle Clusterware -f option.



Example

An example of this command is:

srvctl stop listener -l crmlistener

srvctl stop ons

Stops ONS.

Syntax and Options

Use the srvctl stop ons command with the following syntax:

srvctl stop ons -v

Table 4-74 srvctl stop ons Options

Option Description
-v

Verbose output



srvctl stop service

Stops one or more database services.

Syntax and Options

Use the srvctl stop service command with the following syntax:

srvctl stop service -d db_unique_name [-s service_name_list] [-f]

Table 4-75 srvctl stop service Options

Option Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-s service_name_list

Comma-delimited list of database service names. If you do not provide a service name list, then SRVCTL stops all services on the database

-f

Force. This option disconnects all of the stopped services' sessions immediately. Uncommitted transactions are rolled back. If this option is omitted, active sessions remain connected to the services, but no further connections to the services can be made.



Examples

The following example stops the sales database service on the database with a DB_UNIQUE_NAME of dbcrm:

srvctl stop service -d dbcrm -s sales


unsetenv

The unsetenv command deletes one or more environment variables from the Oracle Restart configuration for a database, a listener, or an Oracle ASM instance.

To perform srvctl unsetenv operations, you must be logged in to the database host computer with the proper user account. See "Preparing to Run SRVCTL" for more information.

Table 4-76 srvctl unsetenv Command Summary

Command Description

srvctl unsetenv asm

Removes the specified environment variables from the Oracle Restart configuration for the Oracle ASM instance

srvctl unsetenv database

Removes the specified environment variables from the Oracle Restart configuration for a database

srvctl unsetenv listener

Removes the specified environment variables from the Oracle Restart configuration for a listener or all listeners


srvctl unsetenv asm

Removes the specified environment variables from the Oracle Restart configuration for the Oracle ASM instance.

Syntax and Options

Use the srvctl unsetenv asm command with the following syntax:

srvctl unsetenv asm -t name_list

Table 4-77 srvctl unsetenv asm Options

Options Description
-t name_list

Comma-delimited list of environment variables to remove



Example

The following example removes the AIX operating system environment variable AIXTHREAD_SCOPE from the Oracle ASM instance configuration:

srvctl unsetenv asm -t AIXTHREAD_SCOPE

srvctl unsetenv database

Removes the specified environment variables from the Oracle Restart configuration for the specified database.

Syntax and Options

Use the srvctl unsetenv database command as follows:

srvctl unsetenv database -d db_unique_name -t name_list

Table 4-78 srvctl unsetenv database Options

Options Description
-d db_unique_name

Unique name for the database. Must match the DB_UNIQUE_NAME initialization parameter setting. If DB_UNIQUE_NAME is unspecified, then this option must match the DB_NAME initialization parameter setting. The default setting for DB_UNIQUE_NAME uses the setting for DB_NAME.

-t name_list

Comma-delimited list of environment variables to remove



Example

The following example deletes the AIXTHREAD_SCOPE environment variable from the Oracle Restart configuration for the database with a DB_UNIQUE_NAME of dbcrm:

srvctl unsetenv database -d dbcrm -t AIXTHREAD_SCOPE

srvctl unsetenv listener

Removes the specified environment variables from the Oracle Restart configuration for the specified listener or all listeners.

Syntax and Options

Use the srvctl unsetenv listener command with the following syntax:

srvctl unsetenv listener [-l listener_name] -t name_list

Table 4-79 srvctl unsetenv listener Options

Options Description
-l listener_name

Listener name. If omitted, the specified environment variables are removed from the configurations of all listeners.

-t name_list

Comma-delimited list of environment variables to remove



Example

The following example removes the AIX operating system environment variable AIXTHREAD_SCOPE from the listener configuration for the listener named crmlistener:

srvctl unsetenv listener -l crmlistener -t AIXTHREAD_SCOPE


CRSCTL Command Reference

This section provides details about the syntax for the CRSCTL commands that are relevant for Oracle Restart.

Note:

You must be the root user or Oracle grid infrastructure software owner to run the these CRSCTL commands.

CRSCTL Command Syntax Overview

CRSCTL expects the following command syntax:

crsctl command has

where command is a verb such as start, stop, or enable. The has object indicates Oracle high availability services. See Table 4-80 for a complete list of commands.

Case Sensitivity

CRSCTL commands and components are case insensitive.

Table 4-80 Summary of CRSCTL Commands

Command Description

check

Displays the Oracle Restart status.

config

Displays the Oracle Restart configuration.

disable

Disables automatic restart of Oracle Restart.

enable

Enables automatic restart of Oracle Restart.

start

Starts Oracle Restart.

stop

Stops Oracle Restart.



check

Displays the Oracle Restart status.

Syntax and Options

crsctl check has

config

Displays the Oracle Restart configuration.

Syntax and Options

crsctl config has

disable

Disables automatic restart of Oracle Restart.

Syntax and Options

crsctl disable has

enable

Enables automatic restart of Oracle Restart.

Syntax and Options

crsctl enable has

start

Starts Oracle Restart.

Syntax and Options

crsctl start has

stop

Stops Oracle Restart.

Syntax and Options

crsctl stop has [-f]

Table 4-81 crsctl stop has Options

Options Description
-f

Force. If any resources that are managed by Oracle Restart are still running, then try to stop these resources gracefully. If a resource cannot be stopped gracefully, then try to force the resource to stop.

For example, if an Oracle ASM instance is running, then SHUTDOWN IMMEDIATE attempts to stop the Oracle ASM instance gracefully, while SHUTDOWN ABORT attempts to force the Oracle ASM instance to stop.

When the -f option is not specified, this command tries to stop resources managed by Oracle Restart gracefully but does not try to force them to stop.