community.general.imgadm – Manage SmartOS images
community.general.imgadm – Manage SmartOS images
Note
This plugin is part of the community.general collection (version 2.0.1).
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 | Choices/Defaults | Comments |
---|---|---|
force boolean |
|
Force a given operation (where supported by imgadm(1M)). |
pool string |
Default: "zones" |
zpool to import to or delete images from. |
source string |
URI for the image source. | |
state string / required |
|
State the object operated on should be in. |
type string |
|
Type for image sources. |
uuid string |
Image UUID. Can either be a full UUID or |
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 | Returned | Description |
---|---|---|
source string |
When not managing an image. |
Source that is managed.
Sample: |
state string |
success |
State of the target, after execution.
Sample: present |
uuid string |
When not managing an image source. |
UUID for an image operated on.
Sample: 70e3ae72-96b6-11e6-9056-9737fd4d0764 |
Authors
- Jasper Lievisse Adriaanse (@jasperla)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/imgadm_module.html