---
name: "cluadmin"
section: "8"
platform: "linux"
package: "kimberlite"
version: "1.1.0-3"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/cluadmin"
---

# cluadmin(8)

Invokes the cluster management utility.

## NAME

cluadmin - Invokes the cluster management utility.

## SYNOPSIS

**cluadmin** \[*OPTION* ...\]

## DESCRIPTION

The **cluadmin** utility enables you to manage cluster systems and services.  Using the utility, you can:

- o Add, modify, and delete services

  - o Disable and enable services

  - o Display cluster and service status

  - o Modify cluster daemon event logging

  - o Backup and restore the cluster database

  When you invoke the  **cluadmin** utility in interactive mode, the cluadmin\> prompt appears.  You can then specify administrative commands, as  described in the COMMANDS section.

## OPTIONS

You can specify the following  **cluadmin** command line options:

- **-d**, **--debug**

  Displays extensive diagnostic information.

- **-h**,**-?**, **--help**

  Displays help about the utility, and then exits.

- **-n**, **--nointeractive**

  Bypasses the  **cluadmin** utility's top-level command loop processing. This option is used for  **cluadmin** debugging purposes.

- **-t**, **--tcl**

  Adds a Tcl command to the  **cluadmin** utility's top-level command interpreter. To pass a Tcl command directly to the utility's internal Tcl interpreter, at the cluadmin\> prompt, preface the Tcl command with **tcl**.  This option is used for  **cluadmin** debugging purposes.

- **-V**, **--version**

  Displays information about the current version of **cluadmin**.

## COMMANDS

Within the  **cludamin** interactive mode, you can specify the following commands at the cluadmin\> prompt:

- **help** \[*command*\]

  Displays help for the specified  **cluadmin** command, or, if a command is not specified, displays a list of  **cluadmin** commands for which you can obtain help.

- **apropos** \[*string*\]

  Displays the  **cluadmin** commands that match the specified character string. If no string is specified, displays all **cluadmin** commands.

- **clear**

  Clears the screen display.

- **exit**

  Exits from the **cluadmin** utility

- **cluster status**

  Displays a snapshot of the current cluster status.

- **cluster monitor**

  Continuously displays snapshots of the cluster status at five-second intervals. Press the Return or Enter key to stop the display. You can specify the **-interval**  *#* option with a  numeric value to display snapshots at the specified time interval (in seconds). In addition, you can  specify the **-clear yes** option to clear the screen after each snapshot display, or a **-clear no** option to not clear the screen.

- **cluster loglevel** *daemon* *level*

  Sets the logging for the specified cluster daemon to the specified severity level.  The cluster daemons include the  quorumd, svcmgr, powerd, and hb daemons.  Specify either the name of the severity level or its numeric  equivalent, as follows:  emerg (0), alert (1), crit (2), err (3), warning (4), notice (5), info (6), or debug (7).

- **cluster reload**

  Forces the cluster daemons to re-read the cluster configuration database.

- **cluster name** *cluster\_name*

  Sets the name of the cluster to the specified name.

- **cluster backup**

  Saves a copy of the cluster configuration database in the /etc/opt/cluster/cluster.conf.bak file.

- **cluster restore**

  Restores the cluster configuration database from the backup copy in the /etc/opt/cluster/cluster.conf.bak file.

- **cluster saveas** *file\_name*

  Saves the cluster configuration database to the specified file.

- **cluster restorefrom** *file\_name*

  Restores the cluster configuration database from the specified file.

- **service add** \[*service\_name*\]

  Adds a cluster service to the cluster database. The  **cluadmin** utility will prompt you for information about service resources and properties.

- **service modify** *service\_name*

  Modifies the resources or properties of the specified service.

- **service show state** \[*service\_name*\]

  Displays the current status of all services or the specified service.

- **service show config** *service\_name*

  Displays the current configuration for the specified service.

- **service disable** *service\_name*

  Stops the specified running service.

- **service enable** *service\_name*

  Starts the specified disabled service.

- **service delete** *service\_name*

  Deletes the specified service from the cluster.

You can use the Tab key to help you identify  **cluadmin** commands.  For example, pressing the Tab key at the prompt displays a list of all the  commands. Entering a letter at the prompt and then pressing the Tab key displays the command that begins with the  specified letter or a list of all the commands that begin with the specified letter.  Specifying a command and then  pressing the Tab key displays a list of all the subcommands that can be specified with that command.

You can display the history of  **cluadmin** commands by pressing the up arrow or down arrow key at the prompt.  The command history is stored in the  **.cluadmin\_history** file in your home directory.

## EXAMPLE

The following is an example of using  **cluadmin** to disable a running service:

```
cluadmin> service disable nfs_home
Are you sure? (Y/N/?) y
notice: Stopping service nfs_home  ...
notice: Service nfs_home is disabled
service nfs_home disabled
cluadmin>
```

## REPORTING BUGS

Report bugs to missioncriticallinux.com.

## SEE ALSO

See the   **Installation and Administration** manual for more information.