community.general.smartos_image_info – Get SmartOS image details.
From Get docs
Ansible/docs/2.10/collections/community/general/smartos image info module
community.general.smartos_image_info – Get SmartOS image details.
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.smartos_image_info
.
Synopsis
- Retrieve information about all installed images on SmartOS.
- This module was called
smartos_image_facts
before Ansible 2.9, returningansible_facts
. Note that the community.general.smartos_image_info module no longer returnsansible_facts
!
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
filters string |
Criteria for selecting image. Can be any value from image manifest and 'published_date', 'published', 'source', 'clones', and 'size'. More information can be found at https://smartos.org/man/1m/imgadm under 'imgadm list'. |
Examples
- name: Return information about all installed images
community.general.smartos_image_info:
register: result
- name: Return all private active Linux images
community.general.smartos_image_info:
filters: "os=linux state=active public=false"
register: result
- name: Show, how many clones does every image have
community.general.smartos_image_info:
register: result
- name: Print information
ansible.builtin.debug:
msg: "{{ result.smartos_images[item]['name'] }}-{{ result.smartos_images[item]['version'] }}
has {{ result.smartos_images[item]['clones'] }} VM(s)"
with_items: "{{ result.smartos_images.keys() | list }}"
# When the module is called as smartos_image_facts, return values are published
# in ansible_facts['smartos_images'] and can be used as follows.
# Note that this is deprecated and will stop working in community.general 3.0.0.
- name: Print information
ansible.builtin.debug:
msg: "{{ smartos_images[item]['name'] }}-{{ smartos_images[item]['version'] }}
has {{ smartos_images[item]['clones'] }} VM(s)"
with_items: "{{ smartos_images.keys() | list }}"
Authors
- Adam Števko (@xen0l)
© 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/smartos_image_info_module.html