Resource Type: consul_prepared_query

Defined in:

lib/puppet/type/consul_prepared_query.rb

Overview

Manage a consul prepared query.

Properties

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• id

  ID of prepared query

Parameters

• acl_api_token (defaults to: anonymous)

  Token for accessing the ACL API

• api_tries (defaults to: 3)

  number of tries when contacting the Consul REST API

• ca_file

  Absolute path to a PEM CA bundle used to verify the Consul HTTPS server.

• ca_path

  Absolute path to an OpenSSL hashed CA directory used to verify the Consul HTTPS server.

• client_cert

  Absolute path to a PEM client certificate, optionally followed by intermediate certificates, for mutual TLS.

• client_key

  Absolute path to the unencrypted PEM private key for client_cert.

• hostname (defaults to: localhost)

  consul hostname

• name (namevar)

  Name of the prepared query

• node_meta

  List of user-defined key/value pairs to filter on NodeMeta

• port (defaults to: 8500)

  consul port

• protocol (defaults to: http)

  consul protocol

  Supported values:

  • http
  • https
• service_failover_dcs (defaults to: [])

  List of datacenters to forward queries to if no health services found locally

• service_failover_n (defaults to: 0)

  Failover to the nearest <n> datacenters

• service_meta

  List of user-defined key/value pairs to filter on ServiceMeta

• service_name

  Service name for the prepared query

• service_near (defaults to: '')

  Resurn results in ascending order of estimated RTT from given node name, or _agent special value

• service_only_passing (defaults to: false)

  Only return services in the passing state

• service_tags (defaults to: [])

  List of tags to filter the query with

• template (defaults to: false)

  is template?

  Supported values:

  • true
  • false
  • yes
  • no
• template_regexp (defaults to: '')

  regexp for template

• template_type (defaults to: name_prefix_match)

  type for template

• token (defaults to: '')

  The prepared query token

• ttl (defaults to: 0)

  TTL for the DNS lookup