2023-12-22 09:10:39 +00:00
|
|
|
---
|
|
|
|
properties:
|
|
|
|
- name: become
|
|
|
|
description: |
|
|
|
|
Enable privilege escalation.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: become_method
|
|
|
|
description: |
|
|
|
|
Privilege escalation method to use.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: become_user
|
|
|
|
description: |
|
|
|
|
Privilege escalation user to use.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: check
|
|
|
|
description: |
|
|
|
|
Run a check, do not apply any changes.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: connection
|
|
|
|
description: |
|
|
|
|
Connection type to use.
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: extra_vars
|
|
|
|
description: |
|
|
|
|
Set additional variables as `key=value`.
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: force_handlers
|
|
|
|
description: |
|
|
|
|
Run handlers even if a task fails.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: forks
|
|
|
|
description: |
|
|
|
|
Specify number of parallel processes to use.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: integer
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: 5
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: galaxy_requirements
|
|
|
|
description: |
|
|
|
|
Path to galaxy requirements file.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
2024-05-05 11:03:29 +00:00
|
|
|
- name: insecure_skip_verify
|
|
|
|
description: |
|
|
|
|
Skip SSL verification.
|
|
|
|
type: bool
|
|
|
|
defaultValue: false
|
|
|
|
required: false
|
|
|
|
|
2023-12-22 09:10:39 +00:00
|
|
|
- name: inventory
|
|
|
|
description: |
|
|
|
|
Path to inventory file.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: list
|
2024-05-04 12:35:41 +00:00
|
|
|
required: true
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: limit
|
|
|
|
description: |
|
|
|
|
Limit selected hosts to an additional pattern.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: list_hosts
|
|
|
|
description: |
|
|
|
|
Outputs a list of matching hosts.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: list_tags
|
|
|
|
description: |
|
|
|
|
List all available tags.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: list_tasks
|
|
|
|
description: |
|
|
|
|
List all tasks that would be executed.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
2024-05-05 11:03:29 +00:00
|
|
|
- name: log_level
|
|
|
|
description: |
|
|
|
|
Plugin log level.
|
|
|
|
type: string
|
|
|
|
defaultValue: "info"
|
|
|
|
required: false
|
|
|
|
|
2023-12-22 09:10:39 +00:00
|
|
|
- name: module_path
|
|
|
|
description: |
|
|
|
|
Prepend paths to module library.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: list
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: playbook
|
|
|
|
description: |
|
|
|
|
List of playbooks to apply.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: list
|
2024-05-04 12:35:41 +00:00
|
|
|
required: true
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: private_key
|
|
|
|
description: |
|
|
|
|
SSH private key used to authenticate the connection.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: python_requirements
|
|
|
|
description: |
|
|
|
|
Path to python requirements file.
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: ssh_extra_args
|
|
|
|
description: |
|
2024-01-03 21:35:23 +00:00
|
|
|
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.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: syntax_check
|
|
|
|
description: |
|
|
|
|
Perform a syntax check on the playbook.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: false
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: tags
|
|
|
|
description: |
|
|
|
|
Only run plays and tasks tagged with these values.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: timeout
|
|
|
|
description: |
|
|
|
|
Override the connection timeout in seconds.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: integer
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: 0
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: user
|
|
|
|
description: |
|
|
|
|
Connect as this user.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: vault_id
|
|
|
|
description: |
|
|
|
|
The vault identity to use.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: vault_password
|
|
|
|
description: |
|
|
|
|
The vault password to use.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
2023-12-22 09:10:39 +00:00
|
|
|
|
|
|
|
- name: verbose
|
|
|
|
description: |
|
|
|
|
Level of verbosity, 0 up to 4.
|
2024-01-03 21:35:23 +00:00
|
|
|
type: integer
|
2024-01-03 22:26:17 +00:00
|
|
|
defaultValue: 0
|
2024-01-03 21:35:23 +00:00
|
|
|
required: false
|