Hdi API References Hdi0260

Hitachi Data Ingestor
API Reference
Document Organization Product Version Getting Help Contents
MK-90HDI026-00
Copyright 2011 Hitachi, Ltd., Hitachi Data Systems Corporation, ALL RIGHTS RESERVED No 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 retrieval system for any purpose without the express written permission of Hitachi, Ltd. (hereinafter referred to as "Hitachi") and Hitachi Data Systems Corporation (hereinafter referred to as "Hitachi Data Systems"). Hitachi and Hitachi Data Systems reserve the right to make changes to this document at any time without notice and assume no responsibility for its use. This document contains the most current information available at the time of publication. When new and/or revised information becomes available, 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 most recent product announcement or contact your local Hitachi Data Systems sales office for information on feature and product availability. Notice: Hitachi Data Systems products and services can be ordered only under the terms and conditions of Hitachi Data Systems' applicable agreement(s). The use of Hitachi Data Systems products 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 from employees and other individuals to access relevant data; and b) Ensuring that data continues to be held, retrieved, deleted or otherwise processed in accordance with relevant laws. Hitachi is a registered trademark of Hitachi, Ltd. in the United States and other countries. Hitachi Data Systems is a registered trademark and service mark of Hitachi in the United States and other countries. 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.
ii
Hitachi Data Ingestor API Reference
Contents
Preface.................................................................................................vii
Intended audience.............................................................................................viii Product version.................................................................................................viii Release notes....................................................................................................viii Document revision level.....................................................................................viii Document organization......................................................................................viii Organization of HDI manuals...............................................................................ix Referenced documents.........................................................................................x Abbreviation conventions.....................................................................................x Document conventions........................................................................................xi Convention for storage capacity values................................................................xii Getting help.......................................................................................................xii Comments........................................................................................................xiii
1. Overview of the API.............................................................................1-1
What you can do by using the API...........................................................................1-2 System configurations.............................................................................................1-2 Resources and properties........................................................................................1-3 HTTP methods........................................................................................................1-3 How to execute a request........................................................................................1-4 When using the GET method.............................................................................1-5 When using the PUT method.............................................................................1-6 When using the POST method...........................................................................1-7 When using the DELETE method.......................................................................1-8 When using the HEAD method...........................................................................1-8 HTTP status codes..................................................................................................1-8 I/O formats for requests and responses..................................................................1-11 Query parameters.................................................................................................1-11 Request headers...................................................................................................1-12 Response headers.................................................................................................1-13 Response XML when an error occurs......................................................................1-14
2. Access and Authentication....................................................................2-1

URI and account for accessing an HDI system..........................................................2-2 Notes on URIs........................................................................................................2-2
iii
Maximum URI length........................................................................................2-2 Encoding of specific characters and values......................................................... 2-2 Quotation marks on the command line............................................................... 2-3 Using multi-byte characters............................................................................... 2-3 Authentication cookie..............................................................................................2-3 SSL certificate.........................................................................................................2-4
3. Resources........................................................................................... 3-1
List of resources..................................................................................................... 3-3 APIAccount............................................................................................................3-4 APIAccount resource overview...........................................................................3-4 APIAccount resource.........................................................................................3-4 Acquiring API administrator account information by using the GET method. 3-4 Changing the API administrator account password by using the POST method ..............................................................................................................3-5 CIFSShares.............................................................................................................3-7 CIFSShares resource overview...........................................................................3-7 CIFSShares resource.........................................................................................3-7 Acquiring information about all CIFS shares by using the GET method........ 3-8 Adding a CIFS share by using the PUT method........................................3-14 CIFSShares/CIFS-share-name resource............................................................3-28 Acquiring CIFS share information by using the GET method......................3-29 Changing CIFS share information by using the POST method....................3-35 Deleting the specified CIFS share by using the DELETE method................3-43 Checking whether the specified CIFS share exists by using the HEAD method ............................................................................................................3-44 Disk.....................................................................................................................3-44 Disk resource overview...................................................................................3-44 Disk resource.................................................................................................3-44 Acquiring information specified about the disk by using the GET method...3-45 FCPaths................................................................................................................3-46 FCPaths resource overview..............................................................................3-46 FCPaths resource............................................................................................3-46 FileSystems..........................................................................................................3-49 FileSystems resource overview.........................................................................3-49 FileSystems resource.......................................................................................3-50 Acquiring file system information by using the GET method......................3-50 Creating a file system by using the PUT method......................................3-57 FileSystems/file-system-name resource............................................................3-63 Acquiring the specified file system information by using the GET method. .3-63 Editing information about the specified file system by using the POST method ............................................................................................................3-70 Deleting the specified file system by using the DELETE method................3-74 Checking whether the specified file system exists by using the HEAD method ............................................................................................................3-74 FileSystems/file-system-name/MountSetting resource........................................3-75 Acquiring information about the mount settings of the specified file system by using the GET method...........................................................................3-75 Editing information about the mount settings of the specified file system by using the POST method.........................................................................3-77 Hardware.............................................................................................................3-80 Hardware resource overview ..........................................................................3-80
iv
Hardware resource.........................................................................................3-80 Acquiring hardware information by using the GET method........................3-80 HCP.....................................................................................................................3-93 HCP resource overview....................................................................................3-93 HCP resource..................................................................................................3-93 Acquiring the specified HCP information by using the GET method............3-94 Setting or deleting HCP information by using the POST method................3-95 HCP/ACCESS resource.....................................................................................3-97 Checking whether the user can access the HCP namespace by using the POST method.................................................................................................3-97 LUs......................................................................................................................3-98 LUs resource overview....................................................................................3-98 LUs resource..................................................................................................3-99 Acquiring LU information by using the GET method..................................3-99 MigrationTask.....................................................................................................3-103 MigrationTask resource overview...................................................................3-103 MigrationTask resource.................................................................................3-104 Acquiring information for all migration policies by using the GET method.3-104 Setting the migration policy by using the PUT method............................3-107 MigrationTask/policy-name resource...............................................................3-110 Acquiring information for the specified migration policy by using the GET method...............................................................................................3-110 Resetting the schedule of the migration task by using the POST method. 3-113 Deleting policy information by using the DELETE method.......................3-116 Checking whether the specified migration policy exists by using the HEAD method...............................................................................................3-116 NetworkInterfaces...............................................................................................3-117 NetworkInterfaces resource overview.............................................................3-117 NetworkInterfaces resource...........................................................................3-117 Acquiring network interface information by using the GET method..........3-117 Adding a network interface by using the PUT method.............................3-122 NetworkInterfaces/network-interface-name resource.......................................3-125 Acquiring network interface information by using the GET method..........3-125 Changing the network interface information by using the POST method. .3-127 Checking whether the specified network interface exists by using the HEAD method...............................................................................................3-130 NFSShares..........................................................................................................3-131 NFSShares resource overview........................................................................3-131 NFSShares resource......................................................................................3-131 Acquiring information for all NFS shares by using the GET method..........3-132 Adding an NFS share by using the PUT method.....................................3-135 NFSShares/NFS-share-directory-name resource...............................................3-146 Acquiring information for the specified NFS share by using the GET method3-147 Editing NFS share information by using the POST method......................3-150 Deleting the specified NFS share by using the DELETE method...............3-155 Checking whether the specified NFS share exists by using the HEAD method ..........................................................................................................3-156 ProcessingNode...................................................................................................3-156 ProcessingNode resource overview.................................................................3-156 ProcessingNode resource...............................................................................3-157 Acquiring cluster and node information by using the GET method...........3-157 Changing a host name by using the POST method.................................3-163
v
Routings.............................................................................................................3-164 Routings resource overview...........................................................................3-164 Routings resource.........................................................................................3-165 Acquiring the specified routing information by using the GET method......3-165 Adding or deleting routing information by using the POST method..........3-167 SystemController.................................................................................................3-170 SystemController resource overview...............................................................3-170 SystemController resource.............................................................................3-171 Checking whether the service or OS needs to be restarted by using the GET method...............................................................................................3-171 Restarting the service or OS by using the POST method.........................3-173 SystemController/OS resource........................................................................3-174 StoppingRestarting or stopping the OS on the node by using the POST method ..........................................................................................................3-175
A API Usage Examples.............................................................................A-1

Example Example Example Example Example Example Example Example Example Example of of of of of of of of of of
acquiring cluster and node information in a cluster configuration..............A-2 editing the host name in a single-node configuration................................A-3 monitoring the hardware status..............................................................A-6 setting up the network.........................................................................A-12 setting HCP information.......................................................................A-21 creating a file system in a cluster configuration......................................A-22 creating a file system in a single-node configuration...............................A-55 deleting a file system...........................................................................A-75 stopping the OS in a cluster configuration.............................................A-78 stopping the OS in a single-node configuration......................................A-79
Acronyms Glossary Index
vi
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 Hitachi Data Ingestor API Reference
vii
Intended audience
This manual is intended for those who use the API to develop application programs 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 version
This document revision applies to Hitachi Data Ingestor version 2.7 and above.
Release notes
Release notes can be found on the documentation CD. Release notes contain requirements and more recent product information that may not be fully described in this manual. Be sure to review the release notes before installation.
Document revision level

Revision
MK-90HDI026-00
Date
June 2011
Description
Initial release
Document organization
The following table provides an overview of the contents and organization of this document.
Chapter
Overview of the API
Description
Provides an overview of the HDI API. The topics covered by this chapter include system configurations, resources and properties, HTTP methods, how to execute requests, HTTP status codes, I/O formats for requests and responses, query parameters, request headers, and response headers. Explains the URI used to access an HDI system, notes pertaining to URIs specified for API requests, how to specify authentication cookies, and SSL certificates. Explains the types of HTTP methods that can be used for requests, the structure of request XMLs and response XMLs for each method, the details of properties, the URIs of the resources to which requests are sent, and the status codes returned when methods end.
Access and Authentication Resources
viii
Chapter
API Usage Examples Acronyms Glossary Index
Description
Explains the API usage through the use of examples. Lists the acronyms used in the HDI manuals. Explains the terms used in the HDI manuals. Lists the topics in this document in alphabetical order.
Organization of HDI manuals

HDI manuals are organized as shown below. Note that whether HDI nodes can be set up in a redundant configuration depends on the HDI model. A configuration where nodes are made redundant is called a cluster configuration, and a configuration where a node is not made redundant with another node is called a single-node configuration. Which manuals you need to read depends on which configuration you are going to use.
Manual name
Hitachi Data Ingestor Installation and Configuration Guide
Description
This is the first manual to read for HDI cluster configurations, and can be used for reference purposes in single-node configurations. This manual explains how to start HDI system operation and the things to keep in mind before operating an HDI system. This manual also explains how to set up an HDI system. This is the first manual to read for HDI single-node configurations. This manual explains how to set up, use, and manage an HDI system. Note that for HDI cluster configurations, you do not need to read this manual. This manual explains how to operate and manage an HDI system from a GUI. The manual also explains how to perform system maintenance and troubleshooting procedures. This manual explains how to operate and manage an HDI system by using commands. This manual explains how to back up data by using Backup Restore. The manual also explains the actions to take when a system error occurs during the operation of Backup Restore. This manual contains the things to keep in mind before managing differential-data snapshots by using Sync Image. The manual also explains the actions to take when a system error occurs during the operation of Sync Image. In addition, this manual also explains how to operate and manage differential-data snapshots by using commands. This manual contains HDI messages, as well as the causes and actions to take for each message. This manual explains how to initially set up a clustered HDI system and how to start operation by linking the HDI system to an HCP system that uses the same storage subsystems. This manual explains the information required to use the API to develop application programs that manage HDI systems.
Hitachi Data Ingestor User's Guide for Single Node Configuration Hitachi Data Ingestor User's Guide Hitachi Data Ingestor CLI User's Guide Hitachi Data Ingestor Backup Restore User's Guide Hitachi Data Ingestor Sync Image User's Guide
Hitachi Data Ingestor Error Codes Hitachi Data Ingestor Getting Started Guide Hitachi Data Ingestor API Reference (This manual)
ix
Manual name
Description
Hitachi Data Ingestor File This manual contains the things to keep in mind before using Access (CIFS/NFS) User's the CIFS or NFS service of an HDI system from a CIFS or NFS client. Guide
Referenced documents
The following Hitachi referenced documents can be found on the applicable Hitachi 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 Onsite Setup Hitachi Content Platform Installing an HCP300 System - Final Onsite Setup Hitachi Content Platform Using HCP Data Migrator Hitachi Content Platform HCP Management API Reference
Abbreviation conventions
This manual uses the following abbreviations for product names:
Abbreviation
Device Manager Dynamic Provisioning File Services Manager
Full name or meaning

Hitachi Device Manager Software Hitachi Dynamic Provisioning A generic name for the following: Configuration Manager Hitachi File Services Manager
HCP HDI Hitachi AMS1500 Hitachi AMS2000 series
Hitachi Content Platform Hitachi Data Ingestor Hitachi Adaptable Modular Storage 1500 Hitachi Adaptable Modular Storage 2000 series
Abbreviation
Internet Explorer ShadowImage
Full name or meaning

Windows(R) Internet Explorer(R) 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 Windows
Hitachi Virtual Storage Platform Microsoft(R) Windows(R) Operating System
Document conventions
This document uses the following typographic conventions:
Convention
Bold
Description
Indicates text on a window, other than the window title, including menus, menu options, buttons, fields, and labels. Example: Click OK. Indicates a variable, which is a placeholder for actual text provided by the user or system. Example: copy source-file target-file Note: Angled brackets (< >) are also used to indicate variables. Indicates text that is displayed on screen or entered by the user. Example: # pairdisplay -g oradb Indicates a variable, which is a placeholder for actual text provided by the user or system. Example: # pairdisplay -g <group> Note: Italic font is also used to indicate variables. Indicates optional values. Example: [ a | b ] indicates that you can choose a, b, or nothing. Indicates required or expected values. Example: { a | b } indicates that you must choose either a or b. Indicates that you have a choice between two or more options or arguments. Examples: [ a | b ] indicates that you can choose a, b, or nothing. { a | b } indicates that you must choose either a or b. The item or items preceding the ellipsis (...) can be repeated. To specify multiple items, use a comma (,) to
Italic
screen/code < > angled brackets
[ ] square brackets { } braces | vertical bar
...
xi
Convention
Description
delimit them. Example: A,B...indicates that B can be specified as many times as necessary after A.
Convention for storage capacity values

Physical storage capacity values (e.g., drive capacity) are calculated based on the following values:
Physical Capacity Unit
1 KB 1 MB 1 GB 1 TB 1 PB 1 EB 1,000 bytes 1,0002 bytes 1,0003 bytes 1,0004 bytes 1,0005 bytes 1,0006 bytes
Value
Logical storage capacity values (e.g., logical device capacity) are calculated based on the following values:
Logical Capacity Unit
1 KB 1 MB 1 GB 1 TB 1 PB 1 EB 1 block 1,024 (210) bytes 1,024 KB or 1,0242 bytes 1,024 MB or 1,0243 bytes 1,024 GB or 1,0244 bytes 1,024 TB or 1,0245 bytes 1,024 PB or 1,0246 bytes 512 bytes
Value
Getting help
If you need to call the Hitachi Data Systems Support Center, please provide as 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 host system(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 troubleshooting purposes. The service information messages (SIMs), including reference codes and severity levels, displayed by Storage Navigator and/or logged at the host.
xii
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 the Hitachi Data Systems Portal for contact information: https:// portal.hds.com
Comments
Please send us your comments on this document: doc.comments@hds.com. Include the document title, number, and revision, and refer to specific section(s) and paragraph(s) whenever possible. Thank you! (All comments become the property of Hitachi Data Systems Corporation.)
xiii
xiv
1
Overview of the API
The Hitachi Data Ingestor (HDI) API is an interface used for creating application programs that manage HDI systems that are located in each site from the data center. This chapter provides an overview of the HDI API. The topics covered by this chapter include system configurations, resources and properties, HTTP methods, how to execute requests, HTTP status codes, I/O formats for requests and responses, query parameters, request headers, and response headers. 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 Hitachi Data Ingestor API Reference
1-1
What you can do by using the API

HDI provides an API in the HTTP REST (Representational State Transfer) interface format. The API automates the settings for connecting HDI to the network and the operations such as for creating file systems. By linking HDI with Hitachi Content Platform (HCP) via the network, you can create an application at the core site that centrally manages the HDI systems at the edge sites and the HCP system at the core site. Central management from the core site reduces the data management workload of the system administrators at each edge site.
System configurations
The following figure shows examples of a system configuration in which the HDI API is used.
Figure 1-1 Examples of a system configuration

HDI The HDI system provides services related to file systems for network clients. The HDI system can be created in either a cluster configuration or a single-node configuration. The HDI system in a cluster configuration consists of two HDI nodes that are 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 HDI node. HDI API client The HDI API client uses the API to connect to the HDI system and manages the HDI node. The HDI API client uses the API to send a request, and then receives the processing results (a response) from the API. The HDI API client must be set so that it can communicate with the HDI node. HCP
1-2
The HCP system archives large volumes of content generated by a variety of systems for long-term storage. Client utilizing a file system A client can use a CIFS or NFS share to access a file system. A client utilizing a file system connects to the HDI data port.
Resources and properties

You can manage resources by using the HDI API. Resources include FileSystems, 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 URI indicates a FileSystems resource named fs01 in the HDI system named system.example.com: https://system.example.com:9090/mapi/FileSystems/fs01 Each property has the String, Integer, or Boolean data type. For example, the data type of the fileSystemName property of a FileSystems resource is String.
HTTP methods
Table 1-1 Supported HTTP methods on page 1-3 describes the HTTP/1.1 methods supported by the HDI API.
Table 1-1 Supported HTTP methods

Method
GET PUT POST DELETE HEAD
Description
Acquires information about the resource indicated by the request URI. Adds information to the resource indicated by the request URI. Changes the information about the resource indicated by the request URI. Deletes the resource indicated by the request URI. Acquires the meta-information of the resource indicated by the request URI. Unlike the GET method, the response of this method includes only meta-information and does not include a message body. Checks the methods that can be used for the resource indicated by the request URI.
OPTIONS
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
1-3
method returns the types of usable HTTP methods and the MIME types supported by these HTTP methods. When the OPTIONS method request is used, it returns the following information: Allow header A list of HTTP methods supported by the request URI. For example, if the OPTIONS method request is used for a URI that supports the GET, HEAD, and POST methods, the Allow header is returned as follows: Allow: OPTIONS, GET, HEAD, POST WADL A WADL document describes the MIME types supported by the HTTP methods regarding the request URI. A WADL document is an XML document that defines Web service specifications.
The WADL document is set in the body of the response to an OPTIONS method request. The following shows an example of the WADL XML document output when the OPTIONS 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 request

This manual uses the curl command (version 7.18.2) to use a REST interface. This section describes how to send a request method by using the curl command in a cluster configuration. For details about the user name and password specified for the curl command, see Authentication cookie on page 2-3.
1-4
When using the GET method

You can use the GET method to acquire resource information. Resource information is returned in XML format. To acquire information about the file system named fs, execute the curl command as follows: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems/fs/?prettyprint" -k -X GET -H "Accept: application/xml" After you execute the curl command, the status code, header, and resource information are displayed as follows: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:13 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 734 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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>
1-5
<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>
<LU>
When using the PUT method

You can use the PUT method to add information to a resource. Create a file containing the contents you want to request in XML format, and then execute the curl command. To expand the capacity of a file system named fs and change the WORM attribute: 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>
1-6
</LUs> </FileSystem>
2.
Execute the curl command as follows: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress: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 are displayed as follows: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:42 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Create file system Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
When using the POST method

You can use the POST method to change resource information. Create a file containing the contents you want to request in XML format, and then execute the 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-IPaddress: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 are displayed as follows: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:20 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00
1-7
X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Expand file system, [2]Edit file system Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
When using the DELETE method

You 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-IPaddress:9090/mapi/FileSystems/fs/" -k -X DELETE -H "Content-Type: application/xml" After you execute the curl command, the status code and header are displayed as follows: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:27 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Delete file system Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
When using the HEAD method

You can use the HEAD method to check whether a resource exists. To check whether the file system named fs exists, execute the curl command as follows: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems/fs/" -k -X HEAD -H "Content-Type: application/xml" After you execute the curl command, the status code and header are displayed as follows: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:11 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 685 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-Type: application/xml
HTTP status codes

An HDI system returns an HTTP status code in response to a request from an HDI API client.
1-8
If method execution succeeds, the HDI system generates a status code, and then returns the status code as a response via the API. For GET methods, response XML is returned in addition to status codes. The response XML returned for a GET method request contains detailed information about the resource indicated by the URI. Table 1-2 HTTP status codes that can be generated when a request terminates normally on page 1-9 describes the status codes that can be generated when a request terminates normally.
Table 1-2 HTTP status codes that can be generated when a request terminates normally
Status code
200 OK
Applicable method
All methods
Description
The HDI system successfully created a resource, changed a resource, deleted a resource, acquired information about a resource, or confirmed the existence of a resource. This status code means that HDI processing has been requested, but completion of the processing is not guaranteed. Wait a while, and then check the resource status to make sure that the processing has completed normally.
202
Accepted
All methods
If method execution fails, the HDI system returns a status code that indicates the type of error along with error information set in the response header via the API. The status code returned when a failure occurs is determined by the cause of the failure. Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9 describes the status codes that can be generated when a request terminates abnormally. Status codes defined by RFC2068, which are not described in Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9 might also be returned.
Table 1-3 HTTP status codes that can be generated when a request terminates abnormally
Status code
302 FOUND
Applicable method
All methods
Description
The request was not valid. The following are possible 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 are possible causes: A required query parameter was not specified in the request.
1-9
Status code
Applicable method
Description
When a PUT or POST method request was used, any of the following conditions were met: - A required property was not specified in the request body. - The request body contains an invalid property. - The request body contains an XML whose format is invalid. - Data-type checking failed. - The request body contains an invalid value. A nonexistent MIME type was specified for the Content-Type or Accept header in the request.
401 403
UNAUTHORIZE D FORBIDDEN
All methods PUT POST DELETE
The user account specified in the request header was denied during authentication. When the PUT or POST method was requested, the request failed although valid properties were specified. Alternatively, when the DELETE method request was used, the HDI system could not delete the file system for one of the following reasons: The file system was being used by the backup functionality. The file system contained files for which a retention period was set.
404 405
NOT_FOUND METHOD_NOT_ ALLOWED
All methods GET PUT POST DELETE GET
The resource indicated by the URI does not exist. The requested processing is not valid for the resource indicated by the URI.
406
NOT_ACCEPTA BLE CONFLICT
An invalid MIME type is specified in the Accept header that was specified when the request was made. When the PUT method request was used, the HDI system could not create a resource because the resource already exists. Alternatively, when the POST method request was used for a Routings resource, the HDI system was unable to set a new route because the route already exists. The HDI system does not support the MIME type specified for the Content-Type or Accept header. An error occurred in the processing of the node to which the request was sent. Requests cannot be temporarily accepted because the system is under a heavy load or is undergoing maintenance. Wait a while, and then reissue the request.
409
PUT POST
415 500 503
UNSUPPORTED _MEDIA_TYPE INTERNAL_SE RVER_ERROR SERVICE_UNA VAILABLE
All methods All methods All methods
1-10
I/O formats for requests and responses

When you use the API to create or change a resource, specify resource properties in XML format. To acquire information about a resource, responses to the OPTIONS request are in WADL format. You can use the following URI to download the XML schema to be used by the HDI API for the request body and the response body: https://host-name-or-IP-address:9090/mapi/static/mapi-3_0.xsd All responses that are returned through the API are encoded in UTF-8. The body of requests created as input for the HDI API must also be encoded in UTF-8. The HDI API supports the MIME types listed in Table 1-4 Supported MIME types on page 1-11. These MIME types can be specified as I/O formats for requests and responses.
Table 1-4 Supported MIME types

MIME type
application/xml application/octet-stream XML format Multiple requests (for uploading or downloading the contents of files)
Description
Query parameters
In the HDI API, you can use the query parameters listed in Table 1-5 Supported query parameters on page 1-11. Query parameters are specified following a question mark (?) appended to a resource URI. If multiple query parameters are specified, ampersands (&) are used as parameter separators. Note that query parameters are case sensitive.
Table 1-5 Supported query parameters

Query parameter
otherNode
Applicable resource
MigrationTa sk
Applicabl e method
All methods
Description
The otherNode query parameter is used when a resource group in a cluster configuration is to be specified for processing. If true is specified, processing is performed for the resource group that normally runs on the node not requested by the method. If false is specified, processing is performed for the resource group that normally runs on the node requested by the method.
1-11
Query parameter
Applicable resource
Applicabl e method
Description
If the otherNode query parameter is not specified, the method operates the same way as when false is specified. Example: MigrationTask?otherNode=true
prettyprint
All resources
All methods
The prettyprint query parameter is used to specify the output format. If the prettyprint query parameter is specified, the XML is output in an easy-toread format that uses line breaks and indentation. If the prettyprint query parameter is not specified, neither line breaks nor indentation is used in the output XML. Example: FileSystems?prettyprint The SHARE-DIRECTORY-NAME query parameter is used to uniquely distinguish resources that have the same name. This parameter must be specified when the CIFSShares/CIFS-share-name resource or the NFSShares/NFS-shared-directory-name resource is used. Example: CIFSShares/CIFS-share-name?SHAREDIRECTORY-NAME=path-name-ofshared-directory The verbose query parameter is used to specify the information to be output when the GET method request is used. If true is specified, all properties contained in the resource are output. If false is specified, only the properties that the PUT or POST method can process are output. The XML output when the GET method request is used can be used as an XML template for using the PUT or POST method request. If the verbose query parameter is not specified, the method operates the same way as when false is specified. Example: ProcessingNode?verbose=true
SHAREDIRECTORYNAME
CIFSSha res/ CIFSsharename NFSShar es/NFSsharedirectory -name
GET POST DELETE HEAD
verbose
All resources
GET
Request headers
Table 1-6 Request headers on page 1-13 describes the request headers set by HDI API clients.
1-12
Table 1-6 Request headers

Request header
Cookie Accept
Description
User authentication details for a request. If a request does not contain a cookie, an error is returned. A list of MIME types for responses that the HDI API client can process. If an invalid MIME type has been set, an error is returned. The media type of the content sent to the recipient. This header can be used when the PUT or POST method request is used. If an invalid MIME type has been set, an error is returned.
Content-Type
Response headers
Table 1-7 Response headers on page 1-13 describes the response headers set by the HDI API.
Table 1-7 Response headers

Response header
Status Code
Description
A status code indicating the processing result. A status code is set in any type of request. The version number of the HDI API. If the corresponding CLI commands or properties do not exist, Unknown is displayed. The media type of the content sent to the recipient
Format of the set value

Number
When the header is set

This header is always set.
X-NODEAPIVersionID
String This header is (Same format as the always set. HDI version number)
Content-Type
MIME type application/xml or text/plain is returned. If application/xml is set, evaluate the entity body. Number
application/xml is set if the GET method request is terminated successfully.
Content-Length
The size of the content sent to the recipient. The size is represented as a decimal octet (eight bits). The message ID of an error that
This header is set only if the GET method request is terminated successfully. This header is set if a request fails.
X-NODEErrorMessageID
String
1-13
Response header
Description
occurred during processing
Format of the set value
When the header is set
X-NODEOperationList
The names of all the processes executed by the request. If the request was not executed, a hyphen (-) is displayed.
String Command names listed in the following format: [1]processingname-1, [2]processingname-2,... If multiple processes are executed, they are separated by commas (,). Number
X-NODECompletedOperatio n
The number of processes executed successfully. If the request was not executed, a hyphen (-) is displayed.
Response XML when an error occurs

Information regarding an error that occurs during processing is returned as response XML via the API. The following table shows the structure of the response XML when an error occurs.
Table 1-8 Structure of the response XML when an error occurs

Property
Error -messageId message cause recoveryAction -The message ID of the error message The message text of the error message The cause of the error The recovery action for the error
Description
1-14
2
Access and Authentication
For the HDI API, URIs are used to identify resources. Each request must specify one URI and must contain a certificate of the account that is used to access the HDI system via the API. This chapter explains the URI used to access an HDI system, notes pertaining to URIs specified for API requests, how to specify authentication cookies, and SSL certificates. URI and account for accessing an HDI system Notes on URIs Authentication cookie SSL certificate
Access and Authentication Hitachi Data Ingestor API Reference
2-1
URI and account for accessing an HDI system

In each request sent to the HDI API, a resource URI must be specified in the following format: https://HDI-node-host-name-or-IP-address:9090/mapi As the port number, all resource URIs must contain 9090, which is the port number 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 a single-node configuration, the account used to access the API is the same as the account used to log in to the GUI. If you have not changed the password for the GUI login account, the initial password for admin is chang3me!. To prevent unauthorized access, make sure that you change the password. For details about how to change the password for admin, see APIAccount on page 3-4.
Notes on URIs
This section provides notes on the URIs specified in API requests.
Maximum URI length

The maximum length of the URI (excluding the query parameters) that follows mapi is 4,095 bytes. If a request contains a URI whose length exceeds the maximum, the HDI system returns status code 414 (REQUEST_URI_TOO_LARGE).
Encoding of specific characters and values

Some 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 on page 2-3 must be percent-encoded. Note: If the result of Base64 encoding includes characters listed in Table 2-1 Characters that must be percent-encoded on page 2-3, those characters must be percent-encoded. The following is an encoding example: 1. Use Base64 encoding to encode the CIFS share name.
2-2
For this example, the result of Base64 encoding is PX5+U2hhcmU=. 2. Percent-encoding the plus sign (+) in PX5+U2hhcmU= replaces the plus sign with %2B. The result of percent-encoding is PX5%2BU2hhcmU=.
Table 2-1 Characters that must be percent-encoded

Character
Space Tab Carriage return Line feed Plus sign (+) Percent sign (%) Hash mark (#) Question mark (?) Ampersand (&) Forward slash (/)# %20 %09 %0A %0D %2B %25 %23 %3F %26 %2F
Percent-encoded value
#: Do not percent-encode forward slashes if they are used as URI delimiters.
Quotation marks on the command line

A Windows or UNIX shell is used when the HDI API is used. Note that some characters used in commands have special meanings for the shell. For example, an ampersand (&), which is used as a query parameter separator in URIs, indicates that a process is to be processed in the background. To prevent the Windows or UNIX shell from misinterpreting characters in URIs, make sure that the entire URI is enclosed in double quotation marks (").
Using multi-byte characters

Unicode (UTF-8) multi-byte characters can be used for the request URI and request XML of the following resources: /CIFSShares/CIFS-share-name /MigrationTask/policy-name
Authentication cookie
To access an HDI system via the API, a certificate consisting of a user name and a password is required for each request. An api-auth cookie is used to specify a certificate.
2-3
Each request sent to the HDI API is always authenticated before it is processed. The information needed for authentication is set in a request header by using a cookie generated by the HDI API client. The cookie value consists of a user name encoded in Base64 and a password generated by using the MD5 hash algorithm. The following shows the format of api-auth cookies: api-auth=user-name-encoded-in-Base64:password-generated-by-MD5-hashalgorithm Use tools that convert plain texts into Base64-encoded values and MD5 hash values to generate api-auth cookie values. However, we recommend that you do not use a Web-based interactive tool because of the reduced level of security. A certificate sent in a request header is checked against the user information stored in the database. If the request sent to the server is authenticated successfully, the request is validated as being in the correct format. If authentication fails, a status code for the processing abnormally terminating is returned.
SSL certificate
The 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 a trusted server certificate. If the certificate cannot be installed on the client, use the server certificate for SSL encrypted communication.
2-4
3
Resources
This chapter describes the types of HTTP methods that can be used for requests, the structure of request XMLs and response XMLs for each method, the details of properties, the URIs of the resources to which requests are sent, and the status codes returned when methods end. The OPTIONS method can 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 Hitachi Data Ingestor API Reference
3-1
Routings SystemController
3-2
List of resources
The following table describes resources according to how they are used and where to find additional information.
Table 3-1 Resources according to purpose of use

Use
Managing user accounts Managing nodes
Resource name
APIAccount
Description
Manage the API administrator account. Manage cluster and node information. Manage network interface information. Manage routing information. Control services and OSs.
Reference
APIAccount on page 3-4 ProcessingNo de on page 3-156 NetworkInterf aces on page 3-117 Routings on page 3-164 SystemContro ller on page 3-170 FCPaths on page 3-46 Hardware on page 3-80 LUs on page 3-98 Disk on page 3-44 FileSystems on page 3-49 CIFSShares on page 3-7 NFSShares on page 3-131 HCP on page 3-93 MigrationTask on page 3-103
ProcessingNode
Managing networks
NetworkInterfaces
Routings Controlling services SystemController
Acquiring statuses
FCPaths Hardware
Acquire the FC path status. Acquire the hardware status. Acquire the LU status. Acquire the total capacity and unused capacity of a user disk. Manage file system information. Manage CIFS share information. Manage NFS share information. Manage HCP information. Manage data migration to HCP.
Managing file systems
LUs Disk
FileSystems
Managing shares
CIFSShares
NFSShares Configuring HCP linkage HCP MigrationTask
3-3
APIAccount
APIAccount resource overview
You can use the APIAccount resource to change the passwords of API administrator accounts and acquire information. The following table describes the HTTP methods that can be used for the APIAccount resource.
Table 3-2 HTTP methods that can be used for the APIAccount resource
Resource URI
/APIAccount
HTTP method
GET POST
Supported configurations
Cluster, single node Cluster, single node
Description
Acquires API administrator account information. Changes the password of the API administrator account.
APIAccount resource
This 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 information from a database. The following table describes the structure of the response XML output when the method ends.
Table 3-3 Structure of the response XML when a GET method request is sent to the APIAccount resource
Properties
APIAccount -userName password 1 1 1
Number of response XMLs output
Cluster, single node Cluster, single node Cluster, single node
Displayed value when verbose is false

Y Y Y#
Legend: Y: Displayed. #: The password is displayed as spaces. The following table describes the properties displayed when a GET method request is sent to the APIAccount resource.
3-4
Table 3-4 Properties displayed when a GET method request is sent to the APIAccount resource
Properties
APIAccount -userName password -Displays the user name of the API administrator account (admin). A null string is always displayed.
Description
The following shows an example of acquiring API administrator account information by sending a GET method request to the APIAccount resource.
URI of the resource to which a request is sent

https://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 the APIAccount resource
Status code
200 Other codes
Description
Execution of the method ended successfully. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally 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-node configuration, the API administrator account is the same as the account to log in to the GUI. If you have not changed the password for the GUI login account, the initial password for admin is chang3me!. To prevent unauthorized access, make sure that you change the password. Important: You need the set password for operating and managing HDI. Do not forget 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 POST method request to both nodes.
3-5
The following table describes the XML structure when a POST method request is sent to the APIAccount resource.
Table 3-6 XML structure when the POST method is used to send a request to the APIAccount resource
Properties
APIAccount -userName password -String String
Data type
Number of items that can be specified

1 1 1
The following table describes the properties to be specified when sending a POST method request to the APIAccount resource.
Table 3-7 Properties used to send a POST method request to the APIAccount resource
Properties
APIAccount -userName password -Sets the user name of the API administrator. Only admin can be specified. Sets the password of the API administrator. You can use alphanumeric characters, exclamation marks (!), hash marks (#), dollar signs ($), 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.
Description
Specification
-Required Required
The following shows an example of changing the password of the API administrator account by sending a POST method request to the APIAccount resource.

https://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
Table 3-8 Status codes returned when a POST method request is sent to the APIAccount resource
Status code
200 400 500 Other codes
Description
Execution of the method ended successfully. Execution of the method failed. An SQL exception or a database connection error occurred. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
CIFSShares
CIFSShares resource overview
You can use the CIFSShares resource to manage CIFS shares. The following table describes the HTTP methods that can be used for the CIFSShares resource.
Table 3-9 HTTP methods that can be used for the CIFSShares resource
Resource URI
/CIFSShares
HTTP method
GET PUT
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
Description
Acquires all information about CIFS shares. Adds a CIFS share. Acquires information about the specified CIFS share. Changes information about the specified CIFS share. Deletes the specified CIFS share. Checks whether the specified CIFS share exists.
/CIFSShares/ CIFS-sharename#1
GET#2 POST#2 DELETE#2 HEAD#2
#1: For CIFS-share-name, specify the name of the directory at the lowest level of the shared directory. #2: Specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. You must use Base64 to encode the path name.
CIFSShares resource
This section describes how to use the CIFSShares resource.
3-7
Acquiring information about all CIFS shares by using the GET method
The following table describes the structure of the response XML output when the method ends.
Table 3-10 Structure of the response XML when a GET method request is sent to the CIFSShares resource
Properties
CIFSShares -CIFSShare -exportPoint cifsShareName isAclEnabled restrictionTarget Hosts isAccessRestricti onAllowed

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

Y Y Y Y Y Y Y Y Y Y Y Y Y Y
commentForShar 1 e isReadOnly isBrowseEnabled fileAccessPermis sionOfOwner fileAccessPermis sionOfGroup fileAccessPermis sionOfOther directoryAccessP ermissionOfOwn er directoryAccessP ermissionOfGrou p directoryAccessP ermissionOfOthe r 1 1 1 1 1 1
guestAccessPerm 1 ission diskSynchronizat ionPolicy 1
Y Y
3-8
Properties
cifsClientCacheS etting fileTimestampCh angeableUsers isHomeDirectory Enabled aclType clientAccessPolic y vssUse cifsClientRoCach eOptimize accessBasedEnu meration

1 1 1 1 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y Y Y N Y Y Y Y Y Y Y Y
writeDisallowedU 1 sers writeDisallowedG 1 roups writeAllowedUser 1 s writeAllowedGro ups 1
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the CIFSShares resource.
Table 3-11 Properties displayed when a GET method request is sent to the CIFSShares resource
Properties
CIFSShares -CIFSShare -exportPoint cifsShareName isAclEnabled --Displays the path name of the shared directory. Displays the CIFS share name. Displays whether an ACL is used. true An ACL is used. false An ACL is not used. restrictionTargetHosts Displays the host for which access restriction is set.
Description
3-9
Properties
isAccessRestrictionAllowe d
Description
Displays whether access restriction is set. true Displayed when access restriction is set. false Displayed when access restriction is not set.
commentForShare isReadOnly
Displays the CIFS share comment. Displays the access privilege for the CIFS share. true Read-only is set. false Read-only is not set.
isBrowseEnabled
Displays whether to display the CIFS share name in the list on the client computer. true The share name is displayed. false The share name is not displayed.
fileAccessPermissionOfO wner
Displays the access privileges the owner has for a file. rw Read and write are permitted. ro Only read is permitted.
none Neither read nor write are permitted. Unknown The ACL type could not be acquired. fileAccessPermissionOfGr oup Displays the access privileges a group has for a file. For details about displayed values, see fileAccessPermissionOfOwner. Displays the access privileges others have for a file. For details about displayed values, see fileAccessPermissionOfOwner. Displays the access privileges the owner has for a directory. For details about displayed values, see fileAccessPermissionOfOwner. Displays the access privileges a group has for a directory. For details about displayed values, see fileAccessPermissionOfOwner. Displays the access privileges others have for a directory.
fileAccessPermissionOfOt her
directoryAccessPermissio nOfOwner
directoryAccessPermissio nOfGroup
directoryAccessPermissio nOfOther
3-10
Properties
Description
For details about displayed values, see fileAccessPermissionOfOwner.
guestAccessPermission
Displays whether to allow access from the guest account. allow Access from the guest account is allowed. disallow Access from the guest account is denied. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used.
diskSynchronizationPolicy Displays the behavior for a write or close request from a client. write_and_close Data is written synchronously with a write request or a close request issued from a client to a CIFS share. close Data is written synchronously with a close request issued from a client to a CIFS share. none Data is written at a fixed interval. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. cifsClientCacheSetting Displays whether to cache updated data for files in the CIFS share on a client. use Data for read-only access is cached. do_not_use Data for read-only access is not cached. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. fileTimestampChangeable Displays the users who can update the time Users stamps of files in the CIFS share. write_permitted_users Timestamp updating is permitted for all users who are permitted to write to the file.
3-11
Properties
Description
owner_only Timestamp file updating is limited to the file owner only. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used.
isHomeDirectoryEnabled
Displays whether to enable automatic creation of the home directory of the CIFS share. true Automatic creation of the home directory is enabled. false Automatic creation of the home directory is disabled.
aclType
Displays the ACL type for the file system. Advanced ACL The ACL type is Advanced ACL. Classic ACL The ACL type is Classic ACL. Unknown The ACL type could not be acquired.
clientAccessPolicy
Displays the method for processing the accesses from a CIFS client. parallel Accesses are handled in parallel. serial Accesses are handled serially. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used.
vssUse
Displays whether to use the Volume Shadow Copy Service to publish a Sync Image differential-data snapshot to a CIFS client. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. do_not_use Displayed when a Sync Image differential-data snapshot is not published to a CIFS client.
cifsClientRoCacheOptimiz e
Displays whether to use a read-only client cache when accesses to a file from multiple CIFS clients conflict.
3-12
Properties
use
Description
A read-only client cache is used.
do_not_use A read-only client cache is not used. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. accessBasedEnumeration Displays whether to enable access-based enumeration. use Access-based enumeration is enabled. do_not_use Access-based enumeration is disabled. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. writeDisallowedUsers writeDisallowedGroups writeAllowedUsers writeAllowedGroups Displays the users who are denied write permission for the CIFS share. Displays the groups who are denied write permission for the CIFS share. Displays the users who are allowed write permission for the CIFS share. Displays the groups who are allowed write permission for the CIFS share.
The following shows an example of acquiring all CIFS share information by sending a GET method request to the CIFSShares resource.

https://host-name-or-IP-address:9090/mapi/CIFSShares

<?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>
3-13
<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>
Table 3-12 Status codes returned when a GET method request is sent to the CIFSShares resource
Status code
200 Other codes
Description
Adding a CIFS share by using the PUT method

The following table describes the XML structure when a PUT method request is sent to the CIFSShares resource.
Table 3-13 XML structure when the PUT method is used to send a request to the CIFSShares resource
Properties
CIFSShare -exportPoint cifsShareName
Data type
-String String

1 1 1
Cluster, single node Cluster, single node Cluster,
3-14
Properties
Data type

1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1
single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
isClassicAcl isAclEnabled restrictionTargetHosts isAccessRestrictionAllowed commentForShare isReadOnly isBrowseEnabled fileAccessPermissionOfOwner fileAccessPermissionOfGroup fileAccessPermissionOfOther directoryAccessPermissionOf Owner directoryAccessPermissionOf Group directoryAccessPermissionOf Other guestAccessPermission diskSynchronizationPolicy cifsClientCacheSetting fileTimestampChangeableUse rs isHomeDirectoryEnabled clientAccessPolicy vssUse cifsClientRoCacheOptimize accessBasedEnumeration writeDisallowedUsers
Boolean Boolean String Boolean String Boolean Boolean String String String String String String String String String String Boolean String String String String String
3-15
Properties
writeDisallowedGroups writeAllowedUsers writeAllowedGroups DirectorySetup -userName groupName isStickyBit ownerPermission groupPermission otherPermission DirectoryACLSettings -DirectoryACLSetting -userGroupAcce ss name accountType
Data type
String String String -String String Boolean String String String --String String String

0 or 1 0 or 1 0 or 1 0 or 1 1 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 to n 1 1 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
applicationDesti String nation inheritanceRan ge accessPermissi on String String
Legend: n: An integer of 2 or more. The following table describes the properties to be specified when sending a PUT method request to the CIFSShares resource.
Table 3-14 Properties used to send a PUT method request to the CIFSShares resource
Properties
CIFSShare --
Description
Specification
--
3-16
Properties
-exportPoint
Description
Specification
Required Sets the absolute path to the directory to which a file share will be added. You can specify 6 to 256 characters. Sets the CIFS share name. No more than 80 characters can be specified for a CIFS share name. Sets whether the Advanced ACL or Classic ACL type is used for operation. Specify this setting so that it matches the ACL type of the file system to which the shared directory belongs. true Specify this value when the file system is the Classic ACL type. false Specify this value when the file system is the Advanced ACL type. Required
cifsShareName
isClassicAcl
Required
isAclEnabled
Sets whether to use an ACL for the CIFS share. true# Specify this value to use an ACL. false Specify this value to not use an ACL.
Optional (Can be set if true is specified for the isClassicAcl property)
restrictionTargetHosts
Sets a host for which you restrict access to the CIFS share. When specifying multiple hosts, 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 range according to a netmask Specify a range in the following format: 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 File page of the GUI to add all the specified host names and IP addresses. If you omit this, all hosts or networks are selected as the target. If hosts or networks for which access is restricted are set in the CIFS Service Management page
Required if the isAccessRestr ictionAllowed property is set.
3-17
Properties
Description
of the GUI, the settings are applied to all the file shares.
Specification
isAccessRestrictionAllowe d
Sets whether to restrict access to the CIFS share by a host specified by the restrictionTargetHosts property. true Specify this value to restrict access. false# Specify this value to not restrict access. If hosts or networks for which access is restricted are set in the CIFS Service Management page of the GUI, the settings are applied to all the file shares.
Required if the restrictionTa rgetHosts property is set.
commentForShare
Sets a comment related to the CIFS Optional share. You can use alphanumeric characters, exclamation marks (!), hash marks (#), dollar signs ($), ampersands (&), single quotation marks ('), left parentheses ((), right parentheses ()), asterisks (*), plus signs (+), commas (,), hyphens (-), periods (.), forward slashes (/), colons (:), left angle brackets (<), right angle brackets (>), question marks (?), at marks (@), left square brackets ([), backslashes (\), right square brackets (]), carets (^), underscores (_), grave accent marks (`), left curly brackets ({), vertical bars (|), right curly brackets (}), and tildes (~). You can also specify a space, but a string cannot start or end with a space. Also, a string cannot end with a backslash (\). In addition, you can specify multi-byte characters. You can use up to 256 characters. If you omit this, a comment is not set for the CIFS share. Specify whether to set the CIFS share as read-only. true Specify this value to set the share as read-only. false# Specify this value to not set the share as read-only. Optional
isReadOnly
3-18
Properties
isBrowseEnabled
Description
Sets whether to list the names of the CIFS shares in a client environment. true# Specify this value to list the names. false Specify this value to not list the names.
Specification
Optional
fileAccessPermissionOfOw ner
Sets the access privileges the file owner has. rw# Specify this value to grant read and write permission. ro Specify this value to grant read permission only.
none Specify this value to grant neither read nor write permission. fileAccessPermissionOfGro Sets the access privileges a group up has for a file. If you omit this, ro is set. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
Required if the fileAccessPer missionOfGrou p or fileAccessPer missionOfOthe r property is set (This can be set when the isClassicAcl property is true). Required if the fileAccessPer missionOfOwne r or fileAccessPer missionOfOthe r property is set (This can be set when the isClassicAcl property is true). Required if the fileAccessPer missionOfOwne r or fileAccessPer missionOfGrou p property is set (This can be set when the isClassicAcl property is true). Required if the directoryAcce ssPermissionO fGroup or directoryAcce ssPermissionO
fileAccessPermissionOfOth Sets the access privileges others er have for a file. If you omit this, ro is set. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
directoryAccessPermission Sets the access privileges the owner OfOwner has for a directory. If you omit this, rw is set. For details about the access privileges you can set, see the
3-19
Properties
Description
fileAccessPermissionOfOwner property.
Specification
fOther property is set (This can be set when the isClassicAcl property is true). Required if the directoryAcce ssPermissionO fOwner or directoryAcce ssPermissionO fOther property is set (This can be set when the isClassicAcl property is true). Required if the directoryAcce ssPermissionO fOwner or directoryAcce ssPermissionO fGroup property is set (This can be set when the isClassicAcl property is true). Optional
directoryAccessPermission Sets the access privileges a group OfGroup has for a directory. If you omit this, ro is set. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
directoryAccessPermission Sets the access privileges others OfOther have for a directory. If you omit this, ro is set. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
guestAccessPermission
Sets whether to allow access from the guest account. allow Specify this value to allow access from the guest account. disallow Specify this value to deny access from the guest account. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
diskSynchronizationPolicy
Sets the behavior for a write or close request from a client. write_and_close Specify this to perform writing synchronously with a write request or a close request issued from a client to a CIFS share.
Optional
3-20
Properties
Description
close Specify this to perform writing synchronously with a close request issued from a client to a CIFS share. none Specify this to perform writing at a fixed interval. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Specification
cifsClientCacheSetting
Sets whether to cache updated data for files in the CIFS share on a client. use Specify this value to cache data for read-only access. do_not_use Specify this value to not cache data for read-only access. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional
fileTimestampChangeable Users
Sets the users who can update the time stamps of files in the CIFS share. write_permitted_users Specify this if you want to permit timestamp updating for all users who are permitted to write to the file. owner_only Specify this if you want to limit timestamp file updating to the file owner only. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional (Can be set if the isClassicAcl property is true)
isHomeDirectoryEnabled
Sets whether to enable automatic Optional creation of the home directory of the CIFS share. true
3-21
Properties
Description
Specify this value to enable automatic creation of the home directory of the CIFS share. false# Specify this value to disable automatic creation of the home directory of the CIFS share.
Specification
clientAccessPolicy
Sets the method for processing the accesses from a CIFS client. parallel Specify this to handle access in parallel. serial Specify this to handle access serially. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional
vssUse
Specifies whether to use the Volume Shadow Copy Service to publish a Sync Image differential-data snapshot to a CIFS client. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI. do_not_use Specify this if you do not want to publish a Sync Image differential-data snapshot to a CIFS client.
Optional
cifsClientRoCacheOptimiz e
Sets whether to use a read-only client cache when accesses to a file from multiple CIFS clients conflict. use Specify this if you want to use a read-only client cache. do_not_use Specify this if you do not want to use a read-only client cache. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional
3-22
Properties
accessBasedEnumeration
Description
Sets whether to enable accessbased enumeration. use Specify this to enable accessbased enumeration. do_not_use Specify this to disable accessbased enumeration. default# Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Specification
Optional
writeDisallowedUsers
Sets the users who are denied write permission for the CIFS share. To specify multiple users, separate them by using commas (,). If you omit this, no value is set. Sets the groups that are denied write permission for the CIFS share. To specify multiple groups, separate them by using commas (,). If you omit this, no value is set. Sets the users who are granted write permission for the CIFS share. To specify multiple users, separate them by using commas (,). If you omit this, no value is set. Sets the groups that are granted write permission for the CIFS share. To specify multiple groups, separate them by using commas (,). If you omit this, no value is set. Specify this if you want to create a directory to be used as a CIFS shared directory and set the attributes of the directory. To check the values set for this property, check if the created shared directory can be accessed from a client. Sets a user name or user ID of the owner for the directory to be created. For a user ID, specify an ID from 0 to 2147483147. Note that, for an ID other than 0, you cannot specify 0 at the beginning of the ID. Sets a group name or group ID for a shared directory.
Optional
writeDisallowedGroups
Optional
writeAllowedUsers
Optional
writeAllowedGroups
Optional
DirectorySetup
Optional
--
userName
Required if the DirectorySetu p property is set.
groupName
3-23
Properties
Description
For a group ID, specify an ID from 0 to 2147483147. Note that, for an ID other than 0, you cannot specify 0 at the beginning of the ID. If user mapping is used, you cannot specify a built-in group for a Windows domain.
Specification
isStickyBit
Sets whether to use the sticky bit. true Specify this value to use the sticky bit. false# Specify this value to not use the sticky bit.
Optional (Can be set when the DirectorySetu p property is set)
ownerPermission
Sets the access privileges the owner has for a shared directory. If you omit this, no access privileges are set for the ownerPermission property. However, if the isStickyBit, ownerPermission, groupPermission, and otherPermission properties are omitted, rw is set for the ownerPermission property. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property. Sets the access privileges a group has for a shared directory. If you omit this, no access privileges are set for the groupPermission property. However, if the isStickyBit, ownerPermission, groupPermission, and otherPermission properties are omitted, ro is set for the groupPermission property. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property. Sets the access privileges others have for a shared directory. If you omit this, no access privileges are set for the otherPermission property. However, if the isStickyBit, ownerPermission, groupPermission, and otherPermission properties are omitted, ro is set for the otherPermission property.
groupPermission
otherPermission
3-24
Properties
Description
For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
Specification
DirectoryACLSettings
Specify this if you want to set the ACL for a shared directory. To check the values set for this property, check if the created shared directory can be accessed from a client. --
Optional (Can be set if the isClassicAcl property is set to false) Required if the DirectoryACLS ettings property is set. Required if the DirectoryACLS etting property is set.
--
DirectoryACLSettin g
--
userGroupA ccess
Sets the access privileges for ACL users and groups. allow Specify this value to set the allow access privileges for the specified users and groups and to add the access privileges specified for the ACEs of the users and groups. If ACEs are already set, the access privileges are combined. If multiple ACEs are set for a user, the ACEs are combined into one ACE. replace Specify this value to set the allow access privileges for the specified users and groups and to replace the access privileges of the users and groups with the specified ACEs. deny Specify this value to set the deny access privileges for the specified users and groups and to replace the access privileges of the users and groups with the specified ACEs.
name
Sets an ACL user name or group name.
Required if the DirectoryACLS etting property is set. Required if the DirectoryACLS etting property is set.
accountTyp e
Sets the ACL account type. u Specify this value to set the access privileges for the users. g Specify this value to set the access privileges for the groups.
3-25
Properties
Description
Specification
Required if the DirectoryACLS etting property is set.
applicationD Sets the ACE scope. estination o Specify this value to apply to the directory only. a Specify this value to apply to the directory, subdirectories, and files. Specify this value to apply to the directory and subdirectories. Specify this value to apply to the directory and files. Specify this value to apply to the subdirectories and files. Specify this value to apply to the subdirectories only. Specify this value to apply to the files only.
inheritance Range
Sets the scope of ACE inheritance. o Specify this value for only the directories and files immediately under the directory to inherit ACEs. a Specify this value for all the directories and files under the directory to inherit ACEs.
accessPermi Sets ACL access privileges. ssion f Specify this value to set full control. s Specify this value to set the Traverse Folder / Execute File privilege. Specify this value to set privileges for acquiring a list of folders and reading data. Specify this value to set privileges for reading attributes.
3-26
Properties
Description
Specify this value to set privileges for reading extended attributes. w Specify this value to set privileges for creating files and writing data. Specify this value to set privileges for creating folders and adding data. Specify this value to set privileges for writing attributes. Specify this value to set privileges for writing extended attributes. Specify this value to set privileges for deleting subfolders and files. Specify this value to set privileges for deletion. Specify this value to set privileges for reading access permissions. Specify this value to set privileges for changing access permissions. Specify this value to set privileges for acquiring owner privileges.
Specification
#: This is the default value used when the property is omitted. The following shows an example of adding a CIFS share by sending a PUT method request to the CIFSShares resource.

https://host-name-or-IP-address:9090/mapi/CIFSShares

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <CIFSShare>
3-27
<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>
Table 3-15 Status codes returned when a PUT method request is sent to the CIFSShares resource
Status code
200 Other codes
Description
CIFSShares/CIFS-share-name resource
This section describes how to use the CIFSShares/CIFS-share-name resource.
3-28
Acquiring CIFS share information by using the GET method

You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. You must use Base64 to encode the path name specified for the query parameter SHARE-DIRECTORY-NAME and CIFS-share-name. The following table describes the structure of the response XML output when the method ends.
Table 3-16 Structure of the response XML when a GET method request is sent to the CIFSShares/CIFS-share-name resource
Properties
CIFSShare -exportPoint cifsShareName isAclEnabled restrictionTargetH osts 1 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
isAccessRestriction 1 Allowed commentForShare isReadOnly isBrowseEnabled fileAccessPermissi onOfOwner fileAccessPermissi onOfGroup fileAccessPermissi onOfOther directoryAccessPer missionOfOwner directoryAccessPer missionOfGroup directoryAccessPer missionOfOther 1 1 1 1 1 1 1 1 1
guestAccessPermis 1 sion diskSynchronizatio nPolicy 1
3-29
Properties
cifsClientCacheSet ting 1

Y Y Y N Y Y Y Y Y Y Y Y
fileTimestampChan 1 geableUsers isHomeDirectoryEn 1 abled aclType clientAccessPolicy vssUse cifsClientRoCache Optimize accessBasedEnum eration writeDisallowedUs ers writeDisallowedGr oups writeAllowedUsers writeAllowedGroup s 1 1 1 1 1 1 1 1 1
Legend: Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the CIFSShares/CIFS-share-name resource.
Table 3-17 Properties displayed when a GET method request is sent to the CIFSShares/CIFS-share-name resource
Properties
CIFSShare -exportPoint cifsShareName isAclEnabled -Displays the path name of the shared directory. Displays the CIFS share name. Displays whether an ACL is used. true An ACL is used. false An ACL is not used. restrictionTargetHosts Displays the host for which access restriction is set. isAccessRestrictionAll owed Displays whether access restriction is set. true Displayed when access restriction is set.
Description
3-30
Properties
Description
false Displayed when access restriction is not set.
commentForShare isReadOnly
Displays the CIFS share comment. Displays the access privilege for the CIFS share. true Read-only is set. false Read-only is not set.
isBrowseEnabled
Displays whether to display the CIFS share name in the list on the client computer. true The share name is displayed. false The share name is not displayed.
fileAccessPermissionO fOwner
Displays the access privileges the owner has for a file. rw Read and write are permitted. ro Only read is permitted.
none Neither read or write is permitted. fileAccessPermissionO fGroup fileAccessPermissionO fOther Displays the access privileges a group has for a file. For details about displayed values, see fileAccessPermissionOfOwner. Displays the access privileges others have for a file. For details about displayed values, see fileAccessPermissionOfOwner.
directoryAccessPermis Displays the access privileges the owner has for a sionOfOwner directory. For details about displayed values, see fileAccessPermissionOfOwner. directoryAccessPermis Displays the access privileges a group has for a sionOfGroup directory. For details about displayed values, see fileAccessPermissionOfOwner. directoryAccessPermis Displays the access privileges others have for a sionOfOther directory. For details about displayed values, see fileAccessPermissionOfOwner. guestAccessPermissio n Displays whether to allow access from the guest account. allow Access from the guest account is allowed. disallow Access from the guest account is denied. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used.
3-31
Properties
Description
diskSynchronizationPo Displays the behavior for a write or close request from licy a client. write_and_close Data is written synchronously with a write request or a close request issued from a client to a CIFS share. close Data is written synchronously with a close request issued from a client to a CIFS share. none Data is written at a fixed interval. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. cifsClientCacheSetting Displays whether to cache updated data for files in the CIFS share on a client. use Data for read-only access is cached. do_not_use Data for read-only access is not cached. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. fileTimestampChange ableUsers Displays the users who can update the time stamps of files in the CIFS share. write_permitted_users Timestamp updating is permitted for all users who are permitted to write to the file. owner_only Timestamp file updating is limited to the file owner only. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. isHomeDirectoryEnabl ed Displays whether to enable automatic creation of the home directory of the CIFS share. true Automatic creation of the home directory is enabled. false Automatic creation of the home directory is disabled. aclType Displays the ACL type for the file system. Advanced ACL The ACL type is Advanced ACL. Classic ACL The ACL type is Classic ACL.
3-32
Properties
Description
Unknown The ACL type could not be acquired.
clientAccessPolicy
Displays the method for processing the accesses from a CIFS client. parallel Accesses are handled in parallel. serial Accesses are handled serially. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used.
vssUse
Displays whether to use the Volume Shadow Copy Service to publish a Sync Image differential-data snapshot to a CIFS client. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. do_not_use Displayed when a Sync Image differential-data snapshot is not published to a CIFS client.
cifsClientRoCacheOpti mize
Displays whether to use a read-only client cache when accesses to a file from multiple CIFS clients conflict. use A read-only client cache is used. do_not_use A read-only client cache is not used. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used.
accessBasedEnumerat Displays whether to enable access-based enumeration. ion use Access-based enumeration is enabled. do_not_use Access-based enumeration is disabled. default The default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI are used. writeDisallowedUsers writeDisallowedGroup s writeAllowedUsers writeAllowedGroups Displays the users who are denied write permission for the CIFS share. Displays the groups who are denied write permission for the CIFS share. Displays the users who are allowed write permission for the CIFS share. Displays the groups who are allowed write permission for the CIFS share.
3-33
The following shows an example of acquiring CIFS share information by sending a GET method request to the CIFSShares/CIFS-share-name resource.

https://host-name-or-IP-address:9090/mapi/CIFSShares/CIFS-share-name

<?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>
Table 3-18 Status codes returned when a GET method request is sent to the CIFSShares/CIFS-share-name resource
Status code
200 Other codes
Description
3-34
Changing CIFS share information by using the POST method

You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. You must use Base64 to encode the path name specified for the query parameter SHARE-DIRECTORY-NAME and CIFS-share-name. The following table describes the XML structure when a POST method request is sent to the CIFSShares/CIFS-share-name resource.
Table 3-19 XML structure when the POST method is used to send a request to the CIFSShares/CIFS-share-name resource
Properties
CIFSShare -cifsShareName isClassicAcl isAclEnabled restrictionTargetH osts -String Boolean Boolean String
Data type

1 0 or 1 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1
isAccessRestriction Boolean Allowed commentForShare isReadOnly isBrowseEnabled fileAccessPermissi onOfOwner fileAccessPermissi onOfGroup fileAccessPermissi onOfOther directoryAccessPer missionOfOwner directoryAccessPer missionOfGroup directoryAccessPer missionOfOther String Boolean Boolean String String String String String String
guestAccessPermis String sion diskSynchronizatio nPolicy String
3-35
Properties
cifsClientCacheSet ting
Data type
String

0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
fileTimestampChan String geableUsers isHomeDirectoryEn Boolean abled clientAccessPolicy vssUse cifsClientRoCache Optimize accessBasedEnum eration writeDisallowedUs ers writeDisallowedGr oups writeAllowedUsers writeAllowedGroup s String String String String String String String String
The following table describes the properties to be specified when sending a POST method request to the CIFSShares/CIFS-share-name resource.
Table 3-20 Properties used to send a POST method request to the CIFSShares/CIFS-share-name resource
Properties
CIFSShare ---
Description
--
Specification
Optional Required
cifsShareName Sets the CIFS share name. You can use no more than 80 characters. isClassicAcl Sets whether the Advanced ACL or Classic ACL type is used for operation. Specify this setting so that it matches the ACL type of the file system to which the shared directory belongs. If true has been specified for this, you cannot specify false. true Specify this value when the file system is the Classic ACL type. false Specify this value when the file system is the Advanced ACL type.
3-36
Properties
isAclEnabled
Description
Sets whether to use an ACL for the CIFS share. true Specify this value to use an ACL. false Specify this value to not use an ACL.
Specification
Optional
restrictionTarg etHosts
Sets a host for which you restrict access to the CIFS share. When specifying multiple hosts, 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 range according to a netmask Specify a range in the following format: 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 File page of the GUI to add all the specified host names and IP addresses. If you omit this, all hosts or networks are selected as the target. If hosts or networks for which access is restricted are set in the CIFS Service Management page of the GUI, the settings are applied to all the file shares.
Required if the isAccessRestric tionAllowed property is set.
isAccessRestri ctionAllowed
Sets whether to restrict access to the CIFS share by a host specified by the restrictionTargetHosts property. true Specify this value to restrict access. false# Specify this value to not restrict access. If hosts or networks for which access is restricted are set in the CIFS Service Management page of the GUI, the settings are applied to all the file shares.
Required if the restrictionTarg etHosts property is set.
commentForS hare
Sets a comment related to the CIFS share. Optional You can use alphanumeric characters, exclamation marks (!), hash marks (#), dollar signs ($), ampersands (&), single quotation marks ('), left parentheses ((), right parentheses ()), asterisks (*), plus signs (+), commas (,), hyphens (-), periods (.), forward slashes (/), colons (:), left angle brackets (<), right angle brackets (>), question marks (?), at marks (@), left square brackets ([), backslashes (\), right
3-37
Properties
Description
square brackets (]), carets (^), underscores (_), grave accent marks (`), left curly brackets ({), vertical bars (|), right curly brackets (}), and tildes (~). You can also specify a space, but a string cannot start or end with a space. Also, a string cannot end with a backslash (\). In addition, you can specify multi-byte characters. You can use up to 256 characters.
Specification
isReadOnly
Sets whether to set the CIFS share as read-only. true Specify this value to set the share as read-only. false Specify this value to not set the share as read-only.
Optional
isBrowseEnabl ed
Sets whether to list the names of the CIFS shares in a client environment. true Specify this value to list the names. false Specify this value to not list the names.
Optional
fileAccessPerm Sets the access privileges the file owner issionOfOwner has. rw Specify this value to grant read and write permissions. ro Specify this value to grant read permission only.
none Specify this value to grant neither read nor write permission. fileAccessPerm Sets the access privileges a group has for a issionOfGroup file. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
Required if the fileAccessPermi ssionOfGroup or fileAccessPermi ssionOfOther property is set (This can be set when the isClassicAcl property is true).
Required if the fileAccessPermi ssionOfOwner or fileAccessPermi ssionOfOther property is set (This can be set when the isClassicAcl property is true). Required if the fileAccessPermi ssionOfOwner or fileAccessPermi ssionOfGroup property is set (This can be set
fileAccessPerm Sets the access privileges others have for a issionOfOther file. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
3-38
Properties
Description
Specification
when the isClassicAcl property is true).
directoryAcces sPermissionOf Owner
Sets the access privileges the owner has for a directory. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
Required if the directoryAccess PermissionOfGro up or directoryAccess PermissionOfOth er property is set (This can be set when the isClassicAcl property is true). Required if the directoryAccess PermissionOfOwn er or directoryAccess PermissionOfOth er property is set (This can be set when the isClassicAcl property is true). Required if the directoryAccess PermissionOfOwn er or directoryAccess PermissionOfGro up property is set (This can be set when the isClassicAcl property is true). Optional
directoryAcces sPermissionOf Group
Sets the access privileges a group has for a directory. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
directoryAcces sPermissionOf Other
Sets the access privileges others have for a directory. For details about the access privileges you can set, see the fileAccessPermissionOfOwner property.
guestAccessPe rmission
Sets whether to allow access from the guest account. allow Specify this value to allow access from the guest account. disallow Specify this value to deny access from the guest account. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
diskSynchroni zationPolicy
Sets the behavior for a write or close Optional request from a client. write_and_close Specify this to perform writing synchronously with a write request or a
3-39
Properties
Description
close request issued from a client to a CIFS share. close Specify this to perform writing synchronously with a close request issued from a client to a CIFS share. none Specify this to perform writing at a fixed interval. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Specification
cifsClientCach eSetting
Sets whether to cache updated data for files in the CIFS share on a client. use Specify this value to cache data for read-only access. do_not_use Specify this value to not cache data for read-only access. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional
fileTimestamp ChangeableUs ers
Sets the users who can update the time stamps of files in the CIFS share. write_permitted_users Specify this if you want to permit timestamp updating for all users who are permitted to write to the file. owner_only Specify this if you want to limit timestamp file updating to the file owner only. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional (can be set if the isClassicAcl property is true)
isHomeDirecto ryEnabled
Sets whether to enable automatic creation of the home directory of the CIFS share. true Specify this value to enable automatic creation of the home directory of the CIFS share. false
Optional
3-40
Properties
Description
Specify this value to disable automatic creation of the home directory of the CIFS share.
Specification
clientAccessPo licy
Sets the method for processing the accesses from a CIFS client. parallel Specify this to handle access in parallel. serial Specify this to handle access serially. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional
vssUse
Specifies whether to use the Volume Shadow Copy Service to publish a Sync Image differential-data snapshot to a CIFS client. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI. do_not_use Specify this if you do not want to publish a Sync Image differential-data snapshot to a CIFS client.
Optional
cifsClientRoCa cheOptimize
Sets whether to use a read-only client cache when access requests to a file from multiple CIFS clients conflict. use Specify this if you want to use a readonly client cache. do_not_use Specify this if you do not want to use a read-only client cache. default Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Optional
accessBasedE numeration
Sets whether to enable access-based enumeration. use Specify this to enable access-based enumeration. do_not_use Specify this to disable access-based enumeration. default
Optional
3-41
Properties
Description
Specify this to use the default settings of the CIFS service configuration definitions set in the CIFS Service Management page of the GUI.
Specification
writeDisallowe dUsers
Optional Sets the users who are denied write permission for the CIFS share. To specify multiple users, separate them by using commas (,). The set information is deleted if you omit settings or specify a null string for this property. However, the set information is not deleted if you also omit settings or specify a null string for the writeDisallowedGroups property. Sets the groups that are denied write permission for the CIFS share. To specify multiple groups, separate them by using commas (,). The set information is deleted if you omit settings or specify a null string for this property. However, the set information is not deleted if you also omit settings or specify a null string for the writeDisallowedUsers property. Optional
writeDisallowe dGroups
writeAllowedU sers
Sets the users who are granted write Optional permission for the CIFS share. To specify multiple users, separate them by using commas (,). The set information is deleted if you omit settings or specify a null string for this property. However, the set information is not deleted if you also omit settings or specify a null string for the writeAllowedGroups property. Sets the groups that are granted write permission for the CIFS share. To specify multiple groups, separate them by using commas (,). The set information is deleted if you omit settings or specify a null string for this property. However, the set information is not deleted if you also omit settings or specify a null string for the writeAllowedUsers property. Optional
writeAllowedG roups
The following shows an example of changing CIFS share information by sending a POST method request to the CIFSShares/CIFS-share-name resource.

https://host-name-or-IP-address:9090/mapi/CIFSShares/CIFS-share-name
3-42

<?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>
Table 3-21 Status codes returned when a POST method request is sent to the CIFSShares/CIFS-share-name resource
Status code
200 Other codes
Description
Deleting the specified CIFS share by using the DELETE method

You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. You must use Base64 to encode the path name specified for the query parameter SHARE-DIRECTORY-NAME and CIFS-share-name. 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 sent to the CIFSShares/CIFS-share-name resource
Status code
200
Description
Execution of the method ended successfully.
3-43
Status code
Other codes
Description
Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
Checking whether the specified CIFS share exists by using the HEAD method
You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. You must use Base64 to encode the path name specified for the query parameter SHARE-DIRECTORY-NAME and CIFS-share-name. The following table describes the status codes output when the method ends.
Table 3-23 Status codes returned when a HEAD method request is sent to the CIFSShares/CIFS-share-name resource
Status code
200 Other codes
Description
The specified CIFS share can be used. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
Disk
Disk resource overview
You can use the Disk resource to acquire the total capacity and unused capacity of a user disk in a single-node configuration. The following table describes the HTTP method that can be used for the Disk resource.
Table 3-24 HTTP method that can be used for the Disk resource
Resource URI
/Disk
HTTP method
GET
Single node
Description
Acquires information about the total capacity and unused capacity of a user disk.
Disk resource
This section describes how to use the Disk resource.
3-44
Acquiring information specified about the disk by using the GET method
Table 3-25 Structure of the response XML when a GET method request is sent to the Disk resource
Properties
Disk -totalDiskSize freeDiskSize 1 1 1
Single node Single node Single node

Y Y Y
Legend: Y: Displayed. The following table describes the properties displayed when a GET method request is sent to the Disk resource.
Table 3-26 Properties displayed when a GET method request is sent to the Disk resource
Properties
Disk -totalDiskSize freeDiskSize -Displays the total capacity of the user disk in gigabytes. Displays the unused capacity on the user disk in gigabytes.
Description
The following shows an example of acquiring the total capacity and unused capacity of a user disk by sending a GET method request to the Disk resource.

https://host-name-or-IP-address:9090/mapi/Disk

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Disk> <totalDiskSize>374</totalDiskSize> <freeDiskSize>321</freeDiskSize> </Disk>
Table 3-27 Status codes returned when a GET method request is sent to the Disk resource
Status code
200
Description
Execution of the method ended successfully.
3-45
Status code
404 Other codes
Description
There is no user disk. The Disk resource might be in use in a cluster configuration. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
FCPaths
FCPaths resource overview
In a cluster configuration, you can use the FCPaths resource to acquire FC path information. The following table describes the HTTP method that can be used for the FCPaths resource.
Table 3-28 HTTP method that can be used for the FCPaths resource
Resource URI
/FCPaths
HTTP method
GET
Cluster
Description
Acquires FC path information.
FCPaths resource
This section describes how to use the FCPaths resource. The following table describes the structure of the response XML output when the method ends.
Table 3-29 Structure of the response XML when a GET method request is sent to the FCPaths resource
Properties
FCPaths -FCPath -path target hostPort hostPortWWN arrayPort arrayPortWWN model

1 0 or 1 to n 1 1 1 1 1 1 1
Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster

Y Y Y Y Y Y Y Y Y
3-46
Properties
serial status

1 1
Cluster Cluster

Y Y
Legend: n: An integer of 2 or more, Y: Displayed. The following table describes the properties displayed when a GET method request is sent to the FCPaths resource.
Table 3-30 Properties displayed when a GET method request is sent to the FCPaths resource
Properties
FCPaths -FCPath -path --Displays the FC path. A null string is displayed if the target cannot be identified. Displays the target. A null string is displayed if the target cannot be identified. Displays the name of the FC port on the node (host port). A null string is displayed if the FC port cannot be identified. Displays the WWN of the FC port on the node. Displays the name of the FC port on the storage subsystem (array port). Displays the WWN of the FC port on the storage subsystem. A null string is displayed if the FC port cannot be identified. Displays the storage subsystem model. AMS Hitachi AMS2000 series or Hitachi AMS1500 USP_V Universal Storage Platform V USP_VM Universal Storage Platform VM VSP Virtual Storage Platform A null string is displayed in the following cases: The storage subsystem does not contain LUs being used in the HDI system. Storage subsystem information has not been acquired because a failure occurred on the FC
Description
target
hostPort
hostPortWWN arrayPort arrayPortWWN
model
3-47
Properties
Description
path during startup of the OS on the node, or for some other reason.
serial
Displays the serial number of the storage subsystem. A null string is displayed if the serial number cannot be identified. Displays the status of the FC path. Online The FC path is working normally. If a device file error is detected, Online (LU Error) is displayed. Offline The system administrator has placed the FC path in the offline status. If a device file error is detected, Offline (LU Error) is displayed. Error This is displayed when any of the following conditions are satisfied: - An error has occurred on the FC path. - None of the device files belonging to the target FC path are accessible. - No LUs has been assigned to a host group associated with the FC path. Partially Online The FC path is working normally but some device files are inaccessible. If a device file error is detected, Partially Online (LU Error) is displayed. Configuration Mismatch The assignment of LUs to host groups associated with the FC path differs from the assignment of LUs for the alternate path, or there is no alternate path. Unknown The FC port on the node (host port) or the FC port on the storage subsystem (array port) cannot be identified.
status
The following shows an example of acquiring FC path information by sending a GET method request to the FCPaths resource.

https://host-name-or-IP-address:9090/mapi/FCPaths

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FCPaths> <FCPath> <path>path000-0004-1E</path> <target>N1-T000</target>
3-48
<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>
Table 3-31 Status codes returned when a GET method request is sent to the FCPaths resource
Status code
200 Other codes
Description
FileSystems
FileSystems resource overview
You can use the FileSystems resource to acquire file system information or to create a file system. You can also delete a file system, and check whether a file system exists. The following table describes the HTTP methods that can be used for the FileSystems resource.
Table 3-32 HTTP methods that can be used for the FileSystems resource
Resource URI
/FileSystems
HTTP method
GET PUT
Description
Acquires file system information. Creates a file system.
3-49
Resource URI
/FileSystems/ file-systemname
HTTP method
GET POST DELETE HEAD
Description
Acquires information about the specified file system. Edits information about the specified file system. Deletes the specified file system. Checks whether the specified file system exists. Acquires information about the mount settings of the specified file system. Edits information about the mount settings of the specified file system.
/FileSystems/ file-systemname/ MountSetting
GET
POST
FileSystems resource
This 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 is sent to the FileSystems resource
Properties
FileSystems -FileSystem -fileSystemName usage deviceStatus

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

Y Y Y N N N N N
freeBlocksInMegaByt 1 es usedBlocksInMegaBy 1 tes totalBlocksInMegaBy tes 1
3-50
Properties
isLvmEnabled

For cluster configuration s: 1 For singlenode configuration s: 0
Cluster

Y
fileSystemSizeInGiga 1 Byte isLvmStripingEnable d For cluster configuration s: 1 For singlenode configuration s: 0 For cluster configuration s: 1 For singlenode configuration s: 0 For cluster configuration s: 1 For singlenode configuration s: 0
Cluster, single node Cluster
Single Y
stripes
Cluster
stripeSize
Cluster
aclType WormSetting -maxRetention minRetention isAutoCommit Enabled
1 1 1 1 1
Y Y Y Y Y Y Y N
autoCommitPe 1 riod defaultRetenti on isWormDelete Enabled 1 1
3-51
Properties

N N N N N N
longestRetenti 1 on MountSetting -isMounted mountStatus isReadOnly 1 1 1 1
isFileLastAcce 1 ssTimeRecordi ngEnabled LUs For cluster configuration s: 1 For singlenode configuration s: 0 For cluster configuration s: 1 to n For singlenode configuration s: 0 For cluster configuration s: 1 For singlenode configuration s: 0
Cluster
--
LU
Cluster
--
deviceFi leName
Cluster
Legend: n: An integer of 2 or more, Y: Displayed, Single: Displayed only in single-node configurations, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the FileSystems resource.
Table 3-34 Properties displayed when a GET method request is sent to the FileSystems resource
Properties
FileSystems --
Description
3-52
Properties
-FileSystem -fileSystemName usage --
Description
The file system name is displayed. The file system usage is displayed. None The file system is not being used by other functions. Sync Image The file system is in use by a Sync Image function. WORM The file system is a WORM file system. If several of the above items apply to the file system usage, the items are all displayed and separated by commas (,).
deviceStatus
Displays the status of a device file that make up the file system. Normal The status is normal. Error A failure has been detected while accessing the device file. A null string is displayed in a single-node configuration.
freeBlocksInMegaByte s
When the file system is correctly mounted, and the unused block capacity is displayed in MB. A null string is displayed if the file system is not correctly mounted.
usedBlocksInMegaByte When the file system is correctly mounted, and s the used block capacity is displayed in MB. A null string is displayed if the file system is not correctly mounted. totalBlocksInMegaByte When the file system is correctly mounted, and s the total block capacity is displayed in MB. A null string is displayed if the file system is not correctly mounted. isLvmEnabled Displays whether a volume manager is used for the file system. true A volume manager is used. false A volume manager is not used. This item is not displayed in a single-node configuration. fileSystemSizeInGigaB yte Displays the file system capacity (total device file capacity) in GB. For a differential-data snapshot of Sync Image, a null string is displayed. The total file system capacity that was specified when the file system is created or expanded is displayed in a single-node configuration. Displays whether the file system is striped.
isLvmStripingEnabled
3-53
Properties
true
Description
The file system is striped.
false The file system is not striped. This item is not displayed in a single-node configuration. stripes Displays the number of stripes if file system is striped. A null string is displayed if the file system is not striped. This item is not displayed in a single-node configuration. Displays the stripe size in KB if the file system is striped. A null string is displayed if the file system is not striped. This item is not displayed in a single-node configuration. Displays the ACL type of the file system. Classic ACL The ACL type is Classic ACL. Advanced ACL The ACL type is Advanced ACL. Unknown The ACL type could not be acquired. WormSetting# -maxRetention -Displays the maximum retention period for a WORM file system in the following format:
day-hour-minute
stripeSize
aclType
infinite is displayed if an indefinite time period is set for the maximum retention period. A null string is displayed for a non-WORM file system. minRetention Displays the minimum retention period for a WORM file system in the following format:
day-hour-minute
infinite is displayed if an indefinite time period is set for the minimum retention period. A null string is displayed for a non-WORM file system. isAutoCommitE nabled Displays whether to use auto commit for a WORM file system. true Auto commit is set. false Auto commit is not set. A null string is displayed for a non-WORM file system. autoCommitPer iod Displays the time from the last access date of a read-only file until the file is committed as a WORM file if auto commit is enabled for a WORM file system, in the following format:
day-hour-minute
3-54
Properties
Description
A null string is displayed if the file system is a non-WORM file system or auto commit is disabled.
defaultRetentio n
Displays the retention period for an autocommitted file in a WORM file system in the following format: infinite is displayed if an indefinite time period is set for the default retention period. A null string is displayed if the file system is a non-WORM file system or auto commit is disabled.
day-hour-minute
isWormDeleteE nabled
Displays whether a WORM file system can be deleted. true A WORM file system can be deleted. false A WORM file system cannot be deleted.
longestRetentio n
Displays the longest retention period for a file in a 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 -isMounted
-Displays whether the file system is mounted. true The file system is mounted. false The file system is not mounted.
mountStatus
Displays the mount status of the file system. Normal The file system is mounted correctly. Fatal error The file system is blocked. Overflow The differential-data storage device of Sync Image has run out of space. Not available A failure occurred in the differential-data storage device of Sync Image. Blocked The file system is blocked because the differential-data storage device of Sync Image has run out of space. Blocked and Ready The file system was blocked due to there not being enough free space on the Sync Image differential-data storage device, after which free space was allocated to the differential-
3-55
Properties
Description
data storage device, and the OS on the node has not been restarted. Expanding The file system is being expanded or an error occurred during expansion processing. Reclaiming The unused area of the virtual LUs that are used for the file system is being released. A null string is displayed if the file system is not mounted.
isReadOnly
Displays whether the file system is mounted as read-only. true The file system is mounted as read-only. false The file system is mounted with both read and write operations permitted. A null string is displayed if the file system is not mounted.
isFileLastAccess Displays whether to update the time that the file TimeRecording system was last accessed. Enabled true The last access time is updated. false The last access time is not updated. A null string is displayed if the file system is not mounted. LUs -LU ---deviceFil Displays the names of the device files that are eName used 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 LU name.
#: The value is not displayed if the file system is not mounted. The following shows an example of acquiring file system information by sending a GET method request to the FileSystems resource.

https://host-name-or-IP-address:9090/mapi/FileSystems

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FileSystems> <FileSystem> <fileSystemName>test02</fileSystemName> <isLvmEnabled>true</isLvmEnabled> <isLvmStripingEnabled>false</isLvmStripingEnabled> <stripeSize></stripeSize>
3-56
<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>
Table 3-35 Status codes returned when a GET method request is sent to the FileSystems resource
Status code
200 Other codes
Description
Creating a file system by using the PUT method

The following table describes the XML structure when a PUT method request is sent to the FileSystems resource.
Table 3-36 XML structure when the PUT method is used to send a request to the FileSystems resource
Properties
FileSystem -fileSystemName isLvmEnabled
Data type
-String Boolean 1 1
For cluster configurations: 0 or 1 For single-node configurations: 0 For cluster configurations: 0 For single-node configurations: 1
Cluster
fileSystemSizeInGigaB yte Double
Single node
3-57
Properties
Data type
Boolean

For cluster configurations: 0 or 1 For single-node configurations: 0 For cluster configurations: 0 or 1 For single-node configurations: 0
Cluster
stripeSize Integer
Cluster
aclType WormSetting -maxRetention minRetention isAutoCommitE nabled autoCommitPer iod defaultRetentio n LUs String -String String Boolean String String --
0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 to n For single-node configurations: 0 For cluster configurations: 1 For single-node configurations: 0
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster
--
LU
--
Cluster
-deviceFil String eName
Cluster
Legend: n: An integer of 2 or more. The following table describes the properties to be specified when sending a PUT method request to the FileSystems resource.
3-58
Table 3-37 Properties used to send a PUT method request to the FileSystems resource
Properties
FileSystem -fileSystemName -Sets the file system name. You can specify a maximum of 16 characters consisting of alphanumeric characters and underscores (_). Sets whether to use the volume manager. If false is specified for this item, you cannot expand the capacity after the creation of the file system. Also you cannot specify the isLvmStripingEnabled property and stripeSize property. If you create the file system from multiple device files, specify true. true# Specify this value to use a volume manager. false Specify this value to not use a volume manager. fileSystemSizeInGigaBy Sets the file system capacity in Required te gigabytes. This can be set only for single-node configurations. isLvmStripingEnabled Sets whether to build the file system as a striped file system. true Specify this value to create a striped file system. false# Specify this value to not create a striped file system. stripeSize Sets the stripe size in kilobytes. Specify one of the following values: 8 16 32 64# 128 Optional (Can be set if the isLvmStripingEnable d property is true). Optional
Description
--
Specification
Required
isLvmEnabled
Optional
3-59
Properties
aclType 256 512
Description
Specification
1024 Optional
Sets the ACL of the file system. Classic ACL# Specify this value to build a Classic ACL file system. Advanced ACL Specify this value to build an Advanced ACL file system.
WormSetting -maxRetention
--
Optional
Optional (Can be set if Sets the maximum retention period for a WORM file system. the WormSetting Specify infinite or a value in property is specified) the following format:
day-hour-minute
You can specify the following values for each item: day: 0 to 36500 hour: 0 to 876000
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. An indefinite time period is set for the maximum retention period if you specify infinite. If you omit this, 10950-0-0 is set. minRetention Sets the minimum retention Optional (Can be set if period for a WORM file system. the WormSetting Specify infinite or a value in property is specified) the following format:
day-hour-minute
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. An indefinite time period is set for the minimum retention period if you specify infinite. If you omit this, 0-0-0 is set. isAutoCommitEn Set true when auto commit abled for a WORM file system is used. You cannot change the setting from true to false. Optional (Can be set if the WormSetting property is specified)
3-60
Properties
autoCommitPeri od
Description
If you omit this, false is set. Sets the auto-commit period for a WORM file system. Specify a value in the following format: You can specify the following values for each item: day: 0 to 36500 hour: 0 to 876000
day-hour-minute
Specification
Optional This can be set if all of the following conditions are satisfied: The WormSetting property is set. The isAutoCommitEnab led property is set to true.
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. If you omit this, 0-0-15 is set. defaultRetention Sets the default retention period for an auto-committed file. Specify infinite or a value in the following format:
day-hour-minute
Optional This can be set if all of the following conditions are satisfied: The WormSetting property is set. The isAutoCommitEnab led property is set to true.
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. An indefinite time period is set for the default retention period if you specify infinite. If you omit this, 10950-0-0 is set. Note that, if the minRetention property is set to infinite, infinite is set. LUs -LU -deviceFil eName --Sets the device file name. This can be set only for cluster configurations. If you specify true for the isLvmEnabled property, the capacity of each selected device file must be 65 MB or more. Also the total capacity of the device files must be 130 MB or more. If you want to create a file system in a striping configuration, select 2 to 128 device files that have the same capacity. The number of the selected LUs is the number of stripes. In --Required
3-61
Properties
Description
addition, striping will be performed in the order the device files are specified.
Specification
#: This is the default value used when the property is omitted. The following shows an example of creating a file system by sending a PUT method request to the FileSystems resource.

https://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>
3-62
Table 3-38 Status codes returned when a PUT method request is sent to the FileSystems resource
Status code
200 Other codes
Description
FileSystems/file-system-name resource
This section describes how to use the FileSystems/file-system-name resource.
Acquiring the specified file system information by using the GET method
Table 3-39 Structure of the response XML when a GET method request is sent to the FileSystems/file-system-name resource
Properties
FileSystem -fileSystemName -usage deviceStatus

1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y Y N N N N N N
freeBlocksInMegaByt 1 es usedBlocksInMegaBy 1 tes totalBlocksInMegaBy tes isLvmEnabled 1 For cluster configuration s: 1 For singlenode configuration s: 0
Cluster
fileSystemSizeInGiga 1 Byte
Cluster, Single node
3-63
Properties
isLvmStripingEnable d

For cluster configuration s: 1 For singlenode configuration s: 0 For cluster configuration s: 1 For singlenode configuration s: 0 For cluster configuration s: 1 For singlenode configuration s: 0
Cluster

N
stripes
Cluster
stripeSize
Cluster
aclType WormSetting -maxRetention minRetention isAutoCommit Enabled
1 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster,
Y Y Y Y Y Y Y Y N N N N N
autoCommitPe 1 riod defaultRetenti on isWormDelete Enabled 1 1
longestRetenti 1 on MountSetting -isMounted mountStatus isReadOnly 1 1 1 1
3-64
Properties
single node

N
isFileLastAcce 1 ssTimeRecordi ngEnabled LUs For cluster configuration s: 1 For singlenode configuration s: 0 For cluster configuration s: 1 to n For singlenode configuration s: 0 For cluster configuration s: 1 For singlenode configuration s: 0
Cluster, single node Cluster
--
LU
Cluster
--
deviceFi leName
Cluster
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the FileSystems/file-system-name resource.
Table 3-40 Properties displayed when a GET method request is sent to the FileSystems/file-system-name resource
Properties
FileSystem -fileSystemName -usage -The file system name is displayed. The file system usage is displayed. None The file system is not being used by other functions. Sync Image The file system is in use by a Sync Image function. WORM The file system is a WORM file system.
Description
3-65
Properties
Description
If several of the above items apply to the file system usage, the items are all displayed and separated by commas (,).
deviceStatus
Displays the status of a device file that make up the file system. Normal The status is normal. Error A failure has been detected while accessing the device file. A null string is displayed in a single-node configuration.
freeBlocksInMegaBytes
When the file system is correctly mounted, the unused block capacity is displayed in MB. A null string is displayed if the file system is not correctly mounted. When the file system is correctly mounted, the used block capacity is displayed in MB. A null string is displayed if the file system is not correctly mounted. When the file system is correctly mounted, the total block capacity is displayed in MB. A null string is displayed if the file system is not correctly mounted. Displays whether a volume manager is used for the file system. true A volume manager is used. false A volume manager is not used. This item is not displayed in a single-node configuration.
usedBlocksInMegaBytes
totalBlocksInMegaBytes
isLvmEnabled
fileSystemSizeInGigaByt e
Displays the file system capacity (total device file capacity) in GB. For a differential-data snapshot of Sync Image, a null string is displayed. The total file system capacity that was specified when the file system is created or expanded is displayed in a single-node configuration. Displays whether the file system is striped. true The file system is striped. false The file system is not striped. This item is not displayed in a single-node configuration.
stripes
Displays the number of stripes if the file system is striped. A null string is displayed if the file system is not striped. This item is not displayed in a single-node configuration.
3-66
Properties
stripeSize
Description
Displays the stripe size in KB if the file system is striped. A null string is displayed if the file system is not striped. This item is not displayed in a single-node configuration. Displays the ACL type of the file system. Classic ACL The ACL type is Classic ACL. Advanced ACL The ACL type is Advanced ACL. Unknown The ACL type could not be acquired.
aclType
WormSetting# -maxRetention
-Displays the maximum retention period for a WORM file system in the following format: infinite is displayed if an indefinite time period is set for the maximum retention period. A null string is displayed for a non-WORM file system.
day-hour-minute
minRetention
Displays the minimum retention period for a WORM file system in the following format: infinite is displayed if an indefinite time period is set for the minimum retention period. A null string is displayed for a non-WORM file system.
day-hour-minute
isAutoCommitEna bled
Displays whether to use auto commit for a WORM file system. true Auto commit is set. false Auto commit is not set. A null string is displayed for a non-WORM file system.
autoCommitPeriod Displays the time from the last access date of a read-only file until the file is committed as a WORM file if auto commit is enabled for a WORM file system, in the following format:
day-hour-minute
A null string is displayed if the file system is a non-WORM file system or auto commit is disabled. defaultRetention Displays the retention period for an autocommitted file in a WORM file system in the following format: infinite is displayed if an indefinite time period is set for the default retention period. A null string is displayed if the file system is a
day-hour-minute
3-67
Properties
Description
non-WORM file system or auto commit is disabled.
isWormDeleteEna bled
Displays whether a WORM file system can be deleted. true A WORM file system can be deleted. false A WORM file system cannot be deleted.
longestRetention
Displays the longest retention period for a file in a 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 -isMounted
-Displays whether the file system is mounted. true The file system is mounted. false The file system is not mounted.
mountStatus
Displays the mount status of the file system. Normal The file system is mounted correctly. Fatal error The file system is blocked. Overflow The differential-data storage device of Sync Image has run out of space. Not available A failure occurred in the differential-data storage device of Sync Image. Blocked The file system is blocked because the differential-data storage device of Sync Image has run out of space. Blocked and Ready The file system was blocked due to there not being enough free space on the Sync Image differential-data storage device, after which free space was allocated to the differential-data storage device, and the OS on the node has not been restarted. Expanding The file system is being expanded or an error occurred during expansion processing. Reclaiming The unused area of the virtual LUs that are used for the file system is being released.
3-68
Properties
Description
A null string is displayed if the file system is not mounted.
isReadOnly
Displays whether the file system is mounted as read-only. true The file system is mounted as read-only. false The file system is mounted with both read and write operations permitted. A null string is displayed if the file system is not mounted.
isFileLastAccessTi Displays whether to update the time that the file meRecordingEnabl system was last accessed. true ed The last access time is updated. false The last access time is not updated. A null string is displayed if the file system is not mounted. LUs -LU -deviceFileN ame --Displays the names of the device files that are used 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 LU name.
#: The value is not displayed if the file system is not mounted. The following shows an example of acquiring specified file system information by sending a GET method request to the FileSystems/file-system-name resource.

https://host-name-or-IP-address:9090/FileSystems/file-system-name

<?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>
3-69
<deviceFileName>lu02</deviceFileName> </LU> <LU> <deviceFileName>lu03</deviceFileName> </LU> </LUs> </FileSystem>
<LU>
Table 3-41 Status codes returned when a GET method request is sent to the FileSystems/file-system-name resource
Status code
200 Other codes
Description
Editing information about the specified file system by using the POST method
The following table describes the XML structure when a POST method request is sent to the FileSystems/file-system-name resource.
Table 3-42 XML structure when the POST method is used to send a request to the FileSystems/file-system-name resource
Properties
FileSystem -expandFileSystemSize
Data type
-String

1 For cluster configurations: 0 For single-node configurations: 0 or 1 For cluster configurations: 0 or 1 For single-node configurations: 0 For cluster configurations: 1 to n For single-node configurations: 0
Cluster, single node Single node
addLUs
--
Cluster
--
LU
--
Cluster
3-70
Properties
--
Data type

For cluster configurations: 1 For single-node configurations: 0
Cluster
deviceFileN String ame
WormSetting -maxRetention minRetention isAutoCommitEna bled
-String String Boolean
0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1
autoCommitPeriod String defaultRetention String
Legend: n: An integer of 2 or more. The following table describes the properties to be specified when sending a POST method request to the FileSystems/file-system-name resource.
Table 3-43 Properties used to send a POST method request to the FileSystems/file-system-name resource
Properties
FileSystem -expandFileSystemSize -Sets the capacity in gigabytes to expand the file system to. Specify the capacity to be added. Note that if the file systems are operating on the Sync Image, the amount of the file system capacity that can be expanded depends on the chunk size that is set on the Sync Image. For details about the restriction on the amount of capacity that can be expanded by using the chunk size, see the Hitachi Data Ingestor Sync Image User's Guide. Sets the LUs to be added to expand the file system. If false was specified for the isLvmStripingEnabled property
Description
--
Specification
One of the following properties is required: expandFileSy stemSize addLUs WormSetting
addLUs
One of the following properties is required:
3-71
Properties
Description
when the file system was created, you cannot expand the capacity. If true was specified for isLvmStripingEnabled property, specify device files that have the same capacity. The number of device files to be specified here must be the same as the number of stripes specified by stripes property when the file system was created.
Specification
expandFileSy stemSize addLUs WormSetting
--
LU
Sets the LU to be assigned to the Required if the file system. addLUs property is set. deviceFile Sets the device file name to be Name assigned to the file system. -Required if the addLUs property is set. One of the following properties is required: expandFileSy stemSize addLUs WormSetting
--
WormSetting
--
maxRetention
Sets the maximum retention period for a WORM file system. Specify infinite or a value in the following format:
day-hour-minute
Required if the WormSetting property is set and infinite is not set for the minRetention property.
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. An indefinite time period is set for the maximum retention period if you specify infinite. minRetention Sets the minimum retention period for a WORM file system. Specify infinite or a value in the following format:
day-hour-minute
Required if the WormSetting property is set.
You can specify the following values for each item: day: 0 to 36500 hour: 0 to 876000 minute: 0 to 52560000
3-72
Properties
Description
You can specify a value from 0-0-1 to 36500-0-0. An indefinite time period is set for the minimum retention period if you specify infinite.
Specification
isAutoCommitEnab Sets true when auto commit for led a WORM file system is used. You cannot change the setting from true to false. autoCommitPeriod Sets the auto-commit period for a WORM file system. Specify a value in the following format:
day-hour-minute
Required if the WormSetting property is set. Required if the WormSetting property is set and true is set for the isAutoCommitEnab led property.
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. defaultRetention Sets the default retention period for a WORM file system. Specify infinite or a value in the following format:
day-hour-minute
Required if the WormSetting property is set and true is set for the isAutoCommitEnab led property.
minute: 0 to 52560000 You can specify a value from 0-0-1 to 36500-0-0. An indefinite time period is set for the default retention period if you specify infinite.
The following shows an example of editing information about the specified file system by sending a POST method request to the FileSystems/file-systemname resource.

https://host-name-or-IP-address:9090/mapi/FileSystems/file-systemname
Example of a request XML (for a cluster configuration)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FileSystem> <WormSetting> <isAutoCommitEnabled>true</isAutoCommitEnabled>
3-73
<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>
Table 3-44 Status codes returned when a POST method request is sent to the FileSystems/file-system-name resource
Status code
200 Other codes
Description
Deleting the specified file system by using the DELETE method

Table 3-45 Status codes returned when a DELETE method request is sent to the FileSystems/file-system-name resource
Status code
200 Other codes
Description
Checking whether the specified file system exists by using the HEAD method
3-74
Table 3-46 Status codes returned when a HEAD method request is sent to the FileSystems/file-system-name resource
Status code
200 404 Other codes
Description
The specified file system exists. The specified file system does not exist. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
FileSystems/file-system-name/MountSetting resource
This section describes how to use the FileSystems/file-system-name/ MountSetting resource.
Acquiring information about the mount settings of the specified file system by using the GET method
Table 3-47 Structure of the response XML when a GET method is sent to the FileSystems/file-system-name/MountSetting resource
Properties
MountSetting -isMounted isReadOnly isFileLastAccessTi meRecordingEnabl ed mountStatus 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y Y Y Y
Legend: Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the FileSystems/file-system-name/MountSetting resource.
3-75
Table 3-48 Properties displayed when a GET method request is sent to the FileSystems/file-system-name/MountSetting resource
Properties
MountSetting -isMounted -Displays whether the file system is mounted. true The file system is mounted. false The file system is not mounted. isReadOnly Displays the file system is mounted as read-only. true The file system is mounted as read-only. false The file system is mounted with both read and write operations permitted. A null string is displayed if the file system is not mounted. isFileLastAccessTime RecordingEnabled Displays whether to update the time that the file system was last accessed. true The last access time is updated. false The last access time is not updated. A null string is displayed if the file system is not mounted. mountStatus Displays the mount status of the file system. Normal The file system is mounted correctly. Fatal error The file system is blocked. Overflow The differential-data storage device of Sync Image has run out of space. Not available A failure occurred in the differential-data storage device of Sync Image. Blocked The file system is blocked because the differentialdata storage device of Sync Image has run out of space. Blocked and Ready The file system was blocked due to there not being enough free space on the Sync Image differential-data storage device, after which free space was allocated to the differential-data storage device, and the OS on the node has not been restarted. Expanding
Description
3-76
Properties
Description
The file system is being expanded or an error occurred during expansion processing. Reclaiming The unused area of the virtual LUs that are used for the file system is being released. A null string is displayed if the file system is not mounted.
The following shows an example of acquiring information about the specified file system by sending a GET method request to the FileSystems/filesystem-name/MountSetting resource.

https://host-name-or-IP-address:9090/FileSystems/file-system-name/ MountSetting

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MountSetting> <isMounted>false</isMounted> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></ isFileLastAccessTimeRecordingEnabled> </MountSetting>
Table 3-49 Status codes returned when a GET method request is sent to the FileSystems/file-system-name/MountSetting resource
Status code
200 Other codes
Description
Editing information about the mount settings of the specified file system by using the POST method
The following table describes the XML structure when a POST method request is sent to the FileSystems/file-system-name/MountSetting resource.
3-77
Table 3-50 XML structure when the POST method is used to send a request to the FileSystems/file-system-name/MountSetting resource
Properties
MountSetting -isMounted isReadOnly -Boolean Boolean
Data type

1 1 0 or 1 0 or 1 0 or 1
isFileLastAccessTimeRe Boolean cordingEnabled isConvertToAdvancedA clType Boolean
The following table describes the properties to be specified when sending a POST method request to the FileSystems/file-system-name/MountSetting resource.
Table 3-51 Properties used to send a POST method request to the FileSystems/file-system-name/MountSetting resource
Properties
MountSetting -isMounted --
Description
--
Specification
Sets whether to change the mount Required status. true Specify this value to mount the file system. false#1 Specify this value to unmount the file system.
isReadOnly
Sets whether to allow writing to Required if true is the file system. specified for the true isMounted property Specify this value to mount the file system as read-only. false Specify this value to mount the file system with both read and write operations permitted.
isFileLastAcces Sets whether to update the time sTimeRecordin that the file system was last gEnabled accessed. true Specify this value to update the last access time.
Optional This can be set if all of the following conditions are satisfied:
3-78
Properties
Description
false#2 Specify this value to not update the last access time.
Specification
true is specified for the isMounted property. false is specified for the isReadOnly property.
isConvertToAd Sets whether to change the ACL vancedAclType type of a file system from the Classic ACL to Advanced ACL. If you change the ACL type, the ACL type of existing directories and files in the file system is changed in the background. true Specify this value to change the ACL type from Classic ACL to Advanced ACL. false#2 Specify this value to not change the ACL type from Classic ACL to Advanced ACL.
Optional This can be set if all of the following conditions are satisfied: true is specified for the isMounted property. false is specified for the isReadOnly property. The ACL type of the file system is Classic ACL.
#1: If processing for unmounting file systems failed, access to file systems might be temporarily suppressed by the Backup Restore volume replication linkage function. Use the fsctl command to check the status of file system access suppression, use the Backup Restore horcunfreeze command to release all file systems from suppression, and then re-execute the method. For details on the fsctl command, see the Hitachi Data Ingestor CLI User's Guide. For details on the horcunfreeze command, see the Hitachi Data Ingestor 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 file system by sending a POST method request to the FileSystems/file-systemname/MountSetting resource.

https://host-name-or-IP-address:9090/FileSystems/file-system-name/ MountSetting

3-79
Table 3-52 Status codes returned when a POST method request is sent to the FileSystems/file-system-name/MountSetting resource
Status code
200 Other codes
Description
Hardware
Hardware resource overview
You can use the Hardware resource to acquire the hardware status. The following table describes the HTTP method that can be used for the Hardware resource.
Table 3-53 HTTP method that can be used for the Hardware resource
Resource URI
/Hardware
HTTP method
GET
Cluster, single node
Description
Acquires the hardware status.
Hardware resource
This 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 to the Hardware resource
Properties
Hardware -PortDetails -PortDetail

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

Y Y Y
3-80
Properties

1 1 1 1 1 0 or 1 1 1 1 1 0 or 1 0 or 1 1 1 1 1 1 0 or 1 to n 1 1 1 1 1 0 or 1 to n 1
single node

Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
--
status portName mediaType linkSpeed
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster Cluster Cluster Cluster Cluster Cluster Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
ManagementLans -ManagementLan -status portName mediaType linkSpeed HeartbeatLans -HeartbeatLan -status portName mediaType linkSpeed PrivateMaintenanceLans -PrivateMaintenanc eLan -status portName mediaType linkSpeed InternalHDDs -InternalHDD -slotName
3-81
Properties
status vendorInfor mation InternalRAIDBatteries --

1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
InternalRAIDBatter 0 or 1 to n y -slotName status vendorInfor mation 1 1 1 1 0 or 1 to n 1 1 1 1 0 or 1 1 1 1 0 or 1 to n 1 1 1 1 Fan 0 or 1 to n
Memories -Memory -slotName status vendorInfor mation MemTotals -MemTotal -slotName size PowerSupplies -PowerSupply -powerSuppl yName status vendorInfor mation Fans --
3-82
Properties
-fanName status vendorInfor mation Temperatures -Temperature -temperatur eName status vendorInfor mation BMCs -BMC -status connection Models -Model -manufactur er product Serials -Serial -number

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

Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
Legend: n: An integer of 2 or more, Y: Displayed. The following table describes the properties displayed when a GET method request is sent to the Hardware resource.
3-83
Table 3-55 Properties displayed when a GET method request is sent to the Hardware resource
Properties
Hardware -PortDetails -PortDetail -status ---Displays the status of the data port. Up The link is operating normally. Down The link is disconnected or no interfaces have been added to the port. portName mediaType Displays the name of the data port. ethnumber Displays the media type of the data port. copper The data port supports metal cables. fiber The data port supports optical cables. linkSpeed Displays the link speed of the data port. 10Base The speed is 10 Mbps. 100Base The speed is 100 Mbps. 1000Base The speed is 1 Gbps. Unknown! The speed is unknown. ManagementLans -ManagementLan -status --Displays the status of the management port. Up The link is operating normally. Down The link is disconnected or no interfaces have been added to the port. portName mediaType Displays the name of the management port. mng0 Displays the media type of the management port. copper The management port supports metal cables. fiber The management port supports optical cables. linkSpeed Displays the link speed of the management port. 10Base The speed is 10 Mbps.
Description
3-84
Properties
Description
100Base The speed is 100 Mbps. 1000Base The speed is 1 Gbps. Unknown! The speed is unknown.
HeartbeatLans -HeartbeatLan -status
Displayed only in a cluster configuration. -Displays the status of the heartbeat port. Up The link is operating normally. Down The link is disconnected or no interfaces have been added to the port. portName mediaType Displays the name of the heartbeat port. hb0 Displays the media type of the heartbeat port. copper The heartbeat port supports metal cables. fiber The heartbeat port supports optical cables. linkSpeed Displays the link speed of the heartbeat port. 10Base The speed is 10 Mbps. 100Base The speed is 100 Mbps. 1000Base The speed is 1 Gbps. Unknown! The speed is unknown.
PrivateMaintenanceLans -PrivateMaintenance Lan -status
--Displays the status of the maintenance port. Up The link is operating normally. Down The link is disconnected or no interfaces have been added to the port.
portName mediaType
Displays the name of the maintenance port. pmnumber Displays the media type of the maintenance port. copper The maintenance port supports metal cables. fiber The maintenance port supports optical cables.
linkSpeed
Displays the link speed of the maintenance port.
3-85
Properties
Description
10Base The speed is 10 Mbps. 100Base The speed is 100 Mbps. 1000Base The speed is 1 Gbps. Unknown! The speed is unknown.
InternalHDDs -InternalHDD -slotName status
--Displays the index number of the internal hard disk. Displays the status of the internal hard disk. OK The status is normal. Rebuild The RAID is being rebuilt. Failed An error occurred. Not supported A program for acquiring information is not installed. vendorInfor mation Displays the vendor-specific detailed information regarding the internal hard disk. --Displays the index number of the internal RAID battery. Displays the status of the internal RAID battery. OK The battery has been charged. Charging The battery is being charged. Failed An error occurred. Not supported A program for acquiring information is not installed. vendorInfor mation Displays the vendor-specific detailed information regarding the internal RAID battery. --Displays the index number of the memory. Displays the memory status. Installed Memory is installed. slotName status
InternalRAIDBatteries -InternalRAIDBatter y -slotName status
Memories -Memory --
3-86
Properties
Description
Not Installed Memory is not installed.
vendorInfor mation MemTotals -MemTotal -slotName size PowerSupplies -PowerSupply --
Displays the vendor-specific detailed information regarding the memory. --Display the index number of the total memory capacity. Displays the total memory capacity. ---
powerSupply Displays the index number of the power supply unit. Name status Displays the status of the power supply unit. OK The status is normal. Failed An error has occurred. Not Installed No power supply unit is installed. vendorInfor mation Displays the vendor-specific detailed information regarding the power supply unit. --fanName status Displays the index number of the fan. Displays the status of the fan. OK The status is normal. Failed An error has occurred or no fan is installed. vendorInfor mation Displays the vendor-specific detailed information regarding the fan. --Displays the index number of the temperature sensor. Displays the detection results of the temperature sensor. OK The status is normal. Failed The status is abnormal. vendorInfor mation Displays the vendor-specific detailed information regarding the temperature sensor. --temperature Name status
Fans -Fan --
Temperatures -Temperature --
BMCs -BMC
3-87
Properties
-status
Description
Displays the status of the BMC on the node to which a request is sent. OK The status is normal. Unknown! The information could not be acquired.
connection
In a cluster configuration, displays the status of the connection with the node other than the node to which the request is sent. OK The status is normal. Failed An attempt to connect to the BMC on the other node failed. None A cluster configuration is not defined or an attempt to acquire the information failed.
Models -Model -manufacture r product Serials -Serial -number
--Displays the name of the manufacturer. Displays the name of the product. --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 the property. The following shows an example of acquiring the cluster mode details of the hardware by sending a GET method request to the Hardware resource.

https://host-name-or-IP-address:9090/mapi/Hardware

<?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
<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/>
3-89
<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 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 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 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 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 vendorInformation>
MB</
MB</
MB</
MB</
MB</
3-90
</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>
3-91
<status>OK</status> <vendorInformation></vendorInformation> </Fan> </Fans> <Temperatures> <Temperature> <temperatureName>0</temperatureName> <status>OK</status> <vendorInformation>reading:55 (+/- 0.500) degrees vendorInformation> </Temperature> <Temperature> <temperatureName>1</temperatureName> <status>OK</status> <vendorInformation>reading:44 (+/- 0.500) degrees vendorInformation> </Temperature> <Temperature> <temperatureName>2</temperatureName> <status>OK</status> <vendorInformation>reading:42 (+/- 0.500) degrees vendorInformation> </Temperature> <Temperature> <temperatureName>3</temperatureName> <status>OK</status> <vendorInformation>reading:39 (+/- 0.500) degrees vendorInformation> </Temperature> <Temperature> <temperatureName>4</temperatureName> <status>OK</status> <vendorInformation>reading:45 (+/- 0.500) degrees 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>
C</
C</
C</
C</
C</
3-92
<Serials> <Serial> <number>4230MB0-T019000037</number> </Serial> </Serials> </Hardware>
Table 3-56 Status codes returned when a GET method request is sent to the Hardware resource
Status code
200 Other codes
Description
HCP
HCP resource overview
You can use the HCP resource to acquire, set, or delete HCP information about the migration destination. You can also check whether the HCP namespace can be accessed. For details about tenant and namespace settings when you link the HDI system to an HCP system, see the Hitachi Data Ingestor Installation and Configuration Guide. The following table describes the HTTP methods that can be used for the HCP resource.
Table 3-57 HTTP methods that can be used for the HCP resource
Resource URI
/HCP
HTTP method
GET POST
Description
Acquires all HCP information. Sets or deletes HCP information. Checks whether the user can access the HCP namespace.
/HCP/ACCESS
POST
HCP resource
This section describes how to use the HCP resource.
3-93
Acquiring the specified HCP information by using the GET method

Table 3-58 Structure of the response XML when a GET method is sent to the HCP resource
Properties
HCP -systemname tenantname username password 1 1 1 1 1

Y Y Y Y Y#
Legend: Y: Displayed. #: The password is displayed as spaces. The following table describes the properties displayed when a GET method request is sent to the HCP resource.
Table 3-59 Properties displayed when a GET method request is sent to the HCP resource
Properties
HCP -systemname -Displays the HCP host name. A null string is displayed if the value of the HCP resource is not set. Displays the HCP tenant name. A null string is displayed if the value of the HCP resource is not set. Displays the user name of the data access account. A null string is displayed if the value of the HCP resource is not set. A null string is always displayed.
Description
tenantname
username
password
The following shows an example of acquiring HCP information by sending a GET method request to the HCP resource.

https://host-name-or-IP-address:9090/mapi/HCP
3-94

<?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>
Table 3-60 Status codes returned when a GET method request is sent to the HCP resource
Status code
200 Other codes
Description
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 of system settings is not changed. Use the sysluscheduleset command to check the settings, such as the destination to which the system settings file is saved. The following table describes the XML structure when a POST method request is sent to the HCP resource.
Table 3-61 XML structure when the POST method is used to send a request to the HCP resource
Properties
HCP -systemname tenantname username password -String String String String
Data type

1 1 1 1 1
3-95
The following table describes the properties to be specified when sending a POST method request to the HCP resource.
Table 3-62 Properties used to send a POST method request to the HCP resource
Properties
HCP -systemname --
Description
--
Specification
Required Sets the HCP host name. You can specify alphanumeric characters, periods (.), hyphens (-), or a null string. The host name cannot exceed 255 bytes, or 63 bytes if the host name contains a period. However, a period or hyphen cannot be used for the first or last character of the character string. Sets the HCP tenant name. You can specify alphanumeric characters, hyphens (-), or a null string. The tenant name must be no more than 255 bytes. Sets the user name of a data access account. You can specify any printable ASCII character from 0x21 to 0x7E, or a null string. Sets the password for a data access account. You can specify any printable ASCII character from 0x21 to 0x7E, or a null string. Required
tenantname
username
Required
password
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 by sending a POST method request to the HCP resource.

https://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
</HCP>
<systemName></systemName> <tenantName></tenantName> <userName></userName> <password></password>
Table 3-63 Status codes returned when a POST method request is sent to the HCP resource
Status code
200 Other codes
Description
HCP/ACCESS resource
This section describes how to use the HCP/ACCESS resource.
Checking whether the user can access the HCP namespace by using the POST method
The following table describes the XML structure when a POST method request is sent to the HCP/ACCESS resource.
Table 3-64 XML structure when the POST method is used to send a request to the HCP/ACCESS resource
Properties
HCP -namespace -String
Data type

1 1
The following table describes the properties to be specified when sending a POST method request to the HCP/ACCESS resource.
Table 3-65 Properties used to send a POST method request to the HCP/ ACCESS resource
Properties
HCP -namespace -Sets the HCP namespace. You can specify alphanumeric characters and hyphens (-). The
Description
--
Specification
Required
3-97
Properties
Description
namespace strings must be no more than 63 bytes.
Specification
The following shows an example of checking whether access to the HCP namespace is allowed by sending a POST method request to the HCP/ACCESS resource.

https://host-name-or-IP-address:9090/mapi/HCP/ACCESS

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <HCP> <namespaceName>arc-test</namespaceName> </HCP>
Table 3-66 Status codes returned when a POST method request is sent to the HCP/ACCESS resource
Status code
200 503 Other codes
Description
An attempt to access the namespace was successful. An attempt to access the namespace failed. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
LUs
LUs resource overview
You can use the LUs resource to acquire LU information. The following table describes the HTTP method that can be used for the LUs resource.
Table 3-67 HTTP method that can be used for the LUs resource
Resource URI
/LUs
HTTP method
GET
Cluster
Description
Acquires LU information.
3-98
LUs resource
This 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 is sent to the LUs resource
Properties
LUs -LU -deviceFileName userLUN isExternalDevice target model serial ldev type size function usedBy rg dp usedPage pool freePool totalPool

1 0 or 1 to n 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster Cluster

Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
Legend: n: An integer of 2 or more, Y: Displayed. The following table describes the properties displayed when a GET method request is sent to the LUs resource.
Table 3-69 Properties displayed when a GET method request is sent to the LUs resource
Properties
LUs -LU -deviceFileName --Displays the device file name.
Description
3-99
Properties
userLUN
Description
luhexadecimal-number Displays the user LUN in hexadecimal format. If the LU is an external storage device, a hash mark (#) is displayed after the numeric value. Displays whether the LU is an external storage device. true The LU is an external storage device. false The LU is not an external storage device.
isExternalDevice
target
Displays the target in the following format: Nnode-number-Tvalue-from-000-to-255 A null string is displayed if an LDEV number has not been assigned to the user LUN. Displays the storage subsystem model. AMS Hitachi AMS2000 series or Hitachi AMS1500 USP_V Universal Storage Platform V USP_VM Universal Storage Platform VM VSP Virtual Storage Platform A null string is displayed if an LDEV number has not been assigned to the user LUN.
model
serial
Displays the serial number of the storage subsystem in decimal format. A null string is displayed if an LDEV number has not been assigned to the user LUN. Displays the LDEV number of the device file. A null string is displayed if an LDEV number has not been assigned to the user LUN. Displays the drive type of the device file. FC/SAS The drive type is FC or SAS. SAS7K The drive type is SAS 7.2K. SATA The drive type is SATA. SSD The drive type is SSD. A null string is displayed if an LDEV number has not been assigned to the user LUN.
ldev
type
size
Displays the size of the device file in GB. A null string is displayed if an LDEV number has not been assigned to the user LUN. The size is displayed to 3 decimal places. Displays how the user LU is used. Free The LU is not in use.
function
3-100
Properties
File
Description
The LU is used for a file system.
Sync The LU is used for a file system that is being used by Sync Image. Sync(Diff) The LU is used for a differential-data storage device that is being used by Sync Image. WORM The LU is used for a WORM file system. WORM,Sync The LU is used for a WORM file system and is being used by Sync Image. WORM,Sync(Diff) The LU is used for a WORM file system and is used for a differential-data storage device that is being used by Sync Image. Defined The LU is reserved as the destination to which a file system is copied by using the functionality for linking with array volume replication functions in Backup Restore. Unknown This is displayed if the LU satisfied either of the following conditions: - The functionality or status of the LU has been changed during the execution of the command. - The information about the LU could not be acquired 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 is displayed. A null string is displayed if an LDEV number has not been assigned to the user LUN. Displays the RAID group to which the LU belongs. When the LU is a virtual LU, if the LU exists in an external subsystem or an LDEV number has not been assigned to the user LUN, a null string is displayed. Displays virtual LU information. DP The LU is a virtual LU. A null string is displayed if the LU is not a virtual LU or an LDEV number has not been assigned to the user LUN. Displays the virtual LU page size. A null string is displayed if the LU is not a virtual LU or an LDEV number has not been assigned to the user LUN. The size is displayed to 3 decimal places. Displays the number of the DP pool to which the virtual LU belongs.
rg
dp
usedPage
pool
3-101
Properties
Description
A null string is displayed if the LU is not a virtual LU or an LDEV number has not been assigned to the user LUN.
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 user LUN.
The storage subsystem model is Virtual Storage Platform 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 user LUN.
The storage subsystem model is Virtual Storage Platform 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 GET method request to the LUs resource.

https://host-name-or-IP-address:9090/mapi/LUs

<?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
<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>
Table 3-70 Status codes returned when a GET method request is sent to the LUs resource
Status code
200 Other codes
Description
MigrationTask
MigrationTask resource overview
You can use the MigrationTask resource to manage data migration to HCP. The following table describes the HTTP methods that can be used for the MigrationTask resource.
Table 3-71 HTTP methods that can be used for the MigrationTask resource
Resource URI
/MigrationTask
HTTP method
GET PUT
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster,
Description
Acquires information for all migration policies. Sets a migration policy. Acquires information for the specified migration policy. Resets the migration task schedule. Deletes the migration policy.
/MigrationTask/ policy-name
GET POST DELETE
3-103
Resource URI
HTTP method
HEAD
single node Cluster, single node
Description
Checks whether the specified migration policy exists.
In a cluster configuration, select the target resource group for the MigrationTask resource by using the otherNode query parameter.
MigrationTask resource
This 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. The following table describes the structure of the response XML output when the method ends.
Table 3-72 Structure of the response XML when a GET method request is sent to the MigrationTask resource
Properties
MigrationTasks -MigrationTask -policy-name task-type task-status fileSystemName namespace schedule-starttime schedule-repeat

1 0 or 1 to n 1 1 1 1 1 1 1

Y Y Y N N Y Y Y Y Y Y Y
schedule-interval 1 exec-stopoccurrences duration 1 1
3-104
Properties
policydescription

1

Y
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the MigrationTask resource.
Table 3-73 Properties displayed when a GET method request is sent to the MigrationTask resource
Properties
MigrationTasks -MigrationTask -policy-name task-type task-status --Displays the policy name. Displays migration as the task type. Displays one of the following task statuses: Standby The task is not scheduled to run. Scheduled The task will run on schedule. Running The task is running. If the status is Standby or Scheduled, one of the following 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 some files or directories were not migrated because a temporary error occurred on the network or other locations. Retry the migration. However, if the files are not targets of the policy when the migration is retried, they will not be migrated. Last time succeeded(Failure files exist) The previous migration was successful, but some files or directories failed to be migrated. Check the status of the files or directories. Last time failed The previous migration failed. Last time stopped The previous migration was stopped in the middle of processing. Last time interrupted The previous migration was interrupted at the set cut-off time.
Description
3-105
Properties
Description
Last time cancelled The previous migration was canceled. Never executed No migrations have been performed since the last time a schedule was set. Depending on the situation, this information is displayed for a task that has been executed once. In this case, you can display the correct status by updating the information. Note that, if a failover occurs during a migration, the status before the failover is displayed.
fileSystemName namespace schedule-starttime schedule-repeat
Displays the name of the migration destination file system. Displays the name of the namespace that corresponds to the migration destination file system. Displays the date and time at which the migration task is executed for the first time. If the task is executed immediately, now is displayed. Displays one of the following units as the migration task execution interval: onlyonce minute hour day week daily weekly monthly
schedule-interval Displays the migration task execution interval as an integer that corresponds to the unit specified in the schedule-repeat property. exec-stopoccurrences Displays the total number of times the migration task is executed. A value of 0 is displayed if there is no limit to the number of executions. Displays the time period from the time the migration task execution starts until it stops automatically. A value of 0 is displayed if the processing is not automatically terminated. Displays the description of the policy.
duration
policydescription
The following shows an example of acquiring information for all migration policies by sending a GET method request to the MigrationTask resource.

https://host-name-or-IP-address:9090/mapi/MigrationTask
3-106

<?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</schedulestart-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>
Table 3-74 Status code returned when a GET method request is sent to the MigrationTask resource
Status code
200 Other codes
Description
Setting the migration policy by using the PUT method

In a cluster configuration, you can use the otherNode query parameter. Note: If a target file is updated during a migration, the migration fails. Set task execution schedules that do not coincide with the updating of files. The following table describes the XML structure when a PUT method request is sent to the MigrationTask resource.
Table 3-75 XML structure when a PUT method request is sent to the MigrationTask resource
Properties
MigrationTask -policy-name fileSystemName namespace -String String String
Data type

1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node
3-107
Properties
schedule-starttime schedule-repeat schedule-interval exec-stopoccurrences duration policy-description
Data type
String String Integer Integer Integer String

0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1
The following table describes the properties to be specified when sending a PUT method request to the MigrationTask resource.
Table 3-76 Properties used to send a PUT method request to the MigrationTask resource
Properties
MigrationTask -policy-name -Sets the policy name. Specify a policy name from 1 to 31 characters. You can use alphanumeric characters, underscores (_), and spaces. Any spaces at the beginning or the end of the string are ignored. Sets the file system name. Sets the namespace name for the file system. Sets the date and time that the migration task is first executed. Set the date and time or now. Specify the date and time in the format below. For example, if you want to execute a task at 22:00, April 1, 2011:
2011-04-01T22:00:00.000+00:00
Description
--
Specification
Required
fileSystemName namespace schedule-starttime
Required Required Optional
When now is specified, the migration is executed immediately. If you omit this, now is set. Sets one of the following as the unit for Optional the interval at which the migration task is executed: onlyonce# minute hour day
schedule-repeat
3-108
Properties
week daily weekly
Description
Specification
monthly When daily, weekly or monthly is specified, the migration is executed at the time specified by the schedulestart-time property. schedule-interval Specifies an interval for executing a migration as an integer corresponding to the value (unit) when one of the following values are set for the schedule-repeat property. If you omit this, 1 is set. exec-stopoccurrences minute hour day week Optional Optional
Sets the maximum number of times that the migration task can be executed. Specify the number of times, as an integer from 0 to 99. When 0 is specified, there is no limit on the number of times that the migration task can be executed. If you omit this, 0 is set.
duration
Optional Sets the period of time from the start of execution of the migration task until the migration task automatically stops. Specify an integer from 0 to 999. If 0 is specified, the migration task will not stop automatically. If you omit this, 0 is set. Sets an explanation of the policy. Use 0 to 256 characters. Note that you cannot use slashes (/) or double quotation marks ("). If you omit this, an explanation of the policy is not set. Optional
policy-description
#: This is the default value used when the property is omitted. The following shows an example of setting the migration policy by sending a PUT method request to the MigrationTask resource.

https://host-name-or-IP-address:9090/mapi/MigrationTask
3-109

<?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</schedulestart-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>
Table 3-77 Status codes returned when a PUT method request is sent to the MigrationTask resource
Status code
200 Other codes
Description
MigrationTask/policy-name resource
This section describes how to use the MigrationTask/policy-name resource.
Acquiring information for the specified migration policy by using the GET method
Make sure that you encode the policy-name portion using Base64. In a cluster configuration, you can use the otherNode query parameter. The following table describes the structure of the response XML output when the method ends.
Table 3-78 Structure of the response XML when a GET method request is sent to the MigrationTask/policy-name resource
Properties
MigrationTask -policy-name task-type 1 1 1

Y Y N
3-110
Properties
task-status fileSystemName namespace schedule-starttime schedule-repeat schedule-interval exec-stopoccurrences duration policy-description 1 1 1 1 1 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

N Y Y Y Y Y Y Y Y
Legend: Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the MigrationTask/policy-name resource.
Table 3-79 Properties displayed when a GET method request is sent to the MigrationTask/policy-name resource
Properties
MigrationTask -policy-name task-type task-status -Displays the policy name. Displays migration as the task type. Displays one of the following task statuses: Standby The task is not scheduled to run. Scheduled The task will run on schedule. Running The task is running. If the status is Standby or Scheduled, one of the following 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 some files or directories were not migrated because a temporary error occurred on the network or other location. Retry the migration. However, if the files are not targets of
Description
3-111
Properties
Description
the policy when the migration is retried, they will not be migrated. Last time succeeded(Failure files exist) The previous migration was successful, but some files or directories failed to be migrated. Check the status of the files or directories. Last time failed The previous migration failed. Last time stopped The previous migration was stopped in the middle of the processing. Last time interrupted The previous migration was interrupted at the set cutoff time. Last time cancelled The previous migration was canceled. Never executed The migration was never executed. Depending on the situation, this information is displayed for a task that has been executed once. In this case, you can display the correct status by updating the information. Note that, if a failover occurs during a migration, the status before the failover is displayed.
fileSystemName namespace schedule-starttime schedule-repeat
Displays the name of the migration destination file system. Displays the name of the namespace that corresponds to the migration destination file system. Displays the date and time at which the migration task is executed for the first time. If the task is executed immediately, now is displayed. Displays one of the following units as the migration task execution interval. onlyonce minute hour day week daily weekly monthly
schedule-interval
Displays the migration task execution interval as an integer that corresponds to the unit specified in the schedulerepeat property. Displays the total number of times the migration task is executed. A value of 0 is displayed if there is no limit to the number of executions.
exec-stopoccurrences
3-112
Properties
duration
Description
Displays the time period from the time the migration task execution starts until it stops automatically. A value of 0 is displayed if the processing is not automatically terminated. Displays the description of the policy.
policy-description
The following shows an example of acquiring information for the specified migration policy by sending a GET method request to the MigrationTask/ policy-name resource.

https://host-name-or-IP-address:9090/mapi/MigrationTask/policy-name

<?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>
Table 3-80 Status codes returned when a GET method request is sent to the MigrationTask/policy-name resource
Status code
200 Other codes
Description
Resetting the schedule of the migration task by using the POST method
Make sure that you encode the policy-name portion using Base64. In a cluster configuration, you can use the otherNode query parameter. Note: If a target file is updated during a migration, the migration fails. Set task execution schedules that do not coincide with the updating of files. The following table describes the XML structure when a POST method request is sent to the MigrationTask/policy-name resource.
3-113
Table 3-81 XML structure when a POST method request is sent to the MigrationTask/policy-name resource
Properties
MigrationTask -schedule-starttime schedule-repeat schedule-interval exec-stopoccurrences duration -String String Integer Integer Integer
Data type

1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1
The following table describes the properties to be specified when sending a POST method request to the MigrationTask/policy-name resource.
Table 3-82 Properties used to send a POST method request to the MigrationTask/policy-name resource
Properties
MigrationTask -schedule-starttime --
Description
--
Specification
Sets the date and time that the Optional migration task is first executed. Specify a date and time or now. Example: To execute the first task at 22:00, April 1, 2011:
2011-04-01T22:00:00.000+00:00
If now is specified, the task will start immediately. If you omit this, now is set.
schedule-repeat
Sets one of the following as the unit for Optional the interval at which the migration task is executed. onlyonce# minute hour day week daily weekly monthly
3-114
Properties
schedule-interval
Description
Sets an integer appropriate for the unit set for the schedule-repeat property. If you omit this, 1 is set.
Specification
Required if any of the following values is set for the schedulerepeat property: minute hour day week
exec-stopoccurrences
Sets the maximum number of times that the migration task can be executed. Specify an integer from 0 to 99. If 0 is specified, no maximum is set. The default value is 0. If you omit this, 0 is set.
Optional
duration
Optional Sets the period of time from the start of execution of the migration task until the migration task automatically stops. Specify an integer from 0 to 999. If 0 is specified, the migration task does not automatically stop. If you omit this, 0 is set.
#: This is the default value used when the property is omitted. The following shows an example of resetting the schedule of the migration task by sending a POST method request to the MigrationTask/policy-name resource.

https://host-name-or-IP-address:9090/mapi/MigrationTask/policy-name

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MigrationTask> <schedule-start-time>2011-05-01T22:00:00.000+00:00</schedulestart-time> <schedule-repeat>week</schedule-repeat> <schedule-interval>10</schedule-interval> <duration>8</duration> <exec-stop-occurrences>0</exec-stop-occurrences> </MigrationTask>
3-115
Table 3-83 Status codes returned when a POST method request is sent to the MigrationTask/policy-name resource
Status code
200 Other codes
Description
Deleting policy information by using the DELETE method

Make sure that you encode the policy-name portion using Base64. In a cluster configuration, you can use the otherNode query parameter. The following table describes the status codes output when the method ends.
Table 3-84 Status codes returned when a DELETE method request is sent to the MigrationTask/policy-name resource
Status code
200 Other codes
Description
Checking whether the specified migration policy exists by using the HEAD method
Make sure that you encode the policy-name portion using Base64. In a cluster configuration, you can use the otherNode query parameter. The following table describes the status codes output when the method ends.
Table 3-85 Status codes returned when a HEAD method request is sent to the MigrationTask/policy-name resource
Status code
200 404 Other codes
Description
Execution of the method ended successfully. The specified migration policy cannot be used. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
3-116
NetworkInterfaces
NetworkInterfaces resource overview
You can use the NetworkInterfaces resource to acquire and manage network interface information. The following table describes the HTTP methods that can be used for the NetworkInterfaces resource.
Table 3-86 HTTP methods that can be used for the NetworkInterfaces resource
Resource URI
/NetworkInterfaces
HTTP method
GET PUT
Description
Acquires network interface information. Adds a network interface. Acquires information for the specified network interface. Edits the specified network interface information. Checks whether the specified network interface exists.
/NetworkInterfaces/ GET network-interfacename POST HEAD
NetworkInterfaces resource
This 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 is sent to the NetworkInterfaces resource
Properties
NetworkInterfaces -NetworkInterface -name mtu 1 0 or 1 to n 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster,

Y Y Y N
3-117
Properties

1
single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y N Y Y Y
netmask
networkAddres 1 s FixedIP -target other 1 1
Cluster For cluster configurations: 1 For singlenode configurations: 0 Cluster For cluster configurations: 1 For singlenode configurations: 0 Cluster For cluster configurations: 1 For singlenode configurations: 0 Cluster For cluster configurations: 1 For singlenode configurations: 0
ServiceIP
--
target
other
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the NetworkInterfaces resource.
3-118
Table 3-88 Properties displayed when a GET method request is sent to the NetworkInterfaces resource
Properties
NetworkInterfaces -NetworkInterface -name --Displays the interface name in one of the following formats: mtu#1 netmask#2 networkAddress FixedIP -target ethnumber agrnumber rdnnumber mng0
Description
Displays the MTU value. A null string is displayed if no interface is set. Displays the netmask. A null string is displayed if no interface is set. Displays the network address. -Displays the fixed IP address of the node to which the request is sent. A null string is displayed if the LAN port is not being used. Displays the fixed IP address of the node other than the node to which the request is sent. A null string is displayed if the LAN port is not being used. -target Displays the service IP address of the node to which the request is sent. A null string is displayed if no service IP address is set. Displays the service IP address of the node other than the node to which the request is sent. A null string is displayed if no service IP address is set.
other#2
ServiceIP --
other#2
#1: If the MTU values in the cluster do not match each other, Invalid is displayed, and the values are displayed on the following line in the format (MTU-value-of-the-node-currently-being-accessed, MTU-value-of-the-othernode). If an MTU value cannot be acquired because the OS is not running, a communication error has occurred, or for some other reason, Unknown is displayed. Example: Invalid(1500,Unknown) If an MTU value cannot be acquired for some other reason, None is displayed.
3-119
Example: Invalid(1500,None) #2: If the information cannot be acquired because the OS is not running, a communication error occurred, or for some other reason, Unknown is displayed. If the collected information is invalid, such as when the interface settings have been specified for only one node or when different IP addresses are specified for network addresses in the same interface, Invalid(invalidvalue) is displayed. The following shows an example of acquiring network interface information by sending a GET method request to the NetworkInterfaces resource.

https://host-name-or-IP-address:9090/mapi/NetworkInterfaces

<?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
<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>
3-121
<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>
Table 3-89 Status codes returned when a GET method request is sent to the NetworkInterfaces resource
Status code
200 Other codes
Description
Adding a network interface by using the PUT method

The following table describes the XML structure when a PUT method request is sent to the NetworkInterfaces resource.
Table 3-90 XML structure when a PUT method request is sent to the NetworkInterfaces resource
Properties
NetworkInterface -name netmask FixedIP -target other -String String -String String
Data type

1 1 1 1 1 For cluster configuratio ns: 0 or 1 For singlenode configuratio ns: 0
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster
3-122
Properties
ServiceIP --
Data type

For cluster configuratio ns: 0 or 1 For singlenode configuratio ns: 0 For cluster configuratio ns: 0 or 1 For singlenode configuratio ns: 0 For cluster configuratio ns: 0 or 1 For singlenode configuratio ns: 0
Cluster
--
target
String
Cluster
other
String
Cluster
The following table describes the properties to be specified when sending a PUT method request to the NetworkInterfaces resource.
Table 3-91 Properties used to send a PUT method request to the NetworkInterfaces resource
Properties
NetworkInterface -name -Sets the name of the port to which the network interface will be added. You can set only the network interfaces that are displayed in the execution result of the GET method and for which only the name property is set. netmask FixedIP#1 -target ethnumber agrnumber rdnnumber Required Required
Description
--
Specification
Required
Sets the netmask for the fixed IP address and service IP address. --
Sets the fixed IP address of the node to Required which the request is sent.
3-123
Properties
other
Description
Sets the fixed IP address of the node other than the node to which the request is sent. -Sets the service IP address of the node to which the request is sent. If you specify a null string or omit this property, no value is set. Sets the service IP address of the node other than the node to which the request is sent. If you specify a null string or omit this property, no value is set.
Specification
Required
ServiceIP#1#2 -target
Optional Optional
other
Optional
#1: Do not specify the IP addresses shown below. These addresses are reserved in the storage subsystem. If you must specify them, contact our Technical 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 port You can use the pmctl command to view the IP address set for the private maintenance port. For details on the pmctl command, see the Hitachi Data Ingestor CLI User's Guide. IP addresses that belong to the same network as the IP address set for the heartbeat port You can use the ProcessingNode resource to view the IP address set for the heartbeat port. For details on the ProcessingNode resource, see ProcessingNode resource on page 3-157.
#2: Interfaces created without specifying a service IP address are excluded from the targets of resource group monitoring. Note the following when creating an interface without specifying a service IP address: The CIFS, NFS, and FTP services provided by the HDI system cannot be used 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 is set, SNMP traps (excluding trunking) and the error notification for maintenance personnel are not sent.
The following shows an example of adding a network interface by sending a PUT method request to NetworkInterfaces resource.

https://host-name-or-IP-address:9090/mapi/NetworkInterfaces

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <NetworkInterface>
3-124
<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>
Table 3-92 Status codes returned when a PUT method request is sent to the NetworkInterfaces resource
Status code
200 Other codes
Description
NetworkInterfaces/network-interface-name resource
This section describes how to use the NetworkInterfaces/network-interfacename resource.
Acquiring network interface information by using the GET method

Table 3-93 Structure of the response XML when a GET method request is sent to the NetworkInterfaces/network-interface-name resource
Properties
NetworkInterface -name mtu netmask networkAddress FixedIP 1 1 1 1 1 1

Y Y N Y N Y
3-125
Properties
-target other 1 ServiceIP -target other

Y Y
For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 For single-node configurations: 0
Cluster
Cluster
Cluster
Cluster
Legend: Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the NetworkInterfaces/network-interface-name resource.
Table 3-94 Properties displayed when a GET method request is sent to the NetworkInterfaces/network-interface-name resource
Properties
NetworkInterface -name -Displays the interface name in one of the following formats: mtu netmask networkAddress FixedIP -target ethnumber agrnumber rdnnumber mng0
Description
Displays the MTU value. A null string is displayed if no interface is set. Displays the netmask. A null string is displayed if no interface is set. Displays the network address. -Displays the fixed IP address of the node to which the request is sent. A null string is displayed if the LAN port is not being used.
3-126
Properties
other
Description
Displays the fixed IP address of the node other than the node to which the request is sent. A null string is displayed if the LAN port is not being used. -Displays the service IP address of the node to which the request is sent. A null string is displayed if no service IP address is set. Displays the service IP address of the node other than the node to which the request is sent. A null string is displayed if no service IP address is set.
ServiceIP -target
other
The following table describes the properties to be specified when sending a POST method request to the NetworkInterfaces/network-interface-name resource.

https://host-name-or-IP-address:9090/mapi/NetworkInterfaces/networkinterface-name

<?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>
Table 3-95 Status codes returned when a GET method request is sent to the NetworkInterfaces/network-interface-name resource
Status code
200 Other codes
Description
Changing the network interface information by using the POST method

The following table describes the XML structure when a POST method request is sent to the NetworkInterfaces/network-interface-name resource.
3-127
Table 3-96 XML structure when a POST method request is sent to the NetworkInterfaces/network-interface-name resource
Properties
NetworkInterface -netmask FixedIP -target other -String -String String
Data type
1
0 or 1 0 or 1 1 For cluster configurations: 0 or 1 For single-node configurations: 0 For cluster configurations: 0 or 1 For single-node configurations: 0 For cluster configurations: 0 or 1 For single-node configurations: 0 For cluster configurations: 0 or 1 For single-node configurations: 0
Cluster
ServiceIP -
Cluster
-target String
Cluster
other String
Cluster
The following table describes the properties used to send a POST method request to the NetworkInterfaces/network-interface-name resource.
Table 3-97 Properties used to send a POST method request to the NetworkInterfaces/network-interface-name resource
Properties
NetworkInterface -netmask --
Description
--
Specification
Sets the netmask for the fixed IP One of the following address and service IP address. properties is required: netmask FixedIP
3-128
Properties
FixedIP#1 --
Description
Specification
ServiceIP One of the following properties is required: netmask FixedIP ServiceIP
--
target
Sets the fixed IP address of the node to which the request is sent. Sets the fixed IP address of the node other than the node to which the request is sent. --
Required if the FixedIP property is set. Required if the FixedIP property is set. One of the following properties is required: netmask FixedIP ServiceIP
other
ServiceIP#1#2
--
target
Sets the service IP address of the node to which the request is sent. If you specify a null string, the value set for this property is deleted.
Optional (if you omit this property, the value set for the target property is deleted.) If you omit the ServiceIP property, the value set for the target property is kept as is. Optional (if you omit this property, the value set for the other property is deleted.) If you omit the ServiceIP property, the value set for the other property is kept as is.
other
Sets the service IP address of the node other than the node to which the request is sent. If you specify a null string, the value set for this property is deleted.
#1: Do not specify the IP addresses shown below. These addresses are reserved in the storage subsystem. If you must specify them, contact our Technical 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 port You can use the pmctl command to view the IP address set for the private maintenance port. For details on the pmctl command, see the Hitachi Data Ingestor CLI User's Guide. IP addresses that belong to the same network as the IP address set for the heartbeat port
3-129
You can use the ProcessingNode resource to view the IP address set for the heartbeat port. For details on the ProcessingNode resource, see ProcessingNode resource on page 3-157. #2: Interfaces created without specifying a service IP address are excluded from the targets of resource group monitoring. Note the following when creating an interface without specifying a service IP address: The CIFS, NFS, and FTP services provided by the HDI system cannot be used 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 is set, SNMP traps (excluding trunking) and the error notification for maintenance personnel are not sent.
The following shows an example of changing the network interface information by sending a POST method request to the NetworkInterfaces/ network-interface-name resource.

https://host-name-or-IP-address:9090/mapi/NetworkInterfaces/networkinterface-name

<?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>
Table 3-98 Status codes returned when a POST method request is sent to the NetworkInterfaces/network-interface-name resource
Status code
200 Other codes
Description
Checking whether the specified network interface exists by using the HEAD method
3-130
Table 3-99 Status codes returned when a HEAD method request is sent to the NetworkInterfaces/network-interface-name resource
Status code
200 Other codes
Description
The specified network interface can be used. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
NFSShares
NFSShares resource overview
You can use the NFSShares resource to manage NFS share information. The following table describes the HTTP methods that can be used for the NFSShares resource.
Table 3-100 HTTP methods that can be used for the NFSShares resource
Resource URI
/NFSShares
HTTP method
GET PUT
Description
Acquires information for all NFS shares. Adds an NFS share. Acquires information for the specified NFS share. Edits the specified NFS share information. Deletes the specified NFS share. Checks whether the specified NFS share exists.
/NFSShares/ NFS-sharedirectoryname#1
GET#2 POST#2 DELETE#2 HEAD#2
#1: For NFS-share-directory-name, specify the name of the directory at the lowest level of the shared directory. #2: Specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME.
NFSShares resource
This section describes how to use the NFSShares resource.
3-131
Acquiring information for all NFS shares by using the GET method
Table 3-101 Structure of the response XML when a GET method request is sent to the NFSShares resource
Properties
NFSShares -NFSShare -exportPoint anonymousUID anonymousGID isPortRestrictionEnabled isSubtreeCheckEnabled isAccessCheckWithLockReq uestEnabled aclType maxRwSize AllowedHosts -AllowedHost --

1 0 or 1 to n 1 1 1 1 1 1 1 1 1 1 to n
Supported configuratio ns

Y Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y
hostOrAddress 1 isReadOnly 1
synchronousW 1 ritingSetting anonymousMa 1 pping securityFlavor 1
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the NFSShares resource.
3-132
Table 3-102 Properties displayed when a GET method request is sent to the NFSShares resource
Properties
NFSShares -NFSShare -exportPoint anonymousUID anonymousGID isPortRestrictionEnabled --Displays the path name of the shared directory. Displays the user ID to be used when accessing a share as an anonymous user. Displays the group ID to be used when accessing a share as an anonymous user. Displays whether to receive only requests sent from Internet port numbers that are 1024 or less. true Source ports are limited. false Source ports are not limited. isSubtreeCheckEnabled Displays whether to check if the execute permission (x) exists for all directories (subtrees), including the shared directory and the directory that contains the file or directory to be accessed, as well as checking the access permissions for the file or directory to be accessed. true A subtree check is performed. false A subtree check is not performed. isAccessCheckWithLockReq uestEnabled Displays whether to approve (check permissions for) a lock request if one is sent. true Permission for a lock request is checked. false Permission for a lock request is not checked. aclType Displays the ACL type of the file system. Advanced ACL Advanced ACL type Classic ACL Classic ACL type Unknown The ACL type could not be acquired. maxRwSize Displays the maximum transfer length for the NFS share. A null string is displayed if no maximum transfer length is set. ---
Description
AllowedHosts -AllowedHost
3-133
Properties
--
Description
hostOrAddress Displays the name of a host or network on which the NFS share is made public. isReadOnly Displays the access permissions for the NFS share. true The NFS share is read-only. false Read and write operations are permitted on the NFS share. synchronousW Displays whether to optimize synchronous ritingSetting writing when isReadOnly is set to false. The displayed value is valid only when false is specified for the isReadOnly property. rw_sync Synchronous writing is not optimized. rw_sync_opt Synchronous writing is optimized. anonymousMa Displays users who are to be mapped as pping anonymous users. everyone All users are mapped as anonymous users. root_only Only the root user is mapped as an anonymous user. none Users are not mapped as anonymous users. securityFlavor Displays the security flavor set for the public destination of the NFS share. If multiple security flavors have been set, they are displayed separated by commas (,). sys UNIX (AUTH_SYS) authentication is applied. krb5 Kerberos authentication is applied. krb5i Data integrity verification is applied in addition to Kerberos authentication. krb5p Data integrity verification is applied and privacy is provided in addition to Kerberos authentication.
The following shows an example of acquiring NFS share information by sending a GET method request to the NFSShares resource.
3-134

https://host-name-or-IP-address:9090/mapi/NFSShares

<?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>
Table 3-103 Status codes returned when a GET method request is sent to the NFSShares resource
Status code
200 Other codes
Description
Adding an NFS share by using the PUT method

The following table describes the XML structure when a PUT method request is sent to the NFSShares resource.
3-135
Table 3-104 XML structure when a PUT method request is sent to the NFSShares resource
Properties
NFSShare -exportPoint anonymousUID anonymousGID isPortRestrictionEnabled isSubtreeCheckEnabled isAccessCheckWithLockReque stEnabled maxRwSize AllowedHosts -AllowedHost -hostOrAddress isReadOnly
Data type
-String Integer Integer Boolean Boolean Boolean Integer --String Boolean

1 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 1 0 or 1 to n 1 0 or 1 0 or 1 0 or 1 0 or 1 0 or 1 1 1 0 or 1 0 or 1 0 or 1 0 or 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
synchronousWri String tingSetting anonymousMap String ping securityFlavor DirectorySetup -userName groupName isStickyBit ownerPermission groupPermission otherPermission String -String String Boolean String String String
3-136
Properties
DirectoryACLSettings -DirectoryACLSetting -userGroupAcce ss name accountType
Data type
--String String String

0 or 1 0 or 1 to n 1 1 1 1 1 1
applicationDesti String nation inheritanceRan ge accessPermissi on String String
Legend: n: An integer of 2 or more. The following table describes the properties to be specified when sending a PUT method request to the NFSShares resource.
Table 3-105 Properties used to send a PUT method request to the NFSShares resource
Properties
NFSShare -exportPoint -Sets the absolute path to the directory to which the file share will be added. You can use 6 to 63 characters. Sets the user ID used for access as an anonymous user. You can specify an ID from 0 to 65535. If you omit this, 65534 is set. Sets the group ID used for access as an anonymous user. You can specify an ID from 0 to 65535. If you omit this, 65534 is set. Sets whether only requests sent from an Internet port whose number is smaller than 1024 will be accepted. true Specify this value to limit the ports.
Description
Specification
-Required
anonymousUID
Optional
anonymousGID
Optional
isPortRestrictionEnabled
Optional
3-137
Properties
Description
false# Specify this value to not limit the ports.
Specification
isSubtreeCheckEnabled
Sets to check for whether execution permission (x) exists for all directories (subtrees), including the shared directory and the directory that contains the file or directory to be accessed. true Specify this value to check the subtree. false# Specify this value to not check the subtree.
Optional
isAccessCheckWithLockReque stEnabled
Sets whether to approve (check Optional permission for) a lock request if one is sent. true Specify this value to approve a lock request. false# Specify this value to not approve a lock request.
maxRwSize
Sets the maximum transfer length, from 4 to 1024 in KB, for the NFS share. If you omit this, no value is set. --hostOrAddress
Optional
AllowedHosts -AllowedHost --
Optional Optional
Sets the hosts allowed to access Required the NFS share. Specify 255 characters or fewer. The string cannot start with a hyphen (-). If you specify a host alias, the official host name also must be 255 characters or fewer. Note that the total length (specified length + 5 bytes) of the specified host names or network addresses must be less than 1,258 bytes. In addition to the host name and the IP address, you can use the following format: Netgroup Specify an NIS netgroup. For example, for @group, only host segment is extracted from the netgroup members. IP network
3-138
Properties
Description
To permit all hosts in the subnetwork to access the NFS share, specify the IP address and the netmask in the following format: address/netmask The netmask can be specified in dotted decimal format or as continuous masks. DNS domain Specify the name of the DNS domain to which NFS clients belong, with a period (.) added at the beginning of the name. Example: .example.com Wild card To specify all hosts, use an asterisk (*) as a wild card. When the NFS client machine has multiple network interfaces communicating with the HDI system, specify the hosts and networks allowed to access the NFS share in one of the following formats: Use a wild card (*). Specify the IP addresses of all network interfaces used on the NFS client side. Specify the host names for all network interfaces used on the NFS client side. Specify an IP network that contains the IP addresses of all network interfaces used on the NFS client side. Specify a netgroup that contains the host names for all network interfaces used on the NFS client side. Specify a DNS domain that contains the host names for all network interfaces used on the NFS client side.
Specification
isReadOnly
Sets whether to permit the NFS share to be read only. true Specify this value to set the share as read-only. false#
Optional
3-139
Properties
Description
Specify this value to not set the share as read-only.
Specification
synchronousWri Sets whether to optimize tingSetting synchronous writing. This item is effective only when the isReadOnly property is false. rw_sync# Specify this value to not optimize synchronous writing. rw_sync_opt Specify this value to optimize synchronous writing. anonymousMap Sets this property to use ping mapping for the anonymous user. everyone Specify this value to map all users to the anonymous user. root_only# Specify this value to map only the root user to the anonymous user. none Specify this value if mapping to the anonymous user is not to be performed. securityFlavor Sets the security flavor. To specify multiple security flavors, separate them by using periods (.). You cannot specify default with other security flavors. sys Specify this value to apply UNIX (AUTH_SYS) authentication. krb5 Specify this value to apply Kerberos authentication. krb5i Specify this value to apply data integrity verification in addition to Kerberos authentication. krb5p Specify this value to apply data integrity verification and provide privacy in
Optional
Optional
Optional
3-140
Properties
Description
addition to Kerberos authentication. default# Specify this value to apply the security flavor value indicated on the NFS Service Management page of the GUI. Other values cannot be specified when this value is specified. The value that is set at the time that the method is executed is applied.
Specification
DirectorySetup
Specify this if you want to create Optional a shared directory whenever a share is created. To check the values set for this property, check if the created shared directory can be accessed from a client. Sets the user name or user ID of the owner for a directory to be created. For a user ID, specify an ID from 0 to 2147483147. Note that, for an ID other than 0, you cannot specify 0 at the beginning of the ID. Sets the group name or group ID of a shared directory. For a group ID, specify an ID from 0 to 2147483147. Note that, for an ID other than 0, you cannot specify 0 at the beginning of the ID. If user mapping is used, you cannot specify a builtin group for a Windows domain. Sets whether to use the sticky bit. true Specify this value to use the sticky bit. false# Specify this value to not use the sticky bit. Required if the DirectorySetu p property is set.
--
userName
groupName
isStickyBit
Optional (Can be set only if the DirectorySetu p property is set)
ownerPermission
Sets the access privileges the owner has for the directory. If you omit this, no access privileges are set. If you omit this, no access privileges are set for the ownerPermission property. However, if the isStickyBit,
3-141
Properties
Description
ownerPermission, groupPermission, and otherPermission properties are omitted, rw is set for the ownerPermission property. rw Specify this value to permit reading and writing. ro Specify this value to permit only reading.
Specification
none Specify this value to prohibit reading and writing. groupPermission Sets the access privileges a group has for the directory. If you omit this, no access privileges are set. If you omit this, no access privileges are set for the groupPermission property. However, if the isStickyBit, ownerPermission, groupPermission, and otherPermission properties are omitted, ro is set for the groupPermission property. For details about the access permissions that can be set, see the description of the ownerPermission property. Sets the access privileges others have for the directory. If you omit this, no access privileges are set. If you omit this, no access privileges are set for the otherPermission property. However, if the isStickyBit, ownerPermission, groupPermission, and otherPermission properties are omitted, ro is set for the otherPermission property. For details about the access permissions that can be set, see the description of the ownerPermission property. Specify this if you want to set the ACL for a shared directory. To check the values set for this property, check if the created shared directory can be accessed from a client. Optional (Can be set only if the DirectorySetu p property is set)
otherPermission
DirectoryACLSettings
Optional (Can be set if the isClassicAcl property is set to false)
3-142
Properties
-DirectoryACLSetting --
Description
Specification
Required if the DirectoryACLS ettings property is set. Required if the DirectoryACLS etting property is set.
--
userGroupAcce ss
Sets the access privileges for ACL users and groups. allow Specify this value to set the allow access privileges for the specified users and groups and to add the access privileges specified for the ACEs of the users and groups. If ACEs are already set, the access privileges are combined. If multiple ACEs are set for a user, the ACEs are combined into one ACE. replace Specify this value to set the allow access privileges for the specified users and groups and to replace the access privileges of the users and groups with the specified ACEs. deny Specify this value to set the deny access privileges for the specified users and groups and to replace the access privileges of the users and groups with the specified ACEs.
name
Sets a user name or group name in the ACL.
Required if the DirectoryACLS etting property is set. Required if the DirectoryACLS etting property is set.
accountType
Sets the ACL account type. u Specify this value to set the access privileges for the users. g Specify this value to set the access privileges for the groups.
applicationDesti Sets the ACE scope. Required if the DirectoryACLS nation o Specify this value to apply to etting property is set. the directory only. a
3-143
Properties
Description
Specify this value to apply to the directory, subdirectories, and files. f Specify this value to apply to the directory and subdirectories. Specify this value to apply to the directory and files. Specify this value to apply to the subdirectories and files. Specify this value to apply to the subdirectories only. Specify this value to apply to the files only.
Specification
inheritanceRan ge
Sets the scope of ACE inheritance. o Specify this value for only the directories and files immediately under the directory to inherit ACEs. a Specify this value for all the directories and files under the directory to inherit ACEs.
accessPermissi on
Sets ACL access privileges. f Specify this value to set full control. s Specify this value to set the Traverse Folder / Execute File privilege. Specify this value to set privileges for acquiring a list of folders and reading data. Specify this value to set privileges for reading attributes. Specify this value to set privileges for reading extended attributes.
3-144
Properties
w
Description
Specify this value to set privileges for creating files and writing data. Specify this value to set privileges for creating folders and adding data. Specify this value to set privileges for writing attributes. Specify this value to set privileges for writing extended attributes. Specify this value to set privileges for deleting subfolders and files. Specify this value to set privileges for deletion. Specify this value to set privileges for reading access permissions. Specify this value to set privileges for changing access permissions. Specify this value to set privileges for acquiring owner privileges.
Specification
#: This is the default value used when the property is omitted. The following shows an example of creating an NFS share by sending a PUT method request to the NFSShares resource.

https://host-name-or-IP-address:9090/mapi/NFSShares

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID>
3-145
<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>
Table 3-106 Status codes returned when a PUT method request is sent to the NFSShares resource
Status code
200 Other codes
Description
NFSShares/NFS-share-directory-name resource
This section describes how to use the NFSShares/NFS-share-directory-name resource.
3-146
Acquiring information for the specified NFS share by using the GET method
You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. The following table describes the structure of the response XML output when the method ends.
Table 3-107 Structure of the response XML when a GET method request is sent to the NFSShares/NFS-share-directory-name resource
Properties
NFSShare -exportPoint anonymousUID anonymousGID isPortRestrictionEnabled isSubtreeCheckEnabled isAccessCheckWithLockReque stEnabled aclType maxRwSize AllowedHosts -AllowedHost -hostOrAddress isReadOnly

1 1 1 1 1 1 1 1 1 1 1 to n 1 1
Supported configuration s
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node

Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y
synchronousWri 1 tingSetting anonymousMap 1 ping securityFlavor 1
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the NFSShares/NFS-share-directory-name resource.
3-147
Table 3-108 Properties displayed when a GET method request is sent to the NFSShares/NFS-share-directory-name resource
Properties
NFSShare -exportPoint anonymousUID anonymousGID isPortRestrictionEnabled -Displays the path name of the shared directory. Displays the user ID to be used when accessing a share as an anonymous user. Displays the group ID to be used when accessing a share as an anonymous user. Displays whether to receive only requests sent from Internet port numbers that are 1024 or less. true Source ports are limited. false Source ports are not limited. isSubtreeCheckEnabled Displays whether to check if the execute permission (x) exists for all directories (subtrees), including the shared directory and the directory that contains the file or directory to be accessed, as well as checking the access permissions for the file or directory to be accessed. true A subtree check is performed. false A subtree check is not performed. isAccessCheckWithLockReque stEnabled Displays whether to approve (check permissions for) a lock request if one is sent. true Permission for a lock request is checked. false Permission for a lock request is not checked. aclType Displays the ACL type of the file system. Advanced ACL Advanced ACL type Classic ACL Classic ACL type Unknown The ACL type could not be acquired. maxRwSize Displays the maximum transfer length for the NFS share. A null string is displayed if no maximum transfer length is set. --Displays the name of a host or network on which the NFS share is made public. Displays the access permission for the NFS share. true hostOrAddress isReadOnly
Description
3-148
Properties
Description
The NFS share is read-only. false Read and write operations are permitted on the NFS share.
synchronousWri Displays whether to optimize synchronous writing tingSetting when isReadOnly is set to false. The displayed value is valid only when false is specified for the isReadOnly property. rw_sync Synchronous writing is not optimized. rw_sync_opt Synchronous writing is optimized. anonymousMap Displays users who are to be mapped as ping anonymous users. everyone All users are mapped as anonymous users. root_only Only the root user is mapped as an anonymous user. none Users are not mapped as anonymous users. securityFlavor Displays the security flavor set for the public destination of the NFS share. If multiple security flavors have been set, they are displayed separated by commas (,). sys UNIX (AUTH_SYS) authentication is applied. krb5 Kerberos authentication is applied. krb5i Data integrity verification is applied in addition to Kerberos authentication. krb5p Data integrity verification is applied and privacy is provided in addition to Kerberos authentication.
The following shows an example of acquiring NFS share information by sending a GET method request to the NFSShares resource.

https://host-name-or-IP-address:9090/mapi/NFSShares/NFS-sharedirectory-name

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <NFSShare> <exportPoint>/mnt/fs/nfs</exportPoint> <anonymousUID>22222</anonymousUID>
3-149
<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>
Table 3-109 Status codes returned when a GET method request is sent to the NFSShares/NFS-share-directory-name resource
Status code
200 Other codes
Description
Editing NFS share information by using the POST method

You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. The following table describes the XML structure when a POST method request is sent to the NFSShares/NFS-share-directory-name resource.
Table 3-110 XML structure when a POST method request is sent to the NFSShares/NFS-share-directory-name resource
Properties
NFSShare -anonymousUID anonymousGID isPortRestrictionEnabled isSubtreeCheckEnabled
Data type
-Integer Integer Boolean Boolean

1 0 or 1 0 or 1 0 or 1 0 or 1
Cluster, single node Cluster, single node Cluster, single node Single node Cluster, single node
3-150
Properties
isAccessCheckWithLockReque stEnabled maxRwSize AllowedHosts -AllowedHost -hostOrAddress isReadOnly
Data type
Boolean Integer --String Boolean

0 or 1 0 or 1 1 1 to n 1 0 or 1 0 or 1 0 or 1 0 or 1
synchronousWri String tingSetting anonymousMap String ping securityFlavor String
Legend: n: An integer of 2 or more. The following table describes the properties to be specified when sending a POST method request to the NFSShares/NFS-share-directory-name resource.
Table 3-111 Properties used to send a POST method request to the NFSShares/NFS-share-directory-name resource
Properties
NFSShare -anonymousUID -Sets the user ID used for access as an anonymous user. You can specify an ID from 0 to 65535. The default is 65534. Sets the group ID used for access as an anonymous user. You can specify an ID from 0 to 65535. The default is 65534. Sets whether only requests sent from an Internet port whose number is smaller than 1024 will be accepted. true Specify this value to limit the ports. false Specify this value to not limit the ports.
Description
Specification
-Optional
anonymousGID
Optional
isPortRestrictionEnabled
Optional
3-151
Properties
isSubtreeCheckEnabled
Description
Sets to check for whether execution permission (x) exists for all directories (subtrees), including the shared directory and the directory that contains the file or directory to be accessed. true Specify this value to check the subtree. false Specify this value to not check the subtree.
Specification
Optional
isAccessCheckWithLockReque stEnabled
Optional Sets whether to approve (check permission for) a lock request if one is sent. true Specify this value to approve a lock request. false Specify this value to not approve a lock request.
maxRwSize
Sets the maximum transfer length, from 4 to 1024 in KB, for the NFS share. --hostOrAddress
Optional
---
Sets the hosts allowed to access Required the NFS share. Specify 255 characters or fewer. The string cannot start with a hyphen (-). If you specify a host alias, the official host name also must be 255 characters or fewer. Note that the total length (specified length + 5 bytes) of the specified host names or network addresses must be less than 1,258 bytes. In addition to the host name and the IP address, you can use the following format: Netgroup Specify an NIS netgroup. For example, for @group, only host segment is extracted from the netgroup members. IP network To permit all hosts in the subnetwork to access the NFS share, specify the IP
3-152
Properties
Description
address and the netmask in the following format: address/netmask The netmask can be specified in dotted decimal format or as continuous masks. DNS domain Specify the name of the DNS domain to which NFS clients belong, with a period (.) added at the beginning of the name. Example: .example.com Wild card To specify all hosts, use an asterisk (*) as a wild card. When the NFS client machine has multiple network interfaces communicating with the HDI system, specify the hosts and networks allowed to access the NFS share in one of the following formats: Use a wild card (*). Specify the IP addresses of all network interfaces used on the NFS client side. Specify the host names for all network interfaces used on the NFS client side. Specify an IP network that contains the IP addresses of all network interfaces used on the NFS client side. Specify a netgroup that contains the host names for all network interfaces used on the NFS client side. Specify a DNS domain that contains the host names for all network interfaces used on the NFS client side.
Specification
isReadOnly
Sets whether to permit the NFS share to be read only. true Specify this value to set the share as read-only. false# Specify this value to not set the share as read-only.
Optional
3-153
Properties
Description
Specification
Optional
synchronousWri Sets whether to optimize tingSetting synchronous writing. This item is effective only when the isReadOnly property is false. rw_sync# Specify this value to not optimize synchronous writing. rw_sync_opt Specify this value to optimize synchronous writing. anonymousMap Sets this property to use ping mapping for the anonymous user. everyone Specify this value to map all users to the anonymous user. root_only# Specify this value to map only the root user to the anonymous user. none Specify this value if mapping to the anonymous user is not to be performed. securityFlavor Sets the security flavor. sys Specify this value to apply UNIX (AUTH_SYS) authentication. krb5 Specify this value to apply Kerberos authentication. krb5i Specify this value to apply data integrity verification in addition to Kerberos authentication. krb5p Specify this value to apply data integrity verification and provide privacy in addition to Kerberos authentication. default# Specify this value to apply the security flavor value indicated on the NFS
Optional
Optional
3-154
Properties
Description
Service Management page of the GUI.
Specification
#: This is the default value used when the property is omitted. The following shows an example of editing NFS share information by sending a POST method request to the NFSShares/NFS-share-directory-name resource.

https://host-name-or-IP-address:9090/mapi/NFSShares/NFS-sharedirectory-name

<?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>
Table 3-112 Status codes returned when a POST method request is sent to the NFSShares/NFS-share-directory-name resource
Status code
200 Other codes
Description
Deleting the specified NFS share by using the DELETE method

You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. The shared directory is not deleted even if an NFS share is deleted.
3-155
Table 3-113 Status codes returned when a DELETE method request is sent to the NFSShares/NFS-share-directory-name resource
Status code
200 Other codes
Description
Checking whether the specified NFS share exists by using the HEAD method
You must specify the path name of the shared directory by using the query parameter SHARE-DIRECTORY-NAME. The following table describes the status codes output when the method ends.
Table 3-114 Status codes returned when a HEAD method request is sent to the NFSShares/NFS-share-directory-name resource
Status code
200 Other codes
Description
The specified NFS share can be used. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
ProcessingNode
ProcessingNode resource overview
You can use the ProcessingNode resource to acquire cluster and node information and to set a host name. The following table describes the HTTP methods that can be used for the ProcessingNode resource.
Table 3-115 HTTP methods that can be used for the ProcessingNode resource
Resource URI
/ProcessingNode
HTTP method
GET POST
Cluster, single node Single node
Description
Acquires cluster and node information. Edits a host name.
3-156
ProcessingNode resource
This 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 and node information. The following table describes the structure of the response XML output when the method ends.
Table 3-116 Structure of the response XML when a GET method request is sent to the ProcessingNode resource
Properties
ProcessingNode -SystemConfiguration -status name LU mode 1 1 1 1 1 For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 For single-node configurations: 0 For cluster configurations: 1 Cluster N Cluster N Cluster N
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster

Y N N N N N
--
model
serial
ldev
3-157
Properties

For single-node configurations: 0 For cluster configurations: 2 For single-node configurations: 1
PhysicalNode
--
location hostName physicalNodeNa me status managementLA NAddress HBLanAddress BMCLanAddress resourceGroupS tatus resourceGroupE rrorInfo runningNode serial SystemVersion -name version
1 1 1 1 1 1 1 1 1 1 1 1 1 1
Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node Cluster, single node
N Y N N N N N N N N N N N N
Legend: Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the ProcessingNode resource.
3-158
Table 3-117 Properties displayed when a GET method request is sent to the ProcessingNode resource
Properties
ProcessingNode -SystemConfiguration -mode --Displays the configuration. CLUSTER The system is in a cluster configuration. SINGLE The system is in a single-node configuration. status Displays the status of the cluster. #1 ACTIVE The cluster is running. INACTIVE The cluster is stopped. UNKNOWN#2#3 The status cannot be determined. DISABLE The cluster is inoperable. UNDEF No clusters have been defined or the system is in a single-node configuration. name Displays the name of the cluster. A null string is displayed if no clusters have been defined or the system is in a single-node configuration. -model Displays the model of the storage subsystem to which the cluster management LU belongs. AMS Hitachi AMS2000 series or Hitachi AMS1500 USP_V Universal Storage Platform V USP_VM Universal Storage Platform VM VSP serial Virtual Storage Platform
Description
LU --
Displays the serial number of the storage subsystem to which the cluster management LU belongs. A null string is displayed if no clusters have been configured. Displays the LDEV number of the LU assigned to the cluster management LU. A null string is displayed if no clusters have been configured. --
ldev
PhysicalNode
3-159
Properties
-location
Description
Displays the unit name. A null string is displayed for the other node when no clusters have been configured. Displays the host name. UNDEF This is displayed for the other node when no clusters have been configured. Displays the node name. A null string is displayed if no clusters have been configured or the system is in a single-node configuration. Displays the status of the node. #1 UP The node is providing the services. DOWN The node is in a reset status. INACTIVE The node is in a planned shutdown status. UNKNOWN#2#3 The status cannot be determined. UNDEF No clusters have been defined or the system is in a single-node configuration.
hostName
physicalNodeName
status
managementLANAd dress
Displays the IP address of the management LAN. A null string is displayed if the IP address is not set or for the other node when no clusters have been configured. Displays the IP address of the heartbeat LAN. A null string is displayed if no clusters have been configured or the system is in a single-node configuration. 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 have been configured.
HBLanAddress
BMCLanAddress
resourceGroupStatu Displays the status of the resource group. s Online The resource group is active. Online Ready#4 The resource group cannot start because the cluster is inactive. This is displayed only for a cluster configuration. Online Pending The resource group is starting. Online Maintenance Monitoring is disabled. This is displayed only for a cluster configuration. Initializing
3-160
Properties
Description
The resource group is initializing. This is displayed only for a cluster configuration. Discovery (exclusivity) Online processing is being performed for the resource group before operations begin. This is displayed only for a cluster configuration. Offline#4 The resource group is in the planned shutdown status. Offline Pending The resource group is stopping. Internal Error An internal error was detected. This is displayed only for a cluster configuration. Partial Online The resources are partially blocked. This is displayed only for a cluster configuration. UNDEF No clusters have been defined. This is displayed only for a cluster configuration.
resourceGroupError Info
Displays error information for the resource group. No error The resource group is running normally. Internal error - not recoverable An unrecoverable internal error occurred. This is displayed only for a cluster configuration. Monitor activity unknown An error occurred during the processing to start or stop the maintenance mode. This is displayed only for a cluster configuration. No available nodes A monitoring error was detected on the last failover node. This is displayed only for a cluster configuration. Node not available(exclusivity) The HA service is inactive on the node to which the resource group is to be failed over. This is displayed only for a cluster configuration. Node unknown The resource group cannot start because the node status is UNKNOWN. This is displayed only for a cluster configuration. Split resource group(exclusivity) A duplicate resource group is active in the cluster. This is displayed only for a cluster configuration. srmd executable error
3-161
Properties
Description
The processing to start or stop the resource group failed. This is displayed only for a cluster configuration. OS error The processing to start or stop the resource group failed. This is displayed only for a cluster configuration. UNDEF No clusters have been defined. This is displayed only for a cluster configuration.
runningNode
Displays the name of the node on which the resource group is running. A null string is displayed if the name is not set, or if the system is in a single-node configuration. Displays the serial number. A null string is displayed if no clusters have been configured or if the node is the other node when communication with the other node is not available. -Displays the product name. Displays the version.
serial
SystemVersion -name version
#1: If an error occurs in the system, the status of cluster and nodes might not be displayed. In this case, collect the error information and contact the maintenance personnel. For details on how to collect error information, see the Hitachi Data Ingestor User's Guide. #2: If you execute the method for a stopped node, UNKNOWN is displayed for the 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 the method for the running node (the other node). #3: UNKNOWN is also displayed when a cluster starts up. Note that, when a cluster starts up, UNKNOWN is displayed until both OSs on the nodes making up the 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 a GET method request to the ProcessingNode resource.

https://host-name-or-IP-address:9090/mapi/ProcessingNode

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessingNode> <PhysicalNode> <hostName>D6BQLNBX</hostName> </PhysicalNode> </ProcessingNode>
3-162
Table 3-118 Status codes returned when a GET method request is sent to the ProcessingNode resource
Status code
200 Other codes
Description
Changing a host name by using the POST method

The following table describes the XML structure when a POST method request is sent to the ProcessingNode resource.
Table 3-119 XML structure when a POST method request is sent to the ProcessingNode resource
Properties
ProcessingNode
Data type
--

For cluster configurations: 0 For single-node configurations: 1 For cluster configurations: 0 For single-node configurations: 1 For cluster configurations: 0 For single-node configurations: 1
Single node
--
PhysicalNode
--
Single node
--
hostName
String
Single node
The following table describes the properties to be specified when sending a POST method request to the ProcessingNode resource.
Table 3-120 Properties used to send a POST method request to the ProcessingNode resource
Properties
ProcessingNode -PhysicalNode -hostName --Sets the host name. You can use alphanumeric characters and hyphens (-). The first character must be a letter. You cannot specify a hyphen at the end
Description
Specification
--Required
3-163
Properties
Description
of the string. The name must be no more than 15 bytes long.
Specification
The following shows an example of changing the host name by sending a POST method request to the ProcessingNode resource.

https://host-name-or-IP-address:9090/mapi/ProcessingNode

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessingNode> <PhysicalNode> <hostName>NewHostName</hostName> </PhysicalNode> </ProcessingNode>
Table 3-121 Status codes returned when a POST method request is sent to the ProcessingNode resource
Status code
200 Other codes
Description
Routings
Routings resource overview
You can use the Routings resource to acquire, add, and delete routing information. The following table describes the HTTP methods that can be used for the Routings resource.
Table 3-122 HTTP methods that can be used for the Routings resource
Resource URI
/Routings
HTTP method
GET POST
Description
Acquires routing information. Adds or deletes routing information.
3-164
Routings resource
This 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 is sent to the Routings resource
Properties
Routings -Routing -name type target netmask gateway isReject mss

1 0 or 1 to n 1 1 1 1 1 1 1

Y Y Y Y Y Y Y Y N
Legend: n: An integer of 2 or more, Y: Displayed, N: Not displayed. The following table describes the properties displayed when a GET method request is sent to the Routings resource.
Table 3-124 Properties displayed when a GET method request is sent to the Routings resource
Properties
Routings -Routing -name --Displays the interface name in one of the following formats: ethnumber agrnumber rdnnumber
Description
3-165
Properties
type#1 mng0
Description
Displays the method for setting the routing destination. net A network is set. host A host is set.
default The default route is set. target#2 Displays the routing destination as a host name, an IP address, or a network address. If the default route is set, default is displayed. Displays the netmask when a network is set as the routing destination. If a host is set, a null string is displayed. If the default route is set, 0.0.0.0 is displayed. Displays the host name or IP address of the gateway. If no gateway is set, a null string is displayed. Displays whether to reject the destination target. true The destination target is rejected. false The destination target is not rejected. mss Displays the maximum segment size for TCP connections over the route. If no maximum segment size is set, a null string is displayed.
netmask#1
gateway isReject
Note: Do not add multiple instances of routing information that have the same routing target. If this is done, you might not be able to delete the routing information correctly. Do not set routing information whose settings (except for the gateway setting) are the same as those of existing routing information. If this is done, 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, the routing information operates as the default route. - If net is selected for type, and 255.255.255.255 is specified for netmask, the routing information operates the same as when the host is directly specified for the routing target. #2: Do not specify the IP addresses shown below as the routing target. These addresses are reserved in the storage subsystem. If you must specify them, contact our Technical Support Center. - 127.0.0.0 to 127.255.255.255
3-166
- IP addresses that belong to the same network as the IP address set for the private maintenance port - IP addresses that belong to the same network as the IP address set for the heartbeat port You can use the pmctl command to view the IP address set for the private maintenance port. For details on the pmctl command, see the Hitachi Data Ingestor CLI User's Guide. You can use the ProcessingNode resource to view the IP address set for the heartbeat port. For details on the ProcessingNode resource, see ProcessingNode resource on page 3-157. The following shows an example of acquiring routing information by sending a GET method request to the Routings resource.

https://host-name-or-IP-address:9090/mapi/Routings

<?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>
Table 3-125 Status codes returned when a GET method request is sent to the Routings resource
Status code
200 Other codes
Description
Adding or deleting routing information by using the POST method

The following table describes the XML structure when a POST method request is sent to the Routings resource.
3-167
Table 3-126 XML structure when a POST method request is sent to the Routings resource
Properties
Routing -operation name type target netmask gateway isReject -String String String String String String Boolean
Data type

1 1 1 1 0 or 1 0 or 1 0 or 1 0 or 1
The following table describes the properties to be specified when sending a POST method request to the Routings resource.
Table 3-127 Properties used to send a POST method request to the Routings resource
Properties
Routing -operation -Sets the operation to be performed on the routing information. Add Specify this value to add routing information. Delete Specify this value to delete routing information. name Sets the name of the interface to Required which routing information will be added. type ethnumber agrnumber rdnnumber Required if Add is specified for the operation property.
Description
--
Specification
Required
Sets how the routing destination is set. net
3-168
Properties
Description
Specify this value to set the network as the routing destination. host Specify this value to set the host as the routing destination.
Specification
default Specify this value to set the default route. target Sets the host name, IP address, or network address of the routing destination. Required if Add is specified for the operation property and net or host is specified for the type property. Required if Delete is specified for the operation property.
netmask gateway
Sets the netmask. Sets the host name or IP address of the gateway. If you omit this, no value is set.
Required if net is specified for the type property. Required if default is specified for the type property and false is specified or will be specified for the isReject property. Optional if net or host is specified for the type property. Can be set if Add is specified for the operation property. true must be specified if default is specified for the type property and the gateway property is not specified
isReject
Sets whether a path for the routing information will be rejected. true Specify this value to reject a path. false# Specify this value to set a path.
#: This is the default value used when the property is omitted. The following shows an example of adding routing information by sending a POST method request to the Routings resource.

https://host-name-or-IP-address:9090/mapi/Routings
3-169

<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>
Table 3-128 Status codes returned when a POST method request is sent to the Routings resource
Status code
200 Other codes
Description
SystemController
SystemController resource overview
You can use the SystemController resource to control services and OSs. The following table describes the HTTP methods that can be used for the SystemController resource.
Table 3-129 HTTP methods that can be used for the SystemController resource
Resource URI
/SystemController
HTTP method
GET
Description
In a cluster configuration, this method checks whether a service needs to be restarted. In a single-node configuration, this method checks whether a service or the OS needs to be restarted. In a cluster configuration, this method restarts a service. In a single-node configuration, this method restarts a service or the OS. In a cluster configuration, this method stops the OS on a node. In a single-node configuration, this method
POST
/SystemController/ OS
POST
3-170
Resource URI
HTTP method
Description
restarts or stops the OS on a node.
SystemController resource
This section describes how to use the SystemController resource.
Checking whether the service or OS needs to be restarted by using the GET method
Table 3-130 Structure of the response XML when a GET method request is sent to the SystemController resource
Properties
Services -Service -serviceName isRestart

1 1 to n 1 1

Y Y Y Y#
Legend: n: An integer of 2 or more, Y: Displayed. #: In a cluster configuration, whether the OS needs to be restarted is not displayed. The following table describes the properties displayed when a GET method request is sent to the SystemController resource.
Table 3-131 Properties displayed when a GET method request is sent to the SystemController resource
Properties
Services -Service -serviceName --Displays the service name. CIFS CIFS service FTP FTP service
Description
3-171
Properties
NFS OS NFS service
Description
OS. This is displayed only for a single-node configuration.
isRestart
Displays whether the service or OS needs to be restarted. true The service or OS needs to be restarted. false The service or OS does not need to be restarted.
The following shows an example of checking whether the service and OS need to be restarted by sending a GET method request to the SystemController resource.

https://host-name-or-IP-address:9090/mapi/SystemController

<?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>
Table 3-132 Status codes returned when a GET method request is sent to the SystemController resource
Status code
200 Other codes
Description
3-172
Restarting the service or OS by using the POST method

The following table describes the XML structure when a POST method request is sent to the SystemController resource.
Table 3-133 XML structure when a POST method request is sent to the SystemController resource
Properties
Services -service -serviceName isRestart --String String
Data type

1 1 to n 1 1
Legend: n: An integer of 2 or more. The following table describes the properties to be specified when sending a POST method request to the SystemController resource.
Table 3-134 Properties used to send a POST method request to the SystemController resource
Properties
Services -service -serviceName --In a cluster configuration, this property sets the service name. In a single-node configuration, this property sets the service name or OS. CIFS Specify this value to control the CIFS service. FTP Specify this value to control the FTP service. Specify this value to control the NFS service. Specify this value to control the OS in a single-node configuration. Required
Description
---
Specification
Required
NFS
OS
isRestart
In a cluster configuration, this property sets whether to restart the
3-173
Properties
Description
service. In a single-node configuration, this property sets whether to restart the service or OS. true Specify this value to restart a service or the OS. false Specify this value to not restart a service or the OS.
Specification
The following shows an example of restarting the service and OS by sending a POST method request to the SystemController resource.

https://host-name-or-IP-address:9090/mapi/SystemController

<?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>
Table 3-135 Status codes returned when a POST method request is sent to the SystemController resource
Status code
200 Other codes
Description
SystemController/OS resource
This section describes how to use the SystemController/OS resource.
3-174
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 POST method request to both nodes at the same time. If you do not send the method to both nodes at the same time, a failover might occur. The following table describes the XML structure when a POST method request is sent to the SystemController/OS resource.
Table 3-136 XML structure when a POST method request is sent to the SystemController/OS resource
Properties
Service -operation -String
Data type

1 1
The following table describes the properties to be specified when sending a POST method request to the SystemController/OS resource.
Table 3-137 Properties used to send a POST method request to the SystemController/OS resource
Properties
Service -operation -Sets the operation to be performed for the OS on the node. Reboot Restarts the OS. This can be specified only in a single-node configuration. Shutdown Stops the OS. Execute on both nodes in a cluster configuration.
Description
--
Specification
Required
The following shows an example of stopping the OS on the node by sending a POST method request to the SystemController/OS resource.

https://host-name-or-IP-address:9090/mapi/SystemController/OS

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Service>
3-175
<operation>Shutdown</operation> </Service>
Table 3-138 Status codes returned when a POST method request is sent to the SystemController/OS resource
Status code
202 Other codes
Description
The method request was accepted. Execution of the method ended abnormally. See Table 1-3 HTTP status codes that can be generated when a request terminates abnormally on page 1-9.
3-176
A
API Usage Examples
This appendix shows examples of using the HDI API. Example of acquiring cluster and node information in a cluster configuration 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 Hitachi Data Ingestor API Reference
A-1
Example of acquiring cluster and node information in a cluster configuration

This section provides an example of acquiring cluster and node information in a 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-IPaddress:9090/mapi/ProcessingNode?prettyprint" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Wed, 27 Apr 2011 23:22:02 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 251 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get node details, [2]Get system details Connection: close Content-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-IPaddress:9090/mapi/ProcessingNode?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 27 Apr 2011 23:22:03 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1751 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get node details, [2]Get system details Connection: close Content-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
<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-node configuration

This section provides an example of editing the host name in a single-node 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-IPaddress:9090/mapi/ProcessingNode?prettyprint" -k -X GET -H "Accept: application/xml" Response:
A-3
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:45:22 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 168 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get node details, [2]Get system details Connection: close Content-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-IPaddress:9090/mapi/ProcessingNode?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:45:24 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 900 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get node details, [2]Get system details Connection: close Content-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>
A-4
<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-IPaddress:9090/mapi/ProcessingNode" -k -d @hostNameset.xml -X POST -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:45:26 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Edit host name Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/SystemController?prettyprint" -k -X GET -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:45:27 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 495 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get service statuses Connection: close Content-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>
A-5
<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-IPaddress:9090/mapi/SystemController" -k -d @osReboot.xml -X POST H "Content-Type: application/xml" Response: HTTP/1.1 202 Accepted Date: Mon, 11 Apr 2011 05:45:28 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Restart OS Connection: close Transfer-Encoding: chunked Content-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 status

This section provides an example of monitoring the hardware status. 1. Acquire the hardware information. Command line:
A-6
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/Hardware?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Tue, 12 Apr 2011 05:30:27 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 7994 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get hardware details Connection: close Content-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>
A-7
<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>
A-8
</Memory> <Memory> <slotName>5</slotName> <status>Installed</status> <vendorInformation>locator:P1C2D0,size:2048 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 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 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 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>
MB</
MB</
MB</
MB</
A-9
<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) vendorInformation> </Temperature> <Temperature> <temperatureName>1</temperatureName> <status>OK</status> <vendorInformation>reading:44 (+/- 0.500) vendorInformation> </Temperature> <Temperature> <temperatureName>2</temperatureName> <status>OK</status> <vendorInformation>reading:42 (+/- 0.500) vendorInformation> </Temperature> <Temperature> <temperatureName>3</temperatureName> <status>OK</status> <vendorInformation>reading:39 (+/- 0.500) vendorInformation>
degrees C</
degrees C</
degrees C</
degrees C</
A-10
</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-IPaddress:9090/mapi/FCPaths?prettyprint" -k -X GET -H "Accept: application/xml"
Response:
HTTP/1.1 200 OK Date: Tue, 12 Apr 2011 02:43:12 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 809 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get FC path details Connection: close Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FCPaths> <FCPath>
A-11
<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 network

This 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-IPaddress:9090/mapi/NetworkInterfaces?prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:19 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 2825 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get network interface details Connection: close Content-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>
A-12
</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>
A-13
<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-IPaddress:9090/mapi/NetworkInterfaces?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:21 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 3398 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get network interface details Connection: close Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <NetworkInterfaces>
A-14
<NetworkInterface> <name>eth12</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth13</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth14</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth15</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth16</name> <mtu></mtu>
A-15
<netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth17</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth18</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>eth19</name> <mtu></mtu> <netmask></netmask> <networkAddress></networkAddress> <FixedIP> <target></target> <other></other> </FixedIP> <ServiceIP> <target></target> <other></other> </ServiceIP> </NetworkInterface> <NetworkInterface> <name>mng0</name> <mtu>1500</mtu> <netmask>255.255.252.0</netmask> <networkAddress>10.213.88.0</networkAddress> <FixedIP>
A-16
<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-IPaddress:9090/mapi/NetworkInterfaces" -k -d @ifset.xml -X PUT -H "Content-Type: application/xml" Response:
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:23 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Set network interface Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/NetworkInterfaces/eth12" -k -X HEAD -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:35 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 300 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get network interface details Connection: close Content-Type: application/xml
A-17
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-IPaddress:9090/mapi/NetworkInterfaces/eth12?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:37 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 369 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get network interface details Connection: close Content-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-IPaddress:9090/mapi/NetworkInterfaces/eth12? prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:39 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 439 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get network interface details Connection: close Content-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>
A-18
<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-IPaddress/mapi/NetworkInterfaces/eth12" -k -d @ifmod.xml -X POST H "Content-Type: application/xml" Response:
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:24:42 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Edit network interface Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/Routings?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:25:01 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 306 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get routing details Connection: close Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Routings> <Routing> <name>mng0</name> <type>default</type>
A-19
<target>default</target> <netmask>0.0.0.0</netmask> <gateway>10.213.88.10</gateway> <isReject>false</isReject> </Routing> </Routings>

curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/Routings?prettyprint&verbose=true" -k -X GET H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:25:02 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 326 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get routing details Connection: close Content-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-IPaddress:9090/mapi/Routings" -k -d @rtset.xml -X POST -H "ContentType: application/xml"
Response:
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 13:25:03 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1
A-20
X-NODE-OperationList: [1]Add routing details Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
Example of setting HCP information

This 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-IPaddress:9090/mapi/HCP?prettyprint" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 12 Apr 2011 13:13:19 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 214 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get HCP settings Connection: close Content-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-IPaddress:9090/mapi/HCP" -k -d @hcpset.xml -X POST -H "ContentType: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 12 Apr 2011 13:13:20 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Configure HCP settings, [2]Set regular
A-21
backup of system settings information Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
Example of creating a file system in a cluster configuration

This section provides an example of creating a file system in a cluster configuration. 1. Acquire the LU information. Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/LUs?prettyprint" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:29 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 19272 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get LU details Connection: close Content-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>
A-22
<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>
A-23
<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>
A-24
<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>
A-25
<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>
A-26
<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>
A-27
</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>
A-28
<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>
A-29
<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>
A-30
<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>
A-31
<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>
A-32
<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>
A-33
<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-IPaddress:9090/mapi/FileSystems?prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:35 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 2167 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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>
A-34
<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-IPaddress:9090/mapi/FileSystems?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:38 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 4399 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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>
A-35
<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>
A-36
<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>
<LU>
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>
A-37
<deviceFileName>lu04</deviceFileName> </LU> <LU> <deviceFileName>lu05</deviceFileName> </LU> </LUs> </FileSystem>
<LUs> <LU>
Command line:
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems" -k -d @fscreate.xml -X PUT -H "Content-Type: application/xml"
Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:42 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Create file system Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/MountSetting?prettyprint" -k -X GET -H "Accept: application/xml"
Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:55 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 232 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MountSetting> <isMounted>false</isMounted> <isReadOnly></isReadOnly> <isFileLastAccessTimeRecordingEnabled></ isFileLastAccessTimeRecordingEnabled> </MountSetting>

curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems/fs/MountSetting? prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"
Response:
A-38
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:56:58 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 264 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/MountSetting" -k -d @fsmount.xml -X POST -H "Content-Type: application/xml"
Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:01 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Mount file system Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/?prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:13 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 734 X-NODE-APIVersionID: 03-00-00-00-00
A-39
X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/?prettyprint&verbose=true" -k X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:17 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1424 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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>
A-40
<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-IPaddress:9090/mapi/FileSystems/fs/" -k -d @fsmod.xml -X POST -H "Content-Type: application/xml"
Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:20 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Expand file system, [2]Edit file system Content-Length: 0
A-41
Connection: close Content-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-IPaddress:9090/mapi/CIFSShares?prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:34 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1732 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-42
<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-IPaddress:9090/mapi/CIFSShares?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:35 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1771 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-43
<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-IPaddress:9090/mapi/CIFSShares" -k -d @cifscreate.xml -X PUT -H "Content-Type: application/xml"
Response:
A-44
HTTP/1.1 100 Continue HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:36 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 4 X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create CIFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORYNAME=L21udC9mcy9jaWZz&prettyprint" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:49 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1645 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-45
<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-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORYNAME=L21udC9mcy9jaWZz&prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:50 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1681 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-46
<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-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORYNAME=L21udC9mcy9jaWZz" -k -X POST -d @cifsmod.xml -H "ContentType: application/xml"
Response:
HTTP/1.1 100 Continue HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:52 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Edit CIFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/NFSShares?prettyprint" -k -X GET -H "Accept: application/xml" Response:
A-47
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:55 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 886 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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-IPaddress:9090/mapi/NFSShares?prettyprint&verbose=true" -k -X GET H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:56 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 925 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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>
A-48
<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>
A-49
Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/NFSShares" -k -d @nfscreate.xml -X PUT -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:57:58 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 4 X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create NFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/ nfs&prettyprint" -k -X GET -H "Accept: application/xml"
Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:58:15 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 785 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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>
A-50
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress: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 OK Date: Tue, 19 Apr 2011 07:58:16 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 821 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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>
A-51
</AllowedHosts> </NFSShare> curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress: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 OK Date: Tue, 19 Apr 2011 07:58:17 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Edit NFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/HCP/ACCESS" -k -d @hcpaccess.xml -X POST -H "Content-Type: application/xml"
Response: HTTP/1.1 200 OK Date: Thu, 21 Apr 2011 00:50:22 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Test namespace connection Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/MigrationTask?prettyprint" -k -X GET -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:58:23 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 74 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-Type: application/xml
A-52
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MigrationTasks/>

curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:19:07 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 74 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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-starttime>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</policydescription> </MigrationTask> Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask" -k -d @policyset.xml -X PUT -H "Content-Type: application/xml" Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:58:39 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 3 X-NODE-OperationList: [1]Configure HCP settings, [2]Set migration policy, [3]Set migration task schedule Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
19. Acquire the information about the specified migration policy.
A-53
Command line when verbose is not specified: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask/cG9saWN5?prettyprint" -k -X GET H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:59:04 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 505 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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-starttime>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</policydescription> </MigrationTask>
Command line when true is specified for verbose: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask/cG9saWN5? prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:59:12 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 599 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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)</taskstatus> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-start-
A-54
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</policydescription> </MigrationTask>
20. Edit the specified migration policy. policymod.xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MigrationTask> <schedule-starttime>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-IPaddress:9090/mapi/MigrationTask/cG9saWN5" -k -d @policymod.xml X POST -H "Content-Type: application/xml"
Response:
HTTP/1.1 200 OK Date: Tue, 19 Apr 2011 07:59:19 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Cancel migration task schedule, [2]Set migration task schedule Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
Example of creating a file system in a single-node configuration

This section provides an example of creating a file system in a single-node configuration. 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-IPaddress:9090/mapi/Disk?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:06:55 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 71 X-NODE-APIVersionID: 03-00-00-00-00
A-55
X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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-IPaddress:9090/mapi/FileSystems?prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:06:55 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 71 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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-IPaddress:9090/mapi/FileSystems?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:06:56 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 71 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details
A-56
Connection: close Content-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-IPaddress:9090/mapi/FileSystems" -k -d @fscreate_single.xml -X PUT -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:06:56 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1
A-57
X-NODE-OperationList: [1]Create file system Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/MountSetting?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:00 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 232 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-Type: application/xml
Command line when true is specified for verbose: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems/fs/MountSetting? prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:01 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 264 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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"?>
A-58
<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-IPaddress:9090/mapi/FileSystems/fs/MountSetting" -k -d @fsmount.xml -X POST -H "Content-Type: application/xml"
Response:
HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:02 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Mount file system Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/?prettyprint" -k -X GET -H "Accept: 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>

curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems/fs/?prettyprint&verbose=true" -k X GET -H "Accept: application/xml"
A-59
<?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-IPaddress:9090/mapi/FileSystems/fs/" -k -d @fsmod_single.xml -X POST -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:09 GMT
A-60
Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Expand file system, [2]Edit file system Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/CIFSShares?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:13 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 70 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-61
<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-IPaddress:9090/mapi/CIFSShares?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:14 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 70 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-62
<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:
A-63
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/CIFSShares" -k -d @cifscreate.xml -X PUT -H "Content-Type: application/xml"
Response: HTTP/1.1 100 Continue

HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:16 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 4 X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create CIFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORYNAME=L21udC9mcy9jaWZz&prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:26 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1631 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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</
A-64
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-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORYNAME=L21udC9mcy9jaWZz&prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:27 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1667 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-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>
A-65
<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-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJl?SHARE-DIRECTORYNAME=L21udC9mcy9jaWZz" -k -X POST -d @cifsmod.xml -H "ContentType: application/xml" Response: HTTP/1.1 100 Continue
HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:29 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Edit CIFS share Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
12. Acquire the NFS share information. Command line when verbose is not specified:
A-66
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/NFSShares?prettyprint" -k -X GET -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:33 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 69 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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-IPaddress:9090/mapi/NFSShares?prettyprint&verbose=true" -k -X GET H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:34 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 69 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <NFSShares> <NFSShare>
A-67
<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>
A-68
<accessPermission>r</accessPermission> </DirectoryACLSetting> </DirectoryACLSettings> </NFSShare>
Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/NFSShares" -k -d @nfscreate.xml -X PUT -H "Content-Type: application/xml" Response: HTTP/1.1 100 Continue
HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:35 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 4 X-NODE-OperationList: [1]Create shared directory, [2]Edit shared directory, [3]Set ACL, [4]Create NFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/ nfs&prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:44 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 785 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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>
A-69
<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-IPaddress: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 OK Date: Wed, 13 Apr 2011 08:07:45 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 821 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-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>
A-70
<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-IPaddress: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 OK Date: Wed, 13 Apr 2011 08:07:47 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Edit NFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/HCP/ACCESS" -k -d @hcpaccess.xml -X POST -H "Content-Type: application/xml" Response:
HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:49 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Test namespace connection Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/MigrationTask?prettyprint" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:51 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk
A-71
Content-Length: 74 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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-IPaddress:9090/mapi/MigrationTask?prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:55 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 74 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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>
A-72
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-starttime>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</policydescription> </MigrationTask> Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask" -k -d @policyset.xml -X PUT -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:07:59 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 3 X-NODE-OperationList: [1]Configure HCP settings, [2]Set migration policy, [3]Set migration task schedule Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/MigrationTask/cG9saWN5?prettyprint" -k -X GET H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:08:21 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 584 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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-
A-73
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</policydescription> </MigrationTask>
Command line when true is specified for verbose: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask/cG9saWN5? prettyprint&verbose=true" -k -X GET -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:08:25 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 686 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-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)</taskstatus> <fileSystemName>fs</fileSystemName> <namespace>arc-test</namespace> <schedule-starttime>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</policydescription> </MigrationTask>
20. Edit the information about the specified migration policy. policymod.xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MigrationTask> <schedule-starttime>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:
A-74
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask/cG9saWN5" -k -d @policymod.xml X POST -H "Content-Type: application/xml"
Response:
HTTP/1.1 200 OK Date: Wed, 13 Apr 2011 08:08:29 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Cancel migration task schedule, [2]Set migration task schedule Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
Example of deleting a file system

This 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-IPaddress:9090/mapi/MigrationTask/cG9saWN5" -k -X HEAD -H "Accept: application/xml"
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:38:52 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 492 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 2 X-NODE-OperationList: [1]Get migration policy details, [2]Get HCP settings Connection: close Content-Type: application/xml 2. Delete the specified migration policy. Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/MigrationTask/cG9saWN5" -k -X DELETE -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:38:58 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Delete migration policy Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1 3. Check whether the specified CIFS share exists.
A-75
Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJlY2hhbmdl?SHAREDIRECTORY-NAME=L21udC9mcy9jaWZz" -k -X HEAD -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:02 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 1499 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get CIFS share details Connection: close Content-Type: application/xml 4. Delete the specified CIFS share. Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/CIFSShares/Y2lmc3NoYXJlY2hhbmdl?SHAREDIRECTORY-NAME=L21udC9mcy9jaWZz" -k -X DELETE -H "Accept: application/xml" Response:
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:03 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Delete CIFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/ nfs" -k -X HEAD -H "Accept: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:05 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 658 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get NFS share details Connection: close Content-Type: application/xml
6.
Delete the specified NFS share. Command line: curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/NFSShares/nfs?SHARE-DIRECTORY-NAME=/mnt/fs/ nfs" -k -X DELETE -H "Accept: application/xml"
A-76
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:07 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Delete NFS share Content-Length: 0 Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/" -k -X HEAD -H "Content-Type: application/xml" Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:11 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk Content-Length: 685 X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Get file system details Connection: close Content-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-IPaddress:9090/mapi/FileSystems/fs/MountSetting" -k -d @fsumount.xml -X POST -H "Content-Type: application/xml"
Response: HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:14 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Unmount file system Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1 9. Delete the specified file system. Command line:
A-77
curl -i -b api-auth=user-name:password "https://host-name-or-IPaddress:9090/mapi/FileSystems/fs/" -k -X DELETE -H "ContentType: application/xml"
Response:
HTTP/1.1 200 OK Date: Mon, 11 Apr 2011 05:39:27 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Delete file system Content-Length: 0 Connection: close Content-Type: text/plain; charset=iso-8859-1
Example of stopping the OS in a cluster configuration

This section provides an example of stopping the OS in a cluster configuration. 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-IPaddress-of-one-node:9090/mapi/SystemController/OS -k -d @osShutdown.xml -X POST -H Content-Type: application/xml
Response: HTTP/1.1 202 Accepted Date: Tue, 12 Apr 2011 13:21:18 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Shutdown OS Connection: close Transfer-Encoding: chunked Content-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-IPaddress-of-other-node:9090/mapi/SystemController/OS -k -d @osShutdown.xml -X POST -H Content-Type: application/xml
A-78
Response: HTTP/1.1 202 Accepted Date: Tue, 12 Apr 2011 13:21:19 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Shutdown OS Connection: close Transfer-Encoding: chunked Content-Type: text/html;charset=utf-8
Example of stopping the OS in a single-node configuration

This section provides an example of stopping the OS in a single-node configuration. 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-IPaddress:9090/mapi/SystemController/OS" -k -d @osShutdown.xml -X POST -H "Content-Type: application/xml" Response: HTTP/1.1 202 Accepted Date: Mon, 11 Apr 2011 14:37:18 GMT Server: Hitachi Web Server 04-00 (Unix) mod_jk X-NODE-APIVersionID: 03-00-00-00-00 X-NODE-CompletedOperation: 1 X-NODE-OperationList: [1]Shutdown OS Connection: close Transfer-Encoding: chunked Content-Type: text/html;charset=utf-8
A-79
A-80
Acronyms
This section lists the acronyms used in the HDI manuals.
A
ABE Access Based Enumeration ACE access control entry ACL access control list AJP Apache JServ Protocol API application programming interface ARP Address Resolution Protocol ASCII American Standard Code for Information Interchange ASN Abstract 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-1
BDC Backup Domain Controller BMC baseboard management controller
C
CA
certificate authority
CHA channel adapter CHAP Challenge-Handshake Authentication Protocol CIFS Common Internet File System CIM Common Information Model CLI command line interface COBOL Common Business-Oriented Language CPU central processing unit CSR certificate signing request CSV comma-separated values CTL controller CU CV
control unit
Acronyms-2
custom volume
D
DACL discretionary access control list DAR Direct Access Recovery DB
database
DBMS database management system DC

domain controller
DEP data execution prevention DES Data Encryption Standard DFS distributed file system DIMM dual in-line memory module DLL dynamic-link library DN distinguished name DNS Domain Name System DOM Document Object Model DOS Disk Operating System
Acronyms-3
DRAM dynamic random access memory DSA digital signal algorithm DTD Document Type Definition
E
ECC error-correcting code EUC Extended UNIX Code
F
FC
Fibre Channel
FIB forwarding information base FIFO First In, First Out FQDN fully qualified domain name FTP File Transfer Protocol FV
Fixed Volume
FXP File Exchange Protocol
Acronyms-4
GbE Gigabit Ethernet GID group identifier GMT Greenwich Mean Time GPL GNU General Public License GUI graphical user interface
H
HBA host bus adapter H-LUN host logical unit number HPFS High Performance File System HSSO HiCommand single sign-on HTML HyperText Markup Language HTTP Hypertext Transfer Protocol HTTPS Hypertext Transfer Protocol Secure
I
I/O input/output ICAP
Acronyms-5
Internet Content Adaptation Protocol
ICMP Internet Control Message Protocol ID IP

identifier
Internet Protocol
IP-SW IP switch
J
JIS Japanese Industrial Standards JSP JavaServer Pages
K
KDC Key Distribution Center
L
LACP Link Aggregation Control Protocol LAN local area network LBA logical block addressing LCD Local Configuration Datastore LDAP
Acronyms-6
Lightweight Directory Access Protocol
LDEV logical device LDIF LDAP Data Interchange Format LDKC logical disk controller LED light-emitting diode LF
Line Feed
LTS long term support LU

logical unit
LUN logical unit number LUSE logical unit size expansion LVI Logical Volume Image LVM Logical Volume Manager
M
MAC Media Access Control MD5 Message-Digest algorithm 5 MIB management information base
Acronyms-7
MMC Microsoft Management Console MP microprocessor MSS maximum segment size MTU maximum transmission unit
N
NAS Network-Attached Storage NAT network address translation NDMP Network Data Management Protocol NetBIOS Network Basic Input/Output System NFS Network File System NIC network interface card NIS Network Information Service NTFS New Technology File System NTP Network Time Protocol
O
OID
Acronyms-8
object identifier
ORB object request broker OS

operating system
P
PAP Password Authentication Protocol PC
personal computer
PCI Peripheral Component Interconnect PDC Primary Domain Controller PDU protocol data unit PID process identifier POSIX Portable Operating System Interface for UNIX PP
program product
R
RADIUS Remote Authentication Dial In User Service RAID Redundant Array of Independent Disks RAM random access memory
Acronyms-9
RAS Reliability Availability Serviceability RCS Revision Control System RD

relational database
RFC Request for Comments RID relative identifier RPC remote procedure call RSA Rivest, Shamir, and Adleman
S
SACL system access control list SAN storage area network SAS Serial Attached SCSI SATA serial ATA SAX Simple API for XML SCSI Small Computer System Interface SHA secure hash algorithm SID
Acronyms-10
security identifier
SJIS Shift JIS SLPR Storage Logical Partition SMB Server Message Block SMD5 Salted Message Digest 5 SNMP Simple Network Management Protocol SOAP Simple Object Access Protocol SP
service pack
SSD solid-state drive SSH Secure Shell SSHA Salted Secure Hash Algorithm SSL Secure Sockets Layer SSO single sign-on SVGA Super Video Graphics Array
T
TCP Transmission Control Protocol
Acronyms-11
TOS type of service TTL time to live
U
UAC User Account Control UDP User Datagram Protocol UID user identifier UNC Universal Naming Convention URI Uniform Resource Identifier URL Uniform Resource Locator UTC Coordinated Universal Time UTF UCS Transformation Format
V
VDEV Virtual Device VLAN virtual LAN VLL Virtual LVI/LUN
Acronyms-12
W
WADL Web Application Description Language WAN wide area network WINS Windows Internet Name Service WORM Write Once, Read Many WS workstation WWN World Wide Name WWW World Wide Web
X
XDR External Data Representation XFS extended file system XML Extensible Markup Language
Acronyms-13
Acronyms-14
Glossary
This glossary explains the terms used in the HDI manuals.
A
ACE An entry in an ACL. An ACE sets access permissions for directories and files for each user and group. ACE formats differ depending on the ACL type. ACL A list of all the ACEs for a particular directory or file. An ACL defines the access permissions for a particular directory or file. ACL type The type of file system or file that is supported by the ACL. The ACL types that can be used in HDI systems are the Advanced ACL type (compatible with NTFS ACL), and the Classic ACL type (compatible with POSIX ACL). Anti Virus Agent A program used to scan, in real time, for viruses in data shared with users via CIFS in an HDI system.
B
Backup Restore A program used for backing up data in an HDI file system. backup server A server that manages backup and restore operations by using backup management software.
W X
Glossary-1
C
CIFS A protocol that provides file-sharing services to Windows users. cluster A redundant configuration that enables a service to continue when an error occurs or maintenance work is performed. cluster management LU An LU that is assigned to a node and stores settings information, such as cluster configuration information and file system information. command device A control device used to receive commands that control storage subsystems. Configuration Manager A program used to set up an HDI system and manage file system operations.
D
Data Control One of the programs on a node OS. data port A node port that is used to connect to the front-end LAN. device file A user LU. For more information, see user LU. Device Manager A program that manages disk resources and the hardware configuration of storage subsystems in an integrated manner. differential-data snapshot A 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 device A storage subsystem volume for saving file system pre-update data that is used by differential-data snapshots of Sync Image. Dynamic Provisioning A function that virtually allocates volumes of a given capacity to a host independent of the physical capacity of the storage subsystem.
W X
Glossary-2
E
end user Among the clients who access the HDI service, a user who can check the status of the file system usage from a computer on the network.
F
failback The relocation of a failed-over resource group back to its original node in the cluster after an error has been recovered on the node or maintenance on the node is complete. failover The relocation of a resource group to the other node in a cluster when an error occurs on a node or when maintenance on a node is required. Failovers enable continuous operation of the services provided by an HDI system. File Sharing One of the programs on a node OS. fixed IP address An IP address set for a specific interface in a node. front-end LAN A LAN used by a client to access the data stored in a storage subsystem.
H
HBase Storage Mgmt Common Service The Web-container service for Hitachi Command Suite Common Component. HBase Storage Mgmt Web Service The Web-server service for Hitachi Command Suite Common Component. heartbeat LAN A LAN used by each node in a cluster to check the operating status of the other node. Hitachi Command Suite Common Component A component that provides functions, such as being able to log in to the GUI, outputting management server integrated logs, and Web services, common to all Hitachi File Services Manager and Hitachi Command Suite products. Hitachi Content Platform (HCP)
W X
Glossary-3
A system used for managing and storing data for long periods of time. File system data created 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 Manager A program necessary for system administrator to operate or manage an HDI system from a GUI.
I
incremental backup Incremental backup is a backup method that targets only data that has changed after the previous backup was performed.
L
LDEV A unit of storage that is created by logically partitioning a storage area within a RAID group of a storage subsystem. Although referred to as an LDEV in File Services Manager, it is referred to as a logical unit (LU) in Hitachi AMS2000 series and Hitachi AMS1500 storage subsystems. logical volume An area created by using a volume manager to divide a volume group into one or more areas. In HDI systems, this area corresponds to a file system, differential-data storage device, or differential-data snapshot created using the volume manager. LU
An LDEV that is assigned to a port in a storage subsystem.
LUN A management number assigned to each LU in a storage subsystem. Although referred to as an LUN in File Services Manager, it is referred to as an H-LUN in the Hitachi AMS2000 series and Hitachi AMS1500 storage subsystems. LUN Expansion Functionality for expanding the capacity of an LU by integrating multiple LUs into one. LVM A type of volume manager. For more information, see volume manager.
W X
Glossary-4
M
maintenance personnel Hitachi engineers who maintain HDI systems. management console A computer used by the system administrator to operate File Services Manager. management LAN A LAN used by the system administrator to operate and manage an HDI system. management server A computer on which Hitachi File Services Manager is installed. The management server can also be used as a management console. media Recording media, such as magnetic tape, for storing backed up data. media server A server that controls a tape device installed outside the storage subsystem.
N
NFS A protocol that provides file-sharing services to UNIX users. node A device that is connected to a storage subsystem and that is used as a file server. Two nodes make up a cluster.
O
OS disk A logical disk area in a node, that stores the OS and programs that run on the OS.
P
physical node A node that makes up part of a processing node. Primary Server Base A program that provides Web server functionality.
W X
Glossary-5
processing node A logical group made up of nodes. If nodes are set up in a cluster, the cluster is treated as a processing node.
Q
quota The maximum block space and maximum number of i-nodes available to a user. In an HDI system, limits can be set and managed for each file system, or each directory immediately below the mount point.
R
resource group A management unit used to manage multiple resources (such as NFS share settings, CIFS share settings, file system information, and service IP address information) as a group. Services can be started and stopped for each resource group. If an error occurs, failover is performed for each resource group.
S
scan server A server that scans, via a LAN, CIFS-shared data in an HDI system for viruses. service IP address An IP address used by a user when connecting to a service running on a resource group. By using a service IP address, the user can continue to use the service even if an error occurs on a node and the resource group fails over to the other, properly running node. ShadowImage A program for replicating user data within a storage subsystem, without using a host. subtree quota The 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 for each directory. Subtree quotas can also be set for users and groups. Sync Image A program used to create differential-data snapshots of an HDI file system. system administrator
W X
Glossary-6
A user who manages an HDI system. The system administrator sets up an HDI system and monitors system operations and error information.
system LU A collective term for the OS disks and the cluster management LU.
T
tape device A device for storing multiple types of storage media. target A unit used to manage multiple LUs as one group so that a node can uniquely recognize the LUs of a storage subsystem. TrueCopy A program for replicating user data between two storage subsystems, without using a host. trunking A technology used to create a virtual network interface from a group of ports. HDI allows you to configure a network by using virtual network interfaces that are assembled by using trunking.
U
Universal Replicator A program that asynchronously reproduces user data between two storage subsystems without transferring the data via a host. user LU A generic term for an LU that is assigned to a node and that stores user data such as file system information. A user LU is also called a device file or an LU (excluding the system LU). user LUN A management number assigned to each user LU. A user LUN is also called a device file number. user mapping The process of assigning a user ID and group ID to a user registered in a domain controller when the user accesses a CIFS share.
W X
Glossary-7
V
volume group An area that consists of one or more LUs that have been grouped together by a volume manager. In a normal file system, a volume group is made up of one file system. For Sync Image file systems, a volume group is made up of a file system, a differential-data storage device, and differential-data snapshots. volume manager Functionality for volume management. In the HDI system, LVM is used as the volume manager. This functionality enables you to create volume groups combining LUs and to create logical volumes out of volume groups.
W
WORM An abbreviation for "Write Once, Read Many". The WORM status indicates that data cannot be modified. A file whose status is changed to the WORM status is called a WORM file, and a file system in which any files can be changed to a WORM file is called a WORM file system.
W X
Glossary-8
Index
A
account 2-2 ACE Glossary-1 ACL Glossary-1 ACL type Glossary-1 acquiring hardware status 3-80 Allow header 1-4 Anti Virus Agent Glossary-1 API overview 1-1 system configuration 1-2 usage example A-1 API administrator account information acquiring 3-4 APIAccount resource 3-4 authentication cookie 2-3 cluster Glossary-2 cluster and node information acquiring 3-156 cluster configuration 1-2 cluster management LU Glossary-2 command device Glossary-2 command line using quotation marks 2-3 Configuration Manager Glossary-2 cookie format 2-4
D
Data Control Glossary-2 data port Glossary-2 DELETE method how to execute requests 1-8 device file Glossary-2 Device Manager x, Glossary-2 differential-data snapshot Glossary-2 differential-data storage device Glossary-2 Disk resource 3-44 Dynamic Provisioning x, Glossary-2
B
Backup Restore Glossary-1 backup server Glossary-1
C
CIFS Glossary-2 CIFS share adding 3-7 checking existence of 3-7 deleting 3-7 CIFS share information acquiring 3-7 changing 3-7 CIFSShares resource 3-7
E
encoding 2-2 Base64 encoding 2-2 percent-encoding 2-2 end user Glossary-3 example
Index-1
acquiring API administrator account information 3-5 acquiring CIFS share information 3-13, 3-34 acquiring cluster information 3-162 acquiring cluster mode details of hardware 3-88 acquiring FC path information 3-48 acquiring file system information 3-56, 3-69, 3-77 acquiring HCP information 3-94 acquiring LU information 3-102 acquiring migration policy information 3-106, 3-113 acquiring network interface information 3-120 acquiring NFS share information 3-134, 3-149 acquiring routing information 3-167 acquiring total capacity and unused capacity of user disk 3-45 adding CIFS share 3-27 adding network interface 3-124 adding routing information 3-169 API usage A-1 changing API administrator account password 3-6 changing host name 3-164 changing network interface information 3-130 checking whether access to HCP namespace is allowed 3-98 creating file system 3-62 creating NFS share 3-145 editing file system information 3-73, 3-79 editing NFS share information 3-155 resetting schedule of migration task 3-115 restarting OS on node 3-175 sending CIFS share information 3-42 setting migration policy 3-109 setting or deleting HCP information 3-96
creating 3-49 deleting 3-50 file system information acquiring 3-49, 3-50 editing 3-50 FileSystems resource 3-49 fixed IP address Glossary-3 front-end LAN Glossary-3
G
GET method how to execute requests glossary Glossary-1 1-5
H
Hardware resource 3-80 HBase Storage Mgmt Common Service Glossary-3 HBase Storage Mgmt Web Service Glossary-3 HCP x, Glossary-3 HCP information acquiring 3-93 deleting 3-93 setting 3-93 HCP resource 3-93 HDI x, Glossary-4 HEAD method how to execute requests 1-8 heartbeat LAN Glossary-3 Hitachi AMS1500 x Hitachi AMS2000 series x Hitachi Command Suite Common Component Glossary-3 Hitachi Content Platform Glossary-3 Hitachi Data Ingestor Glossary-4 Hitachi File Services Manager Glossary-4 host name editting 3-156 how to execute request 1-4 HTTP method 1-3 HTTP status code 1-8
F
failback Glossary-3 failover Glossary-3 FC path information acquiring 3-46 FCPaths resource 3-46 File Services Manager x File Sharing Glossary-3 file system checking existence 3-50
I
I/O formats for requests and responses incremental backup Glossary-4 1-11
Index-2
information about mount setting of file system editing 3-50 Internet Explorer xi
L
LDEV Glossary-4 logical volume Glossary-4 LU Glossary-4 LU information acquiring 3-98 LUN Glossary-4 LUN Expansion Glossary-4 LUs resource 3-98 LVM Glossary-4
checking existence of 3-131 deleting 3-131 NFS share information acquiring 3-131 acquiring 3-131 editing 3-131 NFSShares resource 3-131 node Glossary-5
O
OS restarting 3-170, 3-171 stopping 3-170 OS disk Glossary-5 overview API 1-1
M
maintenance personnel Glossary-5 management console Glossary-5 management LAN Glossary-5 management server Glossary-5 media Glossary-5 media server Glossary-5 migration policy checking for existence of 3-104 deleting 3-103 setting 3-103 migration policy information acquiring 3-103 migration task schedule resetting 3-103 MigrationTask resource 3-103 mount setting information of file system acquiring 3-50
P
password of API administrator account changing 3-4 physical node Glossary-5 POST method how to execute requests 1-7 prettyprint 1-12 Primary Server Base Glossary-5 processing node Glossary-6 ProcessingNode resource 3-156 product names x property 1-3 PUT method how to execute requests 1-6
Q
query parameter 1-11 query parameters prettyprint 1-12 verbose 1-12 quota Glossary-6
N
network interface adding 3-117 checking existence of 3-117 network interface information acquiring 3-117 editing 3-117 NetworkInterfaces resource 3-117 NFS Glossary-5 NFS share adding 3-131
R
request how to execute 1-4 request header 1-12
Index-3
resource 1-3 list of 3-3 resource group
Glossary-6 resource URI 2-2 notes 2-2 response header 1-13 response XML when an error occurs 1-14 restarting OS 3-170 restarting service 3-170 routing information acquiring 3-164 adding 3-164 deleting 3-164 Routings resource 3-164
S
scan server Glossary-6 service restarting 3-170 service IP address Glossary-6 ShadowImage xi, Glossary-6 single-node configuration 1-2 SSL certificate 2-4 status code (HTTP) 1-8 subtree quota Glossary-6 Sync Image Glossary-6 system administrator Glossary-6 system configuration for using API 1-2 system LU Glossary-7 SystemController resource 3-170
acquiring 3-44 URI 2-2 character length 2-2 notes 2-2 percent-encoding 2-3 using multi-byte characters 2-3 usage example acquiring cluster and node information in cluster configuration A-2 creating file systems in a cluster configuration A-22 creating file systems in a single-node configuration A-55 deleting file systems A-75 editing host name in single-node configuration A-3 monitoring hardware status A-6 setting HCP information A-21 setting up network A-12 stopping OS in a single-node configuration A-79 stopping OS in cluster configuration A-78 user can access HCP namespace checking whether 3-93 user disk acquiring total capacity 3-44 acquiring unused capacity 3-44 user LU Glossary-7 user LUN Glossary-7 user mapping Glossary-7
V
verbose 1-12 Virtual Storage Platform xi volume group Glossary-8 volume manager Glossary-8
T
tape device Glossary-7 target Glossary-7 total capacity of user disk acquiring 3-44 TrueCopy xi, Glossary-7 trunking Glossary-7
W
WADL 1-4 What you can do by using the API Windows xi WORM Glossary-8 1-2
U
Universal Replicator Glossary-7 Universal Storage Platform V/VM unused capacity of user disk xi
Index-4
Hitachi Data Systems Corporate Headquarters 750 Central Expressway Santa Clara, California 95050-2627 U.S.A. Phone: 1 408 970 1000 www.hds.com info@hds.com Asia Pacific and Americas 750 Central Expressway Santa Clara, California 95050-2627 U.S.A. Phone: 1 408 970 1000 info@hds.com Europe Headquarters Sefton Park Stoke Poges Buckinghamshire SL2 4HD United Kingdom Phone: + 44 (0)1753 618000 info.eu@hds.com
MK-90HDI026-00

Hdi API References Hdi0260

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Hdi API References Hdi0260

Uploaded by

Copyright:

Available Formats

Hitachi Data Ingestor

Document Organization Product Version Getting Help Contents

1. Overview of the API.............................................................................1-1

2. Access and Authentication....................................................................2-1

A API Usage Examples.............................................................................A-1

Acronyms Glossary Index

Preface Hitachi Data Ingestor API Reference

Document revision level

Access and Authentication Resources

Preface Hitachi Data Ingestor API Reference

Organization of HDI manuals

Preface Hitachi Data Ingestor API Reference

Full name or meaning

HCP HDI Hitachi AMS1500 Hitachi AMS2000 series

Preface Hitachi Data Ingestor API Reference

Full name or meaning

Universal Storage Platform V/VM

Virtual Storage Platform Windows

Hitachi Virtual Storage Platform Microsoft(R) Windows(R) Operating System

screen/code < > angled brackets

[ ] square brackets { } braces | vertical bar

Preface Hitachi Data Ingestor API Reference

Convention for storage capacity values

Preface Hitachi Data Ingestor API Reference

Preface Hitachi Data Ingestor API Reference

Preface Hitachi Data Ingestor API Reference

Overview of the API Hitachi Data Ingestor API Reference

What you can do by using the API

Figure 1-1 Examples of a system configuration

Overview of the API Hitachi Data Ingestor API Reference

Resources and properties

Table 1-1 Supported HTTP methods

Overview of the API Hitachi Data Ingestor API Reference

How to execute a request

Overview of the API Hitachi Data Ingestor API Reference

When using the GET method

Overview of the API Hitachi Data Ingestor API Reference

When using the PUT method

Overview of the API Hitachi Data Ingestor API Reference

When using the POST method

Overview of the API Hitachi Data Ingestor API Reference

When using the DELETE method

When using the HEAD method

HTTP status codes

Overview of the API Hitachi Data Ingestor API Reference

Overview of the API Hitachi Data Ingestor API Reference

All methods PUT POST DELETE

NOT_FOUND METHOD_NOT_ ALLOWED

All methods GET PUT POST DELETE GET

NOT_ACCEPTA BLE CONFLICT

415 500 503

UNSUPPORTED _MEDIA_TYPE INTERNAL_SE RVER_ERROR SERVICE_UNA VAILABLE

All methods All methods All methods

Overview of the API Hitachi Data Ingestor API Reference

I/O formats for requests and responses

Table 1-4 Supported MIME types

Table 1-5 Supported query parameters

Overview of the API Hitachi Data Ingestor API Reference

CIFSSha res/ CIFSsharename NFSShar es/NFSsharedirectory -name

GET POST DELETE HEAD

Overview of the API Hitachi Data Ingestor API Reference

Table 1-6 Request headers

Table 1-7 Response headers