Hitachi

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


4.3.4 Overview of shared built-in service properties

Shared built-in service properties are properties that are predefined in the JP1/AO system. Unlike other properties, shared built-in service properties are not tied to a specific service or task. JP1/AO functions that reference shared built-in service properties use the value assigned to the property when they execute.

You can also define a shared built-in service property as a service share property of a service, and reference it from within a task. In this case, the values while services are executed are referenced in the same manner as other service share properties.

You can define a shared built-in service property as a service share property of a service in the Property tab of the Service Builder Edit window. If you select Add > Service Share Property in the Property tab of the Service Builder Edit window, a list of shared built-in service properties appears.

The following table lists the shared built-in service properties provided in JP1/AO.

Table 4‒26: List of shared built-in service properties

No.

Property key

Property name#

Description#

1

com.hitachi.software.dna.sys.mail.notify

Email notification

Enables or disables the email notification functionality. (Built-in shared service property)

2

com.hitachi.software.dna.sys.mail.smtp.server

SMTP server address

Specifies the SMTP server address. The address can be specified as an IPv4 or IPv6 address, or as a host name. Only one of the above can be specified. Multiple addresses cannot be specified by separating them with commas. (Built-in shared service property)

3

com.hitachi.software.dna.sys.mail.smtp.port

SMTP server port number

Specifies the SMTP server port number. (Built-in shared service property)

4

com.hitachi.software.dna.sys.mail.smtp.userid

SMTP server user ID

Specifies the user ID of the user who logs in to the SMTP server. (Built-in shared service property)

5

com.hitachi.software.dna.sys.mail.smtp.password

SMTP server password

Specifies the password of the user who logs in to the SMTP server. (Built-in shared service property)

6

com.hitachi.software.dna.sys.mail.from

Notification email sender

Specifies the sender of notification emails. (Built-in shared service property)

7

com.hitachi.software.dna.sys.mail.to

Notification email recipients (To)

Specifies the "To" recipients of notification emails. Multiple email addresses can be specified by separating them with commas. (Built-in shared service property)

8

com.hitachi.software.dna.sys.mail.cc

Notification email recipients (Cc)

Specifies the "Cc" recipients of notification emails. Multiple email addresses can be specified by separating them with commas. (Built-in shared service property)

9

com.hitachi.software.dna.sys.mail.bcc

Notification email recipients (Bcc)

Specifies the "Bcc" recipients of notification emails. Multiple email addresses can be specified by separating them with commas. (Built-in shared service property)

10

com.hitachi.software.dna.sys.task.log.level

Task log output level

Specifies the level of messages output to the task log. (Built-in shared service property)

11

com.hitachi.software.dna.sys.ssh.privatekey.passphrase

Pass phrase of the private key (for SSH public key authentication)

Specifies the pass phrase of the private key used for SSH public key authentication. (Built-in shared service property)

#

You can change the contents of the Create Service dialog box by entering a property name and description of your choice for the built-in shared service property. However, the information displayed in the Shared Properties Settings area is not changed from its initial state at installation.

The following table describes detailed information about each property.

Table 4‒27: Detailed information about shared built-in service properties

No.

Property key

Data type

Default value

Required?

Length

Specifiable characters

Presentation

Values in list

Minimum

Maximum

1

com.hitachi.software.dna.sys.mail.notify

boolean

false

true

--

--

--

Selection

--

2

com.hitachi.software.dna.sys.mail.smtp.server

string

--

false

0

255

No restrictions

Text Box

--

3

com.hitachi.software.dna.sys.mail.smtp.port

integer

25

true

0

65535

--

Text Box

--

4

com.hitachi.software.dna.sys.mail.smtp.userid

string

--

false

0

255

No restrictions

Text Box

--

5

com.hitachi.software.dna.sys.mail.smtp.password

password

--

false

0

1,024

No restrictions

Password

--

6

com.hitachi.software.dna.sys.mail.from

string

--

false

0

255

No restrictions

Text Box

--

7

com.hitachi.software.dna.sys.mail.to

string

--

false

0

255

No restrictions

Text Box

--

8

com.hitachi.software.dna.sys.mail.cc

string

--

false

0

255

No restrictions

Text Box

--

9

com.hitachi.software.dna.sys.mail.bcc

string

--

false

0

255

No restrictions

Text Box

--

10

com.hitachi.software.dna.sys.task.log.level

string

10

true

--

--

--

Selection

0,10,20,30,40

11

com.hitachi.software.dna.sys.ssh.privatekey.passphrase

password

--

false

0

1,024

No restrictions

Password

--

Legend:

--: Not applicable.