0
0
mirror of https://github.com/thegeeklab/wp-ansible.git synced 2024-11-13 22:50:40 +00:00
wp-ansible/docs/data/data.yaml

212 lines
4.3 KiB
YAML
Raw Normal View History

2023-12-22 09:10:39 +00:00
---
properties:
- name: become
description: |
Enable privilege escalation.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: become_method
description: |
Privilege escalation method to use.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: become_user
description: |
Privilege escalation user to use.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: check
description: |
Run a check, do not apply any changes.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: connection
description: |
Connection type to use.
type: string
required: false
2023-12-22 09:10:39 +00:00
- 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
2023-12-22 09:10:39 +00:00
- name: extra_vars
description: |
Set additional variables as `key=value`.
type: list
required: false
2023-12-22 09:10:39 +00:00
- name: flush_cache
description: |
Clear the fact cache for every host in inventory.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: force_handlers
description: |
Run handlers even if a task fails.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: forks
description: |
Specify number of parallel processes to use.
type: integer
defaultValue: 5
required: false
2023-12-22 09:10:39 +00:00
- name: galaxy_requirements
description: |
Path to galaxy requirements file.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: inventory
description: |
Path to inventory file.
type: list
required: false
2023-12-22 09:10:39 +00:00
- name: limit
description: |
Limit selected hosts to an additional pattern.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: list_hosts
description: |
Outputs a list of matching hosts.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: list_tags
description: |
List all available tags.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: list_tasks
description: |
List all tasks that would be executed.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: module_path
description: |
Prepend paths to module library.
type: list
required: false
2023-12-22 09:10:39 +00:00
- name: playbook
description: |
List of playbooks to apply.
type: list
required: false
2023-12-22 09:10:39 +00:00
- name: private_key
description: |
SSH private key used to authenticate the connection.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: python_requirements
description: |
Path to python requirements file.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: scp_extra_args
description: |
Specify extra arguments to pass to SCP connections only.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: sftp_extra_args
description: |
Specify extra arguments to pass to SFTP connections only.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: skip_tags
description: |
Only run plays and tasks whose tags do not match.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: ssh_common_args
description: |
Specify common arguments to pass to SFTP, SCP and SSH connections.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: ssh_extra_args
description: |
Specify extra arguments to pass to SSH connections only.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: start_at_task
description: |
Start the playbook at the task matching this name.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: syntax_check
description: |
Perform a syntax check on the playbook.
type: bool
defaultValue: false
required: false
2023-12-22 09:10:39 +00:00
- name: tags
description: |
Only run plays and tasks tagged with these values.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: timeout
description: |
Override the connection timeout in seconds.
type: integer
defaultValue: 0
required: false
2023-12-22 09:10:39 +00:00
- name: user
description: |
Connect as this user.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: vault_id
description: |
The vault identity to use.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: vault_password
description: |
The vault password to use.
type: string
required: false
2023-12-22 09:10:39 +00:00
- name: verbose
description: |
Level of verbosity, 0 up to 4.
type: integer
defaultValue: 0
required: false