Table of Contents


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

PropertyValue
IdentifierHITACHI VANTARA
NameHitachi Vantara
DescriptionHitachi Vantara data storage platforms
Job TypesBoth Inbound and Outbound
Order330
EnabledYes
LockedYes
Block UpdateNo
Single AuthenticationNo
Windows OnlyNo
Connector Version2026-08-10
HooksNone
Additional Job FieldsNone
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.

MethodIdentifierBase MethodScriptOrderEnabledConfig Fields
Header: X-API-KEYHITACHI VANTARA_1d08fef471HITACHI VANTARA_1d08fef471json_rest_api.php50Yes9
Basic Authorization: Username / PasswordHITACHI VANTARA_433c0c2e24HITACHI VANTARA_433c0c2e24json_rest_api.php70Yes4

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)

OrderLabelTypeRequiredDefaultMax LenTooltip
10API DomaintextYes255Enter API domain of the Connection
10Server Temporary Working PathtextYesstorage/etl5255Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40UsernametextNo1024Tooltip for Username
50X-API KeypasswordNo64000Tooltip for Password
60Authentication Value 1passwordNo64000Tooltip for Authentication Value 1
190Authentication End PointtextNo500Tooltip for Authentication End Point
200Authentication Data NodetextNo255Tooltip for Authentication Data Node
240Single AuthenticationradioYes0Choose if authentication is only to be done once and not on each enumeration or pagination loop
250Additional Job Fieldsfields_listNoEnter list of additional fields to add to staging data for all jobs

Authentication Configuration

Headers sent on the authentication call:

HeaderValueBase64
Content-Type:application/jsonOff
X-API-KEY:%user_pass%Off

cURL options:

OptionAuthentication CallData Calls
USERAGENTMozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0Same
SSL_VERIFYHOSTfalseSame
SSL_VERIFYPEERfalseSame
RETURNTRANSFERtrueSame
FOLLOWLOCATIONtrueSame
FAILONERRORtrueSame

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)

OrderLabelTypeRequiredDefaultMax LenTooltip
10API DomaintextYes255Enter API domain of the Connection
10Server Temporary Working PathtextYesstorage/etl5255Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40UsernametextNo1024Tooltip for Username
50PasswordpasswordNo64000Tooltip for Password

Authentication Configuration

Headers sent on the authentication call:

HeaderValueBase64
Content-Type:application/jsonOff
Authorization: Basic%user_name%:%user_pass%On

cURL options:

OptionAuthentication CallData Calls
USERAGENTMozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0Same
SSL_VERIFYHOSTfalseSame
SSL_VERIFYPEERfalseSame
RETURNTRANSFERtrueSame
FOLLOWLOCATIONtrueSame
FAILONERRORtrueSame

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.

OrderLabelTypeRequiredDefaultTooltip
10Job DescriptiontextYesEnter description of the Job
20Job SchedulelookupYesDailySelect frequency Job should run
30EnabledradioYesYesChoose if Job is enabled
40Use Unparsed DataradioNoNoChoose if you wish to parse the incoming data, or leave it in its raw format
50Log Raw API CallsradioYesNoChoose if raw API calls are logged
70Destination TabletextYesEnter name of the destination table
80Data IdentitytextNoEnter identity of the Job
120Append New Data to Existing TablesradioNoNoChoose if new data will append to the existing destination table, or will create a new destination table
130Fields to IndextextNoEnter fields to index
170Method TypeselectYesGETSelect method type of the Job
190API End PointtextNoEnter API end point of the Job
200API Data Parametersfields_listNoEnter API data parameters of the Job
210Body Data Sending MethodselectYesJSON Encoded DataSelect method for sending the body data
220Raw JSON Body DatatextareaNoEnter the raw JSON body to send. Do not use body selections in the API Parameters if this is used.
230API Return Data NodetextNoEnter API return data node of the Job
250Pagination TypeselectNoNoneSelect request paging type of the Job
270API Pagination NodetextNoEnter API pagination node of the Job
280Pagination Offset StarttextNoEnter request paging offset start of the Job
290Pagination LimittextNoEnter request pagination limit of the Job
300Pagination Termination NodetextNoEnter request paging termination node and value of the Job
310Maximum API CallstextNoEnter maximum number of API calls for the Job to make
320Enumeration 1 TypeselectNoNoneEnter enumeration level 1 type
330Enumeration 1 ETL JoblookupNoSelect ETL job for the enumeration values
340Enumeration 1 Data Typedata_typeNoSelect the data type and fields for enumeration 1 values
350Enumeration 1 Keys End PointtextNoEnter enumeration 1 keys end point of the Job
360Enumeration 1 NodetextNoEnter enumeration 1 node of the Job
370Enumeration 1 Fieldsfields_listNoEnter enumeration 1 fields of the Job
380Enumeration 2 TypeselectNoNoneEnter enumeration level 2 type
390Enumeration 2 ETL JoblookupNoSelect ETL job for the enumeration 2 values
400Enumeration 2 Data Typedata_typeNoSelect the data type and fields for enumeration 2 values
410Enumeration 2 Keys End PointtextNoEnter enumeration 2 keys end point of the Job
420Enumeration 2 NodetextNoEnter enumeration 2 node of the Job
430Enumeration 2 Fieldsfields_listNoEnter enumeration 2 fields of the Job
440Enumeration 3 TypeselectNoNoneEnter enumeration level 3 type
450Enumeration 3 ETL JoblookupNoSelect ETL job for the enumeration 3 values
460Enumeration 3 Data Typedata_typeNoSelect the data type and fields for enumeration 3 values
470Enumeration 3 Keys End PointtextNoEnter enumeration 3 keys end point of the Job
480Enumeration 3 NodetextNoEnter enumeration 3 node of the Job
490Enumeration 3 Fieldsfields_listNoEnter enumeration 3 fields of the Job
500Pause EnumerationtextNoEnter values for pausing enumeration every X calls for Y seconds
510Kill Enumeration on ErrorradioNoNoChoose to stop the enumeration loop on an error or continue processing the loop
520Additional Fieldsfields_listNoEnter list of additional fields to add to staging data
550Retry PausetextNoEnter values for retrying a failed API connection. Retry X times, waiting Y seconds between each try, with an API timeout of Z seconds.
560OrdertextYesEnter 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.

OrderLabelTypeRequiredDefaultTooltip
10Job DescriptiontextYesEnter description of the Job
30EnabledradioYesYesChoose if Job is enabled
50Log Raw API CallsradioYesNoChoose if raw API calls are logged
170Method TypeselectYesGETSelect method type of the Job
180Data Sending MethodselectYesJSON Encoded DataSelect method for sending the outbound data
190API End PointtextNoEnter API end point of the Job
200API Data Parametersfields_listNoEnter API data parameters of the Job
210Body Data Sending MethodselectYesJSON Encoded DataSelect method for sending the body data
260Return Data Fields Listfields_listYesEnter return data fields of the Job
530Outbound Fields Listfields_listYesEnter outbound fields of the Job
540Ignore Empty Outbound FieldsradioNoYesIgnore, and do not include, any outbound fields that are empty and have no data
550Raw JSON Outbound TemplatetextareaNoEnter the raw JSON outbound template to send. This will replace any automated structures defined in the outbound fields.
560OrdertextYesEnter 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 DescriptionDestination TableAPI End PointEnabledWhat It Pulls
1Rest GET APIapi_dataNot setNoAn 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

SettingValue
Order10
EnabledNo
Job ScheduleDaily (15 1 * * *)
Destination Tableapi_data
Data Identityapi_data
Allow Empty TableYes
Append Files to Same Destination TableNo
Append New Data to Existing TablesNo
Use Unparsed DataNo
Convert UUID-Keyed Objects to RowsNo
Ignore XML AttributesNo
Log Raw API CallsNo
Method TypeGET
Body Data Sending MethodJSON 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 DescriptionMethodAPI End PointEnabledWhat It Does
1Rest POST APIPOSTNot setNoA 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

SettingValue
Order10
EnabledNo
Log Raw API CallsNo
Method TypePOST
Body Data Sending MethodJSON Encoded Data
Data Sending MethodJSON Encoded Data
Ignore Empty Outbound FieldsYes

Job Parameters and Enumeration

Rest POST API

Outbound fields list:

LabelNameTypeRequiredPattern
Record Keyrecord_keyStringon

Return data fields:

LabelName
Return Statusstatus
Return Messagemessage
Record Keydata.record_key
Last updated on 11/4/2026

Attachments