kickstart.profile.keys

Available methods

Description

Provides methods to access and modify the list of activation keys associated with a kickstart profile.

Namespace:

kickstart.profile.keys

Method: addActivationKey

HTTP POST

Description:

Add an activation key association to the kickstart profile

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string key - the activation key

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getActivationKeys

HTTP GET

Description:

Lookup the activation keys associated with the kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • array :

  • struct activation key

    • string "key"

    • string "description"

    • int "usage_limit"

    • string "base_channel_label"

    • string array "child_channel_labels" - childChannelLabel

    • string array "entitlements" - entitlementLabel

    • string array "server_group_ids" - serverGroupId

    • string array "package_names" - packageName - (deprecated by packages)

    • array "packages"

      • struct package

        • string "name" - packageName

        • string "arch" - archLabel - optional

    • boolean "universal_default"

    • boolean "disabled"

    • string "contact_method" - One of the following:

      • default

      • ssh-push

      • ssh-push-tunnel

Method: removeActivationKey

HTTP POST

Description:

Remove an activation key association from the kickstart profile

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string key - the activation key

Returns:

  • int - 1 on success, exception thrown otherwise.