Description

Namespace: kickstart

Method: cloneProfile

Parameters:

• string sessionKey
• string ksLabelToClone - Label of the kickstart profile to clone
• string newKsLabel - label of the cloned profile

Returns:

• int - 1 on success, exception thrown otherwise.

Method: createProfile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.
• string rootPassword - Root password.
• string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).

Returns:

• int - 1 on success, exception thrown otherwise.

Method: createProfile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.
• string rootPassword - Root password.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: createProfileWithCustomUrl

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.
• string rootPassword - Root password.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: createProfileWithCustomUrl

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.
• string rootPassword - Root password.
• string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).

Returns:

• int - 1 on success, exception thrown otherwise.

Method: deleteProfile

Parameters:

• string sessionKey
• string ksLabel - The label of the kickstart profile you want to remove

Returns:

• int - 1 on success, exception thrown otherwise.

Method: disableProfile

Parameters:

• string sessionKey
• string profileLabel - Label for the kickstart tree you want to en/disable
• string disabled - true to disable the profile

Returns:

• int - 1 on success, exception thrown otherwise.

Method: findKickstartForIp

Parameters:

• string sessionKey
• string ipAddress - The ip address to search for (i.e. 192.168.0.1)

Returns:

• string - label of the kickstart. Empty string ("") if not found.

Method: importFile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartFileContents - Contents of the kickstart file to import.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: importFile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile. Using this option signifies that this default URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.
• string kickstartFileContents - Contents of the kickstart file to import.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: importFile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile. Using this option signifies that this default URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.
• string kickstartFileContents - Contents of the kickstart file to import.
• string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).

Returns:

• int - 1 on success, exception thrown otherwise.

Method: importRawFile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartFileContents - Contents of the kickstart file to import.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: importRawFile

Parameters:

• string sessionKey
• string profileLabel - Label for the new kickstart profile.
• string virtualizationType - none, para_host, qemu, xenfv or xenpv.
• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
• string kickstartFileContents - Contents of the kickstart file to import.
• string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).

Returns:

• int - 1 on success, exception thrown otherwise.

Method: isProfileDisabled

Parameters:

• string sessionKey
• string profileLabel - kickstart profile label

Returns:

• true if profile is disabled

Method: listAllIpRanges

Parameters:

• string sessionKey

Returns:

• array:
  • struct - Kickstart Ip Range
    • string "ksLabel" - The kickstart label associated with the ip range
    • string "max" - The max ip of the range
    • string "min" - The min ip of the range

Method: listKickstartableChannels

Parameters:

• string sessionKey

Returns:

• array:
  • struct - channel
    • int "id"
    • string "name"
    • string "label"
    • string "arch_name"
    • string "arch_label"
    • string "summary"
    • string "description"
    • string "checksum_label"
    • dateTime.iso8601 "last_modified"
    • string "maintainer_name"
    • string "maintainer_email"
    • string "maintainer_phone"
    • string "support_policy"
    • string "gpg_key_url"
    • string "gpg_key_id"
    • string "gpg_key_fp"
    • dateTime.iso8601 "yumrepo_last_sync" - (optional)
    • string "end_of_life"
    • string "parent_channel_label"
    • string "clone_original"
    array:
    • struct - contentSources
      • int "id"
      • string "label"
      • string "sourceUrl"
      • string "type"

Method: listKickstartableTreeChannels

Parameters:

• string sessionKey

Returns:

• array:
  • struct - channel
    • int "id"
    • string "name"
    • string "label"
    • string "arch_name"
    • string "arch_label"
    • string "summary"
    • string "description"
    • string "checksum_label"
    • dateTime.iso8601 "last_modified"
    • string "maintainer_name"
    • string "maintainer_email"
    • string "maintainer_phone"
    • string "support_policy"
    • string "gpg_key_url"
    • string "gpg_key_id"
    • string "gpg_key_fp"
    • dateTime.iso8601 "yumrepo_last_sync" - (optional)
    • string "end_of_life"
    • string "parent_channel_label"
    • string "clone_original"
    array:
    • struct - contentSources
      • int "id"
      • string "label"
      • string "sourceUrl"
      • string "type"

Method: listKickstartableTrees

Deprecated - being replaced by kickstart.tree.list(string sessionKey, string channelLabel)

Parameters:

• string sessionKey
• string channelLabel - Label of channel to search.

Returns:

• array:
  • struct - kickstartable tree
    • int "id"
    • string "label"
    • string "base_path"
    • int "channel_id"

Method: listKickstarts

Parameters:

• string sessionKey

Returns:

• array:
  • struct - kickstart
    • string "label"
    • string "tree_label"
    • string "name"
    • boolean "advanced_mode"
    • boolean "org_default"
    • boolean "active"
    • string "update_type"

Method: renameProfile

Parameters:

• string sessionKey
• string originalLabel - Label for the kickstart profile you want to rename
• string newLabel - new label to change to

Returns:

• int - 1 on success, exception thrown otherwise.