Skip Navigation Links
Exit Print View
| Oracle Solaris Cluster Reference Manual Oracle Solaris Cluster 4.1

Search Scope:

- This Document
- Entire Library

### Intro

- introduction to Oracle Solaris Cluster maintenance commands

## Description

This section describes the object-oriented command set for Oracle Solaris Cluster. Although the original Oracle Solaris Cluster command set is still available, use the object-oriented commands for more intuitive configuration of your cluster. In addition, future new features might not be available in the original command set.

The object-oriented command set uses a common prefix `cl`. The original command set used the prefix `sc`. Both the `sc` and `cl` commands are located in `/usr/cluster/bin`.

Many commands in this command set have both a long form and a short form. For example, `clresource`(1CL) and `clrs`(1CL) are identical.

Each object-oriented command is designed to manage a single type of cluster object. The command name indicates the type of object that it manages. For example, the `clresource` command manages Oracle Solaris Cluster data service resources. Within a command, subcommands define operations that are allowed on the specific cluster object.

The general form of commands in the object-oriented command set is as follows:

cmdname [subcommand] [option…] [operand …]

Options that you use with the object-oriented commands also have a long form and a short form. You specify the short form of an option with a single dash (`-`) followed by a single character. You specify the long form of an option with two dashes (`--`) followed by an option word. For example, `-p` is the short form of the property option. `--property` is the long form.

Some options accept an option argument while others do not. If an option accepts an option argument, the option argument is required. The `-?` option requires no arguments. However, the `--property` option requires an option argument that identifies the property being operated on.

You can group the short form of options without arguments behind a single dash (`-`). For example, `-eM`. You must separate groups of option-arguments following an option either by commas, or by a tab or a space character. When using a tab or space, surround the option-arguments with quotation marks (-o xxx,z,yy or -o “xxx z yy”).

To specify option arguments with long option names, use either the `--input=configurationfile` format or the `--input configurationfile` format.

All commands in this command set accept the `-?` or `--help` option. If you provide these options without a subcommand, summary help for the command is displayed. If you provide a subcommand, help for that subcommand only is displayed.

Certain commands work in conjunction with a configuration file. For information on the required format of this file, see the `clconfiguration`(5CL) man page.

Many subcommands in this command set accept `+` as an operand to indicate all applicable objects.

## LIST OF COMMANDS

This section describes, in alphabetical order, the object-oriented commands that are available with the Oracle Solaris Cluster product.

`claccess`(1CL)

  Manage Oracle Solaris Cluster access policies for adding nodes

`cldevice`(1CL), `cldev`(1CL)

  Manage Oracle Solaris Cluster devices

`cldevicegroup`(1CL), `cldg`(1CL)

  Manage Oracle Solaris Cluster device groups

`clinterconnect`(1CL), `clintr`(1CL)

  Manage the Oracle Solaris Cluster interconnect

`clnasdevice`(1CL), `clnas`(1CL)

  Manage access to NAS devices for Oracle Solaris Cluster

`clnode`(1CL)

  Manage Oracle Solaris Cluster nodes

`clpstring`(1CL)

  Manage Oracle Solaris Cluster private strings

`clquorum`(1CL), `clq`(1CL)

  Manage Oracle Solaris Cluster quorum

`clreslogicalhostname`(1CL), `clrslh`(1CL)

  Manage Oracle Solaris Cluster resources for logical host names

`clresource`(1CL), `clrs`(1CL)

  Manage resources for Oracle Solaris Cluster data services

`clresourcegroup`(1CL), `clrg`(1CL)

  Manage resource groups for Oracle Solaris Cluster data services

`clresourcetype`(1CL), `clrt`(1CL)

  Manage resource types for Oracle Solaris Cluster data services

`clressharedaddress`(1CL), `clrssa`(1CL)

  Manage Oracle Solaris Cluster resources for shared addresses

`clsetup`(1CL)

  Configure Oracle Solaris Cluster interactively

`clsnmphost`(1CL)

  Administer Oracle Solaris Cluster SNMP hosts

`clsnmpmib`(1CL), `clmib`(1CL)

  Administer Oracle Solaris Cluster SNMP MIB

`clsnmpuser`(1CL)

  Administer Oracle Solaris Cluster SNMP users

`cltelemetryattribute`(1CL)

  Configure system resource monitoring

`cluster`(1CL)

  Manage the global configuration and the global status of Sun Cluster

`clzonecluster`(1CL),`clzc`(1CL)

  Manage zone clusters for Oracle Solaris Cluster

## Mapping Original Oracle Solaris Cluster Commands to Object-Oriented Commands

Because the newer command set is object oriented, a clear one-to-one mapping from the original command set does not exist. The following list provides some common Oracle Solaris Cluster commands from the original set and their object-oriented set equivalents.

`scstat`

  `cluster status`

  You can also use the `status` subcommands that are available with many of the object-oriented commands.

`scinstall`

  Use `cluster create` to create a cluster from an XML configuration file.

  To create a cluster interactively, use `scinstall`.

`scrgadm`

  - `clresource`

  - `clresourcetype`

  - `clresourcegroup`

  `clressharedaddress` and `clreslogicalhostname` provide additional conveniences when you work with those particular resource types.

`scswitch`

  - `clresource`

  - `clresourcetype`

  - `clresourcegroup`

  - `clreslogicalhostname`

  - `clressharedaddress`

  - `clnode evacuate` (to move off a node all resource groups and device groups)

`scconf`

  - `cldevicegroup`

  - `clinterconnect`

  - `clquorum`

  - `clnode`

  - `claccess`

  Use `cluster show` instead of `scconf -p`.

`sccheck`

  `cluster check`

`scdidadm`

  `cldevice`

`scgdevs`

  `cldevice populate`

`scdpm`

  `cldevice`

`scnas`, `scnasdir`

  `clnasdevice`

`scsetup`

  `clsetup`

## Exit Status

If an object-oriented Oracle Solaris Cluster command is successful for all specified operands, the command returns zero (`CL_NOERR`). If an error occurs for an operand, the command processes the next operand in the operand list. The returned exit code always reflects the error that occurred first.

These exit codes are shared across this set of commands.

`0` `CL_NOERR`

  No error

  The command that you issued completed successfully.

`1` `CL_ENOMEM`

  Not enough swap space

  A cluster node ran out of swap memory or ran out of other operating system resources.

`3` `CL_EINVAL`

  Invalid argument

  You typed the command incorrectly, or the syntax of the cluster configuration information that you supplied with the `-i` option was incorrect.

`5` `CL_ERECONF`

  Cluster is reconfiguring

  The cluster is reconfiguring.

`6` `CL_EACCESS`

  Permission denied

  The object that you specified is inaccessible. You might need superuser or RBAC access to issue the command. See the `su`(1M) and `rbac`(5) man pages for more information.

`9` `CL_ESTATE`

  Object is in wrong state

  You tried to modify a property, a resource group, or other object that you cannot modify at that particular time or at any time.

`10` `CL_EMETHOD`

  Resource method failed

  A method of a resource failed. The method failed for one of the following reasons:

  - The `validate` method failed when you tried to create a resource or modify the properties of a resource.

  - A method other than `validate` failed when you tried to enable, disable, or delete a resource.

`15` `CL_EPROP`

  Invalid property

  The property or value that you specified with the `-p`, `-y`, or `-x` option does not exist or is not allowed.

`18` `CL_EINTERNAL`

  Internal error was encountered

  An internal error indicates a software defect or other defect.

`35` `CL_EIO`

  I/O error

  A physical input/output error has occurred.

`36` `CL_ENOENT`

  No such object

  The object that you specified cannot be found for one of the following reasons:

  - The object does not exist.

  - A directory in the path to the configuration file that you attempted to create with the `-o` option does not exist.

  - The configuration file that you attempted to access with the `-i` option contains errors.

`37` `CL_EOP`

  Operation not allowed

  You tried to perform an operation on an unsupported configuration, or you performed an unsupported operation.

`38` `CL_EBUSY`

  Object busy

  You attempted to remove a cable from the last cluster interconnect path to an active cluster node. Or, you attempted to remove a node from a cluster configuration from which you have not removed references.

`39` `CL_EEXIST`

  Object exists

  The device, device group, cluster interconnect component, node, cluster, resource, resource type, resource group, or private string that you specified already exists.

`41` `CL_ETYPE`

  Invalid type

  The type that you specified with the `-t` or `-p` option does not exist.

`50` `CL_ECLMODE`

  Node is in cluster mode

  You attempted to perform an operation on a node that is booted in cluster mode. However, you can perform this operation only on a node that is booted in noncluster mode.

`51` `CL_ENOTCLMODE`

  Node is not in cluster mode

  You attempted to perform an operation on a node that is booted in noncluster mode. However, you can perform this operation only on a node that is booted in cluster mode.

## See Also

`getopt`(1)

## Attributes

See `attributes`(5) for descriptions of the following attributes:

ATTRIBUTE TYPE | ATTRIBUTE VALUE
--- | ---
Availability | ha-cluster/system/core
Interface Stability | Evolving

Copyright © 2000, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |