From 1da8f6099446fe15b6fa59b06045ad96e83d9e52 Mon Sep 17 00:00:00 2001 From: Jeffrey Clark Date: Mon, 29 Jan 2024 14:00:07 -0600 Subject: [PATCH] generate reference documentation --- REFERENCE.md | 3538 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 3538 insertions(+) create mode 100644 REFERENCE.md diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 00000000..78149e3f --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,3538 @@ +# Reference + + + +## Table of Contents + +### Classes + +* [`puppetdb`](#puppetdb): All in one class for setting up a PuppetDB instance. See README.md for more details. +* [`puppetdb::database::postgresql`](#puppetdb--database--postgresql): Class for creating the PuppetDB postgresql database. See README.md for more information. +* [`puppetdb::database::ssl_configuration`](#puppetdb--database--ssl_configuration): Class for configuring SSL connection for the PuppetDB postgresql database. See README.md for more information. +* [`puppetdb::globals`](#puppetdb--globals): Global configuration class for PuppetDB. See README.md for more details. +* [`puppetdb::master::config`](#puppetdb--master--config): Manage puppet configuration. See README.md for more details. +* [`puppetdb::master::puppetdb_conf`](#puppetdb--master--puppetdb_conf): Manage the puppetdb.conf file on the puppeet master. See README.md for more details. +* [`puppetdb::master::report_processor`](#puppetdb--master--report_processor): Manage the installation of the report processor on the master. See README.md for more details. +* [`puppetdb::master::routes`](#puppetdb--master--routes): Manages the routes configuration file on the master. See README.md for more details. +* [`puppetdb::master::storeconfigs`](#puppetdb--master--storeconfigs): This class configures the puppet master to enable storeconfigs and to use puppetdb as the storeconfigs backend. See README.md for more detail +* [`puppetdb::params`](#puppetdb--params): PRIVATE CLASS - do not use directly The puppetdb default configuration settings. +* [`puppetdb::server`](#puppetdb--server): Class to configure a PuppetDB server. See README.md for more details. +* [`puppetdb::server::command_processing`](#puppetdb--server--command_processing): PRIVATE CLASS - do not use directly +* [`puppetdb::server::database`](#puppetdb--server--database): PRIVATE CLASS - do not use directly +* [`puppetdb::server::firewall`](#puppetdb--server--firewall): PRIVATE CLASS - do not use directly +* [`puppetdb::server::global`](#puppetdb--server--global): PRIVATE CLASS - do not use directly +* [`puppetdb::server::jetty`](#puppetdb--server--jetty): PRIVATE CLASS - do not use directly +* [`puppetdb::server::puppetdb`](#puppetdb--server--puppetdb): PRIVATE CLASS - do not use directly +* [`puppetdb::server::read_database`](#puppetdb--server--read_database): PRIVATE CLASS - do not use directly +* [`puppetdb::server::validate_db`](#puppetdb--server--validate_db): This validates a database connection. See README.md for more details. +* [`puppetdb::server::validate_read_db`](#puppetdb--server--validate_read_db): This validates a database connection. See README.md for more details. + +### Defined types + +* [`puppetdb::database::default_read_grant`](#puppetdb--database--default_read_grant): Private class. Grant read permissions to $database_read_only_username by default, for new tables created by $database_username. +* [`puppetdb::database::postgresql_ssl_rules`](#puppetdb--database--postgresql_ssl_rules): Private class for configuring the pg_ident.conf and pg_hba.conf files +* [`puppetdb::database::read_grant`](#puppetdb--database--read_grant): Private class. Grant read-only permissions to $database_read_only_username for all objects in $schema of $database_name +* [`puppetdb::database::read_only_user`](#puppetdb--database--read_only_user) + +### Resource types + +* [`puppetdb_conn_validator`](#puppetdb_conn_validator): Verify that a connection can be successfully established between a node and the puppetdb server. Its primary use is as a precondition to pre + +### Functions + +* [`puppetdb::create_subsetting_resource_hash`](#puppetdb--create_subsetting_resource_hash) +* [`puppetdb::flatten_java_args`](#puppetdb--flatten_java_args) + +### Data types + +* [`Puppetdb::Ttl`](#Puppetdb--Ttl) + +### Tasks + +* [`lxd_exp`](#lxd_exp): Provision/Tear down a machine on LXD + +## Classes + +### `puppetdb` + +All in one class for setting up a PuppetDB instance. See README.md for more +details. + +#### Parameters + +The following parameters are available in the `puppetdb` class: + +* [`listen_address`](#-puppetdb--listen_address) +* [`listen_port`](#-puppetdb--listen_port) +* [`disable_cleartext`](#-puppetdb--disable_cleartext) +* [`open_listen_port`](#-puppetdb--open_listen_port) +* [`ssl_listen_address`](#-puppetdb--ssl_listen_address) +* [`ssl_listen_port`](#-puppetdb--ssl_listen_port) +* [`disable_ssl`](#-puppetdb--disable_ssl) +* [`open_ssl_listen_port`](#-puppetdb--open_ssl_listen_port) +* [`ssl_dir`](#-puppetdb--ssl_dir) +* [`ssl_set_cert_paths`](#-puppetdb--ssl_set_cert_paths) +* [`ssl_cert_path`](#-puppetdb--ssl_cert_path) +* [`ssl_key_path`](#-puppetdb--ssl_key_path) +* [`ssl_key_pk8_path`](#-puppetdb--ssl_key_pk8_path) +* [`ssl_ca_cert_path`](#-puppetdb--ssl_ca_cert_path) +* [`ssl_deploy_certs`](#-puppetdb--ssl_deploy_certs) +* [`ssl_key`](#-puppetdb--ssl_key) +* [`ssl_cert`](#-puppetdb--ssl_cert) +* [`ssl_ca_cert`](#-puppetdb--ssl_ca_cert) +* [`ssl_protocols`](#-puppetdb--ssl_protocols) +* [`postgresql_ssl_on`](#-puppetdb--postgresql_ssl_on) +* [`postgresql_ssl_folder`](#-puppetdb--postgresql_ssl_folder) +* [`postgresql_ssl_cert_path`](#-puppetdb--postgresql_ssl_cert_path) +* [`postgresql_ssl_key_path`](#-puppetdb--postgresql_ssl_key_path) +* [`postgresql_ssl_ca_cert_path`](#-puppetdb--postgresql_ssl_ca_cert_path) +* [`cipher_suites`](#-puppetdb--cipher_suites) +* [`migrate`](#-puppetdb--migrate) +* [`manage_dbserver`](#-puppetdb--manage_dbserver) +* [`manage_database`](#-puppetdb--manage_database) +* [`manage_package_repo`](#-puppetdb--manage_package_repo) +* [`postgres_version`](#-puppetdb--postgres_version) +* [`database`](#-puppetdb--database) +* [`database_host`](#-puppetdb--database_host) +* [`database_port`](#-puppetdb--database_port) +* [`database_username`](#-puppetdb--database_username) +* [`database_password`](#-puppetdb--database_password) +* [`database_name`](#-puppetdb--database_name) +* [`manage_db_password`](#-puppetdb--manage_db_password) +* [`jdbc_ssl_properties`](#-puppetdb--jdbc_ssl_properties) +* [`database_listen_address`](#-puppetdb--database_listen_address) +* [`database_validate`](#-puppetdb--database_validate) +* [`database_embedded_path`](#-puppetdb--database_embedded_path) +* [`node_ttl`](#-puppetdb--node_ttl) +* [`node_purge_ttl`](#-puppetdb--node_purge_ttl) +* [`report_ttl`](#-puppetdb--report_ttl) +* [`facts_blacklist`](#-puppetdb--facts_blacklist) +* [`gc_interval`](#-puppetdb--gc_interval) +* [`node_purge_gc_batch_limit`](#-puppetdb--node_purge_gc_batch_limit) +* [`log_slow_statements`](#-puppetdb--log_slow_statements) +* [`conn_max_age`](#-puppetdb--conn_max_age) +* [`conn_keep_alive`](#-puppetdb--conn_keep_alive) +* [`conn_lifetime`](#-puppetdb--conn_lifetime) +* [`puppetdb_package`](#-puppetdb--puppetdb_package) +* [`puppetdb_service`](#-puppetdb--puppetdb_service) +* [`puppetdb_service_status`](#-puppetdb--puppetdb_service_status) +* [`puppetdb_user`](#-puppetdb--puppetdb_user) +* [`puppetdb_group`](#-puppetdb--puppetdb_group) +* [`puppetdb_server`](#-puppetdb--puppetdb_server) +* [`read_database`](#-puppetdb--read_database) +* [`read_database_host`](#-puppetdb--read_database_host) +* [`read_database_port`](#-puppetdb--read_database_port) +* [`read_database_username`](#-puppetdb--read_database_username) +* [`read_database_password`](#-puppetdb--read_database_password) +* [`read_database_name`](#-puppetdb--read_database_name) +* [`manage_read_db_password`](#-puppetdb--manage_read_db_password) +* [`read_database_jdbc_ssl_properties`](#-puppetdb--read_database_jdbc_ssl_properties) +* [`read_database_validate`](#-puppetdb--read_database_validate) +* [`read_log_slow_statements`](#-puppetdb--read_log_slow_statements) +* [`read_conn_max_age`](#-puppetdb--read_conn_max_age) +* [`read_conn_keep_alive`](#-puppetdb--read_conn_keep_alive) +* [`read_conn_lifetime`](#-puppetdb--read_conn_lifetime) +* [`confdir`](#-puppetdb--confdir) +* [`vardir`](#-puppetdb--vardir) +* [`manage_firewall`](#-puppetdb--manage_firewall) +* [`java_args`](#-puppetdb--java_args) +* [`merge_default_java_args`](#-puppetdb--merge_default_java_args) +* [`max_threads`](#-puppetdb--max_threads) +* [`command_threads`](#-puppetdb--command_threads) +* [`concurrent_writes`](#-puppetdb--concurrent_writes) +* [`store_usage`](#-puppetdb--store_usage) +* [`temp_usage`](#-puppetdb--temp_usage) +* [`disable_update_checking`](#-puppetdb--disable_update_checking) +* [`certificate_whitelist_file`](#-puppetdb--certificate_whitelist_file) +* [`certificate_whitelist`](#-puppetdb--certificate_whitelist) +* [`database_max_pool_size`](#-puppetdb--database_max_pool_size) +* [`read_database_max_pool_size`](#-puppetdb--read_database_max_pool_size) +* [`automatic_dlo_cleanup`](#-puppetdb--automatic_dlo_cleanup) +* [`cleanup_timer_interval`](#-puppetdb--cleanup_timer_interval) +* [`dlo_max_age`](#-puppetdb--dlo_max_age) +* [`java_bin`](#-puppetdb--java_bin) + +##### `listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_address` + +##### `listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_port` + +##### `disable_cleartext` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_cleartext` + +##### `open_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::open_listen_port` + +##### `ssl_listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_address` + +##### `ssl_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_port` + +##### `disable_ssl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_ssl` + +##### `open_ssl_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::open_ssl_listen_port` + +##### `ssl_dir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_dir` + +##### `ssl_set_cert_paths` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_set_cert_paths` + +##### `ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_cert_path` + +##### `ssl_key_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key_path` + +##### `ssl_key_pk8_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key_pk8_path` + +##### `ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_ca_cert_path` + +##### `ssl_deploy_certs` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_deploy_certs` + +##### `ssl_key` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key` + +##### `ssl_cert` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_cert` + +##### `ssl_ca_cert` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_ca_cert` + +##### `ssl_protocols` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_protocols` + +##### `postgresql_ssl_on` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_on` + +##### `postgresql_ssl_folder` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_folder` + +##### `postgresql_ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_cert_path` + +##### `postgresql_ssl_key_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_key_path` + +##### `postgresql_ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_ca_cert_path` + +##### `cipher_suites` + +Data type: `Any` + + + +Default value: `$puppetdb::params::cipher_suites` + +##### `migrate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::migrate` + +##### `manage_dbserver` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_dbserver` + +##### `manage_database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_database` + +##### `manage_package_repo` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_pg_repo` + +##### `postgres_version` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgres_version` + +##### `database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database` + +##### `database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_host` + +##### `database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_port` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_password` + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `manage_db_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_db_password` + +##### `jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::jdbc_ssl_properties` + +##### `database_listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgres_listen_addresses` + +##### `database_validate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_validate` + +##### `database_embedded_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_embedded_path` + +##### `node_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_ttl` + +##### `node_purge_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_purge_ttl` + +##### `report_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::report_ttl` + +##### `facts_blacklist` + +Data type: `Optional[Array]` + + + +Default value: `$puppetdb::params::facts_blacklist` + +##### `gc_interval` + +Data type: `Any` + + + +Default value: `$puppetdb::params::gc_interval` + +##### `node_purge_gc_batch_limit` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_purge_gc_batch_limit` + +##### `log_slow_statements` + +Data type: `Any` + + + +Default value: `$puppetdb::params::log_slow_statements` + +##### `conn_max_age` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_max_age` + +##### `conn_keep_alive` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_keep_alive` + +##### `conn_lifetime` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_lifetime` + +##### `puppetdb_package` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_package` + +##### `puppetdb_service` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_service` + +##### `puppetdb_service_status` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_service_status` + +##### `puppetdb_user` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_user` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +##### `puppetdb_server` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_server` + +##### `read_database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database` + +##### `read_database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_host` + +##### `read_database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_port` + +##### `read_database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_username` + +##### `read_database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_password` + +##### `read_database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_name` + +##### `manage_read_db_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_read_db_password` + +##### `read_database_jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_jdbc_ssl_properties` + +##### `read_database_validate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_validate` + +##### `read_log_slow_statements` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_log_slow_statements` + +##### `read_conn_max_age` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_max_age` + +##### `read_conn_keep_alive` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_keep_alive` + +##### `read_conn_lifetime` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_lifetime` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `vardir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::vardir` + +##### `manage_firewall` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_firewall` + +##### `java_args` + +Data type: `Any` + + + +Default value: `$puppetdb::params::java_args` + +##### `merge_default_java_args` + +Data type: `Any` + + + +Default value: `$puppetdb::params::merge_default_java_args` + +##### `max_threads` + +Data type: `Any` + + + +Default value: `$puppetdb::params::max_threads` + +##### `command_threads` + +Data type: `Any` + + + +Default value: `$puppetdb::params::command_threads` + +##### `concurrent_writes` + +Data type: `Any` + + + +Default value: `$puppetdb::params::concurrent_writes` + +##### `store_usage` + +Data type: `Any` + + + +Default value: `$puppetdb::params::store_usage` + +##### `temp_usage` + +Data type: `Any` + + + +Default value: `$puppetdb::params::temp_usage` + +##### `disable_update_checking` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_update_checking` + +##### `certificate_whitelist_file` + +Data type: `Any` + + + +Default value: `$puppetdb::params::certificate_whitelist_file` + +##### `certificate_whitelist` + +Data type: `Any` + + + +Default value: `$puppetdb::params::certificate_whitelist` + +##### `database_max_pool_size` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_max_pool_size` + +##### `read_database_max_pool_size` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_max_pool_size` + +##### `automatic_dlo_cleanup` + +Data type: `Boolean` + + + +Default value: `$puppetdb::params::automatic_dlo_cleanup` + +##### `cleanup_timer_interval` + +Data type: `String[1]` + + + +Default value: `$puppetdb::params::cleanup_timer_interval` + +##### `dlo_max_age` + +Data type: `Integer[1]` + + + +Default value: `$puppetdb::params::dlo_max_age` + +##### `java_bin` + +Data type: `Optional[Stdlib::Absolutepath]` + + + +Default value: `$puppetdb::params::java_bin` + +### `puppetdb::database::postgresql` + +Class for creating the PuppetDB postgresql database. See README.md for more +information. + +#### Parameters + +The following parameters are available in the `puppetdb::database::postgresql` class: + +* [`listen_addresses`](#-puppetdb--database--postgresql--listen_addresses) +* [`puppetdb_server`](#-puppetdb--database--postgresql--puppetdb_server) +* [`database_name`](#-puppetdb--database--postgresql--database_name) +* [`database_username`](#-puppetdb--database--postgresql--database_username) +* [`database_password`](#-puppetdb--database--postgresql--database_password) +* [`database_port`](#-puppetdb--database--postgresql--database_port) +* [`manage_database`](#-puppetdb--database--postgresql--manage_database) +* [`manage_server`](#-puppetdb--database--postgresql--manage_server) +* [`manage_package_repo`](#-puppetdb--database--postgresql--manage_package_repo) +* [`postgres_version`](#-puppetdb--database--postgresql--postgres_version) +* [`postgresql_ssl_on`](#-puppetdb--database--postgresql--postgresql_ssl_on) +* [`postgresql_ssl_key_path`](#-puppetdb--database--postgresql--postgresql_ssl_key_path) +* [`postgresql_ssl_cert_path`](#-puppetdb--database--postgresql--postgresql_ssl_cert_path) +* [`postgresql_ssl_ca_cert_path`](#-puppetdb--database--postgresql--postgresql_ssl_ca_cert_path) +* [`read_database_username`](#-puppetdb--database--postgresql--read_database_username) +* [`read_database_password`](#-puppetdb--database--postgresql--read_database_password) +* [`read_database_host`](#-puppetdb--database--postgresql--read_database_host) + +##### `listen_addresses` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_host` + +##### `puppetdb_server` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_server` + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_password` + +##### `database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_port` + +##### `manage_database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_database` + +##### `manage_server` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_dbserver` + +##### `manage_package_repo` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_pg_repo` + +##### `postgres_version` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgres_version` + +##### `postgresql_ssl_on` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_on` + +##### `postgresql_ssl_key_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_key_path` + +##### `postgresql_ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_cert_path` + +##### `postgresql_ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_ca_cert_path` + +##### `read_database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_username` + +##### `read_database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_password` + +##### `read_database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_host` + +### `puppetdb::database::ssl_configuration` + +Class for configuring SSL connection for the PuppetDB postgresql database. See README.md for more +information. + +#### Parameters + +The following parameters are available in the `puppetdb::database::ssl_configuration` class: + +* [`database_name`](#-puppetdb--database--ssl_configuration--database_name) +* [`database_username`](#-puppetdb--database--ssl_configuration--database_username) +* [`read_database_username`](#-puppetdb--database--ssl_configuration--read_database_username) +* [`read_database_host`](#-puppetdb--database--ssl_configuration--read_database_host) +* [`puppetdb_server`](#-puppetdb--database--ssl_configuration--puppetdb_server) +* [`postgresql_ssl_key_path`](#-puppetdb--database--ssl_configuration--postgresql_ssl_key_path) +* [`postgresql_ssl_cert_path`](#-puppetdb--database--ssl_configuration--postgresql_ssl_cert_path) +* [`postgresql_ssl_ca_cert_path`](#-puppetdb--database--ssl_configuration--postgresql_ssl_ca_cert_path) +* [`create_read_user_rule`](#-puppetdb--database--ssl_configuration--create_read_user_rule) + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `read_database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_username` + +##### `read_database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_host` + +##### `puppetdb_server` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_server` + +##### `postgresql_ssl_key_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_key_path` + +##### `postgresql_ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_cert_path` + +##### `postgresql_ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_ca_cert_path` + +##### `create_read_user_rule` + +Data type: `Any` + + + +Default value: `false` + +### `puppetdb::globals` + +Global configuration class for PuppetDB. See README.md for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::globals` class: + +* [`version`](#-puppetdb--globals--version) +* [`database`](#-puppetdb--globals--database) +* [`puppet_confdir`](#-puppetdb--globals--puppet_confdir) + +##### `version` + +Data type: `Any` + + + +Default value: `'present'` + +##### `database` + +Data type: `Any` + + + +Default value: `'postgres'` + +##### `puppet_confdir` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$settings::confdir` + +### `puppetdb::master::config` + +Manage puppet configuration. See README.md for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::master::config` class: + +* [`puppetdb_server`](#-puppetdb--master--config--puppetdb_server) +* [`puppetdb_port`](#-puppetdb--master--config--puppetdb_port) +* [`puppetdb_disable_ssl`](#-puppetdb--master--config--puppetdb_disable_ssl) +* [`masterless`](#-puppetdb--master--config--masterless) +* [`puppetdb_soft_write_failure`](#-puppetdb--master--config--puppetdb_soft_write_failure) +* [`manage_routes`](#-puppetdb--master--config--manage_routes) +* [`manage_storeconfigs`](#-puppetdb--master--config--manage_storeconfigs) +* [`enable_storeconfigs`](#-puppetdb--master--config--enable_storeconfigs) +* [`manage_report_processor`](#-puppetdb--master--config--manage_report_processor) +* [`manage_config`](#-puppetdb--master--config--manage_config) +* [`create_puppet_service_resource`](#-puppetdb--master--config--create_puppet_service_resource) +* [`strict_validation`](#-puppetdb--master--config--strict_validation) +* [`enable_reports`](#-puppetdb--master--config--enable_reports) +* [`puppet_confdir`](#-puppetdb--master--config--puppet_confdir) +* [`puppet_conf`](#-puppetdb--master--config--puppet_conf) +* [`terminus_package`](#-puppetdb--master--config--terminus_package) +* [`puppet_service_name`](#-puppetdb--master--config--puppet_service_name) +* [`puppetdb_startup_timeout`](#-puppetdb--master--config--puppetdb_startup_timeout) +* [`test_url`](#-puppetdb--master--config--test_url) +* [`restart_puppet`](#-puppetdb--master--config--restart_puppet) + +##### `puppetdb_server` + +Data type: `Any` + + + +Default value: `fact('networking.fqdn')` + +##### `puppetdb_port` + +Data type: `Any` + + + +Default value: + +```puppet +defined(Class['puppetdb']) ? { + true => $puppetdb::disable_ssl ? { + true => 8080, + default => 8081, + }, + default => 8081 +``` + +##### `puppetdb_disable_ssl` + +Data type: `Any` + + + +Default value: + +```puppet +defined(Class['puppetdb']) ? { + true => $puppetdb::disable_ssl, + default => false +``` + +##### `masterless` + +Data type: `Any` + + + +Default value: `$puppetdb::params::masterless` + +##### `puppetdb_soft_write_failure` + +Data type: `Any` + + + +Default value: `false` + +##### `manage_routes` + +Data type: `Any` + + + +Default value: `true` + +##### `manage_storeconfigs` + +Data type: `Any` + + + +Default value: `true` + +##### `enable_storeconfigs` + +Data type: `Any` + + + +Default value: `true` + +##### `manage_report_processor` + +Data type: `Any` + + + +Default value: `false` + +##### `manage_config` + +Data type: `Any` + + + +Default value: `true` + +##### `create_puppet_service_resource` + +Data type: `Any` + + + +Default value: `true` + +##### `strict_validation` + +Data type: `Any` + + + +Default value: `true` + +##### `enable_reports` + +Data type: `Any` + + + +Default value: `false` + +##### `puppet_confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_confdir` + +##### `puppet_conf` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_conf` + +##### `terminus_package` + +Data type: `Any` + + + +Default value: `$puppetdb::params::terminus_package` + +##### `puppet_service_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_service_name` + +##### `puppetdb_startup_timeout` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_startup_timeout` + +##### `test_url` + +Data type: `Any` + + + +Default value: `$puppetdb::params::test_url` + +##### `restart_puppet` + +Data type: `Any` + + + +Default value: `true` + +### `puppetdb::master::puppetdb_conf` + +Manage the puppetdb.conf file on the puppeet master. See README.md for more +details. + +#### Parameters + +The following parameters are available in the `puppetdb::master::puppetdb_conf` class: + +* [`server`](#-puppetdb--master--puppetdb_conf--server) +* [`port`](#-puppetdb--master--puppetdb_conf--port) +* [`soft_write_failure`](#-puppetdb--master--puppetdb_conf--soft_write_failure) +* [`puppet_confdir`](#-puppetdb--master--puppetdb_conf--puppet_confdir) +* [`legacy_terminus`](#-puppetdb--master--puppetdb_conf--legacy_terminus) + +##### `server` + +Data type: `Any` + + + +Default value: `'localhost'` + +##### `port` + +Data type: `Any` + + + +Default value: `'8081'` + +##### `soft_write_failure` + +Data type: `Any` + + + +Default value: + +```puppet +$puppetdb::disable_ssl ? { + true => true, + default => false +``` + +##### `puppet_confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_confdir` + +##### `legacy_terminus` + +Data type: `Any` + + + +Default value: + +```puppet +$puppetdb::params::terminus_package ? { + /(puppetdb-terminus)/ => true, + default => false +``` + +### `puppetdb::master::report_processor` + +Manage the installation of the report processor on the master. See README.md +for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::master::report_processor` class: + +* [`puppet_conf`](#-puppetdb--master--report_processor--puppet_conf) +* [`masterless`](#-puppetdb--master--report_processor--masterless) +* [`enable`](#-puppetdb--master--report_processor--enable) + +##### `puppet_conf` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_conf` + +##### `masterless` + +Data type: `Any` + + + +Default value: `$puppetdb::params::masterless` + +##### `enable` + +Data type: `Any` + + + +Default value: `false` + +### `puppetdb::master::routes` + +Manages the routes configuration file on the master. See README.md for more +details. + +#### Parameters + +The following parameters are available in the `puppetdb::master::routes` class: + +* [`puppet_confdir`](#-puppetdb--master--routes--puppet_confdir) +* [`masterless`](#-puppetdb--master--routes--masterless) +* [`routes`](#-puppetdb--master--routes--routes) + +##### `puppet_confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_confdir` + +##### `masterless` + +Data type: `Any` + + + +Default value: `$puppetdb::params::masterless` + +##### `routes` + +Data type: `Any` + + + +Default value: `undef` + +### `puppetdb::master::storeconfigs` + +This class configures the puppet master to enable storeconfigs and to use +puppetdb as the storeconfigs backend. See README.md for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::master::storeconfigs` class: + +* [`puppet_conf`](#-puppetdb--master--storeconfigs--puppet_conf) +* [`masterless`](#-puppetdb--master--storeconfigs--masterless) +* [`enable`](#-puppetdb--master--storeconfigs--enable) + +##### `puppet_conf` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppet_conf` + +##### `masterless` + +Data type: `Any` + + + +Default value: `$puppetdb::params::masterless` + +##### `enable` + +Data type: `Any` + + + +Default value: `true` + +### `puppetdb::params` + +PRIVATE CLASS - do not use directly + +The puppetdb default configuration settings. + +### `puppetdb::server` + +Class to configure a PuppetDB server. See README.md for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::server` class: + +* [`listen_address`](#-puppetdb--server--listen_address) +* [`listen_port`](#-puppetdb--server--listen_port) +* [`disable_cleartext`](#-puppetdb--server--disable_cleartext) +* [`open_listen_port`](#-puppetdb--server--open_listen_port) +* [`ssl_listen_address`](#-puppetdb--server--ssl_listen_address) +* [`ssl_listen_port`](#-puppetdb--server--ssl_listen_port) +* [`disable_ssl`](#-puppetdb--server--disable_ssl) +* [`open_ssl_listen_port`](#-puppetdb--server--open_ssl_listen_port) +* [`ssl_dir`](#-puppetdb--server--ssl_dir) +* [`ssl_set_cert_paths`](#-puppetdb--server--ssl_set_cert_paths) +* [`ssl_cert_path`](#-puppetdb--server--ssl_cert_path) +* [`ssl_key_path`](#-puppetdb--server--ssl_key_path) +* [`ssl_key_pk8_path`](#-puppetdb--server--ssl_key_pk8_path) +* [`ssl_ca_cert_path`](#-puppetdb--server--ssl_ca_cert_path) +* [`ssl_deploy_certs`](#-puppetdb--server--ssl_deploy_certs) +* [`ssl_key`](#-puppetdb--server--ssl_key) +* [`ssl_cert`](#-puppetdb--server--ssl_cert) +* [`ssl_ca_cert`](#-puppetdb--server--ssl_ca_cert) +* [`ssl_protocols`](#-puppetdb--server--ssl_protocols) +* [`postgresql_ssl_on`](#-puppetdb--server--postgresql_ssl_on) +* [`cipher_suites`](#-puppetdb--server--cipher_suites) +* [`migrate`](#-puppetdb--server--migrate) +* [`database`](#-puppetdb--server--database) +* [`database_host`](#-puppetdb--server--database_host) +* [`database_port`](#-puppetdb--server--database_port) +* [`database_username`](#-puppetdb--server--database_username) +* [`database_password`](#-puppetdb--server--database_password) +* [`database_name`](#-puppetdb--server--database_name) +* [`manage_db_password`](#-puppetdb--server--manage_db_password) +* [`jdbc_ssl_properties`](#-puppetdb--server--jdbc_ssl_properties) +* [`database_validate`](#-puppetdb--server--database_validate) +* [`database_embedded_path`](#-puppetdb--server--database_embedded_path) +* [`node_ttl`](#-puppetdb--server--node_ttl) +* [`node_purge_ttl`](#-puppetdb--server--node_purge_ttl) +* [`report_ttl`](#-puppetdb--server--report_ttl) +* [`facts_blacklist`](#-puppetdb--server--facts_blacklist) +* [`gc_interval`](#-puppetdb--server--gc_interval) +* [`node_purge_gc_batch_limit`](#-puppetdb--server--node_purge_gc_batch_limit) +* [`log_slow_statements`](#-puppetdb--server--log_slow_statements) +* [`conn_max_age`](#-puppetdb--server--conn_max_age) +* [`conn_keep_alive`](#-puppetdb--server--conn_keep_alive) +* [`conn_lifetime`](#-puppetdb--server--conn_lifetime) +* [`puppetdb_package`](#-puppetdb--server--puppetdb_package) +* [`puppetdb_service`](#-puppetdb--server--puppetdb_service) +* [`puppetdb_service_status`](#-puppetdb--server--puppetdb_service_status) +* [`puppetdb_user`](#-puppetdb--server--puppetdb_user) +* [`puppetdb_group`](#-puppetdb--server--puppetdb_group) +* [`read_database`](#-puppetdb--server--read_database) +* [`read_database_host`](#-puppetdb--server--read_database_host) +* [`read_database_port`](#-puppetdb--server--read_database_port) +* [`read_database_username`](#-puppetdb--server--read_database_username) +* [`read_database_password`](#-puppetdb--server--read_database_password) +* [`read_database_name`](#-puppetdb--server--read_database_name) +* [`manage_read_db_password`](#-puppetdb--server--manage_read_db_password) +* [`read_database_jdbc_ssl_properties`](#-puppetdb--server--read_database_jdbc_ssl_properties) +* [`read_database_validate`](#-puppetdb--server--read_database_validate) +* [`read_log_slow_statements`](#-puppetdb--server--read_log_slow_statements) +* [`read_conn_max_age`](#-puppetdb--server--read_conn_max_age) +* [`read_conn_keep_alive`](#-puppetdb--server--read_conn_keep_alive) +* [`read_conn_lifetime`](#-puppetdb--server--read_conn_lifetime) +* [`confdir`](#-puppetdb--server--confdir) +* [`vardir`](#-puppetdb--server--vardir) +* [`manage_firewall`](#-puppetdb--server--manage_firewall) +* [`manage_database`](#-puppetdb--server--manage_database) +* [`java_args`](#-puppetdb--server--java_args) +* [`merge_default_java_args`](#-puppetdb--server--merge_default_java_args) +* [`max_threads`](#-puppetdb--server--max_threads) +* [`command_threads`](#-puppetdb--server--command_threads) +* [`concurrent_writes`](#-puppetdb--server--concurrent_writes) +* [`store_usage`](#-puppetdb--server--store_usage) +* [`temp_usage`](#-puppetdb--server--temp_usage) +* [`disable_update_checking`](#-puppetdb--server--disable_update_checking) +* [`certificate_whitelist_file`](#-puppetdb--server--certificate_whitelist_file) +* [`certificate_whitelist`](#-puppetdb--server--certificate_whitelist) +* [`database_max_pool_size`](#-puppetdb--server--database_max_pool_size) +* [`read_database_max_pool_size`](#-puppetdb--server--read_database_max_pool_size) +* [`automatic_dlo_cleanup`](#-puppetdb--server--automatic_dlo_cleanup) +* [`cleanup_timer_interval`](#-puppetdb--server--cleanup_timer_interval) +* [`dlo_max_age`](#-puppetdb--server--dlo_max_age) +* [`java_bin`](#-puppetdb--server--java_bin) + +##### `listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_address` + +##### `listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_port` + +##### `disable_cleartext` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_cleartext` + +##### `open_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::open_listen_port` + +##### `ssl_listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_address` + +##### `ssl_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_port` + +##### `disable_ssl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_ssl` + +##### `open_ssl_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::open_ssl_listen_port` + +##### `ssl_dir` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$puppetdb::params::ssl_dir` + +##### `ssl_set_cert_paths` + +Data type: `Boolean` + + + +Default value: `$puppetdb::params::ssl_set_cert_paths` + +##### `ssl_cert_path` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$puppetdb::params::ssl_cert_path` + +##### `ssl_key_path` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$puppetdb::params::ssl_key_path` + +##### `ssl_key_pk8_path` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$puppetdb::params::ssl_key_pk8_path` + +##### `ssl_ca_cert_path` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `$puppetdb::params::ssl_ca_cert_path` + +##### `ssl_deploy_certs` + +Data type: `Boolean` + + + +Default value: `$puppetdb::params::ssl_deploy_certs` + +##### `ssl_key` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key` + +##### `ssl_cert` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_cert` + +##### `ssl_ca_cert` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_ca_cert` + +##### `ssl_protocols` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_protocols` + +##### `postgresql_ssl_on` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_on` + +##### `cipher_suites` + +Data type: `Any` + + + +Default value: `$puppetdb::params::cipher_suites` + +##### `migrate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::migrate` + +##### `database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database` + +##### `database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_host` + +##### `database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_port` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_password` + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `manage_db_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_db_password` + +##### `jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::jdbc_ssl_properties` + +##### `database_validate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_validate` + +##### `database_embedded_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_embedded_path` + +##### `node_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_ttl` + +##### `node_purge_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_purge_ttl` + +##### `report_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::report_ttl` + +##### `facts_blacklist` + +Data type: `Optional[Array]` + + + +Default value: `$puppetdb::params::facts_blacklist` + +##### `gc_interval` + +Data type: `Any` + + + +Default value: `$puppetdb::params::gc_interval` + +##### `node_purge_gc_batch_limit` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_purge_gc_batch_limit` + +##### `log_slow_statements` + +Data type: `Any` + + + +Default value: `$puppetdb::params::log_slow_statements` + +##### `conn_max_age` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_max_age` + +##### `conn_keep_alive` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_keep_alive` + +##### `conn_lifetime` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_lifetime` + +##### `puppetdb_package` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_package` + +##### `puppetdb_service` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_service` + +##### `puppetdb_service_status` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_service_status` + +##### `puppetdb_user` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_user` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +##### `read_database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database` + +##### `read_database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_host` + +##### `read_database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_port` + +##### `read_database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_username` + +##### `read_database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_password` + +##### `read_database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_name` + +##### `manage_read_db_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_read_db_password` + +##### `read_database_jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_jdbc_ssl_properties` + +##### `read_database_validate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_validate` + +##### `read_log_slow_statements` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_log_slow_statements` + +##### `read_conn_max_age` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_max_age` + +##### `read_conn_keep_alive` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_keep_alive` + +##### `read_conn_lifetime` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_lifetime` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `vardir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::vardir` + +##### `manage_firewall` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_firewall` + +##### `manage_database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_database` + +##### `java_args` + +Data type: `Any` + + + +Default value: `$puppetdb::params::java_args` + +##### `merge_default_java_args` + +Data type: `Any` + + + +Default value: `$puppetdb::params::merge_default_java_args` + +##### `max_threads` + +Data type: `Any` + + + +Default value: `$puppetdb::params::max_threads` + +##### `command_threads` + +Data type: `Any` + + + +Default value: `$puppetdb::params::command_threads` + +##### `concurrent_writes` + +Data type: `Any` + + + +Default value: `$puppetdb::params::concurrent_writes` + +##### `store_usage` + +Data type: `Any` + + + +Default value: `$puppetdb::params::store_usage` + +##### `temp_usage` + +Data type: `Any` + + + +Default value: `$puppetdb::params::temp_usage` + +##### `disable_update_checking` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_update_checking` + +##### `certificate_whitelist_file` + +Data type: `Any` + + + +Default value: `$puppetdb::params::certificate_whitelist_file` + +##### `certificate_whitelist` + +Data type: `Any` + + + +Default value: `$puppetdb::params::certificate_whitelist` + +##### `database_max_pool_size` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_max_pool_size` + +##### `read_database_max_pool_size` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_max_pool_size` + +##### `automatic_dlo_cleanup` + +Data type: `Boolean` + + + +Default value: `$puppetdb::params::automatic_dlo_cleanup` + +##### `cleanup_timer_interval` + +Data type: `String[1]` + + + +Default value: `$puppetdb::params::cleanup_timer_interval` + +##### `dlo_max_age` + +Data type: `Integer[1]` + + + +Default value: `$puppetdb::params::dlo_max_age` + +##### `java_bin` + +Data type: `Optional[Stdlib::Absolutepath]` + + + +Default value: `$puppetdb::params::java_bin` + +### `puppetdb::server::command_processing` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::command_processing` class: + +* [`command_threads`](#-puppetdb--server--command_processing--command_threads) +* [`concurrent_writes`](#-puppetdb--server--command_processing--concurrent_writes) +* [`store_usage`](#-puppetdb--server--command_processing--store_usage) +* [`temp_usage`](#-puppetdb--server--command_processing--temp_usage) +* [`confdir`](#-puppetdb--server--command_processing--confdir) + +##### `command_threads` + +Data type: `Any` + + + +Default value: `$puppetdb::params::command_threads` + +##### `concurrent_writes` + +Data type: `Any` + + + +Default value: `$puppetdb::params::concurrent_writes` + +##### `store_usage` + +Data type: `Any` + + + +Default value: `$puppetdb::params::store_usage` + +##### `temp_usage` + +Data type: `Any` + + + +Default value: `$puppetdb::params::temp_usage` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +### `puppetdb::server::database` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::database` class: + +* [`database`](#-puppetdb--server--database--database) +* [`database_host`](#-puppetdb--server--database--database_host) +* [`database_port`](#-puppetdb--server--database--database_port) +* [`database_username`](#-puppetdb--server--database--database_username) +* [`database_password`](#-puppetdb--server--database--database_password) +* [`database_name`](#-puppetdb--server--database--database_name) +* [`manage_db_password`](#-puppetdb--server--database--manage_db_password) +* [`jdbc_ssl_properties`](#-puppetdb--server--database--jdbc_ssl_properties) +* [`database_validate`](#-puppetdb--server--database--database_validate) +* [`database_embedded_path`](#-puppetdb--server--database--database_embedded_path) +* [`node_ttl`](#-puppetdb--server--database--node_ttl) +* [`node_purge_ttl`](#-puppetdb--server--database--node_purge_ttl) +* [`report_ttl`](#-puppetdb--server--database--report_ttl) +* [`facts_blacklist`](#-puppetdb--server--database--facts_blacklist) +* [`gc_interval`](#-puppetdb--server--database--gc_interval) +* [`node_purge_gc_batch_limit`](#-puppetdb--server--database--node_purge_gc_batch_limit) +* [`log_slow_statements`](#-puppetdb--server--database--log_slow_statements) +* [`conn_max_age`](#-puppetdb--server--database--conn_max_age) +* [`conn_keep_alive`](#-puppetdb--server--database--conn_keep_alive) +* [`conn_lifetime`](#-puppetdb--server--database--conn_lifetime) +* [`confdir`](#-puppetdb--server--database--confdir) +* [`puppetdb_user`](#-puppetdb--server--database--puppetdb_user) +* [`puppetdb_group`](#-puppetdb--server--database--puppetdb_group) +* [`database_max_pool_size`](#-puppetdb--server--database--database_max_pool_size) +* [`migrate`](#-puppetdb--server--database--migrate) +* [`postgresql_ssl_on`](#-puppetdb--server--database--postgresql_ssl_on) +* [`ssl_cert_path`](#-puppetdb--server--database--ssl_cert_path) +* [`ssl_key_pk8_path`](#-puppetdb--server--database--ssl_key_pk8_path) +* [`ssl_ca_cert_path`](#-puppetdb--server--database--ssl_ca_cert_path) + +##### `database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database` + +##### `database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_host` + +##### `database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_port` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_password` + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `manage_db_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_db_password` + +##### `jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::jdbc_ssl_properties` + +##### `database_validate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_validate` + +##### `database_embedded_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_embedded_path` + +##### `node_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_ttl` + +##### `node_purge_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_purge_ttl` + +##### `report_ttl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::report_ttl` + +##### `facts_blacklist` + +Data type: `Any` + + + +Default value: `$puppetdb::params::facts_blacklist` + +##### `gc_interval` + +Data type: `Any` + + + +Default value: `$puppetdb::params::gc_interval` + +##### `node_purge_gc_batch_limit` + +Data type: `Any` + + + +Default value: `$puppetdb::params::node_purge_gc_batch_limit` + +##### `log_slow_statements` + +Data type: `Any` + + + +Default value: `$puppetdb::params::log_slow_statements` + +##### `conn_max_age` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_max_age` + +##### `conn_keep_alive` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_keep_alive` + +##### `conn_lifetime` + +Data type: `Any` + + + +Default value: `$puppetdb::params::conn_lifetime` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `puppetdb_user` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_user` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +##### `database_max_pool_size` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_max_pool_size` + +##### `migrate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::migrate` + +##### `postgresql_ssl_on` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_on` + +##### `ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_cert_path` + +##### `ssl_key_pk8_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key_pk8_path` + +##### `ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_ca_cert_path` + +### `puppetdb::server::firewall` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::firewall` class: + +* [`http_port`](#-puppetdb--server--firewall--http_port) +* [`open_http_port`](#-puppetdb--server--firewall--open_http_port) +* [`ssl_port`](#-puppetdb--server--firewall--ssl_port) +* [`open_ssl_port`](#-puppetdb--server--firewall--open_ssl_port) + +##### `http_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_port` + +##### `open_http_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::open_listen_port` + +##### `ssl_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_port` + +##### `open_ssl_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::open_ssl_listen_port` + +### `puppetdb::server::global` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::global` class: + +* [`vardir`](#-puppetdb--server--global--vardir) +* [`confdir`](#-puppetdb--server--global--confdir) +* [`puppetdb_group`](#-puppetdb--server--global--puppetdb_group) + +##### `vardir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::vardir` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +### `puppetdb::server::jetty` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::jetty` class: + +* [`listen_address`](#-puppetdb--server--jetty--listen_address) +* [`listen_port`](#-puppetdb--server--jetty--listen_port) +* [`disable_cleartext`](#-puppetdb--server--jetty--disable_cleartext) +* [`ssl_listen_address`](#-puppetdb--server--jetty--ssl_listen_address) +* [`ssl_listen_port`](#-puppetdb--server--jetty--ssl_listen_port) +* [`disable_ssl`](#-puppetdb--server--jetty--disable_ssl) +* [`ssl_set_cert_paths`](#-puppetdb--server--jetty--ssl_set_cert_paths) +* [`ssl_cert_path`](#-puppetdb--server--jetty--ssl_cert_path) +* [`ssl_key_path`](#-puppetdb--server--jetty--ssl_key_path) +* [`ssl_ca_cert_path`](#-puppetdb--server--jetty--ssl_ca_cert_path) +* [`ssl_protocols`](#-puppetdb--server--jetty--ssl_protocols) +* [`cipher_suites`](#-puppetdb--server--jetty--cipher_suites) +* [`confdir`](#-puppetdb--server--jetty--confdir) +* [`max_threads`](#-puppetdb--server--jetty--max_threads) +* [`puppetdb_user`](#-puppetdb--server--jetty--puppetdb_user) +* [`puppetdb_group`](#-puppetdb--server--jetty--puppetdb_group) + +##### `listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_address` + +##### `listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::listen_port` + +##### `disable_cleartext` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_cleartext` + +##### `ssl_listen_address` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_address` + +##### `ssl_listen_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_listen_port` + +##### `disable_ssl` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_ssl` + +##### `ssl_set_cert_paths` + +Data type: `Boolean` + + + +Default value: `$puppetdb::params::ssl_set_cert_paths` + +##### `ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_cert_path` + +##### `ssl_key_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key_path` + +##### `ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_ca_cert_path` + +##### `ssl_protocols` + +Data type: `Optional[String]` + + + +Default value: `$puppetdb::params::ssl_protocols` + +##### `cipher_suites` + +Data type: `Optional[String]` + + + +Default value: `$puppetdb::params::cipher_suites` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `max_threads` + +Data type: `Any` + + + +Default value: `$puppetdb::params::max_threads` + +##### `puppetdb_user` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_user` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +### `puppetdb::server::puppetdb` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::puppetdb` class: + +* [`certificate_whitelist_file`](#-puppetdb--server--puppetdb--certificate_whitelist_file) +* [`certificate_whitelist`](#-puppetdb--server--puppetdb--certificate_whitelist) +* [`disable_update_checking`](#-puppetdb--server--puppetdb--disable_update_checking) +* [`confdir`](#-puppetdb--server--puppetdb--confdir) +* [`puppetdb_user`](#-puppetdb--server--puppetdb--puppetdb_user) +* [`puppetdb_group`](#-puppetdb--server--puppetdb--puppetdb_group) + +##### `certificate_whitelist_file` + +Data type: `Any` + + + +Default value: `$puppetdb::params::certificate_whitelist_file` + +##### `certificate_whitelist` + +Data type: `Any` + + + +Default value: `$puppetdb::params::certificate_whitelist` + +##### `disable_update_checking` + +Data type: `Any` + + + +Default value: `$puppetdb::params::disable_update_checking` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `puppetdb_user` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_user` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +### `puppetdb::server::read_database` + +PRIVATE CLASS - do not use directly + +#### Parameters + +The following parameters are available in the `puppetdb::server::read_database` class: + +* [`read_database`](#-puppetdb--server--read_database--read_database) +* [`read_database_host`](#-puppetdb--server--read_database--read_database_host) +* [`read_database_port`](#-puppetdb--server--read_database--read_database_port) +* [`read_database_username`](#-puppetdb--server--read_database--read_database_username) +* [`read_database_password`](#-puppetdb--server--read_database--read_database_password) +* [`read_database_name`](#-puppetdb--server--read_database--read_database_name) +* [`manage_db_password`](#-puppetdb--server--read_database--manage_db_password) +* [`jdbc_ssl_properties`](#-puppetdb--server--read_database--jdbc_ssl_properties) +* [`database_validate`](#-puppetdb--server--read_database--database_validate) +* [`log_slow_statements`](#-puppetdb--server--read_database--log_slow_statements) +* [`conn_max_age`](#-puppetdb--server--read_database--conn_max_age) +* [`conn_keep_alive`](#-puppetdb--server--read_database--conn_keep_alive) +* [`conn_lifetime`](#-puppetdb--server--read_database--conn_lifetime) +* [`confdir`](#-puppetdb--server--read_database--confdir) +* [`puppetdb_user`](#-puppetdb--server--read_database--puppetdb_user) +* [`puppetdb_group`](#-puppetdb--server--read_database--puppetdb_group) +* [`database_max_pool_size`](#-puppetdb--server--read_database--database_max_pool_size) +* [`postgresql_ssl_on`](#-puppetdb--server--read_database--postgresql_ssl_on) +* [`ssl_cert_path`](#-puppetdb--server--read_database--ssl_cert_path) +* [`ssl_key_pk8_path`](#-puppetdb--server--read_database--ssl_key_pk8_path) +* [`ssl_ca_cert_path`](#-puppetdb--server--read_database--ssl_ca_cert_path) + +##### `read_database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database` + +##### `read_database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_host` + +##### `read_database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_port` + +##### `read_database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_username` + +##### `read_database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_password` + +##### `read_database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_name` + +##### `manage_db_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::manage_read_db_password` + +##### `jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_jdbc_ssl_properties` + +##### `database_validate` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_validate` + +##### `log_slow_statements` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_log_slow_statements` + +##### `conn_max_age` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_max_age` + +##### `conn_keep_alive` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_keep_alive` + +##### `conn_lifetime` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_conn_lifetime` + +##### `confdir` + +Data type: `Any` + + + +Default value: `$puppetdb::params::confdir` + +##### `puppetdb_user` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_user` + +##### `puppetdb_group` + +Data type: `Any` + + + +Default value: `$puppetdb::params::puppetdb_group` + +##### `database_max_pool_size` + +Data type: `Any` + + + +Default value: `$puppetdb::params::read_database_max_pool_size` + +##### `postgresql_ssl_on` + +Data type: `Any` + + + +Default value: `$puppetdb::params::postgresql_ssl_on` + +##### `ssl_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_cert_path` + +##### `ssl_key_pk8_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_key_pk8_path` + +##### `ssl_ca_cert_path` + +Data type: `Any` + + + +Default value: `$puppetdb::params::ssl_ca_cert_path` + +### `puppetdb::server::validate_db` + +This validates a database connection. See README.md for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::server::validate_db` class: + +* [`database`](#-puppetdb--server--validate_db--database) +* [`database_host`](#-puppetdb--server--validate_db--database_host) +* [`database_port`](#-puppetdb--server--validate_db--database_port) +* [`database_username`](#-puppetdb--server--validate_db--database_username) +* [`database_password`](#-puppetdb--server--validate_db--database_password) +* [`database_name`](#-puppetdb--server--validate_db--database_name) +* [`jdbc_ssl_properties`](#-puppetdb--server--validate_db--jdbc_ssl_properties) + +##### `database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database` + +##### `database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_host` + +##### `database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_port` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_password` + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::jdbc_ssl_properties` + +### `puppetdb::server::validate_read_db` + +This validates a database connection. See README.md for more details. + +#### Parameters + +The following parameters are available in the `puppetdb::server::validate_read_db` class: + +* [`database`](#-puppetdb--server--validate_read_db--database) +* [`database_host`](#-puppetdb--server--validate_read_db--database_host) +* [`database_port`](#-puppetdb--server--validate_read_db--database_port) +* [`database_username`](#-puppetdb--server--validate_read_db--database_username) +* [`database_password`](#-puppetdb--server--validate_read_db--database_password) +* [`database_name`](#-puppetdb--server--validate_read_db--database_name) +* [`jdbc_ssl_properties`](#-puppetdb--server--validate_read_db--jdbc_ssl_properties) + +##### `database` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database` + +##### `database_host` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_host` + +##### `database_port` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_port` + +##### `database_username` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_username` + +##### `database_password` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_password` + +##### `database_name` + +Data type: `Any` + + + +Default value: `$puppetdb::params::database_name` + +##### `jdbc_ssl_properties` + +Data type: `Any` + + + +Default value: `$puppetdb::params::jdbc_ssl_properties` + +## Defined types + +### `puppetdb::database::default_read_grant` + +Private class. Grant read permissions to $database_read_only_username by default, for new tables created by +$database_username. + +#### Parameters + +The following parameters are available in the `puppetdb::database::default_read_grant` defined type: + +* [`database_name`](#-puppetdb--database--default_read_grant--database_name) +* [`schema`](#-puppetdb--database--default_read_grant--schema) +* [`database_username`](#-puppetdb--database--default_read_grant--database_username) +* [`database_read_only_username`](#-puppetdb--database--default_read_grant--database_read_only_username) + +##### `database_name` + +Data type: `String` + + + +##### `schema` + +Data type: `String` + + + +##### `database_username` + +Data type: `String` + + + +##### `database_read_only_username` + +Data type: `String` + + + +### `puppetdb::database::postgresql_ssl_rules` + +Private class for configuring the pg_ident.conf and pg_hba.conf files + +#### Parameters + +The following parameters are available in the `puppetdb::database::postgresql_ssl_rules` defined type: + +* [`database_name`](#-puppetdb--database--postgresql_ssl_rules--database_name) +* [`database_username`](#-puppetdb--database--postgresql_ssl_rules--database_username) +* [`puppetdb_server`](#-puppetdb--database--postgresql_ssl_rules--puppetdb_server) + +##### `database_name` + +Data type: `String` + + + +##### `database_username` + +Data type: `String` + + + +##### `puppetdb_server` + +Data type: `String` + + + +### `puppetdb::database::read_grant` + +Private class. Grant read-only permissions to $database_read_only_username for all objects in $schema of +$database_name + +#### Parameters + +The following parameters are available in the `puppetdb::database::read_grant` defined type: + +* [`database_name`](#-puppetdb--database--read_grant--database_name) +* [`schema`](#-puppetdb--database--read_grant--schema) +* [`database_read_only_username`](#-puppetdb--database--read_grant--database_read_only_username) + +##### `database_name` + +Data type: `String` + + + +##### `schema` + +Data type: `String` + + + +##### `database_read_only_username` + +Data type: `String` + + + +### `puppetdb::database::read_only_user` + +The puppetdb::database::read_only_user class. + +#### Parameters + +The following parameters are available in the `puppetdb::database::read_only_user` defined type: + +* [`read_database_username`](#-puppetdb--database--read_only_user--read_database_username) +* [`database_name`](#-puppetdb--database--read_only_user--database_name) +* [`database_owner`](#-puppetdb--database--read_only_user--database_owner) +* [`password_hash`](#-puppetdb--database--read_only_user--password_hash) + +##### `read_database_username` + +Data type: `String` + + + +##### `database_name` + +Data type: `String` + + + +##### `database_owner` + +Data type: `String` + + + +##### `password_hash` + +Data type: `Variant[String, Boolean]` + + + +Default value: `false` + +## Resource types + +### `puppetdb_conn_validator` + +Verify that a connection can be successfully established between a node +and the puppetdb server. Its primary use is as a precondition to +prevent configuration changes from being applied if the puppetdb +server cannot be reached, but it could potentially be used for other +purposes such as monitoring. + +#### Properties + +The following properties are available in the `puppetdb_conn_validator` type. + +##### `ensure` + +Valid values: `present`, `absent` + +The basic property that the resource should be in. + +Default value: `present` + +#### Parameters + +The following parameters are available in the `puppetdb_conn_validator` type. + +* [`name`](#-puppetdb_conn_validator--name) +* [`provider`](#-puppetdb_conn_validator--provider) +* [`puppetdb_port`](#-puppetdb_conn_validator--puppetdb_port) +* [`puppetdb_server`](#-puppetdb_conn_validator--puppetdb_server) +* [`test_url`](#-puppetdb_conn_validator--test_url) +* [`timeout`](#-puppetdb_conn_validator--timeout) +* [`use_ssl`](#-puppetdb_conn_validator--use_ssl) + +##### `name` + +namevar + +An arbitrary name used as the identity of the resource. + +##### `provider` + +The specific backend to use for this `puppetdb_conn_validator` resource. You will seldom need to specify this --- Puppet +will usually discover the appropriate provider for your platform. + +##### `puppetdb_port` + +The port that the puppetdb server should be listening on. + +##### `puppetdb_server` + +The DNS name or IP address of the server where puppetdb should be running. + +##### `test_url` + +URL to use for testing if the PuppetDB database is up + +##### `timeout` + +The max number of seconds that the validator should wait before giving up and deciding that puppetdb is not running; +defaults to 15 seconds. + +Default value: `15` + +##### `use_ssl` + +Whether the connection will be attempted using https + +Default value: `true` + +## Functions + +### `puppetdb::create_subsetting_resource_hash` + +Type: Ruby 4.x API + +The puppetdb::create_subsetting_resource_hash function. + +#### `puppetdb::create_subsetting_resource_hash(Hash $java_args, Any $params)` + +The puppetdb::create_subsetting_resource_hash function. + +Returns: `Any` + +##### `java_args` + +Data type: `Hash` + + + +##### `params` + +Data type: `Any` + + + +### `puppetdb::flatten_java_args` + +Type: Ruby 4.x API + +The puppetdb::flatten_java_args function. + +#### `puppetdb::flatten_java_args(Optional[Hash] $java_args)` + +The puppetdb::flatten_java_args function. + +Returns: `String` + +##### `java_args` + +Data type: `Optional[Hash]` + + + +## Data types + +### `Puppetdb::Ttl` + +The Puppetdb::Ttl data type. + +Alias of `Pattern[/^\d+(d|h|m|s|ms)$/]` + +## Tasks + +### `lxd_exp` + +Provision/Tear down a machine on LXD + +**Supports noop?** false + +#### Parameters + +##### `action` + +Data type: `Enum[provision, tear_down]` + +Action to perform, tear_down or provision + +##### `inventory` + +Data type: `Optional[String[1]]` + +Location of the inventory file + +##### `node_name` + +Data type: `Optional[String[1]]` + +The name of the node + +##### `platform` + +Data type: `Optional[String[1]]` + +Platform to provision, eg ubuntu:14.04 + +##### `vars` + +Data type: `Optional[String[1]]` + +YAML string of key/value pairs to add to the inventory vars section +