Top
Systemwalker Runbook Automation Operation Guide
Systemwalker

3.4 Developing Operation Components

If you cannot develop an Automated Operation Process using the following two types of operation components, develop new operation components:

In Systemwalker Runbook Automation Studio, developed operation components are used as operation component nodes.

Languages that can be used

When creating operation components, create script files written in either of the following languages:

Development method

Create a script file using an environment such as an external Ruby development environment or Perl development environment, or by using the text editor.

In the script file, write the script that is used below.

Note

A library provided by the product cannot be used as an operation component.

Character code

The character code used when a script is executed will be the character code set in the Systemwalker Runbook Automation operating environment.

The character code used for the input and output information of a script will be UTF-8. When you are using a library which performs extraction of input information, the input information will be converted according to the operating environment in the library. When you want to output the results to standard output or standard error output, you must set up character strings that have been converted to UTF-8.

Common functions

Timeout and retry of the execution of operation components are common functions of operation components that can be enabled.

Defining the options shown below will enable these extended options for input information.

Input information

Configure the values specified in the operation component input information in an XML format input information file and pass as arguments when executing the operation component. Use the library for extracting input information (input information library) to extract the input information from the input information file of the operation component.

When configuring the hostname option as input information for the operation component, the input information library passes the following information as input information. For the searched Configuration Management Database (CMDB), refer to the "2.1.7 Registering Connection Information to Operation Target Servers".

Option name

Description

hostname

If the IP address is specified in the hostname option, search the Configuration Management Database (CMDB) for the specified value and pass the retrieved host name.
This will be nil if no value is registered in the CMDB.

If the host name is specified in the hostname option, pass the specified host name.

ipaddress

If the host name is specified in the hostname option, search the Configuration Management Database (CMDB) for the specified value and pass the retrieved IP address.
This will be nil if no value is registered in the CMDB.

If the IP address is specified in the hostname option, pass this IP address.

ostype

Pass the value below if the ostype option has not been configured as input information for the operation component, or if the value of ostype option has been omitted altogether.

  • Search the Configuration Management Database (CMDB) for either the host name or IP address specified in the hostname option and pass the retrieved OS type. This will be nil if no value is registered in the CMDB.

If a value is specified in the ostype option, pass this value.

username

If one of the conditions below is satisfied, search the Configuration Management Database (CMDB) for either the host name or IP address specified in the hostname option and pass the retrieved connection user name.
This will be nil if no value is registered in the CMDB.

  • The username option and password option are not configured as input information of the operation component

or

  • The both username option and password option have not been specified.

If a value is specified in either the username option, pass the value specified in the username option.

If the value of user option has been omitted and the value of password option is specified, the connection user name will be nil.

password

If one of the conditions below is satisfied, search the Configuration Management Database (CMDB) for either the host name or IP address specified in the hostname option and the pass retrieved the connection user password.
This will be nil if no value is registered in the CMDB.

  • The username option and password option are not configured as input information of the operation component

or

  • The both username option and password option have not been specified.

If a value is specified in the password option, pass the connection user password specified in the password option.

If the value of password option has been omitted and the value of username option is specified, the connection user password will be nil.

execusername

If one of the conditions below is satisfied, search the Configuration Management Database (CMDB) for either the host name or IP address specified in the hostname option and pass the retrieved executed user name.
This will be nil if no value is registered in the CMDB.

  • The execusername option and execpassword option are not configured as input information of the operation component

or

  • The both execusername option and execpassword option have not been specified.

If a value is specified in either the execusername option, pass the executed user name specified in the execusername option.

If the value of execusername option has been omitted and the value of execpassword option is specified, the executed user name will be nil.

execpassword

If one of the conditions below is satisfied, search the Configuration Management Database (CMDB) for either the host name or IP address specified in the hostname option and pass the retrieved executed user password.
This will be nil if no value is registered in the CMDB.

  • The execusername option and execpassword option are not configured as input information of the operation component

or

  • The both execusername option and execpassword option have not been specified.

If a value is specified in the execpassword option, pass the executed user password specified in the execpassword option.

If the value of execpassword option has been omitted and the value of execusername option is specified, the executed user password will be nil.

native_hostname

Pass the value specified in the hostname option.

Note

Ensure the name options below are not set in the input information when configuring the hostname option as input information of the operation component. These options value can be used the value passed from input information library with setting hostname option as input information of the operation component.

  • ipaddress option

  • native_hostname option