This appendix contains reference information for the Oracle Clusterware Control (CRSCTL) utility.
Note:
Do not use CRSCTL commands on Oracle entities (such as resources, resource types, and server pools) that have names beginning with ora unless you are directed to do so by My Oracle Support. The Server Control utility (SRVCTL) is the correct utility to use on Oracle entities.This appendix includes the following topics:
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
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:
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.
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: Containsst: Starts withen: Ends withSupported 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
The eval command, when you use it, enables you to simulate a command without making any changes to the system. CRSCTL returns output that informs you what will happen if you run a particular command.
The eval commands available are:
Note:
CRSCTL can only evaluate third-party resources. Resources with the .ora prefix, such asora.orcl.db, must be evaluated using SRVCTL commands.See Also:
Oracle Real Application Clusters Administration and Deployment Guide for information about using SRVCTL evaluation commands
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.
Table E-1 lists deprecated commands and their replacements that you can use to perform the same or similar functionality.
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 |
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 |
You can use the following commands in either the Oracle RAC or the Oracle Restart environments:
Use the crsctl add resource command to register a resource to be managed by Oracle Clusterware. A resource can be an application process, a database, a service, a listener, and so on.
crsctl add resource resource_name -type resource_type [-file file_path | -attr "attribute_name=attribute_value,attribute_name=attribute_value,..."] [-i] [-f]
Table E-2 crsctl add resource Command Parameters
| Parameter | Description |
|---|---|
resource_name
|
A short, descriptive name for the resource. |
-type resource_type
|
The type of resource that you are adding preceded by the |
-file file_path
|
Path name (either absolute or relative) for a text file containing line-delimited attribute name-value pairs that define the resource. |
-attr "attribute_name= attribute_value |
You can specify attributes for a resource you are adding in two different ways:
|
-i |
If you specify |
-f |
Use the force parameter:
|
See Also:
Appendix B, "Oracle Clusterware Resource Reference" for more information about resources and resource attributesBoth 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 ACLsIf 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.
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)"
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"
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'"
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'"
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"
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'"
Use the crsctl add type command to create a resource type in Oracle Clusterware.
crsctl add type type_name -basetype base_type_name {-attr "ATTRIBUTE=attribute_name | -file file_path,TYPE={string | int} [,DEFAULT_VALUE=default_value][,FLAGS=typeFlags"} [-i]
Table E-3 crsctl add type Command Parameters
| Parameter | Description |
|---|---|
type_name
|
A name for the resource type in the form of |
-basetype base_type_name
|
The name of an existing base type. Any resource type that you create must either have |
-attr |
You can specify the resource type attributes using the
You cannot use multiple "ATTRIBUTE=FOO,TYPE=integer,DEFAULT_ VALUE=0,FLAGS=REQUIRED|HOTMOD,ATTRIBUTE=BAR,TYPE=string" The preceding example defines two type attributes, |
-file file_path
|
Path name (either absolute or relative) for a text file containing line-delimited resource type keyword-value pairs that define the resource type. An example of the contents of the file is: ATTRIBUTE=FOO TYPE=integer DEFAULT_VALUE=0 FLAGS=REQUIRED ATTRIBUTE=BAR TYPE=string Note: The keywords must be in the following order: The preceding example defines two type attributes, Note: All operators must be surrounded by spaces. See Also: "Filters" for more information about operators |
-i |
If you specify |
See Also:
"Resource Types" for more information about resource typesBoth the type_name and base_type_name parameters are required
You can either specify a file containing the type information or you can specify the type information on the command line
Do not use this command for any resource types with names that begin with ora because these resource types are Oracle resource types
You must have read permissions on the base type
Use the crsctl add wallet command to create and add users to a wallet.
crsctl add wallet -type wallet_type [-name name] [-user user_name -passwd]
| Parameter | Description |
|---|---|
-type wallet_type
|
Type of wallet you want to create, such as APPQOSADMIN, APPQOSUSER, APPQOSDB, OSUSER, or CVUDB.
|
-name name
|
You must specify a name for the wallet to create APPQOSDB and CVUDB wallets. |
-user user_name -passwd
|
Specify the user name you want to add to the wallet and provide the password through standard input. The user name is required to create an OSUSER wallet. |
Use the crsctl check css command to check 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.
Use the crsctl delete resource command to remove resources from the Oracle Clusterware configuration.
Table E-5 crsctl delete resource Command Parameters
| Parameter | Description |
|---|---|
resource_name
|
Specify the name of the resource you want to remove or specify a space-delimited list of multiple resources you want to remove. |
-i |
If you specify |
-f |
Use the force parameter to remove either running resources, or remove this resource even though other resources have a hard dependency on it. |
Use the crsctl delete type command to remove resource types from the Oracle Clusterware configuration.
The type_name parameter is required. You can specify more than one type by separating each type by a space.
If you specify -i, then the command fails if Oracle Clusterware cannot process the request immediately.
Do not use this command for any resource types with names that begin with ora because these resource types are Oracle resource types.
Use the crsctl delete wallet command to remove wallets or users from a wallet.
crsctl delete wallet -type wallet_type [-name name] [-user user_name]
Table E-6 crsctl delete wallet
| Parameter | Description |
|---|---|
-type wallet_type
|
Type of wallet you want to remove, such as APPQOSADMIN, APPQOSUSER, APPQOSDB, OSUSER, or CVUDB.
|
-name name
|
You must specify the name of the wallet to remove an APPQOSDB wallet. |
-user user_name
|
You must specify a user name to remove a user from an OSUSER wallet. |
To delete a user from the OSUSER wallet:
$ crsctl delete wallet -type OSUSER -user lp_oracle_home_user
In the preceding example, lp_oracle_home_user is a low-privileged Oracle home user who owns the home where the policy-managed database was created. Additionally, the command does not delete the wallet if it contains other users.
Use the crsctl eval add resource command to predict the effects of adding a resource without making changes to the system. This command may be useful to application administrators.
crsctl eval add resource resource_name -type resource_type [-attr "attribute_name=attribute_value[,attribute_name=attribute_value[,..."]] | -file file_path] [-f]
Use the crsctl eval fail resource command to predict the consequences of a resource failing.
Table E-8 crsctl eval fail resource Command Parameters
| Parameter | Description |
|---|---|
resource_name
|
The name of a resource for which you want to simulate a failure. |
-w "filter"
|
Specify a resource filter that Oracle Clusterware uses to limit the number of resources evaluated. The filter must be enclosed in double quotation marks (
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. |
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]
--------------------------------------------------------------------------------
Use the crsctl eval modify resource command to predict the effects of modifying a resource without making changes to the system.
Table E-9 crsctl eval 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:
|
-f |
Specify this parameter to evaluate what happens if you run the command with the force parameter. |
See Also:
Appendix B, "Oracle Clusterware Resource Reference" for more information about resources and resource attributesUse the crsctl eval relocate resource command to simulate relocating a resource without making changes to the system.
crsctl eval relocate resource {resource_name | -all} {-s source_server |
-w "filter"} [-n destination_server] [-f]
See Also:
"crsctl relocate resource" for descriptions of the parameters used with this commandUse the crsctl eval start resource command to predict the effects of starting a resource without making changes to the system.
See Also:
"crsctl start resource" for descriptions of the parameters used with this commandUse the crsctl eval stop resource command to predict the effects of stopping a resource without making changes to the system.
See Also:
"crsctl stop resource" for descriptions of the parameters used with this commandUse the crsctl get hostname command to retrieve the host name of the local server.
Use the crsctl getperm resource command to display the user and group permissions for the specified resource.
crsctl getperm resource resource_name [ {-u user_name | -g group_name} ]
See Also:
Appendix B, "Oracle Clusterware Resource Reference" for more information about resources and resource attributesTable 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 |
-g group_name
|
If you specify |
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
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 Name: app.appvip r--
Use the crsctl getperm type command to obtain permissions for a particular resource type.
crsctl getperm type resource_type [-u user_name] | [-g group_name]
See Also:
"Resource Types" for more information about resource typesTable E-11 crsctl getperm type Command Parameters
| Parameter | Description |
|---|---|
resource_type
|
Specify the resource type for which you want to obtain permissions. |
-u user_name
|
If you specify |
-g group_name
|
If you specify |
Use the crsctl modify resource command to modify the attributes of a particular resource in Oracle Clusterware.
crsctl modify resource resource_name -attr "attribute_name=attribute_value" [-i] [-f] [-delete]
Table E-12 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:
|
-i |
If you specify |
-f |
Use the
|
-delete |
If you specify the |
See Also:
Appendix B, "Oracle Clusterware Resource Reference" for more information about resources and resource attributesThe 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
Use the crsctl modify type command to modify an existing resource type.
crsctl modify type type_name -attr "ATTRIBUTE=attribute_name,TYPE={string | int} [,DEFAULT_VALUE=default_value [,FLAGS=[READONLY][| REQUIRED]]" [-i] [-f]]
Table E-13 crsctl modify type Command Parameters
| Parameter | Description |
|---|---|
type_name
|
Specify the name of the resource type you want to modify. You cannot modify resource type names. |
-attr |
You can modify the following resource type keywords:
Note: Although you must specify the See Also: Table E-3, "crsctl add type Command Parameters" for descriptions of these keywords |
-i |
If you specify the |
See Also:
"Resource Types" for more information about resource typesUse the crsctl modify wallet command to modify the password for a specific user in a specific wallet.
crsctl modify wallet -type wallet_type [-name name] [-user user_name -passwd]
Table E-14 crsctl modify wallet
| Parameter | Description |
|---|---|
-type wallet_type
|
Specify the type of wallet you want to modify, such as APPQOSADMIN, APPQOSUSER, APPQOSDB, OSUSER, or CVUDB.
|
-name name
|
You must specify the wallet name to modify an APPQOSDB wallet. |
-user user_name -passwd
|
You must specify the user name for whom you want to modify the password. Modify the password through standard input. |
Use the crsctl query wallet command to query low-privileged users from a wallet.
crsctl query wallet -type wallet_type [-name name] [-user user_name] [-all]
Table E-15 crsctl query wallet
| Parameter | Description |
|---|---|
-type wallet_type
|
Type of wallet you want to query, such as APPQOSADMIN, APPQOSUSER, APPQOSDB, OSUSER, or CVUDB.
|
-name name
|
You must specify the name of the wallet to query an APPQOSDB wallet. |
-user user_name
|
You must specify a user name to query a user from an OSUSER wallet. |
-all |
Specify |
Use the crsctl relocate resource command to relocate resources to another server in the cluster.
crsctl relocate resource {resource_name | resource_name | -all -s source_server |
-w "filter"} [-n destination_server] [-k cid] [-env "env1=val1,env2=val2,..."]
[-i] [-f]
Table E-16 crsctl relocate resource Command Parameters
| Parameter | Description |
|---|---|
resource_name
|
The name of a resource you want to relocate. |
resource_name | -all -s source_server |
Specify one particular or all resources located on a particular server from which you want to relocate those resources. |
-w "filter"
|
Specify a resource filter that Oracle Clusterware uses to limit the number of resources relocated. The filter must be enclosed in double quotation marks (
See Also: "Filters" for more information |
-n destination_server
|
Specify the name of the server to which you want relocate resources. If you do not specify a destination server, then Oracle Clusterware relocates the resources to the best server according to the attribute profile of each resource. |
-k cid
|
Specify the resource cardinality ID. If you specify this parameter, then Oracle Clusterware relocates the resource instance that have the cardinality you specify. |
-env "env1=val1, env2=val2,..." |
You can optionally override one or more resource profile attribute values for this command. 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 |
-f |
Specify the Note: When you are relocating resources that have cardinality greater than 1, you must use either |
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 Oracle Clusterware uses to match resources to relocate.
If a resource has a degree ID greater than 1, then Oracle Clusterware 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.
Use the crsctl restart resource command to restart idle resources in the cluster, instead of having to run two commands to stop and start the resource.
crsctl restart resource {resource_name [...] | -w "filter"} [-k cid] [-d did]
[-env "env1=val1,env2=val2,..."] [-i] [-f]
Table E-17 crsctl restart resource Command Parameters
| Parameter | Description |
|---|---|
resource_name [...]
|
One or more space-delimited resource names to restart. |
-w filter
|
Specify a resource filter surrounded by double quotation marks ( 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 |
-env "env1=val1, env2=val2,..." |
You can optionally override one or more resource profile attribute values with the |
-i |
If you specify |
-f |
Use the |
Any one of the three following options is required to specify which resources you want to restart:
You can specify one or more resources 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
Use the crsctl setperm resource command to set permissions for a particular resource.
crsctl setperm resource resource_name {-u acl_string | -x acl_string | -o user_name | -g group_name}
Table E-18 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:
Specify a user, group, or other ACL string, as follows: user:user_name[:readPermwritePermexecPerm] | group:group_name[:readPermwritePermexecPerm] | other[::readPermwritePermexecPerm]
|
See Also:
Appendix B, "Oracle Clusterware Resource Reference" for more information about resources and resource attributesUse the crsctl setperm type command to set permissions resources of a particular resource type.
crsctl setperm type resource_type_name {-u acl_string | -x acl_string | -o user_name | -g group_name}
Table E-19 crsctl setperm type Command Parameters
| Parameter | Description |
|---|---|
resource_type_name
|
Specify the name of the resource type for which you want to set permissions. |
{-u | -x | -o | -g}
|
You can specify only one of the following parameters for a resource type:
Specify a user, group, or other ACL string, as follows: user:user_name[:readPermwritePermexecPerm] | group:group_name[:readPermwritePermexecPerm] | other[::readPermwritePermexecPerm]
|
Use the crsctl start resource command to start many idle resources on a particular server in the cluster.
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]
Table E-20 crsctl start resource Command Parameters
| Parameter | Description |
|---|---|
resource_name [...]
|
One or more space-delimited resource names to start. |
-w "filter"
|
Specify a resource filter surrounded by double quotation marks ( 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 |
-env "env1=val1, env2=val2,..." |
You can optionally override one or more resource profile attribute values with the |
-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 |
-f |
Use the |
-l |
Use the |
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
Use the crsctl status resource command to obtain the status and configuration information of many particular resources.
Use this command, depending on how you want the information about the status of the resource returned.
To check the status of specific resources:
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]]
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]
Table E-21 crsctl status resource Command Parameters
| Parameter | Description |
|---|---|
resource_name [...] | -w "filter" |
One or more space-delimited resource names of which you want to check the status. Or you can specify a resource filter that Oracle Clusterware uses to limit the number of resources displayed. The filter must be enclosed in double quotation marks (
See Also: "Filters" for more information |
[-p | -v] | [-f | -l | -g] |
You can optionally specify the following parameters:
|
[[-k cid | -n server_name] [ -e [-p | -v]] [-d did | [-s -k cid [-d did]]] |
You can specify one of the following two options:
|
-t |
Specify the |
-dependency [-stop | -pullup] |
Specify the Use either of the following options with the
|
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.
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]
Use the crsctl status type command to obtain the configuration information of one or more particular resource types.
Table E-22 crsctl status type Command Parameters
| Parameter | Description |
|---|---|
resource_type_name [...] | -w "filter" |
Specify one or more space-delimited resource type names of which you want to check the status. Alternatively, you can specify a resource type filter surrounded by double quotation marks ( See Also: "Filters" for more information |
[-g] [-p] [-f] |
You can specify the following parameters as options when Oracle Clusterware checks the status of specific server pools:
|
Use the crsctl stop resource command to stop running resources.
crsctl stop resource {resource_name [...] | -w "filter" | -all} [-n server_name]
[-k cid] [-d did] [-env "env1=val1,env2=val2,..."]
[-begin | -end] [-i] [-f] [-l]
Table E-23 crsctl stop resource Command Parameters
| Parameter | Description |
|---|---|
resource_name [...]
|
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 (
See Also: "Filters" for more information |
-all |
Use this parameter to stop all resources in the cluster. |
-n server_name
|
Specify the name of the server on which the resource instances you want to stop reside. If you do not specify a server, then Oracle Clusterware stops all instances of the resource. |
-k cid
|
Specify the resource cardinality ID. If you specify this parameter, then Oracle Clusterware 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 Oracle Clusterware 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 |
-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 |
-f |
Specify the |
-l |
Use the |
Any one of the three following options is required to specify which resources you want to stop:
You can specify one or more resources to stop
You can specify a resource filter that Oracle Clusterware uses to match resources to stop
You can specify the -all parameter with the -n server_name 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
The commands listed in this section manage the Oracle Clusterware stack in an Oracle RAC environment, which consists of the following:
Oracle Clusterware, the member nodes and server pools
Oracle ASM (if installed)
Cluster Synchronization Services
Cluster Time Synchronization Services
You can use the following commands only in an Oracle RAC environment:
Use the crsctl add category command to add a server category.
crsctl add category category_name [-attr "attr_name=attr_value [,attr_name=attr_value[,...]]"] [-i]
Table E-24 crsctl add category Command Parameters
| Parameter | Description |
|---|---|
category_name
|
Specify a name for the server category you want to add. |
attr_name
|
Specify the name of a category attribute you want to add preceded by the |
attr_value
|
A value for the category attribute. Note: The -attr "EXPRESSION='(CPU_COUNT > 2) AND (MEMORY_SIZE > 2048)'" See Also:
|
-i |
If you specify |
Use the crsctl add crs administrator command to add a user to the list of cluster administrators.
This command is deprecated in Oracle Clusterware 12c.
You must run this command as root or a cluster administrator, or an administrator on Windows systems
By default, root, the user that installed Oracle Clusterware, and the * wildcard are members of the list of users who have Oracle Clusterware administrative privileges. Run the crsctl delete crs administrator command to remove the wildcard and enable role-separated management of Oracle Clusterware.
See Also:
"Role-Separated Management" for more informationUse the crsctl add css votedisk command to add one or more voting files to the cluster on storage devices other than an Oracle ASM disk group.
Table E-26 crsctl add css votedisk Command Parameters
| Parameter | Description |
|---|---|
path_to_voting_disk
|
A fully qualified path to the voting file you want to add. To add multiple voting files, separate each path with a space. |
-purge |
Removes all existing voting files at once. You can replace the existing set of voting files in one operation. |
You should have at least three voting files, unless you have a storage device, such as a disk array, that provides external redundancy. Oracle recommends that you do not use more than 5 voting files. The maximum number of voting files that is supported is 15.
See Also:
"Adding, Deleting, or Migrating Voting Files" for more informationUse the crsctl add policy command to add a configuration policy to the policy set.
crsctl add policy policy_name -attr "attr_name=attr_value[,attr_name=attr_value[, ...]]" [-i]
Table E-27 crsctl add policy Command Parameters
| Parameter | Description |
|---|---|
policy_name
|
Specify a name for the policy you want to add. |
attr_name
|
Specify a description for the policy using the |
attr_value
|
A value for the Note: The -attr "DESCRIPTION=daytime" |
-i |
If you specify |
Use the crsctl add serverpool command to add a server pool that is for hosting non-database resources (such as application servers) to Oracle Clusterware.
crsctl add serverpool server_pool_name {-file file_path | -attr "attr_name=attr_value[,attr_name=attr_value[,...]]"} [-i] [-f]
Table E-28 crsctl add serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
A short, descriptive name for the server pool. A server pool name has a 254 character limit and can contain any platform-supported characters except the exclamation point (!), the tilde (~), and spaces. A server pool name cannot begin with a period nor with ora. |
-file file_path
|
Fully-qualified path to an attribute file to define the server pool. |
attribute_name
|
The name of a server pool attribute Oracle Clusterware uses to manage the server pool preceded by the
|
attribute_value
|
A value for the server pool attribute. Note: The -attr "MAX_SIZE=30, IMPORTANCE=3" |
-i |
If you specify |
-f |
If you specify the |
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesThe server_pool_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 ('').
Do not use this command for any server pools with names that begin with ora because these server pools are Oracle server pools.
Running this command may result in Oracle Clusterware relocating other servers between server pools to comply with the new configuration.
You must run this command as root or a cluster administrator.
Use the crsctl add serverpool command to create server pools that host non-database resources. To create server pools that host Oracle databases, use the SRVCTL command utility.
See Also:
Oracle Real Application Clusters Administration and Deployment Guide for information about using the SRVCTL command utility to create server poolsTo add a server pool named testsp with a maximum size of 5 servers, run the following command as root or the Oracle Clusterware installation owner:
# crsctl add serverpool testsp -attr "MAX_SIZE=5"
Create the sp1_attr file with the attribute values for the sp1 serverpool, each on its own line, as shown in the following example:
IMPORTANCE=1 MIN_SIZE=1 MAX_SIZE=2 SERVER_NAMES=node3 node4 node5 PARENT_POOLS=Generic EXCLUSIVE_POOLS=testsp ACL=owner:oracle:rwx,pgrp:oinstall:rwx,other::r--
Use the following command to create the sp1 server pool using the sp1_attr file as input:
$ crsctl add serverpool sp1 -file /tmp/sp1_attr
Use the crsctl check cluster command on any node in the cluster to check the status of the Oracle Clusterware stack.
You can check the status of the Oracle Clusterware stack on all nodes in the cluster with the -all parameter or you can specify one or more space-delimited nodes. If you do not specify either parameter, then Oracle Clusterware checks the status of the Oracle Clusterware stack on the local server.
You can use this cluster-aware command on any node in the cluster.
The crsctl check cluster command returns output similar to the following:
$ crsctl check cluster -all ***************************************************************** node1: CRS-4537: Cluster Ready Services is online CRS-4529: Cluster Synchronization Services is online CRS-4533: Event Manager is online ***************************************************************** node2: CRS-4537: Cluster Ready Services is online CRS-4529: Cluster Synchronization Services is online CRS-4533: Event Manager is online *****************************************************************
Use the crsctl check crs command to check the status of Oracle High Availability Services and the Oracle Clusterware stack on the local server.
Use the crsctl check resource command to initiate the check action inside the application-specific agent of a particular resource. Oracle Clusterware only provides output if something prevents the system from issuing the check request, such as a bad resource name.
crsctl check resource {resource_name [...] | -w "filter" }
[-n node_name] [-k cardinality_id] [-d degree_id] }
Table E-29 crsctl check resource Command Parameters
| Parameter | Description |
|---|---|
resource_name
|
Specify a particular resource. You can check multiple resources by entering multiple resource names, with each name separated by a space. |
-w "filter"
|
Specify a resource filter that Oracle Clusterware uses to limit the number of resources checked. The filter must be enclosed in double quotation marks (
See Also: "Filters" for more information |
-n node_name
|
Check the resource instance on a specific node. If you do not specify the |
-k cardinality_id
|
Specify the resource cardinality ID. |
-d degree_id
|
Specify the resource degree ID. |
You must have read and execute permissions on the specified resources to check them
Do not use this command for any resources with names that begin with ora because these resources are Oracle resources
If this command is successful, it only means that a check was issued; it does not mean the CHECK action has been completed
Use the crsctl check ctss command to check the status of the Cluster Time Synchronization services.
Use the crsctl config crs command to display Oracle High Availability Services automatic startup configuration.
Use the crsctl create policyset command to create a single policy set, in the form of a text file, that reflects the server pool configuration. After you create a policy set, you can copy the contents of the text file to create other policy sets.
Table E-30 crsctl create policyset Command Parameters
| Parameter | Description |
|---|---|
-file file_name
|
Specify a path to where CRSCTL creates a file that you can edit and then send back using |
Use the crsctl delete category command to delete a server category.
Table E-31 crsctl delete category Command Parameters
| Parameter | Description |
|---|---|
category_name
|
Specify the name of the server category or a space-delimited list of server categories that you want to delete. |
-i |
If you specify |
Use the crsctl delete crs administrator command to remove a user from the Oracle Clusterware administrator list.
Table E-32 crsctl delete crs administrator Command Parameters
| Parameter | Description |
|---|---|
-u user_name
|
The name of the user whose Oracle Clusterware administrative privileges you want to remove. By default, the list of users with Oracle Clusterware administrative privileges consists of the user who installed Oracle Clusterware, See Also: "Role-Separated Management" for more information |
-f |
Use this parameter to override the user name validity check. |
Use the crsctl delete css votedisk to remove a voting file from the Oracle Clusterware configuration.
Table E-33 crsctl delete css votedisk Command Parameters
| Parameter | Description |
|---|---|
voting_disk_GUID
|
Enter the file universal identifier (GUID) of the voting file you want to remove. Specify multiple GUIDs in a space-delimited list. |
vdisk
|
Enter the path of the voting file you want to remove. Specify multiple voting file paths in a space-delimited list. |
+diskgroup
|
Enter the name of an Oracle ASM disk group that contains voting files you want to remove. You can only use parameter when Oracle Clusterware is in exclusive mode. |
You can specify one or more GUIDs of voting files you want to remove, one or paths to voting files you want to remove, or the name of an Oracle ASM disk group that contains voting files you want to remove.
You can obtain the GUIDs of each current voting file by running the crsctl query css votedisk command
Use the crsctl delete node to remove a node from the cluster.
Use the crsctl delete policy command to delete a configuration policy from the policy set.
Use the crsctl delete serverpool command to remove a server pool from the Oracle Clusterware configuration.
crsctl delete serverpool server_pool_name [server_pool_name [...]] [-i]
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesThe server_pool_name parameter is required
If you specify -i, then the command fails if Oracle Clusterware cannot process the request immediately
Do not use this command for any server pools with names that begin with ora because these server pools are Oracle server pools
While you can use this command in either environment, it is only useful in the Oracle RAC environment
Use the crsctl disable crs command to prevent the automatic startup of Oracle High Availability Services when the server boots.
This command only affects the local server
If you disable Oracle High Availability Services automatic startup, you must use the crsctl start crs command to start Oracle High Availability Services
Use the crsctl discover dhcp command to send DHCP discover packets on the network at the specified port. If DHCP servers are present on the network, then they respond to the discovery message and the command succeeds.
Table E-35 crsctl discover dhcp Command Parameters
| Parameter | Description |
|---|---|
-clientid clientid
|
Specify the client ID for which you want to attempt discovery. Obtain the client ID by running the |
-port port
|
The port to which CRSCTL sends the discovery packets. |
Use the crsctl enable crs command to enable automatic startup of Oracle High Availability Services when the server boots.
Use the crsctl eval activate policy command to predict the effects of activating a specific policy without making changes to the system. This command may be useful to cluster administrators.
crsctl eval activate policy policy_name [-f] [-admin [-l serverpools | resources
| all] [-x] [-a]]
Table E-36 crsctl eval activate policy Command Parameters
| Parameter | Description |
|---|---|
-f |
Specify this parameter to evaluate what happens if you try to forcibly activate a policy. |
-admin [-l serverpools | resources | all] [-x] [-a] |
You must specify If you specify the
If you specify the If you specify the |
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesUse the crsctl eval add server command to simulate the addition of a server without making changes to the system. This command may be useful to cluster administrators.
crsctl eval add server server_name [-file file_path] | [-attr "attr_name=attr_value[,...]"] [-admin [-l level [-x] [-a]] [-f]
Table E-37 crsctl eval add server Command Parameters
| Parameter | Description |
|---|---|
server_name
|
The name of the server you want to add. |
-file file_path
|
Fully-qualified path to a file containing server attributes. |
attr_name
|
The name of a server attribute that Oracle Clusterware uses to manage the server preceded by the See Also: "Server Category Attributes" for information about server attributes |
attr_value
|
A value for the server attribute. Note: The -attr "MAX_SIZE=30,IMPORTANCE=3" |
-admin [-l level] [-x] [-a]
|
If you specify this parameter, then CRSCTL displays output for the cluster administrator. If you specify the
If you specify the If you specify the Note: To specify either the |
-f |
If you specify this parameter, then CRSCTL predicts the effects of forcibly adding a server. |
See Also:
Chapter 7, "Adding and Deleting Cluster Nodes" for more information about adding serversThe following example predicts how the system reacts when you add a server called mjkeenan-node-3:
# crsctl eval add server mjkeenan-node-3 -admin -l resources -a
--------------------------------------------------------------------------------
Name Target State Server Effect
--------------------------------------------------------------------------------
Local Resources
--------------------------------------------------------------------------------
ora.net1.network
ONLINE ONLINE mjkeenan-node-0
ONLINE ONLINE mjkeenan-node-1
--------------------------------------------------------------------------------
Cluster Resources
--------------------------------------------------------------------------------
cs1
1 ONLINE ONLINE mjkeenan-node-1
2 ONLINE ONLINE mjkeenan-node-0
cs2
1 ONLINE ONLINE mjkeenan-node-3 Started
ora.gns
Use the crsctl eval add serverpool command to predict the effects of adding a server pool without making changes to the system. This command may be useful to cluster administrators.
See Also:
"How Server Pools Work" for more information about server pools and server pool attributescrsctl eval add serverpool server_pool_name [-file file_path | -attr "attr_name=attr_value [,attr_name=attr_value[,...]]" [-admin [-l level [-x] [-a]] [-f]
Table E-38 crsctl eval add serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
A short, descriptive name for the server pool. |
-file file_path
|
Fully-qualified path to an attribute file to define the server pool. |
attribute_name
|
The name of a server pool attribute Oracle Clusterware uses to manage the server pool preceded by the
|
attribute_value
|
A value for the server pool attribute. Note: The -attr "MAX_SIZE=30,IMPORTANCE=3" |
-admin [-l level] [-x] [-a]
|
If you specify this parameter, then CRSCTL displays output for the cluster administrator. If you specify the
If you specify the If you specify the Note: To specify either the |
-f |
If you specify this parameter, then CRSCTL predicts the effects of forcibly adding a server pool. |
Use the crsctl eval delete server command to predict the effects of deleting a server without making changes to the system. This command may be useful to cluster administrators.
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesTable E-39 crsctl eval delete server Command Parameters
| Parameter | Description |
|---|---|
server_name
|
Specify the name of the server you want to evaluate before deleting. |
-admin [-l level] [-x] [-a]
|
If you specify this parameter, then CRSCTL displays output for the cluster administrator. If you specify the
If you specify the If you specify the Note: To specify either the |
Use the crsctl eval delete serverpool command to simulate the deletion of a server pool without making changes to the system. This command may be useful to cluster administrators.
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesTable E-40 crsctl eval delete serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
The name of the server pool you want to delete. |
-admin [-l level] [-x] [-a]
|
If you specify this parameter, then CRSCTL displays output for the cluster administrator. If you specify the
If you specify the If you specify the Note: To specify either the |
Use the crsctl eval modify serverpool command to predict the effects of modifying a server pool without making changes to the system. This command may be useful to cluster administrators.
crsctl eval modify serverpool server_pool_name {-file file_path | -attr "attr_name=attr_value [,attr_name=attr_value[, ...]]"} [-f] [-admin [-l level [-x] [-a]]
Table E-41 crsctl eval modify serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
The name of the server pool you want to modify. |
-f |
If you specify this parameter, then CRSCTL predicts the effects of forcibly modifying a server pool. |
-admin [-l level] [-x] [-a]
|
If you specify this parameter, then CRSCTL displays output for the cluster administrator. If you specify the
If you specify the If you specify the Note: To specify either the |
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesThe server_pool_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)'"
Running this command may result in Oracle Clusterware relocating other servers between server pools to comply with the new configuration
Do not use this command for any server pools with names that begin with ora because these server pools are Oracle server pools
While you can use this command in either environment, it is only useful in the Oracle RAC environment
Use the crsctl eval relocate server command to predict the effects of relocating a server to a different server pool without making changes to the system. This command might be useful for a cluster administrator.
crsctl eval relocate server server_name -to server_pool_name [-f] [-admin [-l level] [-x] [-a]]
Table E-42 crsctl eval relocate server Command Parameters
| Parameter | Description |
|---|---|
server_name
|
The name of the server you want to relocate. You can provide a space-delimited list of servers to evaluate relocating multiple servers. |
-to |
Specify the name of the server pool to which you want relocate the server. |
-f |
If you specify this parameter, then CRSCTL predicts the effects of forcibly relocating a server. |
-admin [-l level] [-x] [-a]
|
If you specify this parameter, then CRSCTL displays output for the cluster administrator. If you specify the
If you specify the If you specify the Note: To specify either the |
Use the crsctl get clientid dhcp command to display the client ID that the Oracle Clusterware agent uses to obtain the IP addresses from the DHCP server for configured cluster resources. The VIP type is required.
crsctl get clientid dhcp -cluname cluster_name -viptype vip_type [-vip vip_res_name] [-n node_name]
Table E-43 crsctl get clientid dhcp Command Parameters
| Parameter | Description |
|---|---|
-cluname cluster_name
|
Specify the name of the cluster where the cluster resources are configured. |
-viptype vip_type
|
Specify the type of the VIP resource for which you want to display client IDs: |
-vip vip_resource_name
|
Specify the name of the VIP resource. This parameter is required if you specify the |
-n node_name
|
Specify the name of the node for which you want to obtain the client ID. This parameter is required if you specify the |
Use the crsctl get cluster hubsize command to obtain the value of Hub Nodes in an Oracle Flex Cluster.
Use the crsctl get cluster mode command to ascertain whether the cluster is configured for Oracle Flex Clusters or the current status.
Use the crsctl cpu equivalency command to obtain the value of the CPU_EQUIVALENCY server configuration attribute.
Use the crsctl get css command to obtain the value of a specific Cluster Synchronization Services parameter.
Cluster Synchronization Services parameters and their default values include:
clusterguid diagwait disktimeout (200 (seconds)) misscount (30 (seconds)) reboottime (3 (seconds)) priority (4 (UNIX), 3 (Windows)) logfilesize (50 (MB))
This command does not display default values
This command only affects the local server
Use the crsctl get css ipmiaddr command to get the address stored in the Oracle Local Registry of the local Intelligent Platform Management Interface (IPMI) device.
Run the command under the user account used to install Oracle Clusterware.
This command only obtains the IP address stored in the Oracle Local Registry. It may not be the IP address actually used by IPMI.
Use either ipmiutil or ipmitool as root on the local server to obtain the IP address used by the IPMI device.
Use the crsctl get css leafmisscount command to obtain the amount of time (in seconds) that must pass without any communication between a Leaf Node and the Hub Node to which it is attached, before the connection is declared to be no longer active and the Leaf Node is removed from the cluster.
Use the crsctl get node role command to obtain the configured node role of nodes in the cluster.
Specify the config option to obtain the configured node role for a specific node.
Specify the status option to obtain the current status of a specific node.
You can specify a particular node for which to obtain role information. If you do not specify a particular node, then CRSCTL returns information about the local node.
Use the crsctl get resource use command to check the current setting value of the RESOURCE_USE_ENABLED parameter.
Use the crsctl get server label command to check the current setting value of the SERVER_LABEL server attribute.
Use the crsctl getperm serverpool command to obtain permissions for a particular server pool.
crsctl getperm serverpool server_pool_name [-u user_name | -g group_name]
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesTable E-44 crsctl getperm serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
Specify the name of the server pool for which you want to obtain permissions. |
-u user_name
|
If you specify |
-g group_name
|
If you specify |
Use the crsctl lsmodules command to list the components of the modules that you can debug.
See Also:
"Dynamic Debugging Using crsctl set log" for more information about debuggingYou can specify any of the following components:
mdns: Multicast domain name servergpnp: Grid Plug and Play servicecss: Cluster Synchronization Servicescrf: Cluster Health Monitorcrs: Cluster Ready Servicesctss: Cluster Time Synchronization Serviceevm: Event Managergipc: Grid Interprocess CommunicationThe crsctl lsmodules command returns output similar to the following:
$ crsctl lsmodules evm List EVMD Debug Module: CLSVER List EVMD Debug Module: CLUCLS List EVMD Debug Module: COMMCRS List EVMD Debug Module: COMMNS List EVMD Debug Module: CRSOCR List EVMD Debug Module: CSSCLNT List EVMD Debug Module: EVMAGENT List EVMD Debug Module: EVMAPP ...
Use the crsctl modify category command to modify an existing server category.
crsctl modify category category_name [-attr "attr_name=attr_value [,attr_name=attr_value[,...]]"] [-i] [-f]
Table E-45 crsctl modify category Command Parameters
| Parameter | Description |
|---|---|
category_name
|
Specify the name of the server category you want to modify. |
attr_name
|
Specify the name of a category attribute you want to modify preceded by the |
attr_value
|
A value for the category attribute. Note: The "ACL='owner:st-cdc\cdctest:rwx,pgrp::---', ACTIVE_CSS_ROLE=leaf" See Also:
|
-i |
If you specify |
-f |
Force parameter |
Use the crsctl modify policy command to modify an existing configuration policy.
Table E-46 crsctl modify policy Command Parameters
| Parameter | Description |
|---|---|
policy_name
|
The name of the policy you want to modify. |
attr_name
|
Specify a description for the policy using the |
attr_value
|
A value for the Note: The -attr "DESCRIPTION=daytime" |
-i |
If you specify |
Use the crsctl modify policyset command to modify an existing policy set.
crsctl modify policyset {-attr "attr_name=attr_value[,attr_name=attr_value[, ...]]" | -file file_name} [-ksp]
Table E-47 crsctl modify policyset Command Parameters
| Parameter | Description |
|---|---|
attr_name
|
The name of a policy attribute you want to modify preceded by the ACLLAST_ACTIVATED_POLICYSERVER_POOL_NAMES |
attr_value
|
A value for the policy attribute. Note: The -attr "ACL='owner:mjkeenan:rwx,pgrp:svrtech:rwx,other::r--', SERVER_POOL_NAMES=sp1 sp2 Free" |
-file file_name
|
If you specify this parameter instead of |
-ksp |
If you specify this parameter, then CRSCTL keeps the server pools in the system, which means that they are independent and not managed by the policy set. |
Privileges necessary to run this command depend on the value of the ACL attribute of the policy set
You can only specify policy definitions using the -file parameter or by running the crsctl modify policy command
Use the crsctl modify server command to modify the configuration of a particular server.
Table E-48 crsctl modify server Command Parameters
| Parameter | Description |
|---|---|
server_name [...]
|
Specify the name of the server you want to modify. |
attr_name
|
The name of a server attribute you want to modify preceded by the |
attr_value
|
A value for the server attribute. Note: The -attr "CHECK_INTERVAL=30,START_TIMEOUT=25" |
Use the crsctl modify serverpool command to modify an existing server pool.
crsctl modify serverpool server_pool_name -attr "attr_name=attr_value [,attr_name=attr_value[, ...]]" [-policy policyName | -all_policies] [-i] [-f]
Table E-49 crsctl modify serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
The name of the server pool you want to modify. |
attr_name
|
The name of a server pool attribute you want to modify preceded by the See Also: Table 3-1, "Server Pool Attributes" for details about server pool attributes |
attr_value
|
A value for the server pool attribute. Note: The -attr "CHECK_INTERVAL=30,START_TIMEOUT=25" |
-policy policyName |
-all_policies
|
Specify a particular policy or all policies for which you want to modify the server pool definition. |
-i |
If you specify |
-f |
If you specify the If you do not specify the |
See Also:
"How Server Pools Work" for more information about server pools and server pool attributesThe server_pool_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)'"
Running this command may result in Oracle Clusterware relocating other servers between server pools to comply with the new configuration
Do not use this command for any server pools with names that begin with ora because these server pools are Oracle server pools
While you can use this command in either environment, it is only useful in the Oracle RAC environment
Use the crsctl pin css command to pin many specific nodes. Pinning a node means that the association of a node name with a node number is fixed. If a node is not pinned, its node number may change if the lease expires while it is down. The lease of a pinned node never expires.
You can specify a space-delimited list of servers
Any pre-12c release 1 (12.1) Oracle software must reside on a pinned server.
A node may be unpinned with crsctl unpin css.
Deleting a node with the crsctl delete node command implicitly unpins the node.
Use the crsctl query crs administrator command to display the list of users with Oracle Clusterware administrative privileges.
Use the crsctl query crs activeversion command to display the active version and the configured patch level of the Oracle Clusterware software running in the cluster. During a rolling upgrade, however, the active version is not advanced until the upgrade is finished across the cluster, until which time the cluster operates at the pre-upgrade version.
Additionally, during a rolling patch, the active patch level is not advanced until the patching is finished across the cluster, until which time the cluster operates at the pre-upgrade patch level.
Use the crsctl query crs autostart command to obtain the values of the Oracle Clusterware automatic resource start criteria.
Use the crsctl query crs releasepatch command to display the patch level which is updated in the Grid home patch repository while patching a node. The patch level corresponds to only the local node in which the command is executed. This command can be executed while the stack is not running.
Use the crsctl query crs releaseversion command to display the version of the Oracle Clusterware software stored in the binaries on the local node.
Use the crsctl query crs softwarepatch command to display the configured patch level of the installed Oracle Clusterware.
Use the crsctl query crs softwareversion command to display latest version of the software that has been successfully started on the specified node.
Use the crsctl query css ipmiconfig command to determine whether Oracle Clusterware on the local server has been configured to use IPMI for failure isolation. Note that this command detects the presence of configuration data, but cannot not validate its correctness.
This command attempts to locate and access the IPMI configuration stored in the Oracle Cluster Registry (OCR) and should be executed under the account used to install Oracle Clusterware, or an authorization failure may be reported.
An authorization failure may not result when executed under another account, if the registry contains no IPMI configuration data.
Use the crsctl query css ipmiconfig command to determine the presence of the Intelligent Platform Management Interface (IPMI) driver on the local system.
This command performs a pre-check during IPMI installation, and is normally issued only by the installer.
This command performs a perfunctory check and a success return does not guarantee that the IPMI hardware is fully configured for use.
There are no special privileges required to run this command.
Use the crsctl query css votedisk command to display the voting files used by Cluster Synchronization Services, the status of the voting files, and the location of the disks, whether they are stored on Oracle ASM or elsewhere.
The crsctl query css votedisk command returns output similar to the following:
$ crsctl query css votedisk ## STATE File Universal Id File Name Disk group -- ----- ----------------- --------- --------- 1. ONLINE 296641fd201f4f3fbf3452156d3b5881 (/ocfs2/host09_vd3) [] 2. ONLINE 8c4a552bdd9a4fd9bf93e444223146f2 (/netapp/ocrvf/newvd) [] 3. ONLINE 8afeee6ae3ed4fe6bfbb556996ca4da5 (/ocfs2/host09_vd1) [] Located 3 voting file(s).
Use the crsctl query dns command to obtain a list of addresses returned by DNS lookup of the name with the specified DNS server.
crsctl query dns {-servers | -name name [-dnsserver DNS_server_address]
[-port port] [-attempts number_of_attempts] [-timeout timeout_in_seconds] [-v]}
Table E-50 crsctl query dns Command Parameters
| Parameter | Description |
|---|---|
-servers |
Use the |
-name name
|
Specify the fully-qualified domain name you want to look up. |
-dnsserver DNS_server_address
|
Specify the address of the DNS server on which you want the domain name to be looked up. |
-port port
|
The port on which the DNS server listens. If you do not specify a port, then it defaults to port 53. |
-attempts number_of_attempts
|
Specify the number of retry attempts. |
-timeout timeout_in_seconds
|
Specify the timeout length in seconds. |
-v |
Verbose output. |
The crsctl query dns command returns output similar to the following for a DNS server named stmjk07-vip.stmjk0462.foo.com:
CRS-10024: DNS server returned 192.168.29.250 for name stmjk07-vip.stmjk0462.foo.com
If you choose the -servers parameter, then the command returns output similar to the following:
CRS-10018: the following configuration was found on the system: CRS-10019: There are 3 domains in search order. They are: us.foo.com foo.com foocorp.com CRS-10022: There are 3 name servers. They are: 192.168.249.41 192.168.249.52 192.168.202.15 CRS-10020: number of retry attempts for name lookup is: 2 CRS-10021: timeout for each name lookup is: 1
Use the crsctl query socket udp command to verify that a daemon can listen on specified address and port.
crsctl query socket udp [-address address] [-port port]
Table E-51 crsctl query socket udp
| Parameter | Description |
|---|---|
-address address
|
Specify the IP address on which the socket is to be created. If you do not specify an address, then CRSCTL assumes the local host as the default. |
-port port
|
Specify the port on which the socket is to be created. If you do not specify a port, then CRSCTL assumes 53 as the default. |
The following examples show various outputs:
$ crsctl query socket udp CRS-10030: could not verify if port 53 on local node is in use # crsctl query socket udp CRS-10026: successfully created socket on port 53 on local node
The first of the preceding two commands was not run as root, and in both commands no port was specified, so CRSCTL assumed the default, 53, which is less than 1024. This condition necessitates running the command as root.
$ crsctl query socket udp -port 1023 CRS-10030: could not verify if port 1023 on local node is in use # crsctl query socket udp -port 1023 CRS-10026: successfully created socket on port 1023 on local node
Similar to the first two examples, the first of the preceding two commands was not run as root, and, although a port number was specified, it is still less than 1024, which requires root privileges to run the command.
In this last example, a port number greater than 1024 is specified, so there is no need to run the command as root:
$ crsctl query socket udp -port 1028 CRS-10026: successfully created socket on port 1028 on local node
Use the crsctl release dhcp command to send a DHCP lease release request to a specific client ID and send release packets on the network to a specific port.
Table E-52 crsctl release dhcp Command Parameters
| Parameter | Description |
|---|---|
-clientid clientid
|
Specify the client ID for which you want to attempt release. Obtain the client ID by running the |
-port port
|
The port to which CRSCTL sends the release packets. If you do not specify a port, then CRSCTL uses the default value 67. |
Use the crsctl relocate resource command to relocate resources to another server in the cluster.
crsctl relocate resource {resource_name [-k cid] | {resource_name | -all}
-s source_server | -w "filter"} [-n destination_server] [-env "env1=val1,env2=val2,..."]
[-i] [-f]
Table E-53 crsctl relocate resource Command Parameters
| Parameter | Description |
|---|---|
resource_name [-k cid] |
The name of a resource you want to relocate. Optionally, you can also specify the resource cardinality ID. If you specify this parameter, then Oracle Clusterware relocates the resource instance that have the cardinality you specify. |
resource_name | -all -s source_server |
Specify one particular or all resources located on a particular server from which you want to relocate those resources. |
-w "filter"
|
Specify a resource filter that Oracle Clusterware uses to limit the number of resources relocated. The filter must be enclosed in double quotation marks (
See Also: "Filters" for more information |
-n destination_server
|
Specify the name of the server to which you want relocate resources. If you do not specify a destination server, then Oracle Clusterware 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 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 |
-f |
Specify the Note: When you are relocating resources that have cardinality greater than 1, you must use either |
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 Oracle Clusterware uses to match resources to relocate.
If a resource has a degree ID greater than 1, then Oracle Clusterware 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.
Use the crsctl relocate server command to relocate a server to a different server pool.
Table E-54 crsctl relocate server Command Parameters
| Parameter | Description |
|---|---|
server_name
|
The name of the server you want to relocate. You can provide a space-delimited list of servers to relocate multiple servers. |
-c server_pool_name
|
Specify the name of the server pool to which you want relocate the servers. |
-i |
If you specify |
-f |
If you specify the If you do not specify the Note: If the number of servers in the server pool is not above the value of the |
Use the crsctl replace discoverystring command to replace the existing discovery string used to locate voting files.
Use the crsctl replace votedisk command to move or replace the existing voting files. This command creates voting files in the specified locations, either in Oracle ASM or some other storage option. Oracle Clusterware copies existing voting file information into the new locations and removes the voting files from the former locations.
Use the crsctl request action command to perform a specific action on specific resource.
crsctl request action action_name {-r resource_name [...] | -w "filter"} [-env "env1=val1,env2=val2,..."] [-i]
Table E-57 crsctl request action Command Parameters
| Parameter | Description |
|---|---|
action_name
|
Specify the name of the action you want perform. Actions supported by a particular resource are listed in the |
-r resource_name [...]
|
Specify a particular resource. Multiple resource names must be separated by a space. |
-w "filter"
|
Alternative to specifying resource names, you can specify a resource filter that Oracle Clusterware uses to limit the number of resources on which actions are performed. Examples of resource filters include:
See Also: "Filters" for more information |
-env "env1=val1, env2=val2,..." |
You can optionally override one or more resource profile attribute values with the |
-i |
If you specify |
Use the crsctl request dhcp command to send DHCP request packets on the network at the specified port. If the DHCP server has an IP address it can provide, then it responds with the IP address for the client ID.
Table E-58 crsctl request dhcp Command Parameters
| Parameter | Description |
|---|---|
-clientid clientid
|
Specify the client ID for which you want to attempt request. Obtain the client ID by running the |
-port port
|
The port to which CRSCTL sends the request packets. If you do not specify a port, then CRSCTL uses the default value 67. |
Use the crsctl set cluster hubsize command to set the maximum number of Hub Nodes for an Oracle Flex Cluster.
Use the crsctl set cluster mode command to change a cluster to an Oracle Clusterware standard Cluster or an Oracle Flex Cluster.
Use the crsctl set cpu equivalency command to set a value for the CPU_EQUIVALENCY server configuration attribute.
Use the crsctl set crs autostart command to set the Oracle Clusterware automatic resource start criteria. The autostart delay and minimum server count criteria delay Oracle Clusterware resource autostart until one of the two conditions are met.
To ensure that Oracle Clusterware delays resource autostart for 60 seconds after the first server in the cluster is ONLINE:
crsctl set crs autostart delay 60
To ensure that Oracle Clusterware waits for there to be at least two servers ONLINE before it initiates resource autostart:
crsctl set crs autostart servercount 2
To ensure that Oracle Clusterware delays resource autostart until either of the previous two conditions are met (in no particular order):
crsctl set crs autostart delay 60 servercount 2
Use the crsctl set css command to set the value of a Cluster Synchronization Services parameter.
Use the crsctl set css ipmiaddr command to store the address of the local Intelligent Platform Management Interface (IPMI) device in the Oracle Local Registry.
Run the command under the user account used to install Oracle Clusterware
Obtain the IP address used by the IPMI device using either ipmiutil or ipmitool as root on the local server
Oracle Clusterware stores the IP address for IPMI in the configuration store, and distributes the address as required
This command only stores the IPMI IP address on the server from which you run it
This command fails if another server cannot access IPMI at the supplied address
Use the crsctl set css ipmiadmin command to store the login credentials of an Intelligent Platform Management Interface (IPMI) administrator in the Oracle Local Registry.
This command must be run under the user account that installed Oracle Clusterware.
When prompted, provide the new password to associate with the new administrator account name. Oracle Clusterware stores the name and password for the local IPMI in the configuration store, and distributes the new credentials as required.
This command only modifies the IPMI administrator on the server from which you run it.
This command fails if another server cannot access the local IPMI at the supplied address.
Use the crsctl set css leafmisscount command to specify, in seconds, the amount of time that must pass without any communication between a Leaf Node and the Hub Node to which it is attached, before the connection is declared to be no longer active and the Leaf Node is removed from the cluster.
Use the crsctl set node role command to set the role of a specific node in the cluster.
You can specify a particular node for which to set role information. If you do not specify a particular node, then CRSCTL sets the node role on the local node.
Specify the hub option to configure the node role as a Hub Node.
Specify the leaf option to configure the node role as a Leaf Node.
You must restart the Oracle Clusterware technology stack to apply a node role change.
Use the crsctl set resource use command to set the value of the RESOURCE_USE_ENABLED server configuration parameter for the server on which you run this command.
The possible values are 1 or 0. If you set the value for this attribute to 1, which is the default, then the server can be used for resource placement. If you set the value to 0, then Oracle Clusterware disallows starting server pool resources on the server. The server remains in the Free server pool.
You must run this command as root or a cluster administrator, or an administrator on Windows systems.
Use the crsctl set server label command to set the configuration value of the SERVER_LABEL server configuration attribute for the server on which you run this command.
Use the crsctl setperm serverpool command to set permissions for a particular server pool.
crsctl setperm serverpool server_pool_name {-u acl_string | -x acl_string | -o user_name | -g group_name}
Table E-60 crsctl setperm serverpool Command Parameters
| Parameter | Description |
|---|---|
server_pool_name
|
Specify the name of the server pool for which you want to set permissions. |
{-u | -x | -o | -g}
|
You can specify only one of the following parameters for a server pool:
Specify a user, group, or other ACL string, as follows: user:user_name[:readPermwritePermexecPerm] | group:group_name[:readPermwritePermexecPerm] | other[::readPermwritePermexecPerm]
|
Use the crsctl start cluster command on any node in the cluster to start the Oracle Clusterware stack.
You can choose to start the Oracle Clusterware stack on all servers in the cluster, on one or more named servers in the cluster (separate multiple server names by a space), or the local server, if you do not specify either -all or -n.
You can use this cluster-aware command on any node in the cluster.
Use the crsctl start crs command to start Oracle High Availability Services on the local server.
Table E-61 crsctl start crs Command Parameters
| Parameter | Description |
|---|---|
-excl |
Starts Oracle Clusterware in exclusive mode with two options:
|
-wait | -waithas | -nowait |
Choose one of the following:
|
-noautostart |
Start only OHASD. |
Use the crsctl start ip command to start a given IP name or IP address on a specified interface with a specified subnet mask. Run this command on the server on which you want to start the IP.
Table E-62 crsctl start ip Command Parameters
| Parameter | Description |
|---|---|
{IP_name | IP_address}
|
Specify either a domain name or an IP address. If you do not specify a fully-qualified domain name, then CRSCTL uses a standard name search. |
netmask
|
Specify a subnet mask for the IP to start. |
interface_name
|
Specify an interface on which to start the IP. |
The crsctl start rollingpatch command transitions Oracle Clusterware and Oracle ASM into rolling patch mode. In this mode, the software tolerates nodes having different patch levels.
This command queries the Oracle Clusterware rolling patch state and Oracle ASM cluster state. If either one is not in rolling patch mode, it will use the appropriate method to transition Oracle Clusterware or Oracle ASM to rolling patch mode.
If Oracle Clusterware and Oracle ASM are both in rolling patch mode when you run this command, then this command does nothing.
The rolling patch mode is not persistent. If all the nodes in a cluster are shut down and restarted, then the cluster transitions out of rolling patch mode when it is restarted. Similarly, if Oracle Clusterware is stopped and then restarted on all nodes in the cluster, then the rolling patch mode is lost.
This command does not transition Oracle ASM to rolling patch mode if issued within an Oracle ASM Client Cluster.
The crsctl start rollingupgrade command transitions Oracle Clusterware and Oracle ASM into rolling upgrade mode.
This command queries the Oracle Clusterware rolling upgrade state and Oracle ASM cluster state. If either one is not in rolling upgrade mode, it will use the appropriate method to transition Oracle Clusterware or Oracle ASM to rolling upgrade mode.
If Oracle Clusterware and Oracle ASM are both in rolling upgrade mode when you run this command, then this command does nothing.
The rolling upgrade mode is not persistent. If all the nodes in a cluster are shut down and restarted, then the cluster transitions out of rolling upgrade mode when it is restarted. Similarly, if Oracle Clusterware is stopped and then restarted on all nodes in the cluster, then the rolling upgrade mode is lost.
This command does not transition Oracle ASM to rolling upgrade mode if run within an Oracle ASM Client Cluster.
Use the crsctl start testdns command to start a test DNS server that will listen on a specified IP address and port. The test DNS server does not respond to incoming packets but does display the packets it receives. Typically, use this command to check if domain forwarding is set up correctly for the GNS domain.
Table E-63 crsctl start testdns Command Parameters
| Parameter | Description |
|---|---|
-address address
|
Specify a server address in the form |
-port port
|
The port on which the server listens. If you do not specify a port, then it defaults to port 53. |
-once |
Specify this flag to indicate that the DNS server should exit after it receives one DNS query packet. |
-v |
Verbose output. |
Use the crsctl status category command to obtain information about a server category.
crsctl status category {category_name [category_name [...]] | [-w "filter" |
-server server_name]}
Table E-64 crsctl status category Command Parameters
| Parameter | Description |
|---|---|
category_name
|
Specify the name of the server category or a space-delimited list of server categories for which you want to obtain the status. |
-w "filter"
|
Alternatively, you can specify a category filter preceded by the See Also: "Filters" for more information |
-server server_name
|
Alternatively, you can specify a particular server to list all of the categories that the server matches. |
To obtain the status of a server category using filters:
$ crsctl stat category -w "ACTIVE_CSS_ROLE = hub" NAME=my_category_i ACL=owner:mjkeenan:rwx,pgrp:svrtech:rwx,other::r-- ACTIVE_CSS_ROLE = hub EXPRESSION=(CPU_COUNT > 3)
To obtain the status of a server category by server:
$ crsctl stat category -server node1 NAME=my_category ACL=owner:mjkeenan:rwx,pgrp:svrtech:rwx,other::r-- ACTIVE_CSS_ROLE = hub EXPRESSION=
Use the crsctl status ip command to check if a given IP address is up on the network.
Use the crsctl status policy command to view the status and definition of a configuration policy.
Table E-66 crsctl status policy Command Parameters
| Parameter | Description |
|---|---|
policy_name
|
Specify the name of the policy or a space-delimited list of policy names for which you want to view the status. |
-w "filter"
|
Alternatively, you can specify a policy filter preceded by the See Also: "Filters" for more information |
-active |
Alternatively, you can specify this parameter to display the status of the active policy. |
Use the crsctl status policyset command to view the current policies in the policy set, including the access control list, which governs who can modify the set, the last activated policy, and the configuration which is now in effect, which is known as the Current policy.
Table E-67 crsctl status policyset Command Parameters
| Parameter | Description |
|---|---|
-file file_name
|
You can specify this parameter to create a file that you can edit and then send back using If you do not specify this optional parameter, then CRSCTL displays the Current configuration. |
Privileges necessary to run this command depend on the value of the ACL attribute of the policy set
This command returns output similar to the following:
ACL=owner:'mjkeenan:rwx,pgrp:g900:rwx,other::r--' LAST_ACTIVATED_POLICY=DayTime SERVER_POOL_NAMES=Free pool1 pool2 pool3 POLICY NAME=DayTime DESCRIPTION=Test policy SERVERPOOL NAME=pool1 IMPORTANCE=0 MAX_SIZE=2 MIN_SIZE=2 SERVER_CATEGORY= SERVER_NAMES= SERVERPOOL NAME=pool2 IMPORTANCE=0 MAX_SIZE=1 MIN_SIZE=1 SERVER_CATEGORY= SERVERPOOL NAME=pool3 IMPORTANCE=0 MAX_SIZE=1 MIN_SIZE=1 SERVER_CATEGORY= POLICY NAME=NightTime DESCRIPTION=Test policy SERVERPOOL NAME=pool1 IMPORTANCE=0 MAX_SIZE=1 MIN_SIZE=1 SERVER_CATEGORY= SERVERPOOL NAME=pool2 IMPORTANCE=0 MAX_SIZE=2 MIN_SIZE=2 SERVER_CATEGORY= SERVERPOOL NAME=pool3 IMPORTANCE=0 MAX_SIZE=1 MIN_SIZE=1 SERVER_CATEGORY= POLICY NAME=Weekend DESCRIPTION=Test policy SERVERPOOL NAME=pool1 IMPORTANCE=0 MAX_SIZE=0 MIN_SIZE=0 SERVER_CATEGORY= SERVERPOOL NAME=pool2 IMPORTANCE=0 MAX_SIZE=1 MIN_SIZE=1 SERVER_CATEGORY= SERVERPOOL NAME=pool3 IMPORTANCE=0 MAX_SIZE=3 MIN_SIZE=3 SERVER_CATEGORY=
Use the crsctl status server command to obtain the status and configuration information of one or more particular servers.
crsctl status server {server_name [...] | -w "filter"} [-g | -p | -v | -f] |
[-category category_name | -w "filter"]
Table E-68 crsctl status server Command Parameters
| Parameter | Description |
|---|---|
server_name [...]
|
Specify one or more space-delimited server names. |
-w "filter"
|
Specify a filter to determine which servers are displayed. The filter must be enclosed in double quotation marks ( See Also: "Filters" for more information |
-g | -p | -v | -f |
You can specify one of the following parameters when Oracle Clusterware checks the status of specific servers:
|
-category category_name
|
You can specify a particular category of servers for which to obtain status. |
-w "filter"
|
Specify a filter to determine which categories are displayed. The filter must be enclosed in double quotation marks ( See Also: "Filters" for more information |
The crsctl status server command returns output similar to the following:
NAME=node1 STATE=ONLINE NAME=node2 STATE=ONLINE
The full configuration of a specific server is similar to the following:
NAME=node2 MEMORY_SIZE=72626 CPU_COUNT=12 CPU_CLOCK_RATE=1711 CPU_HYPERTHREADING=0 CPU_EQUIVALENCY=1000 DEPLOYMENT=other CONFIGURED_CSS_ROLE=hub RESOURCE_USE_ENABLED=1 SERVER_LABEL= PHYSICAL_HOSTNAME= STATE=ONLINE ACTIVE_POOLS=ora.pool1 STATE_DETAILS= ACTIVE_CSS_ROLE=hub
Use the crsctl status serverpool command to obtain the status and configuration information of one or more particular server pools.
crsctl status serverpool [server_pool_name [...] | -w "filter"] [-p | -v | -f] crsctl status serverpool {[server_pool_name [...]} -g
Table E-69 crsctl status serverpool Command Parameters
| Parameter | Description |
|---|---|
[server_pool_name [...] -g
|
Specify one or more space-delimited server pool names to identify specific server pools.
Note: You cannot use the |
[-w "filter"]
|
Use this parameter to specify a filter, such as See Also: "Filters" for more information |
[-p | -v | -f] |
You can optionally specify one of the following parameters:
|
The server_pool_name parameter or a filter is required
Do not use this command for any server pools with names that begin with ora because these server pools are Oracle server pools
While you can use this command in either environment, it is only useful in the Oracle RAC environment
To display the full configuration of the server pool sp1:
$ crsctl status serverpool sp1 -f NAME=spl IMPORTANCE=1 MIN_SIZE=0 MAX_SIZE=-1 SERVER_NAMES=node3 node4 node5 PARENT_POOLS=Generic EXCLUSIVE_POOLS= ACL=owner:oracle:rwx,pgrp:oinstall:rwx,other::r-- SERVER_CATEGORY=ora.hub.category ACTIVE_SERVERS=node3 node4
To display all the server pools and the servers associated with them, use the following command:
$ crsctl status serverpool NAME=Free ACTIVE_SERVERS= NAME=Generic ACTIVE_SERVERS=node1 node2 NAME=ora.orcl ACTIVE_SERVERS=node1 node2 NAME=sp1 ACTIVE_SERVERS=node3 node4
To find a server pool that meets certain criteria, use the following command:
$ crsctl status serverpool -w "MAX_SIZE > 1" NAME=sp2 ACTIVE_SERVERS=node3 node4
Use the crsctl status testdns command to query the test DNS server running on a specified address and local host name.
Table E-70 crsctl status testdns Command Parameters
| Parameter | Description |
|---|---|
-server DNS_server_address
|
Specify the DNS server address for which you want to check the status. |
-port port
|
The port on which the DNS server listens. If you do not specify a port, then it defaults to port 53. |
-v |
Verbose output. |
Use the crsctl stop cluster command on any node in the cluster to stop the Oracle Clusterware stack on all servers in the cluster or specific servers.
If you do not specify -all or one or more space-delimited server names, then Oracle Clusterware stops the Oracle Clusterware stack on the local server.
You can use this cluster-aware command on any node in the cluster.
This command attempts to gracefully stop resources managed by Oracle Clusterware while attempting to stop the Oracle Clusterware stack.
If any resources that Oracle Clusterware manages are still running after you run the crsctl stop cluster command, then the command fails. Use the -f parameter to unconditionally stop all resources and stop the Oracle Clusterware stack.
If you intend to stop Oracle Clusterware on all or a list of nodes, then use the crsctl stop cluster command, because it prevents certain resources from being relocated to other servers in the cluster before the Oracle Clusterware stack is stopped on a particular server. If you must stop the Oracle High Availability Services on one or more nodes, then wait until the crsctl stop cluster command completes and then run the crsctl stop crs command on any particular nodes, as necessary.
Use the crsctl stop crs command to stop Oracle High Availability Services on the local server.
You must run this command as root.
This command attempts to gracefully stop resources managed by Oracle Clusterware while attempting to stop Oracle High Availability Services on the local server.
If any resources that Oracle Clusterware manages are still running after you run the crsctl stop crs command, then the command fails. Use the -f parameter to unconditionally stop all resources and stop Oracle High Availability Services on the local server.
If you intend to stop Oracle Clusterware on all or a list of nodes, then use the crsctl stop cluster command, because it prevents certain resources from being relocated to other servers in the cluster before the Oracle Clusterware stack is stopped on a particular server. If you must stop the Oracle High Availability Services on one or more nodes, then wait until the crsctl stop cluster command completes and then run the crsctl stop crs command on any particular nodes, as necessary.
Before attempting to shut down the Oracle Clusterware technology stack on all nodes with an Oracle ASM instance running in parallel in an Oracle Clusterware standard Cluster with Oracle Flex ASM enabled, you must first relocate at least one Oracle ASM instance to another node where Oracle ASM is not running.
In Oracle Clusterware 11g release 2 (11.2.0.3), when you run this command in Solaris Sparc and Solaris X64 environments, drivers remain loaded on shutdown and subsequent startup. This does not happen in Linux environments.
Use the crsctl stop ip command to stop a given IP name or IP address on a specified interface with a specified subnet mask. Run this command on the server on which you want to stop the IP.
The crsctl stop rollingpatch command transitions Oracle Clusterware and Oracle ASM out of rolling patch mode. Once transitioned out of rolling patch mode, the software does not tolerate nodes having different patch levels.
This command queries the Oracle Clusterware rolling patch state and Oracle ASM cluster state. If either one is in rolling patch mode, it will use the appropriate method to transition Oracle Clusterware or Oracle ASM out of rolling patch mode.
This command verifies that all the nodes in the cluster have a consistent patch level, and returns an error otherwise.
If neither Oracle Clusterware or Oracle ASM are in rolling patch mode when you issue this command, then this command does nothing.
This command does not transition Oracle ASM out of rolling patch mode if issued within an Oracle ASM Client Cluster.
Use the crsctl stop testdns command to stop a test DNS server.
Table E-72 crsctl stop testdns Command Parameters
| Parameter | Description |
|---|---|
-address address
|
Specify the server address for which you started the test DNS server in the form |
-port port
|
The port on which the DNS server listens. If you do not specify a port, then it defaults to port 53. |
[-domain GNS_domain]
|
Domain for which the server should stop listening. |
-v |
Verbose output. |
Use the crsctl unpin css command to unpin many servers. If a node is not pinned, its node number may change if the lease expires while it is down.
You can specify a space-delimited list of nodes.
Unpinned servers that stop for longer than a week are no longer reported by olsnodes. These servers are dynamic when they leave the cluster, so you do not need to explicitly remove them from the cluster.
Deleting a node with the crsctl delete node command implicitly unpins the node.
During upgrade of Oracle Clusterware, all servers are pinned, whereas after a fresh installation of Oracle Clusterware 12c, all servers you add to the cluster are unpinned.
You cannot unpin a server that has an instance of Oracle RAC that is older than 12c release 1 (12.1) if you installed Oracle Clusterware 12c on that server.
Use the crsctl unset css command to unset the value of a Cluster Synchronization Services parameter and restore it to its default value.
Use the crsctl unset css ipmiconfig command to clear all previously stored IPMI configuration (login credentials and IP address) from the Oracle Local Registry. This is appropriate when deconfiguring IPMI in your cluster or if IPMI configuration was previously stored by the wrong user.
This command must be run under the user account originally used to configure IPMI or by a privileged user.
This command only clears the IPMI configuration on the server on which you run it.
If Oracle Clusterware was able to access and use the configuration data to be deleted by this command, then it will continue to do so until you restart Oracle Clusterware.
The commands listed in this section control Oracle High Availability Services. These commands manage the Oracle High Availability Services stack in the Oracle Restart environment, which consists of the Oracle High Availability Services daemon (ohasd), Oracle ASM (if installed), and Cluster Synchronization Services (if Oracle ASM is installed). These commands only affect the local server on which you run them.
Note:
Oracle does not support usingcrs_* commands in an Oracle Restart environment.Each server in the cluster is in one of two possible states:
The whole stack is up, which means that Oracle High Availability Services is active
The whole stack is down, which means that Oracle High Availability Services is inactive
You can use the following commands in the Oracle Restart environment, only:
Use the crsctl check has command to display the automatic startup configuration of the Oracle High Availability Services stack on the server.
Use the crsctl disable has command to disable automatic startup of the Oracle High Availability Services stack when the server boots up.
Use the crsctl enable has command to enable automatic startup of the Oracle High Availability Services stack when the server boots up.
Use the crsctl query has releaseversion command to display the release version of the Oracle Clusterware software that is stored in the binaries on the local node.
Use the crsctl query has softwareversion command to display the software version on the local node.
Use the crsctl start has command to start Oracle High Availability Services on the local server.
Use the crsctl stop has command to stop Oracle High Availability Services on the local server.
This command attempts to gracefully stop resources managed by Oracle Clusterware while attempting to stop Oracle High Availability Services.
If any resources that Oracle Clusterware manages are still running after you run the crsctl stop has command, then the command fails. Use the -f parameter to unconditionally stop all resources and stop Oracle High Availability Services.
You can use crsctl set log commands as the root user to enable dynamic debugging for Cluster Ready Services (CRS), Cluster Synchronization Services (CSS), and the Event Manager (EVM), and the clusterware subcomponents. You can dynamically change debugging levels using crsctl debug commands. Debugging information remains in the Oracle Cluster Registry (OCR) for use during the next startup. You can also enable debugging for resources.
This section covers the following topics:
Use the crsctl set log command to set log levels for Oracle Clusterware.
crsctl set log {[crs | css | evm "component_name=log_level, [...]"] |
[all=log_level]}
You can also set log levels for the agents of specific resources, as follows:
crsctl set log res "resource_name=log_level, [...]"
You can set log levels for various components of the three modules, CRS, CSS, and EVM. If you choose the all parameter, then you can set log levels for all components of one module with one command. Use the crsctl lsmodules command to obtain a list of components for each module.
Enter a comma-delimited list of component name-log level pairs enclosed in double quotation marks ("").
Note:
Separate component name-log level pairs with an equals sign (=) in Oracle Clusterware 11g release 2 (11.2.0.3), and later. Previous Oracle Clusterware versions used a colon (:).The log_level is a number from 1 to 5 that sets the log level for the component or resource, where 1 is the least amount of log output and 5 provides the most detailed log output. The default log level is 2.
To set log levels for resources, specify the name of a particular resource, or a comma-delimited list of resource name-log level pairs enclosed in double quotation marks ("").
You can use crsctl set log and crsctl set trace commands as the root user to enable dynamic debugging for the various Oracle Clusterware modules.
You can enable debugging for Oracle Clusterware modules and their components, and for resources, by setting environment variables or by running crsctl set log commands, using the following syntax:
crsctl set {log | trace} module_name "component:debugging_level
[,component:debugging_level][,...]"
Run the crsctl set command as the root user, and supply the following information:
module_name: The name of one of the following modules:
mdns: Multicast domain name servergpnp: Grid Plug and Play servicecss: Cluster Synchronization Servicescrf: Cluster Health Monitorcrs: Cluster Ready Servicesctss: Cluster Time Synchronization Serviceevm: Event Managergipc: Grid Interprocess Communicationcomponent: The name of a component for one of the modules. See Table E-73 for a list of all of the components.
debugging_level: A number from 1 to 5 to indicate the level of detail you want the debug command to return, where 1 is the least amount of debugging output and 5 provides the most detailed debugging output. The default debugging level is 2.
The following commands show examples of how to enable debugging for the various modules:
To enable debugging for Oracle Clusterware:
crsctl set log crs "CRSRTI:1,CRSCOMM:2"
To enable debugging for OCR:
crsctl set log crs "CRSRTI:1,CRSCOMM:2,OCRSRV:4"
To enable debugging for EVM:
crsctl set log evm "EVMCOMM:1"
To enable debugging for resources
crsctl set log res "resname:1"
To obtain a list of components that can be used for debugging, run the crsctl lsmodules command, as follows:
crsctl lsmodules {mdns | gpnp | css | crf | crs | ctss | evm | gipc}
Note:
You do not have to be theroot user to run the crsctl lsmodulues command.Table E-73 shows the components for the CRS, CSS, and EVM modules, respectively. Note that some component names are common between the CRS, EVM, and CSS daemons and may be enabled on that specific daemon. For example, COMMNS is the NS layer and because each daemon uses the NS layer, you can enable this specific module component on any of the daemons to get specific debugging information.
Table E-73 Components for the CRS, CSS, and EVM Modules
| CRS ComponentsFoot 1 | CSS ComponentsFoot 2 | EVM ComponentsFoot 3 |
|---|---|---|
CRSUI CRSCOMM CRSRTI CRSMAIN CRSPLACE CRSAPP CRSRES CRSCOMM CRSOCR CRSTIMER CRSEVT CRSD CLUCLS CSSCLNT COMMCRS COMMNS |
CSSD COMMCRS COMMNS |
EVMD EVMDMAIN EVMCOMM EVMEVT EVMAPP EVMAGENT CRSOCR CLUCLS CSSCLNT COMMCRS COMMNS |
Footnote 1 Obtain the list of CRS components using the crsctl lsmodules crs command.
Footnote 2 Obtain the list of CSS components using the crsctl lsmodules css command.
Footnote 3 Obtain the list of EVM components using the crsctl lsmodules evm command.
To set debugging levels on specific cluster nodes, include the -nodelist keyword and the names of the nodes, as follows:
crsctl set log crs "CRSRTI:1,CRSCOMM:2" -nodelist node1,node2
Table E-74 describes the Cluster Synchronization Services modules.
Table E-74 Cluster Synchronization Services (CSS) Modules and Functions
| Module | Description |
|---|---|
|
CSS |
CSS client component |
|
CSSD |
CSS daemon component |
Table E-75 describes the function of each communication (COMM) module.
Table E-75 Communication (COMM) Modules and Functions
| Module | Description |
|---|---|
|
COMMCRS |
Clusterware communication layer |
|
COMMNS |
NS communication layer |
Table E-76 describes the functions performed by each CRS module.
Table E-76 Oracle Clusterware (CRS) Modules and Functions
| Module | Descriptions |
|---|---|
|
CRSUI |
User interface module |
|
CRSCOMM |
Communication module |
|
CRSRTI |
Resource management module |
|
CRSMAIN |
Main module/driver |
|
CRSPLACE |
CRS placement module |
|
CRSAPP |
CRS application |
|
CRSRES |
CRS resources |
|
CRSOCR |
Oracle Cluster Registry interface |
|
CRSTIMER |
Various timers related to CRS |
|
CRSEVT |
CRS EVM/event interface module |
|
CRSD |
CRS daemon |
Using the crsctl set log crs command, you can debug the OCR components listed in Table E-77. The components listed in Table E-77 can also be used for the Oracle Local Registry (OLR) except for OCRMAS and OCRASM. You can also use them for OCR and OLR clients, except for OCRMAS and OCRSRV. Some OCR and OLR clients are OCRCONFIG, OCRDUMP, and so on.
Table E-77 Oracle Cluster Registry (OCR) Component Names
| Module | Description |
|---|---|
|
OCRAPI |
OCR abstraction component |
|
OCRCLI |
OCR client component |
|
OCRSRV |
OCR server component |
|
OCRMAS |
OCR master thread component |
|
OCRMSG |
OCR message component |
|
OCRCAC |
OCR cache component |
|
OCRRAW |
OCR raw device component |
|
OCRUTL |
OCR util component |
|
OCROSD |
OCR operating system dependent (OSD) layer |
|
OCRASM |
OCR ASM component |
Table E-78 describes the OCR tool modules.
You can enable debugging for Oracle Clusterware resources by running the crsctl set log command, using the following syntax:
crsctl set log res "resource_name=debugging_level"
Run the crsctl set log command as the root user, and supply the following information:
debugging_level: A number from 1 to 5 to indicate the level of detail you want the debug command to return, where 1 is the least amount of debugging output and 5 provides the most detailed debugging output. The default debugging level is 2.
To obtain a list of resources that can be used for debugging, run the crsctl status resource command.
Example
To generate a debugging log for the VIP resource on node1, issue the following command:
crsctl set log res "ora.node1.vip:1"
My Oracle Support may ask you to enable tracing to capture additional information. Because the procedures described in this section may affect performance, only perform these activities with the assistance of My Oracle Support.
You can enable tracing for Oracle Clusterware resources by running the crsctl set trace command, using the following syntax:
crsctl set trace module_name "component_name=tracing_level,..."
Run the crsctl set trace command as the root user, and supply the following information:
module_name: The name of one of the following modules:
mdns: Multicast domain name servergpnp: Grid Plug and Play servicecss: Cluster Synchronization Servicescrf: Cluster Health Monitorcrs: Cluster Ready Servicesctss: Cluster Time Synchronization Serviceevm: Event Managergipc: Grid Interprocess Communicationcomponent_name: The name of the component for one of the modules. See Table E-73 for a list of components.
tracing_level: A number from 1 to 5 to indicate the level of detail you want the trace command to return, where 1 is the least amount of tracing output and 5 provides the most detailed tracing output.