/usr/share/doc/cdist/html/man7/cdist-type__consul_agent.html is in cdist-doc 4.4.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>13.16. cdist-type__consul_agent(7) — cdist 4.4.1 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="cdist 4.4.1 documentation" href="../index.html"/>
<link rel="up" title="13. cdist types" href="../cdist-types.html"/>
<link rel="next" title="13.17. cdist-type__consul_check(7)" href="cdist-type__consul_check.html"/>
<link rel="prev" title="13.15. cdist-type__consul(7)" href="cdist-type__consul.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> cdist
</a>
<div class="version">
4.4.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../cdist-intro.html">1. cdist - usable configuration management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-why.html">2. Why should I use cdist?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-os.html">3. Supported Operating Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-install.html">4. How to install cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-update.html">5. How to update cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-support.html">6. Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-features.html">7. Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-quickstart.html">8. Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../man1/cdist.html">9. cdist(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-bootstrap.html">10. Bootstrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-manifest.html">11. Manifest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-type.html">12. cdist type</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../cdist-types.html">13. cdist types</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_key.html">13.1. cdist-type__apt_key(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_key_uri.html">13.2. cdist-type__apt_key_uri(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_mark.html">13.3. cdist-type__apt_mark(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_norecommends.html">13.4. cdist-type__apt_norecommends(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_ppa.html">13.5. cdist-type__apt_ppa(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_source.html">13.6. cdist-type__apt_source(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_update_index.html">13.7. cdist-type__apt_update_index(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__block.html">13.8. cdist-type__block(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ccollect_source.html">13.9. cdist-type__ccollect_source(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cdist.html">13.10. cdist-type__cdist(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cdistmarker.html">13.11. cdist-type__cdistmarker(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__chroot_mount.html">13.12. cdist-type__chroot_mount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__chroot_umount.html">13.13. cdist-type__chroot_umount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__config_file.html">13.14. cdist-type__config_file(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul.html">13.15. cdist-type__consul(7)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">13.16. cdist-type__consul_agent(7)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#name">13.16.1. NAME</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">13.16.2. DESCRIPTION</a></li>
<li class="toctree-l3"><a class="reference internal" href="#required-parameters">13.16.3. REQUIRED PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#optional-parameters">13.16.4. OPTIONAL PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#boolean-parameters">13.16.5. BOOLEAN PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#examples">13.16.6. EXAMPLES</a></li>
<li class="toctree-l3"><a class="reference internal" href="#see-also">13.16.7. SEE ALSO</a></li>
<li class="toctree-l3"><a class="reference internal" href="#authors">13.16.8. AUTHORS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#copying">13.16.9. COPYING</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_check.html">13.17. cdist-type__consul_check(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_reload.html">13.18. cdist-type__consul_reload(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_service.html">13.19. cdist-type__consul_service(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_template.html">13.20. cdist-type__consul_template(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_template_template.html">13.21. cdist-type__consul_template_template(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_checks.html">13.22. cdist-type__consul_watch_checks(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_event.html">13.23. cdist-type__consul_watch_event(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_key.html">13.24. cdist-type__consul_watch_key(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_keyprefix.html">13.25. cdist-type__consul_watch_keyprefix(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_nodes.html">13.26. cdist-type__consul_watch_nodes(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_service.html">13.27. cdist-type__consul_watch_service(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_services.html">13.28. cdist-type__consul_watch_services(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cron.html">13.29. cdist-type__cron(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__debconf_set_selections.html">13.30. cdist-type__debconf_set_selections(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__directory.html">13.31. cdist-type__directory(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker.html">13.32. cdist-type__docker(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_compose.html">13.33. cdist-type__docker_compose(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__dog_vdi.html">13.34. cdist-type__dog_vdi(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__file.html">13.35. cdist-type__file(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__filesystem.html">13.36. cdist-type__filesystem(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__firewalld_rule.html">13.37. cdist-type__firewalld_rule(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__firewalld_start.html">13.38. cdist-type__firewalld_start(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__git.html">13.39. cdist-type__git(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__group.html">13.40. cdist-type__group(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__hostname.html">13.41. cdist-type__hostname(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_bootloader_grub.html">13.42. cdist-type__install_bootloader_grub(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_chroot_mount.html">13.43. cdist-type__install_chroot_mount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_chroot_umount.html">13.44. cdist-type__install_chroot_umount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_config.html">13.45. cdist-type__install_config(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_file.html">13.46. cdist-type__install_file(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_fstab.html">13.47. cdist-type__install_fstab(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_generate_fstab.html">13.48. cdist-type__install_generate_fstab(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_mkfs.html">13.49. cdist-type__install_mkfs(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_mount.html">13.50. cdist-type__install_mount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_partition_msdos.html">13.51. cdist-type__install_partition_msdos(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_partition_msdos_apply.html">13.52. cdist-type__install_partition_msdos_apply(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_reboot.html">13.53. cdist-type__install_reboot(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_reset_disk.html">13.54. cdist-type__install_reset_disk(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_stage.html">13.55. cdist-type__install_stage(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_umount.html">13.56. cdist-type__install_umount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__iptables_apply.html">13.57. cdist-type__iptables_apply(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__iptables_rule.html">13.58. cdist-type__iptables_rule(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__issue.html">13.59. cdist-type__issue(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail.html">13.60. cdist-type__jail(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail_freebsd10.html">13.61. cdist-type__jail_freebsd10(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail_freebsd9.html">13.62. cdist-type__jail_freebsd9(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__key_value.html">13.63. cdist-type__key_value(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__keyboard.html">13.64. cdist-type__keyboard(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__line.html">13.65. cdist-type__line(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__link.html">13.66. cdist-type__link(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__locale.html">13.67. cdist-type__locale(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__locale_system.html">13.68. cdist-type__locale_system(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__motd.html">13.69. cdist-type__motd(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mount.html">13.70. cdist-type__mount(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mysql_database.html">13.71. cdist-type__mysql_database(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package.html">13.72. cdist-type__package(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_apt.html">13.73. cdist-type__package_apt(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_dpkg.html">13.74. cdist-type__package_dpkg(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_emerge.html">13.75. cdist-type__package_emerge(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_emerge_dependencies.html">13.76. cdist-type__package_emerge_dependencies(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_luarocks.html">13.77. cdist-type__package_luarocks(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_opkg.html">13.78. cdist-type__package_opkg(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pacman.html">13.79. cdist-type__package_pacman(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pip.html">13.80. cdist-type__package_pip(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkg_freebsd.html">13.81. cdist-type__package_pkg_freebsd(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkg_openbsd.html">13.82. cdist-type__package_pkg(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkgng_freebsd.html">13.83. cdist-type__package_pkgng_freebsd(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_rubygem.html">13.84. cdist-type__package_rubygem(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_update_index.html">13.85. cdist-type__package_update_index(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_upgrade_all.html">13.86. cdist-type__package_upgrade_all(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_yum.html">13.87. cdist-type__package_yum(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_zypper.html">13.88. cdist-type__package_zypper(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pacman_conf.html">13.89. cdist-type__pacman_conf(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pacman_conf_integrate.html">13.90. cdist-type__pacman_conf_integrate(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pf_apply.html">13.91. cdist-type__pf_apply(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pf_ruleset.html">13.92. cdist-type__pf_ruleset(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix.html">13.93. cdist-type__postfix(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_master.html">13.94. cdist-type__postfix_master(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_postconf.html">13.95. cdist-type__postfix_postconf(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_postmap.html">13.96. cdist-type__postfix_postmap(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_reload.html">13.97. cdist-type__postfix_reload(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_database.html">13.98. cdist-type__postgres_database(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_extension.html">13.99. cdist-type__postgres_extension(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_role.html">13.100. cdist-type__postgres_role(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__process.html">13.101. cdist-type__process(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pyvenv.html">13.102. cdist-type__pyvenv(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__qemu_img.html">13.103. cdist-type__qemu_img(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rbenv.html">13.104. cdist-type__rbenv(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rsync.html">13.105. cdist-type__rsync(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm.html">13.106. cdist-type__rvm(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_gem.html">13.107. cdist-type__rvm_gemset(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_gemset.html">13.108. cdist-type__rvm_gemset(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_ruby.html">13.109. cdist-type__rvm_ruby(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_authorized_key.html">13.110. cdist-type__ssh_authorized_key(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_authorized_keys.html">13.111. cdist-type__ssh_authorized_keys(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_dot_ssh.html">13.112. cdist-type__ssh_dot_ssh(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__staged_file.html">13.113. cdist-type__staged_file(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__start_on_boot.html">13.114. cdist-type__start_on_boot(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__sysctl.html">13.115. cdist-type__sysctl(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__timezone.html">13.116. cdist-type__timezone(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__update_alternatives.html">13.117. cdist-type__update_alternatives(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__user.html">13.118. cdist-type__user(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__user_groups.html">13.119. cdist-type__user_groups(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__yum_repo.html">13.120. cdist-type__yum_repo(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__zypper_repo.html">13.121. cdist-type__zypper_repo(7)</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__zypper_service.html">13.122. cdist-type__zypper_service(7)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-explorer.html">14. Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-messaging.html">15. Messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-parallelization.html">16. Parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-reference.html">17. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-best-practice.html">18. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-stages.html">19. Execution stages</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-remote-exec-copy.html">20. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-hacker.html">21. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-troubleshooting.html">22. Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">cdist</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="../cdist-types.html">13. cdist types</a> »</li>
<li>13.16. cdist-type__consul_agent(7)</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/man7/cdist-type__consul_agent.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-agent-7">
<h1>13.16. cdist-type__consul_agent(7)<a class="headerlink" href="#cdist-type-consul-agent-7" title="Permalink to this headline">¶</a></h1>
<div class="section" id="name">
<h2>13.16.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
<p>cdist-type__consul_agent - Manage the consul agent</p>
</div>
<div class="section" id="description">
<h2>13.16.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>Configure and manage the consul agent.</p>
</div>
<div class="section" id="required-parameters">
<h2>13.16.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>13.16.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>acl-datacenter</dt>
<dd>only used by servers. This designates the datacenter which is authoritative
for ACL information.</dd>
<dt>acl-default-policy</dt>
<dd>either "allow" or "deny"; defaults to "allow". The default policy controls the
behavior of a token when there is no matching rule.</dd>
<dt>acl-down-policy</dt>
<dd>either "allow", "deny" or "extend-cache"; "extend-cache" is the default.</dd>
<dt>acl-master-token</dt>
<dd>only used for servers in the acl_datacenter. This token will be created with
management-level permissions if it does not exist. It allows operators to
bootstrap the ACL system with a token ID that is well-known.</dd>
<dt>acl-token</dt>
<dd>when provided, the agent will use this token when making requests to the
Consul servers.</dd>
<dt>acl-ttl</dt>
<dd>used to control Time-To-Live caching of ACLs.</dd>
<dt>bind-addr</dt>
<dd>sets the bind address for cluster communication</dd>
<dt>bootstrap-expect</dt>
<dd>sets server to expect bootstrap mode</dd>
<dt>ca-file-source</dt>
<dd>path to a PEM encoded certificate authority file which will be uploaded and
configure using the ca_file config option.</dd>
<dt>cert-file-source</dt>
<dd>path to a PEM encoded certificate file which will be uploaded and
configure using the cert_file config option.</dd>
<dt>client-addr</dt>
<dd>sets the address to bind for client access</dd>
<dt>datacenter</dt>
<dd>datacenter of the agent</dd>
<dt>encrypt</dt>
<dd>provides the gossip encryption key</dd>
<dt>group</dt>
<dd>the primary group for the agent</dd>
<dt>json-config</dt>
<dd>path to a partial json config file without leading { and trailing }.
If json-config is '-' (dash), take what was written to stdin as the file content.</dd>
<dt>key-file-source</dt>
<dd>path to a PEM encoded private key file which will be uploaded and
configure using the key_file config option.</dd>
<dt>node-name</dt>
<dd>name of this node. Must be unique in the cluster</dd>
<dt>retry-join</dt>
<dd>address to attempt joining every retry_interval until at least one join works.
Can be specified multiple times.</dd>
<dt>user</dt>
<dd>the user to run the agent as</dd>
<dt>state</dt>
<dd>if the agent is 'present' or 'absent'. Defaults to 'present'.
Currently state=absent is not working due to some dependency issues.</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>13.16.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>disable-remote-exec</dt>
<dd>disables support for remote execution. When set to true, the agent will ignore any incoming remote exec requests.</dd>
<dt>disable-update-check</dt>
<dd>disables automatic checking for security bulletins and new version releases</dd>
<dt>leave-on-terminate</dt>
<dd>gracefully leave cluster on SIGTERM</dd>
<dt>rejoin-after-leave</dt>
<dd>rejoin the cluster using the previous state after leaving</dd>
<dt>server</dt>
<dd>used to control if an agent is in server or client mode</dd>
<dt>enable-syslog</dt>
<dd>enables logging to syslog</dd>
<dt>verify-incoming</dt>
<dd>enforce the use of TLS and verify a client's authenticity on incoming connections</dd>
<dt>verify-outgoing</dt>
<dd>enforce the use of TLS and verify the peers authenticity on outgoing connections</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>13.16.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># configure as server, bootstrap and rejoin</span>
<span class="nv">hostname</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__global</span><span class="s2">/explorer/hostname"</span><span class="k">)</span><span class="s2">"</span>
__consul_agent <span class="se">\</span>
--datacenter dc1 <span class="se">\</span>
--node-name <span class="s2">"</span><span class="si">${</span><span class="nv">hostname</span><span class="p">%%.*</span><span class="si">}</span><span class="s2">"</span> <span class="se">\</span>
--disable-update-check <span class="se">\</span>
--server <span class="se">\</span>
--rejoin-after-leave <span class="se">\</span>
--bootstrap-expect <span class="m">3</span> <span class="se">\</span>
--retry-join consul-01 <span class="se">\</span>
--retry-join consul-02 <span class="se">\</span>
--retry-join consul-03
<span class="c1"># configure as server, bootstrap and rejoin with ssl support</span>
<span class="nv">hostname</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__global</span><span class="s2">/explorer/hostname"</span><span class="k">)</span><span class="s2">"</span>
__consul_agent <span class="se">\</span>
--datacenter dc1 <span class="se">\</span>
--node-name <span class="s2">"</span><span class="si">${</span><span class="nv">hostname</span><span class="p">%%.*</span><span class="si">}</span><span class="s2">"</span> <span class="se">\</span>
--disable-update-check <span class="se">\</span>
--server <span class="se">\</span>
--rejoin-after-leave <span class="se">\</span>
--bootstrap-expect <span class="m">3</span> <span class="se">\</span>
--retry-join consul-01 <span class="se">\</span>
--retry-join consul-02 <span class="se">\</span>
--retry-join consul-03 <span class="se">\</span>
--ca-file-source /path/to/ca.pem <span class="se">\</span>
--cert-file-source /path/to/cert.pem <span class="se">\</span>
--key-file-source /path/to/key.pem <span class="se">\</span>
--verify-incoming <span class="se">\</span>
--verify-outgoing
<span class="c1"># configure as client and try joining existing cluster</span>
__consul_agent <span class="se">\</span>
--datacenter dc1 <span class="se">\</span>
--node-name <span class="s2">"</span><span class="si">${</span><span class="nv">hostname</span><span class="p">%%.*</span><span class="si">}</span><span class="s2">"</span> <span class="se">\</span>
--disable-update-check <span class="se">\</span>
--retry-join consul-01 <span class="se">\</span>
--retry-join consul-02 <span class="se">\</span>
--retry-join consul-03
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>13.16.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p>consul documentation at: <<a class="reference external" href="http://www.consul.io/docs/agent/options.html">http://www.consul.io/docs/agent/options.html</a>>.</p>
</div>
<div class="section" id="authors">
<h2>13.16.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
<p>Steven Armstrong <<a class="reference external" href="mailto:steven-cdist--%40--armstrong.cc">steven-cdist--<span>@</span>--armstrong<span>.</span>cc</a>></p>
</div>
<div class="section" id="copying">
<h2>13.16.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cdist-type__consul_check.html" class="btn btn-neutral float-right" title="13.17. cdist-type__consul_check(7)" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="cdist-type__consul.html" class="btn btn-neutral" title="13.15. cdist-type__consul(7)" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'4.4.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|