( Return to API Overview )

Available methods

Description

Provides methods to access and modify the kickstart trees.

Namespace: kickstart.tree

Method: create

Description:
Create a Kickstart Tree (Distribution) in Satellite.

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).

Returns:

int - 1 on success, exception thrown otherwise.

Method: delete

Description:
Delete a Kickstart Tree (Distribution) in Satellite.

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: deleteTreeAndProfiles

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

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

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

Description:
Rename a Kickstart Tree (Distribution) in Satellite.

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

Description:
Edit a Kickstart Tree (Distribution) in Satellite.

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).

Returns:

int - 1 on success, exception thrown otherwise.

Generated on 7/31/2009