1.4 Notes common to service templates

The following cautionary notes apply to the service templates provided by JP1/AO:

The locale setting applied at plug-in execution differs depending on the operating system on the operation-target device.

For Windows

The locale depends on the configuration of the operating system.

For UNIX

The following services are executed with the locale LANG=C :Characters might become garbled when these services are used with multi-byte characters.

Table 1‒8: List of services executed with LANG=C
Category	Service
Service templates for JP1 (configuration)	Add monitoring setting Delete monitoring setting Add JP1/Base monitoring settings Adding of a node to be monitored by JP1/Cm2 Deletion of nodes monitored by JP1/Cm2
Service templates for JP1 (operation)	Add operational user Change operational user Delete operational user JP1/AJS root jobnet migration Register JP1/AJS jobnet for execution Get JP1 events Get list of JP1/PFM monitoring targets Get list of JP1/PFM alarm information Get list of JP1/PFM process monitoring settings Obtain JP1/CM2 monitored node list Get list of JP1 users Get JP1 user mapping definition Batch change of operation users
Service templates for JP1 (reporting)	Get JP1/PFM report
Service templates for JP1 (troubleshooting)	Get JP1/AJS and JP1/Base logs Get JP1/IM and JP1/Base logs Changing of the JP1 event action status
Service templates for OS (operation)	Get list of OS users Get lists of OS users by batch

All other services use the default locale of the connected user.

When you execute a plug-in, certain commands must already be installed in the operating system of the operation-target device. For details, see the release notes.
If the operation target device is running UNIX, files are transferred from the device to the JP1/AO server in binary mode. For this reason, when a text file is transferred, the linefeed code is not converted to a code that is appropriate for Windows. Conversely, when you transfer a file from the JP1/AO server to the operation target device, make sure that the linefeed code in the file conforms to the specification of the OS of the device.
If the operation target device is running Windows and you specify an output file in a property of the service template, do not use the following reserved keywords as file names:

CON, PRN, AUX, CLOCK$, NUL, COM0, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9
(Local) in the property name indicates that the file or folder is located on the JP1/AO server. (Remote) means that the file or folder is on the operation target device.
If a service that uses an Email Notification Plug-in or User-Response Wait Plug-in to send email uses machine-dependent characters or characters that are incompatible with the character set assigned to the JP1/AO server and the operation-target device in the subject line or body of an email, characters are replaced with question marks (?) or other characters. In this scenario, either change the characters in the email, or change the encoding of the email.

The following characters might not be converted correctly:
To connect to an operation-target device, you need to define a Connection Destination. If the operation-target device is running Windows, specify Windows as the protocol. If the device is running UNIX, specify SSH.
If you execute multiple services concurrently on a given Hyper-V server, the command executed by JP1/AO might result in an error, causing the task to terminate abnormally. In this case, CommandExitCode:False is output to the task log and the plug-in returns code 27.
The content plug-ins provided by JP1/AO are set to be executed by automatically elevating the user's privileges to root permission. The exceptions are the following plug-ins, which are set to be executed without elevating the privileges of the user who connects to the operation-target device.
- Update cell data in a CSV/Excel file
- Acquisition of cell data from a CSV/Excel file
- Division of data from a CSV/Excel file
- Output OS type
- Calculating dates and times
- Start an Oracle DB instance
- Stop an Oracle DB instance
- Delete an Oracle DB user
- Add an Oracle DB user (UNIX)
The service templates provided by JP1/AO use content plug-ins that must be executed by a user with root permission. When you execute the content plug-ins that must be executed by a user with root permission, root elevation is performed by executing su command. That promote non-superuser users.

At this time, the superuser password is entered at the password prompt returned from the OS.

Therefore, if the OS of the operation-target device is UNIX, the following should be done.
- Enable root elevation on operation-target device.
- Enable the superuser on operation-target device.
- Set the superuser password on operation-target device.
- Set the user ID whose UID is not the same as superuser in the agentless connection definition.
  
  You can set superuser itself.
- Set the superuser password in the agentless connection definition.
A content plug-in might return a value outside the 0 to 63 range. For details about the meaning of return values outside this range, see Return values of content plug-ins in the JP1/Automatic Operation Service Template Developer's Guide.
Do not use the following multi-byte symbols in the properties of service templates and plug-ins:

In addition, do not insert line breaks in these properties.
The values you can specify in the properties of a service template depend on the data type. The range of values you can specify for each data type is shown below.

If the range of values you can specify for a property has been limited in your system, specify a value within that range.
- For string data
  
  1,024 characters
- For integer data
  
  -2147483648 to 2147483647
- For double data
  
  A numerical value from approximately ±4.9 × 10^-324 to ±1.7 × 10³⁰⁸
  
  Note that you cannot enter this value in the form of an exponent. We recommend that the value you specify has no more than 15 significant digits.
- For password data
  
  1,024 characters
- For composite data
  
  30 MB

When you use a user-defined character or surrogate pair character in an input value or input file of a property, characters might become garbled or might not be processed as the intended character.
The service templates that transfer a file between the operation-target device and JP1/AO server do not convert the character encoding of the file. Therefore, if the operation-target device and JP1/AO server use different character encodings, the encoding for the operation-target device must be used to reference the file.
If the operating system of the virtual server in the VMware vSphere environment is Red Hat Enterprise Linux Server 7 (64-bit x86_64), you must use open-vm-tools 9.10 or later for VMware Tools to be installed on the virtual server.
When PowerCLI V6.3 or later is used on the execution target server, commandlets executed by plug-ins might time out, causing the plug-in to end abnormally. To prevent this problem, execute the PowerCLI commandlet Set-PowerCLIConfiguration to change the timeout value. For details about commandlets, see Cmdlets Reference in the vSphere PowerCLI Documentation. Note that, even if a timeout occurs, the operation performed by the plug-in might have succeeded in the VMware environment. In this case, if you change the timeout value and then re-execute the service template, the processing of the service template might end abnormally. For this reason, check the VMware environment before re-executing the service template.

Conditions of occurrence:

This problem occurs when all of the following conditions are met:
- PowerCLI V6.3 or later is used on the execution target server.
- The following message is output to the task log.
  
  For PowerCLI V6.3:
```
The operation has timed out.
```
  For PowerCLI V6.5:
```
The request channel timed out attempting to send after 00:05:00. Increase the timeout value passed to the call to Request or increase the SendTimeout value on the Binding. The time allotted to this operation may have been a portion of a longer timeout.
```
Workaround:

Perform the following procedure.
1. Launch the PowerShell prompt.
  
  Select Start, VMware, and then VMware vSphere PowerCLI.
2. Check the PowerCLI settings.
  
  In the PowerCLI prompt, execute the following commandlet.
```
PowerCLI C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI>Get-PowerCLIConfiguration
```
3. Change the PowerCLI settings.
  
  In the PowerCLI prompt, execute the following commandlet.
```
PowerCLI C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI>Set-PowerCLIConfiguration -WebOperationTimeoutSeconds timeout-value
```
  Note: Specify the timeout value in units of seconds. For example, to set a timeout value of 10 minutes, specify 600.
4. Execute the target service from JP1/AO.
When executing the file transfer plug-in or the content plug-in with the script set, use SCP to transfer the file to the operation-target device. Make sure that the operation-target device has an environment in which files can be transferred using SCP. Note that if the operation-target device is Linux and a character string is output from .bashrc of the connecting user, SCP might become fail. Note that the following parts correspond to "the content plug-in with the script set".
- The JP1/AO standard-package Content plug-ins and JP1/AO Content Pack plug-ins other than the following plug-ins.
  - Shutdown Server (osShutdownServer)
  - Restart Server (osRebootServer)
- The plug-in that a user created (when Script is selected for the execution method)
For vSphere-related plug-ins and service templates, the OS for the prerequisite products for the execution target-server is Windows Server 2019, use JP1/Automatic Operation 12-10-01 or later as the prerequisite product in the system.
When connecting to the Connection Destination using SSH or Telnet, do not include commands such as stty, tty, tset, and script that require an interactive environment in the login script of the connecting user. If so, change the login script or create a new user who uses the login script that does not execute these commands.

To Page Top