Oracle Clusterware is the technology which unifies servers in a server farm to form a cluster. A cluster is defined as a group of independent, yet inter-connected servers which cooperate as a single system.
Oracle Clusterware is the software in this environment which coordinates the management of these servers and the applications running on them. Oracle Clusterware is a generic clustering solution tested and certified to run on all major platforms and operating systems.
Oracle Clusterware was originally introduced with Oracle Database 10g Release 1 as the underlying, generic clustering software required for running the multi-instance RDBMS, Oracle Real Application Clusters (RAC). Oracle Clusterware is shipped with Oracle Grid Infrastructure, which is a suite of software packages which includes Oracle Automatic Storage Management (ASM) for databases, Oracle Automatic Storage Cloud File System (ACFS), a POSIX compliant general purpose cluster file system, Oracle Database Quality of Service Management.

Oracle Clusterware is a generic, general purpose clustering solution for all applications.

Oracle Clusterware is a complete, enterprise class clustering solution. It is a free. To get support for upgrades or patches, a valid support license for any other Oracle product such as Oracle Linux, Oracle Solaris, or any other supported Oracle application is required.

Oracle Stack Management
Oracle Clusterware provides a rich management framework to integrate and manage all applications. The core of this framework is a robust policy engine for resource placement as well as start and stop dependencies between resources. This enables Oracle Clusterware to manage workload and availability through the entire stack. The ability to automate and securely manage the start, stop and placement of database and application resources for planned maintenance and workload performance is an essential ingredient for successful consolidation.

Oracle Flex Cluster 12c
Oracle Clusterware, in the original design, is a tightly coupled clustering solution which requires shared storage and shared network between all servers in the cluster. This is a requirement when Oracle Clusterware is installed for Oracle databases - RAC and single instance. This tightly coupled cluster is
required to preserve data integrity of multi-instance, shared cache clustered databases. Oracle 12c introduces an innovative clustering solution - Oracle Flex Cluster which relaxes the tightly coupled nature of Oracle Clusterware and permits the collocation of applications and the RDBMS in a common Oracle Flex Cluster. In the Oracle Flex Cluster, the database tier, composed of 'HUB' servers, preserves the tightly coupled configuration, while the application tier, composed of 'LEAF' servers, is loosely coupled and does not require shared storage and peer-to-peer communication with other
servers in the cluster.

The collocation of applications and the database in a common cluster offers far greater availability and ease of management between application components and the database, where start, stop ordered dependencies, and placement may be defined and automated. Specifically, applications may depend on components outside of the respective application management domain. Customers either execute the start up of these various components manually, or, they maintain cumbersome scripts in an attempt to automate.

application and database tiers allowing the application to pull up the database or, if the application tier is down, the database startup would start the application components on the correct servers in the correct order. The entire process, application tier start up with correct startup order and placement and database/application tier pull-up - is fully automated.

Next

Oracle Grid Infrastructure for a standalone server, also known as Oracle Restart, provides system support for a single-instance Oracle Database. This support includes volume management, file system, and automatic restart capabilities. If you plan to use Oracle Automatic Storage Management (Oracle ASM), then you must install Oracle Restart before installing your database. Oracle Grid Infrastructure for a standalone server includes Oracle Restart and Oracle Automatic Storage Management. Oracle combined the two infrastructure products into a single set of binaries that is installed into an Oracle Restart home.

Oracle Automatic Storage Management is a volume manager and a file system for Oracle database files that supports single-instance Oracle Database and Oracle Real Application Clusters (Oracle RAC) configurations. Oracle Automatic Storage Management also supports a general purpose file system for your application needs, including Oracle Database binaries. Oracle Automatic Storage Management is Oracle's recommended storage management solution that provides an alternative to conventional volume managers, file systems, and raw devices.

• You can neither install Oracle Restart on an Oracle Grid Infrastructure cluster member node, nor add an Oracle Restart server to an Oracle Grid Infrastructure cluster member node. Oracle Restart supports single-instance databases on one server, while Oracle Grid Infrastructure for a Cluster supports single-instance or Oracle RAC databases on a cluster.
• If you want to use Oracle ASM or Oracle Restart, then you must install Oracle Grid Infrastructure for a standalone server before you install and create the database. Otherwise, you must manually register the database with Oracle Restart.
• Oracle Restart is used in single-instance (nonclustered) environments only.

Oracle Restart improves the availability of your Oracle database by providing the following:

• When there is a hardware or a software failure, Oracle Restart automatically starts all Oracle components, including the Oracle database instance, Oracle Net Listener, database services, and Oracle ASM.
• Oracle Restart starts components in the proper order when the database host is restarted.
• Oracle Restart runs periodic checks to monitor the status of Oracle components. If a check operation fails for a component, then the component is shut down and restarted.

Next

http://www.oracle.com/technetwork/articles/database/asm-odb12c-enhancements-2206102.html

https://docs.oracle.com/database/121/OSTMG/GUID-B20F761E-5217-4F49-BCB8-D200EEE5B51E.htm#OSTMG03601

About Oracle ASM Instances

Next

You are required to complete some configuration tasks after Oracle Grid Infrastructure is installed. In addition, Oracle recommends that you complete additional tasks immediately after installation. You must also complete product-specific configuration tasks before you use those products.

• Downloading and Installing Patch Updates
  Download and install patch updates for your Oracle software after you complete installation.

1. Use a web browser to view the My Oracle Support website:

   https://support.oracle.com

2. Log in to My Oracle Support website.

   Note:

   If you are not a My Oracle Support registered user, then click Register for My Oracle Support and register.

3. On the main My Oracle Support page, click Patches & Updates.
4. In the Patch Search region, select Product or Family (Advanced).
5. On the Product or Family (Advanced) display, provide information about the product, release, and platform for which you want to obtain patches, and click Search.
   The Patch Search pane opens, displaying the results of your search.
6. Select the patch number and click ReadMe.

   The README page is displayed. It contains information about the patch set and how to apply the patches to your installation.

7. Use the unzip utility provided with the software to uncompress the Oracle patch updates that you downloaded from My Oracle Support. The unzip utility is located in the $ORACLE_HOME/bin directory.

Next

1. Calculate the minimum total semaphore requirements using the following formula:2 * sum (process parameters of all database instances on the system) + overhead for background processes + system and other application requirements
2. Set semmns (total semaphores systemwide) to this total.
3. Set semmsl (semaphores for each set) to 250.
4. Set semmni (total semaphores sets) to semmns divided by semmsl, rounded up to the nearest multiple of 1024.

Next

Be sure to back up the root.sh script after you complete the installation.

If you install other products in the same Oracle home directory subsequent to this installation, then Oracle Universal Installer updates the contents of the existing root.sh script during the installation. If you require information contained in the original root.sh script, then you can recover it from the backed up root.sh file.

Next

https://docs.oracle.com/en/database/oracle/oracle-database/12.2/cwlin/creating-a-backup-of-the-root-sh-script.html

Download and install the ORAchk utility to perform proactive heath checks for the Oracle software stack.

Next

Next

Check and adjust the resource limits after you have installed Grid Infrastructure s in the Grid_home/crs/install/s_crsconfig_nodename_env.txt file.

---
#Do not modify this file except as documented above or under the
#direction of Oracle Support Services.
#########################################################################
TZ=PST8PDT
NLS_LANG=AMERICAN_AMERICA.WE8ISO8859P1
CRS_LIMIT_STACK=2048
CRS_LIMIT_OPENFILE=65536
CRS_LIMIT_NPROC=65536
TNS_ADMIN=

Next

The listener should be running from the grid home and will be administered from there. The lsnrctl or srvctl commands can be used to  administer the listener.

Be sure to  set your $ORACLE_HOME environment variable to the path for the Oracle Grid Infrastructure home (Grid home).

If you have multiple oracle releases running on the same server, be sure the listener is running from the home of the higher release because the listener running from Oracle home locations for previous releases, will not work with the new release.

Next

It explains how to configure Oracle ASM instance parameters and how to set Oracle Database parameters for use with Oracle ASM. The chapter also describes Oracle ASM upgrading, patching, and authentication for Oracle ASM instance access. You can also use procedures in this chapter to migrate a database to use Oracle ASM.

Administering an Oracle ASM instance is similar to administering an Oracle Database instance, but the process requires fewer procedures. You can use Oracle ASM Command Line Utility (ASMCMD) command-line interface, Oracle ASM Configuration Assistant (ASMCA), and SQL*Plus to perform Oracle ASM instance administration tasks.

This chapter contains the following topics:

Next

Viewing disk group attributes with V$ASM_ATTRIBUTE

SELECT SUBSTR(dg.name,1,12) AS diskgroup, SUBSTR(a.name,1,24) AS name,

SUBSTR(a.value,1,24) AS value, read_only FROM V$ASM_DISKGROUP dg,

V$ASM_ATTRIBUTE a WHERE dg.name = 'DATA' AND dg.group_number = a.group_number

AND a.name NOT LIKE '%template%';

Viewing the compatibility of a disk group with V$ASM_DISKGROUP

SELECT name AS diskgroup, substr(compatibility,1,12) AS asm_compat,

substr(database_compatibility,1,12) AS db_compat FROM V$ASM_DISKGROUP;

Viewing disks in disk groups with V$ASM_DISK

SELECT SUBSTR(dg.name,1,16) AS diskgroup, SUBSTR(d.name,1,16) AS asmdisk,

d.mount_status, d.state, SUBSTR(d.failgroup,1,16) AS failgroup

FROM V$ASM_DISKGROUP dg, V$ASM_DISK d WHERE dg.group_number = d.group_number;

DISKGROUP ASMDISK MOUNT_S STATE FAILGROUP

Viewing disk group clients with V$ASM_CLIENT

SELECT dg.name AS diskgroup, SUBSTR(c.instance_name,1,12) AS instance,

SUBSTR(c.db_name,1,12) AS dbname, SUBSTR(c.SOFTWARE_VERSION,1,12) AS software,

SUBSTR(c.COMPATIBLE_VERSION,1,12) AS compatible

FROM V$ASM_DISKGROUP dg, V$ASM_CLIENT c

WHERE dg.group_number = c.group_number;

Viewing Oracle ASM File Access Control information with V$ASM_USER

SELECT dg.name AS diskgroup, u.group_number, u.user_number, u.os_id, u.os_name

FROM V$ASM_DISKGROUP dg, V$ASM_USER u

WHERE dg.group_number = u.group_number AND dg.name = 'DATA';

Viewing File Access Control information with V$ASM_USERGROUP

SELECT dg.name AS diskgroup, ug.group_number, ug.owner_number, u.os_name,

ug.usergroup_number, ug.name FROM V$ASM_DISKGROUP dg, V$ASM_USER u, V$ASM_USERGROUP ug

WHERE dg.group_number = ug.group_number AND dg.name = 'DATA'

AND ug.owner_number = u.user_number;

Viewing File Access Control information with V$ASM_USERGROUP_MEMBER

SELECT dg.name AS diskgroup, um.group_number, um.member_number, u.os_name,

um.usergroup_number, ug.name FROM V$ASM_DISKGROUP dg, V$ASM_USER u, V$ASM_USERGROUP_MEMBER um,

V$ASM_USERGROUP ug WHERE dg.group_number = um.group_number AND

dg.group_number = ug.group_number AND dg.group_number = u.group_number AND dg.name = 'DATA'

AND um.member_number = u.user_number AND um.usergroup_number = ug.usergroup_number;

Viewing Oracle ASM File Access Control information with V$ASM_FILE

SELECT dg.name AS diskgroup, a.name, f.permissions, f.user_number, u.os_name,

f.usergroup_number, ug.name

FROM V$ASM_DISKGROUP dg, V$ASM_USER u, V$ASM_USERGROUP ug, V$ASM_FILE f, V$ASM_ALIAS a

WHERE dg.name = 'FRA' AND dg.group_number = u.group_number AND

u.group_number = ug.group_number AND ug.group_number = f.group_number AND

f.group_number = a.group_number AND

f.usergroup_number = ug.usergroup_number AND f.user_number = u.user_number AND

f.file_number = a.file_number;

Viewing Intelligent Data Placement information with V$ASM_FILE

SELECT dg.name AS diskgroup, f.file_number, f.primary_region, f.mirror_region, f.hot_reads,

f.hot_writes, f.cold_reads, f.cold_writes

FROM V$ASM_DISKGROUP dg, V$ASM_FILE f

WHERE dg.group_number = f.group_number and dg.name = 'DATA';

Viewing Intelligent Data Placement information with V$ASM_TEMPLATE

SELECT dg.name AS diskgroup, t.name, t.stripe, t.redundancy, t.primary_region, t.mirror_region

FROM V$ASM_DISKGROUP dg, V$ASM_TEMPLATE t

WHERE dg.group_number = t.group_number and dg.name = 'DATA' ORDER BY t.name;

Next

https://docs.oracle.com/en/database/oracle/oracle-database/12.2/ostmg/diskgroup-compatibility.html#GUID-AE540604-92D9-4CFE-A40E-BF4486163772

This information includes how to create, alter, drop, mount, and dismount Oracle ASM disk groups. The database instances that use Oracle ASM can continue operating while you administer disk groups.

The examples in this chapter use SQL statements. These examples assume that SQL*Plus is run from the Oracle grid home where Oracle ASM is installed and the Oracle environmental variables are set to this home. The examples also assume that the Oracle ASM instance is running.

CREATE DISKGROUP data NORMAL REDUNDANCY
  FAILGROUP controller1 DISK
    '/devices/diska1' NAME diska1,
    '/devices/diska2' NAME diska2,
    '/devices/diska3' NAME diska3,
    '/devices/diska4' NAME diska4
  FAILGROUP controller2 DISK
    '/devices/diskb1' NAME diskb1,
    '/devices/diskb2' NAME diskb2,
    '/devices/diskb3' NAME diskb3,
    '/devices/diskb4' NAME diskb4
  ATTRIBUTE 'au_size'='4M',
    'compatible.asm' = '11.2', 
    'compatible.rdbms' = '11.2',
    'compatible.advm' = '11.2';

CREATE DISKGROUP fra NORMAL REDUNDANCY
  DISK '/devices/diskc*';

SQL> SELECT name, value FROM V$ASM_ATTRIBUTE 
     WHERE (name = 'sector_size' OR name = 'logical_sector_size') AND group_number = 1;
NAME                          VALUE
----------------------------- ---------------------------
sector_size                   4096
logical_sector_size           512

SQL> SELECT logical_sector_size, sector_size FROM V$ASM_DISKGROUP 
     WHERE group_number = 1;
LOGICAL_SECTOR_SIZE SECTOR_SIZE
------------------- -----------
                512        4096

CREATE DISKGROUP data NORMAL REDUNDANCY
  FAILGROUP controller1 DISK
    '/devices/diska1',
    '/devices/diska2',
    '/devices/diska3',
    '/devices/diska4'
  FAILGROUP controller2 DISK
    '/devices/diskb1',
    '/devices/diskb2',
    '/devices/diskb3',
    '/devices/diskb4'
  QUORUM FAILGROUP quorum_failgrp DISK '/devices/diskc1'
  ATTRIBUTE 'compatible.asm' = '12.2', 'compatible.rdbms' = '12.2',
            'sector_size'='4096', 'logical_sector_size'='512';

ALTER DISKGROUP data2  
  SET ATTRIBUTE 'compatible.asm' = '12.2', 'compatible.rdbms' = '12.2';

ALTER DISKGROUP data2
  SET ATTRIBUTE 'sector_size'='4096', 'logical_sector_size'='4096';

CREATE DISKGROUP mgmt_dg NORMAL REDUNDANCY
   FAILGROUP fg1 DISK '/devices/diskg1'
   FAILGROUP fg2 DISK '/devices/diskg2'
   QUORUM FAILGROUP fg3 DISK '/devices/diskg3'
   ATTRIBUTE 'compatible.asm' = '12.2.0.0.0';

SQL> ALTER DISKGROUP data ADD VOLUME volume1 SIZE 10G;
Diskgroup altered.

SQL> ALTER DISKGROUP data RESIZE VOLUME volume1 SIZE 15G;
Diskgroup altered.

SQL> ALTER DISKGROUP data DISABLE VOLUME volume1;
Diskgroup altered.

SQL> ALTER DISKGROUP data ENABLE VOLUME volume1;
Diskgroup altered.

SQL> ALTER DISKGROUP ALL DISABLE VOLUME ALL;
Diskgroup altered.

SQL> ALTER DISKGROUP data DROP VOLUME volume1;
Diskgroup altered.

/devices/diska1 -- member of data1
/devices/diska2 -- member of data1
/devices/diska3 -- member of data1
/devices/diska4 -- member of data1
/devices/diska5 -- candidate disk
/devices/diska6 -- candidate disk
/devices/diska7 -- candidate disk
/devices/diska8 -- candidate disk

/devices/diskb1 -- member of data1
/devices/diskb2 -- member of data1
/devices/diskb3 -- member of data1
/devices/diskb4 -- member of data2

/devices/diskc1 -- member of data2
/devices/diskc2 -- member of data2
/devices/diskc3 -- member of data3
/devices/diskc4 -- candidate disk

/devices/diskd1 -- candidate disk
/devices/diskd2 -- candidate disk
/devices/diskd3 -- candidate disk
/devices/diskd4 -- candidate disk
/devices/diskd5 -- candidate disk
/devices/diskd6 -- candidate disk
/devices/diskd7 -- candidate disk
/devices/diskd8 -- candidate disk

ALTER DISKGROUP data1 ADD DISK
     '/devices/diska*';

ALTER DISKGROUP data1 ADD DISK
     '/devices/diska5' NAME diska5,
     '/devices/diska6' NAME diska6,
     '/devices/diska7' NAME diska7,
     '/devices/diska8' NAME diska8;

ALTER DISKGROUP data1 ADD DISK
     '/devices/disk*4';

ALTER DISKGROUP data1 ADD DISK
      '/devices/diskd*'
       REBALANCE POWER 5 WAIT;

ALTER DISKGROUP data2 ADD DISK
     '/devices/diskc3' FORCE;

SQL> ALTER DISKGROUP data2 REPLACE DISK diskc7 WITH '/devices/diskc18' POWER 3;

SQL> ALTER DISKGROUP fra2 MOUNT RESTRICTED;

SQL> ALTER DISKGROUP fra2 RENAME DISK 'FRA1_0001' TO 'FRA2_0001', 
       'FRA1_0002' TO 'FRA2_0002';

SQL> ALTER DISKGROUP data1 RENAME DISK 'DATA1_0001' SITE SITE1;

SQL> ALTER DISKGROUP external1 RENAME DISK 'EXTERNAL1_0001' FAILGROUP FG_EXT1_0001;

ALTER DISKGROUP data1 DROP DISK diska5;

ALTER DISKGROUP data1 DROP DISK diska5
     ADD FAILGROUP failgrp1 DISK '/devices/diska9' NAME diska9;

ALTER DISKGROUP data1 RESIZE ALL SIZE 100G;

ALTER DISKGROUP data1 UNDROP DISKS;

ALTER DISKGROUP data2 REBALANCE MODIFY POWER 10;

ALTER DISKGROUP data2 REBALANCE MODIFY POWER;

ALTER DISKGROUP data2 REBALANCE WITH BALANCE COMPACT;

ALTER DISKGROUP data3 REBALANCE WITHOUT BALANCE;

ALTER DISKGROUP data2 REBALANCE RESTORE POWER 5 WAIT;

EXPLAIN WORK FOR ALTER DISKGROUP data DROP DISK data_0000;
Explained.

SELECT est_work FROM V$ASM_ESTIMATE;
EST_WORK
--------
    4211

EXPLAIN WORK SET STATEMENT_ID='online' FOR ALTER DISKGROUP data 
  ONLINE disk data_000;
Explained.

SELECT est_work FROM V$ASM_ESTIMATE WHERE STATEMENT_ID='online';
EST_WORK
--------
     421

SQL> SELECT GROUP_NUMBER, PASS, STATE FROM V$ASM_OPERATION;

GROUP_NUMBER PASS      STAT
------------ --------- ----
           2 RESYNC    WAIT
           2 REBALANCE WAIT
           2 COMPACT   WAIT

SQL> ALTER DISKGROUP data SCRUB POWER LOW;

SQL> ALTER DISKGROUP data SCRUB FILE '+DATA/ORCL/DATAFILE/example.266.806582193' 
       REPAIR POWER HIGH FORCE;

SQL> ALTER DISKGROUP data SCRUB DISK DATA_0005 REPAIR POWER HIGH FORCE;

SQL> SELECT name, header_status, path FROM V$ASM_DISK 
     WHERE path LIKE '/devices/disk0%';

NAME      HEADER_STATUS PATH
--------- ------------- ---------------------
          FORMER        /devices/disk02
          FORMER        /devices/disk01
          CANDIDATE     /devices/disk07
DISK06    MEMBER        /devices/disk06
DISK05    MEMBER        /devices/disk05
DISK04    MEMBER        /devices/disk04
DISK03    MEMBER        /devices/disk03
7 rows selected.

SQL> SELECT name, type, total_mb, free_mb, required_mirror_free_mb, 
     usable_file_mb FROM V$ASM_DISKGROUP;

NAME         TYPE     TOTAL_MB    FREE_MB REQUIRED_MIRROR_FREE_MB USABLE_FILE_MB
------------ ------ ---------- ---------- ----------------------- --------------
DATA         NORMAL       6144       3768                    1024           1372

ALTER DISKGROUP data SET ATTRIBUTE 'disk_repair_time' = '4.5h'
ALTER DISKGROUP data SET ATTRIBUTE 'disk_repair_time' = '270m'

ALTER DISKGROUP data OFFLINE DISK DATA_001 DROP AFTER 5m;

ALTER DISKGROUP data OFFLINE DISK DATA_001;

ALTER DISKGROUP data OFFLINE DISKS IN FAILGROUP FG2;

ALTER DISKGROUP data ONLINE DISKS IN FAILGROUP FG2;

ALTER DISKGROUP data ONLINE DISK DATA_001;

ALTER DISKGROUP data ONLINE ALL;

SQL> SELECT GROUP_NUMBER, PASS, STATE FROM V$ASM_OPERATION;
 
GROUP_NUMBER PASS      STAT
------------ --------- ----
           1 RESYNC    RUN
           1 REBALANCE WAIT
           1 COMPACT   WAIT

Next

Perform day to day Clusterware administration tasks
Perform Oracle Cluster Registry (OCR) backup and recovery
Manage network settings
Explain the scope and capabilities of what-if command evaluation
Policy-Based Cluster Management

Next

Plan for rolling patches and rolling upgrades
Compare software versions with the active version
Install a patchset with the Oracle Universal Installer (OUI)
Install a patch with the opatch utility
Troubleshooting Oracle Clusterware

Next

Use the Server Control (SRVCTL) utility to manage various components and applications in your cluster.

SRVCTL is installed on each node in a cluster by default. To use SRVCTL, log in to the operating system of a node and enter the SRVCTL command and its parameters in case-sensitive syntax.

The version of SRVCTL must be the same as the version of the object (listeners, Oracle ASM instances, Oracle RAC databases and their instances, and services) being managed. To ensure the versions are the same release, run SRVCTL commands from the Oracle home of the database or object you are managing.

• SRVCTL does not support concurrent executions of commands on the same object. Therefore, run only one SRVCTL command at a time for each database, service, or other object.
• When specifying a comma-delimited list as part of a SRVCTL command, there should not be any spaces between the items in the list. For example: srvctl add database -serverpool "serverpool1,serverpool3"

You can enclose a comma delimited list in double quotation marks in a Linux or UNIX environment but they
will be ignored.
• If you are entering a SRVCTL command, and you want to continue the input on a new line, then you can use the operating system continuation character. In Linux, this is the backslash (\) symbol.

• A SRVCTL command that produces no output is a successful command. Not all SRVCTL commands return a message when it completes, successfully. However,if a SRVCTL command fails, then it always returns an error message.
• You can use the -eval parameter with several SRVCTL commands. This parameter, when you use it, enables you to simulate running a command without making any changes to the system. SRVCTL returns output that informs you what will happen if you run a particular command. For example, to know what might happen if you relocate a server:

The -eval parameter is available with the following commands:
– srvctl add database
– srvctl add service
– srvctl add srvpool
– srvctl modify database
– srvctl modify service
– srvctl modify srvpool
– srvctl relocate server
– srvctl relocate service
– srvctl remove srvpool
– srvctl start database
– srvctl start service
– srvctl stop database
– srvctl stop service

Before Oracle Database 12c, the SRVCTL command-line interface used single letter parameters. However, this imposes a limit on the number of unique parameters available for use with SRVCTL commands. SRVCTL command parameters introduced in Oracle Database 12c are full words instead of single letters, such as -multicastport and -subdomain.
To support backward compatibility, you can use a mix of single-letter parameters and
new keyword parameters. New parameters introduced with keywords can be used with
single letter parameters.

To see help for all SRVCTL commands, from the command line enter:
srvctl -help
To see the command syntax and a list of parameters for each SRVCTL command,
from the command line enter:
srvctl command (or verb) object (or noun) -help
When you request online help for a command using -help, SRVCTL prints the full words for each parameter. You can obtain the single-letter equivalents, where applicable, by adding the -compatible parameter after the -help parameter. For
example:
$ srvctl config database -help -compatible

The preceding command prints usage information for the srvctl config database command, listing all parameters as full words followed by their single-letter equivalents in parentheses, where applicable.

To see the SRVCTL version number enter:
$ srvctl -version

manage databases and log in as the Oracle Grid Infrastructure software owner (for example, ora_asm) to manage the Oracle ASM instances.
Users who are members of the OSDBA operating system group can start and stop the database. To stop and start an Oracle ASM instance, you must be a member of the OSASM operating system group.

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

• Use SRVCTL to manage Oracle-supplied resources such as listener, instances,
disk groups, and networks, and CRSCTL for managing Oracle Clusterware and its
resources.
Note:
Oracle strongly discourages directly manipulating Oracle-supplied resources
(resources whose names begin with ora) using CRSCTL. This could adversely
impact the cluster configuration.
• Although you may be able to cancel running SRVCTL commands by pressing the
Control-C keys, you may corrupt your configuration data by doing this.
You are strongly advised not to attempt to terminate SRVCTL in this manner.

Use the full keyword for each parameter instead. To support older tools and scripts
that still use single-character parameters, the current version of SRVCTL supports
both single-character parameters and full keyword parameters.
The command reference in this appendix shows the keywords for each SRVCTL
command. Table G-2 lists the deprecated single-character parameters.
Appendix G
Additional SRVCTL Topics
Command Deprecated Parameters
srvctl modify asm -node node_name
srvctl modify instance -z
Instead, use the -node option with the value set to ""
srvctl modify gns [-ip ip_address] [-advertise host_name -address address]
[-delete host_name -address address] [-createalias name -
alias alias] [-deletealias alias]
Use the srvctl update gns command instead.
srvctl * oc4j The oc4j noun has been deprecated and replaced with
qosmserver. SRVCTL still accepts the oc4j noun until it is
desupported.
srvctl add service The PRECONNECToption with the -tafpolicy parameter is
deprecated.
srvctl modify service The -failovermethod {NONE | BASIC} is deprecated.
The PRECONNECToption with the -tafpolicy parameter is
deprecated.
G.8 SRVCTL Command Reference
This section lists and describes all SRVCTL commands that are run from the Oracle
Grid Infrastructure home.
See Also:
Oracle Real Application Clusters Administration and Deployment Guide for
SRVCTL command usage information
G.8.1 srvctl add asm
Adds a record for an Oracle ASM instance to the entire cluster.
This command must be run only one time from the Oracle Grid Infrastructure home.
Syntax
srvctl add asm [-listener listener_name] [-pwfile password_file_path
[-flex [-count {number_of_instances | ALL}] | -proxy [-spfile
server_parameter_file_path]]
Appendix G
SRVCTL Command Reference
G-13
Parameters
Table G-4 srvctl add asm Command Parameters
Parameter Description
-listener listener_name Enter the name of a listener. If you do not
specify this parameter, then the listener name
defaults to LISTENER.
-pwfile password_file_path Enter the full path to the location of the
password file on Oracle ASM.
-flex [-count {number_of_instances |
ALL}] |
-proxy [-spfile
server_parameter_file_path]
Specify that the Oracle ASM instances are
configured as Oracle Flex ASM instances. You
can optionally specify the number of Oracle
ASM instances to create or that an Oracle
ASM instance should be created on all nodes.
Alternatively, you can specify the -proxy
parameter to configure the Oracle ASM
Dynamic Volume Manager proxy instance
resource. Optionally, you can specify the path
to the server parameter file.
Usage Notes
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary
in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle
RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the
database home to manage Oracle ASM.
Example
To add a clusterware resource for Oracle ASM to every node in the cluster, use the
following command:
$ srvctl add asm
G.8.2 srvctl config asm
Displays the configuration for all Oracle ASM instances.
Syntax
srvctl config asm [-proxy] [-detail]
Parameters
Table G-5 srvctl config asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether the
Oracle ASM configuration to display is a proxy instance.
-detail Optionally, you can use this parameter to print detailed
configuration information.
Appendix G
SRVCTL Command Reference
G-14
Usage Notes
• Use this command only with Oracle Clusterware.
• To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL
binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have
Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL
binary in the database home to manage Oracle ASM.
Example
This command returns output similar to the following:
$ srvctl config asm
ASM Home: /u01/app/12.1.0/grid
ASM Listener: LISTENER
ASM instance count: 3
Password file:
G.8.3 srvctl disable asm
Disables the Oracle ASM proxy resource.
Oracle ASM will restart if it contains Oracle Clusterware data or if the node restarts
and it was running before the node failed. The srvctl disable asm command also
prevents the srvctl start asm command from starting Oracle ASM instances.
Disabling the Oracle ASM proxy resource prevents the databases and disk groups
from starting because they depend on the Oracle ASM proxy resource.
Syntax
srvctl disable asm [-proxy] [-node node_name]
Parameters
Table G-6 srvctl disable asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
disabling a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
disable Oracle ASM.
Usage Notes
• To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL
binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have
Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL
binary in the database home to manage Oracle ASM.
• Oracle ASM is part of the Oracle Clusterware stack and when OCR and voting
files are stored on Oracle ASM, then Oracle ASM starts when OHASD starts the
Oracle Clusterware stack. The srvctl disable asm command does not prevent the
Oracle ASM instance managed by OHASD from starting. Oracle ASM, therefore,
starts as needed by the Oracle Clusterware stack.
Appendix G
SRVCTL Command Reference
G-15
The srvctl disable asm command prevents the Oracle ASM Oracle Clusterware
proxy resource, and any resources that depend on it, from starting. So, the
command prevents Oracle Clusterware-managed objects, such as databases, disk
groups, and file systems that depend on Oracle ASM, from starting. For example,
the srvctl start database | diskgroup | filesystem command fails to start any of
those objects on nodes where the Oracle ASM Oracle Clusterware proxy resource
is disabled. The command also prevents the srvctl start asm command from
starting Oracle ASM on remote nodes.
Example
The following example disables Oracle ASM on a node named crmnode1:
$ srvctl disable asm -node crmnode1
G.8.4 srvctl enable asm
Enables an Oracle ASM instance.
Syntax
srvctl enable asm [-proxy] [-node node_name]
Parameters
Table G-7 srvctl enable asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
enabling a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
enable Oracle ASM.
Usage Notes
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary
in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle
RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the
database home to manage Oracle ASM.
Example
An example of this command is:
$ srvctl enable asm -node crmnode1
G.8.5 srvctl getenv asm
Displays the values for environment variables associated with Oracle ASM.
Syntax
srvctl getenv asm [-envs "name_list"]
Appendix G
SRVCTL Command Reference
G-16
Usage Notes
• If you choose not use the -env parameter, then the values of all environment
variables associated with Oracle ASM are displayed.
• You can specify a comma-delimited list of the names of environment variables for
which you want to retrieve the values.
Example
The following example displays the current values for all the environment variables
used by Oracle ASM:
$ srvctl getenv asm
G.8.6 srvctl modify asm
Modifies the listener used by Oracle ASM, the disk group discovery string used by
Oracle ASM, or the SPFILE used by Oracle ASM for a noncluster database or a
cluster database.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl modify asm [-listener listener_name] [-pwfile password_file_path]
[-count {number_of_instances | ALL}] [-diskstring asm_diskstring]
[-spfile spfile_path_name [-proxy] [-force]]
Parameters
Parameter Description
-listener
listener_name
Specify the name of the listener with which Oracle ASM registers.
-pwfile
password_file_path
Specify the full path to the location of the password file for Oracle
ASM.
-count
{number_of_instances |
ALL}
Specify the number of Oracle ASM instances to create, or that an
Oracle ASM instance should be created on all nodes.
-diskstring
asm_diskstring
Specify a new Oracle ASM disk group discovery string.
-spfile
spfile_path_name
Specify the path to the new spfile to be used by Oracle ASM.
-proxy Use this parameter to specify an Oracle ASM proxy instance.
–force Use this parameter to force modification of Oracle ASM.
Appendix G
SRVCTL Command Reference
G-17
Example
An example of this command to modify the configuration of Oracle ASM is:
$ srvctl modify asm -listener lsnr1
G.8.7 srvctl predict asm
Predicts the consequences of Oracle ASM failure.
Syntax
srvctl predict asm [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify a particular node on which you want to predict the
consequences of an Oracle ASM failure.
• You can choose verbose output.
Example
An example of this command to predict the consequences of an Oracle ASM failure on
a particular node:
$ srvctl predict asm -node crmnode2
G.8.8 srvctl relocate asm
Relocates an Oracle Flex ASM instance from one Hub Node of an Oracle Flex Cluster
to another.
Syntax
srvctl relocate asm -currentnode current_node [-targetnode target_node] [-force]
Parameters
Table G-8 srvctl relocate asm Parameters
Parameter Description
-currentnode
current_node
Name of the node on which the Oracle Flex ASM instance currently
resides.
-targetnode
target_node
Name of the node to which you want to relocate the Oracle Flex
ASM instance.
-force Force the relocation of the Oracle Flex ASM instance.
Usage Notes
• You cannot use this command if there is only one Oracle Flex ASM instance
running.
• Because of bootstrap issues between Oracle ASM and Oracle Clusterware, on the
node where Oracle Clusterware uses Oracle ASM run either crsctl stop crs or
Appendix G
SRVCTL Command Reference
G-18
crsctl stop cluster to stop Cluster Ready Services on the node before you
relocate the Oracle ASM instance.
Example
An example of this command to relocate an Oracle Flex ASM instance from the
current node to a node named hubnode2 is:
$ srvctl relocate asm -currentnode hubnode1 -targetnode hubnode2
G.8.9 srvctl remove asm
Removes the Oracle ASM resource from Oracle Clusterware management.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl remove asm [-proxy] [-force]
Parameters
Table G-9 srvctl remove asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
removing a proxy Oracle ASM configuration.
-force Forcefully removes an Oracle ASM resource (ignores any
dependencies).
Example
An example of this command is:
$ srvctl remove asm -force
G.8.10 srvctl setenv asm
Sets Oracle ASM environment configurations.
Syntax
Use this command with one of the following syntaxes:
srvctl setenv asm -envs "name=value,[...]"
srvctl setenv asm -env "name=value"
Appendix G
SRVCTL Command Reference
G-19
Parameters
Table G-10 srvctl setenv asm Command Parameters
Parameter Description
-envs "name=value,
[...]"
Use this parameter to specify either a single name-value pair or a
comma-delimited list of multiple name-value pairs of environment
variables enclosed in double quotation marks ("").
-env "name=value" Use this parameter to enable a single environment variable to be
set to a value that contains commas or other special characters,
enclosed in double quotation marks ("").
Example
The following example sets the language environment configuration for Oracle ASM:
$ srvctl setenv asm -envs "LANG=en"
G.8.11 srvctl start asm
Starts an Oracle ASM instance.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl start asm [-proxy] [-node node_name [-startoption start_options]]
Parameters
Table G-11 srvctl start asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
starting a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
start Oracle ASM.
Note: You can use this parameter only with Oracle Clusterware.
Appendix G
SRVCTL Command Reference
G-20
Table G-11 (Cont.) srvctl start asm Command Parameters
Parameter Description
-startoption
start_options
Optionally, you can specify options to the startup command, such
as OPEN, MOUNT, or NOMOUNT
Note: For multi-word startup options, such as read only and read
write, separate the words with a space and enclose in double
quotation marks (""). For example, "read only".
See Also: SQL*Plus User's Guide and Reference for more
information about startup options
Examples
An example of this command to start an Oracle ASM instance on a single node of a
cluster is:
$ srvctl start asm -node crmnode1
An example to start an Oracle ASM instance on all nodes in the cluster, or for a
noncluster database, is:
$ srvctl start asm
G.8.12 srvctl status asm
Displays the status of an Oracle ASM instance.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl status asm [-proxy] [-node node_name] [-detail] [-verbose]
Parameters
Table G-12 srvctl status asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to display the
status for an Oracle ASM proxy instance.
-node node_name Optionally, you can specify a particular node. If you do
not specify this parameter, then SRVCTL displays the
status of all Oracle ASM instances.
-detail Print detailed status information.
Appendix G
SRVCTL Command Reference
G-21
Table G-12 (Cont.) srvctl status asm Command Parameters
Parameter Description
-verbose Displays verbose output.
Example
This command returns output similar to the following:
$ srvctl status asm -verbose
ASM is enabled
ASM is running on node2, node3, node4
ASM instance +ASM2 is running on node node2
Number of clients connected: 4
Names of clients: db002, db003, +IOS1, clicluster1:later3
ASM instance +ASM3 is running on node node3
Number of clients connected: 2
Names of clients: db001, +IOS2
ASM instance +ASM4 is running on node node4
Number of clients connected: 2
Names of clients: db004, db005
G.8.13 srvctl stop asm
Stops an Oracle ASM instance.
Syntax
srvctl stop asm [-proxy] [-node node_name] [-stopoption stop_options] [-force]
Parameters
Table G-13 srvctl stop asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
stopping a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
stop Oracle ASM.
If you do not specify this parameter, then SRVCTL stops the Oracle
ASM instance on every active node in the cluster.
Note: You can use this parameter only with Oracle Clusterware.
-stopoption
stop_options
Optionally, you can specify options to the shutdown command,
such as NORMAL, TRANSACTIONAL, IMMEDIATE, or ABORT.
See Also: SQL*Plus User's Guide and Reference for more
information about shutdown options
-force Optionally, you can use this parameter to stop disk groups, file
systems, and databases that depend on Oracle ASM.
Appendix G
SRVCTL Command Reference
G-22
Usage Notes
• To manage Oracle ASM on Oracle Database 12c installations, use SRVCTL in the
Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC
or Oracle Database installed, then you cannot use SRVCTL in the database home
to manage Oracle ASM.
• You cannot use this command when OCR is stored in Oracle ASM because it will
not stop Oracle ASM. To stop Oracle ASM you must shut down Oracle
Clusterware.
Example
An example of this command is:
$ srvctl stop asm -node crmnode1 -stopoption IMMEDIATE
G.8.14 srvctl unsetenv asm
Unsets the Oracle ASM environment configurations.
Syntax
srvctl unsetenv asm -envs "name_list"
Usage Notes
Use the -envs parameter to specify a comma-delimited list of the names of
environment variables enclosed in double quotation marks ("").
Example
The following example unsets the environment configuration for an Oracle ASM
environment variable:
$ srvctl unsetenv asm -envs "CLASSPATH"
G.8.15 srvctl add cvu
Adds the Cluster Verification Utility (CVU) to an Oracle Clusterware configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax and Parameters
Use the srvctl add cvu command with the following syntax:
srvctl add cvu [-checkinterval time_in_minutes]
Appendix G
SRVCTL Command Reference
G-23
Usage Notes
• Optionally, you can change the interval between checks. By default, CVU runs
once every 6 hours and verifies the health of the cluster. The shortest interval you
can specify for CVU check is 10 minutes.
• Run this command while logged in as the Grid home user.
Example
To add CVU with a check interval of 6 hours, use the following command:
$ srvctl add cvu -checkinterval 360
G.8.16 srvctl config cvu
Displays the time interval, in minutes, between CVU checks.
Syntax and Parameters
Use the srvctl config cvu command with the following syntax:
srvctl config cvu
This command has no parameters.
Example
This command returns output similar to the following:
CVU is configured to run once every 360 minutes
G.8.17 srvctl disable cvu
Disables the Cluster Verification Utility (CVU) for Oracle Clusterware management (if
enabled).
Syntax
srvctl disable cvu [-node node_name]
Parameters
Optionally, you can specify the name of a particular node on which you want to disable
CVU. Otherwise, SRVCTL disables CVU on all nodes.
Example
An example of this command to disable CVU on a node named crmnode1 is:
$ srvctl disable cvu -node crmnode1
G.8.18 srvctl enable cvu
Enables the Cluster Verification Utility (CVU) for Oracle Clusterware management (if
disabled).
Appendix G
SRVCTL Command Reference
G-24
Syntax
srvctl enable cvu [-node node_name]
Parameters
Optionally, you can specify the name of a particular node on which you want to enable
CVU. Otherwise, SRVCTL enables CVU on all nodes.
Example
An example of this command to enable CVU on a node named crmnode1 is:
$ srvctl enable cvu -node crmnode1
G.8.19 srvctl modify cvu
Modifies the check interval for CVU.
Syntax
srvctl modify cvu [-checkinterval time_in_minutes]
Parameters
By default, CVU runs once every 360 minutes (six hours) and verifies the health of
cluster. If you change the interval, then the shortest interval you can specify for CVU
check is 10 minutes.
Example
An example of this command to modify CVU to have a check interval of 4 hours is:
$ srvctl modify cvu -checkinterval 240
G.8.20 srvctl relocate cvu
Temporarily relocates the CVU to another node in a cluster.
Syntax
srvctl relocate cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node to which you want to relocate CVU.
Example
An example of this command to temporarily relocate CVU from the local node to the
cluster node named crmnode2 is:
$ srvctl relocate cvu -node crmnode2
Appendix G
SRVCTL Command Reference
G-25
G.8.21 srvctl remove cvu
Removes CVU from an Oracle Clusterware configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove cvu [-force]
Usage Notes
Use the -force parameter to remove a CVU resource that is running or starting.
G.8.22 srvctl start cvu
Starts the CVU resource on one node in a cluster. If you specify a node name, then
CVU starts on that node.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node to which you want to start CVU.
Otherwise, SRVCTL starts CVU on all nodes.
Example
An example of this command to start CVU on a single node of a cluster is:
$ srvctl start cvu -node crmnode1
Appendix G
SRVCTL Command Reference
G-26
G.8.23 srvctl status cvu
Displays the current state of the CVU resource on one node in a cluster. If you specify
a node name, then the command checks CVU status on that node.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node where the CVU resource is running, if it is
not the local node.
Example
An example of this command to check the status of CVU on the node in the cluster
named crmnode1 is:
$ srvctl status cvu -node crmnode1
G.8.24 srvctl stop cvu
Stops the Cluster Verification Utility (CVU) that is either in the running or starting state.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop cvu [-force]
Usage Notes
Optionally, you can specify the -force parameter to stop CVU if it is a dependant
resource.
Example
An example of this command to stop CVU:
$ srvctl stop cvu
G.8.25 srvctl add exportfs
Creates an export file system configuration in Oracle Clusterware.
Appendix G
SRVCTL Command Reference
G-27
Syntax
srvctl add exportfs -name unique_name -id havip_name -path path_to_export
[-clients export_clients] [-options export_options] [-type NFS | SMB]
Parameters
Table G-14 svrctl add exportfs Command Parameters
Parameter Description
-name unique_name Enter a unique name for the export file system that you are
creating. This parameter is required.
-id havip_name Enter the number or name that identifies an existing HAVIP, that
you specified in the srvctl add havip command. This parameter
is required.
-path path_to_export Enter the path to the Oracle Automatic Storage Management
Cluster File System (Oracle ACFS) that you want to export. This
parameter is required.
-clients
export_clients -
options export_options
Optionally, enter a comma-delimited list of clients to which you
want the file system exported. You can enter net groups and
wildcards. For example:
-clients @netgroup1,
*.us.domain.com,
16.140.0.0, hostname1
Note: You can use the -clients parameter only for Linux systems.
Use the -options parameter for Solaris and AIX systems.
-type NFS | SMB Specify the export type (NFS for a network file system or SMB for
Oracle ACFS server message block). The default is NFS for Linux
and UNIX platforms, and SMB for Windows.
Usage Notes
You must run this command as root on Linux and UNIX platforms.
Example
To export with operating system defaults:
# srvctl add exportfs -name cifsExport -path "/acfs1" -options "browsable = yes,read
only = no,comment = acfs1"
To export read-only to certain clients:
# srvctl add exportfs -name export1 -id havip1 -path /u01/db1 -clients node1 -
options ro
G.8.26 srvctl config exportfs
Displays the configuration information for the export file system in Oracle Clusterware.
Syntax
srvctl config exportfs [-name unique_name | -id havip_name]
Appendix G
SRVCTL Command Reference
G-28
Parameters
Table G-15 srvctl config exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export for which you want to
display the configuration.
-id havip_name Enter the name of a HAVIP to display the configuration of all the
NFS exports attached to the specific HAVIP.
Example
If you specify the -name parameter, then this command returns output similar to the
following, whether you specify -name or -id:
$ srvctl config exportfs -id havip1
export file system kep1 is configured
Exported path: /scratch/ghnew/base/mymount3
Export options:
Export Type:
Exported clients:
export file system kexp2 is configured
Exported path: /scratch/ghnew/base/mymount3
Export options:
Export Type:
Exported clients:
G.8.27 srvctl disable exportfs
Disables an export file system managed by Oracle Clusterware.
Syntax
srvctl disable exportfs -name filesystem_name
Usage Notes
• This command takes only the unique name of the file system you want to disable.
• You must run this command as root user on Linux and UNIX platforms.
Example
The following example disables an export file system called export1:
# srvctl disable exportfs -name export1
G.8.28 srvctl enable exportfs
Enables an export file system configuration in Oracle Clusterware.
Syntax
srvctl enable exportfs -name filesystem_name
Appendix G
SRVCTL Command Reference
G-29
This command takes only the name of the file system you want to enable, which is a
required parameter.
Usage Notes
You must run this command as the root user on Linux and UNIX platforms.
Example
The following command example enables a file system named export1:
# srvctl enable exportfs -name export1
G.8.29 srvctl modify exportfs
Modifies an export file system configuration in Oracle Clusterware.
Syntax
srvctl modify exportfs -name unique_name [-path path_to_export]
[-clients node_list] [-options nfs_options_string]
Parameters
Table G-16 srvctl modify exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export file system to modify.
This parameter is required.
-path path_to_export You can modify the path to the Oracle Automatic Storage
Management Cluster File System (Oracle ACFS) where the export
is located.
-clients node_list You can modify the comma-delimited list of clients (hosts) to where
the file system is exported. You can enter net groups and
wildcards. For example:
-clients @netgroup1,*.us.domain.com,16.140.0.0, hostname1
Note: You can use the -clients parameter only for Linux systems.
Use the -options parameter for Solaris and AIX systems.
-options
nfs_client_string
Use this parameter to modify the export options for the export file
system.
Usage Notes
• You must run this command as root user on Linux and UNIX platforms.
• You must start and stop the NFS export before any changes you make take effect.
Example
The following command example modifies the path of an export file system named
exportfs1:
# srvctl modify exportfs -name exportfs1 -path /mnt/racdb1
Appendix G
SRVCTL Command Reference
G-30
G.8.30 srvctl remove exportfs
Removes the specified export file system configuration.
Syntax
srvctl remove exportfs -name exportfs_name [-force]
Parameters
Table G-17 srvctl remove exportfs Command Parameters
Parameter Description
-name exportfs_name Enter the unique name of the export file system you want to
remove.
-force Use this parameter to ignore any dependencies and forcibly
remove the export file system.
Usage Notes
• You must run this command as root user on Linux and UNIX platforms.
• If you do not use the -force parameter, then you must first stop the export file
system you want to remove before you remove it.
• If you use the -force parameter, then the resulting configuration can cause errors
when attempting to shut down the Oracle Clusterware stack.
Examples
To remove the stopped export file system named export1:
# srvctl remove exportfs -name export1
To remove a running export file system, leaving it exported:
# srvctl remove exportfs -name export1 -force
G.8.31 srvctl start exportfs
Starts an export file system configuration in Oracle Clusterware.
Syntax
srvctl start exportfs {-name unique_name | -id havip_name}
Parameters
Table G-18 srvctl start exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export you want to start.
-id havip_name The unique ID associated with the HAVIP resource.
Appendix G
SRVCTL Command Reference
G-31
Example
To start an export file system:
$ srvctl start exportfs -name export1
G.8.32 srvctl status exportfs
Displays the status of an export file system configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status exportfs [-name unique_name | -id havip_name]
Parameters
Table G-19 srvctl status exportfs Command Parameters
Parameter Description
-name unique_name Optionally, you can specify the unique name of the NFS export for
which you want to display the status.
-id havip_name Alternatively, you can specify the name of an HAVIP resource and
display the status of all of the NFS exports associated with the
specified HAVIP resource.
Usage Notes
If you do not specify any parameters, then SRVCTL displays the status for all NFS
exports in the cluster.
Example
This command returns output similar to the following:
$ srvctl status exportfs
export file system export1 is enabled
export file system export1 is not exported
export file system export2 is enabled
export file system export2 is exported on node node1
G.8.33 srvctl stop exportfs
Stops an export file system configuration managed by Oracle Clusterware.
Syntax
srvctl stop exportfs {-name unique_name | -id havip_name} [-force]
Appendix G
SRVCTL Command Reference
G-32
Parameters
Table G-20 srvctl stop exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export you want to stop.
-id havip_name Alternatively, you can specify the name of an HAVIP. If you specify
this parameter, then SRVCTL stops all of the NFS exports
associated with the HAVIP resource you specify.
–force Stop the NFS export, ignoring errors.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl stop exportfs -name export1
G.8.34 srvctl add filesystem
Adds a device containing a file system (Oracle Automatic Storage Management
Cluster File System (Oracle ACFS) or other) to the Oracle Clusterware stack for
automount and high availability.
An Oracle ACFS file system resource is typically created for use with application
resource dependency lists. For example, if an Oracle ACFS file system is configured
for use as an Oracle Database home, then a resource created for the file system can
be included in the resource dependency list of the Oracle Database application. This
will cause the file system and stack to be automatically mounted because of the start
action of the database application.
Syntax
srvctl add filesystem -device volume_device -path mountpoint_path
[-volume volume_name] [-diskgroup disk_group_name]
[-node node_list | -serverpool server_pool_list] [-user user_list]
[-fstype {ACFS | EXT3 | EXT4}] [-fsoptions options] [-description description]
[-appid application_id] [-autostart {ALWAYS | NEVER | RESTORE}]
Note:
Oracle supports the EXT3 and EXT4 values for the -fstype parameter only for
Linux.
Appendix G
SRVCTL Command Reference
G-33
Parameters
Table G-21 srvctl add filesystem Command Parameters
Parameter Description
-device volume_device Specify the path to the file system volume device you want to add.
-path mountpoint_path Specify the mount point path that is used to set up dependencies
on other resources for nested mounts. This must be an absolute
path.
-volume volume_name Optionally, you can specify the name of the volume.
-diskgroup
disk_group_name
Optionally, you can specify the name of the Oracle ACFS disk
group to which you want to add the device.
-node node_list | -
serverpool
server_pool_list
Optionally, you can specify a comma-delimited list of nodes on
which to mount the file system device. If you specify a list of nodes
or a server pool, then SRVCTL creates a single-node file system
resource. Without any nodes or server pools, SRVCTL creates a
file system resource that runs on every cluster node.
Alternatively, you can specify a comma-delimited list of server
pools in which a file system will run. If you specify a list of server
pools, then you dynamically limit the number or type of nodes on
which a file system will run. This does not count as a cluster-wide
file system for later usage that may require a cluster-wide Oracle
ACFS resource, such as HANFS.
Note: Nodes and server pools are mutually exclusive.
-user user_list Optionally, you can specify a comma-delimited list of users
authorized to mount and unmount the file system.
If you specify no users, then only root can mount and unmount the
file system. If the file system is for Oracle Database software, then
specify the name of the Oracle home owner.
-fstype {ACFS | EXT3 |
EXT4}
Optionally, you can specify the type of file system to be mounted.
The default value is ACFS.
If the type of file system to be mounted is not ACFS, then it must be
a single-node file system, and you must specify -node or -
serverpool.
-fsoptions options Optionally, you can specify options used to mount the file system.
The options are file system and operating system dependent.
-description
description
Optionally, you can specify a description of the file system. This is
stored as an attribute for later viewing by an administrator.
-appid application_id Optionally, you can specify an application ID, which is a unique
identifier used to group file systems into logical groupings. You can
use this method to group file systems that may be different on
different nodes but are used by an application that must have a
dependency on the resource type, which is ora.id.fs.type.
-autostart {ALWAYS |
NEVER | RESTORE}
Optionally, you can specify the file system resource autostart
policy.
ALWAYS: The file system resource always automatically starts.
NEVER: The file system does not automatically start.
RESTORE: The file system is restored to its last state. This is the
default option.
Appendix G
SRVCTL Command Reference
G-34
Usage Notes
• Use this command only with Oracle Clusterware.
• You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms.
• This command must be run only one time from the Oracle Grid Infrastructure
home.
• To manage Oracle ACFS on Oracle Database 12c installations, use the SRVCTL
binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have
Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL
binary in the database home to manage Oracle ACFS.
Examples
To add the d1volume1-295 disk device in the disk group RAC_DATA as the Oracle ACFS
volume VOLUME1 with a mount point of /oracle/cluster1/acfs:
# srvctl add filesystem -device /dev/asm/d1volume1-295
-path /oracle/cluster1/acfs1
To add an Oracle ACFS file system on the dynamic volume device asm-test-55, with
this file system mounted on one of the specified nodes at a time:
# srvctl add filesystem -fstype ACFS -device asm-test-55 -path myacfs
-node node1,node2,node3
G.8.35 srvctl config filesystem
Displays the configuration for a specific file system resource.
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config filesystem -device volume_device
Usage Notes
Use the -device parameter to specify the path to the file system resource for which you
want to display the configuration.
Examples
The following example lists the configuration of all file systems:
$ srvctl config filesystem
The following example displays the configuration for a specific device:
$ srvctl config filesystem -device /dev/asm/d1volume1-295
Appendix G
SRVCTL Command Reference
G-35
G.8.36 srvctl disable filesystem
Disables a specific Oracle Clusterware-managed file system volume.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable filesystem -device volume_device
Usage Notes
Specify the path to the file system volume you want to disable.
Example
An example of this command is:
# srvctl disable filesystem -device /dev/asm/racvol1
G.8.37 srvctl enable filesystem
Enables an Oracle ACFS volume or generic file system in Oracle Clusterware.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable filesystem -device volume_device
Usage Notes
Specify the path to the volume device you want to enable.
Example
An example of this command is:
# srvctl enable filesystem -device /dev/asm/racvol1
Appendix G
SRVCTL Command Reference
G-36
G.8.38 srvctl modify filesystem
Modifies the configuration of the file system resource.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl modify filesystem -device volume_device -user user_name
[-path mountpoint_path] [-node node_list | -serverpool
server_pool_list] [-fsoptions options] [-description description]
[-autostart {ALWAYS | NEVER | RESTORE}]
Parameters
Table G-22 srvctl modify filesystem Command Parameters
Parameter Description
-device volume_device Specify the path to the file system volume device you want to
modify.
-user user_name Specify the name of the user that is authorized to mount and
unmount the file system. If you do not specify this parameter, then
SRVCTL defaults to the user running the command.
-path mountpoint_path Modify the mount point path that is used to set up dependencies on
other resources for nested mounts. This must be an absolute path.
-node node_list | -
serverpool
server_pool_list
Modify a comma-delimited list of nodes on which to mount the file
system device. If you specify a list of nodes or a server pool, then
SRVCTL creates a single-node file system resource. Without any
nodes or server pools, SRVCTL creates a file system resource that
runs on every cluster node.
Alternatively, you can modify a comma-delimited list of server pools
in which a file system will run. If you specify a list of server pools,
then you dynamically limit the number or type of nodes on which a
file system will run. This does not count as a cluster-wide file
system for later usage that may require a cluster-wide Oracle
ACFS resource, such as HANFS.
Note: Nodes and server pools are mutually exclusive.
-fsoptions options Modify options used to mount the file system. The options are file
system and operating system dependent.
-description
description
Modify the description of the file system.
-autostart {ALWAYS |
NEVER | RESTORE}
Modify the file system resource autostart policy.
ALWAYS: The file system resource always automatically starts
NEVER: The file system does not automatically start
RESTORE: The file system is restored to its last state. This is the
default option.
Appendix G
SRVCTL Command Reference
G-37
Usage Notes
• You must run this command as root user on Linux and UNIX platforms.
• When performing online changes to the file system resource, the changes take
effect only after the resource is next (re)started.
Example
The following example changes the authorized user to sysad for the RACVOL1 volume:
# srvctl modify filesystem -device /dev/asm/racvol1 -user sysad
G.8.39 srvctl predict filesystem
Predicts the consequences of file system failure.
Syntax
srvctl predict filesystem -device volume_device_name [-verbose]
Usage Notes
• Specify the path name of the file system volume device.
• Optionally, you can choose verbose output.
Example
An example of this command is:
$ srvctl predict filesystem -device /dev/asm/volume1-123
G.8.40 srvctl remove filesystem
Removes a specific file system resource from the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove filesystem -device volume_device_name [-force]
Usage Notes
• Specify the path to the file system resource device you want to remove.
• Optionally, you can use the -force parameter to ignore any resource
dependencies and forcibly remove the resource from the cluster.
• You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms.
Appendix G
SRVCTL Command Reference
G-38
Examples
An example of this command is:
# srvctl remove filesystem -device /dev/asm/racvol1
G.8.41 srvctl start filesystem
Starts (mounts) the file system resource.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start filesystem -device volume_device [-node node_name]
Parameters
Table G-23 srvctl start filesystem Command Parameters
Parameter Description
-device volume_device Specify the path of the file system resource device that you want to
start.
-node node_name Optionally, you can specify the name of the node on which the file
system resource should be started.
If you do not specify this parameter, then SRVCTL starts the file
system resource on all the available nodes in the cluster.
Usage Notes
You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms, or as a configured file system user.
See Also:
srvctl add filesystem for more information about configuring file system users
Examples
To start a file system on all configured nodes in the cluster:
$ srvctl start filesystem -device /dev/asm/data_db1-68
To start the file system on node1:
$ srvctl start filesystem -device /dev/asm/data_db1-68 -node node1
Appendix G
SRVCTL Command Reference
G-39
G.8.42 srvctl status filesystem
Displays the status of the file system resource.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status filesystem [-device volume_device] [-verbose]
Usage Notes
• Optionally, you can specify the path of the file system resource for which you want
to obtain the status. If you do not specify this parameter, then SRVCTL displays
the status of all file systems.
• Optionally, you can use the -verbose parameter to display detailed output.
Examples
This command displays output similar to the following, depending on whether you
specify a device name.
If you specify a device name:
$ srvctl status filesystem -device /dev/asm/racvol_1
ACFS file system is not mounted on node1
ACFS file system is not mounted on node2
If you do not specify a device name:
$ srvctl status filesystem
ACFS file system is not running
ACFS file system is running on node1,node3
Note:
In the preceding examples, the file system is Oracle ACFS. If you are using
other file systems, then they will display as EXT3 or EXT4.
Appendix G
SRVCTL Command Reference
G-40
G.8.43 srvctl stop filesystem
Stops (unmounts) the Oracle ACFS file system or generic file system.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop filesystem -device volume_device [-node node_name] [-force]
Parameters
Table G-24 srvctl stop filesystem Command Parameters
Parameter Description
-device volume_device Specify the path to the file system volume device that you want to
stop.
-node node_name Optionally, you can specify the name of a node. If you do not
specify this parameter, then SRVCTL stops the volume resource on
all active nodes in the cluster.
-force Optionally, you can use -force to stop the file system and also
stop any databases or other resources that depend on this file
system.
Usage Notes
You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms, or as a configured file system user.
See Also:
srvctl add filesystem for more information about configuring file system users
Example
An example of this command is:
# srvctl stop filesystem -device /dev/asm/racvol_1 -force
G.8.44 srvctl add gns
Adds the Grid Naming Service (GNS) to a cluster when you are using a DHCP public
network or creating a client cluster.
Appendix G
SRVCTL Command Reference
G-41
Syntax
Use the srvctl add gns command with one of the following syntax models:
To add GNS to a cluster that is not currently running GNS:
srvctl add gns [-domain domain_name] -vip {vip_name | ip_address} [-skip] [-verbose]
To change a cluster that is not running GNS to be a client cluster of another cluster
that is running GNS:
srvctl add gns -clientdata file_name
To add a secondary GNS to a cluster:
srvctl add gns -vip vip_name | ip_address -clientdata file_name
Parameters
Table G-25 srvctl add gns Command Parameters
Parameter Description
-domain domain_name The network subdomain that is used for Forward DNS Lookup of
cluster IP addresses. You can only use this parameter if you
specify -vip, and you must use this parameter if the cluster to
which you are adding GNS has a GNS zone delegation and you
are using DHCP. The cluster to which you add GNS using -vip
with the -domain parameters becomes a server cluster.
If you do not specify -domain, then SRVCTL adds GNS without a
domain.
-vip {vip_name |
ip_address}
Specify either the virtual IP (VIP) name or IP address on which
GNS listens for DNS requests. You cannot use -vip with -
clientdata.
Use the -domain parameter with -vip to make the cluster to which
you are adding GNS a server cluster.
-skip Specify this parameter to skip the reachability check of the VIP
address.
-clientdata
path_to_file
Specify the path to the file you created with the srvctl export gns
command that contains the GNS credentials. You must copy this
file to a node in the cluster you are adding before running the
srvctl add gns command.
The cluster to which you add GNS using -clientdata becomes
either a client cluster or a secondary GNS.
You can only use the -clientdata parameter with the -vip
parameter when you are adding a secondary GNS.
-verbose Verbose output.
Usage Notes
• You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms.
• When you are adding GNS to a cluster for the first time, use the -vip parameter
with the -domain parameter.
Appendix G
SRVCTL Command Reference
G-42
• When you are adding GNS to a cluster using the -clientdata parameter, you must
first export the GNS data to a file and manually copy the file to a node in the
cluster you are adding. Use the -clientdata parameter and run this command on
any node in the cluster.
• You can only specify the -vip and -clientdata parameters at the same time when
you are adding a secondary GNS.
Examples
To add GNS to a cluster, making it a server cluster:
# srvctl add gns -vip 192.168.16.17 -domain cluster.mycompany.com
To add GNS to a cluster, making it a client cluster:
# srvctl add gns -clientdata /tmp/gnsdata
G.8.45 srvctl config gns
Displays the configuration for the grid naming service (GNS).
Syntax
srvctl config gns [-detail] [-subdomain] [-multicastport] [-node node_name] [-port]
[-status]
[-version] [-query name] [-list] [-clusterguid] [-clustername] [-clustertype] [-
loglevel]
[-network] [-role] [-instances]
Parameters
Table G-26 srvctl config gns Command Parameters
Parameter Description
-detail Print detailed configuration information about the GNS.
-subdomain Display the subdomain served by GNS.
-multicastport Display the port on which the GNS daemon is listening for multicast
requests.
-node node_name Display the configuration information for GNS on the specified
node.
-port Display the port that the GNS daemon uses to communicate with
the DNS server.
-status Display the status of GNS.
-version Display the version of GNS.
-query name Query GNS for the records belonging to a specific name.
-list List all records in GNS.
-clusterguid Display the globally unique identifier of the cluster where GNS is
running.
-clustername Display the name of the cluster where GNS is running.
-clustertype Display the type of configuration of GNS on this cluster.
-loglevel Print the log level of the GNS.
Appendix G
SRVCTL Command Reference
G-43
Table G-26 (Cont.) srvctl config gns Command Parameters
Parameter Description
-network Display network on which GNS is listening.
-role Display the role of the GNS instance.
-instances Display the instance list.
G.8.46 srvctl disable gns
Disables GNS for a specific node, or all available nodes in the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable gns [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify the name of a node in the cluster on which you want to
disable GNS. If you do not specify this parameter, then SRVCTL disables GNS for
the entire cluster.
• Optionally, you can use the -verbose parameter to display detailed output.
Example
An example of this command to disable GNS on the node named crm7 is:
$ srvctl disable gns -node crm7
G.8.47 srvctl enable gns
Enables GNS on all nodes or a specific node.
Note:
This command can be used only with Oracle Clusterware.
Syntax
srvctl enable gns [-node node_name] [-verbose]
Appendix G
SRVCTL Command Reference
G-44
Usage Notes
• Optionally, you can specify the name of a node on which you want to enable GNS.
If you do not specify this parameter, then SRVCTL enables GNS on all nodes in
the cluster.
• Optionally, you can use the -verbose parameter to print detailed output.
Example
An example of this command is:
$ srvctl enable gns -node node1
G.8.48 srvctl export gns
Exports Grid Naming Service (GNS) instance data to a file that you can use when you
are either moving GNS from one server cluster to another or when you are creating a
client cluster.
SRVCTL extracts the data from OCR. Exported data includes:
• The credentials used to authorize users, which includes the VIP address on which
the server listens
• The names and DNS records kept in GNS
Syntax
srvctl export gns {-instance path_to_file | {-clientdata path_to_file -role {CLIENT|
SECONDARY} [-version]}}
Parameters
Table G-27 srvctl export gns Command Parameters
Parameter Description
-instance path_to_file Use this parameter to specify the file to which GNS instance data is
written, when you are moving GNS from one server cluster to
another.
-clientdata
path_to_file -role
{CLIENT|SECONDARY}
Use this parameter to specify the file to which GNS credentials data
is written, when you are adding a client cluster to create a file that
contains credentials that the client cluster accesses to perform
name management operations on the server cluster.
You must also use the -role parameter to specify a role for which
the client data will be exported.
-version Optionally, you can use this parameter to specify the version for
which the client data will be generated.
Example
The following command exports the GNS credentials data to a file named gns.txt:
$ srvctl export gns -clientdata /temp/gnsdata/gns.txt
Appendix G
SRVCTL Command Reference
G-45
G.8.49 srvctl import gns
The srvctl import gns command imports data from a file that you create when you run
the srvctl export gns command. Use this command when you want to locate GNS to
a different server cluster.
When you import GNS data, SRVCTL stores the credentials and places the record
data into OCR. If another GNS instance is running or data for another instance is
encountered during the import procedure, then an error occurs.
This command also makes the cluster in which you run it the server cluster.
Note:
This command is only available with Oracle Clusterware.
G.8.50 srvctl modify gns
Modifies the IP address, domain, or other configuration parameters used by the grid
naming service (GNS).
Syntax
Use the srvctl modify gns command with one of the following syntax models:
srvctl modify gns -loglevel log_level
or
srvctl modify gns [-resolve name] [-verify name]
[-parameter name:value[,name:value...]]
[-vip {vip_name | ip} [-skip]] [-clientdata file_name]
[-role {PRIMARY} [-force]] [-verbose]
Parameters
Table G-28 srvctl modify gns Command Parameters
Parameter Description
-loglevel log_level Specify the GNS diagnostic logging level (acceptable values are
1-6).
-resolve name Resolve the name you specify through GNS.
-verify name Check to see if the specified name is advertised through GNS.
-parameter
name:value[,name:value
...]
Set the value of one or more configuration parameters.
Appendix G
SRVCTL Command Reference
G-46
Table G-28 (Cont.) srvctl modify gns Command Parameters
Parameter Description
-vip {vip_name | ip}
[-skip]
Specify a VIP name or IP address on which GNS is to listen.
Note: You can modify this attribute using Online Resource Attribute
Modification.
Optionally, you can use the -skip parameter to skip the
reachability check of the VIP address.
-clientdata file_name Modifies the GNS client data with client data contained in the
specified file.
-role {PRIMARY} [-
force]
Convert a secondary GNS instance to primary.
Use the -force parameter to forcibly convert the secondary GNS
instance to primary.
Examples
An example of this command is:
$ srvctl modify gns -vip 192.0.2.15
G.8.51 srvctl relocate gns
Relocates GNS from its current hosting node to another node within the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl relocate gns [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify the name of a node to which you want to move GNS.
• Optionally, you can use the -verbose parameter to display verbose output.
• On Linux and UNIX systems, you must be logged in as root and on Windows, you
must be logged in as a user with Administrator privileges to run this command.
Example
An example of this command is:
# srvctl relocate gns -node node1
Appendix G
SRVCTL Command Reference
G-47
G.8.52 srvctl remove gns
Removes GNS from the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove gns [-force] [-verbose]
Usage Notes
• Optionally, you can use the -force parameter to forcibly remove GNS from the
cluster, regardless of any errors that might occur.
• Optionally, you can use the -verbose parameter to display verbose output.
Example
An example of this command is:
$ srvctl remove gns
G.8.53 srvctl start gns
Starts GNS on a specific node.
Syntax
srvctl start gns [-loglevel log_level] [-node node_name] [-verbose]
Parameters
Table G-29 srvctl start gns Command Parameters
Parameter Description
-loglevel log_level Optionally, you can specify the level of logging with which GNS
should run. Log levels vary between 1 (minimal tracing) and 6
(traces everything and is time consuming).
-node node_name Optionally, you can specify the name of a node in the cluster where
you want to start GNS.
-verbose Optionally, you can use this parameter to display verbose output.
Usage Notes
You can only run this command in the server cluster. If you attempt to run this
command in a client cluster, then an error occurs.
Appendix G
SRVCTL Command Reference
G-48
Example
An example of this command to start the GNS on the cluster node named crmnode1 is:
$ srvctl start gns -node crmnode1
G.8.54 srvctl status gns
Displays the current state of GNS.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status gns [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify a node on which GNS is running for which you want to
display the state.
• Optionally, you can use the -verbose parameter to display detailed output.
G.8.55 srvctl stop gns
Stops GNS in the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop gns [-node node_name] [-force] [-verbose]
Usage Notes
• Optionally, you can specify the name of a node on which GNS is running that you
want to stop.
• Optionally, you can use -force and -verbose to forcibly stop GNS and print detailed
output, respectively.
Example
An example of this command to stop GNS on the local node is:
$ srvctl stop gns
Appendix G
SRVCTL Command Reference
G-49
G.8.56 srvctl update gns
Modifies a Grid Naming Service (GNS) instance.
Note:
This command is only available with Oracle Clusterware.
Syntax
Use the srvctl update gns command with one of these syntax models:
srvctl update gns -advertise name -address ip_address [-timetolive time_to_live
]
[-verbose]
srvctl update gns -delete name [-address address] [-verbose]
srvctl update gns -alias alias -name name [-timetolive time_to_live] [-verbose]
srvctl update gns -deletealias alias [-verbose]
srvctl update gns -createsrv service -target target -protocol protocol
[-weight weight] [-priority priority] [-port port_number]
[-timetolive time_to_live] [-instance instance_name] [-verbose]
srvctl update gns -deletesrv service_name -target target -protocol protocol
[-verbose]
srvctl update gns -createtxt name -target target [-timetolive time_to_live]
[-namettl name_ttl] [-verbose]
srvctl update gns -deletetxt name -target target [-verbose]
srvctl update gns -createptr name -target target [-timetolive time_to_live]
[-namettl name_ttl] [-verbose]
srvctl update gns -deleteptr name -target target [-verbose]
Parameters
Table G-30 srvctl update gns Command Parameters
Parameter Description
-advertise name Use this parameter to advertise a name through GNS.
-address ip_address Specify the IP address for an advertised name.
-timetolive
time_to_live
Optionally, you can specify, in seconds, an amount of time for the
record to live.
-delete name Use this parameter to remove the advertisement of a name from
GNS.
-alias alias Use this parameter to create an alias for an advertised name.
Appendix G
SRVCTL Command Reference
G-50
Table G-30 (Cont.) srvctl update gns Command Parameters
Parameter Description
-name name You must specify a name to associate with the alias.
-deletealias alias Use this parameter to delete an alias.
-createsrv service Use this parameter to create a service that is described by the
record.
-target target Use this parameter to associate a name with the service.
-protocol protocol Use this parameter to specify which protocol is used to connect to
the service.
-weight weight Optionally, you can specify the weight of the record.
-priority priority Optionally, you can specify a priority of the record, with a value
ranging from 0 to 65535.
-port port_number Optionally, you can specify a port number used to connect to the
service, with a value ranging from 0 to 65535.
-instance
instance_name
Optionally, you can specify an instance name for the service.
-deletesrv
service_name
Use this parameter to specify the name of the service record you
want to delete.
-createtxt name Use this parameter to add a text (TXT) record using the specified
name.
-namettl name_ttl Optionally, you can specify the time, in seconds, to live for the
name.
-deletetxt name Use this parameter to delete a text (TXT) record for a specific
name.
-createptr name Use this parameter to add a pointer (PTR) record for a specific
name.
-deleteptr name Use this parameter to delete a pointer (PTR) record for a specific
name.
Usage Notes
You must be logged in as the root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms, to run this command.
Example
The following command advertises a name with GNS:
# srvctl update gns -advertise myname -address 192.168.1.45
G.8.57 srvctl add havip
Adds highly available VIPs (HAVIPs) (used for highly available NFS and SMB exports)
to a cluster.
Syntax
srvctl add havip -id havip_name -address {host_name | ip_address}
[-netnum network_number] [-description text] [-skip] [-homenode node_name]
Appendix G
SRVCTL Command Reference
G-51
Parameters
Table G-31 srvctl add havip Command Parameters
Parameter Description
-id havip_name Specify a unique ID for the HAVIP resource.
-address {host_name |
ip_address}
Specify either a host name or an IPv4 IP address for the HAVIP
you are going to create.
Note: You must configure the IPv4 IP address with a non-DHCP,
non-round robin DNS address.
-netnum network_number Optionally, you can specify a network resource upon which the
HAVIP depends. The default value for this parameter is 1.
-description text Optionally, you can specify a text description of the HAVIP.
-skip Optionally, you can specify this parameter to skip the reachability
check for the IP address.
-homenode node_name Optionally, you can specify a preferred node or an empty string to
clear the home node.
Example
An example of this command is:
# srvctl add havip -id myhavip -address 192.0.2.1 -netnum 2 -description
"My HA VIP" -skip -homenode myNode2
G.8.58 srvctl config havip
Displays configuration information for a specific highly available VIP (HAVIP) (used for
highly available NFS and SMB exports) or all HAVIP resources in a cluster.
Syntax
Use the srvctl config havip command with the following syntax:
srvctl config havip [-id havip_name]
Parameters
Table G-32 srvctl config havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to display. If you do not
specify this parameter, then SRVCTL displays the configuration information for all
HAVIPs known to Oracle Clusterware.
Example
This command returns output similar to the following:
$ srvctl config havip -id hrexports
VIP: /mjk-vm3-vip/10.149.237.196/10.149.236.0/255.255.252.0/eth0
Description: HR Exports
Appendix G
SRVCTL Command Reference
G-52
G.8.59 srvctl disable havip
Prevents a specific highly-available VIP (HAVIP) (used for highly-available NFS and
SMB exports) resource from running on a number of specified nodes.
Syntax
srvctl disable havip -id havip_name [-node node1,node2,...,noden]
Parameters
Table G-33 srvctl disable havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
disable.
-node
node1,node2,...,noden
Specify the name of a node or a comma-delimited list of node
names on which you do not want the HAVIP resource to run.
If you specify all but one node in the cluster, then the HAVIP will
not fail over.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl disable havip -id myhavip -node myNode1,myNode3
G.8.60 srvctl enable havip
Enables a specific highly-available VIP (HAVIP) (used for highly-available NFS and
SMB exports) to run on a number of specified nodes.
Syntax
srvctl enable havip -id havip_name [-node node_name]
Parameters
Table G-34 srvctl enable havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
enable.
-node node_name Specify the name of a node on which you want the HAVIP resource
to be able to run.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Appendix G
SRVCTL Command Reference
G-53
Examples
An example of this command is:
# srvctl enable havip -id myhavip -node myNode1
G.8.61 srvctl modify havip
Modifies a highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports).
Syntax
srvctl modify havip -id havip_name [-address {host_name | ip_address}
[-netnum network_number] [-skip]] [-description text] [-homenode node_name]
Parameters
Table G-35 srvctl modify havip Command Parameters
Parameter Description
-id havip_name Specify the unique name for the HAVIP resource you want to
modify.
-address {host_name |
ip_address
Specify either a host name or an IPv4 IP or IPv6 address for the
HAVIP you want to modify.
Note: You must configure the IPv4 IP address with a non-DHCP,
non-round robin DNS address.
-netnum network_number Optionally, you can change the network resource upon which the
HAVIP depends. The default value for this optional parameter is 1.
-skip Specify this parameter to skip checking the reachability of the IP
address.
-description text Specify a text description for the HAVIP.
-homenode node_name Optionally, you can specify a preferred node or an empty string to
clear the home node.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl modify havip -id myhavip -address 192.168.16.17 -netnum 2
G.8.62 srvctl relocate havip
Relocates a highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports) to another node in a cluster.
Syntax
srvctl relocate havip -id havip_name [-node node_name] [-force]
Appendix G
SRVCTL Command Reference
G-54
Parameters
Table G-36 srvctl relocate havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
relocate.
-node node_name Specify the name of the node to which you want to relocate the
HAVIP resource.
-force Optionally, you can force the relocation of the HAVIP resource.
Example
An example of this command is:
$ srvctl relocate havip -id myhavip -node node3
G.8.63 srvctl remove havip
Removes a highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports).
Syntax
srvctl remove havip -id havip_name [-force]
Parameters
Table G-37 srvctl remove havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
remove.
–force Use this parameter to forcibly remove the resource from the cluster
and ignore any dependencies.
Usage Notes
• You must first stop the HAVIP resource before you attempt to remove it.
• You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl remove havip -id myhavip -force
G.8.64 srvctl start havip
Starts a specific highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports) on a specific node.
Appendix G
SRVCTL Command Reference
G-55
Syntax
srvctl start havip -id havip_name [-node node_name]
Parameters
Table G-38 srvctl start havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to start.
-node node_name Optionally, you can use the -node parameter to specify the name of
the node on which the HAVIP resource starts.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl start havip -id myhavip -node myNode1
G.8.65 srvctl status havip
Displays the status of all highly-available VIPs (HAVIPs) (used for highly-available
NFS and SMB exports) in a cluster or one particular HAVIP.
Syntax
srvctl status havip [-id havip_name]
Usage Notes
Specify the unique name of the HAVIP resource you want to display. If you do not
specify this parameter, then SRVCTL displays the status of all HAVIPs known to
Oracle Clusterware.
Example
This command returns output similar to the following:
$ srvctl status havip
HAVIP ora.ha1.havip is enabled
HAVIP ora.ha1.havip is not running
G.8.66 srvctl stop havip
Stops the highly-available VIPs (HAVIPs) (used for highly-available NFS and SMB
exports) on a specific node.
Syntax
srvctl stop havip -id havip_name [-node node_name] [-force]
Appendix G
SRVCTL Command Reference
G-56
Parameters
Table G-39 srvctl stop havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource to stop.
-node node_name Optionally, you can specify the name of the node on which the
HAVIP resource to stop resides.
–force Use this parameter to forcibly stop the HAVIP.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Examples
An example of this command is:
# srvctl stop havip -id myhavip -node myNode1 -force
G.8.67 srvctl add ioserver
Adds an Oracle ASM IOServer configuration to the cluster.
When you configure, upgrade, or convert from a standard cluster to an Oracle Flex
Cluster you can create Oracle ASM IOServers on the Hub nodes in the cluster.
Syntax
srvctl add ioserver [-spfile spfile] [-count number_of_ioserver_instances| ALL] [-
listener listener_name]
Parameters
Table G-40 srvctl add ioserver Command Parameters
Parameter Description
-spfile spfile Specify the path to the server parameter file.
-count number_of_ioserver_instances| ALL Specify the number of Oracle ASM IOServer
instances you want to add or ALL to add
instances to all nodes.
-listener listener_name Specify the name of the listener.
Example
An example of this command is:
# srvctl add ioserver -count 2
Appendix G
SRVCTL Command Reference
G-57
G.8.68 srvctl config ioserver
Displays the configuration details of Oracle ASM IOServers.
Syntax
srvctl config ioserver
Usage Notes
This command has no parameters.
Example
This command displays output similar to the following:
$ srvctl config ioserver
ASM I/O Server instance count: 3
ASM I/O Server is enabled.
ASM I/O server is enabled on nodes:
ASM I/O server is disabled on nodes:
G.8.69 srvctl disable ioserver
Disables an Oracle ASM IOServer.
Syntax
srvctl disable ioserver -node node_name
Usage Notes
Use the -node parameter to specify the name of a Hub node on which you want to
disable an Oracle ASM IOServer.
G.8.70 srvctl enable ioserver
Enable an Oracle ASM IOServer on a specific node.
Syntax
srvctl enable ioserver [-node node_name]
Usage Notes
Use the -node parameter to specify the name of a Hub node on which you want to
enable an Oracle ASM IOServer.
G.8.71 srvctl getenv ioserver
Displays the values for environment variables associated with an Oracle ASM
IOServer.
Syntax
srvctl getenv ioserver [-envs "name_list"]
Appendix G
SRVCTL Command Reference
G-58
Usage Notes
Specify a comma-delimited list of the names of environment variables. If you do not
specify this parameter, then SRVCTL displays the values of all environment variables
associated with the database.
G.8.72 srvctl modify ioserver
Modifies an Oracle ASM IOServer configuration on a cluster.
Syntax
srvctl modify ioserver [-spfile spfile] [-count number_of_ioserver_instances | ALL]
[-listener listener_name] [-force]
Parameters
Table G-41 srvctl modify ioserver Command Parameters
Parameter Description
-spfile spfile Optionally, specify the path to the server parameter file path.
-count
number_of_ioserver_ins
tances | ALL
Optionally, specify a number of instances or ALL (to modify
instances on all nodes) that you want to modify. If you modify the
count, then, because this results in a change in cardinality of the
cluster resource, the changes take effect immediately.
-listener
listener_name
Optionally, specify the name of the listener.
-force Optionally, you can ignore any dependencies and force the
modification of the Oracle ASM IOServer.
G.8.73 srvctl relocate ioserver
Relocates an Oracle ASM IOServer instance from its current hosting node to another
node within the cluster.
Syntax
srvctl relocate ioserver -currentnode node_name [-targetnode node_name] [-force]
Parameters
Table G-42 srvctl relocate ioserver Command Parameters
Parameter Description
-currentnode node_name The name of the node on which the Oracle ASM IOServer instance
currently resides
-targetnode node_name The name of the node to which to relocate the IOServer instance
-force Optionally, you can force the relocation of the Oracle ASM
IOServer instance
Appendix G
SRVCTL Command Reference
G-59
Example
The following command relocates the Oracle ASM IOServer from a node called
crsNode2 to a node called crsNode5:
$ srvctl relocate ioserver -currentnode crsNode2 -targetnode crsNode5
G.8.74 srvctl remove ioserver
Use this command to remove an Oracle ASM IOServer instance from the cluster.
Syntax
srvctl remove ioserver [-force]
Usage Notes
Use the -force parameter to forcibly remove the Oracle ASM IOServer instance,
ignoring any dependencies.
G.8.75 srvctl setenv ioserver
Administers the environment configuration for an Oracle ASM IOServer.
Syntax
srvctl setenv ioserver {-envs "name=val[,name=val][...]" | -env "name=val"}
Parameters
Table G-43 srvctl setenv ioserver Command Parameters
Parameter Description
-envs "name=val,..." Comma-delimited list of name-value pairs of environment
variables enclosed in double quotation marks ("").
-env "name=val" Alternatively, use this parameter to set a single
environment variable to a value that contains commas or
other special characters, enclosed in double quotation
marks ("").
G.8.76 srvctl start ioserver
Starts Oracle ASM IOServers in the cluster.
You can also start an Oracle ASM IOServer on a particular Hub Node by specifying
the node name.
Syntax
srvctl start ioserver [-node node_name]
Appendix G
SRVCTL Command Reference
G-60
Usage Notes
If you choose to start an Oracle ASM IOServer on a particular Hub Node, then use the
-node parameter and specify the name of the node. If you do not specify a particular
Hub Node, then SRVCTL starts all Oracle ASM IOServers in the cluster.
Example
The following command starts an Oracle ASM IOServer on a Hub node named
mjkhub46:
$ srvctl start ioserver -node mjkhub46
G.8.77 srvctl status ioserver
Displays the status of Oracle ASM IOServers running in the cluster.
You can display the status of all Oracle ASM IOServers running a cluster, the status of
an Oracle ASM IOServer running on a particular Hub Node, or the information about
clients from a specific database.
Syntax
srvctl status ioserver [-node node_name] [-detail]
Parameters
Table G-44 srvctl status ioserver Parameters
Parameter Description
—node node_name Specify a particular Hub node to display the status of the Oracle
ASM IOServer resource instance running there. If you do not
specify a Hub node, then SRVCTL returns the status of all Oracle
ASM IOServer resource instances running in the cluster.
-detail Use this parameter to display more detailed information about the
status of the Oracle ASM IOServer.
Example
If you run the command with the -detail parameter, then SRVCTL displays output
similar to the following:
$ srvctl status ioserver -detail
ASM I/O Server is enabled
ASM I/O Server is running on nodes: mjk376, mjk377
ASM I/O Server instance +IOS1 running on node mjk376 is connected to ASM instance
+ASM2:
Number of clients connected: 2
Names of clients: later14, alus16, later12, alus9, db0010
ASM I/O Server instance +IOS2 running on node mjk377 is connected to ASM instance
+ASM3:
Number of clients connected: 3
Number of requests completed per sec: 110
Appendix G
SRVCTL Command Reference
G-61
Names of networks: eth1, eth2
Names of clients: later11, later3, later14, later15, later16, alus19, alus17, alus13
G.8.78 srvctl stop ioserver
Stops an Oracle ASM IOServer in the cluster.
Syntax
srvctl stop ioserver [-node node_name] [-force]
Usage Notes
• Use the -node parameter to stop an Oracle ASM IOServer on a particular Hub
Node. If you do not specify a particular Hub Node, then SRVCTL stops all of the
Oracle ASM IOServers in the cluster.
• Use the -force parameter to stop an Oracle ASM IOServer, regardless of any
dependencies.
G.8.79 srvctl unsetenv ioserver
Unsets the Oracle ASM IOServer environment configurations.
Syntax
srvctl unsetenv ioserver -envs "name_list"
Usage Notes
Use the -envs parameter to specify a comma-delimited list of the names of
environment variables enclosed in double quotation marks ("").
G.8.80 srvctl add mgmtdb
Adds a management database (CHM repository) resource to the cluster.
Syntax
srvctl add mgmtdb [-domain domain]
Usage Notes
Optionally, you can specify the domain for the database. If you have the DB_DOMAIN
database initialization parameter set, then you must provide a value for this parameter.
Example
To add a management database to the cluster:
$ srvctl add mgmtdb -domain example.com
Appendix G
SRVCTL Command Reference
G-62
G.8.81 srvctl config mgmtdb
Displays configuration information for the management database (CHM repository)
resource.
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config mgmtdb [-verbose] [-all]
Usage Notes
• Optionally, use the -verbose parameter to print detailed output.
• Optionally, use the -all parameter to print detailed configuration information.
G.8.82 srvctl disable mgmtdb
Disables the management database (CHM repository) resource on the specified node.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable mgmtdb [-node node_name]
Usage Notes
Optionally, you can specify the name of a cluster node on which the managementUse the Server Control (SRVCTL) utility to manage various components and
applications in your cluster.
This appendix contains reference information for Server Control commands, including
utility usage information and a comprehensive listing of the SRVCTL commands.
G.1 SRVCTL Usage Information
SRVCTL is installed on each node in a cluster by default. To use SRVCTL, log in to
the operating system of a node and enter the SRVCTL command and its parameters
in case-sensitive syntax.
• Only use the version of SRVCTL that is provided with Oracle Database 12c on
Oracle RAC databases that are created for or upgraded to Oracle Database 12c.
The version of SRVCTL must be the same as the version of the object (listeners,
Oracle ASM instances, Oracle RAC databases and their instances, and services)
being managed. To ensure the versions are the same release, run SRVCTL
commands from the Oracle home of the database or object you are managing.
• SRVCTL does not support concurrent executions of commands on the same
object. Therefore, run only one SRVCTL command at a time for each database,
service, or other object.
• When specifying a comma-delimited list as part of a SRVCTL command, there
should not be any spaces between the items in the list. For example:
srvctl add database -serverpool "serverpool1,serverpool3"
When you specify a comma-delimited list in a Windows environment, you must
enclose the list in double quotation marks (""). You can enclose a commadelimited
list in double quotation marks in a Linux or UNIX environment but they
will be ignored.
• If you are entering a SRVCTL command, and you want to continue the input on a
new line, then you can use the operating system continuation character. In Linux,
this is the backslash (\) symbol.
• A SRVCTL command that produces no output is a successful command. Not all
SRVCTL commands return a message when it completes, successfully. However,
if a SRVCTL command fails, then it always returns an error message.
• You can use the -eval parameter with several SRVCTL commands. This
parameter, when you use it, enables you to simulate running a command without
making any changes to the system. SRVCTL returns output that informs you what
will happen if you run a particular command. For example, to know what might
happen if you relocate a server:
$ srvctl relocate server –servers "rac1" –eval –serverpool pool2
G-1
Database db1
will stop on node rac1
will start on node rac7
Service mySrv1
will stop on node rac1, it will not run on any node
Service myServ2
will stop on node rac1
will start on node rac6
Server rac1
will be moved from pool myPoolX to pool pool2
The -eval parameter is available with the following commands:
– srvctl add database
– srvctl add service
– srvctl add srvpool
– srvctl modify database
– srvctl modify service
– srvctl modify srvpool
– srvctl relocate server
– srvctl relocate service
– srvctl remove srvpool
– srvctl start database
– srvctl start service
– srvctl stop database
– srvctl stop service
G.2 Specifying Command Parameters as Keywords Instead
of Single Letters
Before Oracle Database 12c, the SRVCTL command-line interface used single letter
parameters. However, this imposes a limit on the number of unique parameters
available for use with SRVCTL commands. SRVCTL command parameters introduced
in Oracle Database 12c are full words instead of single letters, such as -multicastport
and -subdomain.
To support backward compatibility, you can use a mix of single-letter parameters and
new keyword parameters. New parameters introduced with keywords can be used with
single letter parameters.
Appendix G
Specifying Command Parameters as Keywords Instead of Single Letters
G-2
Note:
Starting with Oracle Database 12c, the single letter parameters are
deprecated in favor of the keyword parameters to avoid using the same letter
to implement different functionality depending on the command.
You can obtain the single-letter equivalents, where applicable, by adding the -
compatible parameter after the -help parameter.
G.3 Character Set and Case Sensitivity of SRVCTL Object
Values
SRVCTL interacts with many different types of objects. The character set and name
length limitations, and whether the object name is case sensitive, can vary between
object types.
Table G-1 String Restrictions for SRVCTL Object Names
Object Type Character Set Limitations Case
Sensitive?
Maximum Length
db_domain Alpha-numeric characters,
underscore (_), and number sign
(#)
128 characters
db_unique_name Alpha-numeric characters,
underscore (_), number sign (#),
and dollar sign ($); the first 8
characters must be unique
because those characters are
used to form instance names for
policy-managed databases
No 30 characters but the
first 8 characters must
be unique relative to any
other database in the
same cluster
diskgroup_name Naming disk groups have the
same limitations as naming other
database objects.
See Also: Oracle Database SQL
Language Reference for more
information about database
object naming rules
No (all names
are converted
to uppercase)
instance_name Alpha-numeric characters Depends on the
platform
15 characters
listener_name
node_name No
scan_name The first character must be an
alphabetic character
No
Appendix G
Character Set and Case Sensitivity of SRVCTL Object Values
G-3
Table G-1 (Cont.) String Restrictions for SRVCTL Object Names
Object Type Character Set Limitations Case
Sensitive?
Maximum Length
server_pool Alpha-numeric characters,
underscore (_), number sign (#),
period (.), and dollar sign ($); the
name cannot begin with a period,
contain single quotation marks
(''), nor can the name be
"Generic" or "Free" because
those two names are reserved for
the built-in server pools
250 characters
service_name 250 characters
volume_name Alphanumeric characters; dashes
(-) are not allowed and the first
character must be an alphabetic
character.
No 11 characters
G.4 Using SRVCTL Help
This section includes information about using context sensitive help with SRVCTL.
To see help for all SRVCTL commands, from the command line enter:
srvctl -help
To see the command syntax and a list of parameters for each SRVCTL command,
from the command line enter:
srvctl command (or verb) object (or noun) -help
When you request online help for a command using -help, SRVCTL prints the full
words for each parameter. You can obtain the single-letter equivalents, where
applicable, by adding the -compatible parameter after the -help parameter. For
example:
$ srvctl config database -help -compatible
The preceding command prints usage information for the srvctl config database
command, listing all parameters as full words followed by their single-letter equivalents
in parentheses, where applicable.
To see the SRVCTL version number enter:
$ srvctl -version
G.5 SRVCTL Privileges and Security
To use SRVCTL to change your Oracle RAC database configuration, log in to the
operating system as the software owner of the home that you want to manage.
For example, if different users installed Oracle Database and the Oracle Grid
Infrastructure, then log in as the database software owner (for example, ora_db) to
Appendix G
Using SRVCTL Help
G-4
manage databases and log in as the Oracle Grid Infrastructure software owner (for
example, ora_asm) to manage the Oracle ASM instances.
Users who are members of the OSDBA operating system group can start and stop the
database. To stop and start an Oracle ASM instance, you must be a member of the
OSASM operating system group.
To create or register objects such as listeners, Oracle Notification Services, and
services, you must be logged in to the operating system as the software owner of the
Oracle home. The objects you create or register for that Oracle home will run under
the user account of the owner of the Oracle home. Databases run as the database
installation owner of the home from which they run.
To perform srvctl add operations on any object, you must be logged in as the Oracle
account owner of the home on which the object runs.
For some SRVCTL commands, on Linux and UNIX systems, you must be logged in as
root, and on Windows systems, you must be logged in as a user with Administrator
privileges to run them. In this appendix, those commands are preceded by the root
prompt (#) in the command examples.
G.6 Additional SRVCTL Topics
• Use SRVCTL to manage Oracle-supplied resources such as listener, instances,
disk groups, and networks, and CRSCTL for managing Oracle Clusterware and its
resources.
Note:
Oracle strongly discourages directly manipulating Oracle-supplied resources
(resources whose names begin with ora) using CRSCTL. This could adversely
impact the cluster configuration.
• Although you may be able to cancel running SRVCTL commands by pressing the
Control-C keys, you may corrupt your configuration data by doing this.
You are strongly advised not to attempt to terminate SRVCTL in this manner.
G.7 Deprecated SRVCTL Subprograms or Commands
A number of SRVCTL commands and parameters have been deprecated in this
release.
G.7.1 Single Character Parameters for all SRVCTL Commands
Single-character parameters have been deprecated in Oracle Database 12c.
Use the full keyword for each parameter instead. To support older tools and scripts
that still use single-character parameters, the current version of SRVCTL supports
both single-character parameters and full keyword parameters.
The command reference in this appendix shows the keywords for each SRVCTL
command. Table G-2 lists the deprecated single-character parameters.
Appendix G
Additional SRVCTL Topics
G-5
Table G-2 Deprecated Single-Character Parameters for SRVCTL Commands
Single
Letter
Long Form Values Description Related Commands
A address {VIP_name | IP}/
netmask/ [if1[|
if2...]]
VIP address
specification for node
applications
Node applications, VIP,
network, Listener,
SCAN VIP, and SCAN
listener commands
a all All resources of that
kind
srvctl config
database
Common
a diskgroup diskgroup_list Comma-delimited list
of Oracle ASM disk
groups
Database, instance,
Oracle ASM, disk
group, and file system
commands
a detail Print detailed
configuration
information
Common
a available available_list A comma-delimited list
of available instances
Service and server pool
commands
a abort Abort failed online
relocation
Relocate database
a viponly Display VIP
configuration
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
B rlbgoal {NONE|
SERVICE_TIME|
THROUGHPUT}
The runtime load
balancing goal of a
service
Service and server pool
commands
c currentnode current_node Node name from
which to relocate the
service
Service and server pool
commands
c cardinality {UNIFORM|
SINGLETON}
Whether the service
should run on every
active server in the
server pool
(UNIFORM) or just
one server
(SINGLETON)
Service and server pool
commands
c dbtype type Type of database:
Oracle RAC One
Node, Oracle RAC, or
single instance
Database, instance,
Oracle ASM, disk
group, and file system
commands
d db or
database
db_unique_name Database unique
name
Common
d device volume_device Volume device path Database, instance,
Oracle ASM, disk
group, and file system
commands
d domain Display subdomain
served by GNS
OC4J, home, CVU, and
GNS commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-6
Table G-2 (Cont.) Deprecated Single-Character Parameters for SRVCTL
Commands
Single
Letter
Long Form Values Description Related Commands
e emport em_port_number Local listen port for
Oracle Enterprise
Manager
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
e failovertyp
e
{NONE|SESSION
BASIC|
TRANSACTION}
The failover type for a
service
Service and server pool
commands
e server server_list Candidate server list
for Oracle RAC One
Node database
Database, instance,
Oracle ASM, disk
group, and file system
commands
f force Force remove Common
g diskgroup diskgroup_name Disk group name File system, Diskgroup
commands
g gsdonly Display GSD
configuration
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
g serverpool server_pool_name
server_pool_list
A server pool name
Comma-delimited list
of database server
pool names
Service and server pool
commands
Database, instance,
Oracle ASM, disk
group, and file system
commands
h help Common
i importance number A number that
represents the
importance of the
server pool
Service and server pool
commands
i instance instance_name
instance_list
Instance name prefix
for administratormanaged
Oracle RAC
One Node database
A comma-delimited list
of instance names
Database, instance,
Oracle ASM, disk
group, and file system
commands
I ip ip_address VIP address on which
GNS is to listen
OC4J, home, CVU, and
GNS commands
i oldinst instance_name The old instance
name
Service and server pool
commands
i scannumber scan_ordinal
_number
Ordinal number of the
IP address for the
SCAN
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-7
Table G-2 (Cont.) Deprecated Single-Character Parameters for SRVCTL
Commands
Single
Letter
Long Form Values Description Related Commands
i vip vip_name or
"vip_name_list"
VIP names Node applications,
GNS, VIP, network,
listener, SCAN VIP, and
SCAN listener
commands
j acfspath acfs_path_list Comma-delimited list
of Oracle ACFS paths
where the
dependency on the
database will be set
Database, instance,
Oracle ASM, disk
group, and file system
commands
j clbgoal {SHORT|LONG} The connection load
balancing goal for a
service
Service and server pool
commands
k netnum network_number The network number Service and server pool
commands
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
OC4J, home, CVU, and
GNS commands
l list List all records in GNS OC4J, home, CVU, and
GNS commands
l listener listener_name The name of a listener ASM commands
l loglevel log_level Specify the level (0-6)
of logging that GNS
should run with
OC4J, home, CVU, and
GNS commands
l min number The minimum size of
the server pool
Service and server pool
commands
l onslocalpor
t
port_number Oracle Notification
Service listening port
for local client
connections
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
l role service_role Comma-delimited list
of server roles within
double quotation
marks (""), where
each role is one of
PRIMARY,
PHYSICAL_STANDBY,
LOGICAL_STANDBY, or
SNAPSHOT_STANDBY
Service and server pool
commands
m domain domain_name The domain for the
database
Database, instance,
Oracle ASM, disk
group, and file system
commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-8
Table G-2 (Cont.) Deprecated Single-Character Parameters for SRVCTL
Commands
Single
Letter
Long Form Values Description Related Commands
m failovermet
hod
{NONE|BASIC} The failover method of
a service
Service and server pool
commands
m multicastpo
st
The port on which the
GNS daemon is
listening for multicast
requests
OC4J, home, CVU, and
GNS commands
m path mountpoint_path Mountpoint path Database, instance,
Oracle ASM, disk
group, and file system
commands
n name Advertise a name
through GNS using
the given address
OC4J, home, CVU, and
GNS commands
n node node_name The name of a specific
node
Common
n nodes node_list A comma-delimited list
of node names
File system commands
n dbname database_name The database name
(DB_NAME), if
different from the
unique name specified
by the -db parameter
Database, instance,
Oracle ASM, disk
group, and file system
commands
n scanname scan_name Fully-qualified SCAN
name (includes the
domain)
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
n servers server_list A comma-delimited list
of candidate server
names
Service and server pool
commands
n targetnode node_name Node name to which
to relocate the service
Service and server pool
commands
o oraclehome oracle_home $ORACLE_HOME path Database commands
p endpoints [TCP:]port
_number[/IPC:
key][/NMP:pipe
_name][/TCPS:
s_port][/SDP:
port]
SCAN listener
endpoints
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
p port The port which the
GNS daemon uses to
communicate with the
DNS server
OC4J, home, CVU, and
GNS commands
p rmiport port_number OC4J RMI port
number
OC4J, home, CVU, and
GNS commands
P tafpolicy {NONE|BASIC} TAF policy
specification
Service and server pool
commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-9
Table G-2 (Cont.) Deprecated Single-Character Parameters for SRVCTL
Commands
Single
Letter
Long Form Values Description Related Commands
p spfile spfile_location Server parameter file
path
Database, instance,
Oracle ASM, disk
group, and file system
commands
q notificatio
n
{TRUE|FALSE} Whether FAN is
enabled for OCI
connections
Service commands
q query Query GNS for the
records belonging to a
name
OC4J, home, CVU, and
GNS commands
r preferred preferred_list A comma-delimited list
of preferred instances
Service and server pool
commands
r onsremotepo
rt
port_number Oracle Notification
Service listening port
for connections from
remote hosts
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
r relocate Relocate the VIP Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
r revert Remove target node
of failed online
relocation request
from the candidate
server list of
administratormanaged
Oracle RAC
One Node database
Relocate database
r role role_type Role of the standby
database: PRIMARY,
PHYSICAL_STANDBY,
LOGICAL_STANDBY, or
SNAPSHOT_STANDBY
Database, instance,
Oracle ASM, disk
group, and file system
commands
s onsonly Display Oracle
Notification Service
daemon configuration
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
s skip Skip checking the
ports
Listener, SCAN, and
SCAN listener.
s statfile file_name The file path of the
state_file created
by a previously
executed srvctl stop
home command
OC4J, home, CVU, and
GNS commands
s status Display the status of
GNS
OC4J, home, CVU, and
GNS commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-10
Table G-2 (Cont.) Deprecated Single-Character Parameters for SRVCTL
Commands
Single
Letter
Long Form Values Description Related Commands
S subnet subnet/net
_mask/[if1[|
if2...]]
Network address
specification for a
network
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
s service service_name
service_name_list
The name of a service
A comma-delimited list
of service names
Service and server pool
commands
s startoption start_options Startup options for the
database (mount,
open, read only)
Database, instance,
Oracle ASM, disk
group, and file system
commands
t checkinterv
al
time_interval Interval in minutes
between checks
OC4J, home, CVU, and
GNS commands
t edition edition_name The initial session
edition of a service
Service and server pool
commands
t envs "name_list" A list of environment
variables
Common
t namevals "name= value,..." Names and values of
environment variables
Common
T nameval "name=value" Name and value of a
single environment
variable
Common
t update instance_name The new instance
name
Service and server pool
commands
t remoteserve
rs
host_name[:
port_number]
[,host_name[:
port_number]...]
List of remote host
name and port
number pairs for
Oracle Notification
Service daemons
outside this cluster
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
t stopoption stop_options Stop options for the
database (NORMAL,
TRANSACTIONAL,
IMMEDITATE, or ABORT)
Database, instance,
Oracle ASM, disk
group, and file system
commands
t toversion target_version Version to which you
are downgrading
Database, instance,
Oracle ASM, disk
group, and file system
commands
u max number Maximum size of the
server pool
Service and server pool
commands
u nettype network_type The network server
type, which can be
STATIC, DHCP, or MIXED
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-11
Table G-2 (Cont.) Deprecated Single-Character Parameters for SRVCTL
Commands
Single
Letter
Long Form Values Description Related Commands
u newinst Add a new instance to
the service
configuration
Service commands
u update Update SCAN
listeners to match the
number of SCAN VIPs
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
u user oracle_user Oracle user or other
authorized user to
mount and unmount
file systems
Database, instance,
Oracle ASM, disk
group, and file system
commands
v verbose Verbose output Common
v volume volume_name Name of a volume Database, instance,
Oracle ASM, disk
group, and file system
commands
V versions Common
w failoverdel
ay
number Failover delay Service and server pool
commands
w nettype network_type The network server
type, which can be
STATIC, DHCP, or MIXED
Node applications, VIP,
network, listener, SCAN
VIP, and SCAN listener
commands
w timeout timeout Online relocation
timeout in minutes
Database, instance,
Oracle ASM, disk
group, and file system
commands
x dtp {TRUE | FALSE} Whether to enable
distributed transaction
processing
Service and server pool
commands
x node node_name Node name (use this
parameter only with
noncluster databases)
Common
y noprompt Suppress the
confirmation prompt
Common
y policy {AUTOMATIC |
MANUAL}
Management policy
for the resource
Database, instance,
Oracle ASM, disk
group, file system,
service and server pool
commands
z failoverret
ry
number Number of failover
retries
Service and server pool
commands
z rmdepondisk To remove a
database's
dependency upon disk
groups
Database, instance,
Oracle ASM, disk
group, and file system
commands
Appendix G
Deprecated SRVCTL Subprograms or Commands
G-12
G.7.2 Miscellaneous SRVCTL Commands and Parameters
The following command parameters have been deprecated in this release:
Table G-3 Deprecated Commands and Parameters for SRVCTL
Command Deprecated Parameters
srvctl modify asm -node node_name
srvctl modify instance -z
Instead, use the -node option with the value set to ""
srvctl modify gns [-ip ip_address] [-advertise host_name -address address]
[-delete host_name -address address] [-createalias name -
alias alias] [-deletealias alias]
Use the srvctl update gns command instead.
srvctl * oc4j The oc4j noun has been deprecated and replaced with
qosmserver. SRVCTL still accepts the oc4j noun until it is
desupported.
srvctl add service The PRECONNECToption with the -tafpolicy parameter is
deprecated.
srvctl modify service The -failovermethod {NONE | BASIC} is deprecated.
The PRECONNECToption with the -tafpolicy parameter is
deprecated.
G.8 SRVCTL Command Reference
This section lists and describes all SRVCTL commands that are run from the Oracle
Grid Infrastructure home.
See Also:
Oracle Real Application Clusters Administration and Deployment Guide for
SRVCTL command usage information
G.8.1 srvctl add asm
Adds a record for an Oracle ASM instance to the entire cluster.
This command must be run only one time from the Oracle Grid Infrastructure home.
Syntax
srvctl add asm [-listener listener_name] [-pwfile password_file_path
[-flex [-count {number_of_instances | ALL}] | -proxy [-spfile
server_parameter_file_path]]
Appendix G
SRVCTL Command Reference
G-13
Parameters
Table G-4 srvctl add asm Command Parameters
Parameter Description
-listener listener_name Enter the name of a listener. If you do not
specify this parameter, then the listener name
defaults to LISTENER.
-pwfile password_file_path Enter the full path to the location of the
password file on Oracle ASM.
-flex [-count {number_of_instances |
ALL}] |
-proxy [-spfile
server_parameter_file_path]
Specify that the Oracle ASM instances are
configured as Oracle Flex ASM instances. You
can optionally specify the number of Oracle
ASM instances to create or that an Oracle
ASM instance should be created on all nodes.
Alternatively, you can specify the -proxy
parameter to configure the Oracle ASM
Dynamic Volume Manager proxy instance
resource. Optionally, you can specify the path
to the server parameter file.
Usage Notes
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary
in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle
RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the
database home to manage Oracle ASM.
Example
To add a clusterware resource for Oracle ASM to every node in the cluster, use the
following command:
$ srvctl add asm
G.8.2 srvctl config asm
Displays the configuration for all Oracle ASM instances.
Syntax
srvctl config asm [-proxy] [-detail]
Parameters
Table G-5 srvctl config asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether the
Oracle ASM configuration to display is a proxy instance.
-detail Optionally, you can use this parameter to print detailed
configuration information.
Appendix G
SRVCTL Command Reference
G-14
Usage Notes
• Use this command only with Oracle Clusterware.
• To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL
binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have
Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL
binary in the database home to manage Oracle ASM.
Example
This command returns output similar to the following:
$ srvctl config asm
ASM Home: /u01/app/12.1.0/grid
ASM Listener: LISTENER
ASM instance count: 3
Password file:
G.8.3 srvctl disable asm
Disables the Oracle ASM proxy resource.
Oracle ASM will restart if it contains Oracle Clusterware data or if the node restarts
and it was running before the node failed. The srvctl disable asm command also
prevents the srvctl start asm command from starting Oracle ASM instances.
Disabling the Oracle ASM proxy resource prevents the databases and disk groups
from starting because they depend on the Oracle ASM proxy resource.
Syntax
srvctl disable asm [-proxy] [-node node_name]
Parameters
Table G-6 srvctl disable asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
disabling a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
disable Oracle ASM.
Usage Notes
• To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL
binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have
Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL
binary in the database home to manage Oracle ASM.
• Oracle ASM is part of the Oracle Clusterware stack and when OCR and voting
files are stored on Oracle ASM, then Oracle ASM starts when OHASD starts the
Oracle Clusterware stack. The srvctl disable asm command does not prevent the
Oracle ASM instance managed by OHASD from starting. Oracle ASM, therefore,
starts as needed by the Oracle Clusterware stack.
Appendix G
SRVCTL Command Reference
G-15
The srvctl disable asm command prevents the Oracle ASM Oracle Clusterware
proxy resource, and any resources that depend on it, from starting. So, the
command prevents Oracle Clusterware-managed objects, such as databases, disk
groups, and file systems that depend on Oracle ASM, from starting. For example,
the srvctl start database | diskgroup | filesystem command fails to start any of
those objects on nodes where the Oracle ASM Oracle Clusterware proxy resource
is disabled. The command also prevents the srvctl start asm command from
starting Oracle ASM on remote nodes.
Example
The following example disables Oracle ASM on a node named crmnode1:
$ srvctl disable asm -node crmnode1
G.8.4 srvctl enable asm
Enables an Oracle ASM instance.
Syntax
srvctl enable asm [-proxy] [-node node_name]
Parameters
Table G-7 srvctl enable asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
enabling a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
enable Oracle ASM.
Usage Notes
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary
in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle
RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the
database home to manage Oracle ASM.
Example
An example of this command is:
$ srvctl enable asm -node crmnode1
G.8.5 srvctl getenv asm
Displays the values for environment variables associated with Oracle ASM.
Syntax
srvctl getenv asm [-envs "name_list"]
Appendix G
SRVCTL Command Reference
G-16
Usage Notes
• If you choose not use the -env parameter, then the values of all environment
variables associated with Oracle ASM are displayed.
• You can specify a comma-delimited list of the names of environment variables for
which you want to retrieve the values.
Example
The following example displays the current values for all the environment variables
used by Oracle ASM:
$ srvctl getenv asm
G.8.6 srvctl modify asm
Modifies the listener used by Oracle ASM, the disk group discovery string used by
Oracle ASM, or the SPFILE used by Oracle ASM for a noncluster database or a
cluster database.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl modify asm [-listener listener_name] [-pwfile password_file_path]
[-count {number_of_instances | ALL}] [-diskstring asm_diskstring]
[-spfile spfile_path_name [-proxy] [-force]]
Parameters
Parameter Description
-listener
listener_name
Specify the name of the listener with which Oracle ASM registers.
-pwfile
password_file_path
Specify the full path to the location of the password file for Oracle
ASM.
-count
{number_of_instances |
ALL}
Specify the number of Oracle ASM instances to create, or that an
Oracle ASM instance should be created on all nodes.
-diskstring
asm_diskstring
Specify a new Oracle ASM disk group discovery string.
-spfile
spfile_path_name
Specify the path to the new spfile to be used by Oracle ASM.
-proxy Use this parameter to specify an Oracle ASM proxy instance.
–force Use this parameter to force modification of Oracle ASM.
Appendix G
SRVCTL Command Reference
G-17
Example
An example of this command to modify the configuration of Oracle ASM is:
$ srvctl modify asm -listener lsnr1
G.8.7 srvctl predict asm
Predicts the consequences of Oracle ASM failure.
Syntax
srvctl predict asm [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify a particular node on which you want to predict the
consequences of an Oracle ASM failure.
• You can choose verbose output.
Example
An example of this command to predict the consequences of an Oracle ASM failure on
a particular node:
$ srvctl predict asm -node crmnode2
G.8.8 srvctl relocate asm
Relocates an Oracle Flex ASM instance from one Hub Node of an Oracle Flex Cluster
to another.
Syntax
srvctl relocate asm -currentnode current_node [-targetnode target_node] [-force]
Parameters
Table G-8 srvctl relocate asm Parameters
Parameter Description
-currentnode
current_node
Name of the node on which the Oracle Flex ASM instance currently
resides.
-targetnode
target_node
Name of the node to which you want to relocate the Oracle Flex
ASM instance.
-force Force the relocation of the Oracle Flex ASM instance.
Usage Notes
• You cannot use this command if there is only one Oracle Flex ASM instance
running.
• Because of bootstrap issues between Oracle ASM and Oracle Clusterware, on the
node where Oracle Clusterware uses Oracle ASM run either crsctl stop crs or
Appendix G
SRVCTL Command Reference
G-18
crsctl stop cluster to stop Cluster Ready Services on the node before you
relocate the Oracle ASM instance.
Example
An example of this command to relocate an Oracle Flex ASM instance from the
current node to a node named hubnode2 is:
$ srvctl relocate asm -currentnode hubnode1 -targetnode hubnode2
G.8.9 srvctl remove asm
Removes the Oracle ASM resource from Oracle Clusterware management.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl remove asm [-proxy] [-force]
Parameters
Table G-9 srvctl remove asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
removing a proxy Oracle ASM configuration.
-force Forcefully removes an Oracle ASM resource (ignores any
dependencies).
Example
An example of this command is:
$ srvctl remove asm -force
G.8.10 srvctl setenv asm
Sets Oracle ASM environment configurations.
Syntax
Use this command with one of the following syntaxes:
srvctl setenv asm -envs "name=value,[...]"
srvctl setenv asm -env "name=value"
Appendix G
SRVCTL Command Reference
G-19
Parameters
Table G-10 srvctl setenv asm Command Parameters
Parameter Description
-envs "name=value,
[...]"
Use this parameter to specify either a single name-value pair or a
comma-delimited list of multiple name-value pairs of environment
variables enclosed in double quotation marks ("").
-env "name=value" Use this parameter to enable a single environment variable to be
set to a value that contains commas or other special characters,
enclosed in double quotation marks ("").
Example
The following example sets the language environment configuration for Oracle ASM:
$ srvctl setenv asm -envs "LANG=en"
G.8.11 srvctl start asm
Starts an Oracle ASM instance.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl start asm [-proxy] [-node node_name [-startoption start_options]]
Parameters
Table G-11 srvctl start asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
starting a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
start Oracle ASM.
Note: You can use this parameter only with Oracle Clusterware.
Appendix G
SRVCTL Command Reference
G-20
Table G-11 (Cont.) srvctl start asm Command Parameters
Parameter Description
-startoption
start_options
Optionally, you can specify options to the startup command, such
as OPEN, MOUNT, or NOMOUNT
Note: For multi-word startup options, such as read only and read
write, separate the words with a space and enclose in double
quotation marks (""). For example, "read only".
See Also: SQL*Plus User's Guide and Reference for more
information about startup options
Examples
An example of this command to start an Oracle ASM instance on a single node of a
cluster is:
$ srvctl start asm -node crmnode1
An example to start an Oracle ASM instance on all nodes in the cluster, or for a
noncluster database, is:
$ srvctl start asm
G.8.12 srvctl status asm
Displays the status of an Oracle ASM instance.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the
SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid
home). If you have Oracle RAC or Oracle Database installed, then you cannot
use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl status asm [-proxy] [-node node_name] [-detail] [-verbose]
Parameters
Table G-12 srvctl status asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to display the
status for an Oracle ASM proxy instance.
-node node_name Optionally, you can specify a particular node. If you do
not specify this parameter, then SRVCTL displays the
status of all Oracle ASM instances.
-detail Print detailed status information.
Appendix G
SRVCTL Command Reference
G-21
Table G-12 (Cont.) srvctl status asm Command Parameters
Parameter Description
-verbose Displays verbose output.
Example
This command returns output similar to the following:
$ srvctl status asm -verbose
ASM is enabled
ASM is running on node2, node3, node4
ASM instance +ASM2 is running on node node2
Number of clients connected: 4
Names of clients: db002, db003, +IOS1, clicluster1:later3
ASM instance +ASM3 is running on node node3
Number of clients connected: 2
Names of clients: db001, +IOS2
ASM instance +ASM4 is running on node node4
Number of clients connected: 2
Names of clients: db004, db005
G.8.13 srvctl stop asm
Stops an Oracle ASM instance.
Syntax
srvctl stop asm [-proxy] [-node node_name] [-stopoption stop_options] [-force]
Parameters
Table G-13 srvctl stop asm Command Parameters
Parameter Description
-proxy Optionally, you can use this parameter to specify whether you are
stopping a proxy Oracle ASM configuration.
-node node_name Optionally, you can specify a particular node on which you want to
stop Oracle ASM.
If you do not specify this parameter, then SRVCTL stops the Oracle
ASM instance on every active node in the cluster.
Note: You can use this parameter only with Oracle Clusterware.
-stopoption
stop_options
Optionally, you can specify options to the shutdown command,
such as NORMAL, TRANSACTIONAL, IMMEDIATE, or ABORT.
See Also: SQL*Plus User's Guide and Reference for more
information about shutdown options
-force Optionally, you can use this parameter to stop disk groups, file
systems, and databases that depend on Oracle ASM.
Appendix G
SRVCTL Command Reference
G-22
Usage Notes
• To manage Oracle ASM on Oracle Database 12c installations, use SRVCTL in the
Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC
or Oracle Database installed, then you cannot use SRVCTL in the database home
to manage Oracle ASM.
• You cannot use this command when OCR is stored in Oracle ASM because it will
not stop Oracle ASM. To stop Oracle ASM you must shut down Oracle
Clusterware.
Example
An example of this command is:
$ srvctl stop asm -node crmnode1 -stopoption IMMEDIATE
G.8.14 srvctl unsetenv asm
Unsets the Oracle ASM environment configurations.
Syntax
srvctl unsetenv asm -envs "name_list"
Usage Notes
Use the -envs parameter to specify a comma-delimited list of the names of
environment variables enclosed in double quotation marks ("").
Example
The following example unsets the environment configuration for an Oracle ASM
environment variable:
$ srvctl unsetenv asm -envs "CLASSPATH"
G.8.15 srvctl add cvu
Adds the Cluster Verification Utility (CVU) to an Oracle Clusterware configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax and Parameters
Use the srvctl add cvu command with the following syntax:
srvctl add cvu [-checkinterval time_in_minutes]
Appendix G
SRVCTL Command Reference
G-23
Usage Notes
• Optionally, you can change the interval between checks. By default, CVU runs
once every 6 hours and verifies the health of the cluster. The shortest interval you
can specify for CVU check is 10 minutes.
• Run this command while logged in as the Grid home user.
Example
To add CVU with a check interval of 6 hours, use the following command:
$ srvctl add cvu -checkinterval 360
G.8.16 srvctl config cvu
Displays the time interval, in minutes, between CVU checks.
Syntax and Parameters
Use the srvctl config cvu command with the following syntax:
srvctl config cvu
This command has no parameters.
Example
This command returns output similar to the following:
CVU is configured to run once every 360 minutes
G.8.17 srvctl disable cvu
Disables the Cluster Verification Utility (CVU) for Oracle Clusterware management (if
enabled).
Syntax
srvctl disable cvu [-node node_name]
Parameters
Optionally, you can specify the name of a particular node on which you want to disable
CVU. Otherwise, SRVCTL disables CVU on all nodes.
Example
An example of this command to disable CVU on a node named crmnode1 is:
$ srvctl disable cvu -node crmnode1
G.8.18 srvctl enable cvu
Enables the Cluster Verification Utility (CVU) for Oracle Clusterware management (if
disabled).
Appendix G
SRVCTL Command Reference
G-24
Syntax
srvctl enable cvu [-node node_name]
Parameters
Optionally, you can specify the name of a particular node on which you want to enable
CVU. Otherwise, SRVCTL enables CVU on all nodes.
Example
An example of this command to enable CVU on a node named crmnode1 is:
$ srvctl enable cvu -node crmnode1
G.8.19 srvctl modify cvu
Modifies the check interval for CVU.
Syntax
srvctl modify cvu [-checkinterval time_in_minutes]
Parameters
By default, CVU runs once every 360 minutes (six hours) and verifies the health of
cluster. If you change the interval, then the shortest interval you can specify for CVU
check is 10 minutes.
Example
An example of this command to modify CVU to have a check interval of 4 hours is:
$ srvctl modify cvu -checkinterval 240
G.8.20 srvctl relocate cvu
Temporarily relocates the CVU to another node in a cluster.
Syntax
srvctl relocate cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node to which you want to relocate CVU.
Example
An example of this command to temporarily relocate CVU from the local node to the
cluster node named crmnode2 is:
$ srvctl relocate cvu -node crmnode2
Appendix G
SRVCTL Command Reference
G-25
G.8.21 srvctl remove cvu
Removes CVU from an Oracle Clusterware configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove cvu [-force]
Usage Notes
Use the -force parameter to remove a CVU resource that is running or starting.
G.8.22 srvctl start cvu
Starts the CVU resource on one node in a cluster. If you specify a node name, then
CVU starts on that node.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node to which you want to start CVU.
Otherwise, SRVCTL starts CVU on all nodes.
Example
An example of this command to start CVU on a single node of a cluster is:
$ srvctl start cvu -node crmnode1
Appendix G
SRVCTL Command Reference
G-26
G.8.23 srvctl status cvu
Displays the current state of the CVU resource on one node in a cluster. If you specify
a node name, then the command checks CVU status on that node.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node where the CVU resource is running, if it is
not the local node.
Example
An example of this command to check the status of CVU on the node in the cluster
named crmnode1 is:
$ srvctl status cvu -node crmnode1
G.8.24 srvctl stop cvu
Stops the Cluster Verification Utility (CVU) that is either in the running or starting state.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop cvu [-force]
Usage Notes
Optionally, you can specify the -force parameter to stop CVU if it is a dependant
resource.
Example
An example of this command to stop CVU:
$ srvctl stop cvu
G.8.25 srvctl add exportfs
Creates an export file system configuration in Oracle Clusterware.
Appendix G
SRVCTL Command Reference
G-27
Syntax
srvctl add exportfs -name unique_name -id havip_name -path path_to_export
[-clients export_clients] [-options export_options] [-type NFS | SMB]
Parameters
Table G-14 svrctl add exportfs Command Parameters
Parameter Description
-name unique_name Enter a unique name for the export file system that you are
creating. This parameter is required.
-id havip_name Enter the number or name that identifies an existing HAVIP, that
you specified in the srvctl add havip command. This parameter
is required.
-path path_to_export Enter the path to the Oracle Automatic Storage Management
Cluster File System (Oracle ACFS) that you want to export. This
parameter is required.
-clients
export_clients -
options export_options
Optionally, enter a comma-delimited list of clients to which you
want the file system exported. You can enter net groups and
wildcards. For example:
-clients @netgroup1,
*.us.domain.com,
16.140.0.0, hostname1
Note: You can use the -clients parameter only for Linux systems.
Use the -options parameter for Solaris and AIX systems.
-type NFS | SMB Specify the export type (NFS for a network file system or SMB for
Oracle ACFS server message block). The default is NFS for Linux
and UNIX platforms, and SMB for Windows.
Usage Notes
You must run this command as root on Linux and UNIX platforms.
Example
To export with operating system defaults:
# srvctl add exportfs -name cifsExport -path "/acfs1" -options "browsable = yes,read
only = no,comment = acfs1"
To export read-only to certain clients:
# srvctl add exportfs -name export1 -id havip1 -path /u01/db1 -clients node1 -
options ro
G.8.26 srvctl config exportfs
Displays the configuration information for the export file system in Oracle Clusterware.
Syntax
srvctl config exportfs [-name unique_name | -id havip_name]
Appendix G
SRVCTL Command Reference
G-28
Parameters
Table G-15 srvctl config exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export for which you want to
display the configuration.
-id havip_name Enter the name of a HAVIP to display the configuration of all the
NFS exports attached to the specific HAVIP.
Example
If you specify the -name parameter, then this command returns output similar to the
following, whether you specify -name or -id:
$ srvctl config exportfs -id havip1
export file system kep1 is configured
Exported path: /scratch/ghnew/base/mymount3
Export options:
Export Type:
Exported clients:
export file system kexp2 is configured
Exported path: /scratch/ghnew/base/mymount3
Export options:
Export Type:
Exported clients:
G.8.27 srvctl disable exportfs
Disables an export file system managed by Oracle Clusterware.
Syntax
srvctl disable exportfs -name filesystem_name
Usage Notes
• This command takes only the unique name of the file system you want to disable.
• You must run this command as root user on Linux and UNIX platforms.
Example
The following example disables an export file system called export1:
# srvctl disable exportfs -name export1
G.8.28 srvctl enable exportfs
Enables an export file system configuration in Oracle Clusterware.
Syntax
srvctl enable exportfs -name filesystem_name
Appendix G
SRVCTL Command Reference
G-29
This command takes only the name of the file system you want to enable, which is a
required parameter.
Usage Notes
You must run this command as the root user on Linux and UNIX platforms.
Example
The following command example enables a file system named export1:
# srvctl enable exportfs -name export1
G.8.29 srvctl modify exportfs
Modifies an export file system configuration in Oracle Clusterware.
Syntax
srvctl modify exportfs -name unique_name [-path path_to_export]
[-clients node_list] [-options nfs_options_string]
Parameters
Table G-16 srvctl modify exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export file system to modify.
This parameter is required.
-path path_to_export You can modify the path to the Oracle Automatic Storage
Management Cluster File System (Oracle ACFS) where the export
is located.
-clients node_list You can modify the comma-delimited list of clients (hosts) to where
the file system is exported. You can enter net groups and
wildcards. For example:
-clients @netgroup1,*.us.domain.com,16.140.0.0, hostname1
Note: You can use the -clients parameter only for Linux systems.
Use the -options parameter for Solaris and AIX systems.
-options
nfs_client_string
Use this parameter to modify the export options for the export file
system.
Usage Notes
• You must run this command as root user on Linux and UNIX platforms.
• You must start and stop the NFS export before any changes you make take effect.
Example
The following command example modifies the path of an export file system named
exportfs1:
# srvctl modify exportfs -name exportfs1 -path /mnt/racdb1
Appendix G
SRVCTL Command Reference
G-30
G.8.30 srvctl remove exportfs
Removes the specified export file system configuration.
Syntax
srvctl remove exportfs -name exportfs_name [-force]
Parameters
Table G-17 srvctl remove exportfs Command Parameters
Parameter Description
-name exportfs_name Enter the unique name of the export file system you want to
remove.
-force Use this parameter to ignore any dependencies and forcibly
remove the export file system.
Usage Notes
• You must run this command as root user on Linux and UNIX platforms.
• If you do not use the -force parameter, then you must first stop the export file
system you want to remove before you remove it.
• If you use the -force parameter, then the resulting configuration can cause errors
when attempting to shut down the Oracle Clusterware stack.
Examples
To remove the stopped export file system named export1:
# srvctl remove exportfs -name export1
To remove a running export file system, leaving it exported:
# srvctl remove exportfs -name export1 -force
G.8.31 srvctl start exportfs
Starts an export file system configuration in Oracle Clusterware.
Syntax
srvctl start exportfs {-name unique_name | -id havip_name}
Parameters
Table G-18 srvctl start exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export you want to start.
-id havip_name The unique ID associated with the HAVIP resource.
Appendix G
SRVCTL Command Reference
G-31
Example
To start an export file system:
$ srvctl start exportfs -name export1
G.8.32 srvctl status exportfs
Displays the status of an export file system configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status exportfs [-name unique_name | -id havip_name]
Parameters
Table G-19 srvctl status exportfs Command Parameters
Parameter Description
-name unique_name Optionally, you can specify the unique name of the NFS export for
which you want to display the status.
-id havip_name Alternatively, you can specify the name of an HAVIP resource and
display the status of all of the NFS exports associated with the
specified HAVIP resource.
Usage Notes
If you do not specify any parameters, then SRVCTL displays the status for all NFS
exports in the cluster.
Example
This command returns output similar to the following:
$ srvctl status exportfs
export file system export1 is enabled
export file system export1 is not exported
export file system export2 is enabled
export file system export2 is exported on node node1
G.8.33 srvctl stop exportfs
Stops an export file system configuration managed by Oracle Clusterware.
Syntax
srvctl stop exportfs {-name unique_name | -id havip_name} [-force]
Appendix G
SRVCTL Command Reference
G-32
Parameters
Table G-20 srvctl stop exportfs Command Parameters
Parameter Description
-name unique_name Enter the unique name of the NFS export you want to stop.
-id havip_name Alternatively, you can specify the name of an HAVIP. If you specify
this parameter, then SRVCTL stops all of the NFS exports
associated with the HAVIP resource you specify.
–force Stop the NFS export, ignoring errors.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl stop exportfs -name export1
G.8.34 srvctl add filesystem
Adds a device containing a file system (Oracle Automatic Storage Management
Cluster File System (Oracle ACFS) or other) to the Oracle Clusterware stack for
automount and high availability.
An Oracle ACFS file system resource is typically created for use with application
resource dependency lists. For example, if an Oracle ACFS file system is configured
for use as an Oracle Database home, then a resource created for the file system can
be included in the resource dependency list of the Oracle Database application. This
will cause the file system and stack to be automatically mounted because of the start
action of the database application.
Syntax
srvctl add filesystem -device volume_device -path mountpoint_path
[-volume volume_name] [-diskgroup disk_group_name]
[-node node_list | -serverpool server_pool_list] [-user user_list]
[-fstype {ACFS | EXT3 | EXT4}] [-fsoptions options] [-description description]
[-appid application_id] [-autostart {ALWAYS | NEVER | RESTORE}]
Note:
Oracle supports the EXT3 and EXT4 values for the -fstype parameter only for
Linux.
Appendix G
SRVCTL Command Reference
G-33
Parameters
Table G-21 srvctl add filesystem Command Parameters
Parameter Description
-device volume_device Specify the path to the file system volume device you want to add.
-path mountpoint_path Specify the mount point path that is used to set up dependencies
on other resources for nested mounts. This must be an absolute
path.
-volume volume_name Optionally, you can specify the name of the volume.
-diskgroup
disk_group_name
Optionally, you can specify the name of the Oracle ACFS disk
group to which you want to add the device.
-node node_list | -
serverpool
server_pool_list
Optionally, you can specify a comma-delimited list of nodes on
which to mount the file system device. If you specify a list of nodes
or a server pool, then SRVCTL creates a single-node file system
resource. Without any nodes or server pools, SRVCTL creates a
file system resource that runs on every cluster node.
Alternatively, you can specify a comma-delimited list of server
pools in which a file system will run. If you specify a list of server
pools, then you dynamically limit the number or type of nodes on
which a file system will run. This does not count as a cluster-wide
file system for later usage that may require a cluster-wide Oracle
ACFS resource, such as HANFS.
Note: Nodes and server pools are mutually exclusive.
-user user_list Optionally, you can specify a comma-delimited list of users
authorized to mount and unmount the file system.
If you specify no users, then only root can mount and unmount the
file system. If the file system is for Oracle Database software, then
specify the name of the Oracle home owner.
-fstype {ACFS | EXT3 |
EXT4}
Optionally, you can specify the type of file system to be mounted.
The default value is ACFS.
If the type of file system to be mounted is not ACFS, then it must be
a single-node file system, and you must specify -node or -
serverpool.
-fsoptions options Optionally, you can specify options used to mount the file system.
The options are file system and operating system dependent.
-description
description
Optionally, you can specify a description of the file system. This is
stored as an attribute for later viewing by an administrator.
-appid application_id Optionally, you can specify an application ID, which is a unique
identifier used to group file systems into logical groupings. You can
use this method to group file systems that may be different on
different nodes but are used by an application that must have a
dependency on the resource type, which is ora.id.fs.type.
-autostart {ALWAYS |
NEVER | RESTORE}
Optionally, you can specify the file system resource autostart
policy.
ALWAYS: The file system resource always automatically starts.
NEVER: The file system does not automatically start.
RESTORE: The file system is restored to its last state. This is the
default option.
Appendix G
SRVCTL Command Reference
G-34
Usage Notes
• Use this command only with Oracle Clusterware.
• You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms.
• This command must be run only one time from the Oracle Grid Infrastructure
home.
• To manage Oracle ACFS on Oracle Database 12c installations, use the SRVCTL
binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have
Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL
binary in the database home to manage Oracle ACFS.
Examples
To add the d1volume1-295 disk device in the disk group RAC_DATA as the Oracle ACFS
volume VOLUME1 with a mount point of /oracle/cluster1/acfs:
# srvctl add filesystem -device /dev/asm/d1volume1-295
-path /oracle/cluster1/acfs1
To add an Oracle ACFS file system on the dynamic volume device asm-test-55, with
this file system mounted on one of the specified nodes at a time:
# srvctl add filesystem -fstype ACFS -device asm-test-55 -path myacfs
-node node1,node2,node3
G.8.35 srvctl config filesystem
Displays the configuration for a specific file system resource.
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config filesystem -device volume_device
Usage Notes
Use the -device parameter to specify the path to the file system resource for which you
want to display the configuration.
Examples
The following example lists the configuration of all file systems:
$ srvctl config filesystem
The following example displays the configuration for a specific device:
$ srvctl config filesystem -device /dev/asm/d1volume1-295
Appendix G
SRVCTL Command Reference
G-35
G.8.36 srvctl disable filesystem
Disables a specific Oracle Clusterware-managed file system volume.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable filesystem -device volume_device
Usage Notes
Specify the path to the file system volume you want to disable.
Example
An example of this command is:
# srvctl disable filesystem -device /dev/asm/racvol1
G.8.37 srvctl enable filesystem
Enables an Oracle ACFS volume or generic file system in Oracle Clusterware.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable filesystem -device volume_device
Usage Notes
Specify the path to the volume device you want to enable.
Example
An example of this command is:
# srvctl enable filesystem -device /dev/asm/racvol1
Appendix G
SRVCTL Command Reference
G-36
G.8.38 srvctl modify filesystem
Modifies the configuration of the file system resource.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl modify filesystem -device volume_device -user user_name
[-path mountpoint_path] [-node node_list | -serverpool
server_pool_list] [-fsoptions options] [-description description]
[-autostart {ALWAYS | NEVER | RESTORE}]
Parameters
Table G-22 srvctl modify filesystem Command Parameters
Parameter Description
-device volume_device Specify the path to the file system volume device you want to
modify.
-user user_name Specify the name of the user that is authorized to mount and
unmount the file system. If you do not specify this parameter, then
SRVCTL defaults to the user running the command.
-path mountpoint_path Modify the mount point path that is used to set up dependencies on
other resources for nested mounts. This must be an absolute path.
-node node_list | -
serverpool
server_pool_list
Modify a comma-delimited list of nodes on which to mount the file
system device. If you specify a list of nodes or a server pool, then
SRVCTL creates a single-node file system resource. Without any
nodes or server pools, SRVCTL creates a file system resource that
runs on every cluster node.
Alternatively, you can modify a comma-delimited list of server pools
in which a file system will run. If you specify a list of server pools,
then you dynamically limit the number or type of nodes on which a
file system will run. This does not count as a cluster-wide file
system for later usage that may require a cluster-wide Oracle
ACFS resource, such as HANFS.
Note: Nodes and server pools are mutually exclusive.
-fsoptions options Modify options used to mount the file system. The options are file
system and operating system dependent.
-description
description
Modify the description of the file system.
-autostart {ALWAYS |
NEVER | RESTORE}
Modify the file system resource autostart policy.
ALWAYS: The file system resource always automatically starts
NEVER: The file system does not automatically start
RESTORE: The file system is restored to its last state. This is the
default option.
Appendix G
SRVCTL Command Reference
G-37
Usage Notes
• You must run this command as root user on Linux and UNIX platforms.
• When performing online changes to the file system resource, the changes take
effect only after the resource is next (re)started.
Example
The following example changes the authorized user to sysad for the RACVOL1 volume:
# srvctl modify filesystem -device /dev/asm/racvol1 -user sysad
G.8.39 srvctl predict filesystem
Predicts the consequences of file system failure.
Syntax
srvctl predict filesystem -device volume_device_name [-verbose]
Usage Notes
• Specify the path name of the file system volume device.
• Optionally, you can choose verbose output.
Example
An example of this command is:
$ srvctl predict filesystem -device /dev/asm/volume1-123
G.8.40 srvctl remove filesystem
Removes a specific file system resource from the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove filesystem -device volume_device_name [-force]
Usage Notes
• Specify the path to the file system resource device you want to remove.
• Optionally, you can use the -force parameter to ignore any resource
dependencies and forcibly remove the resource from the cluster.
• You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms.
Appendix G
SRVCTL Command Reference
G-38
Examples
An example of this command is:
# srvctl remove filesystem -device /dev/asm/racvol1
G.8.41 srvctl start filesystem
Starts (mounts) the file system resource.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start filesystem -device volume_device [-node node_name]
Parameters
Table G-23 srvctl start filesystem Command Parameters
Parameter Description
-device volume_device Specify the path of the file system resource device that you want to
start.
-node node_name Optionally, you can specify the name of the node on which the file
system resource should be started.
If you do not specify this parameter, then SRVCTL starts the file
system resource on all the available nodes in the cluster.
Usage Notes
You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms, or as a configured file system user.
See Also:
srvctl add filesystem for more information about configuring file system users
Examples
To start a file system on all configured nodes in the cluster:
$ srvctl start filesystem -device /dev/asm/data_db1-68
To start the file system on node1:
$ srvctl start filesystem -device /dev/asm/data_db1-68 -node node1
Appendix G
SRVCTL Command Reference
G-39
G.8.42 srvctl status filesystem
Displays the status of the file system resource.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status filesystem [-device volume_device] [-verbose]
Usage Notes
• Optionally, you can specify the path of the file system resource for which you want
to obtain the status. If you do not specify this parameter, then SRVCTL displays
the status of all file systems.
• Optionally, you can use the -verbose parameter to display detailed output.
Examples
This command displays output similar to the following, depending on whether you
specify a device name.
If you specify a device name:
$ srvctl status filesystem -device /dev/asm/racvol_1
ACFS file system is not mounted on node1
ACFS file system is not mounted on node2
If you do not specify a device name:
$ srvctl status filesystem
ACFS file system is not running
ACFS file system is running on node1,node3
Note:
In the preceding examples, the file system is Oracle ACFS. If you are using
other file systems, then they will display as EXT3 or EXT4.
Appendix G
SRVCTL Command Reference
G-40
G.8.43 srvctl stop filesystem
Stops (unmounts) the Oracle ACFS file system or generic file system.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop filesystem -device volume_device [-node node_name] [-force]
Parameters
Table G-24 srvctl stop filesystem Command Parameters
Parameter Description
-device volume_device Specify the path to the file system volume device that you want to
stop.
-node node_name Optionally, you can specify the name of a node. If you do not
specify this parameter, then SRVCTL stops the volume resource on
all active nodes in the cluster.
-force Optionally, you can use -force to stop the file system and also
stop any databases or other resources that depend on this file
system.
Usage Notes
You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms, or as a configured file system user.
See Also:
srvctl add filesystem for more information about configuring file system users
Example
An example of this command is:
# srvctl stop filesystem -device /dev/asm/racvol_1 -force
G.8.44 srvctl add gns
Adds the Grid Naming Service (GNS) to a cluster when you are using a DHCP public
network or creating a client cluster.
Appendix G
SRVCTL Command Reference
G-41
Syntax
Use the srvctl add gns command with one of the following syntax models:
To add GNS to a cluster that is not currently running GNS:
srvctl add gns [-domain domain_name] -vip {vip_name | ip_address} [-skip] [-verbose]
To change a cluster that is not running GNS to be a client cluster of another cluster
that is running GNS:
srvctl add gns -clientdata file_name
To add a secondary GNS to a cluster:
srvctl add gns -vip vip_name | ip_address -clientdata file_name
Parameters
Table G-25 srvctl add gns Command Parameters
Parameter Description
-domain domain_name The network subdomain that is used for Forward DNS Lookup of
cluster IP addresses. You can only use this parameter if you
specify -vip, and you must use this parameter if the cluster to
which you are adding GNS has a GNS zone delegation and you
are using DHCP. The cluster to which you add GNS using -vip
with the -domain parameters becomes a server cluster.
If you do not specify -domain, then SRVCTL adds GNS without a
domain.
-vip {vip_name |
ip_address}
Specify either the virtual IP (VIP) name or IP address on which
GNS listens for DNS requests. You cannot use -vip with -
clientdata.
Use the -domain parameter with -vip to make the cluster to which
you are adding GNS a server cluster.
-skip Specify this parameter to skip the reachability check of the VIP
address.
-clientdata
path_to_file
Specify the path to the file you created with the srvctl export gns
command that contains the GNS credentials. You must copy this
file to a node in the cluster you are adding before running the
srvctl add gns command.
The cluster to which you add GNS using -clientdata becomes
either a client cluster or a secondary GNS.
You can only use the -clientdata parameter with the -vip
parameter when you are adding a secondary GNS.
-verbose Verbose output.
Usage Notes
• You must run this command as root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms.
• When you are adding GNS to a cluster for the first time, use the -vip parameter
with the -domain parameter.
Appendix G
SRVCTL Command Reference
G-42
• When you are adding GNS to a cluster using the -clientdata parameter, you must
first export the GNS data to a file and manually copy the file to a node in the
cluster you are adding. Use the -clientdata parameter and run this command on
any node in the cluster.
• You can only specify the -vip and -clientdata parameters at the same time when
you are adding a secondary GNS.
Examples
To add GNS to a cluster, making it a server cluster:
# srvctl add gns -vip 192.168.16.17 -domain cluster.mycompany.com
To add GNS to a cluster, making it a client cluster:
# srvctl add gns -clientdata /tmp/gnsdata
G.8.45 srvctl config gns
Displays the configuration for the grid naming service (GNS).
Syntax
srvctl config gns [-detail] [-subdomain] [-multicastport] [-node node_name] [-port]
[-status]
[-version] [-query name] [-list] [-clusterguid] [-clustername] [-clustertype] [-
loglevel]
[-network] [-role] [-instances]
Parameters
Table G-26 srvctl config gns Command Parameters
Parameter Description
-detail Print detailed configuration information about the GNS.
-subdomain Display the subdomain served by GNS.
-multicastport Display the port on which the GNS daemon is listening for multicast
requests.
-node node_name Display the configuration information for GNS on the specified
node.
-port Display the port that the GNS daemon uses to communicate with
the DNS server.
-status Display the status of GNS.
-version Display the version of GNS.
-query name Query GNS for the records belonging to a specific name.
-list List all records in GNS.
-clusterguid Display the globally unique identifier of the cluster where GNS is
running.
-clustername Display the name of the cluster where GNS is running.
-clustertype Display the type of configuration of GNS on this cluster.
-loglevel Print the log level of the GNS.
Appendix G
SRVCTL Command Reference
G-43
Table G-26 (Cont.) srvctl config gns Command Parameters
Parameter Description
-network Display network on which GNS is listening.
-role Display the role of the GNS instance.
-instances Display the instance list.
G.8.46 srvctl disable gns
Disables GNS for a specific node, or all available nodes in the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable gns [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify the name of a node in the cluster on which you want to
disable GNS. If you do not specify this parameter, then SRVCTL disables GNS for
the entire cluster.
• Optionally, you can use the -verbose parameter to display detailed output.
Example
An example of this command to disable GNS on the node named crm7 is:
$ srvctl disable gns -node crm7
G.8.47 srvctl enable gns
Enables GNS on all nodes or a specific node.
Note:
This command can be used only with Oracle Clusterware.
Syntax
srvctl enable gns [-node node_name] [-verbose]
Appendix G
SRVCTL Command Reference
G-44
Usage Notes
• Optionally, you can specify the name of a node on which you want to enable GNS.
If you do not specify this parameter, then SRVCTL enables GNS on all nodes in
the cluster.
• Optionally, you can use the -verbose parameter to print detailed output.
Example
An example of this command is:
$ srvctl enable gns -node node1
G.8.48 srvctl export gns
Exports Grid Naming Service (GNS) instance data to a file that you can use when you
are either moving GNS from one server cluster to another or when you are creating a
client cluster.
SRVCTL extracts the data from OCR. Exported data includes:
• The credentials used to authorize users, which includes the VIP address on which
the server listens
• The names and DNS records kept in GNS
Syntax
srvctl export gns {-instance path_to_file | {-clientdata path_to_file -role {CLIENT|
SECONDARY} [-version]}}
Parameters
Table G-27 srvctl export gns Command Parameters
Parameter Description
-instance path_to_file Use this parameter to specify the file to which GNS instance data is
written, when you are moving GNS from one server cluster to
another.
-clientdata
path_to_file -role
{CLIENT|SECONDARY}
Use this parameter to specify the file to which GNS credentials data
is written, when you are adding a client cluster to create a file that
contains credentials that the client cluster accesses to perform
name management operations on the server cluster.
You must also use the -role parameter to specify a role for which
the client data will be exported.
-version Optionally, you can use this parameter to specify the version for
which the client data will be generated.
Example
The following command exports the GNS credentials data to a file named gns.txt:
$ srvctl export gns -clientdata /temp/gnsdata/gns.txt
Appendix G
SRVCTL Command Reference
G-45
G.8.49 srvctl import gns
The srvctl import gns command imports data from a file that you create when you run
the srvctl export gns command. Use this command when you want to locate GNS to
a different server cluster.
When you import GNS data, SRVCTL stores the credentials and places the record
data into OCR. If another GNS instance is running or data for another instance is
encountered during the import procedure, then an error occurs.
This command also makes the cluster in which you run it the server cluster.
Note:
This command is only available with Oracle Clusterware.
G.8.50 srvctl modify gns
Modifies the IP address, domain, or other configuration parameters used by the grid
naming service (GNS).
Syntax
Use the srvctl modify gns command with one of the following syntax models:
srvctl modify gns -loglevel log_level
or
srvctl modify gns [-resolve name] [-verify name]
[-parameter name:value[,name:value...]]
[-vip {vip_name | ip} [-skip]] [-clientdata file_name]
[-role {PRIMARY} [-force]] [-verbose]
Parameters
Table G-28 srvctl modify gns Command Parameters
Parameter Description
-loglevel log_level Specify the GNS diagnostic logging level (acceptable values are
1-6).
-resolve name Resolve the name you specify through GNS.
-verify name Check to see if the specified name is advertised through GNS.
-parameter
name:value[,name:value
...]
Set the value of one or more configuration parameters.
Appendix G
SRVCTL Command Reference
G-46
Table G-28 (Cont.) srvctl modify gns Command Parameters
Parameter Description
-vip {vip_name | ip}
[-skip]
Specify a VIP name or IP address on which GNS is to listen.
Note: You can modify this attribute using Online Resource Attribute
Modification.
Optionally, you can use the -skip parameter to skip the
reachability check of the VIP address.
-clientdata file_name Modifies the GNS client data with client data contained in the
specified file.
-role {PRIMARY} [-
force]
Convert a secondary GNS instance to primary.
Use the -force parameter to forcibly convert the secondary GNS
instance to primary.
Examples
An example of this command is:
$ srvctl modify gns -vip 192.0.2.15
G.8.51 srvctl relocate gns
Relocates GNS from its current hosting node to another node within the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl relocate gns [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify the name of a node to which you want to move GNS.
• Optionally, you can use the -verbose parameter to display verbose output.
• On Linux and UNIX systems, you must be logged in as root and on Windows, you
must be logged in as a user with Administrator privileges to run this command.
Example
An example of this command is:
# srvctl relocate gns -node node1
Appendix G
SRVCTL Command Reference
G-47
G.8.52 srvctl remove gns
Removes GNS from the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove gns [-force] [-verbose]
Usage Notes
• Optionally, you can use the -force parameter to forcibly remove GNS from the
cluster, regardless of any errors that might occur.
• Optionally, you can use the -verbose parameter to display verbose output.
Example
An example of this command is:
$ srvctl remove gns
G.8.53 srvctl start gns
Starts GNS on a specific node.
Syntax
srvctl start gns [-loglevel log_level] [-node node_name] [-verbose]
Parameters
Table G-29 srvctl start gns Command Parameters
Parameter Description
-loglevel log_level Optionally, you can specify the level of logging with which GNS
should run. Log levels vary between 1 (minimal tracing) and 6
(traces everything and is time consuming).
-node node_name Optionally, you can specify the name of a node in the cluster where
you want to start GNS.
-verbose Optionally, you can use this parameter to display verbose output.
Usage Notes
You can only run this command in the server cluster. If you attempt to run this
command in a client cluster, then an error occurs.
Appendix G
SRVCTL Command Reference
G-48
Example
An example of this command to start the GNS on the cluster node named crmnode1 is:
$ srvctl start gns -node crmnode1
G.8.54 srvctl status gns
Displays the current state of GNS.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status gns [-node node_name] [-verbose]
Usage Notes
• Optionally, you can specify a node on which GNS is running for which you want to
display the state.
• Optionally, you can use the -verbose parameter to display detailed output.
G.8.55 srvctl stop gns
Stops GNS in the cluster.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop gns [-node node_name] [-force] [-verbose]
Usage Notes
• Optionally, you can specify the name of a node on which GNS is running that you
want to stop.
• Optionally, you can use -force and -verbose to forcibly stop GNS and print detailed
output, respectively.
Example
An example of this command to stop GNS on the local node is:
$ srvctl stop gns
Appendix G
SRVCTL Command Reference
G-49
G.8.56 srvctl update gns
Modifies a Grid Naming Service (GNS) instance.
Note:
This command is only available with Oracle Clusterware.
Syntax
Use the srvctl update gns command with one of these syntax models:
srvctl update gns -advertise name -address ip_address [-timetolive time_to_live
]
[-verbose]
srvctl update gns -delete name [-address address] [-verbose]
srvctl update gns -alias alias -name name [-timetolive time_to_live] [-verbose]
srvctl update gns -deletealias alias [-verbose]
srvctl update gns -createsrv service -target target -protocol protocol
[-weight weight] [-priority priority] [-port port_number]
[-timetolive time_to_live] [-instance instance_name] [-verbose]
srvctl update gns -deletesrv service_name -target target -protocol protocol
[-verbose]
srvctl update gns -createtxt name -target target [-timetolive time_to_live]
[-namettl name_ttl] [-verbose]
srvctl update gns -deletetxt name -target target [-verbose]
srvctl update gns -createptr name -target target [-timetolive time_to_live]
[-namettl name_ttl] [-verbose]
srvctl update gns -deleteptr name -target target [-verbose]
Parameters
Table G-30 srvctl update gns Command Parameters
Parameter Description
-advertise name Use this parameter to advertise a name through GNS.
-address ip_address Specify the IP address for an advertised name.
-timetolive
time_to_live
Optionally, you can specify, in seconds, an amount of time for the
record to live.
-delete name Use this parameter to remove the advertisement of a name from
GNS.
-alias alias Use this parameter to create an alias for an advertised name.
Appendix G
SRVCTL Command Reference
G-50
Table G-30 (Cont.) srvctl update gns Command Parameters
Parameter Description
-name name You must specify a name to associate with the alias.
-deletealias alias Use this parameter to delete an alias.
-createsrv service Use this parameter to create a service that is described by the
record.
-target target Use this parameter to associate a name with the service.
-protocol protocol Use this parameter to specify which protocol is used to connect to
the service.
-weight weight Optionally, you can specify the weight of the record.
-priority priority Optionally, you can specify a priority of the record, with a value
ranging from 0 to 65535.
-port port_number Optionally, you can specify a port number used to connect to the
service, with a value ranging from 0 to 65535.
-instance
instance_name
Optionally, you can specify an instance name for the service.
-deletesrv
service_name
Use this parameter to specify the name of the service record you
want to delete.
-createtxt name Use this parameter to add a text (TXT) record using the specified
name.
-namettl name_ttl Optionally, you can specify the time, in seconds, to live for the
name.
-deletetxt name Use this parameter to delete a text (TXT) record for a specific
name.
-createptr name Use this parameter to add a pointer (PTR) record for a specific
name.
-deleteptr name Use this parameter to delete a pointer (PTR) record for a specific
name.
Usage Notes
You must be logged in as the root user on Linux and UNIX platforms, or as an
Administrator user on Windows platforms, to run this command.
Example
The following command advertises a name with GNS:
# srvctl update gns -advertise myname -address 192.168.1.45
G.8.57 srvctl add havip
Adds highly available VIPs (HAVIPs) (used for highly available NFS and SMB exports)
to a cluster.
Syntax
srvctl add havip -id havip_name -address {host_name | ip_address}
[-netnum network_number] [-description text] [-skip] [-homenode node_name]
Appendix G
SRVCTL Command Reference
G-51
Parameters
Table G-31 srvctl add havip Command Parameters
Parameter Description
-id havip_name Specify a unique ID for the HAVIP resource.
-address {host_name |
ip_address}
Specify either a host name or an IPv4 IP address for the HAVIP
you are going to create.
Note: You must configure the IPv4 IP address with a non-DHCP,
non-round robin DNS address.
-netnum network_number Optionally, you can specify a network resource upon which the
HAVIP depends. The default value for this parameter is 1.
-description text Optionally, you can specify a text description of the HAVIP.
-skip Optionally, you can specify this parameter to skip the reachability
check for the IP address.
-homenode node_name Optionally, you can specify a preferred node or an empty string to
clear the home node.
Example
An example of this command is:
# srvctl add havip -id myhavip -address 192.0.2.1 -netnum 2 -description
"My HA VIP" -skip -homenode myNode2
G.8.58 srvctl config havip
Displays configuration information for a specific highly available VIP (HAVIP) (used for
highly available NFS and SMB exports) or all HAVIP resources in a cluster.
Syntax
Use the srvctl config havip command with the following syntax:
srvctl config havip [-id havip_name]
Parameters
Table G-32 srvctl config havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to display. If you do not
specify this parameter, then SRVCTL displays the configuration information for all
HAVIPs known to Oracle Clusterware.
Example
This command returns output similar to the following:
$ srvctl config havip -id hrexports
VIP: /mjk-vm3-vip/10.149.237.196/10.149.236.0/255.255.252.0/eth0
Description: HR Exports
Appendix G
SRVCTL Command Reference
G-52
G.8.59 srvctl disable havip
Prevents a specific highly-available VIP (HAVIP) (used for highly-available NFS and
SMB exports) resource from running on a number of specified nodes.
Syntax
srvctl disable havip -id havip_name [-node node1,node2,...,noden]
Parameters
Table G-33 srvctl disable havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
disable.
-node
node1,node2,...,noden
Specify the name of a node or a comma-delimited list of node
names on which you do not want the HAVIP resource to run.
If you specify all but one node in the cluster, then the HAVIP will
not fail over.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl disable havip -id myhavip -node myNode1,myNode3
G.8.60 srvctl enable havip
Enables a specific highly-available VIP (HAVIP) (used for highly-available NFS and
SMB exports) to run on a number of specified nodes.
Syntax
srvctl enable havip -id havip_name [-node node_name]
Parameters
Table G-34 srvctl enable havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
enable.
-node node_name Specify the name of a node on which you want the HAVIP resource
to be able to run.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Appendix G
SRVCTL Command Reference
G-53
Examples
An example of this command is:
# srvctl enable havip -id myhavip -node myNode1
G.8.61 srvctl modify havip
Modifies a highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports).
Syntax
srvctl modify havip -id havip_name [-address {host_name | ip_address}
[-netnum network_number] [-skip]] [-description text] [-homenode node_name]
Parameters
Table G-35 srvctl modify havip Command Parameters
Parameter Description
-id havip_name Specify the unique name for the HAVIP resource you want to
modify.
-address {host_name |
ip_address
Specify either a host name or an IPv4 IP or IPv6 address for the
HAVIP you want to modify.
Note: You must configure the IPv4 IP address with a non-DHCP,
non-round robin DNS address.
-netnum network_number Optionally, you can change the network resource upon which the
HAVIP depends. The default value for this optional parameter is 1.
-skip Specify this parameter to skip checking the reachability of the IP
address.
-description text Specify a text description for the HAVIP.
-homenode node_name Optionally, you can specify a preferred node or an empty string to
clear the home node.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl modify havip -id myhavip -address 192.168.16.17 -netnum 2
G.8.62 srvctl relocate havip
Relocates a highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports) to another node in a cluster.
Syntax
srvctl relocate havip -id havip_name [-node node_name] [-force]
Appendix G
SRVCTL Command Reference
G-54
Parameters
Table G-36 srvctl relocate havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
relocate.
-node node_name Specify the name of the node to which you want to relocate the
HAVIP resource.
-force Optionally, you can force the relocation of the HAVIP resource.
Example
An example of this command is:
$ srvctl relocate havip -id myhavip -node node3
G.8.63 srvctl remove havip
Removes a highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports).
Syntax
srvctl remove havip -id havip_name [-force]
Parameters
Table G-37 srvctl remove havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to
remove.
–force Use this parameter to forcibly remove the resource from the cluster
and ignore any dependencies.
Usage Notes
• You must first stop the HAVIP resource before you attempt to remove it.
• You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl remove havip -id myhavip -force
G.8.64 srvctl start havip
Starts a specific highly-available VIP (HAVIP) (used for highly-available NFS and SMB
exports) on a specific node.
Appendix G
SRVCTL Command Reference
G-55
Syntax
srvctl start havip -id havip_name [-node node_name]
Parameters
Table G-38 srvctl start havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource you want to start.
-node node_name Optionally, you can use the -node parameter to specify the name of
the node on which the HAVIP resource starts.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl start havip -id myhavip -node myNode1
G.8.65 srvctl status havip
Displays the status of all highly-available VIPs (HAVIPs) (used for highly-available
NFS and SMB exports) in a cluster or one particular HAVIP.
Syntax
srvctl status havip [-id havip_name]
Usage Notes
Specify the unique name of the HAVIP resource you want to display. If you do not
specify this parameter, then SRVCTL displays the status of all HAVIPs known to
Oracle Clusterware.
Example
This command returns output similar to the following:
$ srvctl status havip
HAVIP ora.ha1.havip is enabled
HAVIP ora.ha1.havip is not running
G.8.66 srvctl stop havip
Stops the highly-available VIPs (HAVIPs) (used for highly-available NFS and SMB
exports) on a specific node.
Syntax
srvctl stop havip -id havip_name [-node node_name] [-force]
Appendix G
SRVCTL Command Reference
G-56
Parameters
Table G-39 srvctl stop havip Command Parameters
Parameter Description
-id havip_name Specify the unique name of the HAVIP resource to stop.
-node node_name Optionally, you can specify the name of the node on which the
HAVIP resource to stop resides.
–force Use this parameter to forcibly stop the HAVIP.
Usage Notes
You must run this command as root user on Linux and UNIX platforms.
Examples
An example of this command is:
# srvctl stop havip -id myhavip -node myNode1 -force
G.8.67 srvctl add ioserver
Adds an Oracle ASM IOServer configuration to the cluster.
When you configure, upgrade, or convert from a standard cluster to an Oracle Flex
Cluster you can create Oracle ASM IOServers on the Hub nodes in the cluster.
Syntax
srvctl add ioserver [-spfile spfile] [-count number_of_ioserver_instances| ALL] [-
listener listener_name]
Parameters
Table G-40 srvctl add ioserver Command Parameters
Parameter Description
-spfile spfile Specify the path to the server parameter file.
-count number_of_ioserver_instances| ALL Specify the number of Oracle ASM IOServer
instances you want to add or ALL to add
instances to all nodes.
-listener listener_name Specify the name of the listener.
Example
An example of this command is:
# srvctl add ioserver -count 2
Appendix G
SRVCTL Command Reference
G-57
G.8.68 srvctl config ioserver
Displays the configuration details of Oracle ASM IOServers.
Syntax
srvctl config ioserver
Usage Notes
This command has no parameters.
Example
This command displays output similar to the following:
$ srvctl config ioserver
ASM I/O Server instance count: 3
ASM I/O Server is enabled.
ASM I/O server is enabled on nodes:
ASM I/O server is disabled on nodes:
G.8.69 srvctl disable ioserver
Disables an Oracle ASM IOServer.
Syntax
srvctl disable ioserver -node node_name
Usage Notes
Use the -node parameter to specify the name of a Hub node on which you want to
disable an Oracle ASM IOServer.
G.8.70 srvctl enable ioserver
Enable an Oracle ASM IOServer on a specific node.
Syntax
srvctl enable ioserver [-node node_name]
Usage Notes
Use the -node parameter to specify the name of a Hub node on which you want to
enable an Oracle ASM IOServer.
G.8.71 srvctl getenv ioserver
Displays the values for environment variables associated with an Oracle ASM
IOServer.
Syntax
srvctl getenv ioserver [-envs "name_list"]
Appendix G
SRVCTL Command Reference
G-58
Usage Notes
Specify a comma-delimited list of the names of environment variables. If you do not
specify this parameter, then SRVCTL displays the values of all environment variables
associated with the database.
G.8.72 srvctl modify ioserver
Modifies an Oracle ASM IOServer configuration on a cluster.
Syntax
srvctl modify ioserver [-spfile spfile] [-count number_of_ioserver_instances | ALL]
[-listener listener_name] [-force]
Parameters
Table G-41 srvctl modify ioserver Command Parameters
Parameter Description
-spfile spfile Optionally, specify the path to the server parameter file path.
-count
number_of_ioserver_ins
tances | ALL
Optionally, specify a number of instances or ALL (to modify
instances on all nodes) that you want to modify. If you modify the
count, then, because this results in a change in cardinality of the
cluster resource, the changes take effect immediately.
-listener
listener_name
Optionally, specify the name of the listener.
-force Optionally, you can ignore any dependencies and force the
modification of the Oracle ASM IOServer.
G.8.73 srvctl relocate ioserver
Relocates an Oracle ASM IOServer instance from its current hosting node to another
node within the cluster.
Syntax
srvctl relocate ioserver -currentnode node_name [-targetnode node_name] [-force]
Parameters
Table G-42 srvctl relocate ioserver Command Parameters
Parameter Description
-currentnode node_name The name of the node on which the Oracle ASM IOServer instance
currently resides
-targetnode node_name The name of the node to which to relocate the IOServer instance
-force Optionally, you can force the relocation of the Oracle ASM
IOServer instance
Appendix G
SRVCTL Command Reference
G-59
Example
The following command relocates the Oracle ASM IOServer from a node called
crsNode2 to a node called crsNode5:
$ srvctl relocate ioserver -currentnode crsNode2 -targetnode crsNode5
G.8.74 srvctl remove ioserver
Use this command to remove an Oracle ASM IOServer instance from the cluster.
Syntax
srvctl remove ioserver [-force]
Usage Notes
Use the -force parameter to forcibly remove the Oracle ASM IOServer instance,
ignoring any dependencies.
G.8.75 srvctl setenv ioserver
Administers the environment configuration for an Oracle ASM IOServer.
Syntax
srvctl setenv ioserver {-envs "name=val[,name=val][...]" | -env "name=val"}
Parameters
Table G-43 srvctl setenv ioserver Command Parameters
Parameter Description
-envs "name=val,..." Comma-delimited list of name-value pairs of environment
variables enclosed in double quotation marks ("").
-env "name=val" Alternatively, use this parameter to set a single
environment variable to a value that contains commas or
other special characters, enclosed in double quotation
marks ("").
G.8.76 srvctl start ioserver
Starts Oracle ASM IOServers in the cluster.
You can also start an Oracle ASM IOServer on a particular Hub Node by specifying
the node name.
Syntax
srvctl start ioserver [-node node_name]
Appendix G
SRVCTL Command Reference
G-60
Usage Notes
If you choose to start an Oracle ASM IOServer on a particular Hub Node, then use the
-node parameter and specify the name of the node. If you do not specify a particular
Hub Node, then SRVCTL starts all Oracle ASM IOServers in the cluster.
Example
The following command starts an Oracle ASM IOServer on a Hub node named
mjkhub46:
$ srvctl start ioserver -node mjkhub46
G.8.77 srvctl status ioserver
Displays the status of Oracle ASM IOServers running in the cluster.
You can display the status of all Oracle ASM IOServers running a cluster, the status of
an Oracle ASM IOServer running on a particular Hub Node, or the information about
clients from a specific database.
Syntax
srvctl status ioserver [-node node_name] [-detail]
Parameters
Table G-44 srvctl status ioserver Parameters
Parameter Description
—node node_name Specify a particular Hub node to display the status of the Oracle
ASM IOServer resource instance running there. If you do not
specify a Hub node, then SRVCTL returns the status of all Oracle
ASM IOServer resource instances running in the cluster.
-detail Use this parameter to display more detailed information about the
status of the Oracle ASM IOServer.
Example
If you run the command with the -detail parameter, then SRVCTL displays output
similar to the following:
$ srvctl status ioserver -detail
ASM I/O Server is enabled
ASM I/O Server is running on nodes: mjk376, mjk377
ASM I/O Server instance +IOS1 running on node mjk376 is connected to ASM instance
+ASM2:
Number of clients connected: 2
Names of clients: later14, alus16, later12, alus9, db0010
ASM I/O Server instance +IOS2 running on node mjk377 is connected to ASM instance
+ASM3:
Number of clients connected: 3
Number of requests completed per sec: 110
Appendix G
SRVCTL Command Reference
G-61
Names of networks: eth1, eth2
Names of clients: later11, later3, later14, later15, later16, alus19, alus17, alus13
G.8.78 srvctl stop ioserver
Stops an Oracle ASM IOServer in the cluster.
Syntax
srvctl stop ioserver [-node node_name] [-force]
Usage Notes
• Use the -node parameter to stop an Oracle ASM IOServer on a particular Hub
Node. If you do not specify a particular Hub Node, then SRVCTL stops all of the
Oracle ASM IOServers in the cluster.
• Use the -force parameter to stop an Oracle ASM IOServer, regardless of any
dependencies.
G.8.79 srvctl unsetenv ioserver
Unsets the Oracle ASM IOServer environment configurations.
Syntax
srvctl unsetenv ioserver -envs "name_list"
Usage Notes
Use the -envs parameter to specify a comma-delimited list of the names of
environment variables enclosed in double quotation marks ("").
G.8.80 srvctl add mgmtdb
Adds a management database (CHM repository) resource to the cluster.
Syntax
srvctl add mgmtdb [-domain domain]
Usage Notes
Optionally, you can specify the domain for the database. If you have the DB_DOMAIN
database initialization parameter set, then you must provide a value for this parameter.
Example
To add a management database to the cluster:
$ srvctl add mgmtdb -domain example.com
Appendix G
SRVCTL Command Reference
G-62
G.8.81 srvctl config mgmtdb
Displays configuration information for the management database (CHM repository)
resource.
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config mgmtdb [-verbose] [-all]
Usage Notes
• Optionally, use the -verbose parameter to print detailed output.
• Optionally, use the -all parameter to print detailed configuration information.
G.8.82 srvctl disable mgmtdb
Disables the management database (CHM repository) resource on the specified node.
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable mgmtdb [-node node_name]
Usage Notes
Optionally, you can specify the name of a cluster node on which the management

Next

CRSCTL Overview
CRSCTL is an interface between you and Oracle Clusterware, parsing and calling
Oracle Clusterware APIs for Oracle Clusterware objects.
CRSCTL provides cluster-aware commands with which you can perform check, start,
and stop operations on the cluster. You can run these commands from any node in the
cluster on another node in the cluster, or on all nodes in the cluster, depending on the
operation.
You can use CRSCTL commands to perform several operations on Oracle
Clusterware, such as:
• Starting and stopping Oracle Clusterware resources
• Enabling and disabling Oracle Clusterware daemons
• Checking the health of the cluster
• Managing resources that represent third-party applications
• Integrating Intelligent Platform Management Interface (IPMI) with Oracle
Clusterware to provide failure isolation support and to ensure cluster integrity
• Debugging Oracle Clusterware components
E-1
This section includes the following topics:
• Clusterized (Cluster Aware) Commands
• CRSCTL Operational Notes
• Deprecated Subprograms or Commands
E.1.1 Clusterized (Cluster Aware) Commands
You can run clusterized commands on one node to perform operations on another
node in the cluster. These are referred to as remote operations. This simplifies
administration because, for example, you no longer have to log in to each node to
check the status of the Oracle Clusterware on all of your nodes.
Clusterized commands are completely operating system independent; they rely on the
OHASD (Oracle High Availability Services daemon). If this daemon is running, then
you can perform remote operations, such as the starting, stopping, and checking the
status of remote nodes.
Clusterized commands include the following:
• crsctl check cluster
• crsctl start cluster
• crsctl stop cluster
E.1.2 CRSCTL Operational Notes
Information about using the CRSCTL command-line interface.
Usage Information
• The CRSCTL utility is located in the Grid_home/bin directory. To run CRSCTL
commands, type in crsctl at the operating system prompt followed by the
command and arguments, as shown in the following example:
crsctl stop crs
• There are three categories of CRSCTL commands:
– Those that you use in either the Oracle Real Application Clusters (Oracle
RAC) environment or in the Oracle Restart environment
– Those that you use in the Oracle RAC environment, only
– Those that you use in the Oracle Restart environment, only
• Many CRSCTL commands use the -f parameter to force the command to run and
ignore any checks.
For example, if you specify the force parameter for the crsctl stop resource
command on a resource that is running and has dependent resources that are
also running, then the force parameter omits the error message and instead stops
or relocates all the dependent resources before stopping the resource you
reference in the command.
• Do not use versions of CRSCTL earlier than 12c release 1 (12.1) to manage
Oracle Clusterware 12c.
Appendix E
CRSCTL Overview
E-2
Filters
You can use filters to narrow down Oracle Clusterware entities upon which a CRSCTL
command operates, as follows:
• Simple filters are attribute-value pairs with an operator.
• Operators must be surrounded by spaces, as shown in the examples.
• You can combine simple filters into expressions called expression filters using
Boolean operators.
Supported filter operators are:
=
>
<
!=
co: Contains
st: Starts with
en: Ends with
Supported Boolean operators are AND and OR.
Examples of filters are:
• TYPE = type1
• ((TYPE = type1) AND (CHECK_INTERVAL > 50))
• (TYPE = type1) AND ((CHECK_INTERVAL > 30) OR (AUTO_START co never))
• NAME en network.res
• TYPE st ora.db
Using CRSCTL Help
To print the help information for CRSCTL, use the following command:
crsctl -help
If you want help for a specific command, such as start, then enter the command and
append -help to the end, as shown in the following example:
crsctl start -help
You can also use the abbreviations -h or -? (this parameter functions in Linux, UNIX,
and Windows environments) instead of -help.
E.1.3 Deprecated Subprograms or Commands
Table E-1 lists deprecated commands and their replacements that you can use to
perform the same or similar functionality.
Appendix E
CRSCTL Overview
E-3
Table E-1 Deprecated CRSCTL Commands and Replacements
Deprecated Command Replacement Commands
crs_stat crsctl check cluster
crsctl status resource
crs_register crsctl add resource
crsctl add type
crsctl modify resource
crsctl modify type
crs_unregister crsctl stop resource
crsctl delete resource
crs_start crsctl start resource
crsctl start crs
crsctl start cluster
crs_stop crsctl stop resource
crsctl stop crs
crsctl stop cluster
crs_getperm crsctl getperm resource
crsctl getperm type
crs_profile crsctl add resource
crsctl add type
crsctl status resource
crsctl status type
crsctl modify resource
crsctl modify type
crs_relocate crsctl relocate resource
crs_setperm crsctl setperm resource
crsctl setperm type
crsctl add crs administrator Use the access control list (ACL) to control who can add
server pools.
crsctl check crsd crsctl check crs
crsctl check cssd crsctl check css
crsctl check evmd crsctl check evm
crsctl debug res log
resource_name:level
crsctl set log
Appendix E
CRSCTL Overview
E-4
Table E-1 (Cont.) Deprecated CRSCTL Commands and Replacements
Deprecated Command Replacement Commands
crsctl set css votedisk crsctl add css votedisk
crsctl delete css votedisk
crsctl query css votedisk
crsctl replace votedisk
crsctl start resources crsctl start resource -all
crsctl stop resources crsctl stop resource -all
crsctl set css logfilesize crsctl get tracefileopts css
crsctl set tracefileopts css
crsctl get css logfilesize crsctl set tracefileopts css
crsctl set trace module_name
"component:debugging_level
[,component:debugging_level]
[,...]"
crsctl get trace
E.2 Dual Environment CRSCTL Commands
Use these commands in either the Oracle RAC or the Oracle Restart environments.
The commands listed in this section manage the Oracle Clusterware resources in both
Oracle RAC and Oracle Restart environments.
E.2.1 crsctl check css
Checks the status of Cluster Synchronization Services.
This command is most often used when Oracle Automatic Storage Management
(Oracle ASM) is installed on the local server.
Syntax
crsctl check css
Example
This command returns output similar to the following:
CRS-4529: Cluster Synchronization Services is online
E.2.2 crsctl check evm
Checks the status of the Event Manager.
Appendix E
Dual Environment CRSCTL Commands
E-5
Syntax
crsctl check evm
Example
This command returns output similar to the following:
CRS-4533: Event Manager is online
E.2.3 crsctl get hostname
Retrieves the host name of the local server.
Syntax
crsctl get hostname
Example
Oracle Clusterware returns the host name of the local server:
$ crsctl get hostname
node2
E.2.4 crsctl add resource
Registers a resource to be managed by Oracle Clusterware.
A resource can be an application process, a database, a service, a listener, and so on.
Syntax
crsctl add resource resource_name -type resource_type [-group group_name [-file
file_path |
-attr "attribute_name=attribute_value[,...]"]
[-i] [-f]
Parameters
Table E-2 crsctl add resource Command Parameters
Parameter Description
resource_name Specify a short, descriptive name for the resource.
-type resource_type Specify the type of resource that you are adding preceded by the -type flag.
-group group_name Specify a resource group to which you want to add the resource.
-file file_path Path name (either absolute or relative) for a text file containing line-delimited
attribute name-value pairs that define the resource.
Appendix E
Dual Environment CRSCTL Commands
E-6
Table E-2 (Cont.) crsctl add resource Command Parameters
Parameter Description
-attr
"attribute_name=attribute_v
alue[,...]"
You can specify attributes for a resource you are adding in two different ways:
• Following the -attr flag, you can specify one or more comma-delimited
attribute name-value pairs enclosed in double quotations marks (""). For
example:
-attr "CHECK_INTERVAL=30,START_TIMEOUT=25"
Some attributes can have multiple values. In those cases, separate the
values with a space and enclose the list of values in single quotation marks.
For example:
-attr "SERVER_POOL_NAMES=
'ora.pool1 ora.pool2',START_TIMEOUT=25"
• Additionally, you can specify attribute values for resource instances with a
particular cardinality value, and with a particular degree value. This method
can be useful for applications that are tied to a particular server. Following
the -attr flag, the syntax is as follows:
attribute_name{@SERVERNAME(server_name)
[@DEGREEID(did)] | @CARDINALITYID(cid)
[@DEGREEID(did)]}=attribute_value
If you specify the @SERVERNAME(server_name) syntax, then the attribute value
you specify for the attribute you specify is limited to resource instances
residing on the server you specify.
Alternatively, if you specify the @CARDINALITYID(cid) syntax, then the
attribute value you specify for the attribute you specify is limited to resource
instances with a specific cardinality ID (cid).
Optionally, you can combine the @DEGREEID(did) syntax with either the
SERVERNAME or CARDINALITYID syntax, or both, to limit the attribute value to
resources with the specific DEGREE.
Examples:
CHECK_INTERVAL@SERVERNAME(node1)=45
STOP_TIMEOUT@CARDINALITYID(2)=65
STOP_TIMEOUT@SERVERNAME(node1)@DEGREEID(2)=65
STOP_TIMEOUT@CARDINALITYID(3)@DEGREEID(2)=65
-i If you specify -i, then CRSCTL returns an error if processing this command
requires waiting for Oracle Clusterware to unlock the resource or its dependents.
Sometimes, Oracle Clusterware locks resources or other objects to prevent
commands from interfering with each other.
-f Use the force parameter:
• To add a resource that has dependencies on other resources that do not yet
exist. The force parameter overrides checks that would prevent a command
from being completed.
• To add a resource if the resource has hard dependencies on other resources
and the owner of the resources does not execute permissions on one or
more of the dependencies. If you do not specify the force parameter in this
case, an error displays.
• To add resources of application type because you may need to move
servers into the Generic server pool. If the servers currently host resources
that must be stopped, then the force parameter is required.
Appendix E
Dual Environment CRSCTL Commands
E-7
Usage Notes
• Both the resource_name and -type resource_type parameters are required. You can
create an associated resource type using the crsctl add type command.
• Any user can create a resource but only clusterware administrators can create
resources of type local_resource or resources of type cluster_resource that have
SERVER_POOLS=*.
Once a resource is defined, its ACL controls who can perform particular operations
with it. The Oracle Clusterware administrator list is no longer relevant.
On Windows, a member of the Administrators group has full control over
everything.
See Also:
"crsctl setperm resource" for more information about setting ACLs
• If an attribute value for an attribute name-value pair contains commas, then the
value must be enclosed in single quotation marks ('').
• Following is an example of an attribute file:
PLACEMENT=favored
HOSTING_MEMBERS=node1 node2 node3
RESTART_ATTEMPTS@CARDINALITYID(1)=0
RESTART_ATTEMPTS@CARDINALITYID(2)=0
FAILURE_THRESHOLD@CARDINALITYID(1)=2
FAILURE_THRESHOLD@CARDINALITYID(2)=4
FAILURE_INTERVAL@CARDINALITYID(1)=300
FAILURE_INTERVAL@CARDINALITYID(2)=500
CHECK_INTERVAL=2
CARDINALITY=2
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources.
Examples
Example E-1 Example 1
To register a VIP as a resource with Oracle Clusterware:
$ crsctl add resource app.appvip -type app.appvip.type -attr "RESTART_ATTEMPTS=2,
START_TIMEOUT=100,STOP_TIMEOUT=100,CHECK_INTERVAL=10,
USR_ORA_VIP=172.16.0.0,
START_DEPENDENCIES=hard(ora.net1.network)pullup(ora.net1.network),
STOP_DEPENDENCIES=hard(ora.net1.network)"
Example E-2 Example 2
To register a resource based on the test_type1 resource type:
$ crsctl add resource r1 -type test_type1 -attr "PATH_NAME=/tmp/r1.txt"
$ crsctl add resource r1 -type test_type1 -attr "PATH_NAME=/tmp/r2.txt"
Appendix E
Dual Environment CRSCTL Commands
E-8
Example E-3 Example 3
To register a Samba server resource of the generic_application resource type, using
the EXECUTABLE_NAMES attribute:
# crsctl add resource my_samba -type generic_application -attr
"EXECUTABLE_NAMES=smbd,START_PROGRAM='/etc/rc.d/init.d/smb start',
STOP_PROGRAM='/etc/rc.d/init.d/smb stop'"
Example E-4 Example 4
To register a DNS server of the generic_application resource type, using the
EXECUTABLE_NAMES attribute:
# crsctl add resource my_dns -type generic_application -attr
"EXECUTABLE_NAMES=named,START_PROGRAM='/etc/rc.d/init.d/named start',
STOP_PROGRAM='/etc/rc.d/init.d/named stop'"
Example E-5 Example 5
To register an Apache web server of the generic_application resource type using the
PID_FILES attribute:
# crsctl add resource my_apache -type generic_application -attr
"START_PROGRAM='/usr/sbin/httpd -k start',STOP_PROGRAM='/usr/sbin/httpd -k stop',
PID_FILES=/etc/httpd/run/httpd.pid"
Example E-6 Example 6
To register an application of generic_application resource type using environment
variables:
# crsctl add resource my_app -type generic_application -attr
"START_PROGRAM='/opt/my_app start', EXECUTABLE_NAMES=my_app,
ENVIRONMENT_VARS='USE_NETAPP=no,USE_BACKUP=yes,CLEAN_ON_KILL=yes'"
Related Topics:
• Oracle Clusterware Resource Reference
E.2.5 crsctl delete resource
Removes resources from the Oracle Clusterware configuration.
Syntax
crsctl delete resource {"resource_name [...]" | -w "filter"} [-i] [-f]
Parameters
Table E-3 crsctl delete resource Command Parameters
Parameter Description
resource_name Specify one or more resource names that you want to delete.
Multiple resources must be space-delimited and enclosed in double
quotation marks ("").
Appendix E
Dual Environment CRSCTL Commands
E-9
Table E-3 (Cont.) crsctl delete resource Command Parameters
Parameter Description
-w "filter" Specify a resource filter that Oracle Clusterware uses to limit the
number of resources evaluated for deletion. The filter must be
enclosed in double quotation marks (""). Examples of resource
filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to relocate only resources of cluster_resource
type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to relocate resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to relocate resources that have a value
greater than 10 for the CHECK_INTERVAL resource attribute and
the name of the resource contains the number 2
Note: All operators must be surrounded by spaces.
See Also: Filters for more information about operators
-i If you specify -i, then CRSCTL returns an error if processing this
command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
-f Use this parameter to delete a resource that is online.
Usage Notes
• Either the resource_name or -w "filter" parameter is required
• You must have read and write permissions to delete the specified resources
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources
Example
To delete a resource from Oracle Clusterware:
# crsctl delete resource myResource
E.2.6 crsctl eval add resource
Predicts the effects of adding a resource without making changes to the system.
This command may be useful to application administrators.
Syntax
crsctl eval add resource resource_name -type resource_type [-file file_path
| -attr "attribute_name=attribute_value[,...]"]] [-group group_name] [-f]
Appendix E
Dual Environment CRSCTL Commands
E-10
Parameters
Table E-4 crsctl eval add resource Command Parameters
Parameter Description
resource_name Specify a short, descriptive name for the resource.
-type resource_type Specify the type of resource that you are adding following the -
type flag.
-file file_path Path name (either absolute or relative) for a text file containing linedelimited
attribute name-value pairs that define the resource.
-attr
"attribute_name=attrib
ute_value"
You can specify attributes for a resource you are adding in two
different ways:
• Following the -attr flag, you can specify one or more commadelimited
attribute name-value pairs enclosed in double
quotations marks (""). For example:
-attr "CHECK_INTERVAL=30,START_TIMEOUT=25"
Some attributes can have multiple values. In those cases,
separate the values with a space and enclose the list of values
in single quotation marks. For example:
-attr "SERVER_POOL_NAMES=
'ora.pool1 ora.pool2',START_TIMEOUT=25"
• Optionally, you can specify attribute values for resource
instances with a particular cardinality value, and with a
particular degree value. This method can be useful for
applications that are tied to a particular server. Following the -
attr flag, the syntax is as follows:
attribute_name{@SERVERNAME(server_name)
[@DEGREEID(did)] | @CARDINALITYID(cid)
[@DEGREEID(did)]}=attribute_value
If you specify the @SERVERNAME(server_name) syntax, then the
attribute value you specify for the attribute you specify is
limited to resource instances residing on the server you
specify.
Alternatively, if you specify the @CARDINALITYID(cid) syntax,
then the attribute value you specify for the attribute you specify
is limited to resource instances with a specific cardinality ID
(cid).
Optionally, you can combine the @DEGREEID(did) syntax with
either the SERVERNAME or CARDINALITYID syntax, or both, to
limit the attribute value to resources with the specific DEGREE.
Examples:
CHECK_INTERVAL@SERVERNAME(node1)=45
STOP_TIMEOUT@CARDINALITYID(2)=65
STOP_TIMEOUT@SERVERNAME(node1)@DEGREEID(2)=65
STOP_TIMEOUT@CARDINALITYID(3)@DEGREEID(2)=65
-group group_name Specify a resource group to which you want to add the resource.
Appendix E
Dual Environment CRSCTL Commands
E-11
Table E-4 (Cont.) crsctl eval add resource Command Parameters
Parameter Description
-f Use the force parameter:
• To add a resource that has dependencies on other resources
that do not yet exist. The force parameter overrides checks
that would prevent a command from being completed.
• To add a resource if the resource has hard dependencies on
other resources and the owner of the resources does not
execute permissions on one or more of the dependencies. If
you do not specify the force parameter in this case, an error
displays.
• To add resources of application type because you may need
to move servers into the Generic server pool. If the servers
currently host resources that must be stopped, then the force
parameter is required.
E.2.7 crsctl eval fail resource
Predicts the consequences of a resource failing.
Syntax
crsctl eval fail resource {resource_name | -w "filter"} [-n server]
[-env "attr=val[,...]"]
Parameters
Table E-5 crsctl eval fail resource Command Parameters
Parameter Description
resource_name Specify the name of a resource for which you want to simulate a
failure. You must specify either the name of a resource or resource
filters using the -w parameter.
-w "filter" Alternatively, you can specify a resource filter that Oracle
Clusterware uses to limit the number of resources evaluated. The
filter must be enclosed in double quotation marks (""). Examples of
resource filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to relocate only resources of cluster_resource
type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to relocate resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to relocate resources that have a value
greater than 10 for the CHECK_INTERVAL resource attribute and
the name of the resource contains the number 2
Note: All operators must be surrounded by spaces.
See Also: "Filters" for more information about operators
-n server Specify the name of the server on which the resource that you want
to simulate a failure resides.
Appendix E
Dual Environment CRSCTL Commands
E-12
Table E-5 (Cont.) crsctl eval fail resource Command Parameters
Parameter Description
-env "attr=val[,...]" You can optionally override one or more resource profile attribute
values with the -env command parameter. If you specify multiple
environment name-value pairs, then you must separate each pair
with a comma and enclose the entire list in double quotation marks
("").
Example
This command returns output similar to the following:
$ crsctl eval fail res cs1
Stage Group 1:
-----------------------------------------------------------------------------
Stage Number Required Action
-----------------------------------------------------------------------------
1 Y Resource 'cs1' (1/1) will be in state
[ONLINE|INTERMEDIATE] on server
[mjkeenan_node_0]
Y Resource 'cs1' (2/1) will be in state
[ONLINE|INTERMEDIATE] on server
[mjkeenan_node_1]
-----------------------------------------------------------------------------
E.2.8 crsctl eval relocate resource
Simulates relocating a resource without making changes to the system.
Syntax
crsctl eval relocate resource {resource_name | -all} {-s source_server | -w "filter"}
[-n destination_server] [-f]
Parameters
Table E-6 crsctl eval relocate resource Command Parameters
Parameter Description
resource_name Specify the name of a resource you want to relocate.
-all Alternatively, you can use this parameter to specify all resources
for relocation.
-s source_server Specify a particular server from which you want to relocate the
resources.
Appendix E
Dual Environment CRSCTL Commands
E-13
Table E-6 (Cont.) crsctl eval relocate resource Command Parameters
Parameter Description
-w "filter" Alternative to using -s, you can specify a resource filter that
CRSCTL uses to limit the number of resources relocated. The filter
must be enclosed in double quotation marks (""). Examples of
resource filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to relocate only resources of cluster_resource
type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to relocate resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to relocate resources that have a value
greater than 10 for the CHECK_INTERVAL resource attribute and
the name of the resource contains the number 2
See Also: "Filters" for more information
-n destination_server Specify the name of the server to which you want to relocate
resources. If you do not specify a destination server, then CRSCTL
relocates the resources to the best server according to the attribute
profile of each resource.
–f Specify the -f parameter to force the relocation of the resource
when it has other resources running that depend on it. CRSCTL
stops or relocates dependent resources when you use this
parameter.
Note: When you are relocating resources that have cardinality
greater than 1, you must use either -k or -s to narrow down which
resource instances are to be relocated.
E.2.9 crsctl eval modify resource
Predicts the effects of modifying a resource without making changes to the system.
Syntax
crsctl eval modify resource resource_name -attr
"attribute_name=attribute_value[,...]"
[-group group_name] [-f]
Parameters
Table E-7 crsctl eval modify resource Command Parameters
Parameter Description
resource_name Specify the name of the resource you want to evaluate.
Appendix E
Dual Environment CRSCTL Commands
E-14
Table E-7 (Cont.) crsctl eval modify resource Command Parameters
Parameter Description
-attr
"attribute_name=attrib
ute_value[,...]"
You can specify attributes for a resource you want to evaluate in
two different ways:
• Following the -attr flag, you can specify one or more commadelimited
attribute name-value pairs to modify enclosed in
double quotations marks (""). For example:
-attr "CHECK_INTERVAL=30, START_TIMEOUT=25"
Some attributes can have multiple values. In those cases,
separate the values with a space and enclose the list of values
in single quotation marks. For example:
-attr "SERVER_POOL_NAMES=
'ora.pool1 ora.pool2',START_TIMEOUT=25"
• Alternatively, you can specify attribute values for resources on
a particular server, with a particular cardinality value, and with
a particular degree value. This method can be useful for
applications that are somehow tied to a particular server.
Following the -attr flag, the syntax is as follows:
attribute_name{@SERVERNAME(server_name)
[@DEGREEID(did)] | @CARDINALITYID(cid)
[@DEGREEID(did)]}=attribute_value
If you specify the @SERVERNAME(server_name) syntax, then the
attribute value you specify for the attribute you specify is
limited to resources residing on the server you specify.
Alternatively, if you specify the @CARDINALITYID(cid) syntax,
then the attribute value you specify for the attribute you specify
is limited to resource instances with a specific cardinality ID
(cid).
Optionally, you can combine the @DEGREEID(did) syntax with
either the SERVERNAME or CARDINALITYID syntax, or both, to
limit the attribute value to resources with the specific DEGREE.
Examples:
CHECK_INTERVAL@SERVERNAME(node1)=45
STOP_TIMEOUT@CARDINALITYID(2)=65
STOP_TIMEOUT@SERVERNAME(node1)@DEGREEID(2)=65
STOP_TIMEOUT@CARDINALITYID(3)@DEGREEID(2)=65
-group group_name Specify a resource group to which the resource belongs that you
want to evaluate.
–f Specify this parameter to evaluate what happens if you run the
command with the force parameter.
E.2.10 crsctl eval start resource
Predicts the effects of starting a resource without making changes to the system.
Syntax
crsctl eval start resource {resource_name [...] | -w "filter"}
[-n server_name] [-f]
Appendix E
Dual Environment CRSCTL Commands
E-15
Parameters
Table E-8 crsctl eval start resource Command Parameters
Parameter Description
resource_name [...] Specify one or more space-delimited resource names to start.
-w "filter" Specify a resource filter surrounded by double quotation marks ("")
that Oracle Clusterware uses to match resources. For example, -w
"TYPE = ora.database.type" or -w "NAME = cs1".
See Also: "Filters" for more information
-n server_name Specify the name of the server on which the resources you want to
start reside. If you do not specify a server, then Oracle Clusterware
starts the resources on the best server according to the attribute
profile of each resource.
–f Use the -f parameter to relocate a resource running on another
server on which the resource you want to start has a hard start
dependency. If you do not specify the force parameter in this case,
then the start command fails.
E.2.11 crsctl eval stop resource
Predicts the effect of stopping a resource without making changes to the system.
Syntax
crsctl eval stop resource {resource_name [...] | -w "filter"} [-f]
Parameters
Table E-9 crsctl eval stop resource Command Parameters
Parameter Description
resource_name [...] Specify one or more space-delimited resource names to stop.
-w "filter" Specify a resource filter that Oracle Clusterware uses to limit the
number of resources stopped. The filter must be enclosed in double
quotation marks (""). Examples of resource filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to stop only resources of cluster_resource type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to stop resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to stop resources that have a value greater
than 10 for the CHECK_INTERVAL resource attribute and the
name of the resource contains the number 2
See Also: Filters for more information
–f Specify the -f parameter to force the stopping of the resource
when it has other resources running that depend on it. Dependent
resources are relocated or stopped when you use this parameter.
Appendix E
Dual Environment CRSCTL Commands
E-16
E.2.12 crsctl getperm resource
Displays the user and group permissions for the specified resource.
Syntax
crsctl getperm resource resource_name [{-u user_name | -g group_name}]
Parameters
Table E-10 crsctl getperm resource Command Parameters
Parameter Description
resource_name Specify the name of the resource for which you want to obtain
permissions.
-u user_name If you specify -u, then Oracle Clusterware obtains permissions for a
particular user.
-g group_name If you specify -g, then Oracle Clusterware obtains permissions for a
particular group.
Usage Notes
• The resource_name parameter is required
• You must have read permission on the specified resources to obtain their
permissions
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources
See Also:
Oracle Clusterware Resource Reference for more information about resources
and resource attributes
Examples
The crsctl getperm resource command returns output similar to the following,
depending on the command option you choose:
$ crsctl getperm resource app.appvip
Name: app.appvip
owner:root:rwx,pgrp:oinstall:rwx,other::r--
$ crsctl getperm resource app.appvip -u oracle
Name: app.appvip
rwx
$ crsctl getperm resource app.appvip -g dba
Appendix E
Dual Environment CRSCTL Commands
E-17
Name: app.appvip
r--
E.2.13 crsctl modify resource
Modifies the attributes of a particular resource in Oracle Clusterware.
Syntax
crsctl modify resource resource_name -attr "attribute_name=attribute_value"
[-i] [-f] [-delete] [-group group_name] [-env "env1=val1,env2=val2,..."]
Parameters
Table E-11 crsctl modify resource Command Parameters
Parameter Description
resource_name The name of the resource you want to modify.
-attr "attribute_name=
attribute_value"
You can specify attributes for a resource you want to modify in two
different ways:
• Following the -attr flag, you can specify one or more commadelimited
attribute name-value pairs to modify enclosed in
double quotations marks (""). For example:
-attr "CHECK_INTERVAL=30, START_TIMEOUT=25"
Some attributes can have multiple values. In those cases,
separate the values with a space and enclose the list of values
in single quotation marks. For example:
-attr "SERVER_POOL_NAMES=
'ora.pool1 ora.pool2',START_TIMEOUT=25"
• Alternatively, you can specify attribute values for resources on
a particular server, with a particular cardinality value, and with
a particular degree value. This method can be useful for
applications that are somehow tied to a particular server.
Following the -attr flag, the syntax is as follows:
attribute_name{@SERVERNAME(server_name)
[@DEGREEID(did)] | @CARDINALITYID(cid)
[@DEGREEID(did)]}=attribute_value
If you specify the @SERVERNAME(server_name) syntax, then the
attribute value you specify for the attribute you specify is
limited to resources residing on the server you specify.
Alternatively, if you specify the @CARDINALITYID(cid) syntax,
then the attribute value you specify for the attribute you specify
is limited to resource instances with a specific cardinality ID
(cid).
Optionally, you can combine the @DEGREEID(did) syntax with
either the SERVERNAME or CARDINALITYID syntax, or both, to
limit the attribute value to resources with the specific DEGREE.
Examples:
CHECK_INTERVAL@SERVERNAME(node1)=45
STOP_TIMEOUT@CARDINALITYID(2)=65
STOP_TIMEOUT@SERVERNAME(node1)@DEGREEID(2)=65
STOP_TIMEOUT@CARDINALITYID(3)@DEGREEID(2)=65
Appendix E
Dual Environment CRSCTL Commands
E-18
Table E-11 (Cont.) crsctl modify resource Command Parameters
Parameter Description
-i If you specify -i, then CRSCTL returns an error if processing this
command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
-f Use the -f parameter when:
• The resource has a hard dependency on a non-existing
resource
• The owner of the resource does not have execute permissions
on one or more hard dependencies
• The modification results in servers being moved into the
Generic pool and resources being stopped or relocated to
accomplish the server move
-delete If you specify the -delete parameter, then Oracle Clusterware
deletes the named attribute.
-group group_name Specify a resource group to which the resource belongs. The
resource group must exist, and the resource cannot be a member
of any other explicit resource group. If you do not specify a
resource group, then CRSCTL adds the resource to a resource
group with the same name as the resource.
-env
"env1=val1,env2=val2,.
.."
You can optionally override one or more resource profile attribute
values for this command. If you specify multiple environment namevalue
pairs, then you must separate each pair with a comma and
enclose the entire list in double quotation marks ("").
Usage Notes
• The resource_name parameter is required
• If an attribute value for an attribute name-value pair contains commas, then the
value must be enclosed in single quotation marks (''). For example:
"START_DEPENDENCIES='hard(res1,res2,res3)'"
• You must have read and write permissions on the specified resources to modify
them
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources
Example
To modify the attributes of the appsvip resource:
$ crsctl modify resource appsvip -attr USR_ORA_VIP=10.1.220.17 -i
Related Topics:
• Oracle Clusterware Resource Reference
E.2.14 crsctl relocate resource
Relocates resources to another server in the cluster.
Appendix E
Dual Environment CRSCTL Commands
E-19
Syntax
crsctl relocate resource {resource_name [-k cid] | -all | -w "filter"} -s
source_server |
[-n destination_server] [-env "env1=val1,env2=val2,..."] [-i] [-f]
Parameters
Table E-12 crsctl relocate resource Command Parameters
Parameter Description
resource_name Specify the name of a resource you want to relocate.
-k cid Optionally, you can specify the resource cardinality ID. If you
specify this parameter, then CRSCTL relocates the resource
instance that has the cardinality you specify.
-all Alternatively, you can use this parameter to specify all resources
for relocation.
-w "filter" Alternative to using -k or -all, you can specify a resource filter that
CRSCTL uses to limit the number of resources relocated. The filter
must be enclosed in double quotation marks (""). Examples of
resource filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to relocate only resources of cluster_resource
type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to relocate resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to relocate resources that have a value
greater than 10 for the CHECK_INTERVAL resource attribute and
the name of the resource contains the number 2
See Also: "Filters" for more information
-s source_server Specify a particular server from which you want to relocate the
resources.
-n destination_server Specify the name of the server to which you want relocate
resources. If you do not specify a destination server, then CRSCTL
relocates the resources to the best server according to the attribute
profile of each resource.
-env
"env1=val1,env2=val2,.
.."
You can optionally override one or more resource profile attribute
values for this command. If you specify multiple environment namevalue
pairs, then you must separate each pair with a comma and
enclose the entire list in double quotation marks ("").
–i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
Appendix E
Dual Environment CRSCTL Commands
E-20
Table E-12 (Cont.) crsctl relocate resource Command Parameters
Parameter Description
–f Specify the -f parameter to force the relocation of the resource
when it has other resources running that depend on it. CRSCTL
stops or relocates dependent resources when you use this
parameter.
Note: When you are relocating resources that have cardinality
greater than 1, you must use either -k or -s to narrow down which
resource instances are to be relocated.
Usage Notes
• Any one of the three following options is required to specify which resources you
want to relocate:
– You can specify one particular resource to relocate.
– Or you can specify one particular or all the resources to relocate from a
particular source server.
– Thirdly, you can specify a resource filter that CRSCTL uses to match
resources to relocate.
• If a resource has a degree ID greater than 1, then CRSCTL relocates all instances
of the resource.
• You must have read and execute permissions on the specified resources to
relocate them
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources.
Examples
To relocate one particular resource from one server to another:
# crsctl relocate resource myResource1 -s node1 -n node3
E.2.15 crsctl restart resource
Restarts idle resources in the cluster, instead of having to run two commands to stop
and start the resource.
Syntax
crsctl restart resource {resource_name [...] | -w "filter"} [-k cid] [-d did]
[-env "env1=val1,env2=val2,..."] [-i] [-f]
Parameters
Table E-13 crsctl restart resource Command Parameters
Parameter Description
resource_name [...] Specify one or more space-delimited names of resources you want
to restart.
Appendix E
Dual Environment CRSCTL Commands
E-21
Table E-13 (Cont.) crsctl restart resource Command Parameters
Parameter Description
-w "filter" Specify a resource filter surrounded by double quotation marks ("")
that Oracle Clusterware uses to match resources. For example, -w
"TYPE = ora.database.type" or -w "NAME = cs1".
See Also: "Filters" for more information
-k cid Specify the resource cardinality ID. If you specify this parameter,
then Oracle Clusterware restarts the resource instances that have
the cardinality you specify.
-d did Specify the resource degree ID. If you specify this parameter and
the degree ID is greater than 1, then Oracle Clusterware restarts all
resource instances that meet this criteria.
Note: You cannot use the -d parameter without specifying the -k
parameter.
-env
"env1=val1,env2=val2,.
.."
You can optionally override one or more resource profile attribute
values with the -env command parameter. If you specify multiple
environment name-value pairs, then you must separate each pair
with a comma and enclose the entire list in double quotation marks
("").
-i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
–f Use the -f parameter to relocate a resource running on another
server on which the resource you want to restart has a hard start
dependency. If you do not specify the force parameter in this case,
then the start command fails.
Usage Notes
• Either of the following options is required to specify which resources you want to
restart:
– You can specify one or more resources by name to restart
– You can specify a resource filter that Oracle Clusterware uses to match
resources to restart
• You must have read and execute permissions on the specified resources to restart
them
• Do not use this command to restart any resources with names that begin with ora
because these resources are Oracle resources
E.2.16 crsctl setperm resource
Sets permissions for a particular resource.
Syntax
crsctl setperm resource resource_name {-u acl_string | -x acl_string |
-o user_name | -g group_name}
Appendix E
Dual Environment CRSCTL Commands
E-22
Parameters
Table E-14 crsctl setperm resource Command Parameters
Parameter Description
resource_name Specify the name of the resource for which you want to set
permissions.
-u | -x | -o | -g You can set only one of the following permissions for a resource:
• -u acl_string: You can update the access control list (ACL)
for a resource
• -x acl_string: You can delete the ACL for a resource
• -o user_name: You can change the owner of a resource by
entering a user name
• -g group_name: You can change the primary group of a
resource by entering a group name
Specify a user, group, or other ACL string, as follows:
user:user_name[:readPermwritePermexecPerm] |
group:group_name[:readPermwritePermexecPerm] |
other[::readPermwritePermexecPerm]
• user: User ACL
• group: Group ACL
• other: Other ACL
• readPerm: Read permission for the resource; the letter r grants
a user, group, or other read permission, the minus sign (-)
denies read permission
• writePerm: Write permission for the resource; the letter w
grants a user, group, or other write permission, the minus sign
(-) denies write permission
• execPerm: Execute permission for the resource; the letter x
grants a user, group, or other execute permission, the minus
sign (-) denies execute permission
See Also:
Oracle Clusterware Resource Reference for more information about resources
and resource attributes
Usage Notes
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources.
• You must have read and write permissions on the specified resources to set their
permissions
Examples
To grant read, write, and execute permissions on a resource for user Scott:
$ crsctl setperm resource myResource -u user:scott:rwx
Appendix E
Dual Environment CRSCTL Commands
E-23
E.2.17 crsctl start resource
Starts idle resources on a particular server in the cluster.
Syntax
crsctl start resource {resource_name [...] | -w "filter" | -all}
[-n server_name | -s server_pool_names] [-k cid] [-d did]
[-env "env1=val1,env2=val2,..."] [-begin] [-end] [-i] [-f] [-l]
Parameters
Table E-15 crsctl start resource Command Parameters
Parameter Description
resource_name [...] Specify one or more space-delimited names of resources you want
to start.
-w "filter" Specify a resource filter surrounded by double quotation marks ("")
that Oracle Clusterware uses to match resources. For example, -w
"TYPE = ora.database.type" or -w "NAME = cs1".
See Also: "Filters" for more information
–all Use this parameter to start all resources in the cluster.
-n server_name Specify the name of the server on which the resources you want to
start reside. If you do not specify a server, then Oracle Clusterware
starts the resources on the best server according to the attribute
profile of each resource.
-s server_pool_names Specify a single server pool name or a space-delimited list of
server pools in which a resource resides that you want to start.
-k cid Specify the resource cardinality ID. If you specify this parameter,
then Oracle Clusterware starts the resource instances that have the
cardinality you specify.
-d did Specify the resource degree ID. If you specify this parameter and
the degree ID is greater than 1, then Oracle Clusterware starts all
resource instances that meet this criteria.
Note: You cannot use the -d parameter without specifying the -k
parameter.
-env
"env1=val1,env2=val2,.
.."
You can optionally override one or more resource profile attribute
values with the -env command parameter. If you specify multiple
environment name-value pairs, then you must separate each pair
with a comma and enclose the entire list in double quotation marks
("").
-begin You can specify this parameter to begin a transparent HA action.
-end You can specify this parameter to end a transparent HA action.
–i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
Appendix E
Dual Environment CRSCTL Commands
E-24
Table E-15 (Cont.) crsctl start resource Command Parameters
Parameter Description
–f Use the -f parameter to relocate a resource running on another
server on which the resource you want to start has a hard start
dependency. If you do not specify the force parameter in this case,
then the start command fails.
–l Use the -l parameter to leave the resources in the state they were
in if the start command fails.
Usage Notes
• Any one of the three following options is required to specify which resources you
want to start:
– You can specify one or more resources to start
– You can specify a resource filter that Oracle Clusterware uses to match
resources to start
– You can specify the -all parameter to start all resources on the specified
server
• You must have read and execute permissions on the specified resources to start
them
• Do not use this command to start any resources with names that begin with ora
because these resources are Oracle resources
• Oracle does not support starting managed applications outside of the Oracle Grid
Infrastructure
Example
To start a resource:
# crsctl start resource myResource -n server1
E.2.18 crsctl status resource
Obtains the status and configuration information of any number of particular resources.
Syntax
crsctl status resource resource_name [...] | -w "filter" [-p | -v] | [-f | -l
| -g] [[-k cid | -n server_name] [ -e [-p | -v]] [-d did]] | [-s -k cid
[-d did]] [-p [-attr attribute_name[,...] [-noname]]
To print the status of the resources in tabular form:
crsctl status resource resource_name [...] | -w "filter" -t
To print a list of the resource dependencies:
crsctl status resource [resource_name [...]] -dependency [-stop | -pullup]
Appendix E
Dual Environment CRSCTL Commands
E-25
Parameters
Table E-16 crsctl status resource Command Parameters
Parameter Description
resource_name [...] |
-w "filter"
Specify one or more space-delimited names of resources of which
you want to check the status.
Optionally, you can specify a resource filter that CRSCTL uses to
limit the number of resources displayed. The filter must be
enclosed in double quotation marks (""). Values that contain
parentheses or spaces must be enclosed in single quotation marks
(''). Operators must be surrounded by spaces. Examples of
resource filters include:
• "TYPE == cluster_resource": This filter limits the display to
only resources of cluster_resource type.
• "CHECK_INTERVAL > 10": This filter limits the display to
resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
the display to resources that have a value greater than 10 for
the CHECK_INTERVAL resource attribute and the name of the
resource contains the number 2.
• "START_DEPENDENCIES='hard(appsvip)'": This filter limits the
display to resources that have a hard start dependency on the
appsvip resource.
See Also: "Filters" for more information
[-p | -v] | [-f | -l |
-g]
You can optionally specify the following parameters:
• Specify either the -p parameter to display the static
configuration of the resource or the -v parameter to display the
run-time configuration of the resource.
• Specify the -f parameter to display the full configuration of the
resource; or specify the -l parameter to display all cardinal
and degree values of the resource; or specify the -g parameter
to check whether the specified resources are registered
[[-k cid | -n
server_name] [ -e [-p
| -v]] [-d did | [-s -
k cid [-d did]]]
You can specify one of the following two options:
• Specify the -k cid parameter to specify a cardinality ID of the
resources you want to query. Or you can specify the -n
parameter to specify a particular server on which to check
resources. Optionally, you can specify the -d parameter with
the -n parameter to specify the degree ID of resources you
want to check. If you specify a degree ID greater than 1, then
Oracle Clusterware checks all resource instances on the
server that meet this criteria.
Use the -e parameter to evaluate the special values of a
resource instance. You must also specify -p or -v with the -e
parameter.
• Specify the -s parameter with the -k parameter to obtain a list
of target servers for relocation. You can further limit the output
by specifying a degree ID with the -d parameter.
–t Specify the -t parameter to display the output in tabular form.
Appendix E
Dual Environment CRSCTL Commands
E-26
Table E-16 (Cont.) crsctl status resource Command Parameters
Parameter Description
-p [-attr
attribute_name[,...]
[-noname]
Specify -attr (followed by a single attribute name or a commadelimited
list of attribute names) or -noname following -p to either
print specific attributes or bypass the default printing of the
resource name, respectively.
-dependency [-stop | -
pullup]
Specify the -dependency parameter to display resource
dependencies. If you do not specify either the -stop or -pullup
option, then CRSCTL displays the start dependencies of the
resource.
Use either of the following options with the -dependency parameter:
• Specify the -stop parameter to display resource stop
dependencies.
• Specify the -pullup parameter to display resource pull up
dependencies.
Usage Notes
• Either a space-delimited list of resources or a resource filter is required.
• You must have read permissions on the specified resources to obtain their status.
• Use crsctl status resource to query the status information of any resource
deployed in the cluster. Oracle recommends, however, that you use the respective
SRCVTL command to query the status information of Oracle (ora.*) resources.
Examples
The crsctl status resource command returns output similar to the following:
$ crsctl status resource ora.staii14.vip
NAME=ora.staii14.vip
TYPE=ora.cluster_vip_net1.type
TARGET=ONLINE
STATE=ONLINE on staii14
The following example shows the start dependencies for a resource named
ora.newdb.db:
$ crsctl status resource ora.newdb.db -dependency ora.newdb.db(ora.database.type)
ora.ACFS_DG1.dg(ora.diskgroup.type)[hard,pullup]
ora.asm(ora.asm.type)[hard,pullup]
ora.LISTENER.lsnr(ora.listener.type)[weak]
type:ora.cluster_vip_net1.type[hard:type,pullup:type]
ora.net1.network(ora.network.type)[hard,pullup]
ora.dbhome_dg.dbhome_dg_v.acfs(ora.acfs.type)[hard,pullup]
ora.asm(ora.asm.type)[pullup:always]
E.2.19 crsctl stop resource
Stops running resources.
Appendix E
Dual Environment CRSCTL Commands
E-27
Syntax
crsctl stop resource {resource_name [...] | -w "filter" | -all} [-n server_name
| -s server_pool] [-k cid] [-d did] [-env "env1=val1,env2=val2,..."]
[-begin | -end] [-i] [-f] [-l]
Parameters
Table E-17 crsctl stop resource Command Parameters
Parameter Description
resource_name [...] Alternative to using -w or -all, you can specify one or more spacedelimited
resource names that you want to stop.
-w "filter" Alternative to specifying a resource name or using -all, you can
specify a resource filter that CRSCTL uses to limit the number of
resources stopped. The filter must be enclosed in double quotation
marks (""). Examples of resource filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to stop only resources of cluster_resource type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to stop resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to stop resources that have a value greater
than 10 for the CHECK_INTERVAL resource attribute and the
name of the resource contains the number 2
See Also: "Filters" for more information
-all Alternative to specifying a resource name or using -w, you can use
this parameter to stop all resources in the cluster.
-n server_name | -s
server_pool
Optionally, you can specify the name of the server on which the
resource instances you want to stop reside, or the name of a server
pool in which the resource instances you want to stop reside. If you
do not specify a server or server pool, then CRSCTL stops all
instances of the resource.
-k cid Optionally, you can specify the resource cardinality ID. If you
specify this parameter, then CRSCTL stops the resource instances
that have the cardinality you specify.
-d did Specify the resource degree ID. If you specify this parameter and
the degree ID is greater than 1, then CRSCTL stops all resource
instances that meet this criteria.
-env
"env1=val1,env2=val2,.
.."
You can optionally override one or more resource profile attribute
values with the -env command parameter. If you specify multiple
environment name-value pairs, then you must separate each pair
with a comma and enclose the entire list in double quotation marks
("").
-begin | -end Optionally, you can specify either of these parameters to begin or
end a transparent HA action, respectively.
–i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
Appendix E
Dual Environment CRSCTL Commands
E-28
Table E-17 (Cont.) crsctl stop resource Command Parameters
Parameter Description
–f Specify the -f parameter to force the stopping of the resource
when it has other resources running that depend on it. Dependent
resources are relocated or stopped when you use this parameter.
–l Use the -l parameter to leave the resources in the state they were
in if the stop command fails.
Usage Notes
• Any one of the three following options is required to specify which resources you
want to stop:
– You can specify by name one or more resources to stop.
– You can specify a resource filter that CRSCTL uses to match resources to
stop
– You can specify the -all parameter to stop all resources on a particular server
• You must have read and execute permissions on the specified resources to stop
them
• Do not use this command for any resources with names that begin with ora
because these resources are Oracle resources
• Oracle does not support stopping managed applications outside of the Oracle Grid
Infrastructure
Example
To stop a resource:
$ crsctl stop resource -n node1 -k 2
E.2.20 crsctl add resourcegroup
Creates a resource group based on a resource group type.
Use this command to create an empty resource group into which you can add
resources.
Syntax
crsctl add resourcegroup group_name –type group_type
[[-file file_path] | [-attr "attribute_name=
attribute_value"]] [-f] [-i]
Parameters
Table E-18 crsctl add resourcegroup Command Parameters
Parameter Description
group_name Specify the name of the resource group.
–type group_type Specify a group type for the resource group.
Appendix E
Dual Environment CRSCTL Commands
E-29
Table E-18 (Cont.) crsctl add resourcegroup Command Parameters
Parameter Description
-file file_path | -
attr
"attribute_name=attrib
ute_value[,...]"
Provide either a file or a list of attributes that define the resource
group.
Path name (either absolute or relative) for a text file containing linedelimited
attribute name-value pairs that define the resource group.
Following the -attr flag, you can specify one or more commadelimited
attribute name-value pairs enclosed in double quotations
marks ("").
–f Use this parameter to add a resource group that is online.
–i If you specify -i, then CRSCTL returns an error if processing this
command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
E.2.21 crsctl check resourcegroup
Initiates a check operation on all member resources of the specified groups.
Syntax
crsctl check resourcegroup {group_name [...] | -w "filter"}
[-n server_name] [-k cid]
Parameters
Table E-19 crsctl check resourcegroup Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to check.
-w "filter" Alternatively, you can specify a resource group filter surrounded by
double quotation marks ("") that Oracle Clusterware uses to match
resource groups. For example, -w "TYPE = ora.database.type"
or -w "NAME = cs1".
See Also: Filters for more information about using filters.
-n server_name Optionally, you can specify the name of the server on which the
resource group you want to check resides.
-k cid Optionally, you can specify the resource group cardinality ID. If you
specify this parameter, then Oracle Clusterware checks the
resource instances that have the cardinality you specify.
E.2.22 crsctl delete resourcegroup
Deletes one or more resource groups from Oracle Clusterware.
Syntax
crsctl delete resourcegroup {"group_name [...]" | -w "filter"} [-f] [-i]
Appendix E
Dual Environment CRSCTL Commands
E-30
Parameters
Table E-20 crsctl delete resourcegroup Command Parameters
Parameter Description
group_name Specify one or more group names that you want to delete. Multiple
groups must be space-delimited and enclosed in double quotation
marks ("").
-w "filter" Specify a resource filter that Oracle Clusterware uses to limit the
number of resources evaluated for deletion. The filter must be
enclosed in double quotation marks (""). Examples of resource
filters include:
• "TYPE == cluster_resource": This filter limits Oracle
Clusterware to relocate only resources of cluster_resource
type
• "CHECK_INTERVAL > 10": This filter limits Oracle Clusterware
to relocate resources that have a value greater than 10 for the
CHECK_INTERVAL resource attribute
• "(CHECK_INTERVAL > 10) AND (NAME co 2)": This filter limits
Oracle Clusterware to relocate resources that have a value
greater than 10 for the CHECK_INTERVAL resource attribute and
the name of the resource contains the number 2
Note: All operators must be surrounded by spaces.
See Also: Filters for more information about operators
-f Use this parameter to delete a resource group that is online.
-i If you specify -i, then CRSCTL returns an error if processing this
command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
Usage Notes
• You must specify either a group name (or several group names) or a resource
filter.
• You can only delete a resource group if no other resource groups have
dependencies to it.
E.2.23 crsctl eval add resourcegroup
Predicts the effects of adding a resource group without making changes to the system.
Syntax
crsctl eval add resourcegroup group_name -type group_type [-file file_path
| -attr "attribute_name=attribute_value[,...]"] [-f]
Appendix E
Dual Environment CRSCTL Commands
E-31
Parameters
Table E-21 crsctl eval add resourcegroup Command Parameters
Parameter Description
group_name Specify the name of the resource group.
-type group_type Specify a group type for the resource group.
-file file_path | -
attr
"attribute_name=attrib
ute_value[,...]"
Provide either a file or a list of attributes that define the resource
group.
Path name (either absolute or relative) for a text file containing linedelimited
attribute name-value pairs that define the resource group.
Following the -attr flag, you can specify one or more commadelimited
attribute name-value pairs enclosed in double quotations
marks ("").
–f Use this parameter to add a resource group that is online.
E.2.24 crsctl eval fail resourcegroup
Predicts the consequences of a resource failing.
Syntax
crsctl eval fail resourcegroup {group_name | -w filter} [-n server]
[-env "attr=val[,...]"]
Parameters
Table E-22 crsctl eval fail resourcegroup Command Parameters
Parameter Description
group_name Specify the name of a resource group you want to evaluate.
-w filter Alternative you specifying a particular resource group, you can
specify a resource group filter surrounded by double quotation
marks ("") that CRSCTL uses to match resource groups. For
example, -w "TYPE = ora.database.type" or -w "NAME = cs1".
See Also: Filters for more information about filters
-n server Optionally, you can specify the name of the server to which
resource groups reside that you want to evaluate.
-env "attr=val[,...]" You can optionally override one or more resource group profile
attribute values with the -env command parameter. If you specify
multiple environment name-value pairs, then you must separate
each pair with a comma and enclose the entire list in double
quotation marks ("").
E.2.25 crsctl eval relocate resourcegroup
Predicts the effect of relocating a resource group without making changes to the
system.
Appendix E
Dual Environment CRSCTL Commands
E-32
Syntax
crsctl eval relocate resourcegroup {group_name | -all} -s server | -w filter}
{-n server} [-f]
Parameters
Table E-23 crsctl eval relocate resourcegroup Command Parameters
Parameter Description
group_name Specify the name of a resource group that you want to evaluate.
-all Alternative to specifying a particular resource group, you can use
this parameter to evaluate relocating all resource groups.
-s server Specify the name of the source server on which the resource group
resides that you want to relocate. This parameter is required.
-w filter Alternative to specifying a particular resource group, you can
specify a resource group filter surrounded by double quotation
marks ("") that CRSCTL uses to match resource groups. For
example, -w "TYPE = ora.database.type" or -w "NAME = cs1".
This parameter is required if you do not use -s.
See Also: Filters for more information about filters
-n server Specify the name of the server to which you want to relocate the
resource groups. This parameter is required.
–f Use this parameter to evaluate the operation with the force option.
E.2.26 crsctl eval start resourcegroup
Predicts the effects of starting a resource group without making changes to the
system.
Syntax
crsctl eval start resourcegroup {group_name | -w filter} [-n server] [-f]
Parameters
Table E-24 crsctl eval start resourcegroup Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to evaluate. This parameter is
required.
-w filter Alternatively, you can specify a resource group filter surrounded by
double quotation marks ("") that CRSCTL uses to match resource
groups. For example, -w "TYPE = ora.database.type" or -w
"NAME = cs1". This parameter is required if you do not specify a
particular resource group.
See Also: Filters for more information about filters
-n server Specify the name of the server on which the resource group you
want to evaluate resides.
Appendix E
Dual Environment CRSCTL Commands
E-33
Table E-24 (Cont.) crsctl eval start resourcegroup Command Parameters
Parameter Description
–f Use the -f parameter to evaluate a resource group on a server on
which one of the resources in the resource group you want to start
has a hard start dependency.
E.2.27 crsctl eval stop resourcegroup
Predicts the effect of stopping a resource group without making changes to the
system.
Syntax
crsctl eval stop resourcegroup {group_name | -w filter} [-f]
Parameters
Table E-25 crsctl eval stop resourcegroup Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to stop.
-w "filter" Alternative to specifying a resource group, you can specify a
resource group filter surrounded by double quotation marks ("")
that CRSCTL uses to match resource groups. For example, -w
"TYPE = ora.database.type" or -w "NAME = cs1".
See Also: Filters for more information about using filters.
–f Use the -f parameter to stop a resource running on another server
on which one of the resources in the resource group you want to
stop has a hard stop dependency.
E.2.28 crsctl export resourcegroup
Exports the complete information and attributes of a resource groups and its member
resources to a script file.
This command also exports configuration information of the resource group type and
member resource types. You can run the script file on another cluster to import the
resource group configuration.
Syntax
crsctl export resourcegroup [group_name [...]] –file file_name
Appendix E
Dual Environment CRSCTL Commands
E-34
Parameters
Table E-26 crsctl export resource Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to export.
–file file_name Specify a name for the output script file that you will run to import
the group.
E.2.29 crsctl modify resourcegroup
Modifies a resource group to add attributes or update the values of existing attributes.
Syntax
crsctl modify resourcegroup group_name -attr "attribute_name=
attribute_value"} [-i] [-f] [-delete]
Parameters
Table E-27 crsctl modify resourcegroup Command Parameters
Parameter Description
group_name Specify the name of the resource group you want to modify.
Appendix E
Dual Environment CRSCTL Commands
E-35
Table E-27 (Cont.) crsctl modify resourcegroup Command Parameters
Parameter Description
-attr "attribute_name=
attribute_value"
You can specify attributes for a resource group you want to modify
in two different ways:
• Following the -attr flag, you can specify one or more commadelimited
attribute name-value pairs to modify enclosed in
double quotations marks (""). For example:
-attr "CHECK_INTERVAL=30, START_TIMEOUT=25"
Some attributes can have multiple values. In those cases,
separate the values with a space and enclose the list of values
in single quotation marks. For example:
-attr "SERVER_POOL_NAMES=
'ora.pool1 ora.pool2',START_TIMEOUT=25"
• Alternatively, you can specify attribute values for resources on
a particular server, with a particular cardinality value, and with
a particular degree value. This method can be useful for
applications that are somehow tied to a particular server.
Following the -attr flag, the syntax is as follows:
attribute_name{@SERVERNAME(server_name)
[@DEGREEID(did)] | @CARDINALITYID(cid)
[@DEGREEID(did)]}=attribute_value
If you specify the @SERVERNAME(server_name) syntax, then the
attribute value you specify for the attribute you specify is
limited to resources residing on the server you specify.
Alternatively, if you specify the @CARDINALITYID(cid) syntax,
then the attribute value you specify for the attribute you specify
is limited to resource instances with a specific cardinality ID
(cid).
Optionally, you can combine the @DEGREEID(did) syntax with
either the SERVERNAME or CARDINALITYID syntax, or both, to
limit the attribute value to resources with the specific DEGREE.
Examples:
CHECK_INTERVAL@SERVERNAME(node1)=45
STOP_TIMEOUT@CARDINALITYID(2)=65
STOP_TIMEOUT@SERVERNAME(node1)@DEGREEID(2)=65
STOP_TIMEOUT@CARDINALITYID(3)@DEGREEID(2)=65
–i If you specify -i, then CRSCTL returns an error if processing this
command requires waiting for Oracle Clusterware to unlock the
resource group or its dependents. Sometimes, Oracle Clusterware
locks resource groups or other objects to prevent commands from
interfering with each other.
–f Use the -f parameter when:
• The resource group has a hard dependency on a non-existing
resource.
• The owner of the resource group does not have execute
permissions on one or more hard dependencies.
• The modification results in servers being moved into the
Generic pool and resources being stopped or relocated to
accomplish the server move.
Appendix E
Dual Environment CRSCTL Commands
E-36
Table E-27 (Cont.) crsctl modify resourcegroup Command Parameters
Parameter Description
–delete If you specify the -delete parameter, then Oracle Clusterware
deletes the named attribute.
Usage Notes
You can modify the name of the resource group and add or change existing attributes.
E.2.30 crsctl relocate resourcegroup
Relocates online resource groups from a source server to a target server.
This command first stops the resource groups you specify on the source server and
then starts them on the target server.
Syntax
crsctl relocate resourcegroup {group_name [...] [-k cid] | -all | -w "filter"}
[-env "attr=val[,...]"] [-f] [-i]
Parameters
Table E-28 crsctl relocate resourcegroup Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to relocate.
-k cid Optionally, you can specify the resource group cardinality ID. If you
specify this parameter, then CRSCTL relocates the resource
instances that have the cardinality you specify.
-all Specify this parameter to relocate all resource groups on the
source server.
-w "filter" Specify a resource group filter surrounded by double quotation
marks ("") that CRSCTL uses to match resource groups. For
example, -w "TYPE = ora.database.type" or -w "NAME = cs1".
See Also: Filters for more information about filters
-s source_server_name Specify the name of the source server on which the resource
groups reside that you want to relocate. This parameter is required.
-n target_server_name Optionally, you can specify the name of the server to which you
want to relocate the resource groups. If you do not specify a target
server, then CRSCTL relocates the resource groups on the best
server according to the attribute profile of each resource group.
-env "attr=val[,...]" You can optionally override one or more resource group profile
attribute values with the -env command parameter. If you specify
multiple environment name-value pairs, then you must separate
each pair with a comma and enclose the entire list in double
quotation marks ("").
–f Specify this option force the relocation of the resource groups you
specify.
Appendix E
Dual Environment CRSCTL Commands
E-37
Table E-28 (Cont.) crsctl relocate resourcegroup Command Parameters
Parameter Description
–i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
Example
To relocate all resource groups running on node1 to node2:
$ crsctl relocate resourcegroup resGrp1 -s node1 -n node2
E.2.31 crsctl restart resourcegroup
Restarts resource groups on the server where they currently reside.
Syntax
crsctl restart resourcegroup {group_name [...] | -w "filter"} [-k cid]
[-env "env1=val1,env2=val2,..."] [-f] [-i]
Parameters
Table E-29 crsctl restart resourcegroup Command Parameters
Parameters Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to restart.
-w "filter" Specify a resource group filter surrounded by double quotation
marks ("") that Oracle Clusterware uses to match resource groups.
For example, -w "TYPE = ora.database.type" or -w "NAME =
cs1".
See Also: Filters for more information about filters
-k cid Specify the resource group cardinality ID. If you specify this
parameter, then Oracle Clusterware restarts the resource instances
that have the cardinality you specify.
-env
"env1=val1,env2=val2,.
.."
You can optionally override one or more resource group profile
attribute values with the -env command parameter. If you specify
multiple environment name-value pairs, then you must separate
each pair with a comma and enclose the entire list in double
quotation marks ("").
–f Use the -f parameter to restart a resource, running on the server
on which the resource group resides that you want to restart, that
has a hard start dependency on another resource. If you do not
specify the force parameter in this case, then the start command
fails.
Appendix E
Dual Environment CRSCTL Commands
E-38
Table E-29 (Cont.) crsctl restart resourcegroup Command Parameters
Parameters Description
–i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
Example
The following command restarts resource group resGrp1:
$ crsctl restart resourcegroup resGrp1
E.2.32 crsctl start resourcegroup
Starts one or more resource groups on specific or preconfigured servers or server
pools.
CRSCTL starts resource groups to which there is a hard or weak start dependency,
and all enabled member resources of the group. This command reports progress
messages for each resource and resource group that CRSCTL starts.
Syntax
crsctl start resourcegroup {group_name [...] | -w "filter"] | -all}
[-n server_name | -s server_pool] [-k cid] [-env "attr=val[,..."]]
[-f] [-i] [-l]
Parameters
Table E-30 crsctl start resourcegroup Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to start.
-w "filter" Specify a resource group filter surrounded by double quotation
marks ("") that CRSCTL uses to match resource groups. For
example, -w "TYPE = ora.database.type" or -w "NAME = cs1".
See Also: Filters for more information about filters
-all Specify this parameter to start all resource groups on the cluster.
-n server_name Specify the name of the server on which the resource group you
want to start resides. If you do not specify a server, then CRSCTL
starts the resources on the best server according to the attribute
profile of each resource.
-s server_pool Specify a single server pool name or a space-delimited list of
server pools in which a resource group resides that you want to
start.
-k cid Specify the resource group cardinality ID. If you specify this
parameter, then CRSCTL starts the resource instances that have
the cardinality you specify.
Appendix E
Dual Environment CRSCTL Commands
E-39
Table E-30 (Cont.) crsctl start resourcegroup Command Parameters
Parameter Description
-env "attr=val[,...]" You can optionally override one or more resource group profile
attribute values with the -env command parameter. If you specify
multiple environment name-value pairs, then you must separate
each pair with a comma and enclose the entire list in double
quotation marks ("").
–f Use the -f parameter to start a resource group on a server on
which one of the resources in the resource group you want to start
has a hard start dependency. If you do not specify the force
parameter in this case, then the start command fails.
–i If you specify -i, then the command returns an error if processing
this command requires waiting for Oracle Clusterware to unlock the
resource or its dependents. Sometimes, Oracle Clusterware locks
resources or other objects to prevent commands from interfering
with each other.
–l Use the -l parameter to leave the resource groups in the state they
were in if the start command fails.
Examples
To start a resource group in a server pool:
$ crsctl start resourcegroup rg1 -s pool1
E.2.33 crsctl status resourcegroup
Displays the state of resource groups.
Syntax
crsctl status resourcegroup [group_name [...] | -w "filter"]
[-p [-attr "attribute_name=attribute_value" [-noname]] | -v [-attr
"attribute_name=attribute_value"] [-noname]]] | [-f] [-l] [-g] | [[-k cid |
-n server_name] [-e [-p | -v]]] [-s -k cid] | -noauto]]
Parameters
Table E-31 crsctl status resourcegroup Command Parameters
Parameter Description
group_name Specify a resource group or a number of resource groups in a
space-delimited list that you want to query. If you do not specify a
resource group name or filters, then CRSCTL displays the status
for all resource groups.
-w "filter" Specify a resource group filter surrounded by double quotation
marks ("") that Oracle Clusterware uses to match resource groups.
For example, -w "TYPE = ora.database.type" or -w "NAME =
cs1".
See Also: Filters for more information about filters
Appendix E
Dual Environment CRSCTL Commands
E-40
Table E-31 (Cont.) crsctl status resourcegroup Command Parameters
Parameter Description
-p -attr
"attribute_name=attrib
ute_value" [-noname]
-v [-attr
"attribute_name=attrib
ute_value"] [-noname]]
Optionally, you can specify this parameter to display the status for
all member resources of a particular resource group.
–f Optionally, you can specify this parameter to display the full
configuration of the resource group.
-l
-g
-k cid Specify the resource group cardinality ID. If you specify this
parameter, then CRSCTL displays the status of the resource
groups that have the cardinality you specify.
-n server_name
–e Optionally, you can specify this parameter to exclude automatic
resource groups. The default is to display the status of all resource
groups.
-p | -v
-s -k cid
-noauto
Example
The following command shows the status of resource group rg1, which resides on
node1:
$ crsctl status resourcegroup rg1 -n node1
E.2.34 crsctl stop resourcegroup
Stops one or more resource groups on optionally specified preconfigured servers or
server pools.
CRSCTL stops all member resources of the resource group. You must use the -f to
stop the resource group if other resource groups have stop dependencies on it.
Syntax
crsctl stop resourcegroup {group_name [...] | -w "filter"] | -all}
[-n server_name | -s server_pool] [-k cid] [-env "attr=val[,...]"]
[-f] [-i] [-l]
Appendix E
Dual Environment CRSCTL Commands
E-41
Parameters
Table