---
name: "cdist-type__consul_service"
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_service"
---

# cdist-type\_\_consul\_service(7)

Manages consul services

## NAME

cdist-type\_\_consul\_service - Manages consul services

## DESCRIPTION

Generate and deploy service definitions for a consul agent. See *http://www.consul.io/docs/agent/services.html* for parameter documentation.

Use either script together with interval, or use ttl.

## REQUIRED PARAMETERS

None.

## OPTIONAL PARAMETERS

- **check-interval**

  the interval in which the script given with --check-script should be run

- **check-http**

  the URL to check for HTTP 200-ish status every --check-interval

- **check-script**

  the shell command to run every --check-interval

- **check-ttl**

  how long a service is considered healthy without being updated through the HTTP interfave

- **id**

  Defaults to --name

- **name**

  The name of this service. Defaults to \_\_object\_id

- **port**

  the port at which this service can be reached

- **state**

  if this service is 'present' or 'absent'. Defaults to 'present'.

- **tag**

  a tag to add to this service. Can be specified multiple times.

## EXAMPLES

```
__consul_service redis \
   --tag master \
   --tag production \
   --port 8000 \
   --check-script /usr/local/bin/check_redis.py \
   --check-interval 10s
__consul_service webapp \
   --port 80 \
   --check-ttl 10s
```

## SEE ALSO

[**cdist-type\_\_consul\_agent**(7)](/cdist-type__consul_agent/7.md)

## AUTHORS

Steven Armstrong \<*steven-cdist--@--armstrong.cc*\>

## 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