Search Knowledge Base by Keyword

Hitachi Vantara

< Back

Overview

Hitachi Vantara is Hitachi’s enterprise infrastructure business. Its storage line covers the Virtual Storage Platform arrays for block and file workloads, Hitachi Content Platform for object storage, and the Ops Center software that manages and reports on them. In a large data centre these arrays hold the volumes that the virtualisation and database estate runs on, so their inventory is part of knowing what the estate actually consists of.

The ReadyWorks connector is a thin, generic REST client aimed at those management APIs. It authenticates either with an X-API-KEY header or with HTTP basic authentication, then issues the GET calls you configure against the array or Ops Center endpoint and parses the JSON into staging tables in the estate.

What it gives you depends entirely on what you configure, because no Hitachi-specific job ships with it. Pointed at the right endpoints it lets you reconcile array, pool and volume inventory against the hosts and workloads already in the fabric, so a storage dependency shows up before a migration wave moves the server that depends on it.

The connector is declared bidirectional. Both the inbound and the outbound job forms are fully exposed, and one generic shell template ships on each side with no endpoint set.

NOTE: This connector ships no Hitachi endpoints. Both templates are empty REST skeletons. Plan for a configuration exercise against your Hitachi API documentation, not a switch-on.

Connector Properties

Property Value
Identifier HITACHI VANTARA
Name Hitachi Vantara
Description Hitachi Vantara data storage platforms
Job Types Both Inbound and Outbound
Order 330
Enabled Yes
Locked Yes
Block Update No
Single Authentication No
Windows Only No
Connector Version 2026-08-10
Hooks None
Additional Job Fields None
Image

Authentication Methods

Two authentication methods are shipped, neither of which is marked as the default, so you must choose one explicitly when creating a connection.

Method Identifier Base Method Script Order Enabled Config Fields
Header: X-API-KEY HITACHI VANTARA_1d08fef471 HITACHI VANTARA_1d08fef471 json_rest_api.php 50 Yes 9
Basic Authorization: Username / Password HITACHI VANTARA_433c0c2e24 HITACHI VANTARA_433c0c2e24 json_rest_api.php 70 Yes 4

NOTE: The two methods are not equivalent in what they let you configure. The X-API-KEY method offers Single Authentication and Additional Job Fields; the Basic Authorization method does not.

NOTE: Both methods set SSL_VERIFYHOST and SSL_VERIFYPEER to false, so the array’s certificate is not validated.

Method 1: Header: X-API-KEY (HITACHI VANTARA_1d08fef471)

Connect to a GET method API with a x-api-key token

Sends an X-API-KEY header carrying the value you enter in the field labelled X-API Key, which is stored in the encrypted user_pass column. Use it for Hitachi management endpoints that issue a static API key. The form also presents Username, Authentication Value 1, Authentication End Point and Authentication Data Node, none of which this method’s recipe uses.

Connection Configuration Fields (9)

Order Label Type Required Default Max Len Tooltip
10 API Domain text Yes 255 Enter API domain of the Connection
10 Server Temporary Working Path text Yes storage/etl5 255 Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40 Username text No 1024 Tooltip for Username
50 X-API Key password No 64000 Tooltip for Password
60 Authentication Value 1 password No 64000 Tooltip for Authentication Value 1
190 Authentication End Point text No 500 Tooltip for Authentication End Point
200 Authentication Data Node text No 255 Tooltip for Authentication Data Node
240 Single Authentication radio Yes 0 Choose if authentication is only to be done once and not on each enumeration or pagination loop
250 Additional Job Fields fields_list No Enter list of additional fields to add to staging data for all jobs

Authentication Configuration

Headers sent on the authentication call:

Header Value Base64
Content-Type: application/json Off
X-API-KEY: %user_pass% Off

cURL options:

Option Authentication Call Data Calls
USERAGENT Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Same
SSL_VERIFYHOST false Same
SSL_VERIFYPEER false Same
RETURNTRANSFER true Same
FOLLOWLOCATION true Same
FAILONERROR true Same

NOTE: Several fields on this form carry unedited template tooltips (“Tooltip for Password”, “Tooltip for Authentication Value 1”). Only API Domain, Server Temporary Working Path and X-API Key are used by the shipped recipe.

Method 2: Basic Authorization: Username / Password (HITACHI VANTARA_433c0c2e24)

Connect to a GET method API with a username / password

Sends Authorization: Basic with the username and password Base64-encoded together. This is the usual choice for a Virtual Storage Platform or Ops Center REST endpoint that accepts an array service account directly. Its connection form is the shorter of the two, with only the domain, working path, username and password.

Connection Configuration Fields (4)

Order Label Type Required Default Max Len Tooltip
10 API Domain text Yes 255 Enter API domain of the Connection
10 Server Temporary Working Path text Yes storage/etl5 255 Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40 Username text No 1024 Tooltip for Username
50 Password password No 64000 Tooltip for Password

Authentication Configuration

Headers sent on the authentication call:

Header Value Base64
Content-Type: application/json Off
Authorization: Basic %user_name%:%user_pass% On

cURL options:

Option Authentication Call Data Calls
USERAGENT Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Same
SSL_VERIFYHOST false Same
SSL_VERIFYPEER false Same
RETURNTRANSFER true Same
FOLLOWLOCATION true Same
FAILONERROR true Same

NOTE: Choosing this method removes the Additional Job Fields option from the connection. If you need connection-wide extra staging columns, use the X-API-KEY method.

Inbound Job Fields Enabled (44)

The inbound job form carries the full generic REST field set, including pagination, the three enumeration levels and the raw JSON body.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
20 Job Schedule lookup Yes Daily Select frequency Job should run
30 Enabled radio Yes Yes Choose if Job is enabled
40 Use Unparsed Data radio No No Choose if you wish to parse the incoming data, or leave it in its raw format
50 Log Raw API Calls radio Yes No Choose if raw API calls are logged
70 Destination Table text Yes Enter name of the destination table
80 Data Identity text No Enter identity of the Job
120 Append New Data to Existing Tables radio No No Choose if new data will append to the existing destination table, or will create a new destination table
130 Fields to Index text No Enter fields to index
170 Method Type select Yes GET Select method type of the Job
190 API End Point text No Enter API end point of the Job
200 API Data Parameters fields_list No Enter API data parameters of the Job
210 Body Data Sending Method select Yes JSON Encoded Data Select method for sending the body data
220 Raw JSON Body Data textarea No Enter the raw JSON body to send. Do not use body selections in the API Parameters if this is used.
230 API Return Data Node text No Enter API return data node of the Job
250 Pagination Type select No None Select request paging type of the Job
270 API Pagination Node text No Enter API pagination node of the Job
280 Pagination Offset Start text No Enter request paging offset start of the Job
290 Pagination Limit text No Enter request pagination limit of the Job
300 Pagination Termination Node text No Enter request paging termination node and value of the Job
310 Maximum API Calls text No Enter maximum number of API calls for the Job to make
320 Enumeration 1 Type select No None Enter enumeration level 1 type
330 Enumeration 1 ETL Job lookup No Select ETL job for the enumeration values
340 Enumeration 1 Data Type data_type No Select the data type and fields for enumeration 1 values
350 Enumeration 1 Keys End Point text No Enter enumeration 1 keys end point of the Job
360 Enumeration 1 Node text No Enter enumeration 1 node of the Job
370 Enumeration 1 Fields fields_list No Enter enumeration 1 fields of the Job
380 Enumeration 2 Type select No None Enter enumeration level 2 type
390 Enumeration 2 ETL Job lookup No Select ETL job for the enumeration 2 values
400 Enumeration 2 Data Type data_type No Select the data type and fields for enumeration 2 values
410 Enumeration 2 Keys End Point text No Enter enumeration 2 keys end point of the Job
420 Enumeration 2 Node text No Enter enumeration 2 node of the Job
430 Enumeration 2 Fields fields_list No Enter enumeration 2 fields of the Job
440 Enumeration 3 Type select No None Enter enumeration level 3 type
450 Enumeration 3 ETL Job lookup No Select ETL job for the enumeration 3 values
460 Enumeration 3 Data Type data_type No Select the data type and fields for enumeration 3 values
470 Enumeration 3 Keys End Point text No Enter enumeration 3 keys end point of the Job
480 Enumeration 3 Node text No Enter enumeration 3 node of the Job
490 Enumeration 3 Fields fields_list No Enter enumeration 3 fields of the Job
500 Pause Enumeration text No Enter values for pausing enumeration every X calls for Y seconds
510 Kill Enumeration on Error radio No No Choose to stop the enumeration loop on an error or continue processing the loop
520 Additional Fields fields_list No Enter list of additional fields to add to staging data
550 Retry Pause text No Enter values for retrying a failed API connection. Retry X times, waiting Y seconds between each try, with an API timeout of Z seconds.
560 Order text Yes Enter order of the Job

NOTE: Several labels and tooltips carry unedited text from the shared templates. Enumaration 1 Node is misspelled and the tooltip on Enumeration 1 Keys End Point refers to enumeration 2. The fields behave as their level numbers say.

Outbound Job Fields Enabled (13)

Thirteen outbound job fields are exposed, covering the endpoint, method type, data sending methods, the outbound and return field lists and a raw JSON template that overrides the generated body.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
30 Enabled radio Yes Yes Choose if Job is enabled
50 Log Raw API Calls radio Yes No Choose if raw API calls are logged
170 Method Type select Yes GET Select method type of the Job
180 Data Sending Method select Yes JSON Encoded Data Select method for sending the outbound data
190 API End Point text No Enter API end point of the Job
200 API Data Parameters fields_list No Enter API data parameters of the Job
210 Body Data Sending Method select Yes JSON Encoded Data Select method for sending the body data
260 Return Data Fields List fields_list Yes Enter return data fields of the Job
530 Outbound Fields List fields_list Yes Enter outbound fields of the Job
540 Ignore Empty Outbound Fields radio No Yes Ignore, and do not include, any outbound fields that are empty and have no data
550 Raw JSON Outbound Template textarea No Enter the raw JSON outbound template to send. This will replace any automated structures defined in the outbound fields.
560 Order text Yes Enter order of the Job

Inbound Job Templates (1)

One inbound template ships, and it is a blank REST skeleton rather than a Hitachi job.

# Job Description Destination Table API End Point Enabled What It Pulls
1 Rest GET API api_data Not set No An empty GET skeleton with no endpoint set, writing to a staging table called api_data. Copy it once per Hitachi collection you want, fill in the API End Point and Destination Table, and set API Return Data Node to the node holding the record array.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled No
Job Schedule Daily (15 1 * * *)
Destination Table api_data
Data Identity api_data
Allow Empty Table Yes
Append Files to Same Destination Table No
Append New Data to Existing Tables No
Use Unparsed Data No
Convert UUID-Keyed Objects to Rows No
Ignore XML Attributes No
Log Raw API Calls No
Method Type GET
Body Data Sending Method JSON Encoded Data

NOTE: The template ships disabled. Nothing is retrieved until you configure an endpoint and enable a job.

Outbound Job Templates (1)

One outbound template ships as a generic shell.

# Job Description Method API End Point Enabled What It Does
1 Rest POST API POST Not set No A disabled POST skeleton with no endpoint set. It sends a single Record Key field and expects status, message and data.record_key back. Configure the endpoint and field lists to match the Hitachi call you intend to make.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled No
Log Raw API Calls No
Method Type POST
Body Data Sending Method JSON Encoded Data
Data Sending Method JSON Encoded Data
Ignore Empty Outbound Fields Yes

Job Parameters and Enumeration

Rest POST API

Outbound fields list:

Label Name Type Required Pattern
Record Key record_key String on

Return data fields:

Label Name
Return Status status
Return Message message
Record Key data.record_key
Tags: