( Return to API Overview )
- addChildChannels
- addConfigChannels
- addEntitlements
- addPackageNames
- addPackages
- addServerGroups
- checkConfigDeployment
- clone
- create
- create
- delete
- disableConfigDeployment
- enableConfigDeployment
- getDetails
- listActivatedSystems
- listActivationKeys
- listConfigChannels
- removeChildChannels
- removeConfigChannels
- removeEntitlements
- removePackageNames
- removePackages
- removeServerGroups
- setConfigChannels
- setDetails
Description
Contains methods to access common activation key functions
available from the web interface.
Namespace:
activationkey
Description:
Add child channels to an activation key.
Parameters:
-
string sessionKey
-
string key
-
array:
- string - childChannelLabel
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Given a list of activation keys and configuration channels,
this method adds given configuration channels to either the top or
the bottom (whichever you specify) of an activation key's
configuration channels list. The ordering of the configuration channels
provided in the add list is maintained while adding.
If one of the configuration channels in the 'add' list
already exists in an activation key, the
configuration channel will be re-ranked to the appropriate place.
Parameters:
-
string sessionKey
-
array:
-
array:
- string - List of configuration channel labels in the ranked order.
-
boolean addToTop
- true - To prepend the given channels to the beginning of
the activation key's config channel list
- false - To append the given channels to the end of
the activation key's config channel list
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Add entitlements to an activation key. Currently only
virtualization_host add-on entitlement is permitted.
Parameters:
-
string sessionKey
-
string key
-
array:
- string - entitlement label
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Add packages to an activation key using package name only.
Deprecated - being replaced by addPackages(string sessionKey, string key,
array[packages])
Parameters:
-
string sessionKey
-
string key
-
array:
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Add packages to an activation key.
Parameters:
-
string sessionKey
-
string key
-
array:
-
struct - packages
- string "name" - Package name
- string "arch" - Arch label - Optional
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Add server groups to an activation key.
Parameters:
-
string sessionKey
-
string key
-
array:
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Check configuration file deployment status for the
activation key specified.
Parameters:
-
string sessionKey
-
string key
Returns:
-
1 if enabled, 0 if disabled, exception thrown otherwise.
Description:
Clone an existing activation key.
Parameters:
-
string sessionKey
-
string key - Key to be cloned.
-
string cloneDescription - Description of the cloned key.
Returns:
-
string - The new activation key.
Description:
Create a new activation key.
The activation key parameter passed
in will be prefixed with the organization ID, and this value will be
returned from the create call.
Eg. If the caller passes in the key "foo" and belong to an organization with
the ID 100, the actual activation key will be "100-foo".
This call allows for the setting of a usage limit on this activation key.
If unlimited usage is desired see the similarly named API method with no
usage limit argument.
Parameters:
-
string sessionKey
-
string key - Leave empty to have new key autogenerated.
-
string description
-
string baseChannelLabel - Leave empty to accept
default.
-
int usageLimit - If unlimited usage is desired,
use the create API that does not include the parameter.
-
array:
- string - Add-on entitlement label to associate with the
key.
-
boolean universalDefault
Returns:
-
string - The new activation key.
Description:
Create a new activation key with unlimited usage.
The activation key parameter passed
in will be prefixed with the organization ID, and this value will be
returned from the create call.
Eg. If the caller passes in the key "foo" and belong to an organization with
the ID 100, the actual activation key will be "100-foo".
Parameters:
-
string sessionKey
-
string key - Leave empty to have new key autogenerated.
-
string description
-
string baseChannelLabel - Leave empty to accept
default.
-
array:
- string - Add-on entitlement label to associate with the
key.
-
boolean universalDefault
Returns:
-
string - The new activation key.
Description:
Delete an activation key.
Parameters:
-
string sessionKey
-
string key
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Disable configuration file deployment for the specified activation key.
Parameters:
-
string sessionKey
-
string key
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Enable configuration file deployment for the specified activation key.
Parameters:
-
string sessionKey
-
string key
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Lookup an activation key's details.
Parameters:
-
string sessionKey
-
string key
Returns:
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- array "entitlements"
- array "server_group_ids"
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
Description:
List the systems activated with the key provided.
Parameters:
-
string sessionKey
-
string key
Returns:
-
array:
-
struct - system structure
- int "id" - System id
- string "hostname"
- dateTime.iso8601 "last_checkin" - Last time server
successfully checked in
Description:
List activation keys that are visible to the
user.
Parameters:
Returns:
-
array:
-
struct - activation key
- string "key"
- string "description"
- int "usage_limit"
- string "base_channel_label"
- array "child_channel_labels"
- array "entitlements"
- array "server_group_ids"
- array "package_names"
- string packageName - (deprecated by packages)
- array "packages"
-
struct - package
- string "name" - packageName
- string "arch" - archLabel - optional
- boolean "universal_default"
- boolean "disabled"
Description:
List configuration channels
associated to an activation key.
Parameters:
-
string sessionKey
-
string key
Returns:
-
array:
-
struct - Configuration Channel information
- int "id"
- int "orgId"
- string "label"
- string "name"
- string "description"
- struct "configChannelType"
struct - Configuration Channel Type information
- int "id"
- string "label"
- string "name"
- int "priority"
Description:
Remove child channels from an activation key.
Parameters:
-
string sessionKey
-
string key
-
array:
- string - childChannelLabel
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Remove configuration channels from the given activation keys.
Parameters:
-
string sessionKey
-
array:
-
array:
- string - configChannelLabel
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Remove entitlements (by label) from an activation key.
Currently only virtualization_host add-on entitlement is permitted.
Parameters:
-
string sessionKey
-
string key
-
array:
- string - entitlement label
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Remove package names from an activation key.
Deprecated - being replaced by removePackages(string sessionKey, string key,
array[packages])
Parameters:
-
string sessionKey
-
string key
-
array:
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Remove package names from an activation key.
Parameters:
-
string sessionKey
-
string key
-
array:
-
struct - packages
- string "name" - Package name
- string "arch" - Arch label - Optional
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Remove server groups from an activation key.
Parameters:
-
string sessionKey
-
string key
-
array:
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Replace the existing set of
configuration channels on the given activation keys.
Channels are ranked by their order in the array.
Parameters:
-
string sessionKey
-
array:
-
array:
- string - configChannelLabel
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Update the details of an activation key.
Parameters:
-
string sessionKey
-
string key
-
struct - activation key
- string "description" - optional
- string "base_channel_label" - optional -
to set default base channel set to empty string or 'none'
- int "usage_limit" - optional
- boolean "unlimited_usage_limit" - Set true
for unlimited usage and to override usage_limit
- boolean "universal_default" - optional
- boolean "disabled" - optional
Returns:
-
int - 1 on success, exception thrown otherwise.
Generated on 3/4/2020