( Return to API Overview )
- createProfile
- createProfileWithCustomUrl
- deleteProfile
- findKickstartForIp
- importFile
- importFile
- importRawFile
- listAllIpRanges
- listKickstartableChannels
- listKickstartableTrees
- listKickstarts
- renameProfile
Description
Provides methods to create kickstart files
Namespace:
kickstart
Description:
Import a kickstart profile into RHN.
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.
Description:
Import a kickstart profile into RHN.
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.
Description:
Delete a kickstart profile
Parameters:
-
string sessionKey
-
string ksLabel - The label of
the kickstart profile you want to remove
Returns:
-
int - 1 on successful deletion, 0 if kickstart wasn't found
or couldn't be deleted.
Description:
Find an associated kickstart for a given ip address.
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.
Description:
Import a kickstart profile into RHN.
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.
Description:
Import a kickstart profile into RHN.
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.
Description:
Import a raw kickstart file into satellite.
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.
Description:
List all Ip Ranges and their associated kickstarts available
in the user's org.
Parameters:
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
Description:
List kickstartable channels for the logged in user.
Parameters:
Returns:
-
array:
-
struct - channel
- int "id"
- string "name"
- string "label"
- string "arch_name"
- string "summary"
- string "description"
- string "maintainer_name"
- string "maintainer_email"
- string "maintainer_phone"
- string "support_policy"
- string "gpg_key_url"
- string "gpg_key_id"
- string "gpg_key_fp"
- string "end_of_life"
- string "parent_channel_label"
Description:
List the available kickstartable trees for the given channel.
Deprecated as of version - 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"
Description:
Provides a list of kickstart profiles visible to the user's
org
Parameters:
Returns:
-
array:
-
struct - kickstart
- string "label"
- string "tree_label"
- string "name"
- boolean "advanced_mode"
- boolean "org_default"
- boolean "active"
Description:
Rename a Kickstart Tree (Distribution) in Satellite
Parameters:
-
string sessionKey
-
string originalLabel - Label for the
kickstart tree you want to rename
-
string newLabel - new label to change too
Returns:
-
int - 1 on success, exception thrown otherwise.
Generated on 7/31/2009