G Server Control (SRVCTL) Command Reference
Use the Server Control (SRVCTL) utility to manage various components and applications in your cluster.
This appendix contains reference information for Server Control commands, including utility usage information and a comprehensive listing of the SRVCTL commands.
G.1 SRVCTL Usage Information
SRVCTL is installed on each node in a cluster by default. To use SRVCTL, log in to the operating system of a node and enter the SRVCTL command and its parameters in case-sensitive syntax.
-
Only use the version of SRVCTL that is provided with Oracle Database 12c on Oracle RAC databases that are created for or upgraded to Oracle Database 12c. The version of SRVCTL must be the same as the version of the object (listeners, Oracle ASM instances, Oracle RAC databases and their instances, and services) being managed. To ensure the versions are the same release, run SRVCTL commands from the Oracle home of the database or object you are managing.
-
SRVCTL does not support concurrent executions of commands on the same object. Therefore, run only one SRVCTL command at a time for each database, service, or other object.
-
When specifying a comma-delimited list as part of a SRVCTL command, there should not be any spaces between the items in the list. For example:
srvctl add database -serverpool "serverpool1,serverpool3"
When you specify a comma-delimited list in a Windows environment, you must enclose the list in double quotation marks (
""
). You can enclose a comma-delimited list in double quotation marks in a Linux or UNIX environment but they will be ignored. -
If you are entering a SRVCTL command, and you want to continue the input on a new line, then you can use the operating system continuation character. In Linux, this is the backslash (\) symbol.
-
A SRVCTL command that produces no output is a successful command. Not all SRVCTL commands return a message when it completes, successfully. However, if a SRVCTL command fails, then it always returns an error message.
-
You can use the
-eval
parameter with several SRVCTL commands. This parameter, when you use it, enables you to simulate running a command without making any changes to the system. SRVCTL returns output that informs you what will happen if you run a particular command. For example, to know what might happen if you relocate a server:$ srvctl relocate server –servers "rac1" –eval –serverpool pool2 Database db1 will stop on node rac1 will start on node rac7 Service mySrv1 will stop on node rac1, it will not run on any node Service myServ2 will stop on node rac1 will start on node rac6 Server rac1 will be moved from pool myPoolX to pool pool2
The
-eval
parameter is available with the following commands:-
srvctl add database
-
srvctl add service
-
srvctl add srvpool
-
srvctl modify database
-
srvctl modify service
-
srvctl modify srvpool
-
srvctl relocate server
-
srvctl relocate service
-
srvctl remove srvpool
-
srvctl start database
-
srvctl start service
-
srvctl stop database
-
srvctl stop service
-
G.2 Specifying Command Parameters as Keywords Instead of Single Letters
Before Oracle Database 12c, the SRVCTL command-line interface used single letter parameters. However, this imposes a limit on the number of unique parameters available for use with SRVCTL commands. SRVCTL command parameters introduced in Oracle Database 12c are full words instead of single letters, such as -multicastport
and -subdomain
.
To support backward compatibility, you can use a mix of single-letter parameters and new keyword parameters. New parameters introduced with keywords can be used with single letter parameters.
Note:
Starting with Oracle Database 12c, the single letter parameters are deprecated in favor of the keyword parameters to avoid using the same letter to implement different functionality depending on the command.
You can obtain the single-letter equivalents, where applicable, by adding the -compatible
parameter after the -help
parameter.
G.3 Character Set and Case Sensitivity of SRVCTL Object Values
SRVCTL interacts with many different types of objects. The character set and name length limitations, and whether the object name is case sensitive, can vary between object types.
Table G-1 String Restrictions for SRVCTL Object Names
Object Type | Character Set Limitations | Case Sensitive? | Maximum Length |
---|---|---|---|
db_domain |
Alpha-numeric characters, underscore (_), and number sign (#) |
128 characters |
|
db_unique_name |
Alpha-numeric characters, underscore (_), number sign (#), and dollar sign ($); the first 8 characters must be unique because those characters are used to form instance names for policy-managed databases |
No |
30 characters but the first 8 characters must be unique relative to any other database in the same cluster |
diskgroup_name |
Naming disk groups have the same limitations as naming other database objects. See Also: Oracle Database SQL Language Reference for more information about database object naming rules |
No (all names are converted to uppercase) |
|
instance_name |
Alpha-numeric characters |
Depends on the platform |
15 characters |
listener_name |
|||
node_name |
No |
||
scan_name |
The first character must be an alphabetic character |
No |
|
server_pool |
Alpha-numeric characters, underscore (_), number sign (#), period (.), and dollar sign ($); the name cannot begin with a period, contain single quotation marks ( |
250 characters |
|
service_name |
250 characters |
||
volume_name |
Alphanumeric characters; dashes (-) are not allowed and the first character must be an alphabetic character. |
No |
11 characters |
G.4 Using SRVCTL Help
This section includes information about using context sensitive help with SRVCTL.
To see help for all SRVCTL commands, from the command line enter:
srvctl -help
To see the command syntax and a list of parameters for each SRVCTL command, from the command line enter:
srvctl command (or verb) object (or noun) -help
When you request online help for a command using -help
, SRVCTL prints the full words for each parameter. You can obtain the single-letter equivalents, where applicable, by adding the -compatible
parameter after the -help
parameter. For example:
$ srvctl config database -help -compatible
The preceding command prints usage information for the srvctl config database
command, listing all parameters as full words followed by their single-letter equivalents in parentheses, where applicable.
To see the SRVCTL version number enter:
$ srvctl -version
G.5 SRVCTL Privileges and Security
To use SRVCTL to change your Oracle RAC database configuration, log in to the operating system as the software owner of the home that you want to manage.
For example, if different users installed Oracle Database and the Oracle Grid Infrastructure, then log in as the database software owner (for example, ora_db
) to manage databases and log in as the Oracle Grid Infrastructure software owner (for example, ora_asm
) to manage the Oracle ASM instances.
Users who are members of the OSDBA operating system group can start and stop the database. To stop and start an Oracle ASM instance, you must be a member of the OSASM operating system group.
To create or register objects such as listeners, Oracle Notification Services, and services, you must be logged in to the operating system as the software owner of the Oracle home. The objects you create or register for that Oracle home will run under the user account of the owner of the Oracle home. Databases run as the database installation owner of the home from which they run.
To perform srvctl add
operations on any object, you must be logged in as the Oracle account owner of the home on which the object runs.
For some SRVCTL commands, on Linux and UNIX systems, you must be logged in as root
, and on Windows systems, you must be logged in as a user with Administrator privileges to run them. In this appendix, those commands are preceded by the root prompt (#) in the command examples.
G.6 Additional SRVCTL Topics
-
Use SRVCTL to manage Oracle-supplied resources such as listener, instances, disk groups, and networks, and CRSCTL for managing Oracle Clusterware and its resources.
Note:
Oracle strongly discourages directly manipulating Oracle-supplied resources (resources whose names begin with ora) using CRSCTL. This could adversely impact the cluster configuration.
-
Although you may be able to cancel running SRVCTL commands by pressing the Control-C keys, you may corrupt your configuration data by doing this.
You are strongly advised not to attempt to terminate SRVCTL in this manner.
G.7 Deprecated SRVCTL Subprograms or Commands
A number of SRVCTL commands and parameters have been deprecated in this release.
G.7.1 Single Character Parameters for all SRVCTL Commands
Single-character parameters have been deprecated in Oracle Database 12c.
Use the full keyword for each parameter instead. To support older tools and scripts that still use single-character parameters, the current version of SRVCTL supports both single-character parameters and full keyword parameters.
The command reference in this appendix shows the keywords for each SRVCTL command. Table G-2 lists the deprecated single-character parameters.
Table G-2 Deprecated Single-Character Parameters for SRVCTL Commands
Single Letter | Long Form | Values | Description | Related Commands |
---|---|---|---|---|
A |
address |
{VIP_name | IP}/netmask/ [if1[|if2...]] |
VIP address specification for node applications |
Node applications, VIP, network, Listener, SCAN VIP, and SCAN listener commands |
a |
all |
|
All resources of that kind |
Common |
a |
diskgroup |
diskgroup_list |
Comma-delimited list of Oracle ASM disk groups |
Database, instance, Oracle ASM, disk group, and file system commands |
a |
detail |
|
Print detailed configuration information |
Common |
a |
available |
available_list |
A comma-delimited list of available instances |
Service and server pool commands |
a |
abort |
Abort failed online relocation |
Relocate database |
|
a |
viponly |
|
Display VIP configuration |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
B |
rlbgoal |
{NONE| SERVICE_TIME| THROUGHPUT} |
The runtime load balancing goal of a service |
Service and server pool commands |
c |
currentnode |
current_node |
Node name from which to relocate the service |
Service and server pool commands |
c |
cardinality |
{UNIFORM| SINGLETON} |
Whether the service should run on every active server in the server pool (UNIFORM) or just one server (SINGLETON) |
Service and server pool commands |
c |
dbtype |
type |
Type of database: Oracle RAC One Node, Oracle RAC, or single instance |
Database, instance, Oracle ASM, disk group, and file system commands |
d |
db or database |
db_unique_name |
Database unique name |
Common |
d |
device |
volume_device |
Volume device path |
Database, instance, Oracle ASM, disk group, and file system commands |
d |
domain |
|
Display subdomain served by GNS |
OC4J, home, CVU, and GNS commands |
e |
emport |
em_port_number |
Local listen port for Oracle Enterprise Manager |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
e |
failovertype |
{NONE|SESSION BASIC|TRANSACTION} |
The failover type for a service |
Service and server pool commands |
e |
server |
server_list |
Candidate server list for Oracle RAC One Node database |
Database, instance, Oracle ASM, disk group, and file system commands |
f |
force |
Force remove |
Common |
|
g |
diskgroup |
diskgroup_name |
Disk group name |
File system, Diskgroup commands |
g |
gsdonly |
Display GSD configuration |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
|
g |
serverpool |
server_pool_name server_pool_list |
A server pool name Comma-delimited list of database server pool names |
Service and server pool commands Database, instance, Oracle ASM, disk group, and file system commands |
h |
help |
Common |
||
i |
importance |
number |
A number that represents the importance of the server pool |
Service and server pool commands |
i |
instance |
instance_name instance_list |
Instance name prefix for administrator-managed Oracle RAC One Node database A comma-delimited list of instance names |
Database, instance, Oracle ASM, disk group, and file system commands |
I |
ip |
ip_address |
VIP address on which GNS is to listen |
OC4J, home, CVU, and GNS commands |
i |
oldinst |
instance_name |
The old instance name |
Service and server pool commands |
i |
scannumber |
scan_ordinal _number |
Ordinal number of the IP address for the SCAN |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
i |
vip |
vip_name or "vip_name_list" |
VIP names |
Node applications, GNS, VIP, network, listener, SCAN VIP, and SCAN listener commands |
j |
acfspath |
acfs_path_list |
Comma-delimited list of Oracle ACFS paths where the dependency on the database will be set |
Database, instance, Oracle ASM, disk group, and file system commands |
j |
clbgoal |
{SHORT|LONG} |
The connection load balancing goal for a service |
Service and server pool commands |
k |
netnum |
network_number |
The network number |
Service and server pool commands Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands OC4J, home, CVU, and GNS commands |
l |
list |
|
List all records in GNS |
OC4J, home, CVU, and GNS commands |
l |
listener |
|
The name of a listener |
ASM commands |
l |
loglevel |
log_level |
Specify the level (0-6) of logging that GNS should run with |
OC4J, home, CVU, and GNS commands |
l |
min |
number |
The minimum size of the server pool |
Service and server pool commands |
l |
onslocalport |
port_number |
Oracle Notification Service listening port for local client connections |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
l |
role |
service_role |
Comma-delimited list of server roles within double quotation marks ( |
Service and server pool commands |
m |
domain |
domain_name |
The domain for the database |
Database, instance, Oracle ASM, disk group, and file system commands |
|
failovermethod |
{NONE|BASIC} |
The failover method of a service |
Service and server pool commands |
m |
multicastpost |
|
The port on which the GNS daemon is listening for multicast requests |
OC4J, home, CVU, and GNS commands |
m |
path |
mountpoint_path |
Mountpoint path |
Database, instance, Oracle ASM, disk group, and file system commands |
n |
name |
|
Advertise a name through GNS using the given address |
OC4J, home, CVU, and GNS commands |
n |
node |
node_name |
The name of a specific node |
Common |
n |
nodes |
node_list |
A comma-delimited list of node names |
File system commands |
n |
dbname |
database_name |
The database name (DB_NAME), if different from the unique name specified by the |
Database, instance, Oracle ASM, disk group, and file system commands |
n |
scanname |
scan_name |
Fully-qualified SCAN name (includes the domain) |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
n |
servers |
server_list |
A comma-delimited list of candidate server names |
Service and server pool commands |
n |
targetnode |
node_name |
Node name to which to relocate the service |
Service and server pool commands |
o |
oraclehome |
oracle_home |
|
Database commands |
p |
endpoints |
[TCP:]port _number[/IPC: key][/NMP:pipe _name][/TCPS: s_port][/SDP: port] |
SCAN listener endpoints |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
p |
port |
|
The port which the GNS daemon uses to communicate with the DNS server |
OC4J, home, CVU, and GNS commands |
p |
rmiport |
port_number |
OC4J RMI port number |
OC4J, home, CVU, and GNS commands |
P |
tafpolicy |
{NONE|BASIC} |
TAF policy specification |
Service and server pool commands |
p |
spfile |
spfile_location |
Server parameter file path |
Database, instance, Oracle ASM, disk group, and file system commands |
q |
notification |
{TRUE|FALSE} |
Whether FAN is enabled for OCI connections |
Service commands |
q |
query |
|
Query GNS for the records belonging to a name |
OC4J, home, CVU, and GNS commands |
r |
preferred |
preferred_list |
A comma-delimited list of preferred instances |
Service and server pool commands |
r |
onsremoteport |
port_number |
Oracle Notification Service listening port for connections from remote hosts |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
r |
relocate |
|
Relocate the VIP |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
r |
revert |
Remove target node of failed online relocation request from the candidate server list of administrator-managed Oracle RAC One Node database |
Relocate database |
|
r |
role |
role_type |
Role of the standby database: |
Database, instance, Oracle ASM, disk group, and file system commands |
s |
onsonly |
|
Display Oracle Notification Service daemon configuration |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
s |
skip |
Skip checking the ports |
Listener, SCAN, and SCAN listener. |
|
s |
statfile |
file_name |
The file path of the |
OC4J, home, CVU, and GNS commands |
s |
status |
|
Display the status of GNS |
OC4J, home, CVU, and GNS commands |
S |
subnet |
subnet/net _mask/[if1[| if2...]] |
Network address specification for a network |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
s |
service |
service_name service_name_list |
The name of a service A comma-delimited list of service names |
Service and server pool commands |
s |
startoption |
start_options |
Startup options for the database (mount, open, read only) |
Database, instance, Oracle ASM, disk group, and file system commands |
t |
checkinterval |
time_interval |
Interval in minutes between checks |
OC4J, home, CVU, and GNS commands |
t |
edition |
edition_name |
The initial session edition of a service |
Service and server pool commands |
t |
envs |
"name_list" |
A list of environment variables |
Common |
t |
namevals |
"name= value,..." |
Names and values of environment variables |
Common |
T |
nameval |
"name=value" |
Name and value of a single environment variable |
Common |
t |
update |
instance_name |
The new instance name |
Service and server pool commands |
t |
remoteservers |
host_name[: port_number] [,host_name[: port_number]...] |
List of remote host name and port number pairs for Oracle Notification Service daemons outside this cluster |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
t |
stopoption |
stop_options |
Stop options for the database ( |
Database, instance, Oracle ASM, disk group, and file system commands |
t |
toversion |
target_version |
Version to which you are downgrading |
Database, instance, Oracle ASM, disk group, and file system commands |
u |
max |
number |
Maximum size of the server pool |
Service and server pool commands |
u |
nettype |
network_type |
The network server type, which can be |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
u |
newinst |
Add a new instance to the service configuration |
Service commands |
|
u |
update |
|
Update SCAN listeners to match the number of SCAN VIPs |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
u |
user |
oracle_user |
Oracle user or other authorized user to mount and unmount file systems |
Database, instance, Oracle ASM, disk group, and file system commands |
v |
verbose |
|
Verbose output |
Common |
v |
volume |
volume_name |
Name of a volume |
Database, instance, Oracle ASM, disk group, and file system commands |
V |
versions |
|
|
Common |
w |
failoverdelay |
number |
Failover delay |
Service and server pool commands |
w |
nettype |
network_type |
The network server type, which can be |
Node applications, VIP, network, listener, SCAN VIP, and SCAN listener commands |
w |
timeout |
timeout |
Online relocation timeout in minutes |
Database, instance, Oracle ASM, disk group, and file system commands |
x |
dtp |
{TRUE | FALSE} |
Whether to enable distributed transaction processing |
Service and server pool commands |
x |
node |
node_name |
Node name (use this parameter only with noncluster databases) |
Common |
y |
noprompt |
|
Suppress the confirmation prompt |
Common |
y |
policy |
{AUTOMATIC | MANUAL} |
Management policy for the resource |
Database, instance, Oracle ASM, disk group, file system, service and server pool commands |
z |
failoverretry |
number |
Number of failover retries |
Service and server pool commands |
z |
rmdepondisk |
|
To remove a database's dependency upon disk groups |
Database, instance, Oracle ASM, disk group, and file system commands |
G.7.2 Miscellaneous SRVCTL Commands and Parameters
The following command parameters have been deprecated in this release:
Table G-3 Deprecated Commands and Parameters for SRVCTL
Command | Deprecated Parameters |
---|---|
srvctl modify asm |
|
srvctl modify instance |
Instead, use the |
srvctl modify gns |
Use the |
srvctl * oc4j |
The |
srvctl add service |
The |
srvctl modify service |
The The |
G.8 SRVCTL Command Reference
This section lists and describes all SRVCTL commands that are run from the Oracle Grid Infrastructure home.
See Also:
Oracle Real Application Clusters Administration and Deployment Guide for SRVCTL command usage information
G.8.1 srvctl add asm
Adds a record for an Oracle ASM instance to the entire cluster.
This command must be run only one time from the Oracle Grid Infrastructure home.
Syntax
srvctl add asm [-listener listener_name] [-pwfile password_file_path
[-flex [-count {number_of_instances | ALL}] | -proxy [-spfile server_parameter_file_path]]
Parameters
Table G-4 srvctl add asm Command Parameters
Parameter | Description |
---|---|
|
Enter the name of a listener. If you do not specify this parameter, then the listener name defaults to LISTENER .
|
|
Enter the full path to the location of the password file on Oracle ASM. |
|
Specify that the Oracle ASM instances are configured as Oracle Flex ASM instances. You can optionally specify the number of Oracle ASM instances to create or that an Oracle ASM instance should be created on all nodes. Alternatively, you can specify the |
Usage Notes
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.
Example
To add a clusterware resource for Oracle ASM to every node in the cluster, use the following command:
$ srvctl add asm
G.8.2 srvctl config asm
Syntax
srvctl config asm [-proxy] [-detail]
Parameters
Table G-5 srvctl config asm Command Parameters
Parameter | Description |
---|---|
-proxy |
Optionally, you can use this parameter to specify whether the Oracle ASM configuration to display is a proxy instance. |
-detail |
Optionally, you can use this parameter to print detailed configuration information. |
Usage Notes
-
Use this command only with Oracle Clusterware.
-
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.
Example
$ srvctl config asm
ASM Home: /u01/app/12.1.0/grid
ASM Listener: LISTENER
ASM instance count: 3
Password file:
G.8.3 srvctl disable asm
Oracle ASM will restart if it contains Oracle Clusterware data or if the node restarts and it was running before the node failed. The srvctl disable asm
command also prevents the srvctl start asm
command from starting Oracle ASM instances.
Disabling the Oracle ASM proxy resource prevents the databases and disk groups from starting because they depend on the Oracle ASM proxy resource.
Syntax
srvctl disable asm [-proxy] [-node node_name]
Parameters
Table G-6 srvctl disable asm Command Parameters
Parameter | Description |
---|---|
-proxy |
Optionally, you can use this parameter to specify whether you are disabling a proxy Oracle ASM configuration. |
-node node_name |
Optionally, you can specify a particular node on which you want to disable Oracle ASM. |
Usage Notes
-
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.
-
Oracle ASM is part of the Oracle Clusterware stack and when OCR and voting files are stored on Oracle ASM, then Oracle ASM starts when OHASD starts the Oracle Clusterware stack. The
srvctl disable asm
command does not prevent the Oracle ASM instance managed by OHASD from starting. Oracle ASM, therefore, starts as needed by the Oracle Clusterware stack.The
srvctl disable asm
command prevents the Oracle ASM Oracle Clusterware proxy resource, and any resources that depend on it, from starting. So, the command prevents Oracle Clusterware-managed objects, such as databases, disk groups, and file systems that depend on Oracle ASM, from starting. For example, thesrvctl start database | diskgroup | filesystem
command fails to start any of those objects on nodes where the Oracle ASM Oracle Clusterware proxy resource is disabled. The command also prevents thesrvctl start asm
command from starting Oracle ASM on remote nodes.
Example
crmnode1
:$ srvctl disable asm -node crmnode1
G.8.4 srvctl enable asm
Syntax
srvctl enable asm [-proxy] [-node node_name]
Parameters
Table G-7 srvctl enable asm Command Parameters
Parameter | Description |
---|---|
-proxy |
Optionally, you can use this parameter to specify whether you are enabling a proxy Oracle ASM configuration. |
-node node_name |
Optionally, you can specify a particular node on which you want to enable Oracle ASM. |
Usage Notes
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.
Example
$ srvctl enable asm -node crmnode1
G.8.5 srvctl getenv asm
Syntax
srvctl getenv asm [-envs "name_list"]
Usage Notes
-
If you choose not use the
-env
parameter, then the values of all environment variables associated with Oracle ASM are displayed. -
You can specify a comma-delimited list of the names of environment variables for which you want to retrieve the values.
Example
$ srvctl getenv asm
G.8.6 srvctl modify asm
Modifies the listener used by Oracle ASM, the disk group discovery string used by Oracle ASM, or the SPFILE used by Oracle ASM for a noncluster database or a cluster database.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.Syntax
srvctl modify asm [-listener listener_name] [-pwfile password_file_path]
[-count {number_of_instances | ALL}] [-diskstring asm_diskstring]
[-spfile spfile_path_name [-proxy] [-force]]
Parameters
Parameter | Description |
---|---|
-listener listener_name |
Specify the name of the listener with which Oracle ASM registers. |
-pwfile password_file_path |
Specify the full path to the location of the password file for Oracle ASM. |
-count {number_of_instances | ALL} |
Specify the number of Oracle ASM instances to create, or that an Oracle ASM instance should be created on all nodes. |
-diskstring asm_diskstring |
Specify a new Oracle ASM disk group discovery string. |
-spfile spfile_path_name |
Specify the path to the new spfile to be used by Oracle ASM. |
-proxy |
Use this parameter to specify an Oracle ASM proxy instance. |
–force |
Use this parameter to force modification of Oracle ASM. |
Example
An example of this command to modify the configuration of Oracle ASM is:
$ srvctl modify asm -listener lsnr1
G.8.7 srvctl predict asm
Syntax
srvctl predict asm [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify a particular node on which you want to predict the consequences of an Oracle ASM failure.
-
You can choose verbose output.
Example
$ srvctl predict asm -node crmnode2
G.8.8 srvctl relocate asm
Relocates an Oracle Flex ASM instance from one Hub Node of an Oracle Flex Cluster to another.
Syntax
srvctl relocate asm -currentnode current_node [-targetnode target_node] [-force]
Parameters
Table G-8 srvctl relocate asm Parameters
Parameter | Description |
---|---|
-currentnode current_node |
Name of the node on which the Oracle Flex ASM instance currently resides. |
-targetnode target_node |
Name of the node to which you want to relocate the Oracle Flex ASM instance. |
-force |
Force the relocation of the Oracle Flex ASM instance. |
Usage Notes
-
You cannot use this command if there is only one Oracle Flex ASM instance running.
-
Because of bootstrap issues between Oracle ASM and Oracle Clusterware, on the node where Oracle Clusterware uses Oracle ASM run either
crsctl stop crs
orcrsctl stop cluster
to stop Cluster Ready Services on the node before you relocate the Oracle ASM instance.
Example
An example of this command to relocate an Oracle Flex ASM instance from the current node to a node named hubnode2
is:
$ srvctl relocate asm -currentnode hubnode1 -targetnode hubnode2
G.8.9 srvctl remove asm
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl remove asm [-proxy] [-force]
Parameters
Table G-9 srvctl remove asm Command Parameters
Parameter | Description |
---|---|
-proxy |
Optionally, you can use this parameter to specify whether you are removing a proxy Oracle ASM configuration. |
-force |
Forcefully removes an Oracle ASM resource (ignores any dependencies). |
Example
$ srvctl remove asm -force
G.8.10 srvctl setenv asm
Syntax
Use this command with one of the following syntaxes:
srvctl setenv asm -envs "name=value,[...]"
srvctl setenv asm -env "name=value"
Parameters
Table G-10 srvctl setenv asm Command Parameters
Parameter | Description |
---|---|
-envs "name=value,[...]" |
Use this parameter to specify either a single name-value pair or a comma-delimited list of multiple name-value pairs of environment variables enclosed in double quotation marks ( |
-env "name=value" |
Use this parameter to enable a single environment variable to be set to a value that contains commas or other special characters, enclosed in double quotation marks ( |
Example
$ srvctl setenv asm -envs "LANG=en"
G.8.11 srvctl start asm
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.
Syntax
srvctl start asm [-proxy] [-node node_name [-startoption start_options]]
Parameters
Table G-11 srvctl start asm Command Parameters
Parameter | Description |
---|---|
-proxy |
Optionally, you can use this parameter to specify whether you are starting a proxy Oracle ASM configuration. |
-node node_name |
Optionally, you can specify a particular node on which you want to start Oracle ASM. Note: You can use this parameter only with Oracle Clusterware. |
-startoption start_options |
Optionally, you can specify options to the startup command, such as Note: For multi-word startup options, such as See Also: SQL*Plus User's Guide and Reference for more information about startup options |
Examples
$ srvctl start asm -node crmnode1
$ srvctl start asm
G.8.12 srvctl status asm
Displays the status of an Oracle ASM instance.
Note:
To manage Oracle ASM on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ASM.Syntax
srvctl status asm [-proxy] [-node node_name] [-detail] [-verbose]
Parameters
Table G-12 srvctl status asm Command Parameters
Parameter | Description |
---|---|
|
Optionally, you can use this parameter to display the status for an Oracle ASM proxy instance. |
|
Optionally, you can specify a particular node. If you do not specify this parameter, then SRVCTL displays the status of all Oracle ASM instances. |
|
Print detailed status information. |
|
Displays verbose output. |
Example
This command returns output similar to the following:
$ srvctl status asm -verbose
ASM is enabled
ASM is running on node2, node3, node4
ASM instance +ASM2 is running on node node2
Number of clients connected: 4
Names of clients: db002, db003, +IOS1, clicluster1:later3
ASM instance +ASM3 is running on node node3
Number of clients connected: 2
Names of clients: db001, +IOS2
ASM instance +ASM4 is running on node node4
Number of clients connected: 2
Names of clients: db004, db005
G.8.13 srvctl stop asm
Syntax
srvctl stop asm [-proxy] [-node node_name] [-stopoption stop_options] [-force]
Parameters
Table G-13 srvctl stop asm Command Parameters
Parameter | Description |
---|---|
-proxy |
Optionally, you can use this parameter to specify whether you are stopping a proxy Oracle ASM configuration. |
-node node_name |
Optionally, you can specify a particular node on which you want to stop Oracle ASM. If you do not specify this parameter, then SRVCTL stops the Oracle ASM instance on every active node in the cluster. Note: You can use this parameter only with Oracle Clusterware. |
-stopoption stop_options |
Optionally, you can specify options to the shutdown command, such as See Also: SQL*Plus User's Guide and Reference for more information about shutdown options |
-force |
Optionally, you can use this parameter to stop disk groups, file systems, and databases that depend on Oracle ASM. |
Usage Notes
-
To manage Oracle ASM on Oracle Database 12c installations, use SRVCTL in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use SRVCTL in the database home to manage Oracle ASM.
-
You cannot use this command when OCR is stored in Oracle ASM because it will not stop Oracle ASM. To stop Oracle ASM you must shut down Oracle Clusterware.
Example
$ srvctl stop asm -node crmnode1 -stopoption IMMEDIATE
G.8.14 srvctl unsetenv asm
Syntax
srvctl unsetenv asm -envs "name_list
"
Usage Notes
Use the -envs
parameter to specify a comma-delimited list of the names of environment variables enclosed in double quotation marks (""
).
Example
$ srvctl unsetenv asm -envs "CLASSPATH"
G.8.15 srvctl add cvu
Adds the Cluster Verification Utility (CVU) to an Oracle Clusterware configuration.
Note:
This command is only available with Oracle Clusterware.
Syntax and Parameters
Use the srvctl add cvu
command with the following syntax:
srvctl add cvu [-checkinterval time_in_minutes]
Usage Notes
-
Optionally, you can change the interval between checks. By default, CVU runs once every 6 hours and verifies the health of the cluster. The shortest interval you can specify for CVU check is 10 minutes.
-
Run this command while logged in as the Grid home user.
Example
To add CVU with a check interval of 6 hours, use the following command:
$ srvctl add cvu -checkinterval 360
G.8.16 srvctl config cvu
Displays the time interval, in minutes, between CVU checks.
Syntax and Parameters
Use the srvctl config cvu
command with the following syntax:
srvctl config cvu
This command has no parameters.
Example
CVU is configured to run once every 360 minutes
G.8.17 srvctl disable cvu
Disables the Cluster Verification Utility (CVU) for Oracle Clusterware management (if enabled).
Syntax
srvctl disable cvu [-node node_name]
Parameters
Optionally, you can specify the name of a particular node on which you want to disable CVU. Otherwise, SRVCTL disables CVU on all nodes.
Example
An example of this command to disable CVU on a node named crmnode1
is:
$ srvctl disable cvu -node crmnode1
G.8.18 srvctl enable cvu
Enables the Cluster Verification Utility (CVU) for Oracle Clusterware management (if disabled).
Syntax
srvctl enable cvu [-node node_name]
Parameters
Optionally, you can specify the name of a particular node on which you want to enable CVU. Otherwise, SRVCTL enables CVU on all nodes.
Example
An example of this command to enable CVU on a node named crmnode1
is:
$ srvctl enable cvu -node crmnode1
G.8.19 srvctl modify cvu
Modifies the check interval for CVU.
Syntax
srvctl modify cvu [-checkinterval time_in_minutes]
Parameters
By default, CVU runs once every 360 minutes (six hours) and verifies the health of cluster. If you change the interval, then the shortest interval you can specify for CVU check is 10 minutes.
Example
An example of this command to modify CVU to have a check interval of 4 hours is:
$ srvctl modify cvu -checkinterval 240
G.8.20 srvctl relocate cvu
Syntax
srvctl relocate cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node to which you want to relocate CVU.
Example
crmnode2
is:$ srvctl relocate cvu -node crmnode2
G.8.21 srvctl remove cvu
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove cvu [-force]
Usage Notes
Use the -force
parameter to remove a CVU resource that is running or starting.
G.8.22 srvctl start cvu
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start cvu [-node node_name
]
Usage Notes
Optionally, you can specify a particular node to which you want to start CVU. Otherwise, SRVCTL starts CVU on all nodes.
Example
$ srvctl start cvu -node crmnode1
G.8.23 srvctl status cvu
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status cvu [-node node_name]
Usage Notes
Optionally, you can specify a particular node where the CVU resource is running, if it is not the local node.
Example
crmnode1
is:$ srvctl status cvu -node crmnode1
G.8.24 srvctl stop cvu
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop cvu [-force]
Usage Notes
Optionally, you can specify the -force
parameter to stop CVU if it is a dependant resource.
Example
$ srvctl stop cvu
G.8.25 srvctl add exportfs
Creates an export file system configuration in Oracle Clusterware.
Syntax
srvctl add exportfs -name unique_name -id havip_name -path path_to_export
[-clients export_clients] [-options export_options] [-type NFS | SMB]
Parameters
Table G-14 svrctl add exportfs Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Enter a unique name for the export file system that you are creating. This parameter is required. |
-id havip_name |
Enter the number or name that identifies an existing HAVIP, that you specified in the |
-path path_to_export |
Enter the path to the Oracle Automatic Storage Management Cluster File System (Oracle ACFS) that you want to export. This parameter is required. |
-clients export_clients -options export_options |
Optionally, enter a comma-delimited list of clients to which you want the file system exported. You can enter net groups and wildcards. For example:
Note: You can use the |
-type NFS | SMB |
Specify the export type ( |
Usage Notes
You must run this command as root
on Linux and UNIX platforms.
Example
To export with operating system defaults:
# srvctl add exportfs -name cifsExport -path "/acfs1" -options "browsable = yes,read only = no,comment = acfs1"
To export read-only to certain clients:
# srvctl add exportfs -name export1 -id havip1 -path /u01/db1 -clients node1 -options ro
G.8.26 srvctl config exportfs
Displays the configuration information for the export file system in Oracle Clusterware.
Syntax
srvctl config exportfs [-name unique_name | -id havip_name]
Parameters
Table G-15 srvctl config exportfs Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Enter the unique name of the NFS export for which you want to display the configuration. |
-id havip_name |
Enter the name of a HAVIP to display the configuration of all the NFS exports attached to the specific HAVIP. |
Example
If you specify the -name
parameter, then this command returns output similar to the following, whether you specify -name
or -id
:
$ srvctl config exportfs -id havip1
export file system kep1 is configured
Exported path: /scratch/ghnew/base/mymount3
Export options:
Export Type:
Exported clients:
export file system kexp2 is configured
Exported path: /scratch/ghnew/base/mymount3
Export options:
Export Type:
Exported clients:
G.8.27 srvctl disable exportfs
Disables an export file system managed by Oracle Clusterware.
Syntax
srvctl disable exportfs -name filesystem_name
Usage Notes
-
This command takes only the unique name of the file system you want to disable.
-
You must run this command as
root
user on Linux and UNIX platforms.
Example
The following example disables an export file system called export1
:
# srvctl disable exportfs -name export1
G.8.28 srvctl enable exportfs
Enables an export file system configuration in Oracle Clusterware.
Syntax
srvctl enable exportfs -name filesystem_name
This command takes only the name of the file system you want to enable, which is a required parameter.
Usage Notes
You must run this command as the root
user on Linux and UNIX platforms.
Example
The following command example enables a file system named export1
:
# srvctl enable exportfs -name export1
G.8.29 srvctl modify exportfs
Modifies an export file system configuration in Oracle Clusterware.
Syntax
srvctl modify exportfs -name unique_name [-path path_to_export]
[-clients node_list] [-options nfs_options_string]
Parameters
Table G-16 srvctl modify exportfs Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Enter the unique name of the NFS export file system to modify. This parameter is required. |
-path path_to_export |
You can modify the path to the Oracle Automatic Storage Management Cluster File System (Oracle ACFS) where the export is located. |
-clients node_list |
You can modify the comma-delimited list of clients (hosts) to where the file system is exported. You can enter net groups and wildcards. For example:
Note: You can use the |
-options nfs_client_string
|
Use this parameter to modify the export options for the export file system. |
Usage Notes
-
You must run this command as root user on Linux and UNIX platforms.
-
You must start and stop the NFS export before any changes you make take effect.
Example
The following command example modifies the path of an export file system named exportfs1
:
# srvctl modify exportfs -name exportfs1 -path /mnt/racdb1
G.8.30 srvctl remove exportfs
Removes the specified export file system configuration.
Syntax
srvctl remove exportfs -name exportfs_name [-force]
Parameters
Table G-17 srvctl remove exportfs Command Parameters
Parameter | Description |
---|---|
-name exportfs_name |
Enter the unique name of the export file system you want to remove. |
-force |
Use this parameter to ignore any dependencies and forcibly remove the export file system. |
Usage Notes
-
You must run this command as
root
user on Linux and UNIX platforms. -
If you do not use the
-force
parameter, then you must first stop the export file system you want to remove before you remove it. -
If you use the
-force
parameter, then the resulting configuration can cause errors when attempting to shut down the Oracle Clusterware stack.
Examples
To remove the stopped export file system named export1
:
# srvctl remove exportfs -name export1
To remove a running export file system, leaving it exported:
# srvctl remove exportfs -name export1 -force
G.8.31 srvctl start exportfs
Starts an export file system configuration in Oracle Clusterware.
Syntax
srvctl start exportfs {-name unique_name | -id havip_name}
Parameters
Table G-18 srvctl start exportfs Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Enter the unique name of the NFS export you want to start. |
-id havip_name |
The unique ID associated with the HAVIP resource. |
Example
To start an export file system:
$ srvctl start exportfs -name export1
G.8.32 srvctl status exportfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status exportfs [-name unique_name | -id havip_name]
Parameters
Table G-19 srvctl status exportfs Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Optionally, you can specify the unique name of the NFS export for which you want to display the status. |
-id havip_name |
Alternatively, you can specify the name of an HAVIP resource and display the status of all of the NFS exports associated with the specified HAVIP resource. |
Usage Notes
If you do not specify any parameters, then SRVCTL displays the status for all NFS exports in the cluster.
Example
$ srvctl status exportfs
export file system export1 is enabled
export file system export1 is not exported
export file system export2 is enabled
export file system export2 is exported on node node1
G.8.33 srvctl stop exportfs
Syntax
srvctl stop exportfs {-name unique_name | -id havip_name} [-force]
Parameters
Table G-20 srvctl stop exportfs Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Enter the unique name of the NFS export you want to stop. |
-id havip_name |
Alternatively, you can specify the name of an HAVIP. If you specify this parameter, then SRVCTL stops all of the NFS exports associated with the HAVIP resource you specify. |
–force |
Stop the NFS export, ignoring errors. |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl stop exportfs -name export1
G.8.34 srvctl add filesystem
An Oracle ACFS file system resource is typically created for use with application resource dependency lists. For example, if an Oracle ACFS file system is configured for use as an Oracle Database home, then a resource created for the file system can be included in the resource dependency list of the Oracle Database application. This will cause the file system and stack to be automatically mounted because of the start action of the database application.
Syntax
srvctl add filesystem -device volume_device -path mountpoint_path
[-volume volume_name] [-diskgroup disk_group_name]
[-node node_list | -serverpool server_pool_list] [-user user_list]
[-fstype {ACFS | EXT3 | EXT4}] [-fsoptions options] [-description description]
[-appid application_id] [-autostart {ALWAYS | NEVER | RESTORE}]
Note:
Oracle supports the EXT3
and EXT4
values for the -fstype
parameter only for Linux.
Parameters
Table G-21 srvctl add filesystem Command Parameters
Parameter | Description |
---|---|
-device volume_device |
Specify the path to the file system volume device you want to add. |
-path mountpoint_path |
Specify the mount point path that is used to set up dependencies on other resources for nested mounts. This must be an absolute path. |
-volume volume_name |
Optionally, you can specify the name of the volume. |
-diskgroup disk_group_name |
Optionally, you can specify the name of the Oracle ACFS disk group to which you want to add the device. |
-node node_list | -serverpool server_pool_list |
Optionally, you can specify a comma-delimited list of nodes on which to mount the file system device. If you specify a list of nodes or a server pool, then SRVCTL creates a single-node file system resource. Without any nodes or server pools, SRVCTL creates a file system resource that runs on every cluster node. Alternatively, you can specify a comma-delimited list of server pools in which a file system will run. If you specify a list of server pools, then you dynamically limit the number or type of nodes on which a file system will run. This does not count as a cluster-wide file system for later usage that may require a cluster-wide Oracle ACFS resource, such as HANFS. Note: Nodes and server pools are mutually exclusive. |
-user user_list |
Optionally, you can specify a comma-delimited list of users authorized to mount and unmount the file system. If you specify no users, then only |
-fstype {ACFS | EXT3 | EXT4} |
Optionally, you can specify the type of file system to be mounted. The default value is If the type of file system to be mounted is not |
-fsoptions options |
Optionally, you can specify options used to mount the file system. The options are file system and operating system dependent. |
-description description |
Optionally, you can specify a description of the file system. This is stored as an attribute for later viewing by an administrator. |
-appid application_id |
Optionally, you can specify an application ID, which is a unique identifier used to group file systems into logical groupings. You can use this method to group file systems that may be different on different nodes but are used by an application that must have a dependency on the resource type, which is |
-autostart {ALWAYS | NEVER | RESTORE} |
Optionally, you can specify the file system resource autostart policy.
|
Usage Notes
-
Use this command only with Oracle Clusterware.
-
You must run this command as
root
user on Linux and UNIX platforms, or as an Administrator user on Windows platforms. -
This command must be run only one time from the Oracle Grid Infrastructure home.
-
To manage Oracle ACFS on Oracle Database 12c installations, use the SRVCTL binary in the Oracle Grid Infrastructure home for a cluster (Grid home). If you have Oracle RAC or Oracle Database installed, then you cannot use the SRVCTL binary in the database home to manage Oracle ACFS.
Examples
d1volume1-295
disk device in the disk group RAC_DATA
as the Oracle ACFS volume VOLUME1
with a mount point of /oracle/cluster1/acfs
:# srvctl add filesystem -device /dev/asm/d1volume1-295
-path /oracle/cluster1/acfs1
asm-test-55
, with this file system mounted on one of the specified nodes at a time:# srvctl add filesystem -fstype ACFS -device asm-test-55 -path myacfs
-node node1,node2,node3
G.8.35 srvctl config filesystem
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config filesystem -device volume_device
Usage Notes
Use the -device
parameter to specify the path to the file system resource for which you want to display the configuration.
Examples
$ srvctl config filesystem
$ srvctl config filesystem -device /dev/asm/d1volume1-295
G.8.36 srvctl disable filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable filesystem -device volume_device
Usage Notes
Specify the path to the file system volume you want to disable.
Example
# srvctl disable filesystem -device /dev/asm/racvol1
G.8.37 srvctl enable filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable filesystem -device volume_device
Usage Notes
Specify the path to the volume device you want to enable.
Example
# srvctl enable filesystem -device /dev/asm/racvol1
G.8.38 srvctl modify filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl modify filesystem -device volume_device -user user_name
[-path mountpoint_path] [-node node_list | -serverpool
server_pool_list] [-fsoptions options] [-description description]
[-autostart {ALWAYS | NEVER | RESTORE}]
Parameters
Table G-22 srvctl modify filesystem Command Parameters
Parameter | Description |
---|---|
-device volume_device |
Specify the path to the file system volume device you want to modify. |
-user user_name |
Specify the name of the user that is authorized to mount and unmount the file system. If you do not specify this parameter, then SRVCTL defaults to the user running the command. |
-path mountpoint_path |
Modify the mount point path that is used to set up dependencies on other resources for nested mounts. This must be an absolute path. |
-node node_list | -serverpool server_pool_list |
Modify a comma-delimited list of nodes on which to mount the file system device. If you specify a list of nodes or a server pool, then SRVCTL creates a single-node file system resource. Without any nodes or server pools, SRVCTL creates a file system resource that runs on every cluster node. Alternatively, you can modify a comma-delimited list of server pools in which a file system will run. If you specify a list of server pools, then you dynamically limit the number or type of nodes on which a file system will run. This does not count as a cluster-wide file system for later usage that may require a cluster-wide Oracle ACFS resource, such as HANFS. Note: Nodes and server pools are mutually exclusive. |
-fsoptions options |
Modify options used to mount the file system. The options are file system and operating system dependent. |
-description description |
Modify the description of the file system. |
-autostart {ALWAYS | NEVER | RESTORE} |
Modify the file system resource autostart policy.
|
Usage Notes
-
You must run this command as
root
user on Linux and UNIX platforms. -
When performing online changes to the file system resource, the changes take effect only after the resource is next (re)started.
Example
sysad
for the RACVOL1
volume:# srvctl modify filesystem -device /dev/asm/racvol1 -user sysad
G.8.39 srvctl predict filesystem
Syntax
srvctl predict filesystem -device volume_device_name [-verbose]
Usage Notes
-
Specify the path name of the file system volume device.
-
Optionally, you can choose verbose output.
Example
$ srvctl predict filesystem -device /dev/asm/volume1-123
G.8.40 srvctl remove filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove filesystem -device volume_device_name [-force]
Usage Notes
-
Specify the path to the file system resource device you want to remove.
-
Optionally, you can use the
-force
parameter to ignore any resource dependencies and forcibly remove the resource from the cluster. -
You must run this command as
root
user on Linux and UNIX platforms, or as an Administrator user on Windows platforms.
Examples
# srvctl remove filesystem -device /dev/asm/racvol1
G.8.41 srvctl start filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start filesystem -device volume_device [-node node_name]
Parameters
Table G-23 srvctl start filesystem Command Parameters
Parameter | Description |
---|---|
-device volume_device |
Specify the path of the file system resource device that you want to start. |
-node node_name |
Optionally, you can specify the name of the node on which the file system resource should be started. If you do not specify this parameter, then SRVCTL starts the file system resource on all the available nodes in the cluster. |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms, or as an Administrator user on Windows platforms, or as a configured file system user.
See Also:
srvctl add filesystem
for more information about configuring file system users
Examples
$ srvctl start filesystem -device /dev/asm/data_db1-68
node1
:$ srvctl start filesystem -device /dev/asm/data_db1-68 -node node1
G.8.42 srvctl status filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status filesystem [-device volume_device] [-verbose]
Usage Notes
-
Optionally, you can specify the path of the file system resource for which you want to obtain the status. If you do not specify this parameter, then SRVCTL displays the status of all file systems.
-
Optionally, you can use the
-verbose
parameter to display detailed output.
Examples
This command displays output similar to the following, depending on whether you specify a device name.
$ srvctl status filesystem -device /dev/asm/racvol_1
ACFS file system is not mounted on node1
ACFS file system is not mounted on node2
$ srvctl status filesystem
ACFS file system is not running
ACFS file system is running on node1,node3
Note:
In the preceding examples, the file system is Oracle ACFS. If you are using other file systems, then they will display as EXT3 or EXT4.
G.8.43 srvctl stop filesystem
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop filesystem -device volume_device [-node node_name] [-force]
Parameters
Table G-24 srvctl stop filesystem Command Parameters
Parameter | Description |
---|---|
-device volume_device |
Specify the path to the file system volume device that you want to stop. |
-node node_name |
Optionally, you can specify the name of a node. If you do not specify this parameter, then SRVCTL stops the volume resource on all active nodes in the cluster. |
-force |
Optionally, you can use |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms, or as an Administrator user on Windows platforms, or as a configured file system user.
See Also:
srvctl add filesystem
for more information about configuring file system users
Example
# srvctl stop filesystem -device /dev/asm/racvol_1 -force
G.8.44 srvctl add gns
Adds the Grid Naming Service (GNS) to a cluster when you are using a DHCP public network or creating a client cluster.
Syntax
Use the srvctl add gns
command with one of the following syntax models:
To add GNS to a cluster that is not currently running GNS:
srvctl add gns [-domain domain_name] -vip {vip_name | ip_address} [-skip] [-verbose]
To change a cluster that is not running GNS to be a client cluster of another cluster that is running GNS:
srvctl add gns -clientdata file_name
To add a secondary GNS to a cluster:
srvctl add gns -vip vip_name | ip_address -clientdata file_name
Parameters
Table G-25 srvctl add gns Command Parameters
Parameter | Description |
---|---|
-domain domain_name |
The network subdomain that is used for Forward DNS Lookup of cluster IP addresses. You can only use this parameter if you specify If you do not specify |
-vip {vip_name | ip_address} |
Specify either the virtual IP (VIP) name or IP address on which GNS listens for DNS requests. You cannot use Use the |
-skip |
Specify this parameter to skip the reachability check of the VIP address. |
-clientdata path_to_file |
Specify the path to the file you created with the The cluster to which you add GNS using You can only use the |
-verbose |
Verbose output. |
Usage Notes
-
You must run this command as
root
user on Linux and UNIX platforms, or as an Administrator user on Windows platforms. -
When you are adding GNS to a cluster for the first time, use the
-vip
parameter with the-domain
parameter. -
When you are adding GNS to a cluster using the
-clientdata
parameter, you must first export the GNS data to a file and manually copy the file to a node in the cluster you are adding. Use the-clientdata
parameter and run this command on any node in the cluster. -
You can only specify the
-vip
and-clientdata
parameters at the same time when you are adding a secondary GNS.
Examples
To add GNS to a cluster, making it a server cluster:
# srvctl add gns -vip 192.168.16.17 -domain cluster.mycompany.com
To add GNS to a cluster, making it a client cluster:
# srvctl add gns -clientdata /tmp/gnsdata
G.8.45 srvctl config gns
Syntax
srvctl config gns [-detail] [-subdomain] [-multicastport] [-node node_name] [-port] [-status]
[-version] [-query name] [-list] [-clusterguid] [-clustername] [-clustertype] [-loglevel]
[-network] [-role] [-instances]
Parameters
Table G-26 srvctl config gns Command Parameters
Parameter | Description |
---|---|
-detail |
Print detailed configuration information about the GNS. |
-subdomain |
Display the subdomain served by GNS. |
-multicastport |
Display the port on which the GNS daemon is listening for multicast requests. |
-node node_name |
Display the configuration information for GNS on the specified node. |
-port |
Display the port that the GNS daemon uses to communicate with the DNS server. |
-status |
Display the status of GNS. |
-version |
Display the version of GNS. |
-query name |
Query GNS for the records belonging to a specific name. |
-list |
List all records in GNS. |
-clusterguid |
Display the globally unique identifier of the cluster where GNS is running. |
-clustername |
Display the name of the cluster where GNS is running. |
-clustertype |
Display the type of configuration of GNS on this cluster. |
-loglevel |
Print the log level of the GNS. |
-network |
Display network on which GNS is listening. |
-role |
Display the role of the GNS instance. |
-instances |
Display the instance list. |
G.8.46 srvctl disable gns
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable gns [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify the name of a node in the cluster on which you want to disable GNS. If you do not specify this parameter, then SRVCTL disables GNS for the entire cluster.
-
Optionally, you can use the
-verbose
parameter to display detailed output.
Example
crm7
is:$ srvctl disable gns -node crm7
G.8.47 srvctl enable gns
Note:
This command can be used only with Oracle Clusterware.
Syntax
srvctl enable gns [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify the name of a node on which you want to enable GNS. If you do not specify this parameter, then SRVCTL enables GNS on all nodes in the cluster.
-
Optionally, you can use the
-verbose
parameter to print detailed output.
Example
$ srvctl enable gns -node node1
G.8.48 srvctl export gns
Exports Grid Naming Service (GNS) instance data to a file that you can use when you are either moving GNS from one server cluster to another or when you are creating a client cluster.
SRVCTL extracts the data from OCR. Exported data includes:
-
The credentials used to authorize users, which includes the VIP address on which the server listens
-
The names and DNS records kept in GNS
Syntax
srvctl export gns {-instance path_to_file | {-clientdata path_to_file -role {CLIENT|SECONDARY} [-version]}}
Parameters
Table G-27 srvctl export gns Command Parameters
Parameter | Description |
---|---|
-instance path_to_file |
Use this parameter to specify the file to which GNS instance data is written, when you are moving GNS from one server cluster to another. |
-clientdata path_to_file -role {CLIENT|SECONDARY} |
Use this parameter to specify the file to which GNS credentials data is written, when you are adding a client cluster to create a file that contains credentials that the client cluster accesses to perform name management operations on the server cluster. You must also use the |
-version |
Optionally, you can use this parameter to specify the version for which the client data will be generated. |
Example
The following command exports the GNS credentials data to a file named gns.txt
:
$ srvctl export gns -clientdata /temp/gnsdata/gns.txt
G.8.49 srvctl import gns
The srvctl import gns
command imports data from a file that you create when you run the srvctl export gns
command. Use this command when you want to locate GNS to a different server cluster.
When you import GNS data, SRVCTL stores the credentials and places the record data into OCR. If another GNS instance is running or data for another instance is encountered during the import procedure, then an error occurs.
This command also makes the cluster in which you run it the server cluster.
Note:
This command is only available with Oracle Clusterware.
G.8.50 srvctl modify gns
Syntax
Use the srvctl modify gns
command with one of the following syntax models:
srvctl modify gns -loglevel log_level
or
srvctl modify gns [-resolve name] [-verify name]
[-parameter name:value[,name:value...]]
[-vip {vip_name | ip} [-skip]] [-clientdata file_name]
[-role {PRIMARY} [-force]] [-verbose]
Parameters
Table G-28 srvctl modify gns Command Parameters
Parameter | Description |
---|---|
-loglevel log_level |
Specify the GNS diagnostic logging level (acceptable values are 1-6). |
-resolve name |
Resolve the name you specify through GNS. |
-verify name |
Check to see if the specified name is advertised through GNS. |
-parameter name:value[,name:value...] |
Set the value of one or more configuration parameters. |
-vip {vip_name | ip} [-skip] |
Specify a VIP name or IP address on which GNS is to listen. Note: You can modify this attribute using Online Resource Attribute Modification. Optionally, you can use the |
-clientdata file_name |
Modifies the GNS client data with client data contained in the specified file. |
-role {PRIMARY} [-force] |
Convert a secondary GNS instance to primary. Use the |
Examples
An example of this command is:
$ srvctl modify gns -vip 192.0.2.15
G.8.51 srvctl relocate gns
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl relocate gns [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify the name of a node to which you want to move GNS.
-
Optionally, you can use the
-verbose
parameter to display verbose output. -
On Linux and UNIX systems, you must be logged in as
root
and on Windows, you must be logged in as a user with Administrator privileges to run this command.
Example
# srvctl relocate gns -node node1
G.8.52 srvctl remove gns
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove gns [-force] [-verbose]
Usage Notes
-
Optionally, you can use the
-force
parameter to forcibly remove GNS from the cluster, regardless of any errors that might occur. -
Optionally, you can use the
-verbose
parameter to display verbose output.
Example
$ srvctl remove gns
G.8.53 srvctl start gns
Starts GNS on a specific node.
Syntax
srvctl start gns [-loglevel log_level] [-node node_name] [-verbose]
Parameters
Table G-29 srvctl start gns Command Parameters
Parameter | Description |
---|---|
-loglevel log_level |
Optionally, you can specify the level of logging with which GNS should run. Log levels vary between 1 (minimal tracing) and 6 (traces everything and is time consuming). |
-node node_name |
Optionally, you can specify the name of a node in the cluster where you want to start GNS. |
-verbose |
Optionally, you can use this parameter to display verbose output. |
Usage Notes
You can only run this command in the server cluster. If you attempt to run this command in a client cluster, then an error occurs.
Example
An example of this command to start the GNS on the cluster node named crmnode1
is:
$ srvctl start gns -node crmnode1
G.8.54 srvctl status gns
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status gns [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify a node on which GNS is running for which you want to display the state.
-
Optionally, you can use the
-verbose
parameter to display detailed output.
G.8.55 srvctl stop gns
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop gns [-node node_name] [-force] [-verbose]
Usage Notes
-
Optionally, you can specify the name of a node on which GNS is running that you want to stop.
-
Optionally, you can use
-force
and-verbose
to forcibly stop GNS and print detailed output, respectively.
Example
$ srvctl stop gns
G.8.56 srvctl update gns
Note:
This command is only available with Oracle Clusterware.
Syntax
Use the srvctl update gns
command with one of these syntax models:
srvctl update gns -advertise name -address ip_address [-timetolive time_to_live
]
[-verbose]
srvctl update gns -delete name [-address address] [-verbose]
srvctl update gns -alias alias -name name [-timetolive time_to_live] [-verbose]
srvctl update gns -deletealias alias [-verbose]
srvctl update gns -createsrv service -target target -protocol protocol
[-weight weight] [-priority priority] [-port port_number]
[-timetolive time_to_live] [-instance instance_name] [-verbose]
srvctl update gns -deletesrv service_name -target target -protocol protocol
[-verbose]
srvctl update gns -createtxt name -target target [-timetolive time_to_live]
[-namettl name_ttl] [-verbose]
srvctl update gns -deletetxt name -target target [-verbose]
srvctl update gns -createptr name -target target [-timetolive time_to_live]
[-namettl name_ttl] [-verbose]
srvctl update gns -deleteptr name -target target [-verbose]
Parameters
Table G-30 srvctl update gns Command Parameters
Parameter | Description |
---|---|
-advertise name |
Use this parameter to advertise a name through GNS. |
-address ip_address |
Specify the IP address for an advertised name. |
-timetolive time_to_live |
Optionally, you can specify, in seconds, an amount of time for the record to live. |
-delete name |
Use this parameter to remove the advertisement of a name from GNS. |
-alias alias |
Use this parameter to create an alias for an advertised name. |
-name name |
You must specify a name to associate with the alias. |
-deletealias alias |
Use this parameter to delete an alias. |
-createsrv service |
Use this parameter to create a service that is described by the record. |
-target target |
Use this parameter to associate a name with the service. |
-protocol protocol |
Use this parameter to specify which protocol is used to connect to the service. |
-weight weight |
Optionally, you can specify the weight of the record. |
-priority priority |
Optionally, you can specify a priority of the record, with a value ranging from 0 to 65535. |
-port port_number |
Optionally, you can specify a port number used to connect to the service, with a value ranging from 0 to 65535. |
-instance instance_name |
Optionally, you can specify an instance name for the service. |
-deletesrv service_name |
Use this parameter to specify the name of the service record you want to delete. |
-createtxt name |
Use this parameter to add a text (TXT) record using the specified name. |
-namettl name_ttl |
Optionally, you can specify the time, in seconds, to live for the name. |
-deletetxt name |
Use this parameter to delete a text (TXT) record for a specific name. |
-createptr name |
Use this parameter to add a pointer (PTR) record for a specific name. |
-deleteptr name |
Use this parameter to delete a pointer (PTR) record for a specific name. |
Usage Notes
You must be logged in as the root
user on Linux and UNIX platforms, or as an Administrator user on Windows platforms, to run this command.
Example
# srvctl update gns -advertise myname -address 192.168.1.45
G.8.57 srvctl add havip
Adds highly available VIPs (HAVIPs) (used for highly available NFS and SMB exports) to a cluster.
Syntax
srvctl add havip -id havip_name -address {host_name | ip_address}
[-netnum network_number] [-description text] [-skip] [-homenode node_name]
Parameters
Table G-31 srvctl add havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify a unique ID for the HAVIP resource. |
-address {host_name | ip_address} |
Specify either a host name or an IPv4 IP address for the HAVIP you are going to create. Note: You must configure the IPv4 IP address with a non-DHCP, non-round robin DNS address. |
-netnum network_number |
Optionally, you can specify a network resource upon which the HAVIP depends. The default value for this parameter is 1. |
-description text |
Optionally, you can specify a text description of the HAVIP. |
-skip |
Optionally, you can specify this parameter to skip the reachability check for the IP address. |
-homenode node_name |
Optionally, you can specify a preferred node or an empty string to clear the home node. |
Example
An example of this command is:
# srvctl add havip -id myhavip -address 192.0.2.1 -netnum 2 -description
"My HA VIP" -skip -homenode myNode2
G.8.58 srvctl config havip
Displays configuration information for a specific highly available VIP (HAVIP) (used for highly available NFS and SMB exports) or all HAVIP resources in a cluster.
Syntax
Use the srvctl config havip
command with the following syntax:
srvctl config havip [-id havip_name]
Parameters
Table G-32 srvctl config havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource you want to display. If you do not specify this parameter, then SRVCTL displays the configuration information for all HAVIPs known to Oracle Clusterware. |
Example
This command returns output similar to the following:
$ srvctl config havip -id hrexports
VIP: /mjk-vm3-vip/10.149.237.196/10.149.236.0/255.255.252.0/eth0
Description: HR Exports
G.8.59 srvctl disable havip
Syntax
srvctl disable havip -id havip_name [-node node1,node2,...,noden]
Parameters
Table G-33 srvctl disable havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource you want to disable. |
-node node1,node2,...,noden |
Specify the name of a node or a comma-delimited list of node names on which you do not want the HAVIP resource to run. If you specify all but one node in the cluster, then the HAVIP will not fail over. |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl disable havip -id myhavip -node myNode1,myNode3
G.8.60 srvctl enable havip
Syntax
srvctl enable havip -id havip_name [-node node_name]
Parameters
Table G-34 srvctl enable havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource you want to enable. |
-node node_name |
Specify the name of a node on which you want the HAVIP resource to be able to run. |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms.
Examples
An example of this command is:
# srvctl enable havip -id myhavip -node myNode1
G.8.61 srvctl modify havip
Syntax
srvctl modify havip -id havip_name [-address {host_name | ip_address}
[-netnum network_number] [-skip]] [-description text] [-homenode node_name]
Parameters
Table G-35 srvctl modify havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name for the HAVIP resource you want to modify. |
-address {host_name | ip_address |
Specify either a host name or an IPv4 IP or IPv6 address for the HAVIP you want to modify. Note: You must configure the IPv4 IP address with a non-DHCP, non-round robin DNS address. |
-netnum network_number |
Optionally, you can change the network resource upon which the HAVIP depends. The default value for this optional parameter is 1. |
-skip |
Specify this parameter to skip checking the reachability of the IP address. |
-description text |
Specify a text description for the HAVIP. |
-homenode node_name |
Optionally, you can specify a preferred node or an empty string to clear the home node. |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl modify havip -id myhavip -address 192.168.16.17 -netnum 2
G.8.62 srvctl relocate havip
Syntax
srvctl relocate havip -id havip_name [-node node_name] [-force]
Parameters
Table G-36 srvctl relocate havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource you want to relocate. |
-node node_name |
Specify the name of the node to which you want to relocate the HAVIP resource. |
-force |
Optionally, you can force the relocation of the HAVIP resource. |
Example
An example of this command is:
$ srvctl relocate havip -id myhavip -node node3
G.8.63 srvctl remove havip
Syntax
srvctl remove havip -id havip_name [-force]
Parameters
Table G-37 srvctl remove havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource you want to remove. |
–force |
Use this parameter to forcibly remove the resource from the cluster and ignore any dependencies. |
Usage Notes
-
You must first stop the HAVIP resource before you attempt to remove it.
-
You must run this command as
root
user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl remove havip -id myhavip -force
G.8.64 srvctl start havip
Syntax
srvctl start havip -id havip_name [-node node_name]
Parameters
Table G-38 srvctl start havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource you want to start. |
-node node_name |
Optionally, you can use the |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms.
Example
An example of this command is:
# srvctl start havip -id myhavip -node myNode1
G.8.65 srvctl status havip
Syntax
srvctl status havip [-id havip_name]
Usage Notes
Specify the unique name of the HAVIP resource you want to display. If you do not specify this parameter, then SRVCTL displays the status of all HAVIPs known to Oracle Clusterware.
Example
This command returns output similar to the following:
$ srvctl status havip
HAVIP ora.ha1.havip is enabled
HAVIP ora.ha1.havip is not running
G.8.66 srvctl stop havip
Syntax
srvctl stop havip -id havip_name [-node node_name] [-force]
Parameters
Table G-39 srvctl stop havip Command Parameters
Parameter | Description |
---|---|
-id havip_name |
Specify the unique name of the HAVIP resource to stop. |
-node node_name |
Optionally, you can specify the name of the node on which the HAVIP resource to stop resides. |
–force |
Use this parameter to forcibly stop the HAVIP. |
Usage Notes
You must run this command as root
user on Linux and UNIX platforms.
Examples
An example of this command is:
# srvctl stop havip -id myhavip -node myNode1 -force
G.8.67 srvctl add ioserver
Adds an Oracle ASM IOServer configuration to the cluster.
When you configure, upgrade, or convert from a standard cluster to an Oracle Flex Cluster you can create Oracle ASM IOServers on the Hub nodes in the cluster.
Syntax
srvctl add ioserver [-spfile spfile] [-count number_of_ioserver_instances| ALL] [-listener listener_name]
Parameters
Table G-40 srvctl add ioserver Command Parameters
Parameter | Description |
---|---|
|
Specify the path to the server parameter file. |
|
Specify the number of Oracle ASM IOServer instances you want to add or |
|
Specify the name of the listener. |
Example
An example of this command is:
# srvctl add ioserver -count 2
G.8.68 srvctl config ioserver
Displays the configuration details of Oracle ASM IOServers.
Syntax
srvctl config ioserver
Usage Notes
This command has no parameters.
Example
This command displays output similar to the following:
$ srvctl config ioserver
ASM I/O Server instance count: 3
ASM I/O Server is enabled.
ASM I/O server is enabled on nodes:
ASM I/O server is disabled on nodes:
G.8.69 srvctl disable ioserver
Disables an Oracle ASM IOServer.
Syntax
srvctl disable ioserver -node node_name
Usage Notes
Use the -node
parameter to specify the name of a Hub node on which you want to disable an Oracle ASM IOServer.
G.8.70 srvctl enable ioserver
Enable an Oracle ASM IOServer on a specific node.
Syntax
srvctl enable ioserver [-node node_name]
Usage Notes
Use the -node
parameter to specify the name of a Hub node on which you want to enable an Oracle ASM IOServer.
G.8.71 srvctl getenv ioserver
Displays the values for environment variables associated with an Oracle ASM IOServer.
Syntax
srvctl getenv ioserver [-envs "name_list"]
Usage Notes
Specify a comma-delimited list of the names of environment variables. If you do not specify this parameter, then SRVCTL displays the values of all environment variables associated with the database.
G.8.72 srvctl modify ioserver
Modifies an Oracle ASM IOServer configuration on a cluster.
Syntax
srvctl modify ioserver [-spfile spfile] [-count number_of_ioserver_instances | ALL]
[-listener listener_name] [-force]
Parameters
Table G-41 srvctl modify ioserver Command Parameters
Parameter | Description |
---|---|
-spfile spfile |
Optionally, specify the path to the server parameter file path. |
-count number_of_ioserver_instances | ALL |
Optionally, specify a number of instances or |
-listener listener_name |
Optionally, specify the name of the listener. |
-force |
Optionally, you can ignore any dependencies and force the modification of the Oracle ASM IOServer. |
G.8.73 srvctl relocate ioserver
Relocates an Oracle ASM IOServer instance from its current hosting node to another node within the cluster.
Syntax
srvctl relocate ioserver -currentnode node_name [-targetnode node_name] [-force]
Parameters
Table G-42 srvctl relocate ioserver Command Parameters
Parameter | Description |
---|---|
-currentnode node_name |
The name of the node on which the Oracle ASM IOServer instance currently resides |
-targetnode node_name |
The name of the node to which to relocate the IOServer instance |
-force |
Optionally, you can force the relocation of the Oracle ASM IOServer instance |
Example
The following command relocates the Oracle ASM IOServer from a node called crsNode2
to a node called crsNode5
:
$ srvctl relocate ioserver -currentnode crsNode2 -targetnode crsNode5
G.8.74 srvctl remove ioserver
Use this command to remove an Oracle ASM IOServer instance from the cluster.
Syntax
srvctl remove ioserver [-force]
Usage Notes
Use the -force
parameter to forcibly remove the Oracle ASM IOServer instance, ignoring any dependencies.
G.8.75 srvctl setenv ioserver
Administers the environment configuration for an Oracle ASM IOServer.
Syntax
srvctl setenv ioserver {-envs "name=val[,name=val][...]" | -env "name=val"}
Parameters
Table G-43 srvctl setenv ioserver Command Parameters
Parameter | Description |
---|---|
-envs "name=val,..." |
Comma-delimited list of name-value pairs of environment variables enclosed in double quotation marks ( |
-env "name=val" |
Alternatively, use this parameter to set a single environment variable to a value that contains commas or other special characters, enclosed in double quotation marks ( |
G.8.76 srvctl start ioserver
Starts Oracle ASM IOServers in the cluster.
You can also start an Oracle ASM IOServer on a particular Hub Node by specifying the node name.
Syntax
srvctl start ioserver [-node node_name]
Usage Notes
If you choose to start an Oracle ASM IOServer on a particular Hub Node, then use the -node
parameter and specify the name of the node. If you do not specify a particular Hub Node, then SRVCTL starts all Oracle ASM IOServers in the cluster.
Example
The following command starts an Oracle ASM IOServer on a Hub node named mjkhub46
:
$ srvctl start ioserver -node mjkhub46
G.8.77 srvctl status ioserver
Displays the status of Oracle ASM IOServers running in the cluster.
You can display the status of all Oracle ASM IOServers running a cluster, the status of an Oracle ASM IOServer running on a particular Hub Node, or the information about clients from a specific database.
Syntax
srvctl status ioserver [-node node_name] [-detail]
Parameters
Table G-44 srvctl status ioserver Parameters
Parameter | Description |
---|---|
—node node_name |
Specify a particular Hub node to display the status of the Oracle ASM IOServer resource instance running there. If you do not specify a Hub node, then SRVCTL returns the status of all Oracle ASM IOServer resource instances running in the cluster. |
-detail |
Use this parameter to display more detailed information about the status of the Oracle ASM IOServer. |
Example
If you run the command with the -detail
parameter, then SRVCTL displays output similar to the following:
$ srvctl status ioserver -detail
ASM I/O Server is enabled
ASM I/O Server is running on nodes: mjk376, mjk377
ASM I/O Server instance +IOS1 running on node mjk376 is connected to ASM instance +ASM2:
Number of clients connected: 2
Names of clients: later14, alus16, later12, alus9, db0010
ASM I/O Server instance +IOS2 running on node mjk377 is connected to ASM instance +ASM3:
Number of clients connected: 3
Number of requests completed per sec: 110
Names of networks: eth1, eth2
Names of clients: later11, later3, later14, later15, later16, alus19, alus17, alus13
G.8.78 srvctl stop ioserver
Stops an Oracle ASM IOServer in the cluster.
Syntax
srvctl stop ioserver [-node node_name] [-force]
Usage Notes
-
Use the
-node
parameter to stop an Oracle ASM IOServer on a particular Hub Node. If you do not specify a particular Hub Node, then SRVCTL stops all of the Oracle ASM IOServers in the cluster. -
Use the
-force
parameter to stop an Oracle ASM IOServer, regardless of any dependencies.
G.8.79 srvctl unsetenv ioserver
Unsets the Oracle ASM IOServer environment configurations.
Syntax
srvctl unsetenv ioserver -envs "name_list"
Usage Notes
Use the -envs
parameter to specify a comma-delimited list of the names of environment variables enclosed in double quotation marks (""
).
G.8.80 srvctl add mgmtdb
Syntax
srvctl add mgmtdb [-domain domain]
Usage Notes
Optionally, you can specify the domain for the database. If you have the DB_DOMAIN
database initialization parameter set, then you must provide a value for this parameter.
Example
$ srvctl add mgmtdb -domain example.com
G.8.81 srvctl config mgmtdb
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config mgmtdb [-verbose] [-all]
Usage Notes
-
Optionally, use the
-verbose
parameter to print detailed output. -
Optionally, use the
-all
parameter to print detailed configuration information.
G.8.82 srvctl disable mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable mgmtdb [-node node_name]
Usage Notes
Optionally, you can specify the name of a cluster node on which the management database you want to disable is running.
Example
$ srvctl disable mgmtdb
G.8.83 srvctl enable mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable mgmtdb [-node node_name]
Usage Notes
Optionally, you can specify the name of a cluster node on which you want to enable a management database resource.
Example
node5
, use the following command:$ srvctl enable mgmtdb -node node5
G.8.84 srvctl getenv mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl getenv mgmtdb [-envs "name_list"]
Usage Notes
Specify a comma-delimited list of the names of environment variables enclosed in double quotation marks (""
). If you do not use this parameter, then SRVCTL displays the values of all environment variables associated with the listener.
Example
$ srvctl getenv mgmtdb
G.8.85 srvctl modify mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl modify mgmtdb [-pwfile password_file_path] [-spfile spfile_path]
[-startoption start_option] [-stopoption stop_option] [-diskgroup "diskgroup_list"]
Parameters
Table G-45 srvctl modify mgmtdb Command Parameters
Parameter | Description |
---|---|
-pwfile password_file_path |
Modify the full path to the location of the password file for the management database. |
-spfile spfile_path |
Modify the path name of the new spfile to be used by the management database. |
-startoption start_option |
Modify the startup options for the management database, such as Note: For multi-word startup options, such as See Also: SQL*Plus User's Guide and Reference for more information about startup options |
-stopoption stop_option |
Modify the stop options for the management database, such as See Also: SQL*Plus User's Guide and Reference for more information about shutdown options |
-diskgroup "diskgroup_list" |
Modify a comma-delimited list of Oracle ASM disk groups used by the management database, enclosed in double quotation marks ( |
Example
SYSFILES
Oracle ASM disk group:$ srvctl modify mgmtdb -diskgroup "SYSFILES"
G.8.86 srvctl relocate mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl relocate mgmtdb [-node node_name]
Usage Notes
Specify a node to which you want to relocate the management database.
Example
$ srvctl relocate mgmtdb -node crsNode2
G.8.87 srvctl remove mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove mgmtdb [-force] [-noprompt] [-verbose]
Parameters
Table G-46 srvctl remove mgmtdb Command Parameters
Parameter | Description |
---|---|
-force |
Optionally, you can use this parameter to forcibly remove the management database from the cluster regardless of any errors that might occur. |
-noprompt |
Optionally, you can use this parameter to suppress prompts. |
-verbose |
Optionally, you can use this parameter to display verbose output. |
Usage Notes
You must first shut down the management database before you attempt to remove it.
Example
$ srvctl remove mgmtdb -noprompt
G.8.88 srvctl setenv mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
Use this command with one of these syntax models:
srvctl setenv mgmtdb -envs "name=val[,...]"
srvctl setenv mgmtdb -env "name=val"
Parameters
Table G-47 srvctl setenv mgmtdb Command Parameters
Parameter | Description |
---|---|
-envs "name=val[,...]" |
Specify a comma-delimited list of name-value pairs of environment variables enclosed in double quotation marks ( |
-env "name=val" |
Use this parameter to enable a single environment variable to be set to a value that contains commas or other special characters enclosed in double quotation marks ( |
Example
$ srvctl setenv mgmtdb -env LANG=en
G.8.89 srvctl start mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start mgmtdb [-startoption start_options] [-node node_name]
Parameters
Table G-48 srvctl start mgmtdb Command Parameters
Parameter | Description |
---|---|
-startoption start_options |
Optionally, you can specify options to the startup command, such as Note: For multi-word startup options, such as See Also: SQL*Plus User's Guide and Reference for more information about startup options |
-node node_name |
Optionally, you can specify a particular node on which to start a management database resource. Note: This parameter can be used only with Oracle Clusterware. |
Example
crmnode1
node of the cluster is:$ srvctl start mgmtdb -node crmnode1
G.8.90 srvctl status mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status mgmtdb [-verbose]
Usage Notes
Optionally, you can use the -verbose
parameter to display detailed output.
Example
$ srvctl status mgmtdb
G.8.91 srvctl stop mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop mgmtdb [-stopoption stop_options] [-force]
Parameters
Table G-49 srvctl stop mgmtdb Command Parameters
Parameter | Description |
---|---|
-stopoption stop_options |
Optionally, you can use this parameter to specify See Also: SQL*Plus User's Guide and Reference for more information about shutdown options |
-force |
Use this parameter to forcibly stop the database and any associated services and any dependent resources. |
Example
$ srvctl stop mgmtdb -stopoption NORMAL
G.8.92 srvctl unsetenv mgmtdb
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl unsetenv mgmtdb -envs "name_list"
Usage Notes
Use the -envs
parameter to specify a comma-delimited list of the names of environment variables enclosed in double quotation marks (""
).
Example
$ srvctl unsetenv mgmtdb -envs "LANG"
G.8.93 srvctl add mgmtlsnr
Adds a management listener resource (for Cluster Health Monitor) to the cluster.
Syntax
srvctl add mgmtlsnr [-endpoints "[TCP:]port_list[/IPC:key][/NMP:pipe_name
[/TCPS:s_port][/SDP:port][/EXADIRECT:port]"] [-skip]]
Parameters
Table G-50 srvctl add mgmtlsnr Command Parameters
Parameter | Description |
---|---|
|
Protocol specifications for the listener. port_list is a comma-delimited list of TCP ports or listener endpoints
|
|
Indicates you want to skip the checking of ports. |
Example
The following command adds a management listener that is listening on port 1341 to the cluster:
$ srvctl add mgmtlsnr -endpoints "TCP:1341"
G.8.94 srvctl config mgmtlsnr
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config mgmtlsnr [-all]
Usage Notes
Use the -all
parameter to print detailed configuration information.
G.8.95 srvctl disable mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable mgmtlsnr [-node node_name]
Usage Notes
Optionally, you can specify the name of a cluster node on which the management listener you want to disable is running.
Example
$ srvctl disable mgmtlsnr
G.8.96 srvctl enable mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable mgmtlsnr [-node node_name]
Usage Notes
Optionally, you can specify the name of a cluster node on which you want to enable a management listener.
Example
node5
, use the following command:$ srvctl enable mgmtlsnr -node node5
G.8.97 srvctl getenv mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl getenv mgmtlsnr [-envs "name_list"]
Usage Notes
Optionally, you can specify a comma-delimited list of environment variable names. If you do not use this parameter, then SRVCTL displays the values of all environment variables associated with the listener.
Example
$ srvctl getenv mgmtlsnr
G.8.98 srvctl modify mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl modify mgmtlsnr [-endpoints "[TCP:]port_list[/IPC:key][/NMP:pipe_name]
[/TCPS:s_port][/SDP:port]"]
Usage Notes
Optionally, you can specify protocol specifications for the management listener. port_list
is comma-delimited list of port numbers. You can also modify this attribute using Online Resource Attribute Modification.
Example
$ srvctl modify mgmtlsnr -endpoints "TCP:2521,2522"
G.8.99 srvctl remove mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove mgmtlsnr [-force]
Usage Notes
Use the -force
parameter to forcibly remove the management listener, ignoring any dependencies.
Example
$ srvctl remove mgmtlsnr
G.8.100 srvctl setenv mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
Use this command with one of the following syntax models:
srvctl setenv mgmtlsnr -envs "name=val[,...]"
srvctl setenv mgmtlsnr -env "name=val"
Parameters
Table G-51 srvctl setenv mgmtlsnr Command Parameters
Parameter | Description |
---|---|
-envs "name=val[,...]" |
Specify a comma-delimited list of name-value pairs of environment variables enclosed in double quotation marks ( |
-env "name=val" |
Use this parameter to enable a single environment variable to be set to a value that contains commas or other special characters enclosed in double quotation marks ( |
Example
$ srvctl setenv mgmtlsnr -env LANG=en
G.8.101 srvctl start mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start mgmtlsnr [-node node_name]
Usage Notes
Specify the node on which you want to start the management listener.
Example
crmnode1
node:$ srvctl start mgmtlsnr -node crmnode1
G.8.102 srvctl status mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status mgmtlsnr [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify the name of a cluster node.
-
Optionally, use the
-verbose
parameter to display detailed output.
Examples
node2
, use the following command:$ srvctl status mgmtlsnr -node node2
G.8.103 srvctl stop mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop mgmtlsnr [-node node_name] [-force]
Usage Notes
-
Optionally, you can specify the name of a single node on which the management listener runs.
-
Optionally, you can use the
-force
parameter to forcibly stop the management listener.
Example
mynode1
:$ srvctl stop mgmtlsnr -node mynode1
G.8.104 srvctl unsetenv mgmtlsnr
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl unsetenv mgmtlsnr -envs "name_list"
Usage Notes
Use the -envs
parameter to specify a comma-delimited list of the names of environment variables enclosed in double quotation marks (""
).
Example
$ srvctl unsetenv mgmtlsnr -envs "LANG"
G.8.105 srvctl add mountfs
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl add mountfs -name mountfs_name -path mount_path -exportserver server_name
-exportpath path [-mountoptions mount_options] [-user user]
Parameters
Table G-52 srvctl add mountfs Command Parameters
Parameter | Description |
---|---|
-name mountfs_name |
Specify a unique name for the NAS. |
-path mount_path |
Specify a mount path for the NAS. |
-exportserver server_name |
Specify a name for the export server. |
-exportpath path |
Specify an export file path. |
-mountoptions mount_options |
Optionally, you can specify mount options for the NAS. |
-user user |
Optionally, you can specify a user authorized to mount and dismount the NAS. |
G.8.106 srvctl config mountfs
Note:
Use this command only with Oracle Clusterware.
Syntax
srvctl config mountfs [-name mountfs_name]
Usage Notes
Specify the unique name of the NAS for which you want to display configuration information.
G.8.107 srvctl disable mountfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable mountfs -name mountfs_name [-node node_list]
Parameters
Table G-53 srvctl disable mountfs Command Parameters
Parameter | Description |
---|---|
-name mountfs_name |
Specify the unique name for the NAS you want to disable. |
-node node_list |
Optionally, you can specify a comma-delimited list of nodes on which to disable NAS. |
G.8.108 srvctl enable mountfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable mountfs -name mountfs_name [-node node_list]
Parameters
Table G-54 srvctl enable mountfs Command Parameters
Parameter | Description |
---|---|
-name mountfs_name |
Specify the unique name for the NAS you want to enable. |
-node node_list |
Optionally, you can specify a comma-delimited list of nodes on which to enable NAS. |
G.8.109 srvctl modify mountfs
Note:
This command is available only with Oracle Clusterware.
Syntax
srvctl modify mountfs -name mountfs_name [-path mount_path] [-exportserver server_name]
[-exportpath path] [-mountoptions mount_options] [-user user_name]
Parameters
Table G-55 srvctl modify mountfs Command Parameters
Parameter | Description |
---|---|
-name mountfs_name |
Specify a unique name for the NAS you want to modify. |
-path mount_path |
Modify the mount path for the NAS. |
-exportserver server_name |
Modify the name of the export server. |
-exportpath path |
Modify the export file path. |
-mountoptions mount_options |
Modify mount options for the NAS. |
-user user_name |
Modify the user authorized to mount and dismount the NAS. |
G.8.110 srvctl remove mountfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove mountfs -name mountfs_name [-force]
Usage Notes
-
Specify the unique name for the NAS to mount.
-
Optionally, you can use the
-force
parameter to ignore resource dependencies while removing the NAS.
G.8.111 srvctl start mountfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start mountfs -name mountfs_name [-node node_list]
Parameters
Table G-56 srvctl start mountfs Command Parameters
Parameter | Description |
---|---|
-name mountfs_name |
Specify the unique name for the NAS to mount. |
-node node_list |
Optionally, you can specify a comma-delimited list of nodes on which to mount NAS. |
G.8.112 srvctl status mountfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status mountfs -name mountfs_name
Usage Notes
Specify the unique name of the NAS for which you want to display the status.
G.8.113 srvctl stop mountfs
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop mountfs -name mountfs_name [-node node_list] [-force]
Parameters
Table G-57 srvctl stop mountfs Command Parameters
Parameter | Description |
---|---|
-name mountfs_name |
Specify the unique name for the NAS to unmount. |
-node node_list |
Optionally, you can specify a comma-delimited list of nodes from which to unmount NAS. |
-force |
Optionally, you can use the |
G.8.114 srvctl add ovmm
Syntax
srvctl add ovmm -wallet certificate_wallet_file -username user_name -ovmmhost host_name | ip_address
-ovmmport port_number [-autologin]
Parameters
Table G-58 srvctl add ovmm Command Parameters
Parameter | Description |
---|---|
-wallet certificate_wallet_file |
Specify the path to the certification wallet that contains the CA certificate used by the virtual machine manager. |
-autologin |
Optionally, you can include this parameter to indicate automatic login for the wallet credentials. If you choose not to specify this parameter, then the user will always be prompted to provide the password of the wallet. |
-username user_name |
Specify a user name for whom you want to add manager credentials. You must provide a manager password when prompted. |
-ovmmhost host_name | ip_address |
Specify the host name or the IP address of the host designated as the virtual machine manager. |
-ovmmport port_number |
Specify the port number used by the virtual machine manager. |
Usage Notes
You must run this command as root
or equivalent user.
Example
An example of this command is:
# srvctl add ovmm -username scott -wallet /tmp/ovmmcred/cwallet.sso -ovmmhost node1 -ovmmport 80
G.8.115 srvctl config ovmm
Syntax
srvctl config ovmm
Usage Notes
This command takes no parameters.
Example
This command returns output similar to the following:
$ srvctl config ovmm
OVMM Host: host1
OVMM Port: 80
G.8.116 srvctl modify ovmm
Syntax
srvctl modify ovmm [-wallet certificate_wallet_file [-autologin]] [-username user_name]
[-ovmmhost host_name | ip_address [-ovmmport port_number]
Parameters
Table G-59 srvctl modify ovmm Command Parameters
Parameter | Description |
---|---|
-wallet certificate_wallet_file |
Specify the path to the certification wallet that contains the CA certificate used by the virtual machine manager. |
-autologin |
Optionally, you can include this parameter to indicate automatic login for the wallet credentials. If you choose not to specify this parameter, then the user will always be prompted to provide the password of the wallet. |
-username user_name |
Specify a user name for whom you want to add manager credentials. You must provide a manager password when prompted. |
-ovmmhost host_ip |
Specify the host name or the IP address of the host designated as the virtual machine manager. |
-ovmmport port_number |
Specify the port number used by the virtual machine manager. |
Usage Notes
-
You must run this command as
root
or equivalent user. -
The
srvctl modify ovmm
command deletes all credentials before writing new ones.
Example
An example of this command is:
$ srvctl modify ovmm -username scott -ovmport 81
G.8.117 srvctl remove ovmm
Syntax
srvctl remove ovmm
Usage Notes
-
You must run this command as
root
or equivalent user. -
This command takes no parameters.
Example
An example of this command is:
# srvctl remove ovmm
G.8.118 srvctl add qosmserver
Adds an Oracle Database QoS Management Server instance to all the nodes in the cluster.
Syntax
srvctl add qosmserver [-verbose]
Usage Notes
Optionally, you can use the -verbose
parameter to display verbose output.
Example
The following command adds an Oracle Database QoS Management Server instance:
$ srvctl add qosmserver
G.8.119 srvctl disable qosmserver
Disables the Oracle Database QoS Management Server instance on all nodes or on a specific node.
Syntax
srvctl disable qosmserver [-node node_name] [-verbose]
Usage Notes
With this command you can optionally specify a particular node on which to disable an Oracle Database QoS Management Server instance, and you can also choose verbose output.
Example
The following example disables the Oracle Database QoS Management Server on a node called crsNode3
:
$ srvctl disable qosmserver -node crsNode3
G.8.120 srvctl enable qosmserver
Enables an Oracle Database QoS Management Server instance on all nodes or on a specific node.
Syntax
srvctl enable qosmserver [-node node_name] [-verbose]
Usage Notes
With this command you can optionally specify a particular node on which to enable an Oracle Database QoS Management Server instance, and you can also choose verbose output.
Example
The following command example enables an Oracle Database QoS Management Server instance on a node named crsNode3
:
$ srvctl enable qosmserver -node crsNode3
G.8.121 srvctl modify qosmserver
Modifies the RMI port for the Oracle Database QoS Management Server instances.
Syntax
srvctl modify qosmserver -rmiport port_number [-verbose] [-force]
Table G-60 srvctl modify qosmserver Command Parameters
Parameter | Description |
---|---|
-rmiport port_number |
Specify the RMI port number that the Oracle Database QoS Management Server instance uses. Note: You can modify this attribute using Online Resource Attribute Modification. |
-verbose |
Verbose output |
-force |
Stops and restarts the resource to effect a change |
Example
The following command example sets the RMI port number to 5385:
$ srvctl modify qosmserver -rmiport 5385
G.8.122 srvctl predict qosmserver
The srvctl predict qosmserver
command predicts the consequences of Oracle Database QoS Management Server failure.
Syntax
srvctl predict qosmserver [-verbose]
This command has only one optional parameter to display verbose output.
Example
This command returns output similar to the following:
$ srvctl predict qosmserver
Resource ora.qosmserver will be started on node crsNodel
G.8.123 srvctl relocate qosmserver
Relocates an Oracle Database QoS Management Server instance from its current hosting node to another node within the cluster.
Syntax
srvctl relocate qosmserver [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify a particular node to which you want to relocate an Oracle Database QoS Management Server instance.
-
Optionally, you can use the
-verbose
parameter to display verbose output.
Example
The following command example relocates the Oracle Database QoS Management Server instance to node crsNode1
and displays verbose output:
$ srvctl relocate qosmserver -node crsNode1 -verbose
G.8.124 srvctl remove qosmserver
Removes the Oracle Database QoS Management Server instance from the Oracle Clusterware configuration.
Syntax
srvctl remove qosmserver [-force] [-verbose]
Usage Notes
Optionally, you can use the -force
and -verbose
parameters that force the removal of the Oracle Database QoS Management Server instance and display verbose output, respectively.
Example
The following command forcibly removes the Oracle Database QoS Management Server instance:
$ srvctl remove qosmserver -force
G.8.125 srvctl start qosmserver
Starts an Oracle Database QoS Management Server instance.
Syntax
srvctl start qosmserver [-node node_name] [-verbose]
Usage Notes
-
Optionally, you can specify a particular node on which to start an Oracle Database QoS Management Server instance.
-
Optionally, you can use the
-verbose
parameter to display verbose output.
Example
The following command example starts an Oracle Database QoS Management Server instance on a node called crsNode1
:
$ srvctl start qosmserver -node crsNode1
G.8.126 srvctl status qosmserver
Determines which node is running the Oracle Database QoS Management Server instance.
Syntax
srvctl status qosmserver [-node node_name] [-verbose]
You can optionally specify a particular about which you can obtain the status of the Oracle Database QoS Management Server instance, and you can also use the -verbose
parameter to display verbose output.
Example
This command returns output similar to the following:
$ srvctl status qosmserver
QoS Management Server is enabled.
QoS Management Server is running on node crsNode1.
G.8.127 srvctl stop qosmserver
Stops an Oracle Database QoS Management Server instance.
Syntax
srvctl stop qosmserver [-force] [-verbose]
Usage Notes
-
Optionally, you can specify a particular node on which to stop an Oracle Database QoS Management Server instance.
-
Optionally, you can use the
-verbose
parameter to display verbose output.
Example
The following command example forcibly stops an Oracle Database QoS Management Server instance:
$ srvctl stop qosmserver -force
G.8.128 srvctl add rhpclient
Adds a Rapid Home Provisioning Client configuration file to the Oracle Clusterware configuration.
Syntax
srvctl add rhpclient -clientdata path_to_file [-diskgroup disk_group_name -storage base_path]
[-email email_address -mailserver mail_server_address -mailserverport mail_server_port] [-verbose]
Parameters
Table G-61 srvctl add rhpclient Command Parameters
Parameter | Description |
---|---|
-clientdata path_to_file |
Specify the path to the file that contains the Rapid Home Provisioning Client data. |
-diskgroup disk_group_name |
Specify the Oracle ASM disk group from which to create the Oracle ACFS file system for image storage. |
-storage base_path |
Specify a location that is available on all cluster nodes and that is used for mounting an Oracle ACFS that you create for image storage on the Rapid Home Provisioning Client. |
-email email_address |
Specify an email address. |
-mailserver mail_server_address |
Specify the mail server address. |
-mailserverport mail_server_port |
Specify the mail server port number. |
–verbose |
Displays verbose output. |
Usage Notes
-
You cannot run this command on a Rapid Home Provisioning Server.
-
You must run this command as
root
user on Linux and UNIX platforms. -
This command does not create an Oracle Clusterware resource.
-
To store working copies in
RHP_MANAGED_STORAGE
on the client, you must specify the-diskgroup
and-storage
parameters with this command (or with). An additional benefit of using these options applies to multi-node client clusters. When the Rapid Home Provisioning Server provisions a working copy to the client cluster, the image is transferred to one node, and the client distributes it, internally, to remaining nodes.
Example
The following command creates a Rapid Home Provisioning Client:
# srvctl add rhpclient -clientdata /tmp/gnsdata
G.8.129 srvctl config rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl config rhpclient
Example
$ srvctl config rhpclient
Rapid Home Provisioning Client is configured
Cluster name: mjk9394
Storage base path: /scratch/aime/storage
Disk group: MJKRHPCDG
Rapid Home Provisioning Server (RHPS): mjk8990clust
Rapid Home Provisioning Server discovery string: 198.51.100.191
Port number: 23795
Rapid Home Provisioning Client is enabled
Rapid Home Provisioning Client is individually enabled on nodes:
Rapid Home Provisioning Client is individually disabled on nodes:
G.8.130 srvctl disable rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable rhpclient [-node node_name]
Usage Notes
Optionally, you can specify a particular node on which to disable a Rapid Home Provisioning Client.
Example
$ srvctl disable rhpclient -node clusterNode01
G.8.131 srvctl enable rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable rhpclient [-node node_name]
Usage Notes
Optionally, you can specify the node on which you want to enable the Rapid Home Provisioning Client instance. If you do not specify a node, then SRVCTL enables all of the Rapid Home Provisioning Clients in the Oracle Clusterware configuration.
Example
$ srvctl enable rhpclient -node clusterNode03
G.8.132 srvctl modify rhpclient
Syntax
srvctl modify rhpclient [-clientdata path_to_client_data] [-port rmi_port] [-diskgroup dg_name -storage base_path] [-email email_address -mailserver mail_server_address
-mailserverport mail_server_port]
Parameters
Table G-62 srvctl modify rhpclient Command Parameters
Parameter | Description |
---|---|
-clientdata path_to_client_data |
Modify the path to the Rapid Home Provisioning Client data. |
-port rmi_port |
Modify the RMI port number used by the Rapid Home Provisioning Client. |
-diskgroup dg_name |
Modify the Oracle ASM disk group from which to create the Oracle ACFS file systems for image storage. |
-storage base_path |
Modify the location which is available on every cluster node but is not necessarily shared. It is not required that this location exist when you add a Rapid Home Provisioning Client. All images are mounted on |
-email email_address |
Modify an email address. |
-mailserver mail_server_address |
Modify the mail server address. |
-mailserverport mail_server_port |
Modify the mail server port number. |
Usage Notes
-
You must run this command as the
root
user on Linux and UNIX platforms. -
You run this command only on Rapid Home Provisioning Clients.
-
After running this command, you must run
srvctl stop rhpclient
andsrvctl start rhpclient
on the Rapid Home Provisioning Client, so that it communicates the changes to the Rapid Home Provisioning Server.
G.8.133 srvctl relocate rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl relocate rhpclient -node node_name
Usage Notes
Specify a node to which you want to relocate the Rapid Home Provisioning Client instance.
Example
$ srvctl relocate rhpclient -node crsNode03
G.8.134 srvctl remove rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl remove rhpclient [-force]
Usage Notes
Optionally, you can use the -force
parameter to forcibly remove the Rapid Home Provisioning Client instance, ignoring any dependencies.
G.8.135 srvctl start rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start rhpclient [-node node_name]
Usage Notes
Specify the node on which you want to start the Rapid Home Provisioning Client instance. If you do not specify a node, then Oracle Clusterware determines the node where the Rapid Home Provisioning Client is to be started. The Rapid Home Provisioning Client resource has cardinality of 1 and Oracle Clusterware decides the placement when the Rapid Home Provisioning Client resource is started.
Example
crs3
:$ srvctl start rhpclient -node crs3
G.8.136 srvctl status rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status rhpclient
Usage Notes
This command does not accept any parameters except for -help
.
Example
$ srvctl status rhpclient
Rapid Home Provisioning Client is enabled
Rapid Home Provisioning Client is running on node mjk1270093
G.8.137 srvctl stop rhpclient
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop rhpclient
Usage Notes
This command does not accept any parameter, except for -help
.
G.8.138 srvctl add rhpserver
Syntax
srvctl add rhpserver -storage base_path -diskgroup disk_group_name [-email email_address -mailserver mail_server_address
-mailserverport mail_server_port]
Parameters
Table G-63 srvctl add rhpserver Command Parameters
Parameter | Description |
---|---|
-storage base_path |
Specify a location that is available on all cluster nodes. It is not necessary that this location be shared. The catalog for the server is kept in this location and all the image file systems are mounted on |
-diskgroup disk_group_name |
Specify a particular Oracle ASM disk group from which to create the Oracle ACFS file system for storing images. |
-email email_address |
Specify an email address. |
-mailserver mail_server_address |
Specify the mail server address. |
-mailserverport mail_server_port |
Specify the mail server port number. |
Usage Notes
-
You must be
root
user on Linux and UNIX platforms to run this command. -
The default user is the user that installed Oracle Clusterware, and this user gets added to the user list for the Rapid Home Provisioning Server resource.
G.8.139 srvctl config rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl config rhpserver
Example
$ srvctl config rhpserver
Storage base path: /scratch/aime/storagedg
Disk Groups: MJKRHPSDG
Port number: 23795
Rapid Home Provisioning Server is enabled
Rapid Home Provisioning Server is individually enabled on nodes:
Rapid Home Provisioning Server is individually disabled on nodes:
G.8.140 srvctl disable rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl disable rhpserver [-node node_name]
Usage Notes
Optionally, you can specify a node on which you want to disable the Rapid Home Provisioning Server.
Example
$ srvctl disable rhpserver -node clusterNode01
G.8.141 srvctl enable rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl enable rhpserver [-node node_name]
Usage Notes
Optionally, you can specify a node on which you want to enable the Rapid Home Provisioning Server. If you do not specify a node, then SRVCTL enables all of the Rapid Home Provisioning Servers in the Oracle Clusterware configuration.
Example
$ srvctl enable rhpserver -node clusterNode03
G.8.142 srvctl modify rhpserver
Syntax
srvctl modify rhpserver [-port rmi_port [-force]] [-email email_address -mailserver mail_server_address
-mailserverport mail_server_port]
Parameters
Table G-64 srvctl modify rhpserver Command Parameters
Parameter | Description |
---|---|
-port rmi_port |
Modify the RMI port number used by the Rapid Home Provisioning Server. |
-force |
Specify this parameter to stop and restart the resource to effect a change. |
-email email_address |
Modify an email address. |
-mailserver mail_server_address |
Modify the mail server address. |
-mailserverport mail_server_port |
Modify the mail server port number. |
G.8.143 srvctl relocate rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl relocate rhpserver [-node node_name]
Usage Notes
Optionally, you can specify a node to which you want to relocate the Rapid Home Provisioning Server.
Example
$ srvctl relocate rhpserver -node crsNode03
G.8.144 srvctl remove rhpserver
Syntax
srvctl remove rhpserver [-resource] [-force] [-verbose]
Parameters
Table G-65 srvctl remove rhpserver Command Parameters
Parameter | Description |
---|---|
-resource |
Optionally, you can remove the Rapid Home Provisioning Server resource only, leaving its repository unaffected. |
–force |
Forcibly remove the Rapid Home Provisioning Server, ignoring any dependencies. |
–verbose |
Print verbose output. |
G.8.145 srvctl start rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl start rhpserver [-node node_name]
Usage Notes
Optionally, you can specify a node on which you want to start the Rapid Home Provisioning Server.
Examples
clusterNode03
:$ srvctl start rhpserver -node clusterNode03
G.8.146 srvctl status rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl status rhpserver
Usage Notes
This command does not accept any parameters except for -help
.
Example
$ srvctl status rhpserver
Rapid Home Provisioning Server is enabled
Rapid Home Provisioning Server is running on node mjk1270089
G.8.147 srvctl stop rhpserver
Note:
This command is only available with Oracle Clusterware.
Syntax
srvctl stop rhpserver
Usage Notes
This command does not accept any parameter except for -help
.
G.8.148 srvctl update instance
Changes to which Oracle ASM instance either a database instance or an Oracle ASM IOServer instance connects.
This command disconnects a specific database or Oracle ASM IOServer instance (or instances) from one instance of Oracle ASM, and connects it to either another specific instance of Oracle ASM or to an Oracle ASM IOServer, or an instance chosen by the relocating instance.
Syntax
srvctl update instance {-database database_name | -ioserver} {-instance instance_name,... | -node node1,...}
[-targetinstance {ASM_instance_name | IOServer_instance_name}]
Parameters
Table G-66 srvctl update instance Command Parameters
Command Option | Description |
---|---|
|
Specify whether you are updating a database or Oracle ASM IOServer instance. If you are specifying a database, then you must provide the unique name of the database. If you choose to update a database instance and you specify a target instance for it to connect to, then that instance must be an Oracle ASM IOServer instance. If you choose to relocate an Oracle ASM IOServer instance and you specify a target instance for it to connect to, then that instance must be an Oracle ASM instance. |
|
Specify the name of the instance you want to update or, alternatively, specify the name of the node on which the instance runs. If you have multiple instances running that you want to update, or multiple nodes on which a particular instance is running, then you can specify a comma-delimited list of .names. Note: The command fails if you specify an Oracle ASM instance name or if you specify an instance that is not running. |
|
Optionally, you can specify a target instance to which you want the instance you are updating to connect. The target instance can be either an Oracle ASM instance or Oracle ASM IOServer instance. |
Example
To disconnect an Oracle ASM IOServer instance and reconnect it to a different Oracle ASM instance:
$ srvctl update instance -ioserver -instance +IOS2 -targetinstance +ASM4
G.8.149 srvctl add vm
Syntax
srvctl add vm -name resource_name -vm "list_of_vms" [-serverpool server_pool_name | -category server_category
| -node "node_list"] [–stoptimeout stop_timeout] [-checkinterval check_interval]
Parameters
Table G-67 srvctl add vm Command Parameters
Parameter | Description |
---|---|
-name resource_name |
Specify a unique name for the virtual machine resource. If the name is not unique, then the command results in an error. |
-vm "list_of_vms" |
Specify a comma-delimited list of virtual machine names or virtual machine IDs that you want to add to the virtual machine resource. A list must be enclosed in double quotation marks ( Currently, Oracle Clusterware gives preference to virtual machines at the beginning of this list, so you should list your most important virtual machines first. |
-serverpool server_pool_name | -category server_category | -node "node_list" |
Optionally, you can specify the name of a server pool, server category, or list of nodes to which to add the virtual machine resource. A list of nodes must be enclosed in double quotation marks ( If you choose to specify a list of nodes, then the number of nodes must be greater than or equal to the number of virtual machine resources you specify. |
–stoptimeout stop_timeout |
Optionally, you can specify a stop timeout, in seconds. The default is 180 if you do not assign a value to the parameter. |
-checkinterval check_interval |
Optionally, you can specify an interval between checks, in seconds. The default is 10 if you do not assign a value to the parameter. |
Usage Notes
You must run srvctl add ovmm
and add virtual machine manager credentials before you add a virtual machine resource.
Example
An example of this command is:
$ srvctl add vm -name vmres -vm vm1 -node node1
G.8.150 srvctl check vm
Syntax
srvctl check vm -name resource_name [-vm vm_name | -node node_name]
Parameters
Table G-68 srvctl check vm Command Parameters
Parameter | Description |
---|---|
-name resource_name |
Specify the name of the virtual machine resource for which you want to check the status. |
-vm vm_name |
Specify the name or ID of the virtual machine on which the named resource resides. |
-node node_name |
Alternatively, specify the name of the node on which the virtual machine resides. |
G.8.151 srvctl config vm
Syntax
srvctl config vm [-name unique_name]
Usage Notes
Specify the unique name of the virtual machine resource for which you want to display the configuration information. If you do not specify a particular virtual machine resource, then the command displays all of the virtual machine resources in the cluster.
Example
This command displays output similar to the following, depending on the command syntax used:
$ srvctl config vm -name vmres1
VM resource name: vmres1
VMs: vm1, y, vm3
VM Names: x, y, z
VM IDs: vm1, vm2, vm3
Server pool: vmpool
Server category:
Nodes:
Stop Timeout: 7
Check Interval: 5
VM resource "vmres1" is enabled.
VM resource is individually enabled on nodes:
VM resource is individually disabled on nodes:
VM resource is individually disabed for VMs: vm2,vm3
$
$ srvctl config vm
vmres1
vmres2
vmres3
$
G.8.152 srvctl disable vm
Syntax
srvctl disable vm -name unique_name [-vm "vm_list" | -node node_name]
Parameters
Table G-69 srvctl disable vm Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Specify the unique name of the virtual machine resource you want to disable. |
-vm "vm_list" |
Specify the name or ID, or a list of names or IDs enclosed in double quotation marks ( |
-node node_name |
Alternatively, specify the name of the node on which the virtual machine resides. If you specify this parameter, then SRVCTL does not allow any instances of the specified resource to run on that node. |
Usage Notes
If you do not specify any of the optional parameters, then SRVCTL disables the virtual machine resource, and the enabled or disabled states of all the nodes are purged, but the state of the virtual machines within the resource remains unchanged.
Example
An example of this command is:
$ srvctl disable vm -name vmres -vm "vm1,vm2,vm3"
G.8.153 srvctl enable vm
Syntax
srvctl enable vm -name unique_name [-vm "vm_list" | -node node_name]
Parameters
Table G-70 srvctl enable vm Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Specify the name of the virtual machine resource you want to enable. |
-vm vm_list |
Specify the name or ID, or a list of names or IDs enclosed in double quotation marks ( |
-node node_name |
Alternatively, specify the name of the node on which the virtual machine resides. If you specify this parameter, then SRVCTL does not allow any instances of the specified resource to run on that node. |
Usage Notes
If you do not specify any of the optional parameters, then SRVCTL enables the virtual machine resource, and the enabled or disabled states of all the nodes are purged, but the state of the virtual machines within the resource remains unchanged.
Example
An example of this command is:
$ srvctl enable -name vmres -node node3
G.8.154 srvctl modify vm
Syntax
srvctl modify vm -name uniquee_name [-addvm "list_of_vms" | -removevm "list_of_vms"
[-serverpool server_pool_name | -category server_category | -node "node_list"]
[–stoptimeout stop_timeout] [-checkinterval check_interval]
Parameters
Table G-71 srvctl modify vm Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Specify the unique name of the virtual machine resource you want to modify. |
-addvm "list_of_vms" |
Specify a comma-delimited list of virtual machine names or virtual machine IDs, enclosed in double quotation marks ( |
-removevms "list_of_vms" |
Specify a comma-delimited list of virtual machine names or virtual machine IDs that you want to remove from the virtual machine resource. You cannot remove a virtual machine if there are existing instances of the virtual machine resource still running. An attempt to do so results in an error. |
-serverpool server_pool_name | -category server_category | -node "node_list" |
You can modify the server pool, server category, or list of nodes to which the virtual machine resource belongs. A list of nodes must be enclosed in double quotation marks ( If you choose to specify a list of nodes, then the number of nodes must be greater than or equal to the number of virtual machine resources you specify. |
–stoptimeout stop_timeout |
You can modify the stop timeout, in seconds. The default is 180 if you do not assign a value to the parameter. |
-checkinterval check_interval |
You can modify the interval between checks, in seconds. The default is 10 if you do not assign a value to the parameter. |
Example
An example of this command is:
$ srvctl modify vm -name vmres -addvm vm2 -removevm vm1 -stoptimeout 93
G.8.155 srvctl relocate vm
Syntax
srvctl relocate vm -name unique_name {-vm vm_name | -srcnode source_node_name}
-node destination_node_name]
Parameters
Table G-72 srvctl relocate vm Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Specify the unique name of the virtual machine resource you want to relocate. |
-vm vm_name |
Specify the name or ID of the virtual machine on which the named resource resides to which you want to relocate the virtual machine resource, together with the name of the node to which you want to relocate the virtual machine resource. |
-srcnode source_node_name |
Alternatively, you can specify a node from which you want to relocate a virtual machine resource. |
-node destination_node_name |
Optionally, you can specify the name of a destination node to which you want to relocate the virtual machine resource. |
Example
An example of this command is:
$ srvctl relocate -name vmres -vm vm1 -node node3
G.8.156 srvctl remove vm
Syntax
srvctl remove vm -name unique_name [-force]
Usage Notes
Specify the unique name of the virtual machine resource you want to remove and, optionally, you can forcibly remove a running virtual machine resource.
G.8.157 srvctl start vm
Syntax
srvctl start vm -name unique_name [-vm vm_name -node node_name]
Parameters
Table G-73 srvctl start vm Command Parameters
Parameter | Description |
---|---|
-name resource_name |
Specify the unique name of the virtual machine resource you want to start. |
-vm vm_name |
Optionally, you can specify the virtual machine on which the virtual machine resource resides that you want to start. |
-node node_name |
Optionally, you can specify the name of a node on which a virtual machine resides that contains the virtual machine resource you want to start. |
Usage Notes
You can use the -vm
and -node
parameters, together, to start a particular virtual machine resource on a particular node. You can also use either the -vm
parameter or the -node
parameter to start a particular virtual machine resource or the virtual machine resource that resides on a particular node, respectively.
Example
An example of this command is:
$ srvctl start vm -name vmres -vm vm3 -node node3
G.8.158 srvctl status vm
Syntax
srvctl status vm -name unique_name [-vm vm_name | -node node_name]
Parameters
Table G-74 srvctl status vm Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Specify the unique name of the virtual machine resource for which you want to display the status. |
-vm vm_name |
Optionally, you can specify the virtual machine on which the virtual machine resource resides that you want to display the status. |
-node node_name |
Optionally, you can specify the name of a node on which a virtual machine resides that contains the virtual machine resource you want to display the status. |
Examples
This command returns output similar to following, depending on which parameters you specify:
$ srvctl status vm -name vmres1 -vm vm1
Virtual machine "vm1" of VM resource "vmres1" is running on node aime1.
$
$ srvctl status vm -name vmres1
Virtual machine "vm1" of VM resource “vmres1” is running on node aime1.
Virtual machine "vm2" of VM resource “vmres1” is not running.
Virtual machine "vm3" of VM resource “vmres1” is running on node aime3
$
$ srvctl status vm -name vmres1 -vm vm1 -S 1
result: vm_resource={vmres1} inst_name={vm1} node_name={aime1} up={true}
$
G.8.159 srvctl stop vm
Syntax
srvctl stop vm -name unique_name [-vm vm_name | -node node_name]
Parameters
Table G-75 srvctl stop vm Command Parameters
Parameter | Description |
---|---|
-name unique_name |
Specify the unique name of the virtual machine resource you want to stop. |
-vm vm_name |
Optionally, you can specify the virtual machine on which the virtual machine resource resides that you want to stop. |
-node node_name |
Optionally, you can specify the name of a node on which a virtual machine resides that contains the virtual machine resource you want to stop. |
Example
An example of this command is:
$ srvctl stop vm -name vmres1 -node node1