---
name: "dispersion.conf"
section: "5"
platform: "linux"
package: "swift"
version: "2.35.1-0+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/dispersion.conf"
---

# dispersion.conf(5)

configuration file for the OpenStack Swift dispersion tools

## NAME

**dispersion.conf** - configuration file for the OpenStack Swift dispersion tools

## SYNOPSIS

**dispersion.conf**

## DESCRIPTION

This is the configuration file used by the dispersion populate and report tools. The file format consists of the '\[dispersion\]' module as the header and available parameters. Any line that begins with a '#' symbol is ignored.

## PARAMETERS

- **auth\_version**

  Authentication system API version. The default is 1.0.

- **auth\_url**

  Authentication system URL

- **auth\_user**

  Authentication system account/user name

- **auth\_key**

  Authentication system account/user password

- **project\_name**

  Project name in case of keystone auth version 3

- **project\_domain\_name**

  Project domain name in case of keystone auth version 3

- **user\_domain\_name**

  User domain name in case of keystone auth version 3

- **endpoint\_type**

  The default is 'publicURL'.

- **keystone\_api\_insecure**

  The default is false.

- **swift\_dir**

  Location of OpenStack Swift configuration and ring files

- **dispersion\_coverage**

  Percentage of partition coverage to use. The default is 1.0.

- **retries**

  Maximum number of attempts. The defaul is 5.

- **concurrency**

  Concurrency to use. The default is 25.

- **container\_populate**

  The default is true.

- **object\_populate**

  The default is true.

- **dump\_json**

  Whether to output in json format. The default is no.

- **container\_report**

  Whether to run the container report. The default is yes.

- **object\_report**

  Whether to run the object report. The default is yes.

## SAMPLE

- \[dispersion\]

  - auth\_url = https://127.0.0.1:443/auth/v1.0

  - auth\_user = dpstats:dpstats

  - auth\_key = dpstats

  - swift\_dir = /etc/swift

  - \# keystone\_api\_insecure = no

  - \# project\_name = dpstats

  - \# project\_domain\_name = default

  - \# user\_domain\_name = default

  - \# dispersion\_coverage = 1.0

  - \# retries = 5

  - \# concurrency = 25

  - \# dump\_json = no

  - \# container\_report = yes

  - \# object\_report = yes

  ## DOCUMENTATION

More in depth documentation about the swift-dispersion utilities and also OpenStack Swift as a whole can be found at **https://docs.openstack.org/swift/latest/admin\_guide.html#dispersion-report** and **https://docs.openstack.org/swift/latest/**

## SEE ALSO

**[swift-dispersion-report(1)](/swift-dispersion-report/1.md),** **[swift-dispersion-populate(1)](/swift-dispersion-populate/1.md)**