salt.modules.smartos_imgadm

Module for running imgadm command on SmartOS

salt.modules.smartos_imgadm.avail(search=None, verbose=False)

Return a list of available images

search
: string
search keyword
verbose
: boolean (False)
toggle verbose output

CLI Example:

salt '*' imgadm.avail [percona]
salt '*' imgadm.avail verbose=True
salt.modules.smartos_imgadm.delete(uuid)

Remove an installed image

uuid
: string
Specifies uuid to import

CLI Example:

salt '*' imgadm.delete e42f8c84-bbea-11e2-b920-078fab2aab1f
salt.modules.smartos_imgadm.docker_to_uuid(uuid)

Get the image uuid from an imported docker image

New in version Fluorine.

salt.modules.smartos_imgadm.get(uuid)

Return info on an installed image

uuid
: string
uuid of image

CLI Example:

salt '*' imgadm.get e42f8c84-bbea-11e2-b920-078fab2aab1f
salt '*' imgadm.get plexinc/pms-docker:plexpass
salt.modules.smartos_imgadm.import(uuid, verbose=False)

Import an image from the repository

uuid
: string
uuid to import
verbose
: boolean (False)
toggle verbose output

CLI Example:

salt '*' imgadm.import e42f8c84-bbea-11e2-b920-078fab2aab1f [verbose=True]
salt.modules.smartos_imgadm.list(verbose=False)

Return a list of installed images

verbose
: boolean (False)
toggle verbose output

Changed in version Fluorine: Docker images are now also listed

CLI Example:

salt '*' imgadm.list
salt '*' imgadm.list docker=True
salt '*' imgadm.list verbose=True
salt.modules.smartos_imgadm.show(uuid)

Show manifest of a given image

uuid
: string
uuid of image

CLI Example:

salt '*' imgadm.show e42f8c84-bbea-11e2-b920-078fab2aab1f
salt '*' imgadm.show plexinc/pms-docker:plexpass
salt.modules.smartos_imgadm.source_add(source, source_type=u'imgapi')

Add a new source

source
: string
source url to add
source_trype
: string (imgapi)
source type, either imgapi or docker

New in version Fluorine.

CLI Example:

salt '*' imgadm.source_add https://updates.joyent.com
salt '*' imgadm.source_add https://docker.io docker
salt.modules.smartos_imgadm.source_delete(source)

Delete a source

source
: string
source url to delete

New in version Fluorine.

CLI Example:

salt '*' imgadm.source_delete https://updates.joyent.com
salt.modules.smartos_imgadm.sources(verbose=False)

Return a list of available sources

verbose
: boolean (False)
toggle verbose output

New in version Fluorine.

CLI Example:

salt '*' imgadm.sources
salt.modules.smartos_imgadm.update(uuid=u'')

Gather info on unknown image(s) (locally installed)

uuid
: string
optional uuid of image

CLI Example:

salt '*' imgadm.update [uuid]
salt.modules.smartos_imgadm.vacuum(verbose=False)

Remove unused images

verbose
: boolean (False)
toggle verbose output

CLI Example:

salt '*' imgadm.vacuum [verbose=True]
salt.modules.smartos_imgadm.version()

Return imgadm version

CLI Example:

salt '*' imgadm.version