univention.ucs_modules.univention_config_registry (3.1.2) — module

Install collection

Install with ansible-galaxy collection install univention.ucs_modules:==3.1.2

Add to requirements.yml

  collections:
    - name: univention.ucs_modules
      version: 3.1.2

Description

You can set and unset keys in the Univention Config Registry.

Inputs

    
keys:
    description:
    - A dict of keys to set or unset. In case of unsetting, the values are ignored.
    - Either this, 'kvlist' or 'commit' must be given.
    required: false
    type: str

force:
    default: false
    description:
    - Set a variable as forced, like `ucr set --force`
    - When the force option is used in setting a local variable, settings adopted from
      the directory service and variables from the schedule level are overruled and the
      given value for the local system fixed instead.
    required: false
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Either 'present' for setting the key/value pairs given with 'keys' or 'absent' for
      unsetting the keys from the 'keys' dict. Default is 'present'.
    type: str

commit:
    description:
    - A list of destination filenames as strings to be commited.
    - Either this, 'keys' or 'kvlist' must be given.
    required: false
    type: list

kvlist:
    description:
    - You pass in a list of dicts with this parameter instead of using a dict via 'keys'.
      Each of the dicts passed via 'kvlist' must contain the keys 'key' and 'value'. This
      allows the use of Jinja in the UCR keys to set/unset.
    - Either this, 'keys' or 'commit' must be given.
    required: false

Outputs

message:
  description: A human-readable information about which keys where changed
meta['changed_keys']:
  description: A list of all key names that were changed
  type: array
meta['commited_templates']:
  description: A list of all templates that were changed
  type: array