Documentation

imgadm - Manage SmartOS images

New in version 2.3.

Synopsis

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

Options

parameter required default choices comments
force
no
  • True
  • False
Force a given operation (where supported by imgadm(1M)).
pool
no zones
zpool to import to or delete images from.
source
no
URI for the image source.
state
yes
  • present
  • absent
  • deleted
  • imported
  • updated
  • vacuumed
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.
type
no imgapi
  • imgapi
  • docker
  • dsapi
Type for image sources.
uuid
no
Image UUID. Can either be a full UUID or * for all images.

Examples

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

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

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

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

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

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

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

Return Values

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

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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.