( Return to API Overview )

Available methods

Description

Provides methods to access and modify many aspects of a kickstart profile.

Namespace: kickstart.profile


Method: addIpRange

Description:
Add an ip range to a kickstart profile.

Parameters:

Returns:


Method: addScript

Description:
Add a pre/post script to a kickstart profile.

Parameters:

Returns:


Method: addScript

Description:
Add a pre/post script to a kickstart profile.

Parameters:

Returns:


Method: addScript

Description:
Add a pre/post script to a kickstart profile.

Parameters:

Returns:


Method: compareActivationKeys

Description:
Returns a list for each kickstart profile; each list will contain activation keys not present on the other profile.

Parameters:

Returns:


Method: compareAdvancedOptions

Description:
Returns a list for each kickstart profile; each list will contain the properties that differ between the profiles and their values for that specific profile .

Parameters:

Returns:


Method: comparePackages

Description:
Returns a list for each kickstart profile; each list will contain package names not present on the other profile.

Parameters:

Returns:


Method: downloadKickstart

Description:
Download the full contents of a kickstart file.

Parameters:

Returns:


Method: downloadRenderedKickstart

Description:
Downloads the Cobbler-rendered Kickstart file.

Parameters:

Returns:


Method: getAdvancedOptions

Description:
Get advanced options for a kickstart profile.

Parameters:

Returns:


Method: getAvailableRepositories

Description:
Lists available OS repositories to associate with the provided kickstart profile.

Parameters:

Returns:


Method: getCfgPreservation

Description:
Get ks.cfg preservation option for a kickstart profile.

Parameters:

Returns:


Method: getChildChannels

Description:
Get the child channels for a kickstart profile.

Parameters:

Returns:


Method: getCustomOptions

Description:
Get custom options for a kickstart profile.

Parameters:

Returns:


Method: getKickstartTree

Description:
Get the kickstart tree for a kickstart profile.

Parameters:

Returns:


Method: getRepositories

Description:
Lists all OS repositories associated with provided kickstart profile.

Parameters:

Returns:


Method: getUpdateType

Description:
Get the update type for a kickstart profile.

Parameters:

Returns:


Method: getVariables

Description:
Returns a list of variables associated with the specified kickstart profile

Parameters:

Returns:


Method: getVirtualizationType

Description:
For given kickstart profile label returns label of virtualization type it's using

Parameters:

Returns:


Method: listIpRanges

Description:
List all ip ranges for a kickstart profile.

Parameters:

Returns:


Method: listScripts

Description:
List the pre and post scripts for a kickstart profile in the order they will run during the kickstart.

Parameters:

Returns:


Method: orderScripts

Description:
Change the order that kickstart scripts will run for this kickstart profile. Scripts will run in the order they appear in the array. There are three arrays, one for all pre scripts, one for the post scripts that run before registration and server actions happen, and one for post scripts that run after registration and server actions. All scripts must be included in one of these lists, as appropriate.

Parameters:

Returns:


Method: removeIpRange

Description:
Remove an ip range from a kickstart profile.

Parameters:

Returns:


Method: removeScript

Description:
Remove a script from a kickstart profile.

Parameters:

Returns:


Method: setAdvancedOptions

Description:
Set advanced options for a kickstart profile. If 'md5_crypt_rootpw' is set to 'True', 'root_pw' is taken as plaintext and will md5 encrypted on server side, otherwise a hash encoded password (according to the auth option) is expected

Parameters:

Returns:


Method: setCfgPreservation

Description:
Set ks.cfg preservation option for a kickstart profile.

Parameters:

Returns:


Method: setChildChannels

Description:
Set the child channels for a kickstart profile.

Parameters:

Returns:


Method: setCustomOptions

Description:
Set custom options for a kickstart profile.

Parameters:

Returns:


Method: setKickstartTree

Description:
Set the kickstart tree for a kickstart profile.

Parameters:

Returns:


Method: setLogging

Description:
Set logging options for a kickstart profile.

Parameters:

Returns:


Method: setRepositories

Description:
Associates OS repository to a kickstart profile.

Parameters:

Returns:


Method: setUpdateType

Description:
Set the update typefor a kickstart profile.

Parameters:

Returns:


Method: setVariables

Description:
Associates list of kickstart variables with the specified kickstart profile

Parameters:

Returns:


Method: setVirtualizationType

Description:
For given kickstart profile label sets its virtualization type.

Parameters:

Returns:


Generated on 3/4/2020