This appendix introduces the object-oriented commands, their short forms, and their subcommands.
In addition to their longer and more descriptive forms, many Sun Cluster commands also have a short form, or alias, that significantly reduces the amount you must type. The following table lists the commands and their shorter aliases.
Table A–1 Object-Oriented Commands and Aliases (Short Names)
Full Command |
Alias |
Purpose |
---|---|---|
claccess |
none |
Manage Sun Cluster access policies |
cldevice |
cldev |
Manage Sun Cluster devices |
cldevicegroup |
cldg |
Manage Sun Cluster device groups |
clinterconnect |
clintr |
Manage the Sun Cluster interconnect |
clnasdevice |
clnas |
Manage access to NAS devices for Sun Cluster |
clnode |
none |
Manage Sun Cluster nodes |
clquorum |
clq |
Manage Sun Cluster quorum |
clquorumserver |
clqs |
Configure and manage quorum server processes on the quorum server host |
clreslogicalhostname |
clrslh |
Manage Sun Cluster resources for logical host names |
clresource |
clrs |
Manage resources for Sun Cluster data services |
clresourcegroup |
clrg |
Manage resource groups for Sun Cluster data services |
clresourcetype |
clrt |
Manage resource types for Sun Cluster data services |
clrssharedaddress |
clrssa |
Manage Sun Cluster resources for shared addresses |
clsetup |
none |
Configure Sun Cluster interactively. This command has no subcommands. |
clsnmphost |
none |
Administer Sun Cluster SNMP hosts |
clsnmpmib |
none |
Administer the Sun Cluster SNMP MIB |
clsnmpuser |
none |
Administer Sun Cluster SNMP users |
cltelemetryattribute |
clta |
Configure system resource monitoring. |
cluster |
none |
Manage the global configuration and status of Sun Cluster |
clvxvm |
none |
Configure Veritas Volume Manager for Sun Cluster |
clzonecluster |
clzc |
Manage zone clusters |
The following tables list the commands in the object-oriented command set and the subcommands available with each command.
Table A–2 claccess: Manage Sun Cluster Access Policies for Nodes
Purpose |
|
---|---|
allow |
Allows the specified machine or machines access to the cluster configuration. |
allow-all |
Allows all nodes access to the cluster configuration. |
deny |
Denies the specified machine or machines access to the cluster configuration. |
deny-all |
Denies all nodes access to the cluster configuration. |
list |
Displays the names of the machines that have access to the cluster configuration. |
set |
Sets the authentication protocol to the value that you specify with the -a option. |
show |
Displays the names of the machines that have access to the cluster configuration. |
Table A–3 cldevice, cldev: Manage Sun Cluster Devices
Purpose |
|
---|---|
check |
Performs a consistency check to compare the kernel representation of the devices against the physical devices. |
clear |
Removes all DID references to underlying devices that are detached from the current node. |
combine |
Combines the specified DID instance with a new destination instance. |
export |
Exports configuration information for a cluster device. |
list |
Displays all device paths. |
monitor |
Turns on monitoring for the specified disk paths. |
populate |
Populates the global-devices namespace. |
refresh |
Updates the device configuration information that is based on the current device trees on a cluster node. |
rename |
Moves the specified DID instance to a new DID instance. |
repair |
Performs a repair procedure on the specified device instances. |
replicate |
Configures DID devices for use with controller-based replication. |
set |
Sets the properties of the specified device. |
show |
Displays a configuration report for all specified device paths. |
status |
Displays the status of the disk paths that are specified as operands to the command. |
unmonitor |
Turns off monitoring for the disk paths that are specified as operands to the command. |
Table A–4 cldevicegroup, cldg: Manage Sun Cluster Device Groups
Purpose |
|
---|---|
add-device |
Adds new member disk devices to an existing raw-disk device group. |
add-node |
Adds new nodes to an existing device group. |
create |
Creates a new device group. |
delete |
Deletes device groups. |
disable |
Disables offline device groups. |
enable |
Enables device groups. |
export |
Exports the device-group configuration information. |
list |
Displays a list of device groups. |
offline |
Takes device groups offline. |
online |
Brings device groups online on a predesignated node. |
remove-device |
Removes member disk devices from a raw-disk device group. |
remove-node |
Removes nodes from existing device groups. |
set |
Sets attributes that are associated with a device group. |
show |
Generates a configuration report for device groups. |
status |
Generates a status report for device groups. |
switch |
Transfers device groups from one primary node in a Sun Cluster configuration to another node. |
sync |
Synchronizes device-group information with the clustering software. |
Table A–5 clinterconnect, clintr: Manage the Sun Cluster Interconnect
Purpose |
|
---|---|
add |
Adds the new cluster interconnect components that are specified as operands to the command. |
disable |
Disables the interconnect components that are specified as operands to the command. |
enable |
Enables the interconnect components that are specified as operands to the command. |
export |
Exports the cluster interconnect configuration information. |
remove |
Removes the cluster interconnect components that are supplied as operands to the command. |
show |
Displays the configuration of interconnect components. |
status |
Displays the status of the interconnect paths. |
Table A–6 clnasdevice, clnas: Manage Access to NAS Devices for Sun Cluster
Purpose |
|
---|---|
add |
Adds a NAS device to the Sun Cluster configuration. |
add-dir |
Adds the specified directories of an already configured NAS device to the cluster configuration. |
export |
Exports the cluster NAS device configuration information. |
list |
Displays the NAS devices configured in the cluster. |
remove |
Removes the specified NAS device or devices from the Sun Cluster configuration. |
remove-dir |
Removes the specified NAS directory or directories from the Sun Cluster configuration. |
set |
Sets specified properties of a specific NAS device. |
show |
Displays configuration information for NAS devices in the cluster. |
Table A–7 clnode: Manage Sun Cluster Nodes
Purpose |
|
---|---|
add |
Configures and adds a node to the cluster. |
add-farm |
Adds a farm node to a cluster. |
clear |
Removes a node from the Sun Cluster software configuration. |
evacuate |
Attempts to switch over all resource groups and device groups from the specified node to a new set of primary nodes. |
export |
Exports the node or farm configuration information to a file or to the standard output (stdout). |
list |
Displays the names of nodes that are configured in the cluster or in the farm. |
remove |
Removes a node from the cluster. |
remove-farm |
Removes a farm node from a cluster. |
set |
Sets the properties that are associated with the node that you specify. |
show |
Displays the configuration of the specified node or nodes. |
show-rev |
Displays the names of and release information about the Sun Cluster packages that are installed on a node. |
status |
Displays the status of the node or nodes that you specify. |
Table A–8 clquorum, clq: Manage Sun Cluster Quorum Configuration
Purpose |
|
---|---|
add |
Adds the specified shared device as a quorum device. |
disable |
Puts a quorum device or node in the quorum maintenance state. |
enable |
Removes a quorum device or a node from the quorum maintenance state. |
export |
Exports the configuration information for the cluster quorum. |
list |
Displays the names of quorum devices that are configured in the cluster. |
remove |
Removes the specified quorum device or devices from the Sun Cluster quorum configuration. |
reset |
Resets the entire quorum configuration to the default vote count settings. |
show |
Displays the properties of quorum devices. |
status |
Displays the status and vote counts of quorum devices. |
Table A–9 clquorumserver, clqs: Manage Quorum Servers
Purpose |
|
---|---|
clear |
Removes outdated cluster information from the quorum server. |
show |
Displays the configuration information about the quorum server. |
start |
Starts the quorum server process on the host machine. |
stop |
Stops the quorum server process. |
Table A–10 clreslogicalhostname, clrslh: Manage Resources for Sun Cluster Logical Host Names
Purpose |
|
---|---|
create |
Creates new logical host name resources. |
delete |
Deletes logical host name resources. |
disable |
Disables logical host name resources. |
enable |
Enables logical host name resources. |
export |
Exports logical host name resource configuration, |
list |
Displays a list of the logical host name resources. |
list-props |
Displays a list of the properties of the logical host name resources. |
monitor |
Turns on monitoring for logical host name resources. |
reset |
Clears an error flag that is associated with logical host name resources. |
set |
Sets specified properties of the logical host name resources. |
show |
Displays the configuration of logical host name resources. |
status |
Displays the status of logical host name resources. |
unmonitor |
Turns off monitoring for logical host name resources. |
Table A–11 clresource, clrs: Manage Resources for Sun Cluster Data Services
Purpose |
|
---|---|
create |
Creates the resources that are specified as operands to the command. |
delete |
Deletes the resources that are specified as operands to the command. |
disable |
Disables resources. |
enable |
Enables resources. |
export |
Exports the cluster resource configuration. |
list |
Displays a list of cluster resources. |
list-props |
Displays a list of resource properties. |
monitor |
Turns on monitoring for resources. |
reset |
Clears error flags that are associated with cluster resources. |
set |
Sets resource properties. |
show |
Displays resource configuration. |
status |
Displays resource status. |
unmonitor |
Turns off resource monitoring. |
Table A–12 clresourcegroup, clrg: Manage Resource Groups for Sun Cluster Data Services
Purpose |
|
---|---|
add-node |
Adds a node to the end of the Nodelist property for a resource group. |
create |
Creates a new resource group. |
delete |
Deletes a resource group. |
evacuate |
Brings offline all resource groups on the nodes that you specify with the -n option. |
export |
Writes the configuration information for a resource group to a file or to the standard output (stdout). |
list |
Displays a list of resource groups. |
manage |
Brings a resource group that you specify to a managed state. |
offline |
Brings a resource group that you specify to an offline state. |
online |
Brings a resource group that you specify to an online state. |
quiesce |
Brings the specified resource group to a quiescent state. |
remaster |
Switches a resource group that you specify to its most preferred node. |
remove-node |
Removes a node from the Nodelist property of a resource group. |
restart |
Takes a resource group offline and then back online on the same set of primary nodes that originally hosted the resource group. |
resume |
Clears the suspended state of any suspended resource groups that you specify. |
set |
Sets the properties that are associated with the resource groups that you specify. |
show |
Generates a configuration report for resource groups that you specify. |
status |
Generates a status report for resource groups that you specify. |
suspend |
Suspends RGM control over all applications that are managed by a resource group that you specify. |
switch |
Changes the node, or set of nodes, that is mastering a resource group that you specify. |
unmanage |
Brings a resource group that you specify to an unmanaged state. |
Table A–13 clresourcetype, clrt: Manage Resource Types for Sun Cluster Data Services
Purpose |
|
---|---|
add-node |
Adds the specified nodes to the node list for resource types. |
export |
Exports the cluster resource-type configuration. |
list |
Displays a list of resource types. |
list-props |
Displays a list of the resource extension properties or resource type properties of resource types. |
register |
Registers resource types. |
remove-node |
Removes a node from the list of nodes for which the resource types in the operand list are registered. |
set |
Sets properties of resource types. |
show |
Displays configuration information about resource types that are registered in the cluster. |
unregister |
Unregisters resource types. |
Table A–14 clressharedaddress, clrssa: Manage Sun Cluster Resources for Shared Addresses
Purpose |
|
---|---|
create |
Creates shared address resources. |
delete |
Deletes shared address resources. |
disable |
Disables shared address resources. |
enable |
Enables shared address resources. |
export |
Exports shared address resource configuration. |
list |
Displays a list of shared address resources. |
list-props |
Displays a list of properties of shared address resources. |
monitor |
Turns on monitoring for shared address resources. |
reset |
Clears an error flag that is associated with shared address resources. |
set |
Sets specified properties of shared address resources. |
show |
Displays the configuration of shared address resources. |
status |
Displays the status of shared address resources. |
unmonitor |
Turns off monitoring for shared address resources. |
Table A–15 clsnmphost: Administer the List of Sun Cluster SNMP Hosts
Purpose |
|
---|---|
add |
Adds an SNMP host to the specified node configuration. |
export |
Exports the SNMP host information from the specified node. |
list |
Lists the SNMP hosts that are configured on the specified node. |
remove |
Removes an SNMP host from the node configuration. |
show |
Displays the SNMP host configuration information on the specified node. |
Table A–16 clsnmpmib: Administer Sun Cluster SNMP MIB
Purpose |
|
---|---|
disable |
Disables one or more of the cluster MIBs on the specified nodes. |
enable |
Enables one or more cluster MIBs on the specified node. |
export |
Exports the cluster MIB configuration information. |
list |
Displays a list of cluster MIBs on the specified nodes. |
set |
Sets the SNMP protocol setting that is used on one or more of the MIBs. |
show |
Displays configuration information for MIBs on the specified nodes. |
Table A–17 clsnmpuser: Administer Sun Cluster SNMP Users
Purpose |
|
---|---|
create |
Adds a user to the SNMP user configuration on the specified node. |
delete |
Deletes an SNMPv3 user from the specified node. |
export |
Exports the SNMP user information from the specified node. |
list |
Prints a list of SNMPv3 users that are configured on the specified node. |
set |
Sets the configuration of a user on the specified node. |
set-default |
Sets the default user and security level to use when sending traps using SNMPv3. |
show |
Displays the information about the users on the specified node. |
Table A–18 cltelemetryattribute, clta: Configure System Resource Monitoring
Purpose |
|
---|---|
disable |
Disables the specified telemetry attribute for the specified object type. |
enable |
Enables data collection for the specified telemetry attribute for the specified object types. |
export |
Exports the configuration of the telemetry attributes of object types and object instances to a file or to the standard output (stdout). |
list |
Displays the telemetry attributes that are configured for the specified object types. |
|
Displays system resource usage for the specified telemetry attributes that are enabled for the specified object instances or object types. |
set-threshold |
Modifies the settings of a threshold for a specified telemetry attribute on a specified object on a node. |
show |
Displays the properties that are configured for telemetry attributes on object types or object instances. |
Table A–19 cluster: Manage the Global Configuration and Status of a Cluster
Purpose |
|
---|---|
check |
Checks and reports whether the cluster is configured correctly. |
create |
Creates a cluster by using configuration information that is stored in a clconfigfile file. |
export |
Exports the configuration information in a cluster configuration file. |
list |
Displays the name of the cluster on which you issue the cluster command. |
list-checks |
Prints a list with the check ID and description of each available check. |
list-cmds |
Prints a list of all available Sun Cluster commands. |
rename |
Renames the cluster on which you issue the cluster command. |
restore-netprops |
Repairs the cluster private-network settings of the cluster on which you issue the cluster command. |
set |
Sets the properties of the cluster on which you issue the cluster command. |
set-netprops |
Sets the properties of the cluster private network address. |
show |
Displays detailed configuration information about cluster components for the specified clusters. |
show-netprops |
Displays the private network address settings. |
shutdown |
Shuts down the cluster on which you issue the cluster command in an orderly fashion. |
status |
Displays the status of cluster components in the specified cluster. |
Table A–20 clvxvm: Configure Veritas Volume Manager for Sun Cluster
Purpose |
|
---|---|
encapsulate |
Encapsulates the root disk and performs other Sun Cluster-specific tasks. |
initialize |
Initializes VxVM and performs other Sun Cluster-specific tasks. |
Table A–21 clzonecluster: Create and Manage Zone Clusters for Sun Cluster
Purpose |
|
boot |
Boots the zone cluster. |
clone |
Clones the zone cluster. |
configure |
Launches an interactive utility to configure and create a zone cluster. |
delete |
Removes a specific zone cluster. |
halt |
Stops a zone cluster or a specific node on the zone cluster. |
install |
Installs a zone cluster. |
list |
Displays the names of configured zone clusters. |
move |
Moves the zonepath to a new zonepath. |
ready |
Prepares the zone for applications. |
reboot |
Reboots a zone cluster. |
show |
Displays the properties of zone clusters. |
status |
Determines if the zone cluster node is a member of the zone cluster. |
uninstall |
Uninstalls a zone cluster. |
verify |
Checks that the syntax of the specified information is correct. |