'\" t
.\" Title: lizardfs-admin
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1
.\" Date: 01/19/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIZARDFS\-ADMIN" "8" "01/19/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lizardfs-admin, lizardfs-probe \- LizardFS monitoring and administration tool
.SH "SYNOPSIS"
.sp
\fBlizardfs\-admin\fR \fICOMMAND\fR [OPTIONS\&...] [ARGUMENTS\&...]
.SH "AVAILABLE COMMANDS"
.PP
\fBchunks\-health\fR \fI \fR
.RS 4
Returns chunks health reports in the installation\&. By default (if no report is specified) all reports will be shown\&. In replication and deletion states, the column means the number of chunks with number of copies specified in the label to replicate/delete\&.
Possible command\-line options:
\-\-availability
Print report about availability of chunks\&.
\-\-replication
Print report about about number of chunks that need replication\&.
\-\-deletion
Print report about about number of chunks that need deletion\&.
.RE
.PP
\fBinfo\fR \fI \fR
.RS 4
Prints statistics concerning the LizardFS installation\&.
.RE
.PP
\fBiolimits\-status\fR \fI \fR
.RS 4
Prints current configuration of global I/O limiting
.RE
.PP
\fBlist\-chunkservers\fR \fI \fR
.RS 4
Prints information about all connected chunkservers\&.
.RE
.PP
\fBlist\-disks\fR \fI \fR
.RS 4
Prints information about all connected chunkservers\&.
Possible command\-line options:
\-\-verbose
Be a little more verbose and show operations statistics\&.
.RE
.PP
\fBlist\-goals\fR \fI \fR
.RS 4
List goal definitions\&.
Possible command\-line options:
\-\-pretty
Print nice table
.RE
.PP
\fBlist\-mounts\fR \fI \fR
.RS 4
Prints information about all connected mounts\&.
Possible command\-line options
\-\-verbose
Be a little more verbose and show goal and trash time limits\&.
.RE
.PP
\fBmetadataserver\-status\fR \fI \fR
.RS 4
Prints status of a master or shadow master server
.RE
.PP
\fBlist\-metadataservers\fR \fI \fR
.RS 4
Prints status of active metadata servers\&.
.RE
.PP
\fBready\-chunkservers\-count\fR \fI \fR
.RS 4
Prints number of chunkservers ready to be written to\&.
.RE
.PP
\fBpromote\-shadow\fR \fI \fR
.RS 4
Promotes metadata server\&. Works only if personality
\fIha\-cluster\-managed\fR
is used\&. Authentication with the admin password is required\&.
.RE
.PP
\fBstop\-master\-without\-saving\-metadata\fR \fI \fR
.RS 4
Stop the master server without saving metadata in the metadata\&.mfs file\&. Used to quickly migrate a metadata server (works for all personalities)\&. Authentication with the admin password is required\&.
.RE
.PP
\fBreload\-config\fR \fI \fR
.RS 4
Requests reloading configuration from the config file\&. This is synchronous (waits for reload to finish)\&. Authentication with the admin password is required\&.
.RE
.PP
\fBsave\-metadata\fR \fI \fR
.RS 4
Requests saving the current state of metadata into the metadata\&.mfs file\&. With \-\-async fail if the process cannot be started, e\&.g\&. because the process is already in progress\&. Without \-\-async, fails if either the process cannot be started or if it finishes with an error (i\&.e\&., no metadata file is created)\&. Authentication with the admin password is required\&.
Possible command\-line options:
\-\-async
Don\(cqt wait for the task to finish\&.
.RE
.SH "COMMON COMMAND OPTIONS"
.PP
\fB\-\-porcelain\fR
.RS 4
Make the output parsing\-friendly\&.
.RE
.SH "COPYRIGHT"
.sp
2013\-2015 Skytechnology sp\&. z o\&.o\&.
.sp
LizardFS is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3\&.
.sp
LizardFS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
.sp
You should have received a copy of the GNU General Public License along with LizardFS\&. If not, see http://www\&.gnu\&.org/licenses/\&.