image
Description
Provides methods to access and modify images.
Namespace:
image
Method: delete
Description:
Delete an Image
Parameters:
-
string sessionKey
-
int imageId
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: getCustomValues
Description:
Get the custom data values defined for the Image.
Parameters:
-
string sessionKey
-
int imageId
Returns:
-
struct - Map of custom labels to custom values
-
string "custom info label"
-
string "value"
-
Method: getDetails
Description:
Get details of an Image
Parameters:
-
string sessionKey
-
int imageId
Returns:
-
* struct - Image Overview information
-
int "id"
-
string "name" - image name
-
string "version" - image tag/version
-
int "revision" - image build revision number
-
string "arch" - image architecture
-
boolean "external" - true if the image is built externally, false otherwise
-
string "checksum"
-
string "profileLabel"
-
string "buildStatus" - One of:
-
queued
-
picked up
-
completed
-
failed
-
string "inspectStatus" - Available if the build is successful. One of:
-
queued
-
picked up
-
completed
-
failed
-
int "buildServerId"
-
int "securityErrata"
-
int "bugErrata"
-
int "enhancementErrata"
-
int "outdatedPackages"
-
int "installedPackages"
-
Method: getRelevantErrata
Description:
Returns a list of all errata that are relevant for the image
Parameters:
-
string sessionKey
-
int imageId
Returns:
-
array :
-
struct - errata
-
int "id" - Errata ID.
-
string "issue_date" - Date erratum was updated. (Deprecated)
-
string "date" - Date erratum was created. (Deprecated)
-
string "update_date" - Date erratum was updated. (Deprecated)
-
string "advisory_synopsis" - Summary of the erratum.
-
string "advisory_type" - Type label such as Security, Bug Fix
-
string "advisory_status" - Status label such as final, testing, retracted
-
string "advisory_name" - Name such as RHSA, etc
-
Method: importImage
Description:
Import an image and schedule an inspect afterwards
Parameters:
-
string sessionKey
-
string name - image name as specified in the store
-
string version - version to import or empty
-
int buildHostId - system ID of the build host
-
string storeLabel
-
string activationKey - activation key to get the channel data from
-
dateTime.iso8601 earliestOccurrence - earliest the following inspect can run
Returns:
-
int id - ID of the inspect action created
Method: listImages
Description:
List available Images
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct - Image information
-
int "id"
-
string "name" - image name
-
string "version" - image tag/version
-
int "revision" - image build revision number
-
string "arch" - image architecture
-
boolean "external" - true if the image is built externally, false otherwise
-
string "storeLabel"
-
string "checksum"
-
Method: listPackages
Description:
List the installed packages on the given image.
Parameters:
-
string sessionKey
-
int imageId
Returns:
-
array :
-
struct - package
-
string "name"
-
string "version"
-
string "release"
-
string "epoch"
-
string "arch"
-
-
Method: scheduleImageBuild
Description:
Schedule an image build
Parameters:
-
string sessionKey
-
string profileLabel
-
string version - version to build or empty
-
int buildHostId - system id of the build host
-
dateTime.iso8601 earliestOccurrence - earliest the build can run.
Returns:
-
int id - ID of the build action created