Copy Custom Plug-in dialog box

Ops Center Automator Service Builder User Guide

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

Use the Copy Custom Plug-in dialog box to provide the details when copying a plug-in.

The following tables describe the dialog box fields, subfields, and field groups that are available based on the tab that is currently selected. A field group is a collection of fields that are related to a specific action or configuration.

From the General tab, you can view and enter the following details on the selected plug-in.

Field Subfield Description
Key Name: * - Specifies the key name for the copied plug-in.
Version * - Version of the plug-in.
Vendor ID: * - Vendor ID assigned to the plug-in.
Display Name: * - Plug-in name that is shown in the user interface.
Vendor Name: - Vendor name, if applicable, for copied plug-in.
Description: - Description of the copied plug-in.
Tags: - Tag category associated with the plug-in.
Icon: - Icon associated with the plug-in.
Fields marked with an asterisk (*) are required.

When making a copy of a plug-in, change the Key Name or Vendor ID to differentiate the copied version from the original.

From the Property tab, you can search for and view all the input and output properties associated with the selected plug-in. You also have the option of managing the properties by clicking one of the options. For example, you can add a new input or output property by choosing Add, edit an existing property by selecting Edit, or delete a selected property by selecting Delete.

Field Subfield Description
Key Name - Specifies the key name for the input or output property.
Display Name - Specifies the display name for the input or output property.
Description - Shows a description of the input or output property and its function.
Required - Indicates if the input or output property is required (true) or not (false).
Default Value - Indicates any default value that is associated with the input or output property.

From the Remote Command tab, choose the platform from which to run the remote command by selecting an option from the Add Platform menu. You can also specify the Credential Type by choosing either Shared agentless setting or Service input property. Other options for controlling how to run the remote command depend on the selected platform.

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

Select Shared agentless setting if you use the credential information in the agentless remote connections view under the Ops Center Automator Administration tab when the service is run. 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 a process by IPv4 address, IPv6 address, or host name (up to 256 characters).

Select Service input property to use the credential information as an input property.

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

  • plugin.destinationHost

    Enter the target of a process by IPv4 address, IPv6 address, or host name (up to 256 characters). If the destination host is 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 on 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 on 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 that the settings are imported 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. Required if Script name or CLI Command is selected for Execution Method. Insert All Input Properties inserts all input properties defined for the plug-in to the command.
Script specification method: - Select 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 holds the command or script.
Mapping Definition of Output Properties -

Specify the mapping definition of the output property for a command or script. By selecting and highlighting a property in the list and then clicking the pencil icon, you can 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 from which the command runs.
Environment Variables - Select environment variables for the command or script. When selecting this option, the Create/Edit Environment Variable dialog box appears where you can enter the required variable information.

Fields marked with an asterisk (*) are required.