community.docker.docker_stack_task_info – Return information of the tasks on a docker stack
community.docker.docker_stack_task_info – Return information of the tasks on a docker stack
Note
This plugin is part of the community.docker collection (version 1.2.2).
To install it use: ansible-galaxy collection install community.docker
.
To use it in a playbook, specify: community.docker.docker_stack_task_info
.
Synopsis
- Retrieve information on docker stacks tasks using the
docker stack
command on the target node (see examples).
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
name string / required |
Stack name. |
Examples
- name: Shows stack info
community.docker.docker_stack_task_info:
name: test_stack
register: result
- name: Show results
ansible.builtin.debug:
var: result.results
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
results list / elements=dictionary |
always |
List of dictionaries containing the list of tasks associated to a stack name.
Sample: [{"CurrentState":"Running","DesiredState":"Running","Error":"","ID":"7wqv6m02ugkw","Image":"busybox","Name":"test_stack.1","Node":"swarm","Ports":""}] |
Authors
- Jose Angel Munoz (@imjoseangel)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/docker/docker_stack_task_info_module.html