Showing content from http://spacewalkproject.github.io/documentation/api/2.10/handlers/ActionChainHandler.html below:
( Return to API Overview ) Available methods
- addConfigurationDeployment
- addErrataUpdate
- addPackageInstall
- addPackageRemoval
- addPackageUpgrade
- addPackageVerify
- addScriptRun
- addSystemReboot
- createChain
- deleteChain
- listChainActions
- listChains
- removeAction
- renameChain
- scheduleChain
Description Provides the namespace for the Action Chain methods.
Namespace: actionchain
Method: addConfigurationDeployment Description:
Adds an action to deploy a configuration file to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- string chainLabel - Label of the chain
- int System ID - System ID
- array:
Returns:
- int - 1 on success, exception thrown otherwise.
Method: addErrataUpdate Description:
Adds Errata update to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- int serverId - System ID
- array:
- string chainLabel - Label of the chain
Returns:
- int actionId - The action id of the scheduled action
Method: addPackageInstall Description:
Adds package installation action to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- int serverId - System ID
- array:
- string chainLabel
Returns:
- int - 1 on success, exception thrown otherwise.
Method: addPackageRemoval Description:
Adds an action to remove installed packages on the system to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- int serverId - System ID
- array:
- string chainLabel - Label of the chain
Returns:
- int actionId - The action id of the scheduled action or exception
Method: addPackageUpgrade Description:
Adds an action to upgrade installed packages on the system to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- int serverId - System ID
- array:
- string chainLabel - Label of the chain
Returns:
- int actionId - The id of the action or throw an exception
Method: addPackageVerify Description:
Adds an action to verify installed packages on the system to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- int serverId - System ID
- array:
- string chainLabel - Label of the chain
Returns:
- int - 1 on success, exception thrown otherwise.
Method: addScriptRun Description:
Add an action to run a script to an Action Chain. NOTE: The script body must be Base64 encoded! Parameters:
- string sessionKey - Session token, issued at login
- int serverId - 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 scriptBodyBase64 - Base64 encoded script body
Returns:
- int actionId - The id of the action or throw an exception
Method: addSystemReboot Description:
Add system reboot to an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- int serverId
- string chainLabel - Label of the chain
Returns:
- int actionId - The action id of the scheduled action
Method: createChain Description:
Create an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- string chainLabel - Label of the chain
Returns:
- int actionId - The ID of the created action chain
Method: deleteChain Description:
Delete action chain by label. Parameters:
- string sessionKey - Session token, issued at login
- string chainLabel - Label of the chain
Returns:
- int - 1 on success, exception thrown otherwise.
Method: listChainActions Description:
List all actions in the particular Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- 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 Description:
List currently available action chains. Parameters:
- string sessionKey - Session token, issued at login
Returns:
- array:
- struct - chain
- string "label" - Label of an Action Chain
- string "entrycount" - Number of entries in the Action Chain
Method: removeAction Description:
Remove an action from an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- string chainLabel - Label of the chain
- int actionId - Action ID
Returns:
- int - 1 on success, exception thrown otherwise.
Method: renameChain Description:
Rename an Action Chain. Parameters:
- string sessionKey - Session token, issued at login
- string previousLabel - Previous chain label
- string newLabel - New chain label
Returns:
- int - 1 on success, exception thrown otherwise.
Method: scheduleChain Description:
Schedule the Action Chain so that its actions will actually occur. Parameters:
- string sessionKey - Session token, issued at login
- string chainLabel - Label of the chain
- dateTime.iso8601 Earliest date
Returns:
- int - 1 on success, exception thrown otherwise.
Generated on 3/4/2020
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4