Contents

List of Examples

List of Figures

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Cloud Infrastructure APIs and CLI

• 1.1 Overview of Virtual Datacenter Management
• 1.2 How APIs and CLI Work
• 1.3 Overview of the Functionality

2 Getting Started

• 2.1 Prerequisites
• 2.2 Installation
  • 2.2.1 Cloud Infrastructure API
  • 2.2.2 Cloud Infrastructure Java Client API
  • 2.2.3 Cloud Infrastructure CLI
• 2.3 Next Steps

3 Managing Resources

• 3.1 Overview of Cloud User Resources
  • 3.1.1 Status of Account Resources
• 3.2 Managing Account Access
  • 3.2.1 Creating an Access Key
  • 3.2.2 Viewing Access Key Information
  • 3.2.3 Deleting an Access Key
• 3.3 Viewing vDC Capabilities
• 3.4 Managing Virtual Networks
  • 3.4.1 Creating a vNet
  • 3.4.2 Deleting a vNet
  • 3.4.3 Viewing vNet Information
• 3.5 Managing vIP Addresses
  • 3.5.1 Allocating a vIP Address
  • 3.5.2 Deallocating a vIP Address
  • 3.5.3 Viewing vIP Addresses
• 3.6 Managing Server Templates
  • 3.6.1 Uploading a Server Template from a vServer
  • 3.6.2 Uploading a Server Template from a URL
  • 3.6.3 Uploading a Server Template from an Assembly
  • 3.6.4 Deleting a Server Template
  • 3.6.5 Viewing Server Template Information
• 3.7 Managing Storage
  • 3.7.1 Creating a Volume
  • 3.7.2 Deleting a Volume
  • 3.7.3 Viewing Volume Information
  • 3.7.4 Attaching a Volume to a vServer
  • 3.7.5 Detaching a Volume from a vServer
  • 3.7.6 Importing a Volume
  • 3.7.7 Creating a Snapshot
  • 3.7.8 Deleting a Snapshot
  • 3.7.9 Viewing Snapshot Information
• 3.8 Managing Distribution Groups
  • 3.8.1 Creating a Distribution Group
  • 3.8.2 Deleting a Distribution Group
  • 3.8.3 Viewing Distribution Group Information
• 3.9 Managing vServers
  • 3.9.1 Viewing vServer Types
  • 3.9.2 Creating a vServer
  • 3.9.3 Deleting a vServer
  • 3.9.4 Viewing vServer Information
  • 3.9.5 Viewing vServer Metrics
  • 3.9.6 Stopping a vServer
  • 3.9.7 Starting a vServer
  • 3.9.8 Rebooting a vServer
  • 3.9.9 Sending a Message to a vServer
  • 3.9.10 Receiving a Message from a vServer
• 3.10 Managing Key Pairs
  • 3.10.1 Creating a Key Pair
  • 3.10.2 Importing a Key Pair
  • 3.10.3 Deleting a Key Pair
  • 3.10.4 Viewing Key Pair Information
• 3.11 Managing Attributes of an Account Resource
  • 3.11.1 Viewing Attributes of an Account Resource
  • 3.11.2 Modifying Attributes of an Account Resource
• 3.12 Managing Tags
  • 3.12.1 Creating a Tag
  • 3.12.2 Removing a Tag
  • 3.12.3 Viewing Tag Information

4 Cloud Infrastructure API Reference

• 4.1 Overview of the Cloud Infrastructure API
• 4.2 Cloud Infrastructure API Requests
  • 4.2.1 Required Web Service HTTP Request Parameters
  • 4.2.2 Signing a Web Service Request
• List of Actions
  • AllocateIpAddressesRequest
  • AttachVolumesToVserverRequest
  • CreateAccessKeyAsObjectRequest
  • CreateAccessKeyToFileRequest
  • CreateDistributionGroupRequest
  • CreateKeyPairAsObjectRequest
  • CreateKeyPairToFileRequest
  • CreateSnapshotRequest
  • CreateTagsRequest
  • CreateVnetRequest
  • CreateVolumeRequest
  • DeleteAccessKeyRequest
  • DeleteDistributionGroupRequest
  • DeleteKeyPairRequest
  • DeleteSnapshotRequest
  • DeleteTagsRequest
  • DeleteVnetRequest
  • DeleteVolumeRequest
  • DeregisterServerTemplateRequest
  • DescribeAccessKeysRequest
  • DescribeAccountsRequest
  • DescribeAttributesRequest
  • DescribeDistributionGroupsRequest
  • DescribeIpAddressesRequest
  • DescribeKeyPairsRequest
  • DescribeServerTemplatesRequest
  • DescribeSnapshotsRequest
  • DescribeTagsRequest
  • DescribeVdcCapabilitiesRequest
  • DescribeVnetsRequest
  • DescribeVolumesRequest
  • DescribeVserverMetricsRequest
  • DescribeVserversRequest
  • DescribeVserverTypesRequest
  • DetachVolumesFromVserverRequest
  • ImportKeyPairRequest
  • ImportVolumeRequest
  • ModifyAttributesRequest
  • RebootVserversRequest
  • ReceiveMessageFromVserverRequest
  • RegisterAccessKeyRequest
  • RegisterKeyPairRequest
  • RegisterServerTemplateFromUrlRequest
  • RegisterServerTemplateFromVserverRequest
  • RegisterServerTemplatesFromAssemblyRequest
  • ReleaseIpAddressesRequest
  • RunVserverRequest
  • RunVserversRequest
  • SendMessagesToVserverRequest
  • StartVserversRequest
  • StopVserversRequest
  • TerminateVserversRequest
• Data Types
  • AccountIdType
  • DescribeAccessKeysResultItem
  • DescribeAccountsResultItem
  • DescribeDistributionGroupsResultItem
  • DescribeIpAddressesResultItem
  • DescribeKeyPairsResultItem
  • DescribeServerTemplatesResultItem
  • DescribeSnapshotsResultItem
  • DescribeTagsResultItem
  • DescribeVdcCapabilitiesResultItem
  • DescribeVnetsResultItem
  • DescribeVolumesResultItem
  • DescribeVserverMetricsResultItem
  • DescribeVserversResultItem
  • DescribeVserverTypesResultItem
  • DistributionGroupIdType
  • FilterItem
  • GenericString
  • HostnameType
  • Message
  • PositiveInteger
  • ResourceAttribute
  • ResourceIdType
  • SnapshotIdType
  • ServerTemplateIdType
  • TagType
  • URLType
  • VnetIdType
  • VolumeIdType
  • VserverIdType

5 Cloud Infrastructure CLI Reference

• 5.1 Common Command Options
• List of Commands
  • akm-create-access-key
  • akm-delete-access-key
  • akm-describe-access-keys
  • akm-describe-accounts
  • iaas-allocate-ip-addresses
  • iaas-attach-volumes-to-vserver
  • iaas-create-distribution-group
  • iaas-create-key-pair
  • iaas-create-server-template-from-assembly
  • iaas-create-server-template-from-url
  • iaas-create-server-template-from-vserver
  • iaas-create-snapshot
  • iaas-create-tags
  • iaas-create-vnet
  • iaas-create-volume
  • iaas-delete-distribution-group
  • iaas-delete-key-pair
  • iaas-delete-server-template
  • iaas-delete-snapshot
  • iaas-delete-tags
  • iaas-delete-vnet
  • iaas-delete-volume
  • iaas-describe-attributes
  • iaas-describe-distribution-groups
  • iaas-describe-ip-addresses
  • iaas-describe-key-pairs
  • iaas-describe-server-templates
  • iaas-describe-snapshots
  • iaas-describe-tags
  • iaas-describe-vdc-capabilities
  • iaas-describe-vnets
  • iaas-describe-volumes
  • iaas-describe-vserver-metrics
  • iaas-describe-vservers
  • iaas-describe-vserver-types
  • iaas-detach-volumes-from-vserver
  • iaas-import-key-pair
  • iaas-import-volume
  • iaas-modify-attributes
  • iaas-reboot-vservers
  • iaas-receive-message-from-vserver
  • iaas-release-ip-addresses
  • iaas-run-vserver
  • iaas-run-vservers
  • iaas-send-messages-to-vserver
  • iaas-start-vservers
  • iaas-stop-vservers
  • iaas-terminate-vservers

A Web Service Client Example

• A.1 Description of Web Service API Requests
  • A.1.1 AKM Request
    • A.1.1.1 REQUEST_DATA Specification
  • A.1.2 IAAS Request
    • A.1.2.1 REQUEST_IAAS_DATA Specification
    • A.1.2.2 SIGNATURE_BLOCK Specification
    • A.1.2.3 IAAS Data Used for Signature
• A.2 Sending a Web Service Request
  • A.2.1 Using the Web Browser
  • A.2.2 Using WGET Utility
• A.3 Creating Public and Private Keys
  • A.3.1 Private Key
  • A.3.2 Public Key
• A.4 Overview of the WebUtil Application
  • A.4.1 How the WebUtil Application Works
• A.5 Examples of Web Service Requests
  • A.5.1 Creating an Access Key
  • A.5.2 Executing actions for an account
    • A.5.2.1 Viewing All Available Virtual Networks
    • A.5.2.2 Viewing Specific Virtual Networks by Using IDs
    • A.5.2.3 Viewing Specific Virtual Networks by Using Filters
    • A.5.2.4 Creating a Private Virtual Network

Index