---
name: "cdist-type__consul"
section: "7"
platform: "linux"
package: "cdist"
version: "7.0.0-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/cdist-type__consul"
---

# cdist-type\_\_consul(7)

Install consul

## NAME

cdist-type\_\_consul - Install consul

## DESCRIPTION

Downloads and installs the consul binary from *https://dl.bintray.com/mitchellh/consul*. Note that the consul binary is downloaded on the server (the machine running cdist) and then deployed to the target host using the \_\_file type unless --direct parameter is used.

## REQUIRED PARAMETERS

None.

## OPTIONAL PARAMETERS

- **state**

  either 'present' or 'absent'. Defaults to 'present'

- **version**

  which version of consul to install. See ./files/versions for a list of supported versions. Defaults to the latest known version.

## BOOLEAN PARAMETERS

- **direct**

  Download and deploy consul binary directly on the target machine.

## MESSAGES

If consul binary is created using \_\_staged\_file then underlaying \_\_file type messages are emitted.

If consul binary is created by direct method then the following messages are emitted:

- **/usr/local/bin/consul created**

  consul binary was created

## EXAMPLES

```
# just install using defaults
__consul
# install by downloading consul binary directly on the target machine
__consul --direct
# specific version
__consul \
   --version 0.4.1
```

## AUTHORS

```
Steven Armstrong <steven-cdist--@--armstrong.cc>
Darko Poljak <darko.poljak--@--gmail.com>
```

## COPYING

Copyright (C) 2015 Steven Armstrong. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

## COPYRIGHT

ungleich GmbH 2021