W3cubDocs

/Ansible 2.10

community.general.docker_stack_task_info – Return information of the tasks on a docker stack

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.docker_stack_task_info.

New in version 1.1.0: of community.general

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.general.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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/docker_stack_task_info_module.html