kickstart.tree

Description

Provides methods to access and modify the kickstart trees.

Namespace:

kickstart.tree

Method: create

HTTP POST

Description:

Create a Kickstart Tree (Distribution) in #product().

Parameters:

  • string sessionKey

  • string treeLabel - The new kickstart tree label.

  • string basePath - Path to the base or root of the kickstart tree.

  • string channelLabel - Label of channel to associate with the kickstart tree.

  • string installType - Label for KickstartInstallType (rhel_6, rhel_7, rhel_8, rhel_9, fedora_9).

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: create

HTTP POST

Description:

Create a Kickstart Tree (Distribution) in #product().

Parameters:

  • string sessionKey

  • string treeLabel - The new kickstart tree label.

  • string basePath - Path to the base or root of the kickstart tree.

  • string channelLabel - Label of channel to associate with the kickstart tree.

  • string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).

  • string kernelOptions - Options to be passed to the kernel when booting for the installation.

  • string postKernelOptions - Options to be passed to the kernel when booting for the installation.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: delete

HTTP POST

Description:

Delete a Kickstart Tree (Distribution) from #product().

Parameters:

  • string sessionKey

  • string treeLabel - Label for the kickstart tree to delete.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteTreeAndProfiles

HTTP POST

Description:

Delete a kickstarttree and any profiles associated with this kickstart tree. WARNING: This will delete all profiles associated with this kickstart tree!

Parameters:

  • string sessionKey

  • string treeLabel - Label for the kickstart tree to delete.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getDetails

HTTP GET

Description:

The detailed information about a kickstartable tree given the tree name.

Parameters:

  • string sessionKey

  • string treeLabel - Label of kickstartable tree to search.

Returns:

  • * struct kickstartable tree

    • int "id"

    • string "label"

    • string "abs_path"

    • int "channel_id"

    • string "kernel_options"

    • string "post_kernel_options"

  • struct kickstart install type

    • int "id"

    • string "label"

    • string "name"

Method: list

HTTP POST

Description:

List the available kickstartable trees for the given channel.

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

HTTP GET

Description:

List the available kickstartable install types (rhel2,3,4,5 and fedora9+).

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct kickstart install type

    • int "id"

    • string "label"

    • string "name"

Method: rename

HTTP POST

Description:

Rename a Kickstart Tree (Distribution) in #product().

Parameters:

  • string sessionKey

  • string originalLabel - Label for the kickstart tree to rename.

  • string newLabel - The kickstart tree’s new label.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: update

HTTP POST

Description:

Edit a Kickstart Tree (Distribution) in #product().

Parameters:

  • string sessionKey

  • string treeLabel - Label for the kickstart tree.

  • string basePath - Path to the base or root of the kickstart tree.

  • string channelLabel - Label of channel to associate with kickstart tree.

  • string installType - Label for KickstartInstallType (rhel_6, rhel_7, rhel_8, rhel_9, fedora_9).

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: update

HTTP POST

Description:

Edit a Kickstart Tree (Distribution) in #product().

Parameters:

  • string sessionKey

  • string treeLabel - Label for the kickstart tree.

  • string basePath - Path to the base or root of the kickstart tree.

  • string channelLabel - Label of channel to associate with kickstart tree.

  • string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).

  • string kernelOptions - Options to be passed to the kernel when booting for the installation.

  • string postKernelOptions - Options to be passed to the kernel when booting for the installation.

Returns:

  • int - 1 on success, exception thrown otherwise.