kickstart.profile.system

Available methods

Description

Provides methods to set various properties of a kickstart profile.

Namespace:

kickstart.profile.system

Method: addFilePreservations

HTTP POST

Description:

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

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string array filePreservations - the list identifying the file preservations to add

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addKeys

HTTP POST

Description:

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

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string array descriptions - the list identifying the keys to add

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: checkConfigManagement

HTTP POST

Description:

Check the configuration management status for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

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

Method: checkRemoteCommands

HTTP POST

Description:

Check the remote commands status flag for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

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

Method: disableConfigManagement

HTTP POST

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

HTTP POST

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

HTTP POST

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

HTTP POST

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

HTTP GET

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

HTTP GET

Description:

Get the partitioning scheme for a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the label of a kickstart profile

Returns:

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

Method: getRegistrationType

HTTP POST

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 ksLabel - the kickstart profile label

Returns:

  • string the registration type

    • reactivation

    • deletion

    • none

Method: getSELinux

HTTP GET

Description:

Retrieves the SELinux enforcing mode property of a kickstart profile.

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • string enforcing mode

    • enforcing

    • permissive

    • disabled

Method: listFilePreservations

HTTP GET

Description:

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

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • array :

  • struct file list

    • string "name"

    • string array "file_names" - the list of file names

Method: listKeys

HTTP GET

Description:

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

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

Returns:

  • array :

    • struct key

      • string "description"

      • string "type"

      • string "content"

Method: removeFilePreservations

HTTP POST

Description:

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

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string array filePreservations - the list identifying the file preservations to add

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeKeys

HTTP POST

Description:

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

Parameters:

  • string sessionKey

  • string ksLabel - the kickstart profile label

  • string array descriptions - the list identifying the keys to remove

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setLocale

HTTP POST

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

HTTP POST

Description:

Set the partitioning scheme for a kickstart profile.

Parameters:

  • string sessionKey

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

  • string array 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

HTTP POST

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 ksLabel - the kickstart profile label

  • 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

HTTP POST

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.