.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.redhat.satellite.smart_class_parameter_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title redhat.satellite.smart_class_parameter module -- Manage Smart Class Parameters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `redhat.satellite collection `_ (version 3.6.0). To install it, use: :code:`ansible-galaxy collection install redhat.satellite`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`redhat.satellite.smart_class_parameter`. .. version_added .. versionadded:: 1.0.0 of redhat.satellite .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Update Smart Class Parameters. - Smart Class Parameters are created/deleted for Puppet classes during import and cannot be created or deleted otherwise. .. Aliases .. Requirements .. _ansible_collections.redhat.satellite.smart_class_parameter_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-avoid_duplicates: .. rst-class:: ansible-option-title **avoid_duplicates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Remove duplicate values (only array type) .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-default_value: .. rst-class:: ansible-option-title **default_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`any` .. raw:: html
- .. raw:: html
Value to use by default. .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the Smart Class Parameter .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-hidden_value: .. rst-class:: ansible-option-title **hidden_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
When enabled the parameter is hidden in the UI. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-merge_default: .. rst-class:: ansible-option-title **merge_default** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include default value when merging all matching values. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-merge_overrides: .. rst-class:: ansible-option-title **merge_overrides** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Merge all matching values (only array/hash type). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-omit: .. rst-class:: ansible-option-title **omit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Don't send this parameter in classification output. Puppet will use the value defined in the Puppet manifest for this parameter. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-override: .. rst-class:: ansible-option-title **override** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether the smart class parameter value is managed by Foreman .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-override_value_order: .. rst-class:: ansible-option-title **override_value_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
The order in which values are resolved. .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-override_values: .. rst-class:: ansible-option-title **override_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Value overrides .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-override_values/match: .. rst-class:: ansible-option-title **match** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Override match .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-override_values/omit: .. rst-class:: ansible-option-title **omit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Don't send this parameter in classification output, replaces use\_puppet\_default. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-override_values/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`any` .. raw:: html
- .. raw:: html
Override value, required if omit is false .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-parameter: .. rst-class:: ansible-option-title **parameter** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the parameter .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-parameter_type: .. rst-class:: ansible-option-title **parameter_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Types of variable values. If \ :literal:`none`\ , set the parameter type to empty value. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`string` - :ansible-option-choices-entry:`boolean` - :ansible-option-choices-entry:`integer` - :ansible-option-choices-entry:`real` - :ansible-option-choices-entry:`array` - :ansible-option-choices-entry:`hash` - :ansible-option-choices-entry:`yaml` - :ansible-option-choices-entry:`json` - :ansible-option-choices-entry:`none` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-puppetclass_name: .. rst-class:: ansible-option-title **puppetclass_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the puppetclass that own the parameter .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-required: .. rst-class:: ansible-option-title **required** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, will raise an error if there is no default value and no matcher provide a value. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-server_url: .. rst-class:: ansible-option-title **server_url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
URL of the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
State of the entity. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`present\_with\_defaults` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-validator_rule: .. rst-class:: ansible-option-title **validator_rule** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Used to enforce certain values for the parameter values. .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__parameter-validator_type: .. rst-class:: ansible-option-title **validator_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Types of validation values. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`regexp` - :ansible-option-choices-entry:`list` .. raw:: html
.. Attributes .. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: "Update prometheus::server alertmanagers_config param default value" redhat.satellite.smart_class_parameter: puppetclass_name: "prometheus::server" parameter: alertmanagers_config override: true required: true default_value: /etc/prometheus/alert.yml server_url: "https://satellite.example.com" username: "admin" password: "changeme" state: present - name: "Update prometheus::server alertmanagers_config param default value" redhat.satellite.smart_class_parameter: puppetclass_name: "prometheus::server" parameter: alertmanagers_config override: true override_value_order: - fqdn - hostgroup - domain required: true default_value: /etc/prometheus/alert.yml server_url: "https://satellite.example.com" username: "admin" password: "changeme" override_values: - match: domain=example.com value: foo - match: domain=foo.example.com omit: true state: present .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__return-entity: .. rst-class:: ansible-option-title **entity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Final state of the affected entities grouped by their type. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.redhat.satellite.smart_class_parameter_module__return-entity/smart_class_parameters: .. rst-class:: ansible-option-title **smart_class_parameters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of smart class parameters. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Baptiste Agasse (@bagasse) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors