This section describes the object-oriented command set for Sun Cluster. Although the original Sun 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.
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 Sun 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, -emM. 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.
This section describes, in alphabetical order, the object-oriented commands that are available with the Sun Cluster product.
Manage Sun Cluster access policies for adding nodes
Manage Sun Cluster devices
Manage Sun Cluster device groups
Manage the Sun Cluster interconnect
Manage access to NAS devices for Sun Cluster
Manage Sun Cluster nodes
Manage Sun Cluster quorum
Manage Sun Cluster resources for logical host names
Manage resources for Sun Cluster data services
Manage resource groups for Sun Cluster data services
Manage resource types for Sun Cluster data services
Manage Sun Cluster resources for shared addresses
Configure Sun Cluster interactively
Administer Sun Cluster SNMP hosts
Administer Sun Cluster SNMP MIB
Administer Sun Cluster SNMP users
Configure system resource monitoring
Manage the global configuration and the global status of Sun Cluster
Configure Veritas Volume Manager for Sun Cluster
Manage zone clusters for Sun Cluster
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 Sun Cluster commands from the original set and their object-oriented set equivalents.
You can also use the status subcommands that are available with many of the object-oriented commands.
Use cluster create to create a cluster from an XML configuration file.
To create a cluster interactively, use scinstall.
clressharedaddress and clreslogicalhostname provide additional conveniences when you work with those particular resource types.
clnode evacuate (to move off a node all resource groups and device groups)
Use cluster show instead of scconf -p.
If an object-oriented Sun 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.
The command that you issued completed successfully.
Not enough swap space
A cluster node ran out of swap memory or ran out of other operating system resources.
You typed the command incorrectly, or the syntax of the cluster configuration information that you supplied with the -i option was incorrect.
Cluster is reconfiguring
The cluster is reconfiguring.
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.
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.
The property or value that you specified with the -p, -y, or -x option does not exist or is not allowed.
Internal error was encountered
An internal error indicates a software defect or other defect.
A physical input/output error has occurred.
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.
Operation not allowed
You tried to perform an operation on an unsupported configuration, or you performed an unsupported operation.
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.
The device, device group, cluster interconnect component, node, cluster, resource, resource type, or resource group that you specified already exists.
The type that you specified with the -t or -p option does not exist.
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.
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 attributes(5) for descriptions of the following attributes: