swift/doc/manpages/swift-account-audit.1
Tim Burke 79905ae794 Replace SOSO auth prefix in examples with more-standard AUTH
Change-Id: I98643d6acf248840a8360f31e446bc8ecb834898
2017-09-27 23:49:59 +00:00

64 lines
2.0 KiB
Groff

.\"
.\" Copyright (c) 2016 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
.\" You may obtain a copy of the License at
.\"
.\" http://www.apache.org/licenses/LICENSE-2.0
.\"
.\" Unless required by applicable law or agreed to in writing, software
.\" distributed under the License is distributed on an "AS IS" BASIS,
.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH SWIFT-ACCOUNT-AUDIT "1" "August 2016" "OpenStack Swift"
.SH NAME
swift\-account\-audit \- manually audit OpenStack Swift accounts
.SH SYNOPSIS
.PP
.B swift\-account\-audit\/
\fI[options]\fR \fI[url 1]\fR \fI[url 2]\fR \fI...\fR
.SH DESCRIPTION
.PP
The swift-account-audit cli tool can be used to audit the data for an account.
It crawls the account, checking that all containers and objects can be found.
You can also feed a list of URLs to the script through stdin.
.SH OPTIONS
.TP
\fB\-c\fR \fIconcurrency\fR
Set the concurrency, default 50
.TP
\fB\-r\fR \fIring dir\fR
Ring locations, default \fI/etc/swift\fR
.TP
\fB\-e\fR \fIfilename\fR
File for writing a list of inconsistent URLs
.TP
\fB\-d\fR
Also download files and verify md5
.SH EXAMPLES
.nf
/usr/bin/swift\-account\-audit\/ AUTH_88ad0b83\-b2c5\-4fa1\-b2d6\-60c597202076
/usr/bin/swift\-account\-audit\/ AUTH_88ad0b83\-b2c5\-4fa1\-b2d6\-60c597202076/container/object
/usr/bin/swift\-account\-audit\/ \fB\-e\fR errors.txt AUTH_88ad0b83\-b2c5\-4fa1\-b2d6\-60c597202076/container
/usr/bin/swift\-account\-audit\/ < errors.txt
/usr/bin/swift\-account\-audit\/ \fB\-c\fR 25 \fB\-d\fR < errors.txt
.fi
.SH DOCUMENTATION
.LP
More in depth documentation in regards to
.BI swift\-account\-audit
and also about OpenStack Swift as a whole can be found at
.BI https://docs.openstack.org/swift/latest/
and
.BI https://docs.openstack.org