Hdi API References Hdi0260

Hitachi Data IngestorAPI Reference

MK-90HDI026-00

Document Organization

Product Version

Getting Help

Contents

Copyright © 2011 Hitachi, Ltd., Hitachi Data Systems Corporation, ALL RIGHTS RESERVEDNo part of this publication may be reproduced or transmitted in any form or by any means,electronic or mechanical, including photocopying and recording, or stored in a database or retrievalsystem for any purpose without the express written permission of Hitachi, Ltd. (hereinafter referredto as "Hitachi") and Hitachi Data Systems Corporation (hereinafter referred to as "Hitachi DataSystems").Hitachi and Hitachi Data Systems reserve the right to make changes to this document at any timewithout notice and assume no responsibility for its use. This document contains the most currentinformation available at the time of publication. When new and/or revised information becomesavailable, this entire document will be updated and distributed to all registered users.All of the features described in this document may not be currently available. Refer to the mostrecent product announcement or contact your local Hitachi Data Systems sales office for informationon feature and product availability.Notice: Hitachi Data Systems products and services can be ordered only under the terms andconditions of Hitachi Data Systems' applicable agreement(s). The use of Hitachi Data Systemsproducts is governed by the terms of your agreement(s) with Hitachi Data Systems.By using this software, you agree that you are responsible for:a) Acquiring the relevant consents as may be required under local privacy laws or otherwise fromemployees and other individuals to access relevant data; andb) Ensuring that data continues to be held, retrieved, deleted or otherwise processed in accordancewith relevant laws.Hitachi is a registered trademark of Hitachi, Ltd. in the United States and other countries. HitachiData Systems is a registered trademark and service mark of Hitachi in the United States and othercountries.All other trademarks, service marks, and company names are properties of their respective owners.Microsoft product screen shot(s) reprinted with permission from Microsoft Corporation.

iiHitachi Data Ingestor API Reference

Contents

Preface.................................................................................................viiIntended audience.............................................................................................viiiProduct version.................................................................................................viiiRelease notes....................................................................................................viiiDocument revision level.....................................................................................viiiDocument organization......................................................................................viiiOrganization of HDI manuals...............................................................................ixReferenced documents.........................................................................................xAbbreviation conventions.....................................................................................xDocument conventions........................................................................................xiConvention for storage capacity values................................................................xiiGetting help.......................................................................................................xiiComments........................................................................................................xiii

1. Overview of the API.............................................................................1-1What you can do by using the API...........................................................................1-2System configurations.............................................................................................1-2Resources and properties........................................................................................1-3HTTP methods........................................................................................................1-3How to execute a request........................................................................................1-4

When using the GET method.............................................................................1-5When using the PUT method.............................................................................1-6When using the POST method...........................................................................1-7When using the DELETE method.......................................................................1-8When using the HEAD method...........................................................................1-8

HTTP status codes..................................................................................................1-8I/O formats for requests and responses..................................................................1-11Query parameters.................................................................................................1-11Request headers...................................................................................................1-12Response headers.................................................................................................1-13Response XML when an error occurs......................................................................1-14

2. Access and Authentication....................................................................2-1URI and account for accessing an HDI system..........................................................2-2Notes on URIs........................................................................................................2-2

iiiHitachi Data Ingestor API Reference

Maximum URI length........................................................................................2-2Encoding of specific characters and values.........................................................2-2Quotation marks on the command line...............................................................2-3Using multi-byte characters...............................................................................2-3

Authentication cookie..............................................................................................2-3SSL certificate.........................................................................................................2-4

3. Resources...........................................................................................3-1List of resources.....................................................................................................3-3APIAccount............................................................................................................3-4

APIAccount resource overview...........................................................................3-4APIAccount resource.........................................................................................3-4

Acquiring API administrator account information by using the GET method. 3-4Changing the API administrator account password by using the POST method..............................................................................................................3-5

CIFSShares.............................................................................................................3-7CIFSShares resource overview...........................................................................3-7CIFSShares resource.........................................................................................3-7

Acquiring information about all CIFS shares by using the GET method........3-8Adding a CIFS share by using the PUT method........................................3-14

CIFSShares/CIFS-share-name resource............................................................3-28Acquiring CIFS share information by using the GET method......................3-29Changing CIFS share information by using the POST method....................3-35Deleting the specified CIFS share by using the DELETE method................3-43Checking whether the specified CIFS share exists by using the HEAD method............................................................................................................3-44

Disk.....................................................................................................................3-44Disk resource overview...................................................................................3-44Disk resource.................................................................................................3-44

Acquiring information specified about the disk by using the GET method...3-45FCPaths................................................................................................................3-46

FCPaths resource overview..............................................................................3-46FCPaths resource............................................................................................3-46

FileSystems..........................................................................................................3-49FileSystems resource overview.........................................................................3-49FileSystems resource.......................................................................................3-50

Acquiring file system information by using the GET method......................3-50Creating a file system by using the PUT method......................................3-57

FileSystems/file-system-name resource............................................................3-63Acquiring the specified file system information by using the GET method. .3-63Editing information about the specified file system by using the POST method............................................................................................................3-70Deleting the specified file system by using the DELETE method................3-74Checking whether the specified file system exists by using the HEAD method............................................................................................................3-74

FileSystems/file-system-name/MountSetting resource........................................3-75Acquiring information about the mount settings of the specified file system byusing the GET method...........................................................................3-75Editing information about the mount settings of the specified file system byusing the POST method.........................................................................3-77

Hardware.............................................................................................................3-80Hardware resource overview ..........................................................................3-80

ivHitachi Data Ingestor API Reference

Hardware resource.........................................................................................3-80Acquiring hardware information by using the GET method........................3-80

HCP.....................................................................................................................3-93HCP resource overview....................................................................................3-93HCP resource..................................................................................................3-93

Acquiring the specified HCP information by using the GET method............3-94Setting or deleting HCP information by using the POST method................3-95

HCP/ACCESS resource.....................................................................................3-97Checking whether the user can access the HCP namespace by using the POSTmethod.................................................................................................3-97

LUs......................................................................................................................3-98LUs resource overview....................................................................................3-98LUs resource..................................................................................................3-99

Acquiring LU information by using the GET method..................................3-99MigrationTask.....................................................................................................3-103

MigrationTask resource overview...................................................................3-103MigrationTask resource.................................................................................3-104

Acquiring information for all migration policies by using the GET method.3-104Setting the migration policy by using the PUT method............................3-107

MigrationTask/policy-name resource...............................................................3-110Acquiring information for the specified migration policy by using the GETmethod...............................................................................................3-110Resetting the schedule of the migration task by using the POST method. 3-113Deleting policy information by using the DELETE method.......................3-116Checking whether the specified migration policy exists by using the HEADmethod...............................................................................................3-116

NetworkInterfaces...............................................................................................3-117NetworkInterfaces resource overview.............................................................3-117NetworkInterfaces resource...........................................................................3-117

Acquiring network interface information by using the GET method..........3-117Adding a network interface by using the PUT method.............................3-122

NetworkInterfaces/network-interface-name resource.......................................3-125Acquiring network interface information by using the GET method..........3-125Changing the network interface information by using the POST method. .3-127Checking whether the specified network interface exists by using the HEADmethod...............................................................................................3-130

NFSShares..........................................................................................................3-131NFSShares resource overview........................................................................3-131NFSShares resource......................................................................................3-131

Acquiring information for all NFS shares by using the GET method..........3-132Adding an NFS share by using the PUT method.....................................3-135

NFSShares/NFS-share-directory-name resource...............................................3-146Acquiring information for the specified NFS share by using the GET method3-147Editing NFS share information by using the POST method......................3-150Deleting the specified NFS share by using the DELETE method...............3-155Checking whether the specified NFS share exists by using the HEAD method..........................................................................................................3-156

ProcessingNode...................................................................................................3-156ProcessingNode resource overview.................................................................3-156ProcessingNode resource...............................................................................3-157

Acquiring cluster and node information by using the GET method...........3-157Changing a host name by using the POST method.................................3-163

vHitachi Data Ingestor API Reference

Routings.............................................................................................................3-164Routings resource overview...........................................................................3-164Routings resource.........................................................................................3-165

Acquiring the specified routing information by using the GET method......3-165Adding or deleting routing information by using the POST method..........3-167

SystemController.................................................................................................3-170SystemController resource overview...............................................................3-170SystemController resource.............................................................................3-171

Checking whether the service or OS needs to be restarted by using the GETmethod...............................................................................................3-171Restarting the service or OS by using the POST method.........................3-173

SystemController/OS resource........................................................................3-174StoppingRestarting or stopping the OS on the node by using the POST method..........................................................................................................3-175

A API Usage Examples.............................................................................A-1Example of acquiring cluster and node information in a cluster configuration..............A-2Example of editing the host name in a single-node configuration................................A-3Example of monitoring the hardware status..............................................................A-6Example of setting up the network.........................................................................A-12Example of setting HCP information.......................................................................A-21Example of creating a file system in a cluster configuration......................................A-22Example of creating a file system in a single-node configuration...............................A-55Example of deleting a file system...........................................................................A-75Example of stopping the OS in a cluster configuration.............................................A-78Example of stopping the OS in a single-node configuration......................................A-79

Acronyms

Glossary

Index

viHitachi Data Ingestor API Reference

Preface

This manual describes how to use the Hitachi Data Ingestor (HDI) API.

Note: The Sync Image Feature is not supported

□ Intended audience

□ Product version

□ Release notes

□ Document revision level

□ Document organization

□ Organization of HDI manuals

□ Referenced documents

□ Abbreviation conventions

□ Document conventions

□ Convention for storage capacity values

□ Getting help

□ Comments

Preface viiHitachi Data Ingestor API Reference

Intended audienceThis manual is intended for those who use the API to develop applicationprograms that manage HDI systems.

Readers of this manual must have:

• Knowledge of how to use and manage an HDI system

• Knowledge of Hitachi Content Platform (HCP) systems

• Knowledge of application programming using the REST interface

Product versionThis document revision applies to Hitachi Data Ingestor version 2.7and above.

Release notesRelease notes can be found on the documentation CD. Release notes containrequirements and more recent product information that may not be fullydescribed in this manual. Be sure to review the release notes beforeinstallation.

Document revision levelRevision Date Description

MK-90HDI026-00 June 2011 Initial release

Document organizationThe following table provides an overview of the contents and organization ofthis document.

Chapter Description

Overview of the API Provides an overview of the HDI API. The topics covered bythis chapter include system configurations, resources andproperties, HTTP methods, how to execute requests, HTTPstatus codes, I/O formats for requests and responses, queryparameters, request headers, and response headers.

Access andAuthentication

Explains the URI used to access an HDI system, notespertaining to URIs specified for API requests, how to specifyauthentication cookies, and SSL certificates.

Resources Explains the types of HTTP methods that can be used forrequests, the structure of request XMLs and response XMLsfor each method, the details of properties, the URIs of theresources to which requests are sent, and the status codesreturned when methods end.

viii Preface

Hitachi Data Ingestor API Reference

Chapter Description

API Usage Examples Explains the API usage through the use of examples.

Acronyms Lists the acronyms used in the HDI manuals.

Glossary Explains the terms used in the HDI manuals.

Index Lists the topics in this document in alphabetical order.

Organization of HDI manualsHDI manuals are organized as shown below.

Note that whether HDI nodes can be set up in a redundant configurationdepends on the HDI model. A configuration where nodes are made redundantis called a cluster configuration, and a configuration where a node is notmade redundant with another node is called a single-node configuration.Which manuals you need to read depends on which configuration you aregoing to use.

Manual name Description

Hitachi Data IngestorInstallation andConfiguration Guide

This is the first manual to read for HDI cluster configurations,and can be used for reference purposes in single-nodeconfigurations. This manual explains how to start HDI systemoperation and the things to keep in mind before operating anHDI system. This manual also explains how to set up an HDIsystem.

Hitachi Data IngestorUser's Guide for SingleNode Configuration

This is the first manual to read for HDI single-nodeconfigurations. This manual explains how to set up, use, andmanage an HDI system. Note that for HDI clusterconfigurations, you do not need to read this manual.

Hitachi Data IngestorUser's Guide

This manual explains how to operate and manage an HDIsystem from a GUI. The manual also explains how to performsystem maintenance and troubleshooting procedures.

Hitachi Data Ingestor CLIUser's Guide

This manual explains how to operate and manage an HDIsystem by using commands.

Hitachi Data IngestorBackup Restore User'sGuide

This manual explains how to back up data by using BackupRestore. The manual also explains the actions to take when asystem error occurs during the operation of Backup Restore.

Hitachi Data IngestorSync Image User's Guide

This manual contains the things to keep in mind beforemanaging differential-data snapshots by using Sync Image.The manual also explains the actions to take when a systemerror occurs during the operation of Sync Image. In addition,this manual also explains how to operate and managedifferential-data snapshots by using commands.

Hitachi Data IngestorError Codes

This manual contains HDI messages, as well as the causesand actions to take for each message.

Hitachi Data IngestorGetting Started Guide

This manual explains how to initially set up a clustered HDIsystem and how to start operation by linking the HDI systemto an HCP system that uses the same storage subsystems.

Hitachi Data Ingestor APIReference (This manual)

This manual explains the information required to use the APIto develop application programs that manage HDI systems.

Preface ixHitachi Data Ingestor API Reference

Manual name Description

Hitachi Data Ingestor FileAccess (CIFS/NFS) User'sGuide

This manual contains the things to keep in mind before usingthe CIFS or NFS service of an HDI system from a CIFS orNFS client.

Referenced documentsThe following Hitachi referenced documents can be found on the applicableHitachi documentation CD:

HCP manuals

• Hitachi Content Platform Administering HCP

• Hitachi Content Platform Managing the Default Tenant and Namespace

• Hitachi Content Platform Managing a Tenant and Its Namespaces

• Hitachi Content Platform Using the Default Namespace

• Hitachi Content Platform Using a Namespace

• Hitachi Content Platform Replicating Tenants and Namespaces

• Hitachi Content Platform Searching Namespaces

• Hitachi Content Platform Using the HCP Client Tools

• Hitachi Content Platform Installing an HCP System

• Hitachi Content Platform Installing an HCP500 System - Final OnsiteSetup

• Hitachi Content Platform Installing an HCP300 System - Final OnsiteSetup

• Hitachi Content Platform Using HCP Data Migrator

• Hitachi Content Platform HCP Management API Reference

Abbreviation conventionsThis manual uses the following abbreviations for product names:

Abbreviation Full name or meaning

Device Manager Hitachi Device Manager Software

Dynamic Provisioning Hitachi Dynamic Provisioning

File Services Manager A generic name for the following:

• Configuration Manager

• Hitachi File Services Manager

HCP Hitachi Content Platform

HDI Hitachi Data Ingestor

Hitachi AMS1500 Hitachi Adaptable Modular Storage 1500

Hitachi AMS2000 series Hitachi Adaptable Modular Storage 2000 series

x Preface


Abbreviation Full name or meaning

Internet Explorer Windows(R) Internet Explorer(R)

ShadowImage A generic name for the following:

• ShadowImage

• ShadowImage in-system replication

TrueCopy A generic name for the following:

• TrueCopy

• TrueCopy Asynchronous

• TrueCopy Extended Distance

• TrueCopy remote replication

Universal Storage Platform V/VM A generic name for the following:

• Hitachi Universal Storage Platform V

• Hitachi Universal Storage Platform VM

Virtual Storage Platform Hitachi Virtual Storage Platform

Windows Microsoft(R) Windows(R) Operating System

Document conventionsThis document uses the following typographic conventions:

Convention Description

Bold Indicates text on a window, other than the window title,including menus, menu options, buttons, fields, andlabels. Example: Click OK.

Italic Indicates a variable, which is a placeholder for actual textprovided by the user or system. Example: copy source-filetarget-fileNote: Angled brackets (< >) are also used to indicatevariables.

screen/code Indicates text that is displayed on screen or entered bythe user. Example: # pairdisplay -g oradb

< > angled brackets Indicates a variable, which is a placeholder for actual textprovided by the user or system. Example: # pairdisplay-g <group>Note: Italic font is also used to indicate variables.

[ ] square brackets Indicates optional values. Example: [ a | b ] indicatesthat you can choose a, b, or nothing.

{ } braces Indicates required or expected values. Example: { a |b } indicates that you must choose either a or b.

| vertical bar Indicates that you have a choice between two or moreoptions or arguments. Examples: [ a | b ] indicates thatyou can choose a, b, or nothing. { a | b } indicates thatyou must choose either a or b.

... The item or items preceding the ellipsis (...) can berepeated. To specify multiple items, use a comma (,) to

Preface xiHitachi Data Ingestor API Reference

Convention Descriptiondelimit them. Example: A,B...indicates that B can bespecified as many times as necessary after A.

Convention for storage capacity valuesPhysical storage capacity values (e.g., drive capacity) are calculated based onthe following values:

Physical Capacity Unit Value

1 KB 1,000 bytes

1 MB 1,0002 bytes

1 GB 1,0003 bytes

1 TB 1,0004 bytes

1 PB 1,0005 bytes

1 EB 1,0006 bytes

Logical storage capacity values (e.g., logical device capacity) are calculatedbased on the following values:

Logical Capacity Unit Value

1 KB 1,024 (210) bytes

1 MB 1,024 KB or 1,0242 bytes

1 GB 1,024 MB or 1,0243 bytes

1 TB 1,024 GB or 1,0244 bytes

1 PB 1,024 TB or 1,0245 bytes

1 EB 1,024 PB or 1,0246 bytes

1 block 512 bytes

Getting helpIf you need to call the Hitachi Data Systems Support Center, please provideas much information about the problem as possible, including:

• The circumstances surrounding the error or failure.

• The exact content of any error message(s) displayed on the hostsystem(s).

• The exact content of any messages displayed on Storage Navigator.

• The Storage Navigator configuration information (use the FD Dump Tool).This information is used by service personnel for troubleshootingpurposes.

• The service information messages (SIMs), including reference codes andseverity levels, displayed by Storage Navigator and/or logged at the host.

xii Preface


The Hitachi Data Systems customer support staff is available 24 hours a day,seven days a week. If you need technical support, please log on to theHitachi Data Systems Portal for contact information: https://portal.hds.com

CommentsPlease send us your comments on this document: [email protected] the document title, number, and revision, and refer to specificsection(s) and paragraph(s) whenever possible.

Thank you! (All comments become the property of Hitachi Data SystemsCorporation.)

Preface xiiiHitachi Data Ingestor API Reference

https://portal.hds.com

https://portal.hds.com

xiv Preface


1Overview of the API

The Hitachi Data Ingestor (HDI) API is an interface used for creatingapplication programs that manage HDI systems that are located in each sitefrom the data center.

This chapter provides an overview of the HDI API. The topics covered by thischapter include system configurations, resources and properties, HTTPmethods, how to execute requests, HTTP status codes, I/O formats forrequests and responses, query parameters, request headers, and responseheaders.

□ What you can do by using the API

□ System configurations

□ Resources and properties

□ HTTP methods

□ How to execute a request

□ HTTP status codes

□ I/O formats for requests and responses

□ Query parameters

□ Request headers

□ Response headers

□ Response XML when an error occurs

Overview of the API 1-1Hitachi Data Ingestor API Reference

What you can do by using the APIHDI provides an API in the HTTP REST (Representational State Transfer)interface format. The API automates the settings for connecting HDI to thenetwork and the operations such as for creating file systems.

By linking HDI with Hitachi Content Platform (HCP) via the network, you cancreate an application at the core site that centrally manages the HDI systemsat the edge sites and the HCP system at the core site. Central managementfrom the core site reduces the data management workload of the systemadministrators at each edge site.

System configurationsThe following figure shows examples of a system configuration in which theHDI API is used.

Figure 1-1 Examples of a system configuration

HDIThe HDI system provides services related to file systems for networkclients.The HDI system can be created in either a cluster configuration or asingle-node configuration.The HDI system in a cluster configuration consists of two HDI nodes thatare managed as a single entity. The API is deployed on each HDI node.The HDI system in a single-node configuration consists of only one HDInode.

HDI API clientThe HDI API client uses the API to connect to the HDI system andmanages the HDI node. The HDI API client uses the API to send arequest, and then receives the processing results (a response) from theAPI. The HDI API client must be set so that it can communicate with theHDI node.

HCP

1-2 Overview of the API


The HCP system archives large volumes of content generated by a varietyof systems for long-term storage.

Client utilizing a file systemA client can use a CIFS or NFS share to access a file system. A clientutilizing a file system connects to the HDI data port.

Resources and propertiesYou can manage resources by using the HDI API. Resources includeFileSystems, ProcessingNode, Routings, and others.

Each resource has a property whose value defines the resource.

Some properties are treated as resources.

Each resource is identified by using a URI. For example, the following URIindicates a FileSystems resource named fs01 in the HDI system namedsystem.example.com:https://system.example.com:9090/mapi/FileSystems/fs01Each property has the String, Integer, or Boolean data type. For example,the data type of the fileSystemName property of a FileSystems resource isString.

HTTP methodsTable 1-1 Supported HTTP methods on page 1-3 describes the HTTP/1.1methods supported by the HDI API.

Table 1-1 Supported HTTP methods

Method DescriptionGET Acquires information about the resource indicated by the request

URI.

PUT Adds information to the resource indicated by the request URI.

POST Changes the information about the resource indicated by the requestURI.

DELETE Deletes the resource indicated by the request URI.

HEAD Acquires the meta-information of the resource indicated by therequest URI.Unlike the GET method, the response of this method includes onlymeta-information and does not include a message body.

OPTIONS Checks the methods that can be used for the resource indicated bythe request URI.

The HDI API allows you to use the OPTIONS method for any resource URI.When the OPTIONS method request is used for a specific resource URI, the


method returns the types of usable HTTP methods and the MIME typessupported by these HTTP methods.

When the OPTIONS method request is used, it returns the followinginformation:

• Allow header

A list of HTTP methods supported by the request URI.For example, if the OPTIONS method request is used for a URI thatsupports the GET, HEAD, and POST methods, the Allow header is returnedas follows:Allow: OPTIONS, GET, HEAD, POST

• WADLA WADL document describes the MIME types supported by the HTTPmethods regarding the request URI. A WADL document is an XMLdocument that defines Web service specifications.

The WADL document is set in the body of the response to an OPTIONS methodrequest.

The following shows an example of the WADL XML document output when theOPTIONS method request is used for a FileSystems resource.<?xml version="1.0" encoding="UTF-8" standalone="yes"?><application xmlns="http://research.sun.com/wadl/2006/10"> <doc jersey:generatedBy="Jersey: 1.1.5 01/21/2011 03:50 PM" xmlns:jersey="http://jersey.dev.java.net/"/> <resources base="https://hdi.example.com:9090/mapi/"> <resource path="FileSystems"> <method id="getFileSystems" name="GET"> <response> <representation mediaType="application/xml"/> </response> </method> <method id="createFileSystem" name="PUT"> <request> <representation mediaType="application/xml"/> </request> <response> <representation mediaType="*/*"/> </response> </method> </resource> </resources></application>

How to execute a requestThis manual uses the curl command (version 7.18.2) to use a RESTinterface.

This section describes how to send a request method by using the curlcommand in a cluster configuration. For details about the user name andpassword specified for the curl command, see Authentication cookie on page2-3.



When using the GET methodYou can use the GET method to acquire resource information. Resourceinformation is returned in XML format.

To acquire information about the file system named fs, execute the curlcommand as follows:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/?prettyprint" -k -X GET -H "Accept: application/xml"After you execute the curl command, the status code, header, and resourceinformation are displayed as follows:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:13 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 734X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystems> <FileSystem> <fileSystemName>aaa</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize> <aclType>Classic ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu1C</deviceFileName> </LU> </LUs> </FileSystem> <FileSystem> <fileSystemName>ttt</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize> <aclType>Classic ACL</aclType> <WormSetting> <maxRetention>10000-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs>


<LU> <deviceFileName>lu20</deviceFileName> </LU> </LUs> </FileSystem> <FileSystem> <fileSystemName>sites</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu1B</deviceFileName> </LU> <LU> <deviceFileName>lu15</deviceFileName> </LU> </LUs> </FileSystem></FileSystems>

When using the PUT methodYou can use the PUT method to add information to a resource. Create a filecontaining the contents you want to request in XML format, and then executethe curl command.

To expand the capacity of a file system named fs and change the WORMattribute:

1. Create a file named fscreate.xml containing the following information:<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FileSystem> <fileSystemName>fs</fileSystemName> <aclType>Advanced ACL</aclType> <isLvmEnabled>true</isLvmEnabled> <stripeSize>64</stripeSize> <isLvmStripingEnabled>true</isLvmStripingEnabled> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> </WormSetting> <LUs> <LU> <deviceFileName>lu04</deviceFileName> </LU> <LU> <deviceFileName>lu05</deviceFileName> </LU>



</LUs></FileSystem>

2. Execute the curl command as follows:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems" -k -d @fscreate.xml -X PUT -H "Content-Type: application/xml"After you execute the curl command, the status code and header aredisplayed as follows:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:42 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Create file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

When using the POST methodYou can use the POST method to change resource information. Create a filecontaining the contents you want to request in XML format, and then executethe curl command.

To edit a file system named fs:

1. Create a file named fsmod.xml containing the following information:<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <WormSetting> <isAutoCommitEnabled>true</isAutoCommitEnabled> <autoCommitPeriod>0-0-15</autoCommitPeriod> <defaultRetention>10950-0-0</defaultRetention> </WormSetting> <addLUs> <LU> <deviceFileName>lu06</deviceFileName> </LU> <LU> <deviceFileName>lu07</deviceFileName> </LU> </addLUs></FileSystem>

2. Execute the curl command as follows:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -d @fsmod.xml -X POST -H "Content-Type: application/xml"After you execute the curl command, the status code and header aredisplayed as follows:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:20 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00


X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Expand file system, [2]Edit file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

When using the DELETE methodYou can use the DELETE method to delete resource information.

To create a file system named fs, execute the curl command as follows:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -X DELETE -H "Content-Type: application/xml"After you execute the curl command, the status code and header aredisplayed as follows:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:27 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Delete file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

When using the HEAD methodYou can use the HEAD method to check whether a resource exists.

To check whether the file system named fs exists, execute the curlcommand as follows:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -X HEAD -H "Content-Type: application/xml"After you execute the curl command, the status code and header aredisplayed as follows:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:11 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 685X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

HTTP status codesAn HDI system returns an HTTP status code in response to a request from anHDI API client.



If method execution succeeds, the HDI system generates a status code, andthen returns the status code as a response via the API. For GET methods,response XML is returned in addition to status codes. The response XMLreturned for a GET method request contains detailed information about theresource indicated by the URI.

Table 1-2 HTTP status codes that can be generated when a requestterminates normally on page 1-9 describes the status codes that can begenerated when a request terminates normally.

Table 1-2 HTTP status codes that can be generated when a requestterminates normally

Status code Applicablemethod Description

200 OK All methods The HDI system successfully created a resource,changed a resource, deleted a resource, acquiredinformation about a resource, or confirmed theexistence of a resource.

202 Accepted All methods This status code means that HDI processing hasbeen requested, but completion of the processingis not guaranteed.Wait a while, and then check the resource statusto make sure that the processing has completednormally.

If method execution fails, the HDI system returns a status code that indicatesthe type of error along with error information set in the response header viathe API. The status code returned when a failure occurs is determined by thecause of the failure.

Table 1-3 HTTP status codes that can be generated when a requestterminates abnormally on page 1-9 describes the status codes that can begenerated when a request terminates abnormally. Status codes defined byRFC2068, which are not described in Table 1-3 HTTP status codes that can begenerated when a request terminates abnormally on page 1-9 might alsobe returned.

Table 1-3 HTTP status codes that can be generated when a requestterminates abnormally


302 FOUND All methods The request was not valid. The following arepossible causes:

• The api-auth cookie does not exist.

• An invalid certificate is specified.

400 BAD_REQUEST All methods The request was not valid. The following arepossible causes:

• A required query parameter was not specifiedin the request.



• When a PUT or POST method request wasused, any of the following conditions weremet:- A required property was not specified in therequest body.- The request body contains an invalidproperty.- The request body contains an XML whoseformat is invalid.- Data-type checking failed.- The request body contains an invalid value.

• A nonexistent MIME type was specified for theContent-Type or Accept header in therequest.

401 UNAUTHORIZED

All methods The user account specified in the request headerwas denied during authentication.

403 FORBIDDEN PUTPOSTDELETE

When the PUT or POST method was requested, therequest failed although valid properties werespecified.Alternatively, when the DELETE method requestwas used, the HDI system could not delete the filesystem for one of the following reasons:

• The file system was being used by the backupfunctionality.

• The file system contained files for which aretention period was set.

404 NOT_FOUND All methods The resource indicated by the URI does not exist.

405 METHOD_NOT_ALLOWED

GETPUTPOSTDELETE

The requested processing is not valid for theresource indicated by the URI.

406 NOT_ACCEPTABLE

GET An invalid MIME type is specified in the Acceptheader that was specified when the request wasmade.

409 CONFLICT PUTPOST

When the PUT method request was used, the HDIsystem could not create a resource because theresource already exists.Alternatively, when the POST method request wasused for a Routings resource, the HDI system wasunable to set a new route because the routealready exists.

415 UNSUPPORTED_MEDIA_TYPE

All methods The HDI system does not support the MIME typespecified for the Content-Type or Accept header.

500 INTERNAL_SERVER_ERROR

All methods An error occurred in the processing of the node towhich the request was sent.

503 SERVICE_UNAVAILABLE

All methods Requests cannot be temporarily accepted becausethe system is under a heavy load or is undergoingmaintenance.Wait a while, and then reissue the request.



I/O formats for requests and responsesWhen you use the API to create or change a resource, specify resourceproperties in XML format. To acquire information about a resource, responsesto the OPTIONS request are in WADL format.

You can use the following URI to download the XML schema to be used by theHDI API for the request body and the response body:https://host-name-or-IP-address:9090/mapi/static/mapi-3_0.xsdAll responses that are returned through the API are encoded in UTF-8. Thebody of requests created as input for the HDI API must also be encoded inUTF-8.

The HDI API supports the MIME types listed in Table 1-4 Supported MIMEtypes on page 1-11. These MIME types can be specified as I/O formats forrequests and responses.

Table 1-4 Supported MIME types

MIME type Descriptionapplication/xml XML format

application/octet-stream Multiple requests (for uploading or downloading thecontents of files)

Query parametersIn the HDI API, you can use the query parameters listed in Table 1-5Supported query parameters on page 1-11.

Query parameters are specified following a question mark (?) appended to aresource URI. If multiple query parameters are specified, ampersands (&) areused as parameter separators. Note that query parameters are casesensitive.

Table 1-5 Supported query parameters

Queryparameter

Applicableresource

Applicable method Description

otherNode MigrationTask

Allmethods

The otherNode query parameter is usedwhen a resource group in a clusterconfiguration is to be specified forprocessing.If true is specified, processing isperformed for the resource group thatnormally runs on the node not requestedby the method.If false is specified, processing isperformed for the resource group thatnormally runs on the node requested bythe method.


Queryparameter

Applicableresource

Applicable method Description

If the otherNode query parameter is notspecified, the method operates the sameway as when false is specified.Example:

MigrationTask?otherNode=trueprettyprint All resources All

methodsThe prettyprint query parameter is usedto specify the output format.If the prettyprint query parameter isspecified, the XML is output in an easy-to-read format that uses line breaks andindentation.If the prettyprint query parameter is notspecified, neither line breaks norindentation is used in the output XML.Example:

FileSystems?prettyprintSHARE-DIRECTORY-NAME

• CIFSShares/CIFS-share-name

• NFSShares/NFS-share-directory-name

GETPOSTDELETEHEAD

The SHARE-DIRECTORY-NAME queryparameter is used to uniquely distinguishresources that have the same name.This parameter must be specified when theCIFSShares/CIFS-share-name resource orthe NFSShares/NFS-shared-directory-nameresource is used.Example:

CIFSShares/CIFS-share-name?SHARE-DIRECTORY-NAME=path-name-of-shared-directory

verbose All resources GET The verbose query parameter is used tospecify the information to be output whenthe GET method request is used.If true is specified, all properties containedin the resource are output.If false is specified, only the propertiesthat the PUT or POST method can processare output.The XML output when the GET methodrequest is used can be used as an XMLtemplate for using the PUT or POST methodrequest.If the verbose query parameter is notspecified, the method operates the sameway as when false is specified.Example:

ProcessingNode?verbose=true

Request headersTable 1-6 Request headers on page 1-13 describes the request headers setby HDI API clients.



Table 1-6 Request headers

Request header DescriptionCookie User authentication details for a request.

If a request does not contain a cookie, an error is returned.

Accept A list of MIME types for responses that the HDI API client canprocess.If an invalid MIME type has been set, an error is returned.

Content-Type The media type of the content sent to the recipient.This header can be used when the PUT or POST method request isused.If an invalid MIME type has been set, an error is returned.

Response headersTable 1-7 Response headers on page 1-13 describes the response headersset by the HDI API.

Table 1-7 Response headers

Response header Description Format of the setvalue

When the headeris set

Status Code A status codeindicating theprocessing result.A status code is setin any type ofrequest.

Number This header isalways set.

X-NODE-APIVersionID

The version numberof the HDI API.If the correspondingCLI commands orproperties do notexist, Unknown isdisplayed.

String(Same format as theHDI version number)

This header isalways set.

Content-Type The media type ofthe content sent tothe recipient

MIME typeapplication/xml ortext/plain isreturned. Ifapplication/xml isset, evaluate theentity body.

application/xml isset if the GETmethod request isterminatedsuccessfully.

Content-Length The size of thecontent sent to therecipient. The size isrepresented as adecimal octet (eightbits).

Number This header is setonly if the GETmethod request isterminatedsuccessfully.

X-NODE-ErrorMessageID

The message ID ofan error that

String This header is set ifa request fails.


Response header Description Format of the setvalue

When the headeris set

occurred duringprocessing

X-NODE-OperationList

The names of all theprocesses executedby the request.If the request wasnot executed, ahyphen (-) isdisplayed.

StringCommand nameslisted in thefollowing format:[1]processing-name-1,[2]processing-name-2,...If multiple processesare executed, theyare separated bycommas (,).

This header isalways set.

X-NODE-CompletedOperation

The number ofprocesses executedsuccessfully.If the request wasnot executed, ahyphen (-) isdisplayed.

Number This header isalways set.

Response XML when an error occursInformation regarding an error that occurs during processing is returned asresponse XML via the API. The following table shows the structure of theresponse XML when an error occurs.

Table 1-8 Structure of the response XML when an error occurs

Property DescriptionError --

-- messageId The message ID of the error message

message The message text of the error message

cause The cause of the error

recoveryAction The recovery action for the error



2Access and Authentication

For the HDI API, URIs are used to identify resources. Each request mustspecify one URI and must contain a certificate of the account that is used toaccess the HDI system via the API.

This chapter explains the URI used to access an HDI system, notes pertainingto URIs specified for API requests, how to specify authentication cookies, andSSL certificates.

□ URI and account for accessing an HDI system

□ Notes on URIs

□ Authentication cookie

□ SSL certificate

Access and Authentication 2-1Hitachi Data Ingestor API Reference

URI and account for accessing an HDI systemIn each request sent to the HDI API, a resource URI must be specified in thefollowing format:https://HDI-node-host-name-or-IP-address:9090/mapiAs the port number, all resource URIs must contain 9090, which is the portnumber used by the HDI API. Note that mapi must be lower case.

The account used to access the API is admin.

In a cluster configuration, the initial password for admin is chang3me!. In asingle-node configuration, the account used to access the API is the same asthe account used to log in to the GUI. If you have not changed the passwordfor the GUI login account, the initial password for admin is chang3me!. Toprevent unauthorized access, make sure that you change the password. Fordetails about how to change the password for admin, see APIAccount on page3-4.

Notes on URIsThis section provides notes on the URIs specified in API requests.

Maximum URI lengthThe maximum length of the URI (excluding the query parameters) thatfollows mapi is 4,095 bytes. If a request contains a URI whose length exceedsthe maximum, the HDI system returns status code 414(REQUEST_URI_TOO_LARGE).

Encoding of specific characters and valuesSome characters and values must be encoded in order to use them in a URI.

Base64 encoding must be used to encode the following values:

• CIFS-share-name

• policy-name

• SHARE-DIRECTORY-NAME query parameter

Characters listed in Table 2-1 Characters that must be percent-encoded onpage 2-3 must be percent-encoded.

Note:If the result of Base64 encoding includes characters listed in Table 2-1Characters that must be percent-encoded on page 2-3, thosecharacters must be percent-encoded.

The following is an encoding example:

1. Use Base64 encoding to encode the CIFS share name.

2-2 Access and Authentication


For this example, the result of Base64 encoding is PX5+U2hhcmU=.

2. Percent-encoding the plus sign (+) in PX5+U2hhcmU= replaces the plus signwith %2B.

The result of percent-encoding is PX5%2BU2hhcmU=.

Table 2-1 Characters that must be percent-encoded

Character Percent-encoded value

Space %20Tab %09Carriage return %0ALine feed %0DPlus sign (+) %2BPercent sign (%) %25Hash mark (#) %23Question mark (?) %3FAmpersand (&) %26Forward slash (/)# %2F

#: Do not percent-encode forward slashes if they are used as URI delimiters.

Quotation marks on the command lineA Windows or UNIX shell is used when the HDI API is used. Note that somecharacters used in commands have special meanings for the shell. Forexample, an ampersand (&), which is used as a query parameter separator inURIs, indicates that a process is to be processed in the background.

To prevent the Windows or UNIX shell from misinterpreting characters inURIs, make sure that the entire URI is enclosed in double quotation marks(").

Using multi-byte charactersUnicode (UTF-8) multi-byte characters can be used for the request URI andrequest XML of the following resources:

• /CIFSShares/CIFS-share-name

• /MigrationTask/policy-name

Authentication cookieTo access an HDI system via the API, a certificate consisting of a user nameand a password is required for each request. An api-auth cookie is used tospecify a certificate.

Access and Authentication 2-3Hitachi Data Ingestor API Reference

Each request sent to the HDI API is always authenticated before it isprocessed. The information needed for authentication is set in a requestheader by using a cookie generated by the HDI API client. The cookie valueconsists of a user name encoded in Base64 and a password generated byusing the MD5 hash algorithm.

The following shows the format of api-auth cookies:api-auth=user-name-encoded-in-Base64:password-generated-by-MD5-hash-algorithm

Use tools that convert plain texts into Base64-encoded values and MD5 hashvalues to generate api-auth cookie values. However, we recommend thatyou do not use a Web-based interactive tool because of the reduced level ofsecurity.

A certificate sent in a request header is checked against the user informationstored in the database. If the request sent to the server is authenticatedsuccessfully, the request is validated as being in the correct format. Ifauthentication fails, a status code for the processing abnormally terminatingis returned.

SSL certificateThe certificate stored in an HDI system is a self-signed certificate.

Install the server certificate sent from the HDI system onto the API client as atrusted server certificate. If the certificate cannot be installed on the client,use the server certificate for SSL encrypted communication.

2-4 Access and Authentication


3Resources

This chapter describes the types of HTTP methods that can be used forrequests, the structure of request XMLs and response XMLs for each method,the details of properties, the URIs of the resources to which requests aresent, and the status codes returned when methods end. The OPTIONS methodcan be used for all resources, but is omitted from the tables in this chapter.

□ List of resources

□ APIAccount

□ CIFSShares

□ Disk

□ FCPaths

□ FileSystems

□ Hardware

□ HCP

□ LUs

□ MigrationTask

□ NetworkInterfaces

□ NFSShares

□ ProcessingNode

Resources 3-1Hitachi Data Ingestor API Reference

□ Routings

□ SystemController

3-2 Resources


List of resourcesThe following table describes resources according to how they are used andwhere to find additional information.

Table 3-1 Resources according to purpose of use

Use Resource name Description Reference

Managing useraccounts

APIAccount Manage the APIadministrator account.

APIAccounton page3-4

Managing nodes ProcessingNode Manage cluster and nodeinformation.

ProcessingNode on page3-156

Managing networks NetworkInterfaces Manage network interfaceinformation.

NetworkInterfaces on page3-117

Routings Manage routinginformation.

Routings onpage 3-164

Controlling services SystemController Control services and OSs. SystemController on page3-170

Acquiring statuses FCPaths Acquire the FC pathstatus.

FCPaths onpage 3-46

Hardware Acquire the hardwarestatus.

Hardware onpage 3-80

Managing file systems LUs Acquire the LU status. LUs on page3-98

Disk Acquire the total capacityand unused capacity of auser disk.

Disk on page3-44

FileSystems Manage file systeminformation.

FileSystemson page3-49

Managing shares CIFSShares Manage CIFS shareinformation.

CIFSShareson page3-7

NFSShares Manage NFS shareinformation.

NFSShares onpage 3-131

Configuring HCPlinkage

HCP Manage HCP information. HCP on page3-93

MigrationTask Manage data migration toHCP.

MigrationTaskon page3-103


APIAccount

APIAccount resource overviewYou can use the APIAccount resource to change the passwords of APIadministrator accounts and acquire information.

The following table describes the HTTP methods that can be used for theAPIAccount resource.

Table 3-2 HTTP methods that can be used for the APIAccount resource

Resource URI HTTP method Supportedconfigurations Description

/APIAccount GET Cluster,single node

Acquires API administratoraccount information.

POST Cluster,single node

Changes the password of the APIadministrator account.

APIAccount resourceThis section describes how to use the APIAccount resource.

Acquiring API administrator account information by using the GET method

Execute the GET method to acquire API administrator account informationfrom a database.

The following table describes the structure of the response XML output whenthe method ends.

Table 3-3 Structure of the response XML when a GET method request issent to the APIAccount resource

PropertiesNumber of

response XMLsoutput

Supportedconfigurations

Displayed valuewhen verbose is

false

APIAccount 1 Cluster,single node

Y

-- userName 1 Cluster,single node

Y

password 1 Cluster,single node

Y#

Legend: Y: Displayed.

#: The password is displayed as spaces.

The following table describes the properties displayed when a GET methodrequest is sent to the APIAccount resource.

3-4 Resources


Table 3-4 Properties displayed when a GET method request is sent to theAPIAccount resource

Properties Description

APIAccount --

-- userName Displays the user name of the API administrator account (admin).

password A null string is always displayed.

The following shows an example of acquiring API administrator accountinformation by sending a GET method request to the APIAccount resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/APIAccount

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><APIAccount> <userName>admin</userName > <password></password></APIAccount>The following table describes the status code output when the method ends.

Table 3-5 Status codes returned when a GET method request is sent to theAPIAccount resource

Status code Description

200 Execution of the method ended successfully.

Other codes Execution of the method ended abnormally. See Table 1-3 HTTPstatus codes that can be generated when a request terminatesabnormally on page 1-9.

Changing the API administrator account password by using the POST method

In a cluster configuration, the initial password is chang3me!. In a single-nodeconfiguration, the API administrator account is the same as the account to login to the GUI. If you have not changed the password for the GUI loginaccount, the initial password for admin is chang3me!. To preventunauthorized access, make sure that you change the password.

Important:You need the set password for operating and managing HDI. Do notforget the password.

Note:The request becomes effective only on the node on which it is executed.To change the password in a cluster configuration, send the same POSTmethod request to both nodes.


The following table describes the XML structure when a POST method requestis sent to the APIAccount resource.

Table 3-6 XML structure when the POST method is used to send a requestto the APIAccount resource

Properties Data type Number of items thatcan be specified


APIAccount -- 1 Cluster,single node

-- userName String 1 Cluster,single node

password String 1 Cluster,single node

The following table describes the properties to be specified when sending aPOST method request to the APIAccount resource.

Table 3-7 Properties used to send a POST method request to theAPIAccount resource

Properties Description Specification

APIAccount -- --

-- userName Sets the user name of the API administrator. Onlyadmin can be specified.

Required

password Sets the password of the API administrator.You can use alphanumeric characters,exclamation marks (!), hash marks (#), dollarsigns ($), percent signs (%), ampersands (&),single quotation marks ('), left parentheses ((),right parentheses ()), asterisks (*), plus signs(+), hyphens (-), periods (.), equal signs (=),carets (^), underscores (_), vertical bars (|),backslashes (\), and at marks (@).You can specify 4 to 256 characters.

Required

The following shows an example of changing the password of the APIadministrator account by sending a POST method request to the APIAccountresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/APIAccount

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><APIAccount> <userName>admin</userName> <password>password</password></APIAccount>The following table describes the status codes output when the method ends.

3-6 Resources


Table 3-8 Status codes returned when a POST method request is sent tothe APIAccount resource



400 Execution of the method failed.

500 An SQL exception or a database connection error occurred.


CIFSShares

CIFSShares resource overviewYou can use the CIFSShares resource to manage CIFS shares.

The following table describes the HTTP methods that can be used for theCIFSShares resource.

Table 3-9 HTTP methods that can be used for the CIFSShares resource


/CIFSShares GET Cluster,single node

Acquires all information aboutCIFS shares.

PUT Cluster,single node

Adds a CIFS share.

/CIFSShares/CIFS-share-name#1

GET#2 Cluster,single node

Acquires information about thespecified CIFS share.

POST#2 Cluster,single node

Changes information about thespecified CIFS share.

DELETE#2 Cluster,single node

Deletes the specified CIFS share.

HEAD#2 Cluster,single node

Checks whether the specified CIFSshare exists.

#1: For CIFS-share-name, specify the name of the directory at the lowestlevel of the shared directory.

#2: Specify the path name of the shared directory by using the queryparameter SHARE-DIRECTORY-NAME. You must use Base64 to encode the pathname.

CIFSShares resourceThis section describes how to use the CIFSShares resource.


Acquiring information about all CIFS shares by using the GET method


Table 3-10 Structure of the response XML when a GET method request issent to the CIFSShares resource

PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

CIFSShares 1 Cluster,single node

Y

-- CIFSShare 0 or 1 to n Cluster,single node

Y

-- exportPoint 1 Cluster,single node

Y

cifsShareName 1 Cluster,single node

Y

isAclEnabled 1 Cluster,single node

Y

restrictionTargetHosts

1 Cluster,single node

Y

isAccessRestrictionAllowed


Y

commentForShare


Y

isReadOnly 1 Cluster,single node

Y

isBrowseEnabled 1 Cluster,single node

Y

fileAccessPermissionOfOwner


Y

fileAccessPermissionOfGroup


Y

fileAccessPermissionOfOther


Y

directoryAccessPermissionOfOwner


Y

directoryAccessPermissionOfGroup


Y

directoryAccessPermissionOfOther


Y

guestAccessPermission


Y

diskSynchronizationPolicy


Y

3-8 Resources


PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

cifsClientCacheSetting


Y

fileTimestampChangeableUsers


Y

isHomeDirectoryEnabled


Y

aclType 1 Cluster,single node

N

clientAccessPolicy


Y

vssUse 1 Cluster,single node

Y

cifsClientRoCacheOptimize


Y

accessBasedEnumeration


Y

writeDisallowedUsers


Y

writeDisallowedGroups


Y

writeAllowedUsers


Y

writeAllowedGroups


Y

Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed.

The following table describes the properties displayed when a GET methodrequest is sent to the CIFSShares resource.

Table 3-11 Properties displayed when a GET method request is sent to theCIFSShares resource


CIFSShares --

-- CIFSShare --

-- exportPoint Displays the path name of the shareddirectory.

cifsShareName Displays the CIFS share name.

isAclEnabled Displays whether an ACL is used.true

An ACL is used.

falseAn ACL is not used.

restrictionTargetHosts Displays the host for which accessrestriction is set.




Displays whether access restriction is set.true

Displayed when access restriction isset.

falseDisplayed when access restriction isnot set.

commentForShare Displays the CIFS share comment.

isReadOnly Displays the access privilege for the CIFSshare.true

Read-only is set.

falseRead-only is not set.

isBrowseEnabled Displays whether to display the CIFS sharename in the list on the client computer.true

The share name is displayed.

falseThe share name is not displayed.


Displays the access privileges the ownerhas for a file.rw

Read and write are permitted.

roOnly read is permitted.

noneNeither read nor write are permitted.

UnknownThe ACL type could not be acquired.


Displays the access privileges a group hasfor a file.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges others havefor a file.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges the ownerhas for a directory.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges a group hasfor a directory.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges others havefor a directory.

3-10 Resources


Properties DescriptionFor details about displayed values, seefileAccessPermissionOfOwner.

guestAccessPermission Displays whether to allow access from theguest account.allow

Access from the guest account isallowed.

disallowAccess from the guest account isdenied.

defaultThe default settings of the CIFS serviceconfiguration definitions set in theCIFS Service Management page ofthe GUI are used.

diskSynchronizationPolicy Displays the behavior for a write or closerequest from a client.write_and_close

Data is written synchronously with awrite request or a close request issuedfrom a client to a CIFS share.

closeData is written synchronously with aclose request issued from a client to aCIFS share.

noneData is written at a fixed interval.


cifsClientCacheSetting Displays whether to cache updated data forfiles in the CIFS share on a client.use

Data for read-only access is cached.

do_not_useData for read-only access is notcached.



Displays the users who can update the timestamps of files in the CIFS share.write_permitted_users

Timestamp updating is permitted forall users who are permitted to write tothe file.


Properties Descriptionowner_only

Timestamp file updating is limited tothe file owner only.


isHomeDirectoryEnabled Displays whether to enable automaticcreation of the home directory of the CIFSshare.true

Automatic creation of the homedirectory is enabled.

falseAutomatic creation of the homedirectory is disabled.

aclType Displays the ACL type for the file system.Advanced ACL

The ACL type is Advanced ACL.

Classic ACLThe ACL type is Classic ACL.


clientAccessPolicy Displays the method for processing theaccesses from a CIFS client.parallel

Accesses are handled in parallel.

serialAccesses are handled serially.


vssUse Displays whether to use the VolumeShadow Copy Service to publish a SyncImage differential-data snapshot to a CIFSclient.default

The default settings of the CIFS serviceconfiguration definitions set in theCIFS Service Management page ofthe GUI are used.

do_not_useDisplayed when a Sync Imagedifferential-data snapshot is notpublished to a CIFS client.


Displays whether to use a read-only clientcache when accesses to a file from multipleCIFS clients conflict.

3-12 Resources


Properties Descriptionuse

A read-only client cache is used.

do_not_useA read-only client cache is not used.


accessBasedEnumeration Displays whether to enable access-basedenumeration.use

Access-based enumeration is enabled.

do_not_useAccess-based enumeration is disabled.


writeDisallowedUsers Displays the users who are denied writepermission for the CIFS share.

writeDisallowedGroups Displays the groups who are denied writepermission for the CIFS share.

writeAllowedUsers Displays the users who are allowed writepermission for the CIFS share.

writeAllowedGroups Displays the groups who are allowed writepermission for the CIFS share.

The following shows an example of acquiring all CIFS share information bysending a GET method request to the CIFSShares resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/CIFSShares

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShares> <CIFSShare> <exportPoint>/mnt/aaa/add</exportPoint> <cifsShareName>add</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts></restrictionTargetHosts> <isAccessRestrictionAllowed>false</isAccessRestrictionAllowed> <commentForShare></commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner>rw</fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup>ro</fileAccessPermissionOfGroup>


<fileAccessPermissionOfOther>ro</fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner>rw</directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup>ro</directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther>ro</directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers>default</fileTimestampChangeableUsers> <isHomeDirectoryEnabled>false</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers></writeDisallowedUsers> <writeDisallowedGroups></writeDisallowedGroups> <writeAllowedUsers></writeAllowedUsers> <writeAllowedGroups></writeAllowedGroups> </CIFSShare></CIFSShares>The following table describes the status codes output when the method ends.

Table 3-12 Status codes returned when a GET method request is sent tothe CIFSShares resource




Adding a CIFS share by using the PUT method

The following table describes the XML structure when a PUT method request issent to the CIFSShares resource.

Table 3-13 XML structure when the PUT method is used to send a requestto the CIFSShares resource

Properties Data typeNumber of

items that canbe specified


CIFSShare -- 1 Cluster,single node

-- exportPoint String 1 Cluster,single node

cifsShareName String 1 Cluster,

3-14 Resources





single node

isClassicAcl Boolean 1 Cluster,single node

isAclEnabled Boolean 0 or 1 Cluster,single node

restrictionTargetHosts String 0 or 1 Cluster,single node

isAccessRestrictionAllowed Boolean 0 or 1 Cluster,single node

commentForShare String 0 or 1 Cluster,single node

isReadOnly Boolean 0 or 1 Cluster,single node

isBrowseEnabled Boolean 0 or 1 Cluster,single node

fileAccessPermissionOfOwner String 0 or 1 Cluster,single node

fileAccessPermissionOfGroup String 0 or 1 Cluster,single node

fileAccessPermissionOfOther String 0 or 1 Cluster,single node


String 0 or 1 Cluster,single node





guestAccessPermission String 0 or 1 Cluster,single node

diskSynchronizationPolicy String 0 or 1 Cluster,single node

cifsClientCacheSetting String 0 or 1 Cluster,single node



isHomeDirectoryEnabled Boolean 0 or 1 Cluster,single node

clientAccessPolicy String 0 or 1 Cluster,single node

vssUse String 0 or 1 Cluster,single node

cifsClientRoCacheOptimize String 0 or 1 Cluster,single node

accessBasedEnumeration String 0 or 1 Cluster,single node

writeDisallowedUsers String 0 or 1 Cluster,single node





writeDisallowedGroups String 0 or 1 Cluster,single node

writeAllowedUsers String 0 or 1 Cluster,single node

writeAllowedGroups String 0 or 1 Cluster,single node

DirectorySetup -- 0 or 1 Cluster,single node


groupName String 1 Cluster,single node

isStickyBit Boolean 0 or 1 Cluster,single node

ownerPermission String 0 or 1 Cluster,single node

groupPermission String 0 or 1 Cluster,single node

otherPermission String 0 or 1 Cluster,single node

DirectoryACLSettings -- 0 or 1 Cluster,single node

-- DirectoryACLSetting -- 0 or 1 to n Cluster,single node

-- userGroupAccess

String 1 Cluster,single node

name String 1 Cluster,single node

accountType String 1 Cluster,single node

applicationDestination


inheritanceRange


accessPermission


Legend: n: An integer of 2 or more.

The following table describes the properties to be specified when sending aPUT method request to the CIFSShares resource.

Table 3-14 Properties used to send a PUT method request to theCIFSShares resource


CIFSShare -- --

3-16 Resources



-- exportPoint Sets the absolute path to thedirectory to which a file share will beadded.You can specify 6 to 256 characters.

Required

cifsShareName Sets the CIFS share name.No more than 80 characters can bespecified for a CIFS share name.

Required

isClassicAcl Sets whether the Advanced ACL orClassic ACL type is used foroperation. Specify this setting sothat it matches the ACL type of thefile system to which the shareddirectory belongs.true

Specify this value when the filesystem is the Classic ACL type.

falseSpecify this value when the filesystem is the Advanced ACLtype.

Required

isAclEnabled Sets whether to use an ACL for theCIFS share.true#

Specify this value to use anACL.

falseSpecify this value to not use anACL.

Optional (Canbe set if trueis specified fortheisClassicAclproperty)

restrictionTargetHosts Sets a host for which you restrictaccess to the CIFS share. Whenspecifying multiple hosts, separatethem with a comma (,).Specify a host in the followingformat:When you specify a network address

Specify an IP address (Example:10.203.15.0).

When you specify a network rangeaccording to a netmask

Specify a range in the followingformat:network-address/netmask(Example:10.203.15.0/255.255.255.0)

When you specify host names, editthe /etc/hosts file in the EditSystem File page of the GUI to addall the specified host names and IPaddresses.If you omit this, all hosts ornetworks are selected as the target.If hosts or networks for whichaccess is restricted are set in theCIFS Service Management page

Required if theisAccessRestrictionAllowedproperty is set.


Properties Description Specificationof the GUI, the settings are appliedto all the file shares.


Sets whether to restrict access tothe CIFS share by a host specifiedby the restrictionTargetHostsproperty.true

Specify this value to restrictaccess.

false#

Specify this value to not restrictaccess.

If hosts or networks for whichaccess is restricted are set in theCIFS Service Management pageof the GUI, the settings are appliedto all the file shares.

Required if therestrictionTargetHostsproperty is set.

commentForShare Sets a comment related to the CIFSshare.You can use alphanumericcharacters, exclamation marks (!),hash marks (#), dollar signs ($),ampersands (&), single quotationmarks ('), left parentheses ((),right parentheses ()), asterisks (*),plus signs (+), commas (,), hyphens(-), periods (.), forward slashes (/),colons (:), left angle brackets (<),right angle brackets (>), questionmarks (?), at marks (@), left squarebrackets ([), backslashes (\), rightsquare brackets (]), carets (^),underscores (_), grave accent marks(`), left curly brackets ({), verticalbars (|), right curly brackets (}),and tildes (~). You can also specify aspace, but a string cannot start orend with a space. Also, a stringcannot end with a backslash (\). Inaddition, you can specify multi-bytecharacters. You can use up to 256characters. If you omit this, acomment is not set for the CIFSshare.

Optional

isReadOnly Specify whether to set the CIFSshare as read-only.true

Specify this value to set theshare as read-only.

false#

Specify this value to not set theshare as read-only.

Optional

3-18 Resources



isBrowseEnabled Sets whether to list the names ofthe CIFS shares in a clientenvironment.true#

Specify this value to list thenames.

falseSpecify this value to not list thenames.

Optional


Sets the access privileges the fileowner has.rw#

Specify this value to grant readand write permission.

roSpecify this value to grant readpermission only.

noneSpecify this value to grantneither read nor writepermission.

Required if thefileAccessPermissionOfGroup orfileAccessPermissionOfOther property isset (This canbe set whentheisClassicAclproperty istrue).


Sets the access privileges a grouphas for a file.If you omit this, ro is set.For details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.

Required if thefileAccessPermissionOfOwner orfileAccessPermissionOfOther property isset (This canbe set whentheisClassicAclproperty istrue).


Sets the access privileges othershave for a file.If you omit this, ro is set.For details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.

Required if thefileAccessPermissionOfOwner orfileAccessPermissionOfGroup property isset (This canbe set whentheisClassicAclproperty istrue).


Sets the access privileges the ownerhas for a directory.If you omit this, rw is set.For details about the accessprivileges you can set, see the

Required if thedirectoryAccessPermissionOfGroup ordirectoryAccessPermissionO


Properties Description SpecificationfileAccessPermissionOfOwnerproperty.

fOtherproperty is set(This can beset when theisClassicAclproperty istrue).


Sets the access privileges a grouphas for a directory.If you omit this, ro is set.For details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.

Required if thedirectoryAccessPermissionOfOwner ordirectoryAccessPermissionOfOtherproperty is set(This can beset when theisClassicAclproperty istrue).


Sets the access privileges othershave for a directory.If you omit this, ro is set.For details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.

Required if thedirectoryAccessPermissionOfOwner ordirectoryAccessPermissionOfGroupproperty is set(This can beset when theisClassicAclproperty istrue).

guestAccessPermission Sets whether to allow access fromthe guest account.allow

Specify this value to allowaccess from the guest account.

disallowSpecify this value to denyaccess from the guest account.

default#

Specify this to use the defaultsettings of the CIFS serviceconfiguration definitions set inthe CIFS ServiceManagement page of the GUI.

Optional

diskSynchronizationPolicy Sets the behavior for a write orclose request from a client.write_and_close

Specify this to perform writingsynchronously with a writerequest or a close requestissued from a client to a CIFSshare.

Optional

3-20 Resources


Properties Description Specificationclose

Specify this to perform writingsynchronously with a closerequest issued from a client to aCIFS share.

noneSpecify this to perform writingat a fixed interval.

default#


cifsClientCacheSetting Sets whether to cache updated datafor files in the CIFS share on aclient.use

Specify this value to cache datafor read-only access.

do_not_useSpecify this value to not cachedata for read-only access.

default#


Optional


Sets the users who can update thetime stamps of files in the CIFSshare.write_permitted_users

Specify this if you want topermit timestamp updating forall users who are permitted towrite to the file.

owner_onlySpecify this if you want to limittimestamp file updating to thefile owner only.

default#


Optional (Canbe set if theisClassicAclproperty istrue)

isHomeDirectoryEnabled Sets whether to enable automaticcreation of the home directory of theCIFS share.true

Optional


Properties Description SpecificationSpecify this value to enableautomatic creation of the homedirectory of the CIFS share.

false#

Specify this value to disableautomatic creation of the homedirectory of the CIFS share.

clientAccessPolicy Sets the method for processing theaccesses from a CIFS client.parallel

Specify this to handle access inparallel.

serialSpecify this to handle accessserially.

default#


Optional

vssUse Specifies whether to use the VolumeShadow Copy Service to publish aSync Image differential-datasnapshot to a CIFS client.default#


do_not_useSpecify this if you do not wantto publish a Sync Imagedifferential-data snapshot to aCIFS client.

Optional


Sets whether to use a read-onlyclient cache when accesses to a filefrom multiple CIFS clients conflict.use

Specify this if you want to use aread-only client cache.

do_not_useSpecify this if you do not wantto use a read-only client cache.

default#


Optional

3-22 Resources



accessBasedEnumeration Sets whether to enable access-based enumeration.use

Specify this to enable access-based enumeration.

do_not_useSpecify this to disable access-based enumeration.

default#


Optional

writeDisallowedUsers Sets the users who are denied writepermission for the CIFS share.To specify multiple users, separatethem by using commas (,). If youomit this, no value is set.

Optional

writeDisallowedGroups Sets the groups that are deniedwrite permission for the CIFS share.To specify multiple groups, separatethem by using commas (,). If youomit this, no value is set.

Optional

writeAllowedUsers Sets the users who are grantedwrite permission for the CIFS share.To specify multiple users, separatethem by using commas (,). If youomit this, no value is set.

Optional

writeAllowedGroups Sets the groups that are grantedwrite permission for the CIFS share.To specify multiple groups, separatethem by using commas (,). If youomit this, no value is set.

Optional

DirectorySetup Specify this if you want to create adirectory to be used as a CIFSshared directory and set theattributes of the directory.To check the values set for thisproperty, check if the createdshared directory can be accessedfrom a client.

Optional

-- userName Sets a user name or user ID of theowner for the directory to becreated.For a user ID, specify an ID from 0to 2147483147. Note that, for an IDother than 0, you cannot specify 0at the beginning of the ID.

Required if theDirectorySetup property isset.

groupName Sets a group name or group ID for ashared directory.



Properties Description SpecificationFor a group ID, specify an ID from 0to 2147483147. Note that, for an IDother than 0, you cannot specify 0at the beginning of the ID. If usermapping is used, you cannot specifya built-in group for a Windowsdomain.

isStickyBit Sets whether to use the sticky bit.true

Specify this value to use thesticky bit.

false#

Specify this value to not use thesticky bit.

Optional (Canbe set whentheDirectorySetup property isset)

ownerPermission Sets the access privileges the ownerhas for a shared directory.If you omit this, no access privilegesare set for the ownerPermissionproperty. However, if theisStickyBit, ownerPermission,groupPermission, andotherPermission properties areomitted, rw is set for theownerPermission property.For details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.


groupPermission Sets the access privileges a grouphas for a shared directory.If you omit this, no access privilegesare set for the groupPermissionproperty. However, if theisStickyBit, ownerPermission,groupPermission, andotherPermission properties areomitted, ro is set for thegroupPermission property.For details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.


otherPermission Sets the access privileges othershave for a shared directory.If you omit this, no access privilegesare set for the otherPermissionproperty. However, if theisStickyBit, ownerPermission,groupPermission, andotherPermission properties areomitted, ro is set for theotherPermission property.


3-24 Resources


Properties Description SpecificationFor details about the accessprivileges you can set, see thefileAccessPermissionOfOwnerproperty.

DirectoryACLSettings Specify this if you want to set theACL for a shared directory.To check the values set for thisproperty, check if the createdshared directory can be accessedfrom a client.

Optional (Canbe set if theisClassicAclproperty is setto false)

-- DirectoryACLSetting

-- Required if theDirectoryACLSettingsproperty is set.

-- userGroupAccess

Sets the access privileges for ACLusers and groups.allow

Specify this value to set theallow access privileges for thespecified users and groups andto add the access privilegesspecified for the ACEs of theusers and groups. If ACEs arealready set, the accessprivileges are combined. Ifmultiple ACEs are set for a user,the ACEs are combined into oneACE.

replaceSpecify this value to set theallow access privileges for thespecified users and groups andto replace the access privilegesof the users and groups with thespecified ACEs.

denySpecify this value to set thedeny access privileges for thespecified users and groups andto replace the access privilegesof the users and groups with thespecified ACEs.

Required if theDirectoryACLSettingproperty is set.

name Sets an ACL user name or groupname.


accountType

Sets the ACL account type.u

Specify this value to set theaccess privileges for the users.

gSpecify this value to set theaccess privileges for the groups.





Sets the ACE scope.o

Specify this value to apply tothe directory only.

aSpecify this value to apply tothe directory, subdirectories,and files.

fSpecify this value to apply tothe directory and subdirectories.

eSpecify this value to apply tothe directory and files.

sSpecify this value to apply tothe subdirectories and files.

uSpecify this value to apply tothe subdirectories only.

iSpecify this value to apply tothe files only.


inheritanceRange

Sets the scope of ACE inheritance.o

Specify this value for only thedirectories and files immediatelyunder the directory to inheritACEs.

aSpecify this value for all thedirectories and files under thedirectory to inherit ACEs.


accessPermission

Sets ACL access privileges.f

Specify this value to set fullcontrol.

sSpecify this value to set theTraverse Folder / Execute Fileprivilege.

rSpecify this value to setprivileges for acquiring a list offolders and reading data.

aSpecify this value to setprivileges for reading attributes.

e


3-26 Resources


Properties Description SpecificationSpecify this value to setprivileges for reading extendedattributes.

wSpecify this value to setprivileges for creating files andwriting data.

pSpecify this value to setprivileges for creating foldersand adding data.

tSpecify this value to setprivileges for writing attributes.

xSpecify this value to setprivileges for writing extendedattributes.

lSpecify this value to setprivileges for deleting subfoldersand files.

dSpecify this value to setprivileges for deletion.

cSpecify this value to setprivileges for reading accesspermissions.

hSpecify this value to setprivileges for changing accesspermissions.

gSpecify this value to setprivileges for acquiring ownerprivileges.

#: This is the default value used when the property is omitted.

The following shows an example of adding a CIFS share by sending a PUTmethod request to the CIFSShares resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/CIFSShares

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare>


<exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isClassicAcl>false</isClassicAcl> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups> <DirectorySetup> <userName>22222</userName> <groupName>11111</groupName> <isStickyBit>true</isStickyBit> <ownerPermission>rw</ownerPermission> <groupPermission>rw</groupPermission> <otherPermission>rw</otherPermission> </DirectorySetup> <DirectoryACLSettings> <DirectoryACLSetting> <userGroupAccess>allow</userGroupAccess> <name>Everyone</name> <accountType>g</accountType> <applicationDestination>a</applicationDestination> <inheritanceRange>a</inheritanceRange> <accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings></CIFSShare>The following table describes the status codes output when the method ends.

Table 3-15 Status codes returned when a PUT method request is sent tothe CIFSShares resource




CIFSShares/CIFS-share-name resourceThis section describes how to use the CIFSShares/CIFS-share-nameresource.

3-28 Resources


Acquiring CIFS share information by using the GET method

You must specify the path name of the shared directory by using the queryparameter SHARE-DIRECTORY-NAME.

You must use Base64 to encode the path name specified for the queryparameter SHARE-DIRECTORY-NAME and CIFS-share-name.


Table 3-16 Structure of the response XML when a GET method request issent to the CIFSShares/CIFS-share-name resource

PropertiesNumber of

response XMLsoutput



false

CIFSShare 1 Cluster,single node

Y


Y

cifsShareName 1 Cluster,single node

Y

isAclEnabled 1 Cluster,single node

Y



Y



Y

commentForShare 1 Cluster,single node

Y


Y

isBrowseEnabled 1 Cluster,single node

Y



Y



Y



Y



Y



Y



Y



Y



Y


PropertiesNumber of

response XMLsoutput



false



Y



Y



Y


N

clientAccessPolicy 1 Cluster,single node

Y

vssUse 1 Cluster,single node

Y



Y



Y



Y



Y

writeAllowedUsers 1 Cluster,single node

Y

writeAllowedGroups


Y

Legend: Y: Displayed, N: Not displayed.

The following table describes the properties displayed when a GET methodrequest is sent to the CIFSShares/CIFS-share-name resource.

Table 3-17 Properties displayed when a GET method request is sent to theCIFSShares/CIFS-share-name resource


CIFSShare --

-- exportPoint Displays the path name of the shared directory.

cifsShareName Displays the CIFS share name.

isAclEnabled Displays whether an ACL is used.true

An ACL is used.

falseAn ACL is not used.

restrictionTargetHosts Displays the host for which access restriction is set.


Displays whether access restriction is set.true

Displayed when access restriction is set.

3-30 Resources


Properties Descriptionfalse

Displayed when access restriction is not set.

commentForShare Displays the CIFS share comment.

isReadOnly Displays the access privilege for the CIFS share.true

Read-only is set.

falseRead-only is not set.

isBrowseEnabled Displays whether to display the CIFS share name in thelist on the client computer.true

The share name is displayed.

falseThe share name is not displayed.


Displays the access privileges the owner has for a file.rw

Read and write are permitted.

roOnly read is permitted.

noneNeither read or write is permitted.


Displays the access privileges a group has for a file.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges others have for a file.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges the owner has for adirectory.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges a group has for adirectory.For details about displayed values, seefileAccessPermissionOfOwner.


Displays the access privileges others have for adirectory.For details about displayed values, seefileAccessPermissionOfOwner.


Displays whether to allow access from the guestaccount.allow

Access from the guest account is allowed.

disallowAccess from the guest account is denied.

defaultThe default settings of the CIFS serviceconfiguration definitions set in the CIFS ServiceManagement page of the GUI are used.




Displays the behavior for a write or close request froma client.write_and_close

Data is written synchronously with a write requestor a close request issued from a client to a CIFSshare.

closeData is written synchronously with a close requestissued from a client to a CIFS share.

noneData is written at a fixed interval.


cifsClientCacheSetting Displays whether to cache updated data for files in theCIFS share on a client.use

Data for read-only access is cached.

do_not_useData for read-only access is not cached.



Displays the users who can update the time stamps offiles in the CIFS share.write_permitted_users

Timestamp updating is permitted for all users whoare permitted to write to the file.

owner_onlyTimestamp file updating is limited to the file owneronly.



Displays whether to enable automatic creation of thehome directory of the CIFS share.true

Automatic creation of the home directory isenabled.

falseAutomatic creation of the home directory isdisabled.

aclType Displays the ACL type for the file system.Advanced ACL

The ACL type is Advanced ACL.

Classic ACLThe ACL type is Classic ACL.

3-32 Resources


Properties DescriptionUnknown

The ACL type could not be acquired.

clientAccessPolicy Displays the method for processing the accesses from aCIFS client.parallel

Accesses are handled in parallel.

serialAccesses are handled serially.


vssUse Displays whether to use the Volume Shadow CopyService to publish a Sync Image differential-datasnapshot to a CIFS client.default

The default settings of the CIFS serviceconfiguration definitions set in the CIFS ServiceManagement page of the GUI are used.

do_not_useDisplayed when a Sync Image differential-datasnapshot is not published to a CIFS client.


Displays whether to use a read-only client cache whenaccesses to a file from multiple CIFS clients conflict.use

A read-only client cache is used.

do_not_useA read-only client cache is not used.



Displays whether to enable access-based enumeration.use

Access-based enumeration is enabled.

do_not_useAccess-based enumeration is disabled.


writeDisallowedUsers Displays the users who are denied write permission forthe CIFS share.


Displays the groups who are denied write permissionfor the CIFS share.

writeAllowedUsers Displays the users who are allowed write permission forthe CIFS share.

writeAllowedGroups Displays the groups who are allowed write permissionfor the CIFS share.


The following shows an example of acquiring CIFS share information bysending a GET method request to the CIFSShares/CIFS-share-nameresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/CIFSShares/CIFS-share-name

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups></CIFSShare>The following table describes the status codes output when the method ends.

Table 3-18 Status codes returned when a GET method request is sent tothe CIFSShares/CIFS-share-name resource




3-34 Resources


Changing CIFS share information by using the POST method



The following table describes the XML structure when a POST method requestis sent to the CIFSShares/CIFS-share-name resource.

Table 3-19 XML structure when the POST method is used to send a requestto the CIFSShares/CIFS-share-name resource

Properties Data typeNumber of items

that can bespecified


CIFSShare -- 1 Cluster,single node

-- cifsShareName String 0 or 1 Cluster,single node

isClassicAcl Boolean 1 Cluster,single node

isAclEnabled Boolean 0 or 1 Cluster,single node




Boolean 0 or 1 Cluster,single node

commentForShare String 0 or 1 Cluster,single node


isBrowseEnabled Boolean 0 or 1 Cluster,single node



























clientAccessPolicy String 0 or 1 Cluster,single node

vssUse String 0 or 1 Cluster,single node









writeAllowedUsers String 0 or 1 Cluster,single node

writeAllowedGroups


The following table describes the properties to be specified when sending aPOST method request to the CIFSShares/CIFS-share-name resource.

Table 3-20 Properties used to send a POST method request to theCIFSShares/CIFS-share-name resource


CIFSShare -- --

-- cifsShareName Sets the CIFS share name.You can use no more than 80 characters.

Optional

isClassicAcl Sets whether the Advanced ACL or ClassicACL type is used for operation. Specify thissetting so that it matches the ACL type ofthe file system to which the shareddirectory belongs.If true has been specified for this, youcannot specify false.true

Specify this value when the file systemis the Classic ACL type.

falseSpecify this value when the file systemis the Advanced ACL type.

Required

3-36 Resources



isAclEnabled Sets whether to use an ACL for the CIFSshare.true

Specify this value to use an ACL.

falseSpecify this value to not use an ACL.

Optional


Sets a host for which you restrict access tothe CIFS share. When specifying multiplehosts, separate them with a comma (,).Specify a host in the following format:When you specify a network address

Specify an IP address (Example:10.203.15.0).

When you specify a network rangeaccording to a netmask

Specify a range in the followingformat:network-address/netmask (Example:10.203.15.0/255.255.255.0)

When you specify host names, edit the /etc/hosts file in the Edit System Filepage of the GUI to add all the specifiedhost names and IP addresses.If you omit this, all hosts or networks areselected as the target.If hosts or networks for which access isrestricted are set in the CIFS ServiceManagement page of the GUI, thesettings are applied to all the file shares.

Required if theisAccessRestrictionAllowedproperty is set.


Sets whether to restrict access to the CIFSshare by a host specified by therestrictionTargetHosts property.true

Specify this value to restrict access.

false#

Specify this value to not restrictaccess.

If hosts or networks for which access isrestricted are set in the CIFS ServiceManagement page of the GUI, thesettings are applied to all the file shares.

Required if therestrictionTargetHosts propertyis set.

commentForShare

Sets a comment related to the CIFS share.You can use alphanumeric characters,exclamation marks (!), hash marks (#),dollar signs ($), ampersands (&), singlequotation marks ('), left parentheses ((),right parentheses ()), asterisks (*), plussigns (+), commas (,), hyphens (-),periods (.), forward slashes (/), colons (:),left angle brackets (<), right angle brackets(>), question marks (?), at marks (@), leftsquare brackets ([), backslashes (\), right

Optional


Properties Description Specificationsquare brackets (]), carets (^),underscores (_), grave accent marks (`),left curly brackets ({), vertical bars (|),right curly brackets (}), and tildes (~). Youcan also specify a space, but a stringcannot start or end with a space. Also, astring cannot end with a backslash (\). Inaddition, you can specify multi-bytecharacters. You can use up to 256characters.

isReadOnly Sets whether to set the CIFS share asread-only.true

Specify this value to set the share asread-only.

falseSpecify this value to not set the shareas read-only.

Optional

isBrowseEnabled

Sets whether to list the names of the CIFSshares in a client environment.true

Specify this value to list the names.

falseSpecify this value to not list thenames.

Optional


Sets the access privileges the file ownerhas.rw

Specify this value to grant read andwrite permissions.

roSpecify this value to grant readpermission only.

noneSpecify this value to grant neither readnor write permission.

Required if thefileAccessPermissionOfGroup orfileAccessPermissionOfOtherproperty is set(This can be setwhen theisClassicAclproperty is true).


Sets the access privileges a group has for afile.For details about the access privileges youcan set, see thefileAccessPermissionOfOwner property.

Required if thefileAccessPermissionOfOwner orfileAccessPermissionOfOtherproperty is set(This can be setwhen theisClassicAclproperty is true).


Sets the access privileges others have for afile.For details about the access privileges youcan set, see thefileAccessPermissionOfOwner property.

Required if thefileAccessPermissionOfOwner orfileAccessPermissionOfGroupproperty is set(This can be set

3-38 Resources


Properties Description Specificationwhen theisClassicAclproperty is true).


Sets the access privileges the owner hasfor a directory.For details about the access privileges youcan set, see thefileAccessPermissionOfOwner property.

Required if thedirectoryAccessPermissionOfGroup ordirectoryAccessPermissionOfOther property is set(This can be setwhen theisClassicAclproperty is true).


Sets the access privileges a group has for adirectory.For details about the access privileges youcan set, see thefileAccessPermissionOfOwner property.

Required if thedirectoryAccessPermissionOfOwner ordirectoryAccessPermissionOfOther property is set(This can be setwhen theisClassicAclproperty is true).


Sets the access privileges others have for adirectory.For details about the access privileges youcan set, see thefileAccessPermissionOfOwner property.

Required if thedirectoryAccessPermissionOfOwner ordirectoryAccessPermissionOfGroup property is set(This can be setwhen theisClassicAclproperty is true).


Sets whether to allow access from theguest account.allow

Specify this value to allow access fromthe guest account.

disallowSpecify this value to deny access fromthe guest account.

defaultSpecify this to use the default settingsof the CIFS service configurationdefinitions set in the CIFS ServiceManagement page of the GUI.

Optional


Sets the behavior for a write or closerequest from a client.write_and_close

Specify this to perform writingsynchronously with a write request or a

Optional


Properties Description Specificationclose request issued from a client to aCIFS share.

closeSpecify this to perform writingsynchronously with a close requestissued from a client to a CIFS share.

noneSpecify this to perform writing at afixed interval.



Sets whether to cache updated data forfiles in the CIFS share on a client.use

Specify this value to cache data forread-only access.

do_not_useSpecify this value to not cache data forread-only access.


Optional


Sets the users who can update the timestamps of files in the CIFS share.write_permitted_users

Specify this if you want to permittimestamp updating for all users whoare permitted to write to the file.

owner_onlySpecify this if you want to limit time-stamp file updating to the file owneronly.


Optional (can beset if theisClassicAclproperty is true)


Sets whether to enable automatic creationof the home directory of the CIFS share.true

Specify this value to enable automaticcreation of the home directory of theCIFS share.

false

Optional

3-40 Resources


Properties Description SpecificationSpecify this value to disable automaticcreation of the home directory of theCIFS share.

clientAccessPolicy

Sets the method for processing theaccesses from a CIFS client.parallel

Specify this to handle access inparallel.

serialSpecify this to handle access serially.


Optional

vssUse Specifies whether to use the VolumeShadow Copy Service to publish a SyncImage differential-data snapshot to a CIFSclient.default

Specify this to use the default settingsof the CIFS service configurationdefinitions set in the CIFS ServiceManagement page of the GUI.

do_not_useSpecify this if you do not want topublish a Sync Image differential-datasnapshot to a CIFS client.

Optional


Sets whether to use a read-only clientcache when access requests to a file frommultiple CIFS clients conflict.use

Specify this if you want to use a read-only client cache.

do_not_useSpecify this if you do not want to use aread-only client cache.


Optional


Sets whether to enable access-basedenumeration.use

Specify this to enable access-basedenumeration.

do_not_useSpecify this to disable access-basedenumeration.

default

Optional


Properties Description SpecificationSpecify this to use the default settingsof the CIFS service configurationdefinitions set in the CIFS ServiceManagement page of the GUI.


Sets the users who are denied writepermission for the CIFS share.To specify multiple users, separate them byusing commas (,).The set information is deleted if you omitsettings or specify a null string for thisproperty. However, the set information isnot deleted if you also omit settings orspecify a null string for thewriteDisallowedGroups property.

Optional


Sets the groups that are denied writepermission for the CIFS share.To specify multiple groups, separate themby using commas (,).The set information is deleted if you omitsettings or specify a null string for thisproperty. However, the set information isnot deleted if you also omit settings orspecify a null string for thewriteDisallowedUsers property.

Optional

writeAllowedUsers

Sets the users who are granted writepermission for the CIFS share.To specify multiple users, separate them byusing commas (,).The set information is deleted if you omitsettings or specify a null string for thisproperty. However, the set information isnot deleted if you also omit settings orspecify a null string for thewriteAllowedGroups property.

Optional

writeAllowedGroups

Sets the groups that are granted writepermission for the CIFS share.To specify multiple groups, separate themby using commas (,).The set information is deleted if you omitsettings or specify a null string for thisproperty. However, the set information isnot deleted if you also omit settings orspecify a null string for thewriteAllowedUsers property.

Optional

The following shows an example of changing CIFS share information bysending a POST method request to the CIFSShares/CIFS-share-nameresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/CIFSShares/CIFS-share-name

3-42 Resources


Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <cifsShareName>cifssharechange</cifsShareName> <isClassicAcl>false</isClassicAcl> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user1,user2</writeDisallowedUsers> <writeDisallowedGroups>group1,group2</writeDisallowedGroups> <writeAllowedUsers>user3,user4</writeAllowedUsers> <writeAllowedGroups>group3,group4</writeAllowedGroups></CIFSShare>The following table describes the status codes output when the method ends.

Table 3-21 Status codes returned when a POST method request is sent tothe CIFSShares/CIFS-share-name resource




Deleting the specified CIFS share by using the DELETE method



The shared directory is not deleted even if a CIFS share is deleted.

The following table describes the status codes output when the method ends.

Table 3-22 Status codes returned when a DELETE method request is sentto the CIFSShares/CIFS-share-name resource






Checking whether the specified CIFS share exists by using the HEAD method




Table 3-23 Status codes returned when a HEAD method request is sent tothe CIFSShares/CIFS-share-name resource


200 The specified CIFS share can be used.


Disk

Disk resource overviewYou can use the Disk resource to acquire the total capacity and unusedcapacity of a user disk in a single-node configuration.

The following table describes the HTTP method that can be used for the Diskresource.

Table 3-24 HTTP method that can be used for the Disk resource


/Disk GET Single node Acquires information about thetotal capacity and unused capacityof a user disk.

Disk resourceThis section describes how to use the Disk resource.

3-44 Resources


Acquiring information specified about the disk by using the GET method


Table 3-25 Structure of the response XML when a GET method request issent to the Disk resource

PropertiesNumber of

response XMLsoutput



false

Disk 1 Single node Y

-- totalDiskSize 1 Single node Y

freeDiskSize 1 Single node Y


The following table describes the properties displayed when a GET methodrequest is sent to the Disk resource.

Table 3-26 Properties displayed when a GET method request is sent to theDisk resource


Disk --

-- totalDiskSize Displays the total capacity of the user disk in gigabytes.

freeDiskSize Displays the unused capacity on the user disk in gigabytes.

The following shows an example of acquiring the total capacity and unusedcapacity of a user disk by sending a GET method request to the Diskresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/Disk

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Disk> <totalDiskSize>374</totalDiskSize> <freeDiskSize>321</freeDiskSize></Disk>The following table describes the status codes output when the method ends.

Table 3-27 Status codes returned when a GET method request is sent tothe Disk resource





404 There is no user disk. The Disk resource might be in use in acluster configuration.


FCPaths

FCPaths resource overviewIn a cluster configuration, you can use the FCPaths resource to acquire FCpath information.

The following table describes the HTTP method that can be used for theFCPaths resource.

Table 3-28 HTTP method that can be used for the FCPaths resource


/FCPaths GET Cluster Acquires FC path information.

FCPaths resourceThis section describes how to use the FCPaths resource.


Table 3-29 Structure of the response XML when a GET method request issent to the FCPaths resource

PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

FCPaths 1 Cluster Y

-- FCPath 0 or 1 to n Cluster Y

-- path 1 Cluster Y

target 1 Cluster Y

hostPort 1 Cluster Y

hostPortWWN 1 Cluster Y

arrayPort 1 Cluster Y

arrayPortWWN 1 Cluster Y

model 1 Cluster Y

3-46 Resources


PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

serial 1 Cluster Y

status 1 Cluster Y

Legend: n: An integer of 2 or more, Y: Displayed.

The following table describes the properties displayed when a GET methodrequest is sent to the FCPaths resource.

Table 3-30 Properties displayed when a GET method request is sent to theFCPaths resource


FCPaths --

-- FCPath --

-- path Displays the FC path.A null string is displayed if the target cannot beidentified.

target Displays the target.A null string is displayed if the target cannot beidentified.

hostPort Displays the name of the FC port on the node (hostport).A null string is displayed if the FC port cannot beidentified.

hostPortWWN Displays the WWN of the FC port on the node.

arrayPort Displays the name of the FC port on the storagesubsystem (array port).

arrayPortWWN Displays the WWN of the FC port on the storagesubsystem.A null string is displayed if the FC port cannot beidentified.

model Displays the storage subsystem model.AMS

Hitachi AMS2000 series or Hitachi AMS1500

USP_VUniversal Storage Platform V

USP_VMUniversal Storage Platform VM

VSPVirtual Storage Platform

A null string is displayed in the following cases:

• The storage subsystem does not contain LUs beingused in the HDI system.

• Storage subsystem information has not beenacquired because a failure occurred on the FC



path during startup of the OS on the node, or forsome other reason.

serial Displays the serial number of the storage subsystem.A null string is displayed if the serial number cannot beidentified.

status Displays the status of the FC path.Online

The FC path is working normally.If a device file error is detected, Online (LUError) is displayed.

OfflineThe system administrator has placed the FC pathin the offline status.If a device file error is detected, Offline (LUError) is displayed.

ErrorThis is displayed when any of the followingconditions are satisfied:- An error has occurred on the FC path.- None of the device files belonging to the targetFC path are accessible.- No LUs has been assigned to a host groupassociated with the FC path.

Partially OnlineThe FC path is working normally but some devicefiles are inaccessible.If a device file error is detected, PartiallyOnline (LU Error) is displayed.

Configuration MismatchThe assignment of LUs to host groups associatedwith the FC path differs from the assignment ofLUs for the alternate path, or there is no alternatepath.

UnknownThe FC port on the node (host port) or the FC porton the storage subsystem (array port) cannot beidentified.

The following shows an example of acquiring FC path information by sendinga GET method request to the FCPaths resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/FCPaths

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FCPaths> <FCPath> <path>path000-0004-1E</path> <target>N1-T000</target>

3-48 Resources


<hostPort>fc0004</hostPort> <hostPortWWN>10000000c98f2992</hostPortWWN> <arrayPort>1E</arrayPort> <arrayPortWWN>50060e801046889c</arrayPortWWN> <model>AMS</model> <serial>83016761</serial> <status>Online</status> </FCPath> <FCPath> <path>path000-0005-1F</path> <target>N1-T000</target> <hostPort>fc0005</hostPort> <hostPortWWN>10000000c98f2993</hostPortWWN> <arrayPort>1F</arrayPort> <arrayPortWWN>50060e801046889d</arrayPortWWN> <model>AMS</model> <serial>83016761</serial> <status>Online</status> </FCPath></FCPaths>The following table describes the status codes output when the method ends.

Table 3-31 Status codes returned when a GET method request is sent tothe FCPaths resource




FileSystems

FileSystems resource overviewYou can use the FileSystems resource to acquire file system information orto create a file system. You can also delete a file system, and check whethera file system exists.

The following table describes the HTTP methods that can be used for theFileSystems resource.

Table 3-32 HTTP methods that can be used for the FileSystems resource


/FileSystems GET Cluster,single node

Acquires file system information.


Creates a file system.



/FileSystems/file-system-name

GET Cluster,single node

Acquires information about thespecified file system.


Edits information about thespecified file system.

DELETE Cluster,single node

Deletes the specified file system.

HEAD Cluster,single node

Checks whether the specified filesystem exists.

/FileSystems/file-system-name/MountSetting


Acquires information about themount settings of the specified filesystem.


Edits information about the mountsettings of the specified filesystem.

FileSystems resourceThis section describes how to use the FileSystems resource.

Acquiring file system information by using the GET method


Table 3-33 Structure of the response XML when a GET method request issent to the FileSystems resource

PropertiesNumber of

response XMLsoutput


Displayedvalue whenverbose is

false

FileSystems 1 Cluster,single node

Y

-- FileSystem 0 or 1 to n Cluster,single node

Y

-- fileSystemName 1 Cluster,single node

Y

usage 1 Cluster,single node

N

deviceStatus 1 Cluster,single node

N

freeBlocksInMegaBytes


N

usedBlocksInMegaBytes


N

totalBlocksInMegaBytes


N

3-50 Resources


PropertiesNumber of

response XMLsoutput



false

isLvmEnabled • For clusterconfigurations: 1

• For single-nodeconfigurations: 0

Cluster Y

fileSystemSizeInGigaByte


Single

isLvmStripingEnabled

• For clusterconfigurations: 1


Cluster Y

stripes • For clusterconfigurations: 1


Cluster N

stripeSize • For clusterconfigurations: 1


Cluster Y


Y

WormSetting 1 Cluster,single node

Y

-- maxRetention 1 Cluster,single node

Y

minRetention 1 Cluster,single node

Y

isAutoCommitEnabled


Y

autoCommitPeriod


Y

defaultRetention


Y

isWormDeleteEnabled


N


PropertiesNumber of

response XMLsoutput



false

longestRetention


N

MountSetting 1 Cluster,single node

N

-- isMounted 1 Cluster,single node

N

mountStatus 1 Cluster,single node

N


N

isFileLastAccessTimeRecordingEnabled


N

LUs • For clusterconfigurations: 1


Cluster Y

-- LU • For clusterconfigurations: 1 to n


Cluster Y

-- deviceFileName



Cluster Y

Legend: n: An integer of 2 or more, Y: Displayed, Single: Displayed only insingle-node configurations, N: Not displayed.

The following table describes the properties displayed when a GET methodrequest is sent to the FileSystems resource.

Table 3-34 Properties displayed when a GET method request is sent to theFileSystems resource


FileSystems --

3-52 Resources



-- FileSystem --

-- fileSystemName The file system name is displayed.

usage The file system usage is displayed.None

The file system is not being used by otherfunctions.

Sync ImageThe file system is in use by a Sync Imagefunction.

WORMThe file system is a WORM file system.

If several of the above items apply to the filesystem usage, the items are all displayed andseparated by commas (,).

deviceStatus Displays the status of a device file that make upthe file system.Normal

The status is normal.

ErrorA failure has been detected while accessingthe device file.

A null string is displayed in a single-nodeconfiguration.


When the file system is correctly mounted, andthe unused block capacity is displayed in MB.A null string is displayed if the file system is notcorrectly mounted.


When the file system is correctly mounted, andthe used block capacity is displayed in MB.A null string is displayed if the file system is notcorrectly mounted.


When the file system is correctly mounted, andthe total block capacity is displayed in MB.A null string is displayed if the file system is notcorrectly mounted.

isLvmEnabled Displays whether a volume manager is used forthe file system.true

A volume manager is used.

falseA volume manager is not used.

This item is not displayed in a single-nodeconfiguration.


Displays the file system capacity (total device filecapacity) in GB.For a differential-data snapshot of Sync Image, anull string is displayed.The total file system capacity that was specifiedwhen the file system is created or expanded isdisplayed in a single-node configuration.

isLvmStripingEnabled Displays whether the file system is striped.


Properties Descriptiontrue

The file system is striped.

falseThe file system is not striped.


stripes Displays the number of stripes if file system isstriped.A null string is displayed if the file system is notstriped.This item is not displayed in a single-nodeconfiguration.

stripeSize Displays the stripe size in KB if the file system isstriped.A null string is displayed if the file system is notstriped.This item is not displayed in a single-nodeconfiguration.

aclType Displays the ACL type of the file system.Classic ACL

The ACL type is Classic ACL.

Advanced ACLThe ACL type is Advanced ACL.


WormSetting# --

-- maxRetention Displays the maximum retention period for aWORM file system in the following format:day-hour-minuteinfinite is displayed if an indefinite time periodis set for the maximum retention period. A nullstring is displayed for a non-WORM file system.

minRetention Displays the minimum retention period for aWORM file system in the following format:day-hour-minuteinfinite is displayed if an indefinite time periodis set for the minimum retention period. A nullstring is displayed for a non-WORM file system.

isAutoCommitEnabled

Displays whether to use auto commit for a WORMfile system.true

Auto commit is set.

falseAuto commit is not set.

A null string is displayed for a non-WORM filesystem.

autoCommitPeriod

Displays the time from the last access date of aread-only file until the file is committed as aWORM file if auto commit is enabled for a WORMfile system, in the following format:day-hour-minute

3-54 Resources


Properties DescriptionA null string is displayed if the file system is anon-WORM file system or auto commit is disabled.

defaultRetention

Displays the retention period for an auto-committed file in a WORM file system in thefollowing format:day-hour-minuteinfinite is displayed if an indefinite time periodis set for the default retention period. A null stringis displayed if the file system is a non-WORM filesystem or auto commit is disabled.

isWormDeleteEnabled

Displays whether a WORM file system can bedeleted.true

A WORM file system can be deleted.

falseA WORM file system cannot be deleted.

longestRetention

Displays the longest retention period for a file in aWORM file system in decimal notation.A null string is displayed in the following cases:

• isWormDeleteEnabled property is true.

• The file system is a non-WORM file system.

• The file system is blocked.

MountSetting --

-- isMounted Displays whether the file system is mounted.true

The file system is mounted.

falseThe file system is not mounted.

mountStatus Displays the mount status of the file system.Normal

The file system is mounted correctly.

Fatal errorThe file system is blocked.

OverflowThe differential-data storage device of SyncImage has run out of space.

Not availableA failure occurred in the differential-datastorage device of Sync Image.

BlockedThe file system is blocked because thedifferential-data storage device of Sync Imagehas run out of space.

Blocked and ReadyThe file system was blocked due to there notbeing enough free space on the Sync Imagedifferential-data storage device, after whichfree space was allocated to the differential-


Properties Descriptiondata storage device, and the OS on the nodehas not been restarted.

ExpandingThe file system is being expanded or an erroroccurred during expansion processing.

ReclaimingThe unused area of the virtual LUs that areused for the file system is being released.

A null string is displayed if the file system is notmounted.

isReadOnly Displays whether the file system is mounted asread-only.true

The file system is mounted as read-only.

falseThe file system is mounted with both readand write operations permitted.



Displays whether to update the time that the filesystem was last accessed.true

The last access time is updated.

falseThe last access time is not updated.


LUs --

-- LU --

-- deviceFileName

Displays the names of the device files that areused for the file system in ascending order.For an LU that resides on an external subsystem,a hash mark (#) is attached at the end of the LUname.

#: The value is not displayed if the file system is not mounted.

The following shows an example of acquiring file system information bysending a GET method request to the FileSystems resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/FileSystems

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystems> <FileSystem> <fileSystemName>test02</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize>

3-56 Resources


<aclType>Classic ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu04</deviceFileName> </LU> </LUs> </FileSystem></FileSystems>The following table describes the status codes output when the method ends.

Table 3-35 Status codes returned when a GET method request is sent tothe FileSystems resource




Creating a file system by using the PUT method

The following table describes the XML structure when a PUT method request issent to the FileSystems resource.

Table 3-36 XML structure when the PUT method is used to send a requestto the FileSystems resource




FileSystem -- 1 Cluster,single node

-- fileSystemName String 1 Cluster,single node

isLvmEnabled Boolean • For clusterconfigurations: 0or 1


Cluster


Double • For clusterconfigurations: 0


Single node





isLvmStripingEnabled Boolean • For clusterconfigurations: 0or 1


Cluster

stripeSize Integer • For clusterconfigurations: 0or 1


Cluster

aclType String 0 or 1 Cluster,single node

WormSetting -- 0 or 1 Cluster,single node

-- maxRetention String 0 or 1 Cluster,single node

minRetention String 0 or 1 Cluster,single node

isAutoCommitEnabled


autoCommitPeriod


defaultRetention


LUs -- • For clusterconfigurations: 1


Cluster

-- LU -- • For clusterconfigurations: 1to n


Cluster

-- deviceFileName

String • For clusterconfigurations: 1


Cluster


The following table describes the properties to be specified when sending aPUT method request to the FileSystems resource.

3-58 Resources


Table 3-37 Properties used to send a PUT method request to theFileSystems resource


FileSystem -- --

-- fileSystemName Sets the file system name.You can specify a maximum of16 characters consisting ofalphanumeric characters andunderscores (_).

Required

isLvmEnabled Sets whether to use thevolume manager. If false isspecified for this item, youcannot expand the capacityafter the creation of the filesystem. Also you cannotspecify theisLvmStripingEnabledproperty and stripeSizeproperty. If you create the filesystem from multiple devicefiles, specify true.true#

Specify this value to use avolume manager.

falseSpecify this value to notuse a volume manager.

Optional


Sets the file system capacity ingigabytes. This can be set onlyfor single-node configurations.

Required

isLvmStripingEnabled Sets whether to build the filesystem as a striped filesystem.true

Specify this value tocreate a striped filesystem.

false#

Specify this value to notcreate a striped filesystem.

Optional

stripeSize Sets the stripe size inkilobytes.Specify one of the followingvalues:

• 8

• 16

• 32

• 64#

• 128

Optional (Can be set iftheisLvmStripingEnabled property is true).



• 256

• 512

• 1024

aclType Sets the ACL of the filesystem.Classic ACL#

Specify this value to builda Classic ACL file system.

Advanced ACLSpecify this value to buildan Advanced ACL filesystem.

Optional

WormSetting -- Optional

-- maxRetention Sets the maximum retentionperiod for a WORM file system.Specify infinite or a value inthe following format:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0. Anindefinite time period is set forthe maximum retention periodif you specify infinite.If you omit this, 10950-0-0 isset.

Optional (Can be set ifthe WormSettingproperty is specified)

minRetention Sets the minimum retentionperiod for a WORM file system.Specify infinite or a value inthe following format:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0. Anindefinite time period is set forthe minimum retention periodif you specify infinite.If you omit this, 0-0-0 is set.


isAutoCommitEnabled

Set true when auto commitfor a WORM file system isused. You cannot change thesetting from true to false.


3-60 Resources


Properties Description SpecificationIf you omit this, false is set.

autoCommitPeriod

Sets the auto-commit periodfor a WORM file system.Specify a value in the followingformat:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0.If you omit this, 0-0-15 is set.

OptionalThis can be set if all ofthe following conditionsare satisfied:

• The WormSettingproperty is set.

• TheisAutoCommitEnabled property is setto true.

defaultRetention Sets the default retentionperiod for an auto-committedfile.Specify infinite or a value inthe following format:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0. Anindefinite time period is set forthe default retention period ifyou specify infinite.If you omit this, 10950-0-0 isset. Note that, if theminRetention property is setto infinite, infinite is set.

OptionalThis can be set if all ofthe following conditionsare satisfied:

• The WormSettingproperty is set.

• TheisAutoCommitEnabled property is setto true.

LUs -- --

-- LU -- --

-- deviceFileName

Sets the device file name. Thiscan be set only for clusterconfigurations.If you specify true for theisLvmEnabled property, thecapacity of each selecteddevice file must be 65 MB ormore. Also the total capacityof the device files must be 130MB or more. If you want tocreate a file system in astriping configuration, select 2to 128 device files that havethe same capacity. Thenumber of the selected LUs isthe number of stripes. In

Required


Properties Description Specificationaddition, striping will beperformed in the order thedevice files are specified.


The following shows an example of creating a file system by sending a PUTmethod request to the FileSystems resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/FileSystems

Example of a request XML (for a cluster configuration)<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FileSystem> <fileSystemName>fs</fileSystemName> <aclType>Advanced ACL</aclType> <isLvmEnabled>true</isLvmEnabled> <stripeSize>64</stripeSize> <isLvmStripingEnabled>true</isLvmStripingEnabled> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> </WormSetting> <LUs> <LU> <deviceFileName>lu04</deviceFileName> </LU> <LU> <deviceFileName>lu05</deviceFileName> </LU> </LUs></FileSystem>

Example of a request XML (for a single-node configuration)<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <aclType>Advanced ACL</aclType> <fileSystemSizeInGigaByte>10</fileSystemSizeInGigaByte> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> </WormSetting></FileSystem>The following table describes the status codes output when the method ends.

3-62 Resources


Table 3-38 Status codes returned when a PUT method request is sent tothe FileSystems resource




FileSystems/file-system-name resourceThis section describes how to use the FileSystems/file-system-nameresource.

Acquiring the specified file system information by using the GET method


Table 3-39 Structure of the response XML when a GET method request issent to the FileSystems/file-system-name resource

PropertiesNumber of

response XMLsoutput



false

FileSystem 1 Cluster,single node

Y

-- fileSystemName 1 Cluster,single node

Y

-- usage 1 Cluster,single node

N

deviceStatus 1 Cluster,single node

N



N



N



N

isLvmEnabled • For clusterconfigurations: 1


Cluster N


1 Cluster,Single node

N


PropertiesNumber of

response XMLsoutput



false

isLvmStripingEnabled



Cluster N

stripes • For clusterconfigurations: 1


Cluster N

stripeSize • For clusterconfigurations: 1


Cluster N


Y

WormSetting 1 Cluster,single node

Y

-- maxRetention 1 Cluster,single node

Y

minRetention 1 Cluster,single node

Y

isAutoCommitEnabled


Y

autoCommitPeriod


Y

defaultRetention


Y

isWormDeleteEnabled


Y

longestRetention


N


N


N


N

isReadOnly 1 Cluster, N

3-64 Resources


PropertiesNumber of

response XMLsoutput



falsesingle node



N

LUs • For clusterconfigurations: 1


Cluster N

-- LU • For clusterconfigurations: 1 to n


Cluster N

-- deviceFileName



Cluster N


The following table describes the properties displayed when a GET methodrequest is sent to the FileSystems/file-system-name resource.

Table 3-40 Properties displayed when a GET method request is sent to theFileSystems/file-system-name resource


FileSystem --

-- fileSystemName The file system name is displayed.

-- usage The file system usage is displayed.None

The file system is not being used by otherfunctions.

Sync ImageThe file system is in use by a Sync Imagefunction.

WORMThe file system is a WORM file system.


Properties DescriptionIf several of the above items apply to the filesystem usage, the items are all displayed andseparated by commas (,).

deviceStatus Displays the status of a device file that make upthe file system.Normal


ErrorA failure has been detected while accessingthe device file.

A null string is displayed in a single-nodeconfiguration.

freeBlocksInMegaBytes When the file system is correctly mounted, theunused block capacity is displayed in MB. A nullstring is displayed if the file system is notcorrectly mounted.

usedBlocksInMegaBytes When the file system is correctly mounted, theused block capacity is displayed in MB. A nullstring is displayed if the file system is notcorrectly mounted.

totalBlocksInMegaBytes When the file system is correctly mounted, thetotal block capacity is displayed in MB. A nullstring is displayed if the file system is notcorrectly mounted.

isLvmEnabled Displays whether a volume manager is used forthe file system.true

A volume manager is used.

falseA volume manager is not used.



Displays the file system capacity (total devicefile capacity) in GB.For a differential-data snapshot of Sync Image,a null string is displayed.The total file system capacity that was specifiedwhen the file system is created or expanded isdisplayed in a single-node configuration.

isLvmStripingEnabled Displays whether the file system is striped.true

The file system is striped.

falseThe file system is not striped.


stripes Displays the number of stripes if the file systemis striped.A null string is displayed if the file system is notstriped.This item is not displayed in a single-nodeconfiguration.

3-66 Resources



stripeSize Displays the stripe size in KB if the file system isstriped.A null string is displayed if the file system is notstriped.This item is not displayed in a single-nodeconfiguration.

aclType Displays the ACL type of the file system.Classic ACL

The ACL type is Classic ACL.

Advanced ACLThe ACL type is Advanced ACL.


WormSetting# --

-- maxRetention Displays the maximum retention period for aWORM file system in the following format:day-hour-minuteinfinite is displayed if an indefinite timeperiod is set for the maximum retention period.A null string is displayed for a non-WORM filesystem.

minRetention Displays the minimum retention period for aWORM file system in the following format:day-hour-minuteinfinite is displayed if an indefinite timeperiod is set for the minimum retention period.A null string is displayed for a non-WORM filesystem.

isAutoCommitEnabled

Displays whether to use auto commit for aWORM file system.true

Auto commit is set.

falseAuto commit is not set.

A null string is displayed for a non-WORM filesystem.

autoCommitPeriod Displays the time from the last access date of aread-only file until the file is committed as aWORM file if auto commit is enabled for a WORMfile system, in the following format:day-hour-minuteA null string is displayed if the file system is anon-WORM file system or auto commit isdisabled.

defaultRetention Displays the retention period for an auto-committed file in a WORM file system in thefollowing format:day-hour-minuteinfinite is displayed if an indefinite timeperiod is set for the default retention period. Anull string is displayed if the file system is a


Properties Descriptionnon-WORM file system or auto commit isdisabled.

isWormDeleteEnabled

Displays whether a WORM file system can bedeleted.true

A WORM file system can be deleted.

falseA WORM file system cannot be deleted.

longestRetention Displays the longest retention period for a file ina WORM file system in decimal notation.A null string is displayed in the following cases:

• isWormDeleteEnabled property is true.

• The file system is a non-WORM file system.

• The file system is blocked.

MountSetting --







OverflowThe differential-data storage device of SyncImage has run out of space.

Not availableA failure occurred in the differential-datastorage device of Sync Image.

BlockedThe file system is blocked because thedifferential-data storage device of SyncImage has run out of space.

Blocked and ReadyThe file system was blocked due to therenot being enough free space on the SyncImage differential-data storage device, afterwhich free space was allocated to thedifferential-data storage device, and the OSon the node has not been restarted.

ExpandingThe file system is being expanded or anerror occurred during expansion processing.

ReclaimingThe unused area of the virtual LUs that areused for the file system is being released.

3-68 Resources


Properties DescriptionA null string is displayed if the file system is notmounted.

isReadOnly Displays whether the file system is mounted asread-only.true


falseThe file system is mounted with both readand write operations permitted.







LUs --

-- LU --

-- deviceFileName

Displays the names of the device files that areused for the file system in ascending order.For an LU that resides on an externalsubsystem, a hash mark (#) is attached at theend of the LU name.

#: The value is not displayed if the file system is not mounted.

The following shows an example of acquiring specified file system informationby sending a GET method request to the FileSystems/file-system-nameresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/FileSystems/file-system-name

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>true</isLvmStripingEnabled> <stripeSize>64</stripeSize> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs>


<LU> <deviceFileName>lu02</deviceFileName> </LU> <LU> <deviceFileName>lu03</deviceFileName> </LU> </LUs></FileSystem>The following table describes the status codes output when the method ends.

Table 3-41 Status codes returned when a GET method request is sent tothe FileSystems/file-system-name resource




Editing information about the specified file system by using the POST method

The following table describes the XML structure when a POST method requestis sent to the FileSystems/file-system-name resource.

Table 3-42 XML structure when the POST method is used to send a requestto the FileSystems/file-system-name resource




FileSystem -- 1 Cluster,single node

-- expandFileSystemSize String • For clusterconfigurations:0

• For single-nodeconfigurations:0 or 1

Single node

addLUs -- • For clusterconfigurations:0 or 1

• For single-nodeconfigurations:0

Cluster

-- LU -- • For clusterconfigurations:1 to n


Cluster

3-70 Resources





-- deviceFileName

String • For clusterconfigurations:1


Cluster

WormSetting -- 0 or 1 Cluster,single node

-- maxRetention String 0 or 1 Cluster,single node

minRetention String 0 or 1 Cluster,single node

isAutoCommitEnabled


autoCommitPeriod String 0 or 1 Cluster,single node

defaultRetention String 0 or 1 Cluster,single node


The following table describes the properties to be specified when sending aPOST method request to the FileSystems/file-system-name resource.

Table 3-43 Properties used to send a POST method request to theFileSystems/file-system-name resource


FileSystem -- --

-- expandFileSystemSize Sets the capacity in gigabytes toexpand the file system to.Specify the capacity to be added.Note that if the file systems areoperating on the Sync Image,the amount of the file systemcapacity that can be expandeddepends on the chunk size that isset on the Sync Image. Fordetails about the restriction onthe amount of capacity that canbe expanded by using the chunksize, see the Hitachi DataIngestor Sync Image User'sGuide.

One of thefollowingproperties isrequired:

• expandFileSystemSize

• addLUs• WormSetting

addLUs Sets the LUs to be added toexpand the file system.If false was specified for theisLvmStripingEnabled property

One of thefollowingproperties isrequired:


Properties Description Specificationwhen the file system wascreated, you cannot expand thecapacity. If true was specifiedfor isLvmStripingEnabledproperty, specify device files thathave the same capacity. Thenumber of device files to bespecified here must be the sameas the number of stripesspecified by stripes propertywhen the file system wascreated.



-- LU Sets the LU to be assigned to thefile system.

Required if theaddLUs property isset.

-- deviceFileName

Sets the device file name to beassigned to the file system.

Required if theaddLUs property isset.

WormSetting -- One of thefollowingproperties isrequired:



-- maxRetention Sets the maximum retentionperiod for a WORM file system.Specify infinite or a value inthe following format:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0. Anindefinite time period is set forthe maximum retention period ifyou specify infinite.

Required if theWormSettingproperty is set andinfinite is notset for theminRetentionproperty.

minRetention Sets the minimum retentionperiod for a WORM file system.Specify infinite or a value inthe following format:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000

Required if theWormSettingproperty is set.

3-72 Resources


Properties Description SpecificationYou can specify a value from0-0-1 to 36500-0-0. Anindefinite time period is set forthe minimum retention period ifyou specify infinite.

isAutoCommitEnabled

Sets true when auto commit fora WORM file system is used. Youcannot change the setting fromtrue to false.

Required if theWormSettingproperty is set.

autoCommitPeriod Sets the auto-commit period fora WORM file system.Specify a value in the followingformat:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0.

Required if theWormSettingproperty is set andtrue is set for theisAutoCommitEnabled property.

defaultRetention Sets the default retention periodfor a WORM file system.Specify infinite or a value inthe following format:day-hour-minuteYou can specify the followingvalues for each item:

• day: 0 to 36500

• hour: 0 to 876000

• minute: 0 to 52560000You can specify a value from0-0-1 to 36500-0-0. Anindefinite time period is set forthe default retention period ifyou specify infinite.

Required if theWormSettingproperty is set andtrue is set for theisAutoCommitEnabled property.

The following shows an example of editing information about the specified filesystem by sending a POST method request to the FileSystems/file-system-name resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/FileSystems/file-system-name

Example of a request XML (for a cluster configuration)<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <WormSetting> <isAutoCommitEnabled>true</isAutoCommitEnabled>


<autoCommitPeriod>0-0-15</autoCommitPeriod> <defaultRetention>10950-0-0</defaultRetention> </WormSetting> <addLUs> <LU> <deviceFileName>lu06</deviceFileName> </LU> <LU> <deviceFileName>lu07</deviceFileName> </LU> </addLUs></FileSystem>

Example of a request XML (for a single-node configuration)<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <WormSetting> <isAutoCommitEnabled>true</isAutoCommitEnabled> <autoCommitPeriod>0-0-15</autoCommitPeriod> <defaultRetention>10950-0-0</defaultRetention> </WormSetting> <expandFileSystemSize>10</expandFileSystemSize></FileSystem>The following table describes the status codes output when the method ends.

Table 3-44 Status codes returned when a POST method request is sent tothe FileSystems/file-system-name resource




Deleting the specified file system by using the DELETE method


Table 3-45 Status codes returned when a DELETE method request is sentto the FileSystems/file-system-name resource




Checking whether the specified file system exists by using the HEAD method


3-74 Resources


Table 3-46 Status codes returned when a HEAD method request is sent tothe FileSystems/file-system-name resource


200 The specified file system exists.

404 The specified file system does not exist.


FileSystems/file-system-name/MountSetting resourceThis section describes how to use the FileSystems/file-system-name/MountSetting resource.

Acquiring information about the mount settings of the specified file system byusing the GET method


Table 3-47 Structure of the response XML when a GET method is sent tothe FileSystems/file-system-name/MountSetting resource

PropertiesNumber of

response XMLsoutput



false


Y


Y


Y



Y


N


The following table describes the properties displayed when a GET methodrequest is sent to the FileSystems/file-system-name/MountSettingresource.


Table 3-48 Properties displayed when a GET method request is sent to theFileSystems/file-system-name/MountSetting resource


MountSetting --




isReadOnly Displays the file system is mounted as read-only.true


falseThe file system is mounted with both read andwrite operations permitted.










OverflowThe differential-data storage device of Sync Imagehas run out of space.

Not availableA failure occurred in the differential-data storagedevice of Sync Image.

BlockedThe file system is blocked because the differential-data storage device of Sync Image has run out ofspace.

Blocked and ReadyThe file system was blocked due to there notbeing enough free space on the Sync Imagedifferential-data storage device, after which freespace was allocated to the differential-datastorage device, and the OS on the node has notbeen restarted.

Expanding

3-76 Resources


Properties DescriptionThe file system is being expanded or an erroroccurred during expansion processing.

ReclaimingThe unused area of the virtual LUs that are usedfor the file system is being released.


The following shows an example of acquiring information about the specifiedfile system by sending a GET method request to the FileSystems/file-system-name/MountSetting resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/FileSystems/file-system-name/MountSetting

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></isFileLastAccessTimeRecordingEnabled></MountSetting>The following table describes the status codes output when the method ends.

Table 3-49 Status codes returned when a GET method request is sent tothe FileSystems/file-system-name/MountSetting resource




Editing information about the mount settings of the specified file system byusing the POST method

The following table describes the XML structure when a POST method requestis sent to the FileSystems/file-system-name/MountSetting resource.


Table 3-50 XML structure when the POST method is used to send a requestto the FileSystems/file-system-name/MountSetting resource




MountSetting -- 1 Cluster,single node

-- isMounted Boolean 1 Cluster,single node




isConvertToAdvancedAclType


The following table describes the properties to be specified when sending aPOST method request to the FileSystems/file-system-name/MountSettingresource.

Table 3-51 Properties used to send a POST method request to theFileSystems/file-system-name/MountSetting resource


MountSetting -- --

-- isMounted Sets whether to change the mountstatus.true

Specify this value to mount thefile system.

false#1

Specify this value to unmountthe file system.

Required

isReadOnly Sets whether to allow writing tothe file system.true

Specify this value to mount thefile system as read-only.

falseSpecify this value to mount thefile system with both read andwrite operations permitted.

Required if true isspecified for theisMounted property


Sets whether to update the timethat the file system was lastaccessed.true

Specify this value to updatethe last access time.

OptionalThis can be set if all of thefollowing conditions aresatisfied:

3-78 Resources



false#2

Specify this value to notupdate the last access time.

• true is specified forthe isMountedproperty.

• false is specified forthe isReadOnlyproperty.

isConvertToAdvancedAclType

Sets whether to change the ACLtype of a file system from theClassic ACL to Advanced ACL. Ifyou change the ACL type, the ACLtype of existing directories and filesin the file system is changed in thebackground.true

Specify this value to changethe ACL type from Classic ACLto Advanced ACL.

false#2

Specify this value to notchange the ACL type fromClassic ACL to Advanced ACL.

OptionalThis can be set if all of thefollowing conditions aresatisfied:

• true is specified forthe isMountedproperty.

• false is specified forthe isReadOnlyproperty.

• The ACL type of thefile system is ClassicACL.

#1: If processing for unmounting file systems failed, access to file systemsmight be temporarily suppressed by the Backup Restore volume replicationlinkage function. Use the fsctl command to check the status of file systemaccess suppression, use the Backup Restore horcunfreeze command torelease all file systems from suppression, and then re-execute the method.For details on the fsctl command, see the Hitachi Data Ingestor CLI User'sGuide. For details on the horcunfreeze command, see the Hitachi DataIngestor Backup Restore User's Guide.

#2: This is the default value used when the property is omitted.

The following shows an example of editing information about the specified filesystem by sending a POST method request to the FileSystems/file-system-name/MountSetting resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/FileSystems/file-system-name/MountSetting

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></isFileLastAccessTimeRecordingEnabled></MountSetting>The following table describes the status codes output when the method ends.


Table 3-52 Status codes returned when a POST method request is sent tothe FileSystems/file-system-name/MountSetting resource




Hardware

Hardware resource overviewYou can use the Hardware resource to acquire the hardware status.

The following table describes the HTTP method that can be used for theHardware resource.

Table 3-53 HTTP method that can be used for the Hardware resource


/Hardware GET Cluster,single node

Acquires the hardware status.

Hardware resourceThis section describes how to use the Hardware resource.

Acquiring hardware information by using the GET method


Table 3-54 Structure of the response XML when a GET method is sent tothe Hardware resource

PropertiesNumber ofresponse

XMLs output



false

Hardware 1 Cluster,single node

Y

-- PortDetails 1 Cluster,single node

Y

-- PortDetail 0 or 1 to n Cluster, Y

3-80 Resources



XMLs output



falsesingle node

-- status 1 Cluster,single node

Y

portName 1 Cluster,single node

Y

mediaType 1 Cluster,single node

Y

linkSpeed 1 Cluster,single node

Y

ManagementLans 1 Cluster,single node

Y

-- ManagementLan 0 or 1 Cluster,single node

Y


Y


Y


Y


Y

HeartbeatLans 0 or 1 Cluster Y

-- HeartbeatLan 0 or 1 Cluster Y

-- status 1 Cluster Y

portName 1 Cluster Y

mediaType 1 Cluster Y

linkSpeed 1 Cluster Y

PrivateMaintenanceLans 1 Cluster,single node

Y

-- PrivateMaintenanceLan

0 or 1 to n Cluster,single node

Y


Y


Y


Y


Y

InternalHDDs 1 Cluster,single node

Y

-- InternalHDD 0 or 1 to n Cluster,single node

Y

-- slotName 1 Cluster,single node

Y



XMLs output



false

status 1 Cluster,single node

Y

vendorInformation


Y

InternalRAIDBatteries 1 Cluster,single node

Y

-- InternalRAIDBattery

0 or 1 to n Cluster,single node

Y


Y


Y

vendorInformation


Y

Memories 1 Cluster,single node

Y

-- Memory 0 or 1 to n Cluster,single node

Y


Y


Y

vendorInformation


Y

MemTotals 1 Cluster,single node

Y

-- MemTotal 0 or 1 Cluster,single node

Y


Y

size 1 Cluster,single node

Y

PowerSupplies 1 Cluster,single node

Y

-- PowerSupply 0 or 1 to n Cluster,single node

Y

-- powerSupplyName


Y


Y

vendorInformation


Y

Fans 1 Cluster,single node

Y

-- Fan 0 or 1 to n Cluster,single node

Y

3-82 Resources



XMLs output



false

-- fanName 1 Cluster,single node

Y


Y

vendorInformation


Y

Temperatures 1 Cluster,single node

Y

-- Temperature 0 or 1 to n Cluster,single node

Y

-- temperatureName


Y


Y

vendorInformation


Y

BMCs 1 Cluster,single node

Y

-- BMC 0 or 1 Cluster,single node

Y


Y

connection 0 or 1 Cluster Y

Models 1 Cluster,single node

Y

-- Model 0 or 1 Cluster,single node

Y

-- manufacturer


Y

product 1 Cluster,single node

Y

Serials 1 Cluster,single node

Y

-- Serial 0 or 1 Cluster,single node

Y

-- number 1 Cluster,single node

Y


The following table describes the properties displayed when a GET methodrequest is sent to the Hardware resource.


Table 3-55 Properties displayed when a GET method request is sent to theHardware resource


Hardware --

-- PortDetails --

-- PortDetail --

-- status Displays the status of the data port.Up

The link is operating normally.

DownThe link is disconnected or no interfaces havebeen added to the port.

portName Displays the name of the data port.ethnumber

mediaType Displays the media type of the data port.copper

The data port supports metal cables.

fiberThe data port supports optical cables.

linkSpeed Displays the link speed of the data port.10Base

The speed is 10 Mbps.

100BaseThe speed is 100 Mbps.

1000BaseThe speed is 1 Gbps.

Unknown!The speed is unknown.

ManagementLans --

-- ManagementLan --

-- status Displays the status of the management port.Up



portName Displays the name of the management port.mng0

mediaType Displays the media type of the management port.copper

The management port supports metal cables.

fiberThe management port supports optical cables.

linkSpeed Displays the link speed of the management port.10Base


3-84 Resources


Properties Description100Base




HeartbeatLans Displayed only in a cluster configuration.

-- HeartbeatLan --

-- status Displays the status of the heartbeat port.Up



portName Displays the name of the heartbeat port.hb0

mediaType Displays the media type of the heartbeat port.copper

The heartbeat port supports metal cables.

fiberThe heartbeat port supports optical cables.

linkSpeed Displays the link speed of the heartbeat port.10Base





PrivateMaintenanceLans --

-- PrivateMaintenanceLan

--

-- status Displays the status of the maintenance port.Up



portName Displays the name of the maintenance port.pmnumber

mediaType Displays the media type of the maintenance port.copper

The maintenance port supports metal cables.

fiberThe maintenance port supports optical cables.

linkSpeed Displays the link speed of the maintenance port.


Properties Description10Base





InternalHDDs --

-- InternalHDD --

-- slotName Displays the index number of the internal hard disk.

status Displays the status of the internal hard disk.OK


RebuildThe RAID is being rebuilt.

FailedAn error occurred.

Not supportedA program for acquiring information is notinstalled.

vendorInformation

Displays the vendor-specific detailed informationregarding the internal hard disk.

InternalRAIDBatteries --

-- InternalRAIDBattery

--

-- slotName Displays the index number of the internal RAIDbattery.

status Displays the status of the internal RAID battery.OK

The battery has been charged.

ChargingThe battery is being charged.

FailedAn error occurred.

Not supportedA program for acquiring information is notinstalled.

vendorInformation

Displays the vendor-specific detailed informationregarding the internal RAID battery.

Memories --

-- Memory --

-- slotName Displays the index number of the memory.

status Displays the memory status.Installed

Memory is installed.

3-86 Resources


Properties DescriptionNot Installed

Memory is not installed.

vendorInformation

Displays the vendor-specific detailed informationregarding the memory.

MemTotals --

-- MemTotal --

-- slotName Display the index number of the total memorycapacity.

size Displays the total memory capacity.

PowerSupplies --

-- PowerSupply --

-- powerSupplyName

Displays the index number of the power supply unit.

status Displays the status of the power supply unit.OK


FailedAn error has occurred.

Not InstalledNo power supply unit is installed.

vendorInformation

Displays the vendor-specific detailed informationregarding the power supply unit.

Fans --

-- Fan --

-- fanName Displays the index number of the fan.

status Displays the status of the fan.OK


FailedAn error has occurred or no fan is installed.

vendorInformation

Displays the vendor-specific detailed informationregarding the fan.

Temperatures --

-- Temperature --

-- temperatureName

Displays the index number of the temperaturesensor.

status Displays the detection results of the temperaturesensor.OK


FailedThe status is abnormal.

vendorInformation

Displays the vendor-specific detailed informationregarding the temperature sensor.

BMCs --

-- BMC --



-- status Displays the status of the BMC on the node to whicha request is sent.OK


Unknown!The information could not be acquired.

connection In a cluster configuration, displays the status of theconnection with the node other than the node towhich the request is sent.OK


FailedAn attempt to connect to the BMC on the othernode failed.

NoneA cluster configuration is not defined or anattempt to acquire the information failed.

Models --

-- Model --

-- manufacturer

Displays the name of the manufacturer.

product Displays the name of the product.

Serials --

-- Serial --

-- number Displays the device identification number.

Note: The properties for the devices that are not installed are not displayed.If information could not be acquired, a null string is displayed for theproperty.

The following shows an example of acquiring the cluster mode details of thehardware by sending a GET method request to the Hardware resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/Hardware

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Hardware> <PortDetails> <PortDetail> <status>Up</status> <portName>eth12</portName> <mediaType>copper</mediaType> <linkSpeed>1000Base</linkSpeed> </PortDetail> <PortDetail> <status>Up</status> <portName>eth13</portName> <mediaType>copper</mediaType>

3-88 Resources


<linkSpeed>1000Base</linkSpeed> </PortDetail> <PortDetail> <status>Down</status> <portName>eth14</portName> <mediaType>copper</mediaType> <linkSpeed>Unknown!</linkSpeed> </PortDetail> <PortDetail> <status>Up</status> <portName>eth15</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </PortDetail> </PortDetails> <ManagementLans> <ManagementLan> <status>Up</status> <portName>mng0</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </ManagementLan> </ManagementLans> <HeartbeatLans> <HeartbeatLan> <status>Up</status> <portName>hb0</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </HeartbeatLan> </HeartbeatLans> <PrivateMaintenanceLans> <PrivateMaintenanceLan> <status>Up</status> <portName>pm0</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </PrivateMaintenanceLan> <PrivateMaintenanceLan> <status>Down</status> <portName>pm1</portName> <mediaType>copper</mediaType> <linkSpeed>Unknown!</linkSpeed> </PrivateMaintenanceLan> </PrivateMaintenanceLans> <InternalHDDs> <InternalHDD> <slotName>0</slotName> <status>Normal</status> <vendorInformation>size:136.732 GB,raid level:RAID1</vendorInformation> </InternalHDD> <InternalHDD> <slotName>1</slotName> <status>Normal</status> <vendorInformation>size:136.732 GB,raid level:RAID1</vendorInformation> </InternalHDD> </InternalHDDs> <InternalRAIDBatteries/>


<Memories> <Memory> <slotName>0</slotName> <status>Not Installed</status> <vendorInformation>locator:P1C0D1,size:-</vendorInformation> </Memory> <Memory> <slotName>1</slotName> <status>Installed</status> <vendorInformation>locator:P1C0D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>2</slotName> <status>Not Installed</status> <vendorInformation>locator:P1C1D1,size:-</vendorInformation> </Memory> <Memory> <slotName>3</slotName> <status>Installed</status> <vendorInformation>locator:P1C1D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>4</slotName> <status>Not Installed</status> <vendorInformation>locator:P1C2D1,size:-</vendorInformation> </Memory> <Memory> <slotName>5</slotName> <status>Installed</status> <vendorInformation>locator:P1C2D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>6</slotName> <status>Not Installed</status> <vendorInformation>locator:P0C0D1,size:-</vendorInformation> </Memory> <Memory> <slotName>7</slotName> <status>Installed</status> <vendorInformation>locator:P0C0D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>8</slotName> <status>Not Installed</status> <vendorInformation>locator:P0C1D1,size:-</vendorInformation> </Memory> <Memory> <slotName>9</slotName> <status>Installed</status> <vendorInformation>locator:P0C1D0,size:2048 MB</vendorInformation>

3-90 Resources


</Memory> <Memory> <slotName>10</slotName> <status>Not Installed</status> <vendorInformation>locator:P0C2D1,size:-</vendorInformation> </Memory> <Memory> <slotName>11</slotName> <status>Installed</status> <vendorInformation>locator:P0C2D0,size:2048 MB</vendorInformation> </Memory> </Memories> <MemTotals> <MemTotal> <slotName>0</slotName> <size>size:11.5 GB(12.0 GB)</size> </MemTotal> </MemTotals> <PowerSupplies> <PowerSupply> <powerSupplyName>0</powerSupplyName> <status>OK</status> <vendorInformation></vendorInformation> </PowerSupply> <PowerSupply> <powerSupplyName>1</powerSupplyName> <status>OK</status> <vendorInformation></vendorInformation> </PowerSupply> </PowerSupplies> <Fans> <Fan> <fanName>0</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>1</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>2</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>3</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>4</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>5</fanName>


<status>OK</status> <vendorInformation></vendorInformation> </Fan> </Fans> <Temperatures> <Temperature> <temperatureName>0</temperatureName> <status>OK</status> <vendorInformation>reading:55 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>1</temperatureName> <status>OK</status> <vendorInformation>reading:44 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>2</temperatureName> <status>OK</status> <vendorInformation>reading:42 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>3</temperatureName> <status>OK</status> <vendorInformation>reading:39 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>4</temperatureName> <status>OK</status> <vendorInformation>reading:45 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>5</temperatureName> <status>OK</status> <vendorInformation>reading:30 (+/- 0) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>6</temperatureName> <status>OK</status> <vendorInformation>reading:30 (+/- 0) degrees C</vendorInformation> </Temperature> </Temperatures> <BMCs> <BMC> <status>OK</status> <connection>OK</connection> </BMC> </BMCs> <Models> <Model> <manufacturer>HITACHI </manufacturer> <product>HA8000/RS220</product> </Model> </Models>

3-92 Resources


<Serials> <Serial> <number>4230MB0-T019000037</number> </Serial> </Serials></Hardware>The following table describes the status codes output when the method ends.

Table 3-56 Status codes returned when a GET method request is sent tothe Hardware resource




HCP

HCP resource overviewYou can use the HCP resource to acquire, set, or delete HCP information aboutthe migration destination. You can also check whether the HCP namespacecan be accessed.

For details about tenant and namespace settings when you link the HDIsystem to an HCP system, see the Hitachi Data Ingestor Installation andConfiguration Guide.

The following table describes the HTTP methods that can be used for the HCPresource.

Table 3-57 HTTP methods that can be used for the HCP resource


/HCP GET Cluster,single node

Acquires all HCP information.


Sets or deletes HCP information.

/HCP/ACCESS POST Cluster,single node

Checks whether the user canaccess the HCP namespace.

HCP resourceThis section describes how to use the HCP resource.


Acquiring the specified HCP information by using the GET method


Table 3-58 Structure of the response XML when a GET method is sent tothe HCP resource

PropertiesNumber of

response XMLsoutput



false

HCP 1 Cluster,single node

Y

-- systemname 1 Cluster,single node

Y

tenantname 1 Cluster,single node

Y

username 1 Cluster,single node

Y

password 1 Cluster,single node

Y#


#: The password is displayed as spaces.

The following table describes the properties displayed when a GET methodrequest is sent to the HCP resource.

Table 3-59 Properties displayed when a GET method request is sent to theHCP resource


HCP --

-- systemname Displays the HCP host name.A null string is displayed if the value of the HCP resource isnot set.

tenantname Displays the HCP tenant name.A null string is displayed if the value of the HCP resource isnot set.

username Displays the user name of the data access account.A null string is displayed if the value of the HCP resource isnot set.

password A null string is always displayed.

The following shows an example of acquiring HCP information by sending aGET method request to the HCP resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/HCP

3-94 Resources


Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <systemName>hcp.example.com</systemName> <tenantName>HCP-tenant</tenantName> <userName>username</userName> <password></password></HCP>The following table describes the status codes output when the method ends.

Table 3-60 Status codes returned when a GET method request is sent tothe HCP resource




Setting or deleting HCP information by using the POST method

Notes:If you set HCP information, the periodic saving of system settings is set.The system settings file is stored in the HCP system.Even if you delete HCP information, the settings for the periodic saving ofsystem settings is not changed. Use the sysluscheduleset command tocheck the settings, such as the destination to which the system settingsfile is saved.

The following table describes the XML structure when a POST method requestis sent to the HCP resource.

Table 3-61 XML structure when the POST method is used to send a requestto the HCP resource




HCP -- 1 Cluster,single node

-- systemname String 1 Cluster,single node

tenantname String 1 Cluster,single node

username String 1 Cluster,single node

password String 1 Cluster,single node


The following table describes the properties to be specified when sending aPOST method request to the HCP resource.

Table 3-62 Properties used to send a POST method request to the HCPresource


HCP -- --

-- systemname Sets the HCP host name.You can specify alphanumericcharacters, periods (.), hyphens (-), ora null string. The host name cannotexceed 255 bytes, or 63 bytes if thehost name contains a period. However,a period or hyphen cannot be used forthe first or last character of thecharacter string.

Required

tenantname Sets the HCP tenant name.You can specify alphanumericcharacters, hyphens (-), or a nullstring. The tenant name must be nomore than 255 bytes.

Required

username Sets the user name of a data accessaccount.You can specify any printable ASCIIcharacter from 0x21 to 0x7E, or a nullstring.

Required

password Sets the password for a data accessaccount.You can specify any printable ASCIIcharacter from 0x21 to 0x7E, or a nullstring.

Required

Note: To delete HCP information, specify a null string for the property value.

The following shows an example of setting or deleting HCP information bysending a POST method request to the HCP resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/HCP

Example of a request XML (when HCP information is set)<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <systemName>hcp.example.com</systemName> <tenantName>HCP-tenant</tenantName> <userName>username</userName> <password>password</password></HCP>

Example of a request XML (when HCP information is deleted)<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP>

3-96 Resources


<systemName></systemName> <tenantName></tenantName> <userName></userName> <password></password></HCP>The following table describes the status codes output when the method ends.

Table 3-63 Status codes returned when a POST method request is sent tothe HCP resource




HCP/ACCESS resourceThis section describes how to use the HCP/ACCESS resource.

Checking whether the user can access the HCP namespace by using the POSTmethod

The following table describes the XML structure when a POST method requestis sent to the HCP/ACCESS resource.

Table 3-64 XML structure when the POST method is used to send a requestto the HCP/ACCESS resource




HCP -- 1 Cluster,single node

-- namespace String 1 Cluster,single node

The following table describes the properties to be specified when sending aPOST method request to the HCP/ACCESS resource.

Table 3-65 Properties used to send a POST method request to the HCP/ACCESS resource


HCP -- --

-- namespace Sets the HCP namespace.You can specify alphanumericcharacters and hyphens (-). The

Required


Properties Description Specificationnamespace strings must be no morethan 63 bytes.

The following shows an example of checking whether access to the HCPnamespace is allowed by sending a POST method request to the HCP/ACCESSresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/HCP/ACCESS

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <namespaceName>arc-test</namespaceName></HCP>The following table describes the status codes output when the method ends.

Table 3-66 Status codes returned when a POST method request is sent tothe HCP/ACCESS resource


200 An attempt to access the namespace was successful.

503 An attempt to access the namespace failed.


LUs

LUs resource overviewYou can use the LUs resource to acquire LU information.

The following table describes the HTTP method that can be used for the LUsresource.

Table 3-67 HTTP method that can be used for the LUs resource


/LUs GET Cluster Acquires LU information.

3-98 Resources


LUs resourceThis section describes how to use the LUs resource.

Acquiring LU information by using the GET method


Table 3-68 Structure of the response XML when a GET method request issent to the LUs resource

PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

LUs 1 Cluster Y

-- LU 0 or 1 to n Cluster Y

-- deviceFileName 1 Cluster Y

userLUN 1 Cluster Y

isExternalDevice 1 Cluster Y

target 1 Cluster Y

model 1 Cluster Y

serial 1 Cluster Y

ldev 1 Cluster Y

type 1 Cluster Y

size 1 Cluster Y

function 1 Cluster Y

usedBy 1 Cluster Y

rg 1 Cluster Y

dp 1 Cluster Y

usedPage 1 Cluster Y

pool 1 Cluster Y

freePool 1 Cluster Y

totalPool 1 Cluster Y


The following table describes the properties displayed when a GET methodrequest is sent to the LUs resource.

Table 3-69 Properties displayed when a GET method request is sent to theLUs resource


LUs --

-- LU --

-- deviceFileName Displays the device file name.


Properties Descriptionluhexadecimal-number

userLUN Displays the user LUN in hexadecimal format.If the LU is an external storage device, a hash mark(#) is displayed after the numeric value.

isExternalDevice Displays whether the LU is an external storage device.true

The LU is an external storage device.

falseThe LU is not an external storage device.

target Displays the target in the following format:Nnode-number-Tvalue-from-000-to-255A null string is displayed if an LDEV number has notbeen assigned to the user LUN.

model Displays the storage subsystem model.AMS





A null string is displayed if an LDEV number has notbeen assigned to the user LUN.

serial Displays the serial number of the storage subsystem indecimal format.A null string is displayed if an LDEV number has notbeen assigned to the user LUN.

ldev Displays the LDEV number of the device file.A null string is displayed if an LDEV number has notbeen assigned to the user LUN.

type Displays the drive type of the device file.FC/SAS

The drive type is FC or SAS.

SAS7KThe drive type is SAS 7.2K.

SATAThe drive type is SATA.

SSDThe drive type is SSD.

A null string is displayed if an LDEV number has notbeen assigned to the user LUN.

size Displays the size of the device file in GB.A null string is displayed if an LDEV number has notbeen assigned to the user LUN.The size is displayed to 3 decimal places.

function Displays how the user LU is used.Free

The LU is not in use.

3-100 Resources


Properties DescriptionFile

The LU is used for a file system.

SyncThe LU is used for a file system that is being usedby Sync Image.

Sync(Diff)The LU is used for a differential-data storagedevice that is being used by Sync Image.

WORMThe LU is used for a WORM file system.

WORM,SyncThe LU is used for a WORM file system and isbeing used by Sync Image.

WORM,Sync(Diff)The LU is used for a WORM file system and is usedfor a differential-data storage device that is beingused by Sync Image.

DefinedThe LU is reserved as the destination to which afile system is copied by using the functionality forlinking with array volume replication functions inBackup Restore.

UnknownThis is displayed if the LU satisfied either of thefollowing conditions:- The functionality or status of the LU has beenchanged during the execution of the command.- The information about the LU could not beacquired due to an error.

usedBy Displays the name of the resource that uses the LU.If function is File, or Sync, the file system name isdisplayed.A null string is displayed if an LDEV number has notbeen assigned to the user LUN.

rg Displays the RAID group to which the LU belongs.When the LU is a virtual LU, if the LU exists in anexternal subsystem or an LDEV number has not beenassigned to the user LUN, a null string is displayed.

dp Displays virtual LU information.DP

The LU is a virtual LU.A null string is displayed if the LU is not a virtual LU oran LDEV number has not been assigned to the userLUN.

usedPage Displays the virtual LU page size.A null string is displayed if the LU is not a virtual LU oran LDEV number has not been assigned to the userLUN.The size is displayed to 3 decimal places.

pool Displays the number of the DP pool to which thevirtual LU belongs.


Properties DescriptionA null string is displayed if the LU is not a virtual LU oran LDEV number has not been assigned to the userLUN.

freePool Displays the free capacity in the DP pool.A null string is displayed in the following cases:

• The LU is not a virtual LU.

• No LDEV number has been assigned to the userLUN.

• The storage subsystem model is Virtual StoragePlatform or Universal Storage Platform V/VM.

The capacity is displayed to 3 decimal places.

totalPool Displays the total capacity of the DP pool.A null string is displayed in the following cases:

• The LU is not a virtual LU.

• No LDEV number has been assigned to the userLUN.

• The storage subsystem model is Virtual StoragePlatform or Universal Storage Platform V/VM.

The capacity is displayed to 4 decimal places.

The following shows an example of acquiring LU information by sending a GETmethod request to the LUs resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/LUs

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><LUs> <LU> <deviceFileName>lu00</deviceFileName> <userLUN>00</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>1</ldev> <type>SATA</type> <size>20.000</size> <function>File</function> <usedBy>MyShare</usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu01</deviceFileName> <userLUN>01</userLUN>

3-102 Resources


<isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>2</ldev> <type>SATA</type> <size>20.000</size> <function>File</function> <usedBy>test</usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU></LUs>The following table describes the status codes output when the method ends.

Table 3-70 Status codes returned when a GET method request is sent tothe LUs resource




MigrationTask

MigrationTask resource overviewYou can use the MigrationTask resource to manage data migration to HCP.

The following table describes the HTTP methods that can be used for theMigrationTask resource.

Table 3-71 HTTP methods that can be used for the MigrationTask resource


/MigrationTask GET Cluster,single node

Acquires information for allmigration policies.


Sets a migration policy.

/MigrationTask/policy-name


Acquires information for thespecified migration policy.


Resets the migration taskschedule.

DELETE Cluster, Deletes the migration policy.



single node


Checks whether the specifiedmigration policy exists.

In a cluster configuration, select the target resource group for theMigrationTask resource by using the otherNode query parameter.

MigrationTask resourceThis section describes how to use the MigrationTask resource.

Acquiring information for all migration policies by using the GET method

In a cluster configuration, you can use the otherNode query parameter.


Table 3-72 Structure of the response XML when a GET method request issent to the MigrationTask resource

PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

MigrationTasks 1 Cluster,single node

Y

-- MigrationTask 0 or 1 to n Cluster,single node

Y

-- policy-name 1 Cluster,single node

Y

task-type 1 Cluster,single node

N

task-status 1 Cluster,single node

N

fileSystemName 1 Cluster,single node

Y

namespace 1 Cluster,single node

Y

schedule-start-time


Y

schedule-repeat 1 Cluster,single node

Y

schedule-interval 1 Cluster,single node

Y

exec-stop-occurrences


Y

duration 1 Cluster,single node

Y

3-104 Resources


PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

policy-description


Y


The following table describes the properties displayed when a GET methodrequest is sent to the MigrationTask resource.

Table 3-73 Properties displayed when a GET method request is sent to theMigrationTask resource


MigrationTasks --

-- MigrationTask --

-- policy-name Displays the policy name.

task-type Displays migration as the task type.

task-status Displays one of the following task statuses:Standby

The task is not scheduled to run.

ScheduledThe task will run on schedule.

RunningThe task is running.

If the status is Standby or Scheduled, one of thefollowing details is displayed after the status:Last time succeeded

The previous migration was successful.

Last time succeeded(Retry enable)The previous migration was successful, but somefiles or directories were not migrated because atemporary error occurred on the network or otherlocations. Retry the migration. However, if thefiles are not targets of the policy when themigration is retried, they will not be migrated.

Last time succeeded(Failure files exist)The previous migration was successful, but somefiles or directories failed to be migrated. Check thestatus of the files or directories.

Last time failedThe previous migration failed.

Last time stoppedThe previous migration was stopped in the middleof processing.

Last time interruptedThe previous migration was interrupted at the setcut-off time.


Properties DescriptionLast time cancelled

The previous migration was canceled.

Never executedNo migrations have been performed since the lasttime a schedule was set. Depending on thesituation, this information is displayed for a taskthat has been executed once. In this case, youcan display the correct status by updating theinformation.

Note that, if a failover occurs during a migration, thestatus before the failover is displayed.

fileSystemName Displays the name of the migration destination filesystem.

namespace Displays the name of the namespace that correspondsto the migration destination file system.

schedule-start-time

Displays the date and time at which the migration taskis executed for the first time.If the task is executed immediately, now is displayed.

schedule-repeat Displays one of the following units as the migrationtask execution interval:

• onlyonce• minute• hour• day• week• daily• weekly• monthly

schedule-interval Displays the migration task execution interval as aninteger that corresponds to the unit specified in theschedule-repeat property.


Displays the total number of times the migration taskis executed.A value of 0 is displayed if there is no limit to thenumber of executions.

duration Displays the time period from the time the migrationtask execution starts until it stops automatically.A value of 0 is displayed if the processing is notautomatically terminated.

policy-description

Displays the description of the policy.

The following shows an example of acquiring information for all migrationpolicies by sending a GET method request to the MigrationTask resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/MigrationTask

3-106 Resources


Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTasks> <MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description>description</policy-description> </MigrationTask></MigrationTasks>The following table describes the status codes output when the method ends.

Table 3-74 Status code returned when a GET method request is sent to theMigrationTask resource




Setting the migration policy by using the PUT method


Note: If a target file is updated during a migration, the migration fails. Settask execution schedules that do not coincide with the updating of files.

The following table describes the XML structure when a PUT method request issent to the MigrationTask resource.

Table 3-75 XML structure when a PUT method request is sent to theMigrationTask resource




MigrationTask -- 1 Cluster,single node

-- policy-name String 1 Cluster,single node

fileSystemName String 1 Cluster,single node

namespace String 1 Cluster,single node





schedule-start-time


schedule-repeat String 0 or 1 Cluster,single node

schedule-interval Integer 0 or 1 Cluster,single node


Integer 0 or 1 Cluster,single node

duration Integer 0 or 1 Cluster,single node

policy-description String 0 or 1 Cluster,single node

The following table describes the properties to be specified when sending aPUT method request to the MigrationTask resource.

Table 3-76 Properties used to send a PUT method request to theMigrationTask resource


MigrationTask -- --

-- policy-name Sets the policy name.Specify a policy name from 1 to 31characters. You can use alphanumericcharacters, underscores (_), andspaces. Any spaces at the beginning orthe end of the string are ignored.

Required

fileSystemName Sets the file system name. Required

namespace Sets the namespace name for the filesystem.

Required

schedule-start-time

Sets the date and time that themigration task is first executed.Set the date and time or now. Specifythe date and time in the format below.For example, if you want to execute atask at 22:00, April 1, 2011:2011-04-01T22:00:00.000+00:00When now is specified, the migration isexecuted immediately. If you omit this,now is set.

Optional

schedule-repeat Sets one of the following as the unit forthe interval at which the migration taskis executed:

• onlyonce#

• minute• hour• day

Optional

3-108 Resources



• week• daily• weekly• monthlyWhen daily, weekly or monthly isspecified, the migration is executed atthe time specified by the schedule-start-time property.

schedule-interval Specifies an interval for executing amigration as an integer correspondingto the value (unit) when one of thefollowing values are set for theschedule-repeat property.If you omit this, 1 is set.

• minute• hour• day• week

Optional


Sets the maximum number of timesthat the migration task can beexecuted.Specify the number of times, as aninteger from 0 to 99. When 0 isspecified, there is no limit on thenumber of times that the migrationtask can be executed.If you omit this, 0 is set.

Optional

duration Sets the period of time from the startof execution of the migration task untilthe migration task automatically stops.Specify an integer from 0 to 999. If 0 isspecified, the migration task will notstop automatically.If you omit this, 0 is set.

Optional

policy-description Sets an explanation of the policy.Use 0 to 256 characters. Note that youcannot use slashes (/) or doublequotation marks ("). If you omit this,an explanation of the policy is not set.

Optional


The following shows an example of setting the migration policy by sending aPUT method request to the MigrationTask resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/MigrationTask


Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences> <policy-description>description</policy-description></MigrationTask>The following table describes the status codes output when the method ends.

Table 3-77 Status codes returned when a PUT method request is sent tothe MigrationTask resource




MigrationTask/policy-name resourceThis section describes how to use the MigrationTask/policy-name resource.

Acquiring information for the specified migration policy by using the GETmethod

Make sure that you encode the policy-name portion using Base64.



Table 3-78 Structure of the response XML when a GET method request issent to the MigrationTask/policy-name resource

PropertiesNumber of

response XMLsoutput



false

MigrationTask 1 Cluster,single node

Y

-- policy-name 1 Cluster,single node

Y

task-type 1 Cluster,single node

N

3-110 Resources


PropertiesNumber of

response XMLsoutput



false

task-status 1 Cluster,single node

N

fileSystemName 1 Cluster,single node

Y

namespace 1 Cluster,single node

Y

schedule-start-time


Y

schedule-repeat 1 Cluster,single node

Y

schedule-interval 1 Cluster,single node

Y



Y

duration 1 Cluster,single node

Y

policy-description 1 Cluster,single node

Y


The following table describes the properties displayed when a GET methodrequest is sent to the MigrationTask/policy-name resource.

Table 3-79 Properties displayed when a GET method request is sent to theMigrationTask/policy-name resource


MigrationTask --

-- policy-name Displays the policy name.

task-type Displays migration as the task type.

task-status Displays one of the following task statuses:Standby

The task is not scheduled to run.

ScheduledThe task will run on schedule.

RunningThe task is running.

If the status is Standby or Scheduled, one of the followingdetails is displayed after the status:Last time succeeded

The previous migration was successful.

Last time succeeded(Retry enable)The previous migration was successful, but some filesor directories were not migrated because a temporaryerror occurred on the network or other location. Retrythe migration. However, if the files are not targets of


Properties Descriptionthe policy when the migration is retried, they will notbe migrated.

Last time succeeded(Failure files exist)The previous migration was successful, but some filesor directories failed to be migrated. Check the status ofthe files or directories.

Last time failedThe previous migration failed.

Last time stoppedThe previous migration was stopped in the middle ofthe processing.

Last time interruptedThe previous migration was interrupted at the set cut-off time.

Last time cancelledThe previous migration was canceled.

Never executedThe migration was never executed. Depending on thesituation, this information is displayed for a task thathas been executed once. In this case, you can displaythe correct status by updating the information.

Note that, if a failover occurs during a migration, the statusbefore the failover is displayed.

fileSystemName Displays the name of the migration destination file system.

namespace Displays the name of the namespace that corresponds tothe migration destination file system.

schedule-start-time

Displays the date and time at which the migration task isexecuted for the first time.If the task is executed immediately, now is displayed.

schedule-repeat Displays one of the following units as the migration taskexecution interval.

• onlyonce• minute• hour• day• week• daily• weekly• monthly

schedule-interval Displays the migration task execution interval as an integerthat corresponds to the unit specified in the schedule-repeat property.


Displays the total number of times the migration task isexecuted.A value of 0 is displayed if there is no limit to the number ofexecutions.

3-112 Resources



duration Displays the time period from the time the migration taskexecution starts until it stops automatically.A value of 0 is displayed if the processing is notautomatically terminated.

policy-description Displays the description of the policy.

The following shows an example of acquiring information for the specifiedmigration policy by sending a GET method request to the MigrationTask/policy-name resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/MigrationTask/policy-name

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences> <policy-description>description</policy-description></MigrationTask>The following table describes the status codes output when the method ends.

Table 3-80 Status codes returned when a GET method request is sent tothe MigrationTask/policy-name resource




Resetting the schedule of the migration task by using the POST method



Note:If a target file is updated during a migration, the migration fails. Set taskexecution schedules that do not coincide with the updating of files.

The following table describes the XML structure when a POST method requestis sent to the MigrationTask/policy-name resource.


Table 3-81 XML structure when a POST method request is sent to theMigrationTask/policy-name resource




MigrationTask -- 1 Cluster,single node

-- schedule-start-time


schedule-repeat String 0 or 1 Cluster,single node

schedule-interval Integer 0 or 1 Cluster,single node


Integer 0 or 1 Cluster,single node

duration Integer 0 or 1 Cluster,single node

The following table describes the properties to be specified when sending aPOST method request to the MigrationTask/policy-name resource.

Table 3-82 Properties used to send a POST method request to theMigrationTask/policy-name resource


MigrationTask -- --

-- schedule-start-time

Sets the date and time that themigration task is first executed. Specifya date and time or now.Example: To execute the first task at22:00, April 1, 2011:2011-04-01T22:00:00.000+00:00If now is specified, the task will startimmediately. If you omit this, now isset.

Optional

schedule-repeat Sets one of the following as the unit forthe interval at which the migration taskis executed.

• onlyonce#

• minute• hour• day• week• daily• weekly• monthly

Optional

3-114 Resources



schedule-interval Sets an integer appropriate for the unitset for the schedule-repeat property.If you omit this, 1 is set.

Required if any ofthe followingvalues is set forthe schedule-repeat property:

• minute• hour• day• week


Sets the maximum number of timesthat the migration task can beexecuted.Specify an integer from 0 to 99. If 0 isspecified, no maximum is set. Thedefault value is 0. If you omit this, 0 isset.

Optional

duration Sets the period of time from the startof execution of the migration task untilthe migration task automatically stops.Specify an integer from 0 to 999. If 0 isspecified, the migration task does notautomatically stop. If you omit this, 0is set.

Optional


The following shows an example of resetting the schedule of the migrationtask by sending a POST method request to the MigrationTask/policy-nameresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/MigrationTask/policy-name

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>week</schedule-repeat> <schedule-interval>10</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences></MigrationTask>The following table describes the status codes output when the method ends.


Table 3-83 Status codes returned when a POST method request is sent tothe MigrationTask/policy-name resource




Deleting policy information by using the DELETE method




Table 3-84 Status codes returned when a DELETE method request is sentto the MigrationTask/policy-name resource




Checking whether the specified migration policy exists by using the HEADmethod




Table 3-85 Status codes returned when a HEAD method request is sent tothe MigrationTask/policy-name resource



404 The specified migration policy cannot be used.


3-116 Resources


NetworkInterfaces

NetworkInterfaces resource overviewYou can use the NetworkInterfaces resource to acquire and managenetwork interface information.

The following table describes the HTTP methods that can be used for theNetworkInterfaces resource.

Table 3-86 HTTP methods that can be used for the NetworkInterfacesresource


/NetworkInterfaces GET Cluster,single node

Acquires network interfaceinformation.


Adds a network interface.

/NetworkInterfaces/network-interface-name


Acquires information for thespecified network interface.


Edits the specified networkinterface information.


Checks whether thespecified network interfaceexists.

NetworkInterfaces resourceThis section describes how to use the NetworkInterfaces resource.

Acquiring network interface information by using the GET method


Table 3-87 Structure of the response XML when a GET method request issent to the NetworkInterfaces resource

PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is false

NetworkInterfaces 1 Cluster,single node

Y

-- NetworkInterface 0 or 1 to n Cluster,single node

Y

-- name 1 Cluster,single node

Y

mtu 1 Cluster, N


PropertiesNumber of

response XMLsoutput


Displayedvalue when

verbose is falsesingle node

netmask 1 Cluster,single node

Y

networkAddress


N

FixedIP 1 Cluster,single node

Y

-- target 1 Cluster,single node

Y

other • For clusterconfigurations:1


Cluster Y

ServiceIP • For clusterconfigurations:1


Cluster Y

-- target • For clusterconfigurations:1


Cluster Y

other • For clusterconfigurations:1


Cluster Y


The following table describes the properties displayed when a GET methodrequest is sent to the NetworkInterfaces resource.

3-118 Resources


Table 3-88 Properties displayed when a GET method request is sent to theNetworkInterfaces resource


NetworkInterfaces --

-- NetworkInterface --

-- name Displays the interface name in one of thefollowing formats:

• ethnumber

• agrnumber

• rdnnumber

• mng0mtu#1 Displays the MTU value.

A null string is displayed if no interface is set.

netmask#2 Displays the netmask.A null string is displayed if no interface is set.

networkAddress Displays the network address.

FixedIP --

-- target Displays the fixed IP address of the node towhich the request is sent.A null string is displayed if the LAN port is notbeing used.

other#2 Displays the fixed IP address of the node otherthan the node to which the request is sent.A null string is displayed if the LAN port is notbeing used.

ServiceIP --

-- target Displays the service IP address of the node towhich the request is sent.A null string is displayed if no service IPaddress is set.

other#2 Displays the service IP address of the nodeother than the node to which the request issent.A null string is displayed if no service IPaddress is set.

#1: If the MTU values in the cluster do not match each other, Invalid isdisplayed, and the values are displayed on the following line in the format(MTU-value-of-the-node-currently-being-accessed, MTU-value-of-the-other-node).

If an MTU value cannot be acquired because the OS is not running, acommunication error has occurred, or for some other reason, Unknown isdisplayed.

Example: Invalid(1500,Unknown)If an MTU value cannot be acquired for some other reason, None is displayed.


Example: Invalid(1500,None)#2: If the information cannot be acquired because the OS is not running, acommunication error occurred, or for some other reason, Unknown isdisplayed. If the collected information is invalid, such as when the interfacesettings have been specified for only one node or when different IP addressesare specified for network addresses in the same interface, Invalid(invalid-value) is displayed.

The following shows an example of acquiring network interface information bysending a GET method request to the NetworkInterfaces resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NetworkInterfaces

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterfaces> <NetworkInterface> <name>eth12</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth13</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth14</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth15</name> <netmask></netmask>

3-120 Resources


<FixedIP> <target>10.213.88.250</target> <other>10.213.88.251</other> </FixedIP> <ServiceIP> <target>10.213.88.252</target> <other>10.213.88.253</other> </ServiceIP> </NetworkInterface></NetworkInterfaces>The following table describes the status codes output when the method ends.

Table 3-89 Status codes returned when a GET method request is sent tothe NetworkInterfaces resource




Adding a network interface by using the PUT method

The following table describes the XML structure when a PUT method request issent to the NetworkInterfaces resource.

Table 3-90 XML structure when a PUT method request is sent to theNetworkInterfaces resource




NetworkInterface -- 1 Cluster,single node

-- name String 1 Cluster,single node

netmask String 1 Cluster,single node

FixedIP -- 1 Cluster,single node

-- target String 1 Cluster,single node

other String • For clusterconfigurations: 0 or 1


Cluster

3-122 Resources





ServiceIP -- • For clusterconfigurations: 0 or 1


Cluster

-- target String • For clusterconfigurations: 0 or 1


Cluster

other String • For clusterconfigurations: 0 or 1


Cluster

The following table describes the properties to be specified when sending aPUT method request to the NetworkInterfaces resource.

Table 3-91 Properties used to send a PUT method request to theNetworkInterfaces resource


NetworkInterface -- --

-- name Sets the name of the port to which thenetwork interface will be added. Youcan set only the network interfacesthat are displayed in the executionresult of the GET method and for whichonly the name property is set.

• ethnumber

• agrnumber

• rdnnumber

Required

netmask Sets the netmask for the fixed IPaddress and service IP address.

Required

FixedIP#1 -- Required

-- target Sets the fixed IP address of the node towhich the request is sent.

Required



other Sets the fixed IP address of the nodeother than the node to which therequest is sent.

Required

ServiceIP#1#2 -- Optional

-- target Sets the service IP address of the nodeto which the request is sent. If youspecify a null string or omit thisproperty, no value is set.

Optional

other Sets the service IP address of the nodeother than the node to which therequest is sent. If you specify a nullstring or omit this property, no value isset.

Optional

#1: Do not specify the IP addresses shown below. These addresses arereserved in the storage subsystem. If you must specify them, contact ourTechnical Support Center.

• 127.0.0.0 to 127.255.255.255• IP addresses that belong to the same network as the IP address set for

the private maintenance portYou can use the pmctl command to view the IP address set for theprivate maintenance port. For details on the pmctl command, see theHitachi Data Ingestor CLI User's Guide.

• IP addresses that belong to the same network as the IP address set forthe heartbeat portYou can use the ProcessingNode resource to view the IP address set forthe heartbeat port. For details on the ProcessingNode resource, seeProcessingNode resource on page 3-157.

#2: Interfaces created without specifying a service IP address are excludedfrom the targets of resource group monitoring. Note the following whencreating an interface without specifying a service IP address:

• The CIFS, NFS, and FTP services provided by the HDI system cannot beused from an interface for which no service IP address is set.

• If a linkage error occurs in an interface for which no service IP address isset, SNMP traps (excluding trunking) and the error notification formaintenance personnel are not sent.

The following shows an example of adding a network interface by sending aPUT method request to NetworkInterfaces resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NetworkInterfaces

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface>

3-124 Resources


<name>eth12</name> <netmask>255.255.255.0</netmask> <FixedIP> <target>192.168.30.10</target> <other>192.168.30.11</other> </FixedIP> <ServiceIP> <target>192.168.30.12</target> <other>192.168.30.13</other> </ServiceIP></NetworkInterface>The following table describes the status codes output when the method ends.

Table 3-92 Status codes returned when a PUT method request is sent tothe NetworkInterfaces resource




NetworkInterfaces/network-interface-name resourceThis section describes how to use the NetworkInterfaces/network-interface-name resource.

Acquiring network interface information by using the GET method


Table 3-93 Structure of the response XML when a GET method request issent to the NetworkInterfaces/network-interface-name resource

PropertiesNumber of

response XMLsoutput



false

NetworkInterface 1 Cluster,single node

Y


Y

mtu 1 Cluster,single node

N


Y

networkAddress 1 Cluster,single node

N

FixedIP 1 Cluster,single node

Y


PropertiesNumber of

response XMLsoutput



false

-- target 1 Cluster,single node

Y

other • For clusterconfigurations: 1


Cluster Y

ServiceIP • For clusterconfigurations: 1


Cluster Y

-- target • For clusterconfigurations: 1


Cluster Y

other • For clusterconfigurations: 1


Cluster Y


The following table describes the properties displayed when a GET methodrequest is sent to the NetworkInterfaces/network-interface-name resource.

Table 3-94 Properties displayed when a GET method request is sent to theNetworkInterfaces/network-interface-name resource


NetworkInterface --

-- name Displays the interface name in one of the following formats:

• ethnumber

• agrnumber

• rdnnumber

• mng0mtu Displays the MTU value.

A null string is displayed if no interface is set.

netmask Displays the netmask.A null string is displayed if no interface is set.

networkAddress Displays the network address.

FixedIP --

-- target Displays the fixed IP address of the node to which therequest is sent.A null string is displayed if the LAN port is not being used.

3-126 Resources



other Displays the fixed IP address of the node other than thenode to which the request is sent.A null string is displayed if the LAN port is not being used.

ServiceIP --

-- target Displays the service IP address of the node to which therequest is sent.A null string is displayed if no service IP address is set.

other Displays the service IP address of the node other than thenode to which the request is sent.A null string is displayed if no service IP address is set.

The following table describes the properties to be specified when sending aPOST method request to the NetworkInterfaces/network-interface-nameresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NetworkInterfaces/network-interface-name

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface> <name>eth12</name> <netmask>255.255.255.0</netmask> <FixedIP> <target>192.168.30.10</target> <other>192.168.30.11</other> </FixedIP> <ServiceIP> <target>192.168.30.12</target> <other>192.168.30.13</other> </ServiceIP></NetworkInterface>The following table describes the status codes output when the method ends.

Table 3-95 Status codes returned when a GET method request is sent tothe NetworkInterfaces/network-interface-name resource




Changing the network interface information by using the POST method

The following table describes the XML structure when a POST method requestis sent to the NetworkInterfaces/network-interface-name resource.


Table 3-96 XML structure when a POST method request is sent to theNetworkInterfaces/network-interface-name resource




NetworkInterface -- 1 Cluster,single node

-- netmask String 0 or 1 Cluster,single node

FixedIP -- 0 or 1 Cluster,single node

-- target String 1 Cluster,single node

other String • For clusterconfigurations: 0or 1


Cluster

ServiceIP -- • For clusterconfigurations: 0or 1


Cluster

-- target String • For clusterconfigurations: 0or 1


Cluster

other String • For clusterconfigurations: 0or 1


Cluster

The following table describes the properties used to send a POST methodrequest to the NetworkInterfaces/network-interface-name resource.

Table 3-97 Properties used to send a POST method request to theNetworkInterfaces/network-interface-name resource


NetworkInterface -- --

-- netmask Sets the netmask for the fixed IPaddress and service IP address.

One of the followingproperties is required:

• netmask• FixedIP

3-128 Resources



• ServiceIPFixedIP#1 -- One of the following

properties is required:

• netmask• FixedIP• ServiceIP

-- target Sets the fixed IP address of thenode to which the request issent.

Required if the FixedIPproperty is set.

other Sets the fixed IP address of thenode other than the node towhich the request is sent.

Required if the FixedIPproperty is set.

ServiceIP#1#2 -- One of the followingproperties is required:

• netmask• FixedIP• ServiceIP

-- target Sets the service IP address ofthe node to which the request issent. If you specify a null string,the value set for this property isdeleted.

Optional (if you omitthis property, the valueset for the targetproperty is deleted.)If you omit theServiceIP property,the value set for thetarget property is keptas is.

other Sets the service IP address ofthe node other than the node towhich the request is sent. If youspecify a null string, the valueset for this property is deleted.

Optional (if you omitthis property, the valueset for the otherproperty is deleted.)If you omit theServiceIP property,the value set for theother property is keptas is.

#1: Do not specify the IP addresses shown below. These addresses arereserved in the storage subsystem. If you must specify them, contact ourTechnical Support Center.

• 127.0.0.0 to 127.255.255.255• IP addresses that belong to the same network as the IP address set for

the private maintenance portYou can use the pmctl command to view the IP address set for theprivate maintenance port. For details on the pmctl command, see theHitachi Data Ingestor CLI User's Guide.

• IP addresses that belong to the same network as the IP address set forthe heartbeat port


You can use the ProcessingNode resource to view the IP address set forthe heartbeat port. For details on the ProcessingNode resource, seeProcessingNode resource on page 3-157.

#2: Interfaces created without specifying a service IP address are excludedfrom the targets of resource group monitoring. Note the following whencreating an interface without specifying a service IP address:

• The CIFS, NFS, and FTP services provided by the HDI system cannot beused from an interface for which no service IP address is set.

• If a linkage error occurs in an interface for which no service IP address isset, SNMP traps (excluding trunking) and the error notification formaintenance personnel are not sent.

The following shows an example of changing the network interfaceinformation by sending a POST method request to the NetworkInterfaces/network-interface-name resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NetworkInterfaces/network-interface-name

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface> <netmask>255.255.255.0</netmask> <FixedIP> <target>192.168.30.14</target> <other>192.168.30.15</other> </FixedIP> <ServiceIP> <target>192.168.30.16</target> <other>192.168.30.17</other> </ServiceIP></NetworkInterface>The following table describes the status codes output when the method ends.

Table 3-98 Status codes returned when a POST method request is sent tothe NetworkInterfaces/network-interface-name resource




Checking whether the specified network interface exists by using the HEADmethod


3-130 Resources


Table 3-99 Status codes returned when a HEAD method request is sent tothe NetworkInterfaces/network-interface-name resource


200 The specified network interface can be used.


NFSShares

NFSShares resource overviewYou can use the NFSShares resource to manage NFS share information.

The following table describes the HTTP methods that can be used for theNFSShares resource.

Table 3-100 HTTP methods that can be used for the NFSShares resource


/NFSShares GET Cluster,single node

Acquires information for all NFSshares.


Adds an NFS share.

/NFSShares/NFS-share-directory-name#1

GET#2 Cluster,single node

Acquires information for thespecified NFS share.

POST#2 Cluster,single node

Edits the specified NFS shareinformation.

DELETE#2 Cluster,single node

Deletes the specified NFS share.

HEAD#2 Cluster,single node

Checks whether the specified NFSshare exists.

#1: For NFS-share-directory-name, specify the name of the directory at thelowest level of the shared directory.

#2: Specify the path name of the shared directory by using the queryparameter SHARE-DIRECTORY-NAME.

NFSShares resourceThis section describes how to use the NFSShares resource.


Acquiring information for all NFS shares by using the GET method


Table 3-101 Structure of the response XML when a GET method request issent to the NFSShares resource


XMLs output

Supportedconfiguratio

ns


false

NFSShares 1 Cluster,single node

Y

-- NFSShare 0 or 1 to n Cluster,single node

Y


Y

anonymousUID 1 Cluster,single node

Y

anonymousGID 1 Cluster,single node

Y

isPortRestrictionEnabled 1 Cluster,single node

Y

isSubtreeCheckEnabled 1 Cluster,single node

Y

isAccessCheckWithLockRequestEnabled


Y


N

maxRwSize 1 Cluster,single node

Y

AllowedHosts 1 Cluster,single node

Y

-- AllowedHost 1 to n Cluster,single node

Y

-- hostOrAddress 1 Cluster,single node

Y


Y

synchronousWritingSetting


Y

anonymousMapping


Y

securityFlavor 1 Cluster,single node

Y


The following table describes the properties displayed when a GET methodrequest is sent to the NFSShares resource.

3-132 Resources


Table 3-102 Properties displayed when a GET method request is sent tothe NFSShares resource


NFSShares --

-- NFSShare --

-- exportPoint Displays the path name of the shareddirectory.

anonymousUID Displays the user ID to be used whenaccessing a share as an anonymous user.

anonymousGID Displays the group ID to be used whenaccessing a share as an anonymous user.

isPortRestrictionEnabled Displays whether to receive only requests sentfrom Internet port numbers that are 1024 orless.true

Source ports are limited.

falseSource ports are not limited.

isSubtreeCheckEnabled Displays whether to check if the executepermission (x) exists for all directories(subtrees), including the shared directory andthe directory that contains the file or directoryto be accessed, as well as checking the accesspermissions for the file or directory to beaccessed.true

A subtree check is performed.

falseA subtree check is not performed.


Displays whether to approve (checkpermissions for) a lock request if one is sent.true

Permission for a lock request is checked.

falsePermission for a lock request is notchecked.

aclType Displays the ACL type of the file system.Advanced ACL

Advanced ACL type

Classic ACLClassic ACL type


maxRwSize Displays the maximum transfer length for theNFS share.A null string is displayed if no maximumtransfer length is set.

AllowedHosts --

-- AllowedHost --



-- hostOrAddress Displays the name of a host or network onwhich the NFS share is made public.

isReadOnly Displays the access permissions for the NFSshare.true

The NFS share is read-only.

falseRead and write operations are permittedon the NFS share.


Displays whether to optimize synchronouswriting when isReadOnly is set to false. Thedisplayed value is valid only when false isspecified for the isReadOnly property.rw_sync

Synchronous writing is not optimized.

rw_sync_optSynchronous writing is optimized.

anonymousMapping

Displays users who are to be mapped asanonymous users.everyone

All users are mapped as anonymoususers.

root_onlyOnly the root user is mapped as ananonymous user.

noneUsers are not mapped as anonymoususers.

securityFlavor Displays the security flavor set for the publicdestination of the NFS share. If multiplesecurity flavors have been set, they aredisplayed separated by commas (,).sys

UNIX (AUTH_SYS) authentication isapplied.

krb5Kerberos authentication is applied.

krb5iData integrity verification is applied inaddition to Kerberos authentication.

krb5pData integrity verification is applied andprivacy is provided in addition to Kerberosauthentication.

The following shows an example of acquiring NFS share information bysending a GET method request to the NFSShares resource.

3-134 Resources


URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NFSShares

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShares> <NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> </NFSShare></NFSShares>The following table describes the status codes output when the method ends.

Table 3-103 Status codes returned when a GET method request is sent tothe NFSShares resource




Adding an NFS share by using the PUT method

The following table describes the XML structure when a PUT method request issent to the NFSShares resource.


Table 3-104 XML structure when a PUT method request is sent to theNFSShares resource




NFSShare -- 1 Cluster,single node

-- exportPoint String 1 Cluster,single node

anonymousUID Integer 0 or 1 Cluster,single node

anonymousGID Integer 0 or 1 Cluster,single node

isPortRestrictionEnabled Boolean 0 or 1 Single node

isSubtreeCheckEnabled Boolean 0 or 1 Cluster,single node



maxRwSize Integer 0 or 1 Cluster,single node

AllowedHosts -- 1 Cluster,single node

-- AllowedHost -- 0 or 1 to n Cluster,single node

-- hostOrAddress String 1 Cluster,single node




anonymousMapping


securityFlavor String 0 or 1 Cluster,single node

DirectorySetup -- 0 or 1 Cluster,single node


groupName String 1 Cluster,single node

isStickyBit Boolean 0 or 1 Cluster,single node

ownerPermission String 0 or 1 Cluster,single node

groupPermission String 0 or 1 Cluster,single node

otherPermission String 0 or 1 Cluster,single node

3-136 Resources





DirectoryACLSettings -- 0 or 1 Cluster,single node

-- DirectoryACLSetting -- 0 or 1 to n Cluster,single node

-- userGroupAccess



accountType String 1 Cluster,single node



inheritanceRange


accessPermission



The following table describes the properties to be specified when sending aPUT method request to the NFSShares resource.

Table 3-105 Properties used to send a PUT method request to theNFSShares resource


NFSShare -- --

-- exportPoint Sets the absolute path to thedirectory to which the file sharewill be added.You can use 6 to 63 characters.

Required

anonymousUID Sets the user ID used for accessas an anonymous user.You can specify an ID from 0 to65535. If you omit this, 65534 isset.

Optional

anonymousGID Sets the group ID used foraccess as an anonymous user.You can specify an ID from 0 to65535. If you omit this, 65534 isset.

Optional

isPortRestrictionEnabled Sets whether only requests sentfrom an Internet port whosenumber is smaller than 1024 willbe accepted.true

Specify this value to limitthe ports.

Optional



false#

Specify this value to notlimit the ports.

isSubtreeCheckEnabled Sets to check for whetherexecution permission (x) existsfor all directories (subtrees),including the shared directoryand the directory that containsthe file or directory to beaccessed.true

Specify this value to checkthe subtree.

false#

Specify this value to notcheck the subtree.

Optional


Sets whether to approve (checkpermission for) a lock request ifone is sent.true

Specify this value to approvea lock request.

false#

Specify this value to notapprove a lock request.

Optional

maxRwSize Sets the maximum transferlength, from 4 to 1024 in KB, forthe NFS share.If you omit this, no value is set.

Optional

AllowedHosts -- Optional

-- AllowedHost -- Optional

-- hostOrAddress Sets the hosts allowed to accessthe NFS share.Specify 255 characters or fewer.The string cannot start with ahyphen (-). If you specify a hostalias, the official host name alsomust be 255 characters or fewer.Note that the total length(specified length + 5 bytes) ofthe specified host names ornetwork addresses must be lessthan 1,258 bytes.In addition to the host name andthe IP address, you can use thefollowing format:Netgroup

Specify an NIS netgroup.For example, for @group,only host segment isextracted from the netgroupmembers.

IP network

Required

3-138 Resources


Properties Description SpecificationTo permit all hosts in thesubnetwork to access theNFS share, specify the IPaddress and the netmask inthe following format:address/netmaskThe netmask can bespecified in dotted decimalformat or as continuousmasks.

DNS domainSpecify the name of the DNSdomain to which NFS clientsbelong, with a period (.)added at the beginning ofthe name.Example: .example.com

Wild cardTo specify all hosts, use anasterisk (*) as a wild card.

When the NFS client machinehas multiple network interfacescommunicating with the HDIsystem, specify the hosts andnetworks allowed to access theNFS share in one of the followingformats:

• Use a wild card (*).

• Specify the IP addresses ofall network interfaces usedon the NFS client side.

• Specify the host names forall network interfaces usedon the NFS client side.

• Specify an IP network thatcontains the IP addresses ofall network interfaces usedon the NFS client side.

• Specify a netgroup thatcontains the host names forall network interfaces usedon the NFS client side.

• Specify a DNS domain thatcontains the host names forall network interfaces usedon the NFS client side.

isReadOnly Sets whether to permit the NFSshare to be read only.true


false#

Optional


Properties Description SpecificationSpecify this value to not setthe share as read-only.


Sets whether to optimizesynchronous writing. This item iseffective only when theisReadOnly property is false.rw_sync#

Specify this value to notoptimize synchronouswriting.

rw_sync_optSpecify this value tooptimize synchronouswriting.

Optional

anonymousMapping

Sets this property to usemapping for the anonymoususer.everyone

Specify this value to map allusers to the anonymoususer.

root_only#

Specify this value to maponly the root user to theanonymous user.

noneSpecify this value if mappingto the anonymous user isnot to be performed.

Optional

securityFlavor Sets the security flavor.To specify multiple securityflavors, separate them by usingperiods (.). You cannot specifydefault with other securityflavors.sys

Specify this value to applyUNIX (AUTH_SYS)authentication.

krb5Specify this value to applyKerberos authentication.

krb5iSpecify this value to applydata integrity verification inaddition to Kerberosauthentication.

krb5pSpecify this value to applydata integrity verificationand provide privacy in

Optional

3-140 Resources


Properties Description Specificationaddition to Kerberosauthentication.

default#

Specify this value to applythe security flavor valueindicated on the NFSService Management pageof the GUI. Other valuescannot be specified whenthis value is specified.The value that is set at thetime that the method isexecuted is applied.

DirectorySetup Specify this if you want to createa shared directory whenever ashare is created.To check the values set for thisproperty, check if the createdshared directory can be accessedfrom a client.

Optional

-- userName Sets the user name or user ID ofthe owner for a directory to becreated.For a user ID, specify an ID from0 to 2147483147. Note that, foran ID other than 0, you cannotspecify 0 at the beginning of theID.


groupName Sets the group name or group IDof a shared directory.For a group ID, specify an IDfrom 0 to 2147483147. Notethat, for an ID other than 0, youcannot specify 0 at the beginningof the ID. If user mapping isused, you cannot specify a built-in group for a Windows domain.


isStickyBit Sets whether to use the stickybit.true

Specify this value to use thesticky bit.

false#

Specify this value to not usethe sticky bit.

Optional (Canbe set only iftheDirectorySetup property isset)

ownerPermission Sets the access privileges theowner has for the directory. Ifyou omit this, no accessprivileges are set.If you omit this, no accessprivileges are set for theownerPermission property.However, if the isStickyBit,



Properties Description SpecificationownerPermission,groupPermission, andotherPermission properties areomitted, rw is set for theownerPermission property.rw

Specify this value to permitreading and writing.

roSpecify this value to permitonly reading.

noneSpecify this value to prohibitreading and writing.

groupPermission Sets the access privileges agroup has for the directory. Ifyou omit this, no accessprivileges are set.If you omit this, no accessprivileges are set for thegroupPermission property.However, if the isStickyBit,ownerPermission,groupPermission, andotherPermission properties areomitted, ro is set for thegroupPermission property.For details about the accesspermissions that can be set, seethe description of theownerPermission property.


otherPermission Sets the access privileges othershave for the directory. If youomit this, no access privilegesare set.If you omit this, no accessprivileges are set for theotherPermission property.However, if the isStickyBit,ownerPermission,groupPermission, andotherPermission properties areomitted, ro is set for theotherPermission property.For details about the accesspermissions that can be set, seethe description of theownerPermission property.


DirectoryACLSettings Specify this if you want to setthe ACL for a shared directory.To check the values set for thisproperty, check if the createdshared directory can be accessedfrom a client.

Optional (Canbe set if theisClassicAclproperty is setto false)

3-142 Resources



-- DirectoryACLSetting -- Required if theDirectoryACLSettingsproperty is set.

-- userGroupAccess

Sets the access privileges forACL users and groups.allow

Specify this value to set theallow access privileges forthe specified users andgroups and to add theaccess privileges specifiedfor the ACEs of the usersand groups. If ACEs arealready set, the accessprivileges are combined. Ifmultiple ACEs are set for auser, the ACEs are combinedinto one ACE.

replaceSpecify this value to set theallow access privileges forthe specified users andgroups and to replace theaccess privileges of theusers and groups with thespecified ACEs.

denySpecify this value to set thedeny access privileges forthe specified users andgroups and to replace theaccess privileges of theusers and groups with thespecified ACEs.


name Sets a user name or group namein the ACL.


accountType Sets the ACL account type.u

Specify this value to set theaccess privileges for theusers.

gSpecify this value to set theaccess privileges for thegroups.



Sets the ACE scope.o

Specify this value to apply tothe directory only.

a



Properties Description SpecificationSpecify this value to apply tothe directory, subdirectories,and files.

fSpecify this value to apply tothe directory andsubdirectories.

eSpecify this value to apply tothe directory and files.

sSpecify this value to apply tothe subdirectories and files.

uSpecify this value to apply tothe subdirectories only.

iSpecify this value to apply tothe files only.

inheritanceRange

Sets the scope of ACEinheritance.o

Specify this value for onlythe directories and filesimmediately under thedirectory to inherit ACEs.

aSpecify this value for all thedirectories and files underthe directory to inherit ACEs.


accessPermission

Sets ACL access privileges.f

Specify this value to set fullcontrol.

sSpecify this value to set theTraverse Folder / ExecuteFile privilege.

rSpecify this value to setprivileges for acquiring a listof folders and reading data.

aSpecify this value to setprivileges for readingattributes.

eSpecify this value to setprivileges for readingextended attributes.


3-144 Resources


Properties Description Specificationw

Specify this value to setprivileges for creating filesand writing data.

pSpecify this value to setprivileges for creatingfolders and adding data.

tSpecify this value to setprivileges for writingattributes.

xSpecify this value to setprivileges for writingextended attributes.

lSpecify this value to setprivileges for deletingsubfolders and files.

dSpecify this value to setprivileges for deletion.

cSpecify this value to setprivileges for reading accesspermissions.

hSpecify this value to setprivileges for changingaccess permissions.

gSpecify this value to setprivileges for acquiringowner privileges.


The following shows an example of creating an NFS share by sending a PUTmethod request to the NFSShares resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NFSShares

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID>


<anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> <DirectorySetup> <userName>22222</userName> <groupName>11111</groupName> <isStickyBit>true</isStickyBit> <ownerPermission>rw</ownerPermission> <groupPermission>rw</groupPermission> <otherPermission>rw</otherPermission> </DirectorySetup> <DirectoryACLSettings> <DirectoryACLSetting> <userGroupAccess>allow</userGroupAccess> <name>Everyone</name> <accountType>g</accountType> <applicationDestination>a</applicationDestination> <inheritanceRange>a</inheritanceRange> <accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings></NFSShare>The following table describes the status codes output when the method ends.

Table 3-106 Status codes returned when a PUT method request is sent tothe NFSShares resource




NFSShares/NFS-share-directory-name resourceThis section describes how to use the NFSShares/NFS-share-directory-nameresource.

3-146 Resources


Acquiring information for the specified NFS share by using the GET method



Table 3-107 Structure of the response XML when a GET method request issent to the NFSShares/NFS-share-directory-name resource


XMLs output

Supportedconfiguration

s


false

NFSShare 1 Cluster,single node

Y


Y

anonymousUID 1 Cluster,single node

Y

anonymousGID 1 Cluster,single node

Y

isPortRestrictionEnabled 1 Cluster,single node

Y

isSubtreeCheckEnabled 1 Cluster,single node

Y



Y


N

maxRwSize 1 Cluster,single node

Y

AllowedHosts 1 Cluster,single node

Y

-- AllowedHost 1 to n Cluster,single node

Y

-- hostOrAddress 1 Cluster,single node

Y


Y



Y

anonymousMapping


Y

securityFlavor 1 Cluster,single node

Y


The following table describes the properties displayed when a GET methodrequest is sent to the NFSShares/NFS-share-directory-name resource.


Table 3-108 Properties displayed when a GET method request is sent tothe NFSShares/NFS-share-directory-name resource


NFSShare --

-- exportPoint Displays the path name of the shared directory.

anonymousUID Displays the user ID to be used when accessing ashare as an anonymous user.

anonymousGID Displays the group ID to be used when accessinga share as an anonymous user.

isPortRestrictionEnabled Displays whether to receive only requests sentfrom Internet port numbers that are 1024 or less.true

Source ports are limited.

falseSource ports are not limited.

isSubtreeCheckEnabled Displays whether to check if the executepermission (x) exists for all directories (subtrees),including the shared directory and the directorythat contains the file or directory to be accessed,as well as checking the access permissions for thefile or directory to be accessed.true

A subtree check is performed.

falseA subtree check is not performed.


Displays whether to approve (check permissionsfor) a lock request if one is sent.true

Permission for a lock request is checked.

falsePermission for a lock request is not checked.

aclType Displays the ACL type of the file system.Advanced ACL

Advanced ACL type

Classic ACLClassic ACL type


maxRwSize Displays the maximum transfer length for the NFSshare.A null string is displayed if no maximum transferlength is set.

AllowedHosts --

-- AllowedHost --

-- hostOrAddress Displays the name of a host or network on whichthe NFS share is made public.

isReadOnly Displays the access permission for the NFS share.true

3-148 Resources


Properties DescriptionThe NFS share is read-only.

falseRead and write operations are permitted onthe NFS share.


Displays whether to optimize synchronous writingwhen isReadOnly is set to false. The displayedvalue is valid only when false is specified for theisReadOnly property.rw_sync

Synchronous writing is not optimized.

rw_sync_optSynchronous writing is optimized.

anonymousMapping

Displays users who are to be mapped asanonymous users.everyone

All users are mapped as anonymous users.

root_onlyOnly the root user is mapped as ananonymous user.

noneUsers are not mapped as anonymous users.

securityFlavor Displays the security flavor set for the publicdestination of the NFS share. If multiple securityflavors have been set, they are displayedseparated by commas (,).sys

UNIX (AUTH_SYS) authentication is applied.

krb5Kerberos authentication is applied.

krb5iData integrity verification is applied inaddition to Kerberos authentication.

krb5pData integrity verification is applied andprivacy is provided in addition to Kerberosauthentication.

The following shows an example of acquiring NFS share information bysending a GET method request to the NFSShares resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NFSShares/NFS-share-directory-name

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID>


<anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>The following table describes the status codes output when the method ends.

Table 3-109 Status codes returned when a GET method request is sent tothe NFSShares/NFS-share-directory-name resource




Editing NFS share information by using the POST method


The following table describes the XML structure when a POST method requestis sent to the NFSShares/NFS-share-directory-name resource.

Table 3-110 XML structure when a POST method request is sent to theNFSShares/NFS-share-directory-name resource




NFSShare -- 1 Cluster,single node

-- anonymousUID Integer 0 or 1 Cluster,single node

anonymousGID Integer 0 or 1 Cluster,single node

isPortRestrictionEnabled Boolean 0 or 1 Single node

isSubtreeCheckEnabled Boolean 0 or 1 Cluster,single node

3-150 Resources







maxRwSize Integer 0 or 1 Cluster,single node

AllowedHosts -- 1 Cluster,single node

-- AllowedHost -- 1 to n Cluster,single node

-- hostOrAddress String 1 Cluster,single node




anonymousMapping


securityFlavor String 0 or 1 Cluster,single node


The following table describes the properties to be specified when sending aPOST method request to the NFSShares/NFS-share-directory-name resource.

Table 3-111 Properties used to send a POST method request to theNFSShares/NFS-share-directory-name resource


NFSShare -- --

-- anonymousUID Sets the user ID used for accessas an anonymous user.You can specify an ID from 0 to65535. The default is 65534.

Optional

anonymousGID Sets the group ID used foraccess as an anonymous user.You can specify an ID from 0 to65535. The default is 65534.

Optional

isPortRestrictionEnabled Sets whether only requests sentfrom an Internet port whosenumber is smaller than 1024 willbe accepted.true

Specify this value to limitthe ports.

falseSpecify this value to notlimit the ports.

Optional



isSubtreeCheckEnabled Sets to check for whetherexecution permission (x) existsfor all directories (subtrees),including the shared directoryand the directory that containsthe file or directory to beaccessed.true

Specify this value to checkthe subtree.

falseSpecify this value to notcheck the subtree.

Optional


Sets whether to approve (checkpermission for) a lock request ifone is sent.true

Specify this value to approvea lock request.

falseSpecify this value to notapprove a lock request.

Optional

maxRwSize Sets the maximum transferlength, from 4 to 1024 in KB, forthe NFS share.

Optional

AllowedHosts -- --

-- AllowedHost -- --

-- hostOrAddress Sets the hosts allowed to accessthe NFS share.Specify 255 characters or fewer.The string cannot start with ahyphen (-). If you specify a hostalias, the official host name alsomust be 255 characters or fewer.Note that the total length(specified length + 5 bytes) ofthe specified host names ornetwork addresses must be lessthan 1,258 bytes.In addition to the host name andthe IP address, you can use thefollowing format:Netgroup

Specify an NIS netgroup.For example, for @group,only host segment isextracted from the netgroupmembers.

IP networkTo permit all hosts in thesubnetwork to access theNFS share, specify the IP

Required

3-152 Resources


Properties Description Specificationaddress and the netmask inthe following format:address/netmaskThe netmask can bespecified in dotted decimalformat or as continuousmasks.

DNS domainSpecify the name of the DNSdomain to which NFS clientsbelong, with a period (.)added at the beginning ofthe name.Example: .example.com

Wild cardTo specify all hosts, use anasterisk (*) as a wild card.

When the NFS client machinehas multiple network interfacescommunicating with the HDIsystem, specify the hosts andnetworks allowed to access theNFS share in one of the followingformats:

• Use a wild card (*).

• Specify the IP addresses ofall network interfaces usedon the NFS client side.

• Specify the host names forall network interfaces usedon the NFS client side.

• Specify an IP network thatcontains the IP addresses ofall network interfaces usedon the NFS client side.

• Specify a netgroup thatcontains the host names forall network interfaces usedon the NFS client side.

• Specify a DNS domain thatcontains the host names forall network interfaces usedon the NFS client side.

isReadOnly Sets whether to permit the NFSshare to be read only.true


false#

Specify this value to not setthe share as read-only.

Optional




Sets whether to optimizesynchronous writing. This item iseffective only when theisReadOnly property is false.rw_sync#

Specify this value to notoptimize synchronouswriting.

rw_sync_optSpecify this value tooptimize synchronouswriting.

Optional

anonymousMapping

Sets this property to usemapping for the anonymoususer.everyone

Specify this value to map allusers to the anonymoususer.

root_only#

Specify this value to maponly the root user to theanonymous user.

noneSpecify this value if mappingto the anonymous user isnot to be performed.

Optional

securityFlavor Sets the security flavor.sys

Specify this value to applyUNIX (AUTH_SYS)authentication.

krb5Specify this value to applyKerberos authentication.

krb5iSpecify this value to applydata integrity verification inaddition to Kerberosauthentication.

krb5pSpecify this value to applydata integrity verificationand provide privacy inaddition to Kerberosauthentication.

default#

Specify this value to applythe security flavor valueindicated on the NFS

Optional

3-154 Resources


Properties Description SpecificationService Management pageof the GUI.


The following shows an example of editing NFS share information by sendinga POST method request to the NFSShares/NFS-share-directory-nameresource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/NFSShares/NFS-share-directory-name

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <anonymousUID>33333</anonymousUID> <anonymousGID>33333</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled> <isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <maxRwSize>6</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>The following table describes the status codes output when the method ends.

Table 3-112 Status codes returned when a POST method request is sent tothe NFSShares/NFS-share-directory-name resource




Deleting the specified NFS share by using the DELETE method


The shared directory is not deleted even if an NFS share is deleted.



Table 3-113 Status codes returned when a DELETE method request is sentto the NFSShares/NFS-share-directory-name resource




Checking whether the specified NFS share exists by using the HEAD method



Table 3-114 Status codes returned when a HEAD method request is sent tothe NFSShares/NFS-share-directory-name resource


200 The specified NFS share can be used.


ProcessingNode

ProcessingNode resource overviewYou can use the ProcessingNode resource to acquire cluster and nodeinformation and to set a host name.

The following table describes the HTTP methods that can be used for theProcessingNode resource.

Table 3-115 HTTP methods that can be used for the ProcessingNoderesource


/ProcessingNode GET Cluster,single node

Acquires cluster and nodeinformation.

POST Single node Edits a host name.

3-156 Resources


ProcessingNode resourceThis section describes how to use the ProcessingNode resource.

Acquiring cluster and node information by using the GET method

The following describes how to use the GET method to acquire cluster andnode information.


Table 3-116 Structure of the response XML when a GET method request issent to the ProcessingNode resource

PropertiesNumber of

response XMLsoutput



false

ProcessingNode 1 Cluster,single node

Y

-- SystemConfiguration 1 Cluster,single node

N

-- mode 1 Cluster,single node

N


N

name 1 Cluster,single node

N

LU • For clusterconfigurations:1


Cluster N

-- model • For clusterconfigurations:1


Cluster N

serial • For clusterconfigurations:1


Cluster N

ldev • For clusterconfigurations:1

Cluster N


PropertiesNumber of

response XMLsoutput



false


PhysicalNode • For clusterconfigurations:2


Cluster,single node

Y

-- location 1 Cluster,single node

N

hostName 1 Cluster,single node

Y

physicalNodeName


N


N

managementLANAddress


N

HBLanAddress 1 Cluster,single node

N

BMCLanAddress 1 Cluster,single node

N

resourceGroupStatus


N

resourceGroupErrorInfo


N

runningNode 1 Cluster,single node

N

serial 1 Cluster,single node

N

SystemVersion 1 Cluster,single node

N


N

version 1 Cluster,single node

N


The following table describes the properties displayed when a GET methodrequest is sent to the ProcessingNode resource.

3-158 Resources


Table 3-117 Properties displayed when a GET method request is sent tothe ProcessingNode resource


ProcessingNode --

-- SystemConfiguration --

-- mode Displays the configuration.CLUSTER

The system is in a cluster configuration.

SINGLEThe system is in a single-node configuration.

status Displays the status of the cluster. #1

ACTIVEThe cluster is running.

INACTIVEThe cluster is stopped.

UNKNOWN#2#3

The status cannot be determined.

DISABLEThe cluster is inoperable.

UNDEFNo clusters have been defined or the system isin a single-node configuration.

name Displays the name of the cluster.A null string is displayed if no clusters have beendefined or the system is in a single-nodeconfiguration.

LU --

-- model Displays the model of the storage subsystem towhich the cluster management LU belongs.AMS





serial Displays the serial number of the storage subsystemto which the cluster management LU belongs.A null string is displayed if no clusters have beenconfigured.

ldev Displays the LDEV number of the LU assigned to thecluster management LU.A null string is displayed if no clusters have beenconfigured.

PhysicalNode --



-- location Displays the unit name.A null string is displayed for the other node when noclusters have been configured.

hostName Displays the host name.UNDEF

This is displayed for the other node when noclusters have been configured.

physicalNodeName Displays the node name.A null string is displayed if no clusters have beenconfigured or the system is in a single-nodeconfiguration.

status Displays the status of the node. #1

UPThe node is providing the services.

DOWNThe node is in a reset status.

INACTIVEThe node is in a planned shutdown status.

UNKNOWN#2#3

The status cannot be determined.

UNDEFNo clusters have been defined or the system isin a single-node configuration.

managementLANAddress

Displays the IP address of the management LAN.A null string is displayed if the IP address is not setor for the other node when no clusters have beenconfigured.

HBLanAddress Displays the IP address of the heartbeat LAN.A null string is displayed if no clusters have beenconfigured or the system is in a single-nodeconfiguration.

BMCLanAddress Displays the IP address of the BMC port.A null string is displayed if the IP address is not set,if the node is the other node when no clusters havebeen configured.

resourceGroupStatus

Displays the status of the resource group.Online

The resource group is active.

Online Ready#4

The resource group cannot start because thecluster is inactive. This is displayed only for acluster configuration.

Online PendingThe resource group is starting.

Online MaintenanceMonitoring is disabled. This is displayed only fora cluster configuration.

Initializing

3-160 Resources


Properties DescriptionThe resource group is initializing. This isdisplayed only for a cluster configuration.

Discovery (exclusivity)Online processing is being performed for theresource group before operations begin. This isdisplayed only for a cluster configuration.

Offline#4

The resource group is in the planned shutdownstatus.

Offline PendingThe resource group is stopping.

Internal ErrorAn internal error was detected. This is displayedonly for a cluster configuration.

Partial OnlineThe resources are partially blocked. This isdisplayed only for a cluster configuration.

UNDEFNo clusters have been defined. This is displayedonly for a cluster configuration.

resourceGroupErrorInfo

Displays error information for the resource group.No error

The resource group is running normally.

Internal error - not recoverableAn unrecoverable internal error occurred. This isdisplayed only for a cluster configuration.

Monitor activity unknownAn error occurred during the processing to startor stop the maintenance mode. This is displayedonly for a cluster configuration.

No available nodesA monitoring error was detected on the lastfailover node. This is displayed only for a clusterconfiguration.

Node not available(exclusivity)The HA service is inactive on the node to whichthe resource group is to be failed over. This isdisplayed only for a cluster configuration.

Node unknownThe resource group cannot start because thenode status is UNKNOWN. This is displayed onlyfor a cluster configuration.

Split resource group(exclusivity)A duplicate resource group is active in thecluster. This is displayed only for a clusterconfiguration.

srmd executable error


Properties DescriptionThe processing to start or stop the resourcegroup failed. This is displayed only for a clusterconfiguration.

OS errorThe processing to start or stop the resourcegroup failed. This is displayed only for a clusterconfiguration.

UNDEFNo clusters have been defined. This is displayedonly for a cluster configuration.

runningNode Displays the name of the node on which theresource group is running.A null string is displayed if the name is not set, or ifthe system is in a single-node configuration.

serial Displays the serial number.A null string is displayed if no clusters have beenconfigured or if the node is the other node whencommunication with the other node is not available.

SystemVersion --

-- name Displays the product name.

version Displays the version.

#1: If an error occurs in the system, the status of cluster and nodes mightnot be displayed. In this case, collect the error information and contact themaintenance personnel. For details on how to collect error information, seethe Hitachi Data Ingestor User's Guide.

#2: If you execute the method for a stopped node, UNKNOWN is displayed forthe status of the cluster and the other node regardless of the actual status.To check the status of the cluster, nodes, and resource groups, execute themethod for the running node (the other node).

#3: UNKNOWN is also displayed when a cluster starts up. Note that, when acluster starts up, UNKNOWN is displayed until both OSs on the nodes making upthe cluster complete startup (for up to 10 minutes).

#4: This is displayed also when the cluster status is DISABLE.

The following shows an example of acquiring cluster information by sending aGET method request to the ProcessingNode resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/ProcessingNode

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <PhysicalNode> <hostName>D6BQLNBX</hostName> </PhysicalNode></ProcessingNode>

3-162 Resources



Table 3-118 Status codes returned when a GET method request is sent tothe ProcessingNode resource




Changing a host name by using the POST method

The following table describes the XML structure when a POST method requestis sent to the ProcessingNode resource.

Table 3-119 XML structure when a POST method request is sent to theProcessingNode resource

Properties Data type Number of items thatcan be specified


ProcessingNode -- • For clusterconfigurations: 0


Single node

-- PhysicalNode -- • For clusterconfigurations: 0


Single node

-- hostName String • For clusterconfigurations: 0


Single node

The following table describes the properties to be specified when sending aPOST method request to the ProcessingNode resource.

Table 3-120 Properties used to send a POST method request to theProcessingNode resource


ProcessingNode -- --

-- PhysicalNode -- --

-- hostName Sets the host name.You can use alphanumericcharacters and hyphens (-). Thefirst character must be a letter. Youcannot specify a hyphen at the end

Required


Properties Description Specificationof the string. The name must be nomore than 15 bytes long.

The following shows an example of changing the host name by sending aPOST method request to the ProcessingNode resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/ProcessingNode

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <PhysicalNode> <hostName>NewHostName</hostName> </PhysicalNode></ProcessingNode>The following table describes the status codes output when the method ends.

Table 3-121 Status codes returned when a POST method request is sent tothe ProcessingNode resource




Routings

Routings resource overviewYou can use the Routings resource to acquire, add, and delete routinginformation.

The following table describes the HTTP methods that can be used for theRoutings resource.

Table 3-122 HTTP methods that can be used for the Routings resource


/Routings GET Cluster,single node

Acquires routing information.


Adds or deletes routinginformation.

3-164 Resources


Routings resourceThis section describes how to use the Routings resource.

Acquiring the specified routing information by using the GET method


Table 3-123 Structure of the response XML when a GET method request issent to the Routings resource

PropertiesNumber of

response XMLsoutput



false

Routings 1 Cluster,single node

Y

-- Routing 0 or 1 to n Cluster,single node

Y


Y

type 1 Cluster,single node

Y

target 1 Cluster,single node

Y


Y

gateway 1 Cluster,single node

Y

isReject 1 Cluster,single node

Y

mss 1 Cluster,single node

N


The following table describes the properties displayed when a GET methodrequest is sent to the Routings resource.

Table 3-124 Properties displayed when a GET method request is sent tothe Routings resource


Routings --

-- Routing --

-- name Displays the interface name in one of the following formats:

• ethnumber

• agrnumber

• rdnnumber



• mng0type#1 Displays the method for setting the routing destination.

netA network is set.

hostA host is set.

defaultThe default route is set.

target#2 Displays the routing destination as a host name, an IPaddress, or a network address.If the default route is set, default is displayed.

netmask#1 Displays the netmask when a network is set as the routingdestination.If a host is set, a null string is displayed.If the default route is set, 0.0.0.0 is displayed.

gateway Displays the host name or IP address of the gateway.If no gateway is set, a null string is displayed.

isReject Displays whether to reject the destination target.true

The destination target is rejected.

falseThe destination target is not rejected.

mss Displays the maximum segment size for TCP connectionsover the route.If no maximum segment size is set, a null string isdisplayed.

Note:Do not add multiple instances of routing information that have the samerouting target. If this is done, you might not be able to delete the routinginformation correctly.Do not set routing information whose settings (except for the gatewaysetting) are the same as those of existing routing information. If this isdone, you might not be able to delete the routing information correctly.

#1:- If net is selected for type, and 0.0.0.0 is specified for netmask, therouting information operates as the default route.- If net is selected for type, and 255.255.255.255 is specified fornetmask, the routing information operates the same as when the host isdirectly specified for the routing target.

#2:Do not specify the IP addresses shown below as the routing target. Theseaddresses are reserved in the storage subsystem. If you must specifythem, contact our Technical Support Center.- 127.0.0.0 to 127.255.255.255

3-166 Resources


- IP addresses that belong to the same network as the IP address set forthe private maintenance port- IP addresses that belong to the same network as the IP address set forthe heartbeat portYou can use the pmctl command to view the IP address set for theprivate maintenance port. For details on the pmctl command, see theHitachi Data Ingestor CLI User's Guide.You can use the ProcessingNode resource to view the IP address set forthe heartbeat port. For details on the ProcessingNode resource, seeProcessingNode resource on page 3-157.

The following shows an example of acquiring routing information by sending aGET method request to the Routings resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/Routings

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Routings> <Routing> <name>mng0</name> <type>default</type> <target>default</target> <netmask>0.0.0.0</netmask> <gateway>10.213.88.10</gateway> <isReject>false</isReject> </Routing></Routings>The following table describes the status codes output when the method ends.

Table 3-125 Status codes returned when a GET method request is sent tothe Routings resource




Adding or deleting routing information by using the POST method

The following table describes the XML structure when a POST method requestis sent to the Routings resource.


Table 3-126 XML structure when a POST method request is sent to theRoutings resource




Routing -- 1 Cluster,single node

-- operation String 1 Cluster,single node


type String 1 Cluster,single node

target String 0 or 1 Cluster,single node

netmask String 0 or 1 Cluster,single node

gateway String 0 or 1 Cluster,single node

isReject Boolean 0 or 1 Cluster,single node

The following table describes the properties to be specified when sending aPOST method request to the Routings resource.

Table 3-127 Properties used to send a POST method request to theRoutings resource


Routing -- --

-- operation Sets the operation to beperformed on the routinginformation.Add

Specify this value to addrouting information.

DeleteSpecify this value to deleterouting information.

Required

name Sets the name of the interface towhich routing information will beadded.

• ethnumber

• agrnumber

• rdnnumber

Required

type Sets how the routing destinationis set.net

Required if Add is specifiedfor the operation property.

3-168 Resources


Properties Description SpecificationSpecify this value to set thenetwork as the routingdestination.

hostSpecify this value to set thehost as the routingdestination.

defaultSpecify this value to set thedefault route.

target Sets the host name, IP address,or network address of therouting destination.

• Required if Add isspecified for theoperation propertyand net or host isspecified for the typeproperty.

• Required if Delete isspecified for theoperation property.

netmask Sets the netmask. Required if net is specifiedfor the type property.

gateway Sets the host name or IPaddress of the gateway.If you omit this, no value is set.

• Required if default isspecified for the typeproperty and false isspecified or will bespecified for theisReject property.

• Optional if net or hostis specified for the typeproperty.

isReject Sets whether a path for therouting information will berejected.true

Specify this value to reject apath.

false#

Specify this value to set apath.

• Can be set if Add isspecified for theoperation property.

• true must be specifiedif default is specifiedfor the type propertyand the gatewayproperty is not specified


The following shows an example of adding routing information by sending aPOST method request to the Routings resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/Routings


Example of a request XML<Routing> <operation>Add</operation> <name>eth12</name> <type>net</type> <netmask>255.255.255.0</netmask> <target>192.168.30.0</target> <gateway>192.168.30.4</gateway></Routing>The following table describes the status codes output when the method ends.

Table 3-128 Status codes returned when a POST method request is sent tothe Routings resource




SystemController

SystemController resource overviewYou can use the SystemController resource to control services and OSs.

The following table describes the HTTP methods that can be used for theSystemController resource.

Table 3-129 HTTP methods that can be used for the SystemControllerresource


/SystemController GET Cluster,single node

In a cluster configuration, thismethod checks whether aservice needs to be restarted.In a single-nodeconfiguration, this methodchecks whether a service or the OS needs to be restarted.


In a cluster configuration, thismethod restarts a service. Ina single-node configuration,this method restarts a serviceor the OS.

/SystemController/OS


In a cluster configuration, thismethod stops the OS on anode. In a single-nodeconfiguration, this method

3-170 Resources



restarts or stops the OS on anode.

SystemController resourceThis section describes how to use the SystemController resource.

Checking whether the service or OS needs to be restarted by using the GETmethod


Table 3-130 Structure of the response XML when a GET method request issent to the SystemController resource

PropertiesNumber of

response XMLsoutput



false

Services 1 Cluster,single node

Y

-- Service 1 to n Cluster,single node

Y

-- serviceName 1 Cluster,single node

Y

isRestart 1 Cluster,single node

Y#


#: In a cluster configuration, whether the OS needs to be restarted is notdisplayed.

The following table describes the properties displayed when a GET methodrequest is sent to the SystemController resource.

Table 3-131 Properties displayed when a GET method request is sent tothe SystemController resource


Services --

-- Service --

-- serviceName Displays the service name.CIFS

CIFS service

FTPFTP service


Properties DescriptionNFS

NFS service

OSOS. This is displayed only for a single-nodeconfiguration.

isRestart Displays whether the service or OS needs to berestarted.true

The service or OS needs to be restarted.

falseThe service or OS does not need to be restarted.

The following shows an example of checking whether the service and OSneed to be restarted by sending a GET method request to theSystemController resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/SystemController

Example of a response XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Services> <Service> <serviceName>CIFS</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>FTP</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>NFS</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>OS</serviceName> <isRestart>false</isRestart> </Service></Services>The following table describes the status codes output when the method ends.

Table 3-132 Status codes returned when a GET method request is sent tothe SystemController resource




3-172 Resources


Restarting the service or OS by using the POST method

The following table describes the XML structure when a POST method requestis sent to the SystemController resource.

Table 3-133 XML structure when a POST method request is sent to theSystemController resource




Services -- 1 Cluster,single node

-- service -- 1 to n Cluster,single node

-- serviceName String 1 Cluster,single node

isRestart String 1 Cluster,single node


The following table describes the properties to be specified when sending aPOST method request to the SystemController resource.

Table 3-134 Properties used to send a POST method request to theSystemController resource


Services -- --

-- service -- --

-- serviceName In a cluster configuration, thisproperty sets the service name. In asingle-node configuration, thisproperty sets the service name orOS.CIFS

Specify this value to control theCIFS service.

FTPSpecify this value to control theFTP service.

NFSSpecify this value to control theNFS service.

OSSpecify this value to control theOS in a single-nodeconfiguration.

Required

isRestart In a cluster configuration, thisproperty sets whether to restart the

Required


Properties Description Specificationservice. In a single-nodeconfiguration, this property setswhether to restart the service or OS.true

Specify this value to restart aservice or the OS.

falseSpecify this value to not restart aservice or the OS.

The following shows an example of restarting the service and OS by sendinga POST method request to the SystemController resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/SystemController

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Services> <Service> <serviceName>CIFS</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>FTP</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>NFS</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>OS</serviceName> <isRestart>false</isRestart> </Service></Services>The following table describes the status codes output when the method ends.

Table 3-135 Status codes returned when a POST method request is sent tothe SystemController resource




SystemController/OS resourceThis section describes how to use the SystemController/OS resource.

3-174 Resources


StoppingRestarting or stopping the OS on the node by using the POST method

Note:The request becomes effective only on the node on which it is executed.To stop the OS on a node in a cluster configuration, send the same POSTmethod request to both nodes at the same time. If you do not send themethod to both nodes at the same time, a failover might occur.

The following table describes the XML structure when a POST method requestis sent to the SystemController/OS resource.

Table 3-136 XML structure when a POST method request is sent to theSystemController/OS resource




Service -- 1 Cluster,single node

-- operation String 1 Cluster,single node

The following table describes the properties to be specified when sending aPOST method request to the SystemController/OS resource.

Table 3-137 Properties used to send a POST method request to theSystemController/OS resource


Service -- --

-- operation Sets the operation to be performed forthe OS on the node.Reboot

Restarts the OS. This can bespecified only in a single-nodeconfiguration.

ShutdownStops the OS. Execute on both nodesin a cluster configuration.

Required

The following shows an example of stopping the OS on the node by sending aPOST method request to the SystemController/OS resource.

URI of the resource to which a request is senthttps://host-name-or-IP-address:9090/mapi/SystemController/OS

Example of a request XML<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Service>


<operation>Shutdown</operation></Service>The following table describes the status codes output when the method ends.

Table 3-138 Status codes returned when a POST method request is sent tothe SystemController/OS resource


202 The method request was accepted.


3-176 Resources


AAPI Usage Examples

This appendix shows examples of using the HDI API.

□ Example of acquiring cluster and node information in a clusterconfiguration

□ Example of editing the host name in a single-node configuration

□ Example of monitoring the hardware status

□ Example of setting up the network

□ Example of setting HCP information

□ Example of creating a file system in a cluster configuration

□ Example of creating a file system in a single-node configuration

□ Example of deleting a file system

□ Example of stopping the OS in a cluster configuration

□ Example of stopping the OS in a single-node configuration

API Usage Examples A-1Hitachi Data Ingestor API Reference

Example of acquiring cluster and node information in acluster configuration

This section provides an example of acquiring cluster and node information ina cluster configuration.

1. Acquire the cluster and node information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/ProcessingNode?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 27 Apr 2011 23:22:02 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 251X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get node details, [2]Get system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <PhysicalNode> <hostName>DT019000037</hostName> </PhysicalNode> <PhysicalNode> <hostName>DT019000042</hostName> </PhysicalNode></ProcessingNode>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/ProcessingNode?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 27 Apr 2011 23:22:03 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1751X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get node details, [2]Get system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <SystemConfiguration> <mode>CLUSTER</mode> </SystemConfiguration> <status>ACTIVE</status> <name>HA8000</name> <LU>

A-2 API Usage Examples


<model>AMS</model> <serial>83016761</serial> <ldev>0</ldev> </LU> <PhysicalNode> <location>node 0</location> <hostName>DT019000037</hostName> <physicalNodeName>DT019000037</physicalNodeName> <status>UP</status> <managementLANAddress>10.213.88.250</managementLANAddress> <HBLanAddress>172.23.212.21</HBLanAddress> <BMCLanAddress>10.213.88.249</BMCLanAddress> <resourceGroupStatus>Online</resourceGroupStatus> <resourceGroupErrorInfo>No error</resourceGroupErrorInfo> <runningNode>DT019000037</runningNode> <serial>4230MB0-T019000037</serial> <SystemVersion> <name>Hitachi Data Ingestor</name> <version>03-00-00-00-00</version> </SystemVersion> </PhysicalNode> <PhysicalNode> <location>node 1</location> <hostName>DT019000042</hostName> <physicalNodeName>DT019000042</physicalNodeName> <status>UP</status> <managementLANAddress>10.213.88.251</managementLANAddress> <HBLanAddress>172.23.212.25</HBLanAddress> <BMCLanAddress>10.213.88.248</BMCLanAddress> <resourceGroupStatus>Online</resourceGroupStatus> <resourceGroupErrorInfo>No error</resourceGroupErrorInfo> <runningNode>DT019000042</runningNode> <serial>4230MB0-T019000042</serial> <SystemVersion> <name></name> <version></version> </SystemVersion> </PhysicalNode></ProcessingNode>

Example of editing the host name in a single-nodeconfiguration

This section provides an example of editing the host name in a single-nodeconfiguration.

1. Acquire the cluster and node information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/ProcessingNode?prettyprint" -k -X GET -H "Accept: application/xml"Response:


HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:45:22 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 168X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get node details, [2]Get system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <PhysicalNode> <hostName>D6BQLNBX</hostName> </PhysicalNode></ProcessingNode>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/ProcessingNode?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:45:24 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 900X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get node details, [2]Get system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <SystemConfiguration> <mode>SINGLE</mode> </SystemConfiguration> <status>ACTIVE</status> <name>HA8000</name> <LU> <model>AMS</model> <serial>83016761</serial> <ldev>0</ldev> </LU> <PhysicalNode> <location>node 0</location> <hostName>DT019000037</hostName> <physicalNodeName>DT019000037</physicalNodeName> <status>UP</status> <managementLANAddress>10.213.88.250</managementLANAddress> <HBLanAddress>172.23.212.21</HBLanAddress> <BMCLanAddress>10.213.88.249</BMCLanAddress> <resourceGroupStatus>Online</resourceGroupStatus> <resourceGroupErrorInfo>No error</resourceGroupErrorInfo> <runningNode>DT019000037</runningNode> <serial>4230MB0-T019000037</serial> <SystemVersion>



<name>Hitachi Data Ingestor</name> <version>03-00-00-00-00</version> </SystemVersion> </PhysicalNode></ProcessingNode>

2. Edit the host name.hostNameset.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ProcessingNode> <PhysicalNode> <hostName>NewHostName</hostName> </PhysicalNode></ProcessingNode>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/ProcessingNode" -k -d @hostNameset.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:45:26 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Edit host nameContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

3. Check whether the restarting the OS is necessary.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/SystemController?prettyprint" -k -X GET -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:45:27 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 495X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get service statusesConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Services> <Service> <serviceName>CIFS</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>FTP</serviceName> <isRestart>true</isRestart> </Service> <Service>


<serviceName>NFS</serviceName> <isRestart>true</isRestart> </Service> <Service> <serviceName>OS</serviceName> <isRestart>true</isRestart> </Service></Services>

4. If it is necessary to restart the OS, then restart the OS.osReboot.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Services> <Service> <serviceName>CIFS</serviceName> <isRestart>false</isRestart> </Service> <Service> <serviceName>FTP</serviceName> <isRestart>false</isRestart> </Service> <Service> <serviceName>NFS</serviceName> <isRestart>false</isRestart> </Service> <Service> <serviceName>OS</serviceName> <isRestart>true</isRestart> </Service></Services>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/SystemController" -k -d @osReboot.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 202 AcceptedDate: Mon, 11 Apr 2011 05:45:28 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Restart OSConnection: closeTransfer-Encoding: chunkedContent-Type: text/html;charset=utf-8

<html><head><title>202 Accepted</title></head><body><h1>202 Accepted</h1></body></html>

Example of monitoring the hardware statusThis section provides an example of monitoring the hardware status.

1. Acquire the hardware information.

Command line:



curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/Hardware?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 12 Apr 2011 05:30:27 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 7994X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get hardware detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Hardware> <PortDetails> <PortDetail> <status>Up</status> <portName>eth12</portName> <mediaType>copper</mediaType> <linkSpeed>1000Base</linkSpeed> </PortDetail> <PortDetail> <status>Up</status> <portName>eth13</portName> <mediaType>copper</mediaType> <linkSpeed>1000Base</linkSpeed> </PortDetail> <PortDetail> <status>Down</status> <portName>eth14</portName> <mediaType>copper</mediaType> <linkSpeed>Unknown!</linkSpeed> </PortDetail> <PortDetail> <status>Up</status> <portName>eth15</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </PortDetail> </PortDetails> <ManagementLans> <ManagementLan> <status>Up</status> <portName>mng0</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </ManagementLan> </ManagementLans> <HeartbeatLans> <HeartbeatLan> <status>Up</status> <portName>hb0</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </HeartbeatLan> </HeartbeatLans>


<PrivateMaintenanceLans> <PrivateMaintenanceLan> <status>Up</status> <portName>pm0</portName> <mediaType>copper</mediaType> <linkSpeed>100Base</linkSpeed> </PrivateMaintenanceLan> <PrivateMaintenanceLan> <status>Down</status> <portName>pm1</portName> <mediaType>copper</mediaType> <linkSpeed>Unknown!</linkSpeed> </PrivateMaintenanceLan> </PrivateMaintenanceLans> <InternalHDDs> <InternalHDD> <slotName>0</slotName> <status>Normal</status> <vendorInformation>size:136.732 GB,raid level:RAID1</vendorInformation> </InternalHDD> <InternalHDD> <slotName>1</slotName> <status>Normal</status> <vendorInformation>size:136.732 GB,raid level:RAID1</vendorInformation> </InternalHDD> </InternalHDDs> <InternalRAIDBatteries/> <Memories> <Memory> <slotName>0</slotName> <status>Not Installed</status> <vendorInformation>locator:P1C0D1,size:-</vendorInformation> </Memory> <Memory> <slotName>1</slotName> <status>Installed</status> <vendorInformation>locator:P1C0D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>2</slotName> <status>Not Installed</status> <vendorInformation>locator:P1C1D1,size:-</vendorInformation> </Memory> <Memory> <slotName>3</slotName> <status>Installed</status> <vendorInformation>locator:P1C1D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>4</slotName> <status>Not Installed</status> <vendorInformation>locator:P1C2D1,size:-</vendorInformation>



</Memory> <Memory> <slotName>5</slotName> <status>Installed</status> <vendorInformation>locator:P1C2D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>6</slotName> <status>Not Installed</status> <vendorInformation>locator:P0C0D1,size:-</vendorInformation> </Memory> <Memory> <slotName>7</slotName> <status>Installed</status> <vendorInformation>locator:P0C0D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>8</slotName> <status>Not Installed</status> <vendorInformation>locator:P0C1D1,size:-</vendorInformation> </Memory> <Memory> <slotName>9</slotName> <status>Installed</status> <vendorInformation>locator:P0C1D0,size:2048 MB</vendorInformation> </Memory> <Memory> <slotName>10</slotName> <status>Not Installed</status> <vendorInformation>locator:P0C2D1,size:-</vendorInformation> </Memory> <Memory> <slotName>11</slotName> <status>Installed</status> <vendorInformation>locator:P0C2D0,size:2048 MB</vendorInformation> </Memory> </Memories> <MemTotals> <MemTotal> <slotName>0</slotName> <size>size:11.5 GB(12.0 GB)</size> </MemTotal> </MemTotals> <PowerSupplies> <PowerSupply> <powerSupplyName>0</powerSupplyName> <status>OK</status> <vendorInformation></vendorInformation> </PowerSupply> <PowerSupply> <powerSupplyName>1</powerSupplyName> <status>OK</status>


<vendorInformation></vendorInformation> </PowerSupply> </PowerSupplies> <Fans> <Fan> <fanName>0</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>1</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>2</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>3</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>4</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> <Fan> <fanName>5</fanName> <status>OK</status> <vendorInformation></vendorInformation> </Fan> </Fans> <Temperatures> <Temperature> <temperatureName>0</temperatureName> <status>OK</status> <vendorInformation>reading:55 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>1</temperatureName> <status>OK</status> <vendorInformation>reading:44 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>2</temperatureName> <status>OK</status> <vendorInformation>reading:42 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>3</temperatureName> <status>OK</status> <vendorInformation>reading:39 (+/- 0.500) degrees C</vendorInformation>



</Temperature> <Temperature> <temperatureName>4</temperatureName> <status>OK</status> <vendorInformation>reading:45 (+/- 0.500) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>5</temperatureName> <status>OK</status> <vendorInformation>reading:30 (+/- 0) degrees C</vendorInformation> </Temperature> <Temperature> <temperatureName>6</temperatureName> <status>OK</status> <vendorInformation>reading:30 (+/- 0) degrees C</vendorInformation> </Temperature> </Temperatures> <BMCs> <BMC> <status>OK</status> <connection>OK</connection> </BMC> </BMCs> <Models> <Model> <manufacturer>HITACHI </manufacturer> <product>HA8000/RS220</product> </Model> </Models> <Serials> <Serial> <number>4230MB0-T019000037</number> </Serial> </Serials></Hardware>

2. Acquire the FC path information.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FCPaths?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 12 Apr 2011 02:43:12 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 809X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get FC path detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FCPaths> <FCPath>


<path>path000-0004-1E</path> <target>N1-T000</target> <hostPort>fc0004</hostPort> <hostPortWWN>10000000c98f2992</hostPortWWN> <arrayPort>1E</arrayPort> <arrayPortWWN>50060e801046889c</arrayPortWWN> <model>AMS</model> <serial>83016761</serial> <status>Online</status> </FCPath> <FCPath> <path>path000-0005-1F</path> <target>N1-T000</target> <hostPort>fc0005</hostPort> <hostPortWWN>10000000c98f2993</hostPortWWN> <arrayPort>1F</arrayPort> <arrayPortWWN>50060e801046889d</arrayPortWWN> <model>AMS</model> <serial>83016761</serial> <status>Online</status> </FCPath></FCPaths>

Example of setting up the networkThis section provides an example of setting up the network.

1. Acquire the network interface information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NetworkInterfaces?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:19 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 2825X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get network interface detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterfaces> <NetworkInterface> <name>eth12</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other>



</ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth13</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth14</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth15</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth16</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth17</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target>


<other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth18</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth19</name> <netmask></netmask> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>mng0</name> <netmask>255.255.252.0</netmask> <FixedIP> <target>10.213.88.250</target> <other>10.213.88.251</other> </FixedIP> <ServiceIP> <target>10.213.88.252</target> <other>10.213.88.253</other> </ServiceIP> </NetworkInterface></NetworkInterfaces>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NetworkInterfaces?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:21 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 3398X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get network interface detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterfaces>



<target>10.213.88.250</target> <other>10.213.88.251</other> </FixedIP> <ServiceIP> <target>10.213.88.252</target> <other>10.213.88.253</other> </ServiceIP> </NetworkInterface></NetworkInterfaces>

2. Add a network interface.ifset.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface> <name>eth12</name> <netmask>255.255.255.0</netmask> <FixedIP> <target>192.168.30.10</target> <other>192.168.30.11</other> </FixedIP> <ServiceIP> <target>192.168.30.12</target> <other>192.168.30.13</other> </ServiceIP></NetworkInterface>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NetworkInterfaces" -k -d @ifset.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:23 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Set network interfaceContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

3. Check the added network interface.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NetworkInterfaces/eth12" -k -X HEAD -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:35 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 300X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get network interface detailsConnection: closeContent-Type: application/xml


4. Acquire the information about the specified network interface.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NetworkInterfaces/eth12?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:37 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 369X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get network interface detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface> <name>eth12</name> <netmask>255.255.255.0</netmask> <FixedIP> <target>192.168.30.10</target> <other>192.168.30.11</other> </FixedIP> <ServiceIP> <target>192.168.30.12</target> <other>192.168.30.13</other> </ServiceIP></NetworkInterface>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NetworkInterfaces/eth12?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:39 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 439X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get network interface detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface> <name>eth12</name> <mtu>1500</mtu> <netmask>255.255.255.0</netmask> <networkAddress>192.168.30.0</networkAddress> <FixedIP> <target>192.168.30.10</target> <other>192.168.30.11</other> </FixedIP> <ServiceIP>



<target>192.168.30.12</target> <other>192.168.30.13</other> </ServiceIP></NetworkInterface>

5. Change the information about the specified network interface.ifmod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NetworkInterface> <netmask>255.255.255.0</netmask> <FixedIP> <target>192.168.30.14</target> <other>192.168.30.15</other> </FixedIP> <ServiceIP> <target>192.168.30.16</target> <other>192.168.30.17</other> </ServiceIP></NetworkInterface>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address/mapi/NetworkInterfaces/eth12" -k -d @ifmod.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:24:42 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Edit network interfaceContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

6. Acquire the routing information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/Routings?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:25:01 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 306X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get routing detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Routings> <Routing> <name>mng0</name> <type>default</type>


<target>default</target> <netmask>0.0.0.0</netmask> <gateway>10.213.88.10</gateway> <isReject>false</isReject> </Routing></Routings>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/Routings?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:25:02 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 326X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get routing detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Routings> <Routing> <name>mng0</name> <type>default</type> <target>default</target> <netmask>0.0.0.0</netmask> <gateway>10.213.88.10</gateway> <isReject>false</isReject> <mss></mss> </Routing></Routings>

7. Set the routing information.rtset.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Routing> <operation>Add</operation> <name>eth12</name> <type>net</type> <netmask>255.255.255.0</netmask> <target>192.168.30.0</target> <gateway>192.168.30.4</gateway></Routing>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/Routings" -k -d @rtset.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 13:25:03 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1



X-NODE-OperationList: [1]Add routing detailsContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

Example of setting HCP informationThis section provides an example of setting HCP information.

1. Acquire the HCP information.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/HCP?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 12 Apr 2011 13:13:19 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 214X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <systemName>hcp.example.com</systemName> <tenantName>HCP-tenant</tenantName> <userName>username</userName> <password></password></HCP>

2. Set the HCP information.hcpset.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <systemName>hcp.example.com</systemName> <tenantName>HCP-tenant</tenantName> <userName>username</userName> <password>password</password></HCP>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/HCP" -k -d @hcpset.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 12 Apr 2011 13:13:20 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Configure HCP settings, [2]Set regular


backup of system settings informationContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

Example of creating a file system in a cluster configurationThis section provides an example of creating a file system in a clusterconfiguration.

1. Acquire the LU information.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/LUs?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:29 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 19272X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get LU detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><LUs> <LU> <deviceFileName>lu00</deviceFileName> <userLUN>00</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>1</ldev> <type>SATA</type> <size>20.000</size> <function>File</function> <usedBy>MyShare</usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu01</deviceFileName> <userLUN>01</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>2</ldev>



<type>SATA</type> <size>20.000</size> <function>File</function> <usedBy>test</usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu02</deviceFileName> <userLUN>02</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>3</ldev> <type>SATA</type> <size>20.000</size> <function>Sync,P-VOL</function> <usedBy>test_FS</usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu03</deviceFileName> <userLUN>03</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>4</ldev> <type>SATA</type> <size>20.000</size> <function>Sync,D-VOL</function> <usedBy>test_FS</usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu04</deviceFileName> <userLUN>04</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>5</ldev> <type>SATA</type> <size>20.000</size>


<function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu05</deviceFileName> <userLUN>05</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>6</ldev> <type>SATA</type> <size>20.000</size> <function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu06</deviceFileName> <userLUN>06</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>7</ldev> <type>SATA</type> <size>20.000</size> <function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu07</deviceFileName> <userLUN>07</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>8</ldev> <type>SATA</type> <size>20.000</size> <function>Free</function> <usedBy></usedBy>



<rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu08</deviceFileName> <userLUN>08</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>9</ldev> <type>SATA</type> <size>20.000</size> <function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu09</deviceFileName> <userLUN>09</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>10</ldev> <type>SATA</type> <size>20.000</size> <function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu0A</deviceFileName> <userLUN>0A</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>47</ldev> <type>SATA</type> <size>40.000</size> <function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp>


<usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu0B</deviceFileName> <userLUN>0B</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>48</ldev> <type>SATA</type> <size>100.000</size> <function>Free</function> <usedBy></usedBy> <rg>000</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu0C</deviceFileName> <userLUN>0C</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>53</ldev> <type>SATA</type> <size>100.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu0D</deviceFileName> <userLUN>0D</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>54</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool>



<freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu0E</deviceFileName> <userLUN>0E</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>55</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu0F</deviceFileName> <userLUN>0F</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>56</ldev> <type>SATA</type> <size>5.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu10</deviceFileName> <userLUN>10</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>57</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool>


</LU> <LU> <deviceFileName>lu11</deviceFileName> <userLUN>11</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>58</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu12</deviceFileName> <userLUN>12</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>59</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu13</deviceFileName> <userLUN>13</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>60</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU>



<deviceFileName>lu14</deviceFileName> <userLUN>14</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>61</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu15</deviceFileName> <userLUN>15</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>62</ldev> <type>SATA</type> <size>1.000</size> <function>File</function> <usedBy>sites</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu16</deviceFileName> <userLUN>16</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>63</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,D-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu17</deviceFileName> <userLUN>17</userLUN>


<isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>64</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,D-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu18</deviceFileName> <userLUN>18</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>65</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,D-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu19</deviceFileName> <userLUN>19</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>66</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,D-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu1A</deviceFileName> <userLUN>1A</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target>



<model>AMS</model> <serial>83016761</serial> <ldev>67</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,D-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu1B</deviceFileName> <userLUN>1B</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>68</ldev> <type>SATA</type> <size>1.000</size> <function>File</function> <usedBy>sites</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu1C</deviceFileName> <userLUN>1C</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>69</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,P-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu1D</deviceFileName> <userLUN>1D</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial>


<ldev>70</ldev> <type>SATA</type> <size>1.000</size> <function>Sync,D-VOL</function> <usedBy>aaa</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu1E</deviceFileName> <userLUN>1E</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>71</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu1F</deviceFileName> <userLUN>1F</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>72</ldev> <type>SATA</type> <size>1.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu20</deviceFileName> <userLUN>20</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>73</ldev> <type>SATA</type>



<size>1.000</size> <function>WORM</function> <usedBy>ttt</usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu21</deviceFileName> <userLUN>21</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>85</ldev> <type>SATA</type> <size>20.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu22</deviceFileName> <userLUN>22</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>87</ldev> <type>SATA</type> <size>50.000</size> <function>Free</function> <usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU> <LU> <deviceFileName>lu23</deviceFileName> <userLUN>23</userLUN> <isExternalDevice>false</isExternalDevice> <target>N1-T000</target> <model>AMS</model> <serial>83016761</serial> <ldev>88</ldev> <type>SATA</type> <size>100.000</size> <function>Free</function>


<usedBy></usedBy> <rg>004</rg> <dp></dp> <usedPage></usedPage> <pool></pool> <freePool></freePool> <totalPool></totalPool> </LU></LUs>

2. Acquire the file system information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:35 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 2167X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystems> <FileSystem> <fileSystemName>aaa</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize> <aclType>Classic ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu1C</deviceFileName> </LU> </LUs> </FileSystem> <FileSystem> <fileSystemName>ttt</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize> <aclType>Classic ACL</aclType> <WormSetting> <maxRetention>10000-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled>



<autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu20</deviceFileName> </LU> </LUs> </FileSystem> <FileSystem> <fileSystemName>sites</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu1B</deviceFileName> </LU> <LU> <deviceFileName>lu15</deviceFileName> </LU> </LUs> </FileSystem></FileSystems>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:38 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 4399X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystems> <FileSystem> <fileSystemName>aaa</fileSystemName> <usage>Sync Image</usage> <deviceStatus>Normal</deviceStatus> <freeBlocksInMegaBytes>982.016</freeBlocksInMegaBytes> <usedBlocksInMegaBytes>4.096</usedBlocksInMegaBytes> <totalBlocksInMegaBytes>986.112</totalBlocksInMegaBytes> <isLvmEnabled>true</isLvmEnabled>


<fileSystemSizeInGigaByte>1.000</fileSystemSizeInGigaByte> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripes></stripes> <stripeSize></stripeSize> <aclType>Classic ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> <isWormDeleteEnabled></isWormDeleteEnabled> <longestRetention></longestRetention> </WormSetting> <MountSetting> <isMounted>true</isMounted> <mountStatus>Normal</mountStatus> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled> </MountSetting> <LUs> <LU> <deviceFileName>lu1C</deviceFileName> </LU> </LUs> </FileSystem> <FileSystem> <fileSystemName>ttt</fileSystemName> <usage>WORM</usage> <deviceStatus>Normal</deviceStatus> <freeBlocksInMegaBytes>982.016</freeBlocksInMegaBytes> <usedBlocksInMegaBytes>4.096</usedBlocksInMegaBytes> <totalBlocksInMegaBytes>986.112</totalBlocksInMegaBytes> <isLvmEnabled>true</isLvmEnabled> <fileSystemSizeInGigaByte>1.000</fileSystemSizeInGigaByte> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripes></stripes> <stripeSize></stripeSize> <aclType>Classic ACL</aclType> <WormSetting> <maxRetention>10000-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> <isWormDeleteEnabled>true</isWormDeleteEnabled> <longestRetention></longestRetention> </WormSetting> <MountSetting> <isMounted>true</isMounted> <mountStatus>Normal</mountStatus> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled> </MountSetting> <LUs>



<LU> <deviceFileName>lu20</deviceFileName> </LU> </LUs> </FileSystem> <FileSystem> <fileSystemName>sites</fileSystemName> <usage>None</usage> <deviceStatus>Normal</deviceStatus> <freeBlocksInMegaBytes>1973.248</freeBlocksInMegaBytes> <usedBlocksInMegaBytes>4.096</usedBlocksInMegaBytes> <totalBlocksInMegaBytes>1978.368</totalBlocksInMegaBytes> <isLvmEnabled>true</isLvmEnabled> <fileSystemSizeInGigaByte>2.000</fileSystemSizeInGigaByte> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripes></stripes> <stripeSize></stripeSize> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention></maxRetention> <minRetention></minRetention> <isAutoCommitEnabled></isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> <isWormDeleteEnabled></isWormDeleteEnabled> <longestRetention></longestRetention> </WormSetting> <MountSetting> <isMounted>true</isMounted> <mountStatus>Normal</mountStatus> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled> </MountSetting> <LUs> <LU> <deviceFileName>lu1B</deviceFileName> </LU> <LU> <deviceFileName>lu15</deviceFileName> </LU> </LUs> </FileSystem></FileSystems>

3. Create a file system.fscreate.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FileSystem> <fileSystemName>fs</fileSystemName> <aclType>Advanced ACL</aclType> <isLvmEnabled>true</isLvmEnabled> <stripeSize>64</stripeSize> <isLvmStripingEnabled>true</isLvmStripingEnabled> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> </WormSetting>


<LUs> <LU> <deviceFileName>lu04</deviceFileName> </LU> <LU> <deviceFileName>lu05</deviceFileName> </LU> </LUs></FileSystem>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems" -k -d @fscreate.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:42 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Create file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

4. Acquire information about the mount settings of the specified file system.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:55 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 232X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></isFileLastAccessTimeRecordingEnabled></MountSetting>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:



HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:56:58 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 264X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <mountStatus></mountStatus> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></isFileLastAccessTimeRecordingEnabled></MountSetting>

5. Mount the specified file system.fsmount.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>true</isMounted> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled></MountSetting>Command line:

curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting" -k -d @fsmount.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:01 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Mount file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

6. Acquire information about the of the specified file system.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:13 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 734X-NODE-APIVersionID: 03-00-00-00-00


X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>true</isLvmStripingEnabled> <stripeSize>64</stripeSize> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> <LUs> <LU> <deviceFileName>lu04</deviceFileName> </LU> <LU> <deviceFileName>lu05</deviceFileName> </LU> </LUs></FileSystem>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:17 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1424X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <usage>WORM</usage> <deviceStatus>Normal</deviceStatus> <freeBlocksInMegaBytes>40870.912</freeBlocksInMegaBytes> <usedBlocksInMegaBytes>4.096</usedBlocksInMegaBytes> <totalBlocksInMegaBytes>40875.008</totalBlocksInMegaBytes> <isLvmEnabled>true</isLvmEnabled> <fileSystemSizeInGigaByte>40.000</fileSystemSizeInGigaByte> <isLvmStripingEnabled>true</isLvmStripingEnabled> <stripes>2</stripes> <stripeSize>64</stripeSize> <aclType>Advanced ACL</aclType>



<WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> <isWormDeleteEnabled>true</isWormDeleteEnabled> <longestRetention></longestRetention> </WormSetting> <MountSetting> <isMounted>true</isMounted> <mountStatus>Normal</mountStatus> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled> </MountSetting> <LUs> <LU> <deviceFileName>lu04</deviceFileName> </LU> <LU> <deviceFileName>lu05</deviceFileName> </LU> </LUs></FileSystem>

7. Edit the information about the specified file system.fsmod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <WormSetting> <isAutoCommitEnabled>true</isAutoCommitEnabled> <autoCommitPeriod>0-0-15</autoCommitPeriod> <defaultRetention>10950-0-0</defaultRetention> </WormSetting> <addLUs> <LU> <deviceFileName>lu06</deviceFileName> </LU> <LU> <deviceFileName>lu07</deviceFileName> </LU> </addLUs></FileSystem>Command line:

curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -d @fsmod.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:20 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Expand file system, [2]Edit file systemContent-Length: 0


Connection: closeContent-Type: text/plain; charset=iso-8859-1

8. Acquire the CIFS share information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:34 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1732X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShares> <CIFSShare> <exportPoint>/mnt/aaa/add</exportPoint> <cifsShareName>add</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts></restrictionTargetHosts> <isAccessRestrictionAllowed>false</isAccessRestrictionAllowed> <commentForShare></commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner>rw</fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup>ro</fileAccessPermissionOfGroup> <fileAccessPermissionOfOther>ro</fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner>rw</directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup>ro</directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther>ro</directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers>default</fileTimestampChangeableUsers> <isHomeDirectoryEnabled>false</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers></writeDisallowedUsers> <writeDisallowedGroups></writeDisallowedGroups>



<writeAllowedUsers></writeAllowedUsers> <writeAllowedGroups></writeAllowedGroups> </CIFSShare></CIFSShares>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:35 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1771X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShares> <CIFSShare> <exportPoint>/mnt/aaa/add</exportPoint> <cifsShareName>add</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts></restrictionTargetHosts> <isAccessRestrictionAllowed>false</isAccessRestrictionAllowed> <commentForShare></commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner>rw</fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup>ro</fileAccessPermissionOfGroup> <fileAccessPermissionOfOther>ro</fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner>rw</directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup>ro</directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther>ro</directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers>default</fileTimestampChangeableUsers> <isHomeDirectoryEnabled>false</isHomeDirectoryEnabled> <aclType>Classic ACL</aclType> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers></writeDisallowedUsers>


<writeDisallowedGroups></writeDisallowedGroups> <writeAllowedUsers></writeAllowedUsers> <writeAllowedGroups></writeAllowedGroups> </CIFSShare></CIFSShares>

9. Create a CIFS share.cifscreate.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isClassicAcl>false</isClassicAcl> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups> <DirectorySetup> <userName>22222</userName> <groupName>11111</groupName> <isStickyBit>true</isStickyBit> <ownerPermission>rw</ownerPermission> <groupPermission>rw</groupPermission> <otherPermission>rw</otherPermission> </DirectorySetup> <DirectoryACLSettings> <DirectoryACLSetting> <userGroupAccess>allow</userGroupAccess> <name>Everyone</name> <accountType>g</accountType> <applicationDestination>a</applicationDestination> <inheritanceRange>a</inheritanceRange> <accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings></CIFSShare>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares" -k -d @cifscreate.xml -X PUT -H "Content-Type: application/xml"Response:



HTTP/1.1 100 Continue

HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:36 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 4X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create CIFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

10. Acquire the information about the specified CIFS share.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz&prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:49 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1645X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse>


<cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups></CIFSShare>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz&prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:50 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1681X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <aclType>Advanced ACL</aclType> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups>



<writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups></CIFSShare>

11. Edit the information about the specified CIFS share.cifsmod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <cifsShareName>cifssharechange</cifsShareName> <isClassicAcl>false</isClassicAcl> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user1,user2</writeDisallowedUsers> <writeDisallowedGroups>group1,group2</writeDisallowedGroups> <writeAllowedUsers>user3,user4</writeAllowedUsers> <writeAllowedGroups>group3,group4</writeAllowedGroups></CIFSShare>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz" -k -X POST -d @cifsmod.xml -H "Content-Type: application/xml"Response:HTTP/1.1 100 Continue

HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:52 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Edit CIFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

12. Acquire the NFS share information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares?prettyprint" -k -X GET -H "Accept: application/xml"Response:


HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:55 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 886X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShares> <NFSShare> <exportPoint>/mnt/aaa/add</exportPoint> <anonymousUID>65534</anonymousUID> <anonymousGID>65534</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled> <isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <maxRwSize></maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> </NFSShare></NFSShares>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:56 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 925X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShares> <NFSShare> <exportPoint>/mnt/aaa/add</exportPoint> <anonymousUID>65534</anonymousUID> <anonymousGID>65534</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled>



<isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <aclType>Classic ACL</aclType> <maxRwSize></maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> </NFSShare></NFSShares>

13. Create an NFS share.nfscreate.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> <DirectorySetup> <userName>22222</userName> <groupName>11111</groupName> <isStickyBit>true</isStickyBit> <ownerPermission>rw</ownerPermission> <groupPermission>rw</groupPermission> <otherPermission>rw</otherPermission> </DirectorySetup> <DirectoryACLSettings> <DirectoryACLSetting> <userGroupAccess>allow</userGroupAccess> <name>Everyone</name> <accountType>g</accountType> <applicationDestination>a</applicationDestination> <inheritanceRange>a</inheritanceRange> <accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings></NFSShare>


Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares" -k -d @nfscreate.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:57:58 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 4X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create NFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

14. Acquire the information about the specified NFS share.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs&prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:58:15 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 785X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>Command line when true is specified for verbose:



curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs&prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:58:16 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 821X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <aclType>Advanced ACL</aclType> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>

15. Edit the information about the specified NFS share.nfsmod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <anonymousUID>33333</anonymousUID> <anonymousGID>33333</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled> <isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <maxRwSize>6</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost>


</AllowedHosts></NFSShare>curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs" -k -d @nfsmod.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:58:17 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Edit NFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

16. Check whether you can access the namespace.hcpaccess.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <namespaceName>arc-test</namespaceName></HCP>Command line:

curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/HCP/ACCESS" -k -d @hcpaccess.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Thu, 21 Apr 2011 00:50:22 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Test namespace connectionContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

17. Acquire the information about the migration policy.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:58:23 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 74X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml



<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTasks/>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:19:07 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 74X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTasks/>

18. Set the migration policy.policyset.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences> <policy-description>description</policy-description></MigrationTask>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask" -k -d @policyset.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:58:39 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 3X-NODE-OperationList: [1]Configure HCP settings, [2]Set migration policy, [3]Set migration task scheduleContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

19. Acquire the information about the specified migration policy.


Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:59:04 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 505X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-02T07:00:00.000+09:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description>description</policy-description></MigrationTask>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:59:12 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 599X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <task-type>migration</task-type> <task-status>Scheduled(Never executed)</task-status> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-



time>2011-05-02T07:00:00.000+09:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description>description</policy-description></MigrationTask>

20. Edit the specified migration policy.policymod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>week</schedule-repeat> <schedule-interval>10</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences></MigrationTask>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5" -k -d @policymod.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Tue, 19 Apr 2011 07:59:19 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Cancel migration task schedule, [2]Set migration task scheduleContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

Example of creating a file system in a single-nodeconfiguration

This section provides an example of creating a file system in a single-nodeconfiguration.

1. Acquire the total capacity and free capacity of the user disk.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/Disk?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:06:55 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 71X-NODE-APIVersionID: 03-00-00-00-00


X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Disk> <totalDiskSize>3553</totalDiskSize> <freeDiskSize>3552</freeDiskSize></Disk>

2. Acquire the file system information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:06:55 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 71X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystems> <FileSystem> <fileSystemName>ABC</fileSystemName> <fileSystemSizeInGigaByte>1.000</fileSystemSizeInGigaByte> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention>infinite</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting> </FileSystem></FileSystems>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:06:56 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 71X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system details



Connection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystems> <FileSystem> <fileSystemName>ABC</fileSystemName> <usage>WORM</usage> <deviceStatus></deviceStatus> <freeBlocksInMegaBytes>1009.664</freeBlocksInMegaBytes> <usedBlocksInMegaBytes>4.096</usedBlocksInMegaBytes> <totalBlocksInMegaBytes>1013.76</totalBlocksInMegaBytes> <fileSystemSizeInGigaByte>1.000</fileSystemSizeInGigaByte> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention>infinite</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> <isWormDeleteEnabled>true</isWormDeleteEnabled> <longestRetention></longestRetention> </WormSetting> <MountSetting> <isMounted>true</isMounted> <mountStatus>Normal</mountStatus> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled> </MountSetting> </FileSystem></FileSystems>

3. Create a file system.fscreate_single.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <aclType>Advanced ACL</aclType> <fileSystemSizeInGigaByte>10</fileSystemSizeInGigaByte> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> </WormSetting></FileSystem>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems" -k -d @fscreate_single.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:06:56 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1


X-NODE-OperationList: [1]Create file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

4. Acquire information about the mount settings of the specified file system.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:00 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 232X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></isFileLastAccessTimeRecordingEnabled></MountSetting>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:01 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 264X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <mountStatus></mountStatus> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></isFileLastAccessTimeRecordingEnabled></MountSetting>

5. Mount the specified file system.fsmount.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?>



<MountSetting> <isMounted>true</isMounted> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled></MountSetting>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting" -k -d @fsmount.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:02 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Mount file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

6. Acquire information about the specified file system.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:07 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 499X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <fileSystemSizeInGigaByte>10.000</fileSystemSizeInGigaByte> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> </WormSetting></FileSystem>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"


Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:08 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1093X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <fileSystemName>fs</fileSystemName> <usage>WORM</usage> <deviceStatus></deviceStatus> <freeBlocksInMegaBytes>10225.664</freeBlocksInMegaBytes> <usedBlocksInMegaBytes>4.096</usedBlocksInMegaBytes> <totalBlocksInMegaBytes>10229.76</totalBlocksInMegaBytes> <fileSystemSizeInGigaByte>10.000</fileSystemSizeInGigaByte> <aclType>Advanced ACL</aclType> <WormSetting> <maxRetention>10950-0-0</maxRetention> <minRetention>0-0-0</minRetention> <isAutoCommitEnabled>false</isAutoCommitEnabled> <autoCommitPeriod></autoCommitPeriod> <defaultRetention></defaultRetention> <isWormDeleteEnabled>true</isWormDeleteEnabled> <longestRetention></longestRetention> </WormSetting> <MountSetting> <isMounted>true</isMounted> <mountStatus>Normal</mountStatus> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled> </MountSetting></FileSystem>

7. Edit the information about the specified file system.fsmod_single.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><FileSystem> <WormSetting> <isAutoCommitEnabled>true</isAutoCommitEnabled> <autoCommitPeriod>0-0-15</autoCommitPeriod> <defaultRetention>10950-0-0</defaultRetention> </WormSetting> <expandFileSystemSize>10</expandFileSystemSize></FileSystem>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -d @fsmod_single.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:09 GMT



Server: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Expand file system, [2]Edit file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

8. Acquire the CIFS share information.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:13 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 70X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShares> <CIFSShare> <exportPoint>/mnt/ABC</exportPoint> <cifsShareName>ABC</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts></restrictionTargetHosts> <isAccessRestrictionAllowed>false</isAccessRestrictionAllowed> <commentForShare></commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>false</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse>


<cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers></writeDisallowedUsers> <writeDisallowedGroups></writeDisallowedGroups> <writeAllowedUsers></writeAllowedUsers> <writeAllowedGroups></writeAllowedGroups> </CIFSShare></CIFSShares>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:14 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 70X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShares> <CIFSShare> <exportPoint>/mnt/ABC</exportPoint> <cifsShareName>ABC</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts></restrictionTargetHosts> <isAccessRestrictionAllowed>false</isAccessRestrictionAllowed> <commentForShare></commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>false</isHomeDirectoryEnabled> <aclType>Advanced ACL</aclType> <clientAccessPolicy>default</clientAccessPolicy>



<vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers></writeDisallowedUsers> <writeDisallowedGroups></writeDisallowedGroups> <writeAllowedUsers></writeAllowedUsers> <writeAllowedGroups></writeAllowedGroups> </CIFSShare></CIFSShares>

9. Create a CIFS share.cifscreate.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isClassicAcl>false</isClassicAcl> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups> <DirectorySetup> <userName>22222</userName> <groupName>11111</groupName> <isStickyBit>true</isStickyBit> <ownerPermission>rw</ownerPermission> <groupPermission>rw</groupPermission> <otherPermission>rw</otherPermission> </DirectorySetup> <DirectoryACLSettings> <DirectoryACLSetting> <userGroupAccess>allow</userGroupAccess> <name>Everyone</name> <accountType>g</accountType> <applicationDestination>a</applicationDestination> <inheritanceRange>a</inheritanceRange> <accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings></CIFSShare>Command line:


curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares" -k -d @cifscreate.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 100 Continue

HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:16 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 4X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create CIFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

10. Acquire the information about the specified CIFS share.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz&prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:26 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1631X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</



diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups></CIFSShare>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz&prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:27 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1667X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <exportPoint>/mnt/fs/cifs</exportPoint> <cifsShareName>cifsshare</cifsShareName> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <fileAccessPermissionOfOwner></fileAccessPermissionOfOwner> <fileAccessPermissionOfGroup></fileAccessPermissionOfGroup> <fileAccessPermissionOfOther></fileAccessPermissionOfOther> <directoryAccessPermissionOfOwner></directoryAccessPermissionOfOwner> <directoryAccessPermissionOfGroup></directoryAccessPermissionOfGroup> <directoryAccessPermissionOfOther></directoryAccessPermissionOfOther> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <fileTimestampChangeableUsers></fileTimestampChangeableUsers> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <aclType>Advanced ACL</aclType> <clientAccessPolicy>default</clientAccessPolicy>


<vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user3,user4</writeDisallowedUsers> <writeDisallowedGroups>group3,group4</writeDisallowedGroups> <writeAllowedUsers>user1,user2</writeAllowedUsers> <writeAllowedGroups>group1,group2</writeAllowedGroups></CIFSShare>

11. Edit the information about the specified CIFS share.cifsmod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CIFSShare> <cifsShareName>cifssharechange</cifsShareName> <isClassicAcl>false</isClassicAcl> <isAclEnabled>true</isAclEnabled> <restrictionTargetHosts>10.213.77.88</restrictionTargetHosts> <isAccessRestrictionAllowed>true</isAccessRestrictionAllowed> <commentForShare>cifscomment</commentForShare> <isReadOnly>false</isReadOnly> <isBrowseEnabled>true</isBrowseEnabled> <guestAccessPermission>default</guestAccessPermission> <diskSynchronizationPolicy>default</diskSynchronizationPolicy> <cifsClientCacheSetting>default</cifsClientCacheSetting> <isHomeDirectoryEnabled>true</isHomeDirectoryEnabled> <clientAccessPolicy>default</clientAccessPolicy> <vssUse>default</vssUse> <cifsClientRoCacheOptimize>default</cifsClientRoCacheOptimize> <accessBasedEnumeration>default</accessBasedEnumeration> <writeDisallowedUsers>user1,user2</writeDisallowedUsers> <writeDisallowedGroups>group1,group2</writeDisallowedGroups> <writeAllowedUsers>user3,user4</writeAllowedUsers> <writeAllowedGroups>group3,group4</writeAllowedGroups></CIFSShare>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz" -k -X POST -d @cifsmod.xml -H "Content-Type: application/xml"Response:HTTP/1.1 100 Continue

HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:29 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Edit CIFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

12. Acquire the NFS share information.

Command line when verbose is not specified:



curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:33 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 69X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShares> <NFSShare> <exportPoint>/mnt/ABC</exportPoint> <anonymousUID>65534</anonymousUID> <anonymousGID>65534</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled> <isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <maxRwSize></maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> </NFSShare></NFSShares>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:34 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 69X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShares> <NFSShare>


<exportPoint>/mnt/ABC</exportPoint> <anonymousUID>65534</anonymousUID> <anonymousGID>65534</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled> <isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <aclType>Advanced ACL</aclType> <maxRwSize></maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> </NFSShare></NFSShares>

13. Create an NFS share.nfscreate.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts> <DirectorySetup> <userName>22222</userName> <groupName>11111</groupName> <isStickyBit>true</isStickyBit> <ownerPermission>rw</ownerPermission> <groupPermission>rw</groupPermission> <otherPermission>rw</otherPermission> </DirectorySetup> <DirectoryACLSettings> <DirectoryACLSetting> <userGroupAccess>allow</userGroupAccess> <name>Everyone</name> <accountType>g</accountType> <applicationDestination>a</applicationDestination> <inheritanceRange>a</inheritanceRange>



<accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings></NFSShare>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares" -k -d @nfscreate.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 100 Continue

HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:35 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 4X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create NFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

14. Acquire the information about the specified NFS share.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs&prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:44 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 785X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping>


<securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs&prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:45 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 821X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID> <anonymousGID>22222</anonymousGID> <isPortRestrictionEnabled>true</isPortRestrictionEnabled> <isSubtreeCheckEnabled>true</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>true</isAccessCheckWithLockRequestEnabled> <aclType>Advanced ACL</aclType> <maxRwSize>5</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress> <isReadOnly>true</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>

15. Edit the information about the specified NFS share.nfsmod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><NFSShare> <anonymousUID>33333</anonymousUID> <anonymousGID>33333</anonymousGID> <isPortRestrictionEnabled>false</isPortRestrictionEnabled> <isSubtreeCheckEnabled>false</isSubtreeCheckEnabled> <isAccessCheckWithLockRequestEnabled>false</isAccessCheckWithLockRequestEnabled> <maxRwSize>6</maxRwSize> <AllowedHosts> <AllowedHost> <hostOrAddress>*</hostOrAddress>



<isReadOnly>false</isReadOnly> <synchronousWritingSetting>rw_sync</synchronousWritingSetting> <anonymousMapping>root_only</anonymousMapping> <securityFlavor>sys</securityFlavor> </AllowedHost> </AllowedHosts></NFSShare>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs" -k -d @nfsmod.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:47 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Edit NFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

16. Check whether you can access the namespace.hcpaccess.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><HCP> <namespaceName>arc-test</namespaceName></HCP>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/HCP/ACCESS" -k -d @hcpaccess.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:49 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Test namespace connectionContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

17. Acquire the information about the migration policy.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:51 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jk


Content-Length: 74X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTasks> <MigrationTask> <policy-name>ABC</policy-name> <fileSystemName>ABC</fileSystemName> <namespace>arc-ABC</namespace> <schedule-start-time>2011-04-27T22:00:00.000+09:00</schedule-start-time> <schedule-repeat>daily</schedule-repeat> <schedule-interval></schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description></policy-description> </MigrationTask></MigrationTasks>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:55 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 74X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTasks> <MigrationTask> <policy-name>ABC</policy-name> <task-type>migration</task-type> <task-status>Scheduled(Never executed)</task-status> <fileSystemName>ABC</fileSystemName> <namespace>arc-ABC</namespace> <schedule-start-time>2011-04-27T22:00:00.000+09:00</schedule-start-time> <schedule-repeat>daily</schedule-repeat> <schedule-interval></schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description></policy-description> </MigrationTask></MigrationTasks>



18. Set the migration policy.policyset.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences> <policy-description>description</policy-description></MigrationTask>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask" -k -d @policyset.xml -X PUT -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:07:59 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 3X-NODE-OperationList: [1]Configure HCP settings, [2]Set migration policy, [3]Set migration task scheduleContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

19. Acquire the information about the specified migration policy.

Command line when verbose is not specified:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5?prettyprint" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:08:21 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 584X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-


time>2011-05-02T07:00:00.000+09:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description>description</policy-description></MigrationTask>Command line when true is specified for verbose:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:08:25 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 686X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <policy-name>policy</policy-name> <task-type>migration</task-type> <task-status>Scheduled(Never executed)</task-status> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-time>2011-05-02T07:00:00.000+09:00</schedule-start-time> <schedule-repeat>day</schedule-repeat> <schedule-interval>5</schedule-interval> <exec-stop-occurrences>0</exec-stop-occurrences> <duration>8</duration> <policy-description>description</policy-description></MigrationTask>

20. Edit the information about the specified migration policy.policymod.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MigrationTask> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedule-start-time> <schedule-repeat>week</schedule-repeat> <schedule-interval>10</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences></MigrationTask>Command line:



curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5" -k -d @policymod.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Wed, 13 Apr 2011 08:08:29 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Cancel migration task schedule, [2]Set migration task scheduleContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

Example of deleting a file systemThis section provides an example of deleting a file system.

1. Check whether the specified migration policy exists.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5" -k -X HEAD -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:38:52 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 492X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 2X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settingsConnection: closeContent-Type: application/xml

2. Delete the specified migration policy.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/MigrationTask/cG9saWN5" -k -X DELETE -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:38:58 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Delete migration policyContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

3. Check whether the specified CIFS share exists.


Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJlY2hhbmdl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz" -k -X HEAD -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:02 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 1499X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get CIFS share detailsConnection: closeContent-Type: application/xml

4. Delete the specified CIFS share.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/CIFSShares/Y2lmc3NoYXJlY2hhbmdl?SHARE-DIRECTORY-NAME=L21udC9mcy9jaWZz" -k -X DELETE -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:03 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Delete CIFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

5. Check whether the specified NFS share exists.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs" -k -X HEAD -H "Accept: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:05 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 658X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get NFS share detailsConnection: closeContent-Type: application/xml

6. Delete the specified NFS share.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/nfs" -k -X DELETE -H "Accept: application/xml"



Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:07 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Delete NFS shareContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

7. Check whether the specified file system exists.

Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -X HEAD -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:11 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkContent-Length: 685X-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Get file system detailsConnection: closeContent-Type: application/xml

8. Unmount the specified file system.fsumount.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MountSetting> <isMounted>false</isMounted> <isReadOnly>false</isReadOnly> <isFileLastAccessTimeRecordingEnabled>true</isFileLastAccessTimeRecordingEnabled></MountSetting>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/MountSetting" -k -d @fsumount.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:14 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Unmount file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

9. Delete the specified file system.

Command line:


curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/FileSystems/fs/" -k -X DELETE -H "Content-Type: application/xml"Response:HTTP/1.1 200 OKDate: Mon, 11 Apr 2011 05:39:27 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Delete file systemContent-Length: 0Connection: closeContent-Type: text/plain; charset=iso-8859-1

Example of stopping the OS in a cluster configurationThis section provides an example of stopping the OS in a clusterconfiguration.

1. Stop the OS running on one of the nodes.osShutdown.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Service> <operation>Shutdown</operation></Service>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address-of-one-node:9090/mapi/SystemController/OS -k -d @osShutdown.xml -X POST -H Content-Type: application/xmlResponse:HTTP/1.1 202 AcceptedDate: Tue, 12 Apr 2011 13:21:18 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Shutdown OSConnection: closeTransfer-Encoding: chunkedContent-Type: text/html;charset=utf-8


2. Stop the OS running on the other node.osShutdown.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Service> <operation>Shutdown</operation></Service>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address-of-other-node:9090/mapi/SystemController/OS -k -d @osShutdown.xml -X POST -H Content-Type: application/xml



Response:HTTP/1.1 202 AcceptedDate: Tue, 12 Apr 2011 13:21:19 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Shutdown OSConnection: closeTransfer-Encoding: chunkedContent-Type: text/html;charset=utf-8


Example of stopping the OS in a single-node configurationThis section provides an example of stopping the OS in a single-nodeconfiguration.

1. Stop the OS.osShutdown.xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Service> <operation>Shutdown</operation></Service>Command line:curl -i -b api-auth=user-name:password "https://host-name-or-IP-address:9090/mapi/SystemController/OS" -k -d @osShutdown.xml -X POST -H "Content-Type: application/xml"Response:HTTP/1.1 202 AcceptedDate: Mon, 11 Apr 2011 14:37:18 GMTServer: Hitachi Web Server 04-00 (Unix) mod_jkX-NODE-APIVersionID: 03-00-00-00-00X-NODE-CompletedOperation: 1X-NODE-OperationList: [1]Shutdown OSConnection: closeTransfer-Encoding: chunkedContent-Type: text/html;charset=utf-8



Acronyms

This section lists the acronyms used in the HDI manuals.

A

ABEAccess Based Enumeration

ACEaccess control entry

ACLaccess control list

AJPApache JServ Protocol

APIapplication programming interface

ARPAddress Resolution Protocol

ASCIIAmerican Standard Code for Information Interchange

ASNAbstract Syntax Notation

B

# A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Acronyms-1Hitachi Data Ingestor API Reference

BDCBackup Domain Controller

BMCbaseboard management controller

C

CAcertificate authority

CHAchannel adapter

CHAPChallenge-Handshake Authentication Protocol

CIFSCommon Internet File System

CIMCommon Information Model

CLIcommand line interface

COBOLCommon Business-Oriented Language

CPUcentral processing unit

CSRcertificate signing request

CSVcomma-separated values

CTLcontroller

CUcontrol unit

CV



custom volume

D

DACLdiscretionary access control list

DARDirect Access Recovery

DBdatabase

DBMSdatabase management system

DCdomain controller

DEPdata execution prevention

DESData Encryption Standard

DFSdistributed file system

DIMMdual in-line memory module

DLLdynamic-link library

DNdistinguished name

DNSDomain Name System

DOMDocument Object Model

DOSDisk Operating System



DRAMdynamic random access memory

DSAdigital signal algorithm

DTDDocument Type Definition

E

ECCerror-correcting code

EUCExtended UNIX Code

F

FCFibre Channel

FIBforwarding information base

FIFOFirst In, First Out

FQDNfully qualified domain name

FTPFile Transfer Protocol

FVFixed Volume

FXPFile Exchange Protocol

G



GbEGigabit Ethernet

GIDgroup identifier

GMTGreenwich Mean Time

GPLGNU General Public License

GUIgraphical user interface

H

HBAhost bus adapter

H-LUNhost logical unit number

HPFSHigh Performance File System

HSSOHiCommand single sign-on

HTMLHyperText Markup Language

HTTPHypertext Transfer Protocol

HTTPSHypertext Transfer Protocol Secure

I

I/Oinput/output

ICAP



Internet Content Adaptation Protocol

ICMPInternet Control Message Protocol

IDidentifier

IPInternet Protocol

IP-SWIP switch

J

JISJapanese Industrial Standards

JSPJavaServer Pages

K

KDCKey Distribution Center

L

LACPLink Aggregation Control Protocol

LANlocal area network

LBAlogical block addressing

LCDLocal Configuration Datastore

LDAP



Lightweight Directory Access Protocol

LDEVlogical device

LDIFLDAP Data Interchange Format

LDKClogical disk controller

LEDlight-emitting diode

LFLine Feed

LTSlong term support

LUlogical unit

LUNlogical unit number

LUSElogical unit size expansion

LVILogical Volume Image

LVMLogical Volume Manager

M

MACMedia Access Control

MD5Message-Digest algorithm 5

MIBmanagement information base



MMCMicrosoft Management Console

MPmicroprocessor

MSSmaximum segment size

MTUmaximum transmission unit

N

NASNetwork-Attached Storage

NATnetwork address translation

NDMPNetwork Data Management Protocol

NetBIOSNetwork Basic Input/Output System

NFSNetwork File System

NICnetwork interface card

NISNetwork Information Service

NTFSNew Technology File System

NTPNetwork Time Protocol

O

OID



object identifier

ORBobject request broker

OSoperating system

P

PAPPassword Authentication Protocol

PCpersonal computer

PCIPeripheral Component Interconnect

PDCPrimary Domain Controller

PDUprotocol data unit

PIDprocess identifier

POSIXPortable Operating System Interface for UNIX

PPprogram product

R

RADIUSRemote Authentication Dial In User Service

RAIDRedundant Array of Independent Disks

RAMrandom access memory



RASReliability Availability Serviceability

RCSRevision Control System

RDrelational database

RFCRequest for Comments

RIDrelative identifier

RPCremote procedure call

RSARivest, Shamir, and Adleman

S

SACLsystem access control list

SANstorage area network

SASSerial Attached SCSI

SATAserial ATA

SAXSimple API for XML

SCSISmall Computer System Interface

SHAsecure hash algorithm

SID



security identifier

SJISShift JIS

SLPRStorage Logical Partition

SMBServer Message Block

SMD5Salted Message Digest 5

SNMPSimple Network Management Protocol

SOAPSimple Object Access Protocol

SPservice pack

SSDsolid-state drive

SSHSecure Shell

SSHASalted Secure Hash Algorithm

SSLSecure Sockets Layer

SSOsingle sign-on

SVGASuper Video Graphics Array

T

TCPTransmission Control Protocol



TOStype of service

TTLtime to live

U

UACUser Account Control

UDPUser Datagram Protocol

UIDuser identifier

UNCUniversal Naming Convention

URIUniform Resource Identifier

URLUniform Resource Locator

UTCCoordinated Universal Time

UTFUCS Transformation Format

V

VDEVVirtual Device

VLANvirtual LAN

VLLVirtual LVI/LUN



W

WADLWeb Application Description Language

WANwide area network

WINSWindows Internet Name Service

WORMWrite Once, Read Many

WSworkstation

WWNWorld Wide Name

WWWWorld Wide Web

X

XDRExternal Data Representation

XFSextended file system

XMLExtensible Markup Language



Glossary

This glossary explains the terms used in the HDI manuals.

A

ACEAn entry in an ACL. An ACE sets access permissions for directories and files for eachuser and group. ACE formats differ depending on the ACL type.

ACLA list of all the ACEs for a particular directory or file. An ACL defines the accesspermissions for a particular directory or file.

ACL typeThe type of file system or file that is supported by the ACL. The ACL types that can beused in HDI systems are the Advanced ACL type (compatible with NTFS ACL), and theClassic ACL type (compatible with POSIX ACL).

Anti Virus AgentA program used to scan, in real time, for viruses in data shared with users via CIFS inan HDI system.

B

Backup RestoreA program used for backing up data in an HDI file system.

backup serverA server that manages backup and restore operations by using backup managementsoftware.


Glossary-1Hitachi Data Ingestor API Reference

C

CIFSA protocol that provides file-sharing services to Windows users.

clusterA redundant configuration that enables a service to continue when an error occurs ormaintenance work is performed.

cluster management LUAn LU that is assigned to a node and stores settings information, such as clusterconfiguration information and file system information.

command deviceA control device used to receive commands that control storage subsystems.

Configuration ManagerA program used to set up an HDI system and manage file system operations.

D

Data ControlOne of the programs on a node OS.

data portA node port that is used to connect to the front-end LAN.

device fileA user LU. For more information, see user LU.

Device ManagerA program that manages disk resources and the hardware configuration of storagesubsystems in an integrated manner.

differential-data snapshotA virtual volume that reproduces the conditions of past file systems in Sync Image,using file system data and data saved in the differential-data storage device.

differential-data storage deviceA storage subsystem volume for saving file system pre-update data that is used bydifferential-data snapshots of Sync Image.

Dynamic ProvisioningA function that virtually allocates volumes of a given capacity to a host independent ofthe physical capacity of the storage subsystem.



E

end userAmong the clients who access the HDI service, a user who can check the status of thefile system usage from a computer on the network.

F

failbackThe relocation of a failed-over resource group back to its original node in the clusterafter an error has been recovered on the node or maintenance on the node is complete.

failoverThe relocation of a resource group to the other node in a cluster when an error occurson a node or when maintenance on a node is required. Failovers enable continuousoperation of the services provided by an HDI system.

File SharingOne of the programs on a node OS.

fixed IP addressAn IP address set for a specific interface in a node.

front-end LANA LAN used by a client to access the data stored in a storage subsystem.

H

HBase Storage Mgmt Common ServiceThe Web-container service for Hitachi Command Suite Common Component.

HBase Storage Mgmt Web ServiceThe Web-server service for Hitachi Command Suite Common Component.

heartbeat LANA LAN used by each node in a cluster to check the operating status of the other node.

Hitachi Command Suite Common ComponentA component that provides functions, such as being able to log in to the GUI, outputtingmanagement server integrated logs, and Web services, common to all Hitachi FileServices Manager and Hitachi Command Suite products.

Hitachi Content Platform (HCP)



A system used for managing and storing data for long periods of time. File system datacreated in an HDI system can be migrated to an HCP system.

Hitachi Data Ingestor (HDI)A system that uses storage subsystems and nodes to provide a file-sharing service.

Hitachi File Services ManagerA program necessary for system administrator to operate or manage an HDI systemfrom a GUI.

I

incremental backupIncremental backup is a backup method that targets only data that has changed afterthe previous backup was performed.

L

LDEVA unit of storage that is created by logically partitioning a storage area within a RAIDgroup of a storage subsystem. Although referred to as an LDEV in File ServicesManager, it is referred to as a logical unit (LU) in Hitachi AMS2000 series and HitachiAMS1500 storage subsystems.

logical volumeAn area created by using a volume manager to divide a volume group into one or moreareas. In HDI systems, this area corresponds to a file system, differential-data storagedevice, or differential-data snapshot created using the volume manager.

LUAn LDEV that is assigned to a port in a storage subsystem.

LUNA management number assigned to each LU in a storage subsystem. Although referredto as an LUN in File Services Manager, it is referred to as an H-LUN in the HitachiAMS2000 series and Hitachi AMS1500 storage subsystems.

LUN ExpansionFunctionality for expanding the capacity of an LU by integrating multiple LUs into one.

LVMA type of volume manager. For more information, see volume manager.



M

maintenance personnelHitachi engineers who maintain HDI systems.

management consoleA computer used by the system administrator to operate File Services Manager.

management LANA LAN used by the system administrator to operate and manage an HDI system.

management serverA computer on which Hitachi File Services Manager is installed. The management servercan also be used as a management console.

mediaRecording media, such as magnetic tape, for storing backed up data.

media serverA server that controls a tape device installed outside the storage subsystem.

N

NFSA protocol that provides file-sharing services to UNIX users.

nodeA device that is connected to a storage subsystem and that is used as a file server. Twonodes make up a cluster.

O

OS diskA logical disk area in a node, that stores the OS and programs that run on the OS.

P

physical nodeA node that makes up part of a processing node.

Primary Server BaseA program that provides Web server functionality.



processing nodeA logical group made up of nodes. If nodes are set up in a cluster, the cluster is treatedas a processing node.

Q

quotaThe maximum block space and maximum number of i-nodes available to a user. In anHDI system, limits can be set and managed for each file system, or each directoryimmediately below the mount point.

R

resource groupA management unit used to manage multiple resources (such as NFS share settings,CIFS share settings, file system information, and service IP address information) as agroup. Services can be started and stopped for each resource group. If an error occurs,failover is performed for each resource group.

S

scan serverA server that scans, via a LAN, CIFS-shared data in an HDI system for viruses.

service IP addressAn IP address used by a user when connecting to a service running on a resourcegroup. By using a service IP address, the user can continue to use the service even if anerror occurs on a node and the resource group fails over to the other, properly runningnode.

ShadowImageA program for replicating user data within a storage subsystem, without using a host.

subtree quotaThe quota set for a directory residing immediately under the mount point directory.Subtree quotas are used to control the amount of block usage and i-node usage foreach directory. Subtree quotas can also be set for users and groups.

Sync ImageA program used to create differential-data snapshots of an HDI file system.

system administrator



A user who manages an HDI system. The system administrator sets up an HDI systemand monitors system operations and error information.

system LUA collective term for the OS disks and the cluster management LU.

T

tape deviceA device for storing multiple types of storage media.

targetA unit used to manage multiple LUs as one group so that a node can uniquely recognizethe LUs of a storage subsystem.

TrueCopyA program for replicating user data between two storage subsystems, without using ahost.

trunkingA technology used to create a virtual network interface from a group of ports. HDIallows you to configure a network by using virtual network interfaces that areassembled by using trunking.

U

Universal ReplicatorA program that asynchronously reproduces user data between two storage subsystemswithout transferring the data via a host.

user LUA generic term for an LU that is assigned to a node and that stores user data such asfile system information. A user LU is also called a device file or an LU (excluding thesystem LU).

user LUNA management number assigned to each user LU. A user LUN is also called a device filenumber.

user mappingThe process of assigning a user ID and group ID to a user registered in a domaincontroller when the user accesses a CIFS share.



V

volume groupAn area that consists of one or more LUs that have been grouped together by a volumemanager. In a normal file system, a volume group is made up of one file system. ForSync Image file systems, a volume group is made up of a file system, a differential-datastorage device, and differential-data snapshots.

volume managerFunctionality for volume management. In the HDI system, LVM is used as the volumemanager. This functionality enables you to create volume groups combining LUs and tocreate logical volumes out of volume groups.

W

WORMAn abbreviation for "Write Once, Read Many". The WORM status indicates that datacannot be modified. A file whose status is changed to the WORM status is called aWORM file, and a file system in which any files can be changed to a WORM file is calleda WORM file system.



Index

A

account 2-2ACE Glossary-1ACL Glossary-1ACL type Glossary-1acquiring hardware status 3-80Allow header 1-4Anti Virus Agent Glossary-1API

overview 1-1system configuration 1-2usage example A-1

API administrator account informationacquiring 3-4

APIAccount resource 3-4authentication cookie 2-3

B

Backup Restore Glossary-1backup server Glossary-1

C

CIFS Glossary-2CIFS share

adding 3-7checking existence of 3-7deleting 3-7

CIFS share informationacquiring 3-7changing 3-7

CIFSShares resource 3-7

cluster Glossary-2cluster and node information

acquiring 3-156cluster configuration 1-2cluster management LU Glossary-2command device Glossary-2command line

using quotation marks 2-3Configuration Manager Glossary-2cookie

format 2-4

D

Data Control Glossary-2data port Glossary-2DELETE method

how to execute requests 1-8device file Glossary-2Device Manager x, Glossary-2differential-data snapshot Glossary-2differential-data storage device Glossary-2Disk resource 3-44Dynamic Provisioning x, Glossary-2

E

encoding 2-2Base64 encoding 2-2percent-encoding 2-2

end user Glossary-3example

Index-1Hitachi Data Ingestor API Reference

acquiring API administrator account information3-5

acquiring CIFS share information 3-13, 3-34acquiring cluster information 3-162acquiring cluster mode details of hardware 3-88acquiring FC path information 3-48acquiring file system information 3-56, 3-69,3-77acquiring HCP information 3-94acquiring LU information 3-102acquiring migration policy information 3-106,3-113acquiring network interface information 3-120acquiring NFS share information 3-134, 3-149acquiring routing information 3-167acquiring total capacity and unused capacity ofuser disk 3-45adding CIFS share 3-27adding network interface 3-124adding routing information 3-169API usage A-1changing API administrator account password3-6changing host name 3-164changing network interface information 3-130checking whether access to HCP namespace isallowed 3-98creating file system 3-62creating NFS share 3-145editing file system information 3-73, 3-79editing NFS share information 3-155resetting schedule of migration task 3-115restarting OS on node 3-175sending CIFS share information 3-42setting migration policy 3-109setting or deleting HCP information 3-96

F

failback Glossary-3failover Glossary-3FC path information

acquiring 3-46FCPaths resource 3-46File Services Manager xFile Sharing Glossary-3file system

checking existence 3-50

creating 3-49deleting 3-50

file system informationacquiring 3-49, 3-50editing 3-50

FileSystems resource 3-49fixed IP address Glossary-3front-end LAN Glossary-3

G

GET methodhow to execute requests 1-5

glossary Glossary-1

H

Hardware resource 3-80HBase Storage Mgmt Common Service Glossary-3HBase Storage Mgmt Web Service Glossary-3HCP x, Glossary-3HCP information

acquiring 3-93deleting 3-93setting 3-93

HCP resource 3-93HDI x, Glossary-4HEAD method

how to execute requests 1-8heartbeat LAN Glossary-3Hitachi AMS1500 xHitachi AMS2000 series xHitachi Command Suite Common ComponentGlossary-3Hitachi Content Platform Glossary-3Hitachi Data Ingestor Glossary-4Hitachi File Services Manager Glossary-4host name

editting 3-156how to execute

request 1-4HTTP method 1-3HTTP status code 1-8

I

I/O formats for requests and responses 1-11incremental backup Glossary-4


information about mount setting of file systemediting 3-50

Internet Explorer xi

L

LDEV Glossary-4logical volume Glossary-4LU Glossary-4LU information

acquiring 3-98LUN Glossary-4LUN Expansion Glossary-4LUs resource 3-98LVM Glossary-4

M

maintenance personnel Glossary-5management console Glossary-5management LAN Glossary-5management server Glossary-5media Glossary-5media server Glossary-5migration policy

checking for existence of 3-104deleting 3-103setting 3-103

migration policy informationacquiring 3-103

migration task scheduleresetting 3-103

MigrationTask resource 3-103mount setting information of file system

acquiring 3-50

N

network interfaceadding 3-117checking existence of 3-117

network interface informationacquiring 3-117editing 3-117

NetworkInterfaces resource 3-117NFS Glossary-5NFS share

adding 3-131

checking existence of 3-131deleting 3-131

NFS share informationacquiring 3-131acquiring 3-131editing 3-131

NFSShares resource 3-131node Glossary-5

O

OSrestarting 3-170, 3-171stopping 3-170

OS disk Glossary-5overview

API 1-1

P

password of API administrator accountchanging 3-4

physical node Glossary-5POST method

how to execute requests 1-7prettyprint 1-12Primary Server Base Glossary-5processing node Glossary-6ProcessingNode resource 3-156product names xproperty 1-3PUT method

how to execute requests 1-6

Q

query parameter 1-11query parameters

prettyprint 1-12verbose 1-12

quota Glossary-6

R

requesthow to execute 1-4

request header 1-12


resource 1-3list of 3-3

resource group Glossary-6resource URI 2-2

notes 2-2response header 1-13response XML

when an error occurs 1-14restarting OS 3-170restarting service 3-170routing information

acquiring 3-164adding 3-164deleting 3-164

Routings resource 3-164

S

scan server Glossary-6service

restarting 3-170service IP address Glossary-6ShadowImage xi, Glossary-6single-node configuration 1-2SSL certificate 2-4status code (HTTP) 1-8subtree quota Glossary-6Sync Image Glossary-6system administrator Glossary-6system configuration

for using API 1-2system LU Glossary-7SystemController resource 3-170

T

tape device Glossary-7target Glossary-7total capacity of user disk

acquiring 3-44TrueCopy xi, Glossary-7trunking Glossary-7

U

Universal Replicator Glossary-7Universal Storage Platform V/VM xiunused capacity of user disk

acquiring 3-44URI 2-2

character length 2-2notes 2-2percent-encoding 2-3using multi-byte characters 2-3

usage exampleacquiring cluster and node information in clusterconfiguration A-2creating file systems in a cluster configurationA-22creating file systems in a single-nodeconfiguration A-55deleting file systems A-75editing host name in single-node configurationA-3monitoring hardware status A-6setting HCP information A-21setting up network A-12stopping OS in a single-node configuration A-79stopping OS in cluster configuration A-78

user can access HCP namespacechecking whether 3-93

user diskacquiring total capacity 3-44acquiring unused capacity 3-44

user LU Glossary-7user LUN Glossary-7user mapping Glossary-7

V

verbose 1-12Virtual Storage Platform xivolume group Glossary-8volume manager Glossary-8

W

WADL 1-4What you can do by using the API 1-2Windows xiWORM Glossary-8


Hitachi Data Systems

Corporate Headquarters750 Central ExpresswaySanta Clara, California 95050-2627U.S.A.Phone: 1 408 970 [email protected]

Asia Pacific and Americas750 Central ExpresswaySanta Clara, California 95050-2627U.S.A.Phone: 1 408 970 [email protected]

Europe HeadquartersSefton ParkStoke PogesBuckinghamshire SL2 4HDUnited KingdomPhone: + 44 (0)1753 [email protected]

MK-90HDI026-00

Hdi API References Hdi0260

Documents

Transcript of Hdi API References Hdi0260