Description

Namespace: kickstart.profile

Method: addIpRange

Parameters:

• string sessionKey
• string label - The label of the kickstart
• string min - The ip address making up the minimum of the range (i.e. 192.168.0.1)
• string max - The ip address making up the maximum of the range (i.e. 192.168.0.254)

Returns:

• int - 1 on success, exception thrown otherwise.

Method: addScript

Parameters:

• string sessionKey
• string ksLabel - The kickstart label to add the script to.
• string contents - The full script to add.
• string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
• string type - The type of script (either 'pre' or 'post').
• boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.

Returns:

• int id - the id of the added script

Method: addScript

Parameters:

• string sessionKey
• string ksLabel - The kickstart label to add the script to.
• string contents - The full script to add.
• string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
• string type - The type of script (either 'pre' or 'post').
• boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.
• boolean template - Enable templating using cobbler.

Returns:

• int id - the id of the added script

Method: compareActivationKeys

Parameters:

• string sessionKey
• string kickstartLabel1
• string kickstartLabel2

Returns:

• struct - Comparison Info
  • array "kickstartLabel1" - Actual label of the first kickstart profile is the key into the struct
  array:
  • struct - activation key
    • string "key"
    • string "description"
    • int "usage_limit"
    • string "base_channel_label"
    • array "child_channel_labels"
      • string childChannelLabel
    • array "entitlements"
      • string entitlementLabel
    • array "server_group_ids"
      • string serverGroupId
    • array "package_names"
      • string packageName - (deprecated by packages)
    • array "packages"
      • struct - package
        • string "name" - packageName
        • string "arch" - archLabel - optional
    • boolean "universal_default"
    • boolean "disabled"
  • array "kickstartLabel2" - Actual label of the second kickstart profile is the key into the struct
  array:
  • struct - activation key
    • string "key"
    • string "description"
    • int "usage_limit"
    • string "base_channel_label"
    • array "child_channel_labels"
      • string childChannelLabel
    • array "entitlements"
      • string entitlementLabel
    • array "server_group_ids"
      • string serverGroupId
    • array "package_names"
      • string packageName - (deprecated by packages)
    • array "packages"
      • struct - package
        • string "name" - packageName
        • string "arch" - archLabel - optional
    • boolean "universal_default"
    • boolean "disabled"

Method: compareAdvancedOptions

Parameters:

• string sessionKey
• string kickstartLabel1
• string kickstartLabel2

Returns:

• struct - Comparison Info
  • array "kickstartLabel1" - Actual label of the first kickstart profile is the key into the struct
  array:
  • struct - value
    • string "name"
    • string "value"
    • boolean "enabled"
  • array "kickstartLabel2" - Actual label of the second kickstart profile is the key into the struct
  array:
  • struct - value
    • string "name"
    • string "value"
    • boolean "enabled"

Method: comparePackages

Parameters:

• string sessionKey
• string kickstartLabel1
• string kickstartLabel2

Returns:

• struct - Comparison Info
  • array "kickstartLabel1" - Actual label of the first kickstart profile is the key into the struct
  array:
  • string - package name
  • array "kickstartLabel2" - Actual label of the second kickstart profile is the key into the struct
  array:
  • string - package name

Method: downloadKickstart

Parameters:

• string sessionKey
• string ksLabel - The label of the kickstart to download.
• string host - The host to use when referring to the satellite itself (Usually this should be the FQDN of the satellite, but could be the ip address or shortname of it as well.

Returns:

• string - The contents of the kickstart file. Note: if an activation key is not associated with the kickstart file, registration will not occur in the satellite generated %post section. If one is associated, it will be used for registration.

Method: downloadRenderedKickstart

Parameters:

• string sessionKey
• string ksLabel - The label of the kickstart to download.

Returns:

• string - The contents of the kickstart file.

Method: getAdvancedOptions

Parameters:

• string sessionKey
• string ksLabel - Label of kickstart profile to be changed.

Returns:

• array:
  • struct - option
    • string "name"
    • string "arguments"

Method: getCfgPreservation

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.

Returns:

• boolean - The value of the option. True means that ks.cfg will be copied to /root, false means that it will not.

Method: getChildChannels

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile.

Returns:

• array:
  • string - channelLabel

Method: getCustomOptions

Parameters:

• string sessionKey
• string ksLabel

Returns:

• array:
  • struct - option
    • int "id"
    • string "arguments"

Method: getKickstartTree

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.

Returns:

• string kstreeLabel - Label of the kickstart tree.

Method: getUpdateType

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile.

Returns:

• string update_type - Update type for this Kickstart Profile.

Method: getVariables

Parameters:

• string sessionKey
• string ksLabel

Returns:

• array:
  • struct - kickstart variable
    • string "key"
    • string or int "value"

Method: listIpRanges

Parameters:

• string sessionKey
• string label - The label of the kickstart

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: listScripts

Parameters:

• string sessionKey
• string ksLabel - The label of the kickstart

Returns:

• array:
  • struct - kickstart script
    • int "id"
    • string "contents"
    • string "script_type" - Which type of script ('pre' or 'post').
    • string "interpreter" - The scripting language interpreter to use for this script. An empty string indicates the default kickstart shell.
    • boolean "chroot" - True if the script will be executed within the chroot environment.
    • boolean "template" - True if templating using cobbler is enabled

Method: removeIpRange

Parameters:

• string sessionKey
• string ksLabel - The kickstart label of the ip range you want to remove
• string ip_address - An Ip Address that falls within the range that you are wanting to remove. The min or max of the range will work.

Returns:

• int - 1 on successful removal, 0 if range wasn't found for the specified kickstart, exception otherwise.

Method: removeScript

Parameters:

• string sessionKey
• string ksLabel - The kickstart from which to remove the script from.
• int scriptId - The id of the script to remove.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setAdvancedOptions

Parameters:

• string sessionKey
• string ksLabel
• array:
  • struct - advanced options
    • string "name" - Name of the advanced option. Valid Option names: autostep, interactive, install, upgrade, text, network, cdrom, harddrive, nfs, url, lang, langsupport keyboard, mouse, device, deviceprobe, zerombr, clearpart, bootloader, timezone, auth, rootpw, selinux, reboot, firewall, xconfig, skipx, key, ignoredisk, autopart, cmdline, firstboot, graphical, iscsi, iscsiname, logging, monitor, multipath, poweroff, halt, services, shutdown, user, vnc, zfcp, driverdisk, md5_crypt_rootpw
    • string "arguments" - Arguments of the option

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setCfgPreservation

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.
• boolean preserve - whether or not ks.cfg and all %include fragments will be copied to /root.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setChildChannels

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.
• string[] channelLabels - List of labels of child channels

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setCustomOptions

Parameters:

• string sessionKey
• string ksLabel
• string[] options

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setKickstartTree

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.
• string kstreeLabel - Label of new kickstart tree.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setLogging

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.
• boolean pre - whether or not to log the pre section of a kickstart to /root/ks-pre.log
• boolean post - whether or not to log the post section of a kickstart to /root/ks-post.log

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setUpdateType

Parameters:

• string sessionKey
• string kslabel - Label of kickstart profile to be changed.
• string updateType - The new update type to set. Possible values are 'red_hat', 'all', and 'none'.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setVariables

Parameters:

• string sessionKey
• string ksLabel
• array:
  • struct - kickstart variable
    • string "key"
    • string or int "value"

Returns:

• int - 1 on success, exception thrown otherwise.