actionchain

Available methods

Description

Provides the namespace for the Action Chain methods.

Namespace:

actionchain

Method: addConfigurationDeployment

HTTP POST

Description:

Adds an action to deploy a configuration file to an Action Chain.

Parameters:

  • string sessionKey

  • string chainLabel - Label of the chain

  • int sid - System ID

  • array revisionSpecifiers

    • struct config revision specifier

      • string "channelLabel" - Channel label

      • string "filePath" - Path of the configuration file

      • int "revision" - Revision number

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addErrataUpdate

HTTP POST

Description:

Adds Errata update to an Action Chain.

Parameters:

  • string sessionKey

  • int sid - System ID

  • int array errataIds - Errata ID

  • string chainLabel - Label of the chain

Returns:

  • int actionId - The action id of the scheduled action

Method: addErrataUpdate

HTTP POST

Description:

Adds Errata update to an Action Chain.

Parameters:

  • string sessionKey

  • int array sids - System IDs

  • int array errataIds - Errata ID

  • string chainLabel - Label of the chain

Returns:

  • int actionId - The action id of the scheduled action

Method: addErrataUpdate

HTTP POST

Description:

Adds Errata update to an Action Chain.

Parameters:

  • string sessionKey

  • int array sids - System IDs

  • int array errataIds - Errata ID

  • string chainLabel - Label of the chain

  • boolean onlyRelevant - If true, InvalidErrataException is thrown if an errata does not apply to a system.

Returns:

  • int actionId - The action ID of the scheduled action

Method: addPackageInstall

HTTP POST

Description:

Adds package installation action to an Action Chain.

Parameters:

  • string sessionKey

  • int sid - System ID

  • int array packageIds

  • string chainLabel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addPackageRemoval

HTTP POST

Description:

Adds an action to remove installed packages on the system to an Action Chain.

Parameters:

  • string sessionKey

  • int sid - System ID

  • int array packageIds

  • string chainLabel - Label of the chain

Returns:

  • int actionId - The action id of the scheduled action or exception

Method: addPackageUpgrade

HTTP POST

Description:

Adds an action to upgrade installed packages on the system to an Action Chain.

Parameters:

  • string sessionKey

  • int sid - System ID

  • int array packageIds

  • string chainLabel - Label of the chain

Returns:

  • int actionId - The id of the action or throw an exception

Method: addPackageVerify

HTTP POST

Description:

Adds an action to verify installed packages on the system to an Action Chain.

Parameters:

  • string sessionKey

  • int sid - System ID

  • int array packageIds

  • string chainLabel - Label of the chain

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addScriptRun

HTTP POST

Description:

Add an action with label to run a script to an Action Chain. NOTE: The script body must be Base64 encoded!

Parameters:

  • string sessionKey

  • int sid - System ID

  • string chainLabel - Label of the chain

  • string scriptLabel - Label of the script

  • string uid - User ID on the particular system

  • string gid - Group ID on the particular system

  • int timeout - Timeout

  • string scriptBody - Base64 encoded script body

Returns:

  • int actionId - The id of the action or throw an exception

Method: addScriptRun

HTTP POST

Description:

Add an action to run a script to an Action Chain. NOTE: The script body must be Base64 encoded!

Parameters:

  • string sessionKey

  • int sid - System ID

  • string chainLabel - Label of the chain

  • string uid - User ID on the particular system

  • string gid - Group ID on the particular system

  • int timeout - Timeout

  • string scriptBody - Base64 encoded script body

Returns:

  • int actionId - The id of the action or throw an exception

Method: addSystemReboot

HTTP POST

Description:

Add system reboot to an Action Chain.

Parameters:

  • string sessionKey

  • int sid - System ID

  • string chainLabel - Label of the chain

Returns:

  • int actionId - The action id of the scheduled action

Method: createChain

HTTP POST

Description:

Create an Action Chain.

Parameters:

  • string sessionKey

  • string chainLabel - Label of the chain

Returns:

  • int actionId - The ID of the created action chain

Method: deleteChain

HTTP POST

Description:

Delete action chain by label.

Parameters:

  • string sessionKey

  • string chainLabel - Label of the chain

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listChainActions

HTTP GET

Description:

List all actions in the particular Action Chain.

Parameters:

  • string sessionKey

  • string chainLabel - Label of the chain

Returns:

  • array :

    • struct entry

      • int "id" - Action ID

      • string "label" - Label of an Action

      • string "created" - Created date/time

      • string "earliest" - Earliest scheduled date/time

      • string "type" - Type of the action

      • string "modified" - Modified date/time

      • string "cuid" - Creator UID

Method: listChains

HTTP GET

Description:

List currently available action chains.

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct chain

      • string "label" - Label of an Action Chain

      • string "entrycount" - Number of entries in the Action Chain

Method: removeAction

HTTP POST

Description:

Remove an action from an Action Chain.

Parameters:

  • string sessionKey

  • string chainLabel - Label of the chain

  • int actionId - Action ID

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: renameChain

HTTP POST

Description:

Rename an Action Chain.

Parameters:

  • string sessionKey

  • string previousLabel - Previous chain label

  • string newLabel - New chain label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: scheduleChain

HTTP POST

Description:

Schedule the Action Chain so that its actions will actually occur.

Parameters:

  • string sessionKey

  • string chainLabel - Label of the chain

  • dateTime.iso8601 date - Earliest date

Returns:

  • int - 1 on success, exception thrown otherwise.