| Oracle® Database Administrator's Guide 11g Release 2 (11.2) Part Number E10595-04 |
|
|
View PDF |
This section provides details about the syntax and options for all SRVCTL commands.
SRVCTL Command Syntax and Options Overview
SRVCTL expects the following command syntax:
srvctl command object options
where:
command is a verb such as start, stop, or remove. See Table 4-7 for a complete list.
object is the component on which SRVCTL performs the command, such as database, listener, and so on. You can also use component abbreviations. See Table 4-8 for a complete list of components and their abbreviations.
options extend the use of a preceding command combination to include additional parameters for the command. For example, the -d option indicates that a database unique name follows, and the -s option indicates that a comma-delimited list of database service names follows.
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 |
|---|---|
|
Adds a component to the Oracle Restart configuration. |
|
|
Displays the Oracle Restart configuration for a component. |
|
|
Disables management by Oracle Restart for a component. |
|
|
Reenables management by Oracle Restart for a component. |
|
|
Displays environment variables in the Oracle Restart configuration for a database, Oracle ASM instance, or listener. |
|
|
Modifies the Oracle Restart configuration for a component. |
|
|
Removes a component from the Oracle Restart configuration. |
|
|
Sets environment variables in the Oracle Restart configuration for a database, Oracle ASM instance, or listener. |
|
|
Starts the specified component. |
|
|
Displays the running status of the specified component. |
|
|
Stops the specified component. |
|
|
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 |
|---|---|---|
|
|
|
Oracle ASM instance |
|
|
|
Database instance |
|
|
|
Oracle ASM disk group |
|
|
|
Oracle ASM file system |
|
|
|
Oracle home or Oracle Clusterware home |
|
|
|
Oracle Net listener |
|
|
|
Database service |
|
|
|
Oracle Notification Services (ONS) |
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 |
|---|---|
|
Adds an Oracle ASM instance. |
|
|
Adds a database. |
|
|
Adds an eONS (used by Oracle Enterprise Manager). |
|
|
Adds a listener. |
|
|
Adds an ONS (used by Oracle Data Guard configurations with Oracle Data Guard Broker). |
|
|
Adds a database service managed by Oracle Restart. |
Note:
There is nosrvctl 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.Adds an Oracle ASM instance to the Oracle Restart configuration.
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 |
-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. |
An example of this command is:
srvctl add asm -l crmlistener
See Also:
Oracle Database Storage Administrator's Guide for more information about Oracle ASM disk group discovery stringsAdds 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.
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 |
-o Oracle_home
|
The full path of Oracle home for the database. |
-m domain_name
|
The domain for the database. Must match the |
-n db_name
|
If provided, must match the |
-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 ( |
-t stop_options
|
Shutdown options for the database ( |
-r {PRIMARY | PHYSICAL_STANDBY | LOGICAL_STANDBY | SNAPSHOT_STANDBY}
|
The current role of the database ( |
-y {AUTOMATIC | MANUAL}
|
Management policy for the database. If |
-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. |
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"
See Also:
Adds an eONS to an Oracle Restart configuration.
The eONS is used by Oracle Enterprise Manager to receive notification of change in status of components managed by Oracle Restart.
Use the srvctl add eons command with the following syntax:
srvctl add eons [-p portnum] [-m multicast_ip_address] [-e eons_listen_port] [-v]
Table 4-12 srvctl add eons Options
| Option | Description |
|---|---|
-p portnum
|
The port number for eONS |
-m multicast_ip_address
|
The multicast IP address for eONS |
-e eons_listen_port
|
Local listen port for eONS. The default port number is 2016. |
-v |
Verbose output |
Adds a listener to the Oracle Restart configuration.
Use the srvctl add listener command with the following syntax:
srvctl add listener [-l listener_name] [-p endpoints] [-s] [-o Oracle_home]
Table 4-13 srvctl add listener Options
| Option | Description |
|---|---|
-l listener_name
|
Listener name. If omitted, defaults to |
-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. |
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
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.
Use the srvctl add ons command with the following syntax:
srvctl add ons [-l ons_local_port] [-r ons_remote_port] [-t host[:port],[host[:port]...]] [-v]
Table 4-14 srvctl add ons Options
| Option | Description |
|---|---|
-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 Note: If |
-v |
Verbose output |
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.
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}]
Table 4-15 srvctl add service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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 |
-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. |
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:
The section in Oracle Database PL/SQL Packages and Types Reference on the DBMS_SERVICE package for more information about the options for this command
The srvctl config command displays the Oracle Restart configuration of the specified component or set of components.
Table 4-16 srvctl config Summary
| Command | Description |
|---|---|
|
Displays the Oracle Restart configuration information for the Oracle ASM instance |
|
|
Displays the Oracle Restart configuration information for the specified database, or lists all databases managed by Oracle Restart |
|
|
Displays the current configuration information for eONS. |
|
|
Displays the Oracle Restart configuration information for all listeners or for the specified listener |
|
|
Displays the current configuration information for ONS. |
|
|
For the specified database, displays the Oracle Restart configuration information for the specified database service or for all database services |
Displays the Oracle Restart configuration information for the Oracle ASM instance.
Use the srvctl config asm command with the following syntax:
srvctl config asm [-a]
An example of this command is:
srvctl config asm -a asm home: /u01/app/oracle/product/11.2.0/grid ASM is enabled.
Displays the Oracle Restart configuration information for the specified database, or lists all databases managed by Oracle Restart.
Use the srvctl config database command with the following syntax:
srvctl config database [-d db_unique_name [-a]]
Table 4-18 srvctl config database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-a |
Display enabled/disabled status also |
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
Displays the current configuration information for eONS.
Use the srvctl config eons command with the following syntax:
srvctl config eons
Displays the Oracle Restart configuration information for all Oracle Restart–managed listeners or for the specified listener.
Use the srvctl config listener command with the following syntax:
srvctl config listener [-l listener_name]
Table 4-19 srvctl config listener Options
| Option | Description |
|---|---|
-l listener_name
|
Listener name. If omitted, configuration information for all Oracle Restart–managed listeners is displayed. |
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.
Displays the current configuration information for ONS.
Use the srvctl config ons command with the following syntax:
srvctl config ons
For the specified database, displays the Oracle Restart configuration information for the specified database service or for all Oracle Restart–managed database services.
Use the srvctl config service command with the following syntax:
srvctl config service -d db_unique_name [-s service_name] [-a]
Table 4-20 srvctl config service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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 |
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
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:
It is no longer automatically restarted.
It is no longer automatically started through a dependency.
It cannot be started with SRVCTL.
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 commandTable 4-21 srvctl disable Summary
| Command | Description |
|---|---|
|
Disables the Oracle ASM instance |
|
|
Disables a database |
|
|
Disables an Oracle ASM disk group |
|
|
Disables eONS |
|
|
Disables the specified listener or all listeners |
|
|
Disables ONS |
|
|
Disables one or more database services for the specified database |
Disables the Oracle ASM instance.
Use the srvctl disable asm command with the following syntax:
srvctl disable asm
Disables the specified database.
Use the srvctl disable database command with the following syntax:
srvctl disable database -d db_unique_name
Table 4-22 srvctl disable database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
An example of this command is:
srvctl disable database -d dbcrm
Disables an Oracle ASM disk group.
Use the srvctl disable diskgroup command with the following syntax:
srvctl disable diskgroup -g diskgroup_name
An example of this command is:
srvctl disable diskgroup -g DATA
Disables eONS.
Use the srvctl disable eons command with the following syntax:
srvctl disable eons -v
Disables the specified listener or all listeners.
Use the srvctl disable listener command with the following syntax:
srvctl disable listener [-l listener_name]
Table 4-25 srvctl disable listener Options
| Option | Description |
|---|---|
-l listener_name
|
Listener name. If omitted, all listeners are disabled. |
An example of this command is:
srvctl disable listener -l crmlistener
Disables ONS.
Use the srvctl disable ons command with the following syntax:
srvctl disable ons -v
Disables one or more database services.
Use the srvctl disable service command with the following syntax:
srvctl disable service -d db_unique_name -s service_name_list
Table 4-27 srvctl disable service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-s service_name_list
|
Comma-delimited list of database service names |
The following example disables the database service sales and mfg:
srvctl disable service -d dbcrm -s sales,mfg
The srvctl enable command reenables the specified disabled component so that:
Oracle Restart can automatically restart it.
It can be automatically started through a dependency.
You can start it manually with SRVCTL.
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-28 srvctl enable Summary
| Command | Description |
|---|---|
|
Enables an Oracle ASM instance. |
|
|
Enables a database. |
|
|
Enables an Oracle ASM disk group. |
|
|
Enables eONS. |
|
|
Enables the specified listener or all listeners. |
|
|
Enables ONS. |
|
|
Enables one or more database services for the specified database. |
See Also:
The disable commandEnables an Oracle ASM instance.
Use the srvctl enable asm command with the following syntax:
srvctl enable asm
Enables the specified database.
Use the srvctl enable database command with the following syntax:
srvctl enable database -d db_unique_name
Table 4-29 srvctl enable database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
An example of this command is:
srvctl enable database -d dbcrm
Enables an Oracle ASM disk group.
Use the srvctl enable diskgroup command with the following syntax:
srvctl enable diskgroup -g diskgroup_name
An example of this command is:
srvctl enable diskgroup -g DATA
Enables eONS.
Use the srvctl enable eons command with the following syntax:
srvctl enable eons -v
Enables the specified listener or all listeners.
Use the srvctl enable listener command with the following syntax:
srvctl enable listener [-l listener_name]
Table 4-32 srvctl enable listener Options
| Option | Description |
|---|---|
-l listener_name
|
Listener name. If omitted, all listeners are enabled. |
An example of this command is:
srvctl enable listener -l crmlistener
Enables ONS.
Use the srvctl enable ons command with the following syntax:
srvctl enable ons -v
Enables one or more database services for the specified database.
Use the srvctl enable service command with the following syntax:
srvctl enable service -d db_unique_name -s service_name_list
Table 4-34 srvctl enable service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-s service_name_list
|
Comma-delimited list of database service names |
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"
Gets and displays environment variables and their values from the Oracle Restart configuration for a database, listener, or Oracle ASM instance.
Table 4-35 srvctl getenv Summary
| Command | Description |
|---|---|
|
Displays the configured environment variables for the Oracle ASM instance |
|
|
Displays the configured environment variables for the specified database instance |
|
|
Displays the configured environment variables for the specified listener |
See Also:
Displays the configured environment variables for the Oracle ASM instance.
Use the srvctl getenv asm command with the following syntax:
srvctl getenv asm [-t name_list]
Table 4-36 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. |
The following example displays all configured environment variables for the Oracle ASM instance:
srvctl getenv asm
Displays the configured environment variables for the specified database.
Use the srvctl getenv database command with the following syntax:
srvctl getenv database -d db_unique_name [-t name_list]
Table 4-37 srvctl getenv database Options
| Options | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-t name_list
|
Comma-delimited list of names of environment variables to display. If omitted, SRVCTL displays all configured environment variables. |
The following example displays all configured environment variables for the database with DB_UNIQUE_NAME dbcrm:
srvctl getenv database -d dbcrm
Displays the configured environment variables for the specified listener.
Use the srvctl getenv listener command with the following syntax:
srvctl getenv listener [-l listener_name] [-t name_list]
Table 4-38 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. |
The following example displays all configured environment variables for the listener named crmlistener:
srvctl getenv listener -l crmlistener
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-39 srvctl modify Summary
| Command | Description |
|---|---|
|
Modifies the configuration for Oracle ASM |
|
|
Modifies the configuration for a database |
|
|
Modifies eONS |
|
|
Modifies the configuration for the specified listener or all listeners |
|
|
Modifies ONS |
|
|
Modifies the configuration for a database service |
Modifies the Oracle Restart configuration for the Oracle ASM instance.
Use the srvctl modify asm command with the following syntax:
srvctl modify asm [-l listener_name] [-p spfile] [-d asm_diskstring]
Table 4-40 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. |
An example of this command is:
srvctl modify asm -l crmlistener
See Also:
Oracle Database Storage Administrator's Guide for more information about Oracle ASM disk group discovery stringsModifies the Oracle Restart configuration for a database.
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-41 srvctl modify database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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 |
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
See Also:
Modifies eONS.
Use the srvctl modify eons command with the following syntax:
srvctl modify eons [-p portnum] [-m multicast_ip_address] [-e eons_listen_port] [-v]
Table 4-42 srvctl modify eons Options
| Option | Description |
|---|---|
-p portnum
|
The port number for eONS |
-m multicast_ip_address
|
The multicast IP address for eONS |
-e eons_listen_port
|
Local listen port for eONS. The default port number is 2016. |
-v |
Verbose output |
Modifies the Oracle Restart configuration for the specified listener or all listeners.
Use the srvctl modify listener command with the following syntax:
srvctl modify listener [-l listener_name] [-p endpoints] [-o Oracle_home]
Table 4-43 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 |
This example modifies the TCP port on which the listener named crmlistener listens:
srvctl modify listener -l crmlistener -p TCP:1522
Modifies ONS.
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]
Table 4-44 srvctl modify ons Options
| Option | Description |
|---|---|
-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 Note: If |
-v |
Verbose output |
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.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}]
Table 4-45 srvctl modify service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-s service_name
|
Service name |
|
(other options) |
See Table 4-15 |
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
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-46 srvctl remove Summary
| Command | Description |
|---|---|
|
Removes the Oracle ASM instance |
|
|
Removes a database |
|
|
Removes an Oracle ASM disk group |
|
|
Removes an eONS |
|
|
Removes a listener |
|
|
Removes an ONS |
|
|
Removes one or more database services |
Removes an Oracle ASM instance.
Use the srvctl remove asm command with the following syntax:
srvctl remove asm [-f]
Table 4-47 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. |
An example of this command is:
srvctl remove asm
Removes a database. Prompts for confirmation first.
Use the srvctl remove database command with the following syntax:
srvctl remove database -d db_unique_name [-f] [-y] [-v]
Table 4-48 srvctl remove database Options
| Options | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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. |
An example of this command is:
srvctl remove database -d dbcrm
Removes an Oracle ASM disk group.
Use the srvctl remove diskgroup command with the following syntax:
srvctl remove diskgroup -g diskgroup_name [-f]
Table 4-49 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. |
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
Removes eONS.
Use the srvctl remove eons command as follows:
srvctl remove eons -f -v
Table 4-50 srvctl remove eons Options
| Options | Description |
|---|---|
-f |
Force. Removes eONS even if it is enabled. |
-v |
Verbose output |
Removes the specified listener or all listeners.
Use the srvctl remove listener command with the following syntax:
srvctl remove listener [-l listener_name] [-a] [-f]
Table 4-51 srvctl remove listener Options
| Options | Description |
|---|---|
-l listener_name
|
Name of the listener that you want to remove. If omitted, then the default is |
-a |
Remove all listeners |
-f |
Force. Removes the listener even if databases are using it. |
The following command removes the listener lsnr01:
srvctl remove listener -l lsnr01
Removes ONS.
Use the srvctl remove ons command as follows:
srvctl remove ons -f -v
Table 4-52 srvctl remove ons Options
| Options | Description |
|---|---|
-f |
Force. Removes ONS even if it is enabled. |
-v |
Verbose output |
Removes the specified database service.
Use the srvctl remove service command as follows:
srvctl remove service -d db_unique_name -s service_name] [-f]
Table 4-53 srvctl remove service Options
| Options | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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. |
An example of this command is:
srvctl remove service -d dbcrm -s sales
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-54 srvctl setenv and unsetenv Summary
| Command | Description |
|---|---|
|
Sets environment variables in the Oracle Restart configuration for an Oracle ASM instance |
|
|
Sets environment variables in the Oracle Restart configuration for a database instance |
|
|
Sets environment variables in the Oracle Restart configuration for the specified listener or all listeners |
See Also:
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.
Use the srvctl setenv asm command with the following syntax:
srvctl setenv asm {-t name=val[,name=val,...] | -T name=val}
Table 4-55 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 |
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
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.
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-56 srvctl setenv database Options
| Options | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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 |
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
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.
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-57 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 |
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
Starts the specified component or components.
Table 4-58 srvctl start Summary
| Command | Description |
|---|---|
|
Starts the Oracle ASM instance |
|
|
Starts the specified database |
|
|
Starts (mounts) the specified Oracle ASM disk group |
|
|
Starts eONS |
|
|
Starts all of the components managed by Oracle Restart in the specified Oracle home |
|
|
Starts the specified listener or all Oracle Restart–managed listeners |
|
|
Starts ONS |
|
|
Starts the specified database service or services |
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.
Use the srvctl start asm command with the following syntax:
srvctl start asm [-o start_options]
Table 4-59 srvctl start asm Option
| Option | Description |
|---|---|
-o start_options
|
Comma-delimited list of options for the startup command ( |
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
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.
Use the srvctl start database command with the following syntax:
srvctl start database -d db_unique_name [-o start_options]
Table 4-60 srvctl start database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-o start_options
|
Comma-delimited list of options for the startup command (for example: |
An example of this command is:
srvctl start database -d dbcrm -o pfile=testparm,nomount
Starts (mounts) an Oracle ASM disk group.
Use the srvctl start diskgroup command with the following syntax:
srvctl start diskgroup -g diskgroup_name
An example of this command is:
srvctl start diskgroup -g DATA
Starts eONS.
Use the srvctl start eons command with the following syntax:
srvctl start eons -v
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.Use the srvctl start home command with the following syntax:
srvctl start home -o oracle_home -s state_file
Table 4-63 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 |
Starts the specified listener or all listeners.
Use the srvctl start listener command with the following syntax:
srvctl start listener [-l listener_name]
Table 4-64 srvctl start listener Options
| Option | Description |
|---|---|
-l listener_name
|
Listener name. If omitted, all Oracle Restart–managed listeners are started. |
An example of this command is:
srvctl start listener -l listener
Starts ONS.
Use the srvctl start ons command with the following syntax:
srvctl start ons -v
Starts the specified database service or services.
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-66 srvctl start service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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: |
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
Displays the running status of the specified component or set of components.
Table 4-67 srvctl status Summary
| Command | Description |
|---|---|
|
Displays the running status of the Oracle ASM instance |
|
|
Displays the running status of a database |
|
|
Displays the running status of an Oracle ASM disk group |
|
|
Displays the running status of eONS |
|
|
Displays the running status of all of the components that are managed by Oracle Restart in the specified Oracle home |
|
|
Displays the running status of the specified listener or all Oracle Restart–managed listeners |
|
|
Displays the running status of ONS |
|
|
Displays the running status of one or more services |
Displays the running status of the Oracle ASM instance.
Use the srvctl status asm command with the following syntax:
srvctl status asm [-a]
An example of this command is:
srvctl status asm ASM is running on dbhost
Displays the running status of the specified database.
Use the srvctl status database command with the following syntax:
srvctl status database -d db_unique_name [-f] [-v]
Table 4-69 srvctl status database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-f |
Display a message if the database is disabled |
-v |
Verbose output. Lists the database services that are running. |
An example of this command is:
srvctl status database -d dbcrm -v Database dbcrm is running with online services mfg,sales
Displays the running status of an Oracle ASM disk group.
Use the srvctl status diskgroup command with the following syntax:
srvctl status diskgroup -g diskgroup_name [-a]
Table 4-70 srvctl status diskgroup Options
| Option | Description |
|---|---|
-g diskgroup_name
|
Disk group name |
-a |
Display enabled/disabled status also |
An example of this command is:
srvctl status diskgroup -g DATA Disk Group DATA is running on dbhost
Displays the running status of eONS.
Use the srvctl status eons command with the following syntax:
srvctl status eons
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.
Use the srvctl status home command with the following syntax:
srvctl status home -o oracle_home -s state_file
Table 4-71 srvctl status home Options
| Option | Description |
|---|---|
|
-o |
Complete path of the Oracle home |
|
-s |
Complete path of the state file |
Displays the running status of the specified listener or of all Oracle Restart–managed listeners.
Use the srvctl status listener command with the following syntax:
srvctl status listener -l listener_name
Table 4-72 srvctl status listener Options
| Option | Description |
|---|---|
-l listener_name
|
Listener name. If omitted, the status of all listeners is displayed. |
An example of this command is:
srvctl status listener -l crmlistener Listener CRMLISTENER is running on dbhost
Displays the running status of ONS.
Use the srvctl status ons command with the following syntax:
srvctl status ons
Displays the running status of one or more database services.
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-73 srvctl status service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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 |
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
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 asrvctl start command.Table 4-74 srvctl stop Summary
| Command | Description |
|---|---|
|
Stops the Oracle ASM instance |
|
|
Stops the specified database instance |
|
|
Stops (dismounts) the specified Oracle ASM disk group |
|
|
Stops eONS |
|
|
Stops all of the components managed by Oracle Restart in the specified Oracle home |
|
|
Stops the specified listener or all listeners |
|
|
Stops ONS |
|
|
Stops the specified database service or services |
Stops the Oracle ASM instance.
Use the srvctl stop asm command with the following syntax:
srvctl stop asm [-o stop_options] [-f]
Table 4-75 srvctl stop asm Option
| Option | Description |
|---|---|
-o stop_options
|
Options for the shutdown operation, for example, |
-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 |
An example of this command is:
srvctl stop asm -o abort -f
Stops a database.
Use the srvctl stop database command with the following syntax:
srvctl stop database -d db_unique_name [-o stop_options] [-f]
Table 4-76 srvctl stop database Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-o stop_options
|
|
-f |
Force. Performs a |
An example of this command is:
srvctl stop database -d dbcrm
Stops (dismounts) an Oracle ASM disk group.
Use the srvctl stop diskgroup command with the following syntax:
srvctl stop diskgroup -g diskgroup_name [-f]
Table 4-77 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. |
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
Stops eONS.
Use the srvctl stop eons command with the following syntax:
srvctl stop eons -v
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.
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-79 srvctl stop home Options
| Option | Description |
|---|---|
|
-o |
Complete path of the Oracle home |
|
-s |
Complete path of the state file |
-t stop_options
|
|
-f |
Force stop each component |
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.
Use the srvctl stop listener command with the following syntax:
srvctl stop listener [-l listener_name] [-f]
Table 4-80 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 |
An example of this command is:
srvctl stop listener -l crmlistener
Stops ONS.
Use the srvctl stop ons command with the following syntax:
srvctl stop ons -v
Stops one or more database services.
Use the srvctl stop service command with the following syntax:
srvctl stop service -d db_unique_name [-s service_name_list] [-f]
Table 4-82 srvctl stop service Options
| Option | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-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. |
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
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-83 srvctl unsetenv Command Summary
| Command | Description |
|---|---|
|
Removes the specified environment variables from the Oracle Restart configuration for the Oracle ASM instance |
|
|
Removes the specified environment variables from the Oracle Restart configuration for a database |
|
|
Removes the specified environment variables from the Oracle Restart configuration for a listener or all listeners |
See Also:
Removes the specified environment variables from the Oracle Restart configuration for the Oracle ASM instance.
Use the srvctl unsetenv asm command with the following syntax:
srvctl unsetenv asm -t name_list
Table 4-84 srvctl unsetenv asm Options
| Options | Description |
|---|---|
-t name_list
|
Comma-delimited list of environment variables to remove |
The following example removes the AIX operating system environment variable AIXTHREAD_SCOPE from the Oracle ASM instance configuration:
srvctl unsetenv asm -t AIXTHREAD_SCOPE
Removes the specified environment variables from the Oracle Restart configuration for the specified database.
Use the srvctl unsetenv database command as follows:
srvctl unsetenv database -d db_unique_name -t name_list
Table 4-85 srvctl unsetenv database Options
| Options | Description |
|---|---|
-d db_unique_name
|
Unique name for the database. Must match the |
-t name_list
|
Comma-delimited list of environment variables to remove |
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
Removes the specified environment variables from the Oracle Restart configuration for the specified listener or all listeners.
Use the srvctl unsetenv listener command with the following syntax:
srvctl unsetenv listener [-l listener_name] -t name_list
Table 4-86 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 |
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