image.profile
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
-
array :
-
string - customDataKeys
-
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 - 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:
-
array :
-
string - imageProfileTypes
-
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 - 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 - image profile details
-
string "storeLabel"
-
string "path"
-
string "activationKey" - set empty string to unset
-
Returns:
-
int - 1 on success, exception thrown otherwise.