Create a probe activity

Create an activity that runs a probe on the target host that is configured to return specific information..

Before you begin

Role required: activity_creator or workflow_admin

About this task

For instructions on using the activity template process flow, see create custom activities.

Procedure

  1. Create a custom activity.
    This action creates a custom activity using a template.
  2. After setting up general properties and creating input variables, configure the Probe Execution Command:
    OptionDescription
    Map the input variables Use the variables you created to configure the command that Orchestration executes.
    Probe Probe to run with this activity, from the list of probes in the system
    Target host Host name or IP address of the target server for this activity.
    Parameters MID Server to use, by capabilities.
    Required MID Server capabilities Name-value pairs to pass to the host with this probe. You can create these parameters manually, or drag and drop input variables into the parameter fields and assign a value.
    Note: You can map parameter values in a test payload to variables in the Outputs tab automatically. See automap output variables.

What to do next

Probe template execution parameters

You use execution parameters to create the input process script in the Pre Processing form.

For descriptions of the command fields, see Configure the Probe execution command.
Note: You must use the executionParam. prefix with all variables in this table.
Table 1. Probe activity execution parameters
Name Variable Type Usage
Probe probe Reference The sys_id of the MID Server probe.
Source source String Intended target host
Parameters parameters Array of JS object Array of JavaScript objects, expressed with the executionParam. prefix. To add more name-value pairs to the parameters array, append them to the existing array. Create a JavaScript object with the following syntax, and add it to the executionParam.parameter array. This assigns additional parameters to the message:
var newParameter = {"name":"parameterName","value":"parameterValue"}; executionParam.parameters.push(newParameter);
MidCapabilities midCapabilities String (comma separated) List of required MID server capabilities.
ValueCapabilities valueCapabilities Array of hashmap Capability values used to select the MID Server. For more information, see Set up domain separation for MID servers. If there are additional capabilities that are assigned by value, use this example to customize the MID Server selection:
var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);

Probe template post-processing parameters

Use these parameters to create a post-processing script.

Table 2. Probe post-processing parameters
Name Variable Type Usage
Payload payload String Contains raw payload returned from the probe.
Output output String Contains output data returned from the probe.
EccSysId eccSysId String Contains the reference ID associated with the ECC Queue input message.

Configure the Probe execution command

Use the input variables you created to configure the command that Orchestration executes on the target.

Before you begin

Create the input variables you need in the Inputs form before you can advance to the Execution Command stage.

Role required: activity_creator, admin

Note: You can test the activity connection between the MID Server and the target without having to run the acvitity in a workflow context. For details, see test template outputs.

Procedure

  1. Drag variables from the list of inputs and drop them into command fields.
    The system formats the variable in the proper syntax for the command.
    Figure 1. Probe execution command
    Probe execution command
  2. Complete the fields shown in the table.
    Table 3. Probe execution command fields
    Field Description
    Input Input variable builder. Create input variables to map to available fields.
    Probe Probe to run with this activity, from the list of probes in the system.
    Target host Host name or IP address of the target server for this activity.
    Required MID Server capabilities MID Server to use, by capabilities.
    Parameters Name-value pairs to pass to the host with this probe. You can create these parameters manually, or drag and drop input variables into the parameter fields and assign a value.
  3. Click Save.
  4. Click Continue to advance to the Outputs stage.