From d3963160380ddac39793f596cd7c83c97f1aa3b2 Mon Sep 17 00:00:00 2001 From: thegeeklab-bot Date: Wed, 3 Jan 2024 21:46:06 +0000 Subject: [PATCH] [skip ci] auto-update documentation --- data/data.yaml | 68 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/data/data.yaml b/data/data.yaml index 2fe925f..ad3a741 100644 --- a/data/data.yaml +++ b/data/data.yaml @@ -3,143 +3,209 @@ properties: - name: become description: | Enable privilege escalation. + type: bool defaultvalue: false + required: false - name: become_method description: | Privilege escalation method to use. + type: string + required: false - name: become_user description: | Privilege escalation user to use. + type: string + required: false - name: check description: | Run a check, do not apply any changes. + type: bool defaultvalue: false + required: false - name: connection description: | Connection type to use. + type: string + required: false - name: diff description: | Show the differences. Be careful when using it in public CI environments as it can print secrets. + type: bool defaultvalue: false + required: false - name: extra_vars description: | Set additional variables as `key=value`. + type: list + required: false - name: flush_cache description: | Clear the fact cache for every host in inventory. + type: bool defaultvalue: false + required: false - name: force_handlers description: | Run handlers even if a task fails. + type: bool defaultvalue: false + required: false - name: forks description: | Specify number of parallel processes to use. + type: integer defaultvalue: 5 + required: false - name: galaxy_requirements description: | Path to galaxy requirements file. + type: string + required: false - name: inventory description: | Path to inventory file. + type: list + required: false - name: limit description: | Limit selected hosts to an additional pattern. + type: string + required: false - name: list_hosts description: | Outputs a list of matching hosts. + type: bool defaultvalue: false + required: false - name: list_tags description: | List all available tags. + type: bool defaultvalue: false + required: false - name: list_tasks description: | List all tasks that would be executed. + type: bool defaultvalue: false + required: false - name: module_path description: | Prepend paths to module library. + type: list + required: false - name: playbook description: | List of playbooks to apply. + type: list + required: false - name: private_key description: | SSH private key used to authenticate the connection. + type: string + required: false - name: python_requirements description: | Path to python requirements file. + type: string + required: false - name: scp_extra_args description: | Specify extra arguments to pass to SCP connections only. + type: string + required: false - name: sftp_extra_args description: | Specify extra arguments to pass to SFTP connections only. + type: string + required: false - name: skip_tags description: | Only run plays and tasks whose tags do not match. + type: string + required: false - name: ssh_common_args description: | Specify common arguments to pass to SFTP, SCP and SSH connections. + type: string + required: false - name: ssh_extra_args description: | - Specify extra arguments to pass to ssh connections only. + Specify extra arguments to pass to SSH connections only. + type: string + required: false - name: start_at_task description: | Start the playbook at the task matching this name. + type: string + required: false - name: syntax_check description: | Perform a syntax check on the playbook. + type: bool defaultvalue: false + required: false - name: tags description: | Only run plays and tasks tagged with these values. + type: string + required: false - name: timeout description: | Override the connection timeout in seconds. + type: integer defaultvalue: 0 + required: false - name: user description: | Connect as this user. + type: string + required: false - name: vault_id description: | The vault identity to use. + type: string + required: false - name: vault_password description: | The vault password to use. + type: string + required: false - name: verbose description: | Level of verbosity, 0 up to 4. + type: integer defaultvalue: 0 + required: false