community / community.docker / 3.8.1 / module / docker_stack_info Return information on all docker stacks Authors: Jose Angel Munoz (@imjoseangel)community.docker.docker_stack_info (3.8.1) — module
Install with ansible-galaxy collection install community.docker:==3.8.1
collections: - name: community.docker version: 3.8.1
Retrieve information on docker stacks using the C(docker stack) command on the target node (see examples).
- name: Shows stack info community.docker.docker_stack_info: register: result
- name: Show results ansible.builtin.debug: var: result.results
tls: default: false description: - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if O(validate_certs) is set to V(true) as well, it will take precedence. - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS) will be used instead. If the environment variable is not set, the default value will be used. type: bool version_added: 3.6.0 version_added_collection: community.docker ca_path: aliases: - ca_cert - tls_ca_cert - cacert_path description: - Use a CA certificate when performing server verification by providing the path to a CA certificate file. - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set, the file C(ca.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. type: path version_added: 3.6.0 version_added_collection: community.docker client_key: aliases: - tls_client_key - key_path description: - Path to the client's TLS key file. - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set, the file C(key.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. type: path version_added: 3.6.0 version_added_collection: community.docker docker_cli: description: - Path to the Docker CLI. If not provided, will search for Docker CLI on the E(PATH). type: path version_added: 3.6.0 version_added_collection: community.docker api_version: aliases: - docker_api_version default: auto description: - The version of the Docker API running on the Docker Host. - Defaults to the latest version of the API supported by this collection and the docker daemon. - If the value is not specified in the task, the value of environment variable E(DOCKER_API_VERSION) will be used instead. If the environment variable is not set, the default value will be used. type: str version_added: 3.6.0 version_added_collection: community.docker cli_context: description: - The Docker CLI context to use. type: str version_added: 3.6.0 version_added_collection: community.docker client_cert: aliases: - tls_client_cert - cert_path description: - Path to the client's TLS certificate file. - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set, the file C(cert.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. type: path version_added: 3.6.0 version_added_collection: community.docker docker_host: aliases: - docker_url default: unix:///var/run/docker.sock description: - The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, V(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection, the module will automatically replace C(tcp) in the connection URL with C(https). - If the value is not specified in the task, the value of environment variable E(DOCKER_HOST) will be used instead. If the environment variable is not set, the default value will be used. type: str version_added: 3.6.0 version_added_collection: community.docker tls_hostname: description: - When verifying the authenticity of the Docker Host server, provide the expected name of the server. - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS_HOSTNAME) will be used instead. If the environment variable is not set, the default value will be used. type: str version_added: 3.6.0 version_added_collection: community.docker validate_certs: aliases: - tls_verify default: false description: - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS_VERIFY) will be used instead. If the environment variable is not set, the default value will be used. type: bool version_added: 3.6.0 version_added_collection: community.docker
results: description: - List of dictionaries containing the list of stacks on the target node elements: dict returned: always sample: - name: grafana namespace: default orchestrator: Kubernetes services: '2' type: list