Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Developer's Guide 


6.3.6 Reserved plug-in properties for specifying execution-target hosts and authentication information

A reserved plug-in property is a plug-in property whose property key and intended use are predefined in the JP1/AO system.

The names of reserved plug-in properties start with plugin.. Reserved plug-in properties are created automatically in the Input Properties area of the following dialog boxes:

Reserved plug-in properties are only valid in the context of the plug-in for which they are defined.

Although you can edit some aspects of a reserved plug-in property, other aspects such as the property key and whether certain parameters are mandatory cannot be changed. You cannot delete a reserved plug-in property.

Reserved plug-in property for specifying execution-target hosts

The reserved plug-in property shown in the following table is automatically created to specify the execution-target host.

Table 6‒11: Reserved plug-in property for specifying the execution-target host

Property key

Description

plugin.destinationHost

Specify the target host of an operation by IPv4 address, IPv6 address, or host name. You must specify a target host in a network configuration in which the JP1/AO server and the command execution environment can communicate directly with each other. However, if the OS on the JP1/AO server is Linux and the OS on the operation target device is Windows, you cannot specify an IPv6 address for the connection destination.

You can specify a value from 1 to 256 characters long.

Reserved plug-in property for specifying authentication information

As the credential type of a plug-in, for the Credential Type option on the Remote Command tab of the Create Custom Plug-in or Edit Custom Plug-in dialog box, select Shared agentless setting or Service input property.

Shared agentless setting

Select this option to use the authentication information set in the Agentless Remote Connections area. When you select this option, JP1/AO uses the authentication information specified in the connection destination definition for Windows, SSH, or Telnet connections, depending on the operation-target host.

Service input property

Select this option to use the authentication information specified in a property.

When you select Service input property, the reserved plug-in properties shown in the following table are automatically created in the list of input properties in the Create Custom Plug-in dialog box or Edit Custom Plug-in dialog box. Note that if local execution function is enabled and the execution host is the local host, these settings are ignored.

Table 6‒12: Reserved plug-in properties for specifying authentication information

Property key

Description

plugin.account

Specify the user ID for logging in to the target host in 1 to 256 characters.

plugin.password

Specify the password for logging in to the target host in 1 to 256 characters.

If true is specified for the plugin.publicKeyAuthentication reserved plug-in property, JP1/AO ignores the value set for the plugin.password property.

plugin.suPassword

Specify the password of the root account used to log in to a target host in a UNIX environment, using 1 to 256 characters.

The root password you specify is ignored in the following circumstances:

  • The target host is running Windows.

  • The Execute with root privileges check box is not selected in the Create Custom Plug-in dialog box or the Edit Custom Plug-in dialog box.

plugin.publicKeyAuthentication

This property specifies whether to use public key authentication for SSH connections to target hosts in UNIX environments. If you do not specify a value, false is the default value.

  • true

    Specify this value to use public key authentication.

  • false

    Specify this value to not use public key authentication.#

plugin.keyboardInteractiveAuthentication

This property specifies whether to use keyboard interactive authentication for SSH connections to target hosts in UNIX environments. If you do not specify a value, false is the default value.

Note that the value for plugin.keyboardInteractiveAuthentication is enabled only when false is specified for plugin.publicKeyAuthentication. If true is specified for plugin.publicKeyAuthentication, public key authentication is set even if true is specified for plugin.keyboardInteractiveAuthentication.

  • true

    Specify this value to use keyboard interactive authentication.

  • false

    Specify this value to not use keyboard interactive authentication.#

#

If you specify false for both plugin.publicKeyAuthentication and plugin.keyboardInteractiveAuthentication properties, password authentication is set.