Ver.2.08

Enterprise Cloud

Functional Description

for API Function

[Global Standard Services]

NTT Communications

Ver.2.08

(May 1st, 2016 Edition)

1

About This Document

Purpose of This Document/How to Use This Document

This document explains API in the Enterprise Clouds. Please note that the information in this

document is for users who have signed contracts.

2

1 CONTENTS

1 Contents ........................................... 2

2 API function ....................................... 3

2.1 API function ..................................................................................................................... 3

3 vCloud Native API .................................. 4

3.1 Supported API ................................................................................................................. 4

3.2 Restrictions ...................................................................................................................... 4 3.2.1 Prerequisite ....................................................................................................................... 4 3.2.2 Service Support ................................................................................................................. 4 3.2.3 General API Restrictions ................................................................................................... 5 3.2.4 Restrictions on Virtual Hardware ....................................................................................... 5 3.2.5 Restrictions on Guest Customization ................................................................................. 7 3.2.6 Restrictions on Snapshot ................................................................................................... 7 3.2.7 Restrictions on Private Catalog.......................................................................................... 8

4 Enterprise Cloud Unique Extension API .............. 9

4.1 Supported API ................................................................................................................. 9

5 Reference 1(vCloud Native API) .................... 10

6 Reference 2(vCloud NAtive API) .................... 11

7 Revision History .................................. 12

3

2 API FUNCTION

2.1 API function

API functions are provided, as a rule, standardized according to vCloud API 5.5 and Enterprise Cloud Unique Extension API.

Available API functions are below

Functions Contents

vCloud Native API Customer can use API for vApp/VM and vApp template.

Enterprise Cloud Unique Extension API

Customer can use API for managing Compute Resource Pool.

API User Management API user management function is provided.

API Endpoint The Endpoint which customer can connect for API is provided in each Data Center.

To use API customer need to create “API user” by Customer Portal. And Endpoint URL can be got on Customer Portal. Refer to Enterprise Cloud API User’s Guide.

API available Data Center

Functions/Data Center JP US UK

Yokohama Kansai1 Saitama Lundy Sterling

vCloud Native API N N Y N N Y

Enterprise Cloud Unique Extension API

N N Y N N Y

Functions/Data Center DE FR ES SG HK MY AU TH

vCloud Native API Y Y Y Y Y N Y Y

Enterprise Cloud Unique Extension API

Y Y Y Y Y N Y Y

4

3 VCLOUD NATIVE API

3.1 Supported API

We expose not all of native vCloud APIs based on version 5.5 to a customer as Enterprise Cloud. As for a vApp template and a vApp, there is a concept of "Managed by NTT". NTT managed API objects should not be accessed by a customer. So, some APIs cannot be used for API objects managed by NTT.

Supported API and detailed parameters for each operation are described in API User’s Guide.

3.2 Restrictions

3.2.1 Prerequisite

Followings are prerequisites for using API

- Knowledge on XML

- Knowledge on basic structure of WWW Service

- Knowledge on programming

- Knowledge on Server delivery and operation of Enterprise Cloud

API feature which is available on Enterprise Cloud is based on vCloud API version 5.5 provided by VMware. Please make sure to check the VMware document (Please refer to “Reference 1”) for vCloud API knowledge.

3.2.2 Service Support

All technical inquiries for single http message contents (request line for request message, status code of method, header, status code, and message body) on API are supported. Any inquiries on designing support related to development of API Client Software or trouble analysis cannot be supported.

Any inquiries regarding workflow that overlaps several APIs used for specific objectives such as consecutive API control or periodical batch test are not supported.

Any general inquiries regarding API tool or Library are not supported.

According to the content of the inquiry, our response time might change.

5

3.2.3 General API Restrictions

Not all API functions of vCloud Director are applicable. There are partially restricted API and parameters. Please refer to supported API.

IP/Password for API User ID is different from Customer Portal ID/Password. API ID/Password needs to be set per Datacenter.

Permission Controls being set on Customer Portal does not apply to API Operation. Please be aware of permission management when creating API User.

Role and Rights for API User is being set in advance by NTT Communications. Customer cannot change this setting.

Access Control setting related to API Object cannot be used.

When using billable service with API (such as creating vApp/VM with OS License), there is a possibility that Customer might get billed. Please pay full attention when developing Application program and make sure not to conduct any kind of action that leads to unintended charge.

3.2.4 Restrictions on Virtual Hardware

3.2.4.1 Restrictions on vApp

1 vApp could only have 1 Virtual Machine. vApp with several Virtual Machines is not supported.

Start and Stop Options for vApp and Lease Settings are not supported.

vApp Network assign the Organization vDC Network provided for Server Segment as Parent Network. Please take over (IsInherited) the IP Settings (IpScope) from the Parent Network.

3.2.4.2 Restrictions on CPU

Please set the number of CPU sockets within the supported value of Compute Resource Service.

Enterprise Cloud only supports CPU cores per socket as 1.

Hot Add/Remove is not supported.

3.2.4.3 Restrictions on Memory

Please set the Memory capacity within the supported value of Compute Resource Service.

Hot Add/Remove is not supported.

3.2.4.4 Restrictions on Disk Controller

At least 1 SCSI Controller is necessary.

6

Please use the type of SCSI Controller that each Guest OS supports.

IDE Controller must be 1. Either 0 or more than 2 IDE Controller is not supported.

For more detailed specification, see Reference 2.

3.2.4.5 Restrictions on Disk

HDD only supports SCSI Disk. Please connect Root Disk to SCSI (0:0).

Both IDE Disk and SATA Disk are not supported.

3.2.4.6 Restrictions on NIC

The number of NIC must be 8. If the number of NICs is below 7 or above 9, it is not supported.

Please use the type of NIC which is supported by Guest OS.

Please use the MAC Address which is automatically assigned by Enterprise Cloud. If the Customer set their own MAC address, we may ask the customer to change.

Connecting several NICs to the same server segment is not supported.

Hot Add/Remove is not supported.

When assigning the IP address to NIC, please set Allocation Mode as “MANUAL” and select the IP address which is not used for any Server Segments. Customer cannot use “POOL” or ”DHCP” Mode

When not assigning the IP address to NIC, please set Allocation Mode as “NONE”. However, Please do not select “NONE” for Primary NIC and Customer must assign IP address as “MANUAL”.

For more detailed specification, see Reference 2.

3.2.4.7 Restrictions on CD/DVD Drive

Please use only 1 CD/DVD Drive. If the number of CD/DVD Drive is 0 or more than 2, it is not supported.

Only IDE Connectivity is supported by CD/DVD Drive. Please connect the IDE Controller to IDE(0:0) for Linux OS and IDE(0:1) for Windows OS.

3.2.4.8 Restrictions on Floppy Drive

Please use only 1 Floppy Drive. If the number of Floppy Drive is 0 or more than 2, it is not supported.

7

3.2.4.9 Restrictions on other Virtual Hardware

Peripheral Ports such as Serial Port, Parallel Port, USB Controller are not supported.

3.2.5 Restrictions on Guest Customization

Please Enable the Guest Customization.

Please do not change the default settings of Template which is provided based on OS License Service (vApp Template) and Guest Customization settings for Virtual Machines (Guest Customization Section).

Please activate (True) the status of Change SID (ChangeSid) for the Windows Server Virtual Machine brought in by using VM Server Image Import Function.

Initial password (AdminPassword) for Customer Portal will not be informed via Secure Message when creating Virtual Machines using API. Customer could either set a default password which is optional when creating the Virtual Machine or Customer need to acquire the default password which is automatically created (AdminPasswordAuto = True) by v Cloud Director via API.

3.2.6 Restrictions on Snapshot

VM / vApp is only when Powered ON and PowerdOFF is possible Snapshot of operation.

This Snapshot API is provided only in the data center.

Snapshot available Data Center

Functions/Data Center JP US UK

Yokohama Kansai1 Saitama Lundy Sterling

Snapshot for vCloud Native API

N N N N N Y

Functions/Data Center DE FR ES SG HK MY AU TH

Snapshot for vCloud Native API

Y Y Y Y Y Y Y Y

Retention period of the Snapshot will be two days at the maximum.

VM / vApp that exceeded the time limit is automatically Snapshot will be deleted.

8

During snapshot acquisition it will not be able to perform an operation of this API

Method URL

POST /catalog/{id}/action/captureVApp

PUT /vApp/{id}

PUT /vApp/{id}/guestCustomizationSection

PUT /vApp/{id}/networkConfigSection

PUT /vApp/{id}/networkConnectionSection

PUT /vApp/{id}/virtualHardwareSection

PUT /vApp/{id}/virtualHardwareSection/cpu

PUT /vApp/{id}/virtualHardwareSection/disks

PUT /vApp/{id}/virtualHardwareSection/memory

PUT /vApp/{id}/virtualHardwareSection/networkCards

3.2.7 Restrictions on Private Catalog

Please keep the power status of the VM as “Powered Off” when creating vApp Template.

9

4 ENTERPRISE CLOUD UNIQUE

EXTENSION API

4.1 Supported API

Enterprise Cloud Unique Extension API defines unique API operations and API types. As it is not included in the vCloud API Programming Guide or vCloud API Reference, it is necessary to read this document carefully and understand these contents when using the Enterprise Cloud Unique Extension API.

Detail parameters for each API operation are described in API User’s Guide.

10

5 REFERENCE 1(VCLOUD

NATIVE API)

Please check the documents listed below before using API.

vCloud API Programming Guide

http://pubs.vmware.com/vcd-55/topic/com.vmware.vcloud.api.doc_55/GUID-86CA32C2-

3753-49B2-A471-1CE460109ADB.html

vCloud Director REST API Reference Documentation

http://pubs.vmware.com/vcd-55/topic/com.vmware.vcloud.api.reference.doc_55/doc/right-pane.html

11

6 REFERENCE 2(VCLOUD

NATIVE API)

OS License Services provided for each Guest OS are listed below along with the hardware types for Disk Controller and NIC.

Disk Controller

NIC

Service Menu OS type Hardware type

Red Hat Enterprise Linux

Red Hat Enterprise Linux 5 E1000

Red Hat Enterprise Linux 6 E1000

Red Hat Enterprise Linux 7 VMXNET3

Windows Server

Windows Server 2008 R2 SP1 Enterprise

E1000

Windows Server 2012 Standard VmxNet3

Windows Server 2012 R2 Standard

VmxNet3

Service Menu OS type Hardware type

Red Hat Enterprise Linux

Red Hat Enterprise Linux 5 LSI Logic Parallel SCSI controller

Red Hat Enterprise Linux 6 LSI Logic Parallel SCSI controller

Red Hat Enterprise Linux 7 LSI Logic SAS SCSI controller

Windows Server

Windows Server 2008 R2 SP1 Enterprise

LSI Logic SAS SCSI controller

Windows Server 2012 Standard LSI Logic SAS SCSI controller

Windows Server 2012 R2 Standard

LSI Logic SAS SCSI controller

12

7 REVISION HISTORY

Date Updated Version No. Revision Details

02/13/2015 Ver.1.0 Ver.1.0 established

05/15/2015 Ver.2.0 Added Enterprise Cloud Unique Extension API

06/5/2015 Ver.2.01 Updated API available Data Center

France Paris 2, Germany Frankfurt 2

09/1/2015 Ver.2.02 Updated API available Data Center

Madrid 2

11/1/2015 Ver.2.03 Updated API available Data Center

Hong Kong Tai Po

12/1/2015 Ver.2.04 Updated API available Data Center

Australia Sydney1

1/1/2016 Ver.2.05 Updated API available Data Center

Saitama No.1

2/1/2016 Ver.2.06 Updated API available Data Center

Thai Bangna, Singapore Serangoon

4/1/2016 Ver.2.07 Update API Available Function

3.2.6 Restrictions on Snapshot

5/1/2016 Ver.2.08 Updated Reference2

Added Red Hat Enterprise Linux 7