5. Collect function¶

5.1. Introduction¶

This document aims to explain how to use the ITA Collect function.

5.2. Collect function overview¶

This section explains the Collect function.

5.2.1. Collect function¶

The Collect function is a function that automatically registers values to parameters based on ITA execution results (source file output by a fixed format).
This function can collect items from Ansible-Driver.
For more information regarding Ansible, see the Official Ansible Product Manuals.
For more information regarding the Ansible-Driver, see Ansible Driver.
For more information regarding Parameter sheets, see Parameter sheet creation function.

Collect function overview figure¶

The following figure illustrates using the Collect function.

図 5.7 Collect function overview figure¶

Collect function data registration process figure¶

The following figure illustrates using the Collect function to register data.

File storage destination is edited/registeered to the Parameter sheet following the Collect item value mnagement settings.

図 5.8 Collect function data registration process figure¶

Tip

※For more information regarding Collect function data type examples, see Handling Collect target file values.

5.2.2. Registering to Parameter sheets¶

The Collect function registers and edits registered setting values and file values to parameter sheets.

Collect function requirements¶

Make sure that the requirements below are met.

A parameter sheet (with host/operation) is created in the Define/Create Parameter sheets menu.
The registration information (source file) is linked to the items in the parameter sheet in Collection item value management.
Collect target device （Host name） is registered to the Device list.

If the executed operations outputs any of the statuses below, it will be registered to the parameter sheet.

Operation execution result, the operation has successfully ended.
Directories and files are arranged in a specific structure as a result of the output of the operation execution.

注釈

Each user must prepare the IaC(Plabook, Role) that generates source files going to be registered to the parameter sheets.
Reference： Ansible Playbook Collection（OS settings collection）
https://github.com/exastro-suite/playbook-collection-docs/blob/master/README.ja.md

5.3. Collect function directory, file structure and Variable handling methods¶

This section explains directories, file structures and variables handled by the Collect function.

5.3.1. Collect target directory file structure¶

Collect target file format

リスト 5.29 Files output in YAML format.¶

■File name：RH_snmp.yml
■File contents：
VAR_RH_sshd_config:
  - key: PermitRootLogin
    value: yes
  - key: PasswordAuthentication
    value: no

Collect target directory structure

The collectable directory path (output destination for the source file) can be handled as the following variable in IaC (Playbook, Role).

表 5.29 Collect function target directory ITA original variables¶
ITA original variable	Variable specified contents	Remarks
__parameter_dir__	"_parameters" Operation result directory path
__parameters_file_dir__	"_parameters_file" Operation result directory path
__parameters_dir_for_epc__	"_parameters" Operation result directory path
__parameters_file_dir_for_epc__	"_parameters_file" Operation result directory path

The upper directory of the collectable directories (parameters) depends on the "Data relay storage path (Ansible”, Ansible driver execution mdoe and the No. of the operation.

リスト 5.30 Collect target directory path¶

|-  _parameters           ※1
|   |-  localhost         ※2
|       |-  SAMPLE.yml    ※3
|-  _parameters_file      ※4
|   |-  localhost         ※2
        |-  test.txt      ※5

※Hierarchy structure after the upper directory path

Remarks

※1 Collectable directory（Fixed name）

※2 Host name（Items registered in the device list are collectable）

※3 Collect target file

※4 Collectable directory for file uploads（Fixed name）

※5 Uploadable file

注釈

If "Collect function target directory ITA original variables" is not used for the output destination when creating a Playbook that generates source files, the following structure must be recognised and the Playbook written.

表 5.30 Upper directory paths for the different Ansible-Driver modes¶
Mode	Mode identifier	Hierarchy structure
Ansible-Legacy	legacy	/<Upper directory(Ansible）>/legacy/
Ansible-Pioneer	pioneer	/<Upper directory(Ansible）>/pioneer/
Ansible-LegacyRole	legacy_role	/<Upper directory(Ansible）>/legacy_role/

注釈

※Upper directory(Ansible） is /storage/<Organization>/<Workspace>/driver/ansible/.

■　e.g.) File path and Directory structure for Collect target file.

リスト 5.31 Collect targetfile path and directory structure¶

Execution mode： Ansible-Legacy
Execution No： 00000000-0000-0000-0000-000000000001
Target： localhost
Execution directory    ： /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/in/
Execution result directory： /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/out/
Collect target file path and directory structure:
  - /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/in/_parameters/localhost/SAMPLE.yml
  - /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/in/_parameters/localhost/OS/RH_snmpd.yml
  - /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/in/_parameters_file/localhost/TEST.txt
  - /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/out/_parameters/localhost/SAMPLE.yml
  - /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/out/_parameters/localhost/OS/RH_snmpd.yml
  - /storage/Organization/Workspace/driver/ansible/legacy/00000000-0000-0000-0000-000000000001/out/_parameters_file/localhost/TEST.txt

If the user wants the file upload menu to be collectable, a file with the same name as the value of the source file variable (file name) must be placed under _parameters_.
For more information about Collection item value list settings, please refer to "Collection item value management".
As the maximum file size for uploads depends on the server specifications, please refer to  "Parameter sheet creation function" for more information.
The following description methods are available for specifying the files to be uploaded, which are placed under the _parameters_file distribution.

表 5.31 Upload target file specification method¶
Specification method	YAML file input method	Remarks
File name specification	VAR_FILE_NAME : <‘File name> ’
File path specification (Backwards match)	VAR_FILE_NAME : ‘/<HierarchyX>/<File name>’

Tip

If multiple corresponding files exists when specifying file names, the target file will be random.

When specifying file path (backwards match) and there are multiple corresponding files, the target file will be random.

■　e.g.) Directory structure and source file contents when using variables of Normal variable structure.

リスト 5.32 Directory structure and source file contents when using variables of Normal variable structure.¶

 ■Structure
 【Upper directory】
    |-  _parameters
    |   |-  localhost
    |       |-  SAMPLE.yml             ※Source file
    |-  _parameters_file
    |   |-  localhost
    |      |-  test.txt                ※Upload target file
    |      |-  APP001
              |-  config               ※Upload target file
 ■Collect target File name：SAMPLE.yml
 ■File contents
 VAR_upload_file: test.txt
 VAR_upload_fileX: config
 VAR_upload_fileZ: '/APP001/config'

5.3.2. Variable and Variable types¶

The following 3 types of variables can be handled in the Collect function source file.

Normal variable

Can have one specific value defined per each variable name.

リスト 5.33 Normal variable¶

VAR_users: root

Multiple specific value variable

Can have multiple specific values defined per each variable name

リスト 5.34 Multiple specific value structure¶

 VAR_users:
   - root
   - mysql

Multistage variable

Hierarchical variable.

リスト 5.35 多段変数の構造の変数の場合¶

 VAR_users:
    - user-name: alice      #Member variable
      authorized: password

Tip

Member variable names can contain any ascii charactere xcluding the seven characters below. ( ‘0x20~0x7e can be used)

" . [ ] ' \ :

Keep in mind that there are a few characters that can’t be used at the beginning of a variable name unless they are enclosed in quotation marks.

For more information, see the official Ansible document, Yamlsyntax.

5.4. Collect function menu structure¶

This section explains the Collect function menu structure

5.4.1. Menu list¶

Ansible common menus

The Ansible common menu list are as following.

表 5.32 Ansible common Menu list¶
No	Menu group	Menu	Description
1	Ansible common	Collection item value management	Set up the connection between the executed operation output results (Source file) and the parameter sheet items and manages the Collect function parameter sheets.

図 5.9 Setting item value management menu¶

Ansible driver menu

The Ansible common console menu list is as following.

表 5.33 Ansible driver menu list¶
No	Menu group	Menu	Description
1	Ansible-Legacy	Execution management	Manages operation execution history. Refers to the registration status of the parameter sheet and execution log by the Collect function.
2	Ansible-LegacyRole	Execution management	Manages operation execution history. Refers to the registration status of the parameter sheet and execution log by the Collect function.
3	Ansible-Pioneer	Execution management	Manages operation execution history. Refers to the registration status of the parameter sheet and execution log by the Collect function.

図 5.10 Execution management menu¶

5.5. Collect function procedure¶

This section describes the how to use the Collect function.

5.5.1. Workflow¶

A standard workflow using the Collect function can be seen below.
For more information regarding using the ITA Ansible-Driver, see "Ansible Driver".
For more information regarding using the ITA Basic console, see "Basic console".

Collect function workflow¶

The following workflow starts from executing Ansible to collecting the values to Parameter sheets.

Workflow details and references
1. Create Parameter sheet (with host/operation)
  
  Create Parameter sheet's Define/Create Parameter sheets menu. For more information, see "Parameter sheet creation function".
2. Register Collection item value management
  
  From the Ansible common and Collection item value management menus, link Source files and Parameter sheet items.
  
  For more information, see "Collection item value management".
3. Prepare execution
  
  Prepare for the execution.
  
  For more information, see "Ansible Driver" and "Conductor".
4. Execute
  
  Select Execution date, Input operation and Movement and execute.
  
  For more information regarding execution, see "Ansible Driver" and "Conductor".
5. Execute Collect function
  
  Use the Execution number from the Finished execution and use the Collect function to register the values to the parameter sheet.
  
  For more information, see "BackYard contents".
6. Check Collection status
  
  In the "Ansible-Legacy " / "Ansible-Pioneer " / "Ansible-LegacyRole "'s Execution management menu, users can check the status of the collection process and download the log file.
  
  For more information, see "Check Collect status".

5.6. Collect function operation¶

This section explains the menu functions used by the Collect function.

For more information regarding registering information, see "Basic console".

5.6.1. Ansible common¶

For more information regarding Ansible common menus, see Ansible common

Collection item value management¶

In the Collection item value management menu, users can configure links between the collect items and the paramter sheet items.

図 5.11 Submenu （Collection item value management）¶
Press List ▶ Register or Edit and register a collect item.

図 5.12 Registration/Edit page（Collection item value management）¶
The items found in the Collection item value management menu are as following.

表 5.34 Registration page item list（Collection item value management）：Collect item(From)¶
Item：Collect item(From)	Description	Input required	Restriction
Parse format	YAML: Analyses YAML format file and generates Parameter.	〇	※1
PREFIX（File name）	Input the File name without the format extention.	〇	※1
Variable name	Input the Collect target's variable name. If the variable name is an Array or hash structure, the user must input Member variable as well.	〇	※1
Member variable	Input if the variable is multiple specific values or multistage variable.		※1

表 5.35 Registration page item list（Collection item value management）：Parameter sheet(To)¶
Item：Parameter sheet(To)	Description	Input required	Restrictions
Menu group:Menu:Item	Select an Item. The items are displayed in the following format with the Menu group, Menu name and Item name divided with ":".		※2

注釈

※1 File name, Variable, Variable, Member variable input value example.

※2 If multiple "PREFIX(File name) - Variable names are defined to single "Parameter sheet(To) - Menu group：Menu：Items", the execution will follow the file order. For more information, see "Collect function examples".

■e.g.) If the variable has a normal variable structure.

リスト 5.36 If the variable has a normal variable structure.¶

■File name: SAMPLE.yml
■File contents

VAR_sample_config_1: yes
VAR_sample_config_2: test_parameter

■Values that can be input to Collect item value management's Collect item(FROM)

PREFIX(File name): SAMPLE
Variable name: VAR_sample_config_1
         VAR_sample_config_2

■ e.g.) If the variable has a multiple variable structure 1

リスト 5.37 If the variable has a multiple variable structure 1¶

■File name: SAMPLE_2.yml
■File contents

VAR_sample2_conf:
  - SAMPLE1
  - SAMPLE2
  - SAMPLE3

■Values that can be input to Collect item value management's Collect item(FROM)
PREFIX(File name): SAMPLE_2
Variable name: VAR_sample2_conf
Member variable：  [0]
             [1]
             [2]

■ e.g.) If the variable has a multiple variable structure 2

リスト 5.38 If the variable has a multiple variable structure 2¶

■File name: RH_sshd.yml
■File contents

VAR_RH_sshd_config:
  - key: PermitRootLogin
    value: yes
  - key: PasswordAuthentication
    value: no

 ■Values that can be input to Collect item value management's Collect item(FROM)
 PREFIX(File name): RH_sshd
 Variable name: VAR_RH_sshd_config:
 Member variable：  [0].key
              [0].value
              [1].key
              [1].value

■e.g.)If the variable has a multiple variable structure 3

リスト 5.39 If the variable has a multiple variable structure 3¶

■File name: RH_snmp.yml
■File contents

VAR_RH_snmpd_info:
  com2sec:
    - sec_name: "testsec"
      source: "192.168.1.0/24"
      community: "public"
    - sec_name: "local"
      source: "localhost"
      community: "private"

■Values that can be input to Collect item value management's Collect item(FROM)
PREFIX(File name): RH_snmp
Variable name: VAR_RH_snmp_config:
Member variable：  com2sec[0].sec_name
             com2sec[0].source
             com2sec[0].community
             com2sec[1].sec_name
             com2sec[1].source
             com2sec[1].community

5.6.2. Ansible-Legacy、Ansible-Pioneer、Ansible-LegacyRole¶

Check Collect status¶

Users can check the status of completed operations and download the log files from the different console's (Ansible-Legacy /Ansible-Pioneer /Ansible-LegacyRole ) Execution management menu.

図 5.13 Execution management menu¶

表 5.36 Execution management collect status details¶
Item	Description	Remarks
Status	Collect function execution status Not target; Not a Collect function target (No target file) Collected: Collect function executed. Collected (with notification): If any errors occurred during registration/update. Collection error：There is something wrong with the Movement operation or Host.	※
Collect log	Downloads the Collect function execution log

表 5.37 Collect status details¶
Operation status Status	Collect function target	Target file	Collect status Status	Collect log
Other than Complete	No	Not target	Blank	Blank
Other than Complete	Yes	Not target	Blank	Blank
Complete	No	Target	Not target	With log file
Complete	Yes	Target	Collected	With log file
Complete	Yes	Target	Collected(with notification）	With log file
Complete	Yes	Target	Collect error	With log file

注釈

※Status notations
If the Operation status shows “Not complete”, the Collect status will not be updated because it is not subject to the Collect function.
If the operation status shows as “Complete” and there are no files to collect, the status will show as “Collected” and the collection log will be blank.
Even if the RESTAPI registration process fails during collecting the “ Collection interface information, Setting item value management or “ Menu access rights/permission roles”, the collection will show as “ Complete (with notification)”.

Logfile Output contents example

■ e.g.) Logfile Output contents example

リスト 5.40 Logfile Output contents example - Collected¶

 Collect START (host name: exastro-test-1 file name: ['Ansible_conf'])
 REST DATA (host name: exastro-test-1 menu ID: collect_001 operation NO: 4001e182-51d2-4918-96e0-5981c4dc6d5f)
 Collect END (host name: exastro-test-1 file name: ['Ansible_conf'])
 Collect START (host name: exastro-test-2 file name: ['Ansible_conf'])
 REST DATA (host name: exastro-test-2 menu ID: collect_001 operation NO: 4001e182-51d2-4918-96e0-5981c4dc6d5f)
 Collect END (host name: exastro-test-2 file name: ['Ansible_conf'])
 Collect START (host name: exastro-test-3 file name: ['Ansible_conf'])
 REST DATA (host name: exastro-test-3 menu ID: collect_001 operation NO: 4001e182-51d2-4918-96e0-5981c4dc6d5f)
 Collect END (host name: exastro-test-3 file name: ['Ansible_conf'])

リスト 5.41 Logfile Output contents example - Collected(with notification)¶

Collect START (host name: exastro-test-1 file name: ['Ansible_conf'])
{'item_1': [{'status_code': '', 'msg_args': '', 'msg': 'Regular expression error (1,Value:sample_value)'}]}
[Process] Failed to register or update data in CMDB. (1/1)
Collect END (host name: exastro-test-1 file name: ['Ansible_conf'])
Collect START (host name: exastro-test-2 file name: ['Ansible_conf'])
{'item_1': [{'status_code': '', 'msg_args': '', 'msg': 'Regular expression error (1,Value:sample_value)'}]}
[Process] Failed to register or update data in CMDB. (1/1)
Collect END (host name: exastro-test-2 file name: ['Ansible_conf'])
Collect START (host name: exastro-test-3 file name: ['Ansible_conf'])
{'item_1': [{'status_code': '', 'msg_args': '', 'msg': 'Regular expression error (1,Value:sample_value)'}]}
[Process] Failed to register or update data in CMDB. (1/1)
Collect END (host name: exastro-test-3 file name: ['Ansible_conf'])

リスト 5.42 Logfile Output contents example - Collect error [Operation]¶

[Process] Operation is abolished, so registration and update processing is skipped (Operation No: 4001e182-51d2-4918-96e0-5981c4dc6d5f)

リスト 5.43 Logfile Output contents example - Collect error [host]¶

[Process] The registration / update process is skipped because the target device has not been registered or has been abolished (host name: exastro-test-1).
[Process] The registration / update process is skipped because the target device has not been registered or has been abolished (host name: exastro-test-2).
[Process] The registration / update process is skipped because the target device has not been registered or has been abolished (host name: exastro-test-3).

リスト 5.44 Logfile Output contents example - Not target¶

[Process] There is no file in the collection target directory.

5.6.3. BackYard contents¶

Acquire Collection interface information
1. Acquire list over completed operations (with Normal end)
  
  Collect targetStatus： Complete
2. Acquire the following information from the collectable operation no.
  
  - Operation information
  
  - Target host
  
  - Target source file
3. Inquire wether the target host is registered in the Device list or not
  
  Registered： Collect target
  
  Not registered： Not target
4. Acquire the Menu ID of the target Parameter sheet from the source file and the Collection item value list
  
  ※If there are multiple Target soruce files, the File names will be processed in rising order.
5. Create RESTAPI Parameter with the information gathered in Step 1-4.
  
  Query the Menu ID for data and determine the RESTAPI Execution type.
  
  Register：　Unique operation and Host combination data is not registered.
  
  Update：　 Unique operation and Host combination data is registered.
6. Register/Update the data using ITA Standard RESTAPI functions
7. Update the status of the Collection status to the Operation No.

Keep in mind that the timing of the data registration to the Parameter sheet depends on the startup cycle of the Automatic process.

For more information regarding Target execution results, see "Ansible Driver".

5.7. Appendix¶

5.7.1. References¶

Below are examples of IaCs (Playbook and Role)

Exastro Playbook Collection

https://github.com/exastro-suite/playbook-collection-docs/blob/master/README.ja.md

2. Ansible config collecting and Parameter creating Playbook.

リスト 5.45 makeYml_Ansible.yml¶

 - name: make yaml file
   blockinfile:
     create: yes
     mode: 0644
     insertbefore: EOF
     marker: ""
     dest: "{{ __parameter_dir__  }}/{{ inventory_hostname }}/Ansible_conf.yml"
     content: |
      ansible_architecture: {{ ansible_architecture }}
      ansible_bios_version: {{ ansible_bios_version }}
      ansible_default_ipv4__address: {{ ansible_default_ipv4.address }}
      ansible_default_ipv4__interface: {{ ansible_default_ipv4.interface }}
      ansible_default_ipv4__network: {{ ansible_default_ipv4.network }}
      ansible_distribution: {{ ansible_distribution }}
      ansible_distribution_file_path: {{ ansible_distribution_file_path }}
      ansible_distribution_file_variety: {{ ansible_distribution_file_variety }}
      ansible_distribution_major_version: {{ ansible_distribution_major_version }}
      ansible_distribution_release: {{ ansible_distribution_release }}
      ansible_distribution_version: {{ ansible_distribution_version }}
      ansible_machine: {{ ansible_machine }}
      ansible_memtotal_mb: {{ ansible_memtotal_mb }}
      ansible_nodename: {{ ansible_nodename }}
      ansible_os_family: {{ ansible_os_family }}
      ansible_pkg_mgr: {{ ansible_pkg_mgr }}
      ansible_processor_cores: {{ ansible_processor_cores }}
      ansible_processor_count: {{ ansible_processor_count }}
      ansible_processor_threads_per_core: {{ ansible_processor_threads_per_core }}
      ansible_processor_vcpus: {{ ansible_processor_vcpus }}
      ansible_product_name: {{ ansible_product_name }}
      ansible_product_serial: {{ ansible_product_serial }}
      ansible_product_uuid: {{ ansible_product_uuid }}
      ansible_product_version: {{ ansible_product_version }}
      ansible_python__executable: {{ ansible_python.executable }}
      ansible_python_version: {{ ansible_python_version }}
      ansible_service_mgr: {{ ansible_service_mgr }}
      vconsole_config: vconsole.conf
      yum_config: yum.conf

- name: get vconsole config
  fetch:
    src: /etc/vconsole.conf
    dest: "{{ __parameters_file_dir__ }}/{{ inventory_hostname }}/"
    flat: yes

- name: get yum config
  fetch:
    src: /etc/yum.conf
    dest: "{{ __parameters_file_dir__ }}/{{ inventory_hostname }}/"
    flat: yes

注釈

※　When executing makeYML_Ansible.yml and generate the Collectable source file (yaml), gather_facts must be enabled.
When editing the Movement list in Ansible Legacy, enter the following in the header section.
For more information, see "Ansible Driver".

リスト 5.46 gather_facts valid setting example¶

- hosts: all
  remote_user: "{{ __loginuser__ }}"
  gather_facts: yes
  become: yes

5.7.2. Collect function examples¶

When target have multiple files for single menu¶

The following section shows an example of the directory and the collect process when multiple "PREFIX (file name)-Variable names" are set to a single "Menu-Item" and there are multiple corresponding source files in the target host's collect directory.

リスト 5.47 Collect target file¶

【Upper directory】
   |-  _parameters
       |-  ita-sample01
           |-  SAMPLE_01.yml
           |-  SAMPLE_02.yml

■ Collection item value management settings

■File name：SAMPLE_01.yml ,SAMPLE_02.yml

表 5.38 File contents¶
SAMPLE_01.yml	SAMPLE_02.yml
VAR_sample_config_1: 1 VAR_sample_config_2: 2 VAR_sample_config_3: 3	VAR_sample_config_1: “A” VAR_sample_config_B: “B” VAR_sample_config_X: “X”

■ Collecting target menu items and configuring collected value item lists

Collecting target menu items and configuring collected value item lists

図 5.14 Collect value item target settings and parameter sheet¶

■Execute Collect process per File according to the Collect value item management's setting contents

SAMPLE_01.yml registration process（Register）

SAMPLE_01.yml registration process（Register）

SAMPLE_02.yml registration process（Update）

SAMPLE_02.yml registration process（Update）

Record status after running the collect function.

Record status after running the collect function.

Handling Collect target file values¶

For Collect target files output in Yaml format, the handling of values during the registration process in the parameter sheet are handled as following.

リスト 5.48 Sample.yml¶

VAR_TEST: TEST
VAR_STR_TEST1: 'TEST1'
VAR_STR_TEST2: "TEST2"
VAR_null: null
VAR_NULL: NULL
VAR_STR_null: "null"
VAR_STR_NULL: "NULL"
VAR_true: true
VAR_false: false
VAR_STR_true: "true"
VAR_STR_false: "false"
VAR_YES: YES
VAR_NO: NO
VAR_STR_YES: "YES"
VAR_STR_NO: "NO"
VAR_NON:
VAR_Quotation: ''
VAR_WQuotation: ""
VAR_INT: 100

■ Collect target YAML (sample.yml) key and value

表 5.39 Collect target YAML (sample.yml) key and value¶
No	Key	Value
1	VAR_TEST	TEST
2	VAR_STR_TEST1	'TEST1'
3	VAR_STR_TEST2	"TEST2"
4	VAR_null	null
5	VAR_NULL	NULL
6	VAR_STR_null	"null"
7	VAR_STR_NULL	"NULL"
8	VAR_true	true
9	VAR_false	false
10	VAR_STR_true	"true"
11	VAR_STR_false	"false"
12	VAR_YES	YES
13	VAR_NO	NO
14	VAR_STR_YES	"YES"
15	VAR_STR_NO	"NO"
16	VAR_NON
17	VAR_Quotation	''
18	VAR_WQuotation	""
19	VAR_INT	100

■ Collecting YAML(sample.yml)

表 5.40 Collecting YAML(sample.yml)¶
No	Collect target (Key:Value)	Parameter sheet Item name	RESTAPI response Value	RESTAPI response Data type	WEB page display
1	VAR_TEST: TEST	Parameter/VAR_TEST	"TEST"	string	TEST
2	VAR_STR_TEST1: 'TEST1'	Parameter/VAR_STR_TEST1	"TEST1"	string	TEST1
3	VAR_STR_TEST2: "TEST2"	Parameter/VAR_STR_TEST2	"TEST2"	string	TEST2
4	VAR_null: null	Parameter/VAR_null	null	null
5	VAR_NULL: NULL	Parameter/VAR_NULL	null	null
6	VAR_STR_null: "null"	Parameter/VAR_STR_null	"null"	string	null
7	VAR_STR_NULL: "NULL"	Parameter/VAR_STR_NULL	"NULL"	string	NULL
8	VAR_true: true	Parameter/VAR_true	true	boolean	true
9	VAR_false: false	Parameter/VAR_false	false	boolean	false
10	VAR_STR_true: "true"	Parameter/VAR_STR_true	"true"	string	true
11	VAR_STR_false: "false"	Parameter/VAR_STR_false	"false"	string	false
12	VAR_YES: YES	Parameter/VAR_YES	true	boolean	true
13	VAR_NO: NO	Parameter/VAR_NO	false	boolean	false
14	VAR_STR_YES: "YES"	Parameter/VAR_STR_YES	"YES"	string	YES
15	VAR_STR_NO: "NO"	Parameter/VAR_STR_NO	"NO"	string	NO
16	VAR_NON:	Parameter/VAR_NON	null	null
17	VAR_Quotation: ''	Parameter/VAR_Quotation	""	string
18	VAR_WQuotation: ""	Parameter/VAR_WQuotation	""	string
19	VAR_INT: 100	パラメータ/VAR_INT	"100"	string	100

※This section explains RESTAPI response values and Data types displayed on the WebUI.

※The Parameter sheet items are strings (single line).

Target parameter sheet on WebUI display result

図 5.15 Target parameter sheet on WebUI display result 1¶

図 5.16 Target parameter sheet on WebUI display result 2¶

Results fetched with Target Parameter sheet's RESTAPI(filter)

リスト 5.49 RESTAPI(filter) response¶

{
    "data": [
        {
            "file": {},
            "parameter": {
                "base_datetime": "2023/05/17 13:58:47",
                "discard": "0",
                "host_name": "exastro-test-1",
                "item_1": "TEST",
                "item_10": "true",
                "item_11": "false",
                "item_12": "true",
                "item_13": "false",
                "item_14": "YES",
                "item_15": "NO",
                "item_16": null,
                "item_17": "",
                "item_18": "",
                "item_19": "100",
                "item_2": "TEST1",
                "item_3": "TEST2",
                "item_4": null,
                "item_5": null,
                "item_6": "null",
                "item_7": "NULL",
                "item_8": "true",
                "item_9": "false",
                "last_execute_timestamp": "2023/05/17 13:58:47",
                "last_update_date_time": "2023/05/17 14:00:07.944031",
                "last_updated_user": "Collect execute function",
                "operation_date": "2023/01/01 00:00:00",
                "operation_name_disp": "OP1",
                "operation_name_select": "2023/01/01 00:00_OP1",
                "remarks": null,
                "uuid": "ede113f8-14b1-48bf-8b3f-409f68b107ae"
            }
        }
    ],
    "message": "SUCCESS",
    "result": "000-00000",
    "ts": "2023-05-17T05:54:03.937Z"
}

If multiple files with the same file names are Upload target files¶

This section describes an example of specifying an Upload target file for a Collect target file output in Yaml format, when the same file name needs to be handled on the same host and by hierarchy.

リスト 5.50 Collect target file File path and Directory structure (Multiple file with same file name)¶

【Upper directory】
   |-  _parameters
   |   |-  localhost
   |       |-  SAMPLE.yml
   |-  _parameters_file
   |   |-  localhost
             |-  APP001
                 |-  config                   #①
             |-  APP002
                 |-  config                   #②
             |-  APP003
                 |-  config                   #③
             |-  APP002
                 |-  config                   #④

  ■Collect target file name：SAMPLE.yml
  ■File contents
  VAR_upload_file_1: config
  VAR_upload_file_2: ‘/APP002/config’
  VAR_upload_file_3: ‘/APP001/config’
  VAR_upload_file_4: ‘/APP003/APP002/config’

※For more information regarding Upper directories, see "Collect target directory file structure".

The target Collect file when collected are as following.

表 5.41 Collect target file¶
Collect item(FROM)/Variable name	Target file	Remarks
VAR_upload_file_1	Random from File ①、②、③、④
VAR_upload_file_2	Random from File ②、④
VAR_upload_file_3	File ① is Target
VAR_upload_file_4	File ④ is Target

Target file contents when File is deleted.¶

This section contains Collect target file specification examples for deleting File upload items.

Files being deleted must have the Target variable name's value be blank.

リスト 5.51 Collect target file's File path and Directory structure when deleting File upload item¶

【Upper directory】
   |-  _parameters
   |   |-  localhost
   |       |-  SAMPLE.yml   ※Source file
   |-  _parameters_file
   |   |-  localhost

 ■Collect target file name: SAMPLE.yml
 ■File contents
 VAR_upload_file: ""         ※Upload target file

↑ Page Top