You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.imgadm – Manage SmartOS images

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

• Manage SmartOS virtual machine images through imgadm(1M)

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.6

Parameters

Parameter	Comments
force boolean	Force a given operation (where supported by imgadm(1M)). Choices: no yes
pool string	zpool to import to or delete images from. Default: “zones”
source string	URI for the image source.
state string / required	State the object operated on should be in. imported is an alias for for present and deleted for absent. When set to vacuumed and uuid to *, it will remove all unused images. Choices: present absent deleted imported updated vacuumed
type string	Type for image sources. Choices: imgapi ← (default) docker dsapi
uuid string	Image UUID. Can either be a full UUID or * for all images.

Examples

- name: Import an image
  community.general.imgadm:
    uuid: '70e3ae72-96b6-11e6-9056-9737fd4d0764'
    state: imported

- name: Delete an image
  community.general.imgadm:
    uuid: '70e3ae72-96b6-11e6-9056-9737fd4d0764'
    state: deleted

- name: Update all images
  community.general.imgadm:
    uuid: '*'
    state: updated

- name: Update a single image
  community.general.imgadm:
    uuid: '70e3ae72-96b6-11e6-9056-9737fd4d0764'
    state: updated

- name: Add a source
  community.general.imgadm:
    source: 'https://datasets.project-fifo.net'
    state: present

- name: Add a Docker source
  community.general.imgadm:
    source: 'https://docker.io'
    type: docker
    state: present

- name: Remove a source
  community.general.imgadm:
    source: 'https://docker.io'
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
source string	Source that is managed. Returned: When not managing an image. Sample: “https://datasets.project-fifo.net”
state string	State of the target, after execution. Returned: success Sample: “present”
uuid string	UUID for an image operated on. Returned: When not managing an image source. Sample: “70e3ae72-96b6-11e6-9056-9737fd4d0764”

Authors

• Jasper Lievisse Adriaanse (@jasperla)