com.dtolabs.rundeck.plugins.step

Interface RemoteScriptNodeStepPlugin

public interface RemoteScriptNodeStepPlugin

The plugin interface for a Remote Script Node Step Plugin.

Method Summary

Modifier and Type	Method and Description
GeneratedScript	generateScript(PluginStepContext context, java.util.Map<java.lang.String,java.lang.Object> configuration, INodeEntry entry) Generate a full script or command string to execute on the remote node
default boolean	hasAdditionalConfigVarGroupName() Additional Group name for config variables, other than 'config'

Method Detail

generateScript

GeneratedScript generateScript(PluginStepContext context,
                               java.util.Map<java.lang.String,java.lang.Object> configuration,
                               INodeEntry entry)
                        throws NodeStepException

Generate a full script or command string to execute on the remote node

Parameters:

context - the step context

configuration - Any configuration property values not otherwise applied to the plugin

entry - the Node

Returns:

the generated script

Throws:

NodeStepException - if an error occurs

hasAdditionalConfigVarGroupName

default boolean hasAdditionalConfigVarGroupName()

Additional Group name for config variables, other than 'config'

Returns:

true to include additional config var group 'nodestep'