BuildMaster Documentation

General - SHEnsure

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

SHEnsure

Uses two shell scripts to Collect, and then Ensure a configuration about a server.

Script usage:

SHEnsure(
	Key: <text>,
	Value: <text>,
	[Collect: <text>],
	[Configure: <text>],
	[CollectScript: <text>],
	[ConfigureScript: <text>],
	[UseExitCode: <true/false>],
	[Verbose: <true/false>],
	[CollectScriptArgs: <text>],
	[ConfigureScriptArgs: <text>]
);

This operation may be prefixed with Linux::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
Configuration key
text
Key
This argument is required.
Expected value
text
Value
This argument is required.
Collection script
text
Collect
The output of this shell script will be used to collect the current configuration of the server.
Configure script
text
Configure
This shell script is executed if the configuration gathered using the collection script does not match the stored configuration.
Collection script asset
text
CollectScript
The name of a shell script asset to use for collection. The output of this script will be used to collect the current configuration of the server.
Configuration script asset
text
ConfigureScript
The name of a shell script asset to use for configuration. This script is executed if the configuration gathered using the collection script does not match the stored configuration.
Use exit code
true/false
UseExitCode
When set, the exit/return code of the script will be used instead of the output stream for collection.
Verbose
true/false
Verbose
When true, additional information about staging the script is written to the debug log.
Collection script arguments
text
CollectScriptArgs
Arguments to pass to the collect script.
Configure script arguments
text
ConfigureScriptArgs
Arguments to pass to the configure script.

Note: The Key is a unique string per server, and having multiple operations attempt to use the same key will yield in unpredictable behavior.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ced119d5 on master