Files
python-zunclient/doc/source/cli/command-objects/image.rst
namrata 0468c79d72 Doc: Add appcontainer image delete, appcontainer image search and appcontainer image pull
Add command list documentation for the 'appcontainer image delete',
'appcontainer image search' and 'appcontainer image pull' commands.

Partially Implements: blueprint zun-cli-guide

Change-Id: Ie4f6e071471e4b0fd1a3dbec69945f9a7a5bfe8d
2018-08-17 06:28:55 +00:00

7.5 KiB

appcontainer image

An appcontainer image specifies the image for a host.

appcontainer image list

List available images

appcontainer image list

openstack appcontainer image list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--marker <marker>] [--limit <limit>]
                                  [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

-h, --help

show this help message and exit

--marker <marker>

The last host UUID of the previous page; displays list of hosts after "marker".

--limit <limit>

Maximum number of hosts to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

whether to disable indenting the JSON

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

appcontainer image show

Describe a specific image

appcontainer image show

openstack appcontainer image show [-h]
                                  [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--noindent] [--prefix PREFIX]
                                  <uuid>

<uuid>

UUID of image to describe

-h, --help

show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

whether to disable indenting the JSON

--prefix PREFIX

add a prefix to all variable names

appcontainer image delete

Delete specified image from a host

appcontainer image delete

openstack appcontainer image delete  [-h] <uuid> <host>

<uuid>

UUID of image to describe

<host>

Name or UUID of the host

-h, --help

show this help message and exit

appcontainer image pull

Pull specified image into a host

appcontainer image pull

openstack appcontainer image pull [-h]
                                  [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--noindent] [--prefix PREFIX]
                                  <image> <host>

<image>

Name of the image

<host>

Name or UUID of the host

-h, --help

show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

whether to disable indenting the JSON

--prefix PREFIX

add a prefix to all variable names

Search the image repository for images

appcontainer image search

openstack appcontainer image search [-h]
                                    [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--image-driver <image-driver>]
                                    [--exact-match]
                                    <image_name>

<image_name>

Name of the image

-h, --help

show this help message and exit

--image-driver <image-driver>

Name of the image driver

--exact-match

exact match image name

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

whether to disable indenting the JSON

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric