Oracle® VM

Web Services API Developer's Guide for Release 3.3

Oracle Legal Notices

Oracle Documentation License

E50253-05

July 2015

Table of Contents

1 Audience
2 Related Documents
3 Command Syntax
4 Conventions

1 Oracle VM Web Services Overview

1.1 Using the Oracle VM Web Services SDK
1.2 Using the Oracle VM Web Services Client Library and Sample Code

2 Using the Oracle VM Manager REST API

2.1 Connecting to the REST Base URI

2.2 How do I Authenticate?

2.3 What URI Mappings are Available and How do They Work?

2.4 Internet Media Types Used by the REST API (JSON and XML)

2.5 Good Practice: Check the Oracle VM Manager Start Up State

2.6 Example Code Using REST

2.6.1 Authenticating
2.6.2 Checking Oracle VM Manager Run State
2.6.3 Listing Servers
2.6.4 Discovering Servers
2.6.5 Working with Jobs
2.6.6 Creating a Server Pool
2.6.7 Clustering
2.6.8 Managing Servers in a Server Pool
2.6.9 Discovering a Network File Server
2.6.10 Creating a Storage Repository
2.6.11 Presenting a Storage Repository
2.6.12 Creating Networks
2.6.13 Creating Virtual Machines
2.6.14 Importing Assemblies

3 Using the Oracle VM Manager SOAP API

3.1 Connecting To The SOAP API

3.2 How Do I Authenticate?

3.3 Common SOAP API Calls To Retrieve Information

3.4 Good Practice: Check the Oracle VM Manager Start Up State

3.5 Example Code Using SOAP

3.5.1 Authenticating
3.5.2 Checking Oracle VM Manager Run State
3.5.3 Listing Servers
3.5.4 Discovering Servers
3.5.5 Working with Jobs
3.5.6 Creating a Server Pool
3.5.7 Clustering
3.5.8 Managing Servers in a Server Pool
3.5.9 Discovering a Network File Server
3.5.10 Creating a Storage Repository
3.5.11 Presenting a Storage Repository
3.5.12 Creating Networks
3.5.13 Creating Virtual Machines
3.5.14 Importing Assemblies

4 Additional Utilities Exposed in the WS-API

4.1.1 Authentication
4.1.2 Calling Utility Methods Using SOAP and Java
4.1.3 Certificate Management for Certificate-based Authentication Using SOAP

4.2.1 Authentication
4.2.2 Utilities Paths and Examples
4.2.3 Certificate Management for Certificate-based Authentication Using REST

5 Programming Issues and Considerations

5.1 General Programming Considerations

5.1.1 Object Modification
5.1.2 Object Associations
5.1.3 Read-only Methods and Object Properties
5.1.4 Working with Jobs
5.1.5 Dealing with Exceptions

5.2 Notable Issues for Suds Users

5.2.1 Dealing with an Externally Hosted XSD
5.2.2 Null Properties and Empty Lists
5.2.3 Unable to Access the OvmWsUtilities Endpoint

5.3 Notable Issues for Jackson and Jersey Library Users

5.3.1 Null Properties and Empty Lists