bimages

Displays information on Docker container images

Synopsis

bimages [-m host_name ... | -m host_group ... ] [-o "field_name ..." [-json]] [image-reponame[:image-tagname]]

bimages [-m host_name ... | -m host_group ...] [-o "field_name ..." ] [-noheader] [image-reponame[:image-tagname]]

bimages [-h | -V]

Description

By default, returns the following information about all LSF-invoked Docker container images: container image name, size of the image file, how many pending job tasks will use the container image, LSF host name, how many running job tasks and container instances are using the container image.

Pending and running job tasks are not counted for container jobs with UNKNOWN status.

Job arrays are considered as multi-job elements in this command.

Important: To enable the LIM to collect Docker image information, you must specify docker as a Boolean resource in the lsf.shared file.

Options

-json

Displays the customized output in JSON format.

When specified, bimages -o displays the customized output in the JSON format.

This option only applies to output for the bimages -o command for customized output. This has no effect when running bimages without the -o option.

-m host_name... | -m host_group ...

Displays information on containers that are invoked by LSF on the specified hosts. If a host group is specified, bimages displays containers that are invoked by LSF on every host in the host group.

If -m is not specified, bimages displays containers that are invoked by LSF on every host in the cluster.

-noheader

Removes the column headings from the output.

When specified, bimages displays the values of the fields without displaying the names of the fields. This is useful for script parsing, when column headings are not necessary.

This option cannot be used with the -json option.

-o "field_name ..."

Sets the customized output format. Specify which bimages fields and in which order to display.

The following are the field names used to specify the bimages fields to display and units of measurement for the displayed field:

Table 1. Output fields for bimages
Field name	Unit
REPO
TAGS
IMAGE_NAME
SIZE	MB
DEMAND
HOST_NAME
NJOBS
NCTNRS
LAST_USED	time stamp
TOTAL_NJOBS
PULLED_TIME	time stamp
IMAGE_ID

Field names are space-separated and case-sensitive.

For example,

bimages -o "IMAGE_NAME SIZE HOST_NAME"

image-reponame[:image-tagname]

Displays information about the specified container image. If there are no specified image tags, bimages image-reponame displays the latest container image.

If this argument is not specified, bimages displays all container images.

-h

Prints command usage to stderr and exits.

-V

Prints LSF release version to stderr and exits.

Default Output

Displays the following fields:

IMAGE_NAME: The name of the container image. This is a combination of the container image repository and tag names.
SIZE: The size of the container image file.
DEMAND: The number of pending job tasks that will use the container image. This number includes jobs in the PENDING and PSUSPEND states, but does not include jobs in the FWD_PEND or any other states.
HOST_NAME: Name of the LSF host.
NJOBS: The number of running job tasks that are using the container image. This number includes jobs in the RUNNING, USUSPEND, and SSUSPEND states.
NCTNRS: The number of running container instances that are using the container image on the host. This number includes container instances that are started by other applications.

Customized Output (-o)

In addition to the fields displayed for the default output, the -o option can display the following specified fields:

REPO: The name of the container image repository.
TAGS: The name of the container image tags.
LAST_USED: The time that the container image was last used by an LSF job. If a running job is using the container image, the value is the current time, otherwise, this is the time that the job ended. A hyphen (-) indicates that the container image was never used.
TOTAL_NJOBS: The total number of running job tasks that are using the container image on all hosts. This number is the sum of all NJOBS values on all LSF hosts with the same container image.
PULLED_TIME: The time that the container image was last pulled.
IMAGE_ID: The container image ID, in table format. This shows the first 12 bits of the container image ID, which is the same output format as the docker images command. When shown in JSON format, this displays the full image ID.