scyld-imgctl¶

NAME

scyld-imgctl -- Query and modify images for compute nodes.

USAGE

scyld-imgctl: [-h] [-v] [-q] [[-c | --config] CONFIG] [--base-url URL] [[-u | --user] USER[:PASSWD]] [--human | --json | --csv | --table] [--pretty | --no-pretty] [--show-uids] [-a | -i IMAGES] {list,ls, create,mk, clone,cp, update,up, replace,re, delete,rm, download, stat, capture}

OPTIONAL ARGUMENTS

-h, --help: Print usage message and exit. Ignore trailing args, parse and ignore preceding args.
-v, --verbose: Increase verbosity.
-q, --quiet: Decrease verbosity.
-c, --config CONFIG: Specify a client configuration file CONFIG.
--show-uids: Do not try to make the output more human readable.
-a, --all: Interact with all node images (default for list).
-i, --ids IMAGES: A comma separated list of node images to query or modify.

ARGUMENTS TO OVERRIDE BASIC CONFIGURATION DETAILS

-u, --user USER[:PASSWD]: Masquerade as user USER with optional colon-separated password PASSWD.

FORMATTING ARGUMENTS

--human: Format the output for readability (default).
--json: Format the output as JSON.
--csv: Format the output as CSV.
--table: Format the output as a table.
--pretty: Indent JSON or XML output, and substitute human readable output for other formats.
--no-pretty: Opposite of --pretty.
--fields FIELDS: Select individual fields in the result or error.

ACTIONS ON IMAGE(s)

list (ls)

List information about node images.

create (mk)

Add node image.

clone (cp)

Copy node image to new identifiers.

update (up)

Modify node image fields.

replace (re)

Replace all node image fields.

delete (rm)

Delete node image(s) from the remote cache.

download FILES

Download named files FILES (any of "content").

--dest DIR: Optional destination for the downloaded files. (Default is current working directory.)

stat

Print the recorded file stats for an image.

capture [--save FILE] [--node NODE] [--exclude PATHS] [--content JSON/INI_FILE] ...

Replace or create an image captured from a running system, adding optional name=value pairs.

-n, --node NODE: Select the node to capture.
--exclude PATHS: Exclude additional paths during image capture, specifying either pathnames or a file @FILE that contains a list of pathnames.

--content [ JSON | INI_FILE ]: Overwrite fields in the specified image(s).

EXAMPLES

scyld-imgctl -i DefaultImage download content

Download the previously uploaded image named DefaultImage.

scyld-imgctl -i DefaultImage stat

Print the last modified time and size of the previously uploaded image.

scyld-imgctl -i DefaultImage clone name=NewImage

Clone the DefaultImage to a new NewImage.

RETURN VALUES

Upon successful completion, scyld-imgctl returns 0. On failure, an error message is printed to stderr and scyld-imgctl returns 1.