Create/Edit Custom Plug-in dialog box

Ops Center Automator Service Builder User Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99AUT002-18

When you create a new plug-in, you provide the details from the General, Property, or Remote Command tabs in the Create/Edit Custom Plug-in dialog box.

General Tab

From the General tab, you can view and edit general details for the selected service template.

The following table describes the options available from the General tab.

When you enter information in a dialog box, if the information is incorrect, errors include a description of the problem at the right side of the box.

Field Subfield Description
Key Name * - Key name for the plug-in (up to 64 characters). The combination of the Key Name and Vendor ID cannot exceed 115 characters.
Version * - Version number of the plug-in.
Vendor ID * - Vendor ID of the plug-in (up to 64 characters). The combination of the ID and Vendor ID cannot exceed 115 characters.
Display Name - Name of the plug-in (up to 64 characters).
Vendor Name - Vendor name of the plug-in (up to 64 characters).
Description - Brief description of the plug-in (up to 1,024 characters).
Tags - Assigned Tag category for the plug-in. Click the Plus Sign to add tag categories.
Icon -

Specifies the icon graphic (a 48 pixels × 48 pixels PNG file) associated with the plug-in.

To change the default image provided, click Change and enter the graphic file name. You can revert to the original icon anytime by choosing Restore Default Icon.

Fields marked with an asterisk (*) are required.

Property Tab

From the Property tab, you can search for and view the input and output properties for a service template. You can search for a property with the text search box. Click input or output (next to search box), to switch between the lists for input and output properties. You can also edit a property by clicking the pencil icon.

The following table describes the options available from the Property tab.

Field Subfield Description
Key Name - Displays the key associated with the property.
Display Name - Displays the name associated with the property.
Description - Gives a description for the property.
Required - Indicates whether the property is required (true) or (false).
Default Value - Specifies default values if required.

Remote Command Tab

From the Remote Command tab, you can set up remote commands that run during the processing of a service template.

To add a remote command, click Add Platform and then provide the details for the OS environment.

The following table describes the options available from the Remote Command tab.

When you enter information in a dialog box, if the information is incorrect, errors include a description of the problem at the right side of the box.

Field Subfield Description
Credential Type - Specifies the credential type required for the plug-in.

To use the credential information in the agentless remote connections view under the Ops Center Automator Administration tab when the service runs, select Shared agentless setting.

Shared agentless setting is the default Credential Type.

The following reserved plug-in property is automatically set for the shared agentless setting credential type:

  • plugin.destinationHost

    Enter the target of an action with an IPv4 address, IPv6 address, or host name (up to 256 characters).

To use the credential information as an input property, select Service input property.

The following reserved plug-in properties are automatically set for the Service input property credential type:

  • plugin.destinationHost

    Enter the target of an action with an IPv4 address, IPv6 address, or host name (up to 256 characters). If the destination host is the Ops Center Automator Server (localhost), the user ID and the password are not necessary.
  • plugin.account

    Enter the user ID for logging on to the target host (up to 256 characters).
  • plugin.password

    Enter the password for logging io to the target host (up to 256 characters).
  • plugin.suPassword

    Enter the password of the root account used for logging on to a target host in a Linux OS environment (up to 245 characters). If the target host is running the Windows OS, this property is ignored.
Windows Options Run as system account Runs the command using the system account.
Linux/UNIX Options Execute with root privileges Runs with root privileges.
Character Set Auto Judgment Character Set Auto Judgment applies to the Linux OS. If enabled, the script runs using the default locale of the user. If disabled, the script runs with the LC_ALL=C locale. The default is enabled.
Add Platform - Specifies the platform for the remote command (Windows or Linux platform).
Import Settings - Specifies to obtain the settings from another OS.
Execution Method: - Select Script name if based on a script, or CLI Command if using a stored command.
CLI Command: * - Enter the CLI command (up to 8,192 characters) for the remote command. This is required if you choose Script name or CLI Command for the Execution Method. Use Insert All Input Properties to insert all input properties defined for the plug-in to the command.
Type in: - Select By attachment if uploading a script file, or Type in to directly enter the script information.

Use the following file format for a plug-in that runs a script: name-of-plug-in.extension.

File* - Click Browse to specify the file that contains the command or script.
Mapping Definition of Output Properties - Specify the mapping definition of the output property for a command or script. Select and highlight a property in the list and then click Edit to access the Edit Output Filter dialog box where you can specify an output filter that controls the data that is passed to the output property.
Execution Directory - Specify the folder in which the command or script runs.
Environment Variables - Select environment variables for the command or script as required. The Create/Edit Environment Variable dialog box appears for you to enter the variable information.
Fields marked with an asterisk (*) are required.