kickstart.profile.system

Available methods

Description

Provides methods to set various properties of a kickstart profile.

Namespace:

kickstart.profile.system

Method: addFilePreservations

Description:

Adds the given list of file preservations to the specified kickstart profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

  • array :

    • string - filePreservations

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addKeys

Description:

Adds the given list of keys to the specified kickstart profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

  • array :

    • string - keyDescription

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: checkConfigManagement

Description:

Check the configuration management status for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • boolean enabled - true if configuration management is enabled; otherwise, false

Method: checkRemoteCommands

Description:

Check the remote commands status flag for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • boolean enabled - true if remote commands support is enabled; otherwise, false

Method: disableConfigManagement

Description:

Disables the configuration management flag in a kickstart profile so that a system created using this profile will be NOT be configuration capable.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: disableRemoteCommands

Description:

Disables the remote command flag in a kickstart profile so that a system created using this profile will be capable of running remote commands

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: enableConfigManagement

Description:

Enables the configuration management flag in a kickstart profile so that a system created using this profile will be configuration capable.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: enableRemoteCommands

Description:

Enables the remote command flag in a kickstart profile so that a system created using this profile will be capable of running remote commands

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getLocale

Description:

Retrieves the locale for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • struct - locale info

    • string "locale"

    • boolean "useUtc"

    • true - the hardware clock uses UTC

    • false - the hardware clock does not use UTC

Method: getPartitioningScheme

Description:

Get the partitioning scheme for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - The label of a kickstart profile.

Returns:

  • array :

    • string - A list of partitioning commands used to setup the partitions, logical volumes and volume groups

Method: getRegistrationType

Description:

returns the registration type of a given kickstart profile. Registration Type can be one of reactivation/deletion/none These types determine the behaviour of the registration when using this profile for reprovisioning.

Parameters:

  • string sessionKey

  • string kickstartLabel

Returns:

  • string registrationType

  • reactivation

  • deletion

  • none

Method: getSELinux

Description:

Retrieves the SELinux enforcing mode property of a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • string enforcingMode

  • enforcing

  • permissive

  • disabled

Method: listFilePreservations

Description:

Returns the set of all file preservations associated with the given kickstart profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

Returns:

  • array :

  • struct - file list

    • string "name"

    • array "file_names"

      • string - name

Method: listKeys

Description:

Returns the set of all keys associated with the given kickstart profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

Returns:

  • array :

    • struct - key

      • string "description"

      • string "type"

      • string "content"

Method: removeFilePreservations

Description:

Removes the given list of file preservations from the specified kickstart profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

  • array :

    • string - filePreservations

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeKeys

Description:

Removes the given list of keys from the specified kickstart profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

  • array :

    • string - keyDescription

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setLocale

Description:

Sets the locale for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string locale - the locale

  • boolean useUtc

  • true - the hardware clock uses UTC

  • false - the hardware clock does not use UTC

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setPartitioningScheme

Description:

Set the partitioning scheme for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - The label of the kickstart profile to update.

  • [.string[]]string[] scheme - The partitioning scheme is a list of partitioning command strings used to setup the partitions, volume groups and logical volumes.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setRegistrationType

Description:

Sets the registration type of a given kickstart profile. Registration Type can be one of reactivation/deletion/none These types determine the behaviour of the re registration when using this profile.

Parameters:

  • string sessionKey

  • string kickstartLabel

  • string registrationType

  • reactivation - to try and generate a reactivation key and use that to register the system when reprovisioning a system.

  • deletion - to try and delete the existing system profile and reregister the system being reprovisioned as new

  • none - to preserve the status quo and leave the current system as a duplicate on a reprovision.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setSELinux

Description:

Sets the SELinux enforcing mode property of a kickstart profile so that a system created using this profile will be have the appropriate SELinux enforcing mode.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string enforcingMode - the selinux enforcing mode

  • enforcing

  • permissive

  • disabled

Returns:

  • int - 1 on success, exception thrown otherwise.