New in version 2.3.
- python >= 2.6
parameter | required | default | choices | comments |
---|---|---|---|---|
force |
no |
|
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 |
|
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 |
|
Type for image sources. |
uuid |
no | Image UUID. Can either be a full UUID or * for all images. |
- 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
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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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, Helping Testing PRs and Developing Modules.