Oracle® VM

Web Services API Developer's Guide for Release 3.4

Oracle Legal Notices
Oracle Documentation License

E64087_01

March 2016


Table of Contents

Preface
1 Audience
2 Related Documents
3 Command Syntax
4 Conventions
1 Oracle VM Web Services Overview
1.1 Changes to the Oracle VM Web Services API in Release 3.4
1.2 Using the Oracle VM Web Services SDK
1.3 Using the Oracle VM Web Services Client Library and Sample Code
2 Programming Issues and Considerations
2.1 General Programming Considerations
2.1.1 Object Modification
2.1.2 Object Associations
2.1.3 Read-only Methods and Object Properties
2.1.4 Working with Jobs
2.1.5 Dealing with Exceptions
2.1.6 XML Tags in Object Names and Descriptions
2.2 Notable Issues for Suds Users
2.2.1 Dealing with an Externally Hosted XSD
2.2.2 Null Properties and Empty Lists
2.2.3 Unable to Access the OvmWsUtilities Endpoint
2.3 Notable Issues for Jackson and Jersey Library Users
2.3.1 Null Properties and Empty Lists
3 Using the Oracle VM Manager REST API
3.1 Connecting to the REST Base URI
3.2 How do I Authenticate?
3.3 What URI Mappings are Available and How do They Work?
3.4 Internet Media Types Used by the REST API (JSON and XML)
3.5 Good Practice: Check the Oracle VM Manager Start Up State
3.6 Example Code Using REST
3.6.1 Notes on the samples in this document
3.6.2 Authenticating
3.6.3 Checking Oracle VM Manager Run State
3.6.4 Listing Servers
3.6.5 Discovering Servers
3.6.6 Working with Jobs
3.6.7 Searching For Objects And IDs
3.6.8 Discovering a Network File Server
3.6.9 Creating a Server Pool
3.6.10 Clustering
3.6.11 Managing Servers in a Server Pool
3.6.12 Creating a Storage Repository
3.6.13 Presenting a Storage Repository
3.6.14 Creating Networks
3.6.15 Creating Virtual Machines
3.6.16 Importing Virtual Appliances
4 Additional Utilities Exposed in the WS-API
4.1 Authentication
4.2 Utilities Paths and Examples
4.3 Certificate Management for Certificate-based Authentication Using REST
4.3.1 How to Obtain the CA Certificate Using REST
4.3.2 How to Sign and Register a Certificate Using REST
Glossary