image.profile

Available methods

Description

Provides methods to access and modify image profiles.

Namespace:

image.profile

Method: create

Description:

Create a new image profile

Parameters:

  • string sessionKey

  • string label

  • string type

  • string storeLabel

  • string path

  • string activationKey - optional

  • string kiwiOptions

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: create

Description:

Create a new image profile

Parameters:

  • string sessionKey

  • string label

  • string type

  • string storeLabel

  • string path

  • string activationKey - optional

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: delete

Description:

Delete an image profile

Parameters:

  • string sessionKey

  • string label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteCustomValues

Description:

Delete the custom values defined for the specified image profile. (Note: Attempt to delete values of non-existing keys throws exception. Attempt to delete value of existing key which has assigned no values doesn’t throw exception.)

Parameters:

  • string sessionKey

  • string label

  • string array keys - the custom data keys

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getCustomValues

Description:

Get the custom data values defined for the image profile

Parameters:

  • string sessionKey

  • string label

Returns:

  • struct the map of custom labels to custom values

    • string "custom info label"

    • string "value"

Method: getDetails

Description:

Get details of an image profile

Parameters:

  • string sessionKey

  • string label

Returns:

  • * struct image profile information

    • string "label"

    • string "imageType"

    • string "imageStore"

    • string "activationKey"

    • string "path" - in case type support path

Method: listImageProfileTypes

Description:

List available image store types

Parameters:

  • string sessionKey

Returns:

  • string array the list of image profile types

Method: listImageProfiles

Description:

List available image profiles

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct image profile information

    • string "label"

    • string "imageType"

    • string "imageStore"

    • string "activationKey"

    • string "path" - in case type support path

Method: setCustomValues

Description:

Set custom values for the specified image profile

Parameters:

  • string sessionKey

  • string label

  • struct values - the map of custom labels to custom values

    • string "custom info label"

    • string "value"

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setDetails

Description:

Set details of an image profile

Parameters:

  • string sessionKey

  • string label

  • struct details

    • string "storeLabel"

    • string "path"

    • string "activationKey" - set empty string to unset

Returns:

  • int - 1 on success, exception thrown otherwise.