Oracle VM (OVM) REST Api

############################################################################################
Update 20180331:
I tried a couple things from the comment section and can add the following:

@chaitanya: ovcmclient worked for me also with create and clone

@Dave: that still gave me the same errors and I am using documentation as its here https://docs.oracle.com/cd/E50245\_01/E50253/html/vmprg-rest-example-vm-create-python.html

@Jeff: try chaitanya”s suggestion python-ovmclient it worked for me
############################################################################################

Previous article here:

Oracle OVM rest api example

I am adding a slightly updated script here even though I could not get POST (Create new VM) and PUT (Clone VM) to work yet.

Using a module for most functions.

1
import json
2
from time import sleep
3

4
def get_id_from_name(s,baseUri,obj,name):
5
  #sp_id=get_id_from_name(s,baseUri,'ServerPool','ovs-home')
6
  r=s.get(baseUri+'/'+obj)
7
  for i in r.json():
8
    if i['name'] == name:
9
      id = i['id']['value']
10
  return id
11

12
def wait_for_job(joburi,s):
13
        while True:
14
            time.sleep(1)
15
            r=s.get(joburi)
16
            job=r.json()
17
            if job['summaryDone']:
18
                print '{name}: {runState}'.format(name=job['name'], runState=job['jobRunState'])
19
                if job['jobRunState'].upper() == 'FAILURE':
20
                    raise Exception('Job failed: {error}'.format(error=job['error']))
21
                elif job['jobRunState'].upper() == 'SUCCESS':
22
                    if 'resultId' in job:
23
                        return job['resultId']
24
                    break
25
                else:
26
                    break
27

28
def check_manager_state(baseUri,s):
29
  #https://hostname:port/ovm/core/wsapi/rest/Manager
30
  while True:
31
    r=s.get(baseUri+'/Manager')
32
    manager=r.json()
33
    if manager[0]['managerRunState'].upper() == 'RUNNING':
34
      break
35
      time.sleep(1)
36
      return;
37

38
def serverList(s,baseUri):
39
  print "\nServer List:"
40
  print "##############"
41
  r=s.get(baseUri+'/Server')
42
  for i in r.json():
43
    # do something with the content
44
    print '{:20} {:20}'.format(i['serverRunState'],i['name'])
45

46
def vmList(s,baseUri):
47
  print "\nVM List:"
48
  print "########"
49
  r=s.get(baseUri+'/Vm')
50
  for i in r.json():
51
    # print '{:20} {:20}'.format(i['vmRunState'],i['name'])
52
    print '{:20} {:35} {:30}'.format(i['vmRunState'],i['name'],i['id']['value']),
53
    for d in i['vmDiskMappingIds']:
54
      print d['value'],
55
    print
56
    # print '{name} '.format(name=i['name'])
57
    # print i
58

59
def showVm(s,baseUri,name):
60
  print "\nVM Show:"
61
  print "##########"
62
  r=s.get(baseUri+'/Vm')
63
  for i in r.json():
64
    if i['name'] == name:
65
      print '{:20} {:55}'.format(i['vmRunState'],i['name']),
66
      for d in i['vmDiskMappingIds']:
67
  if 'CDROM' not in d['name']:
68
          print d['value'],
69
          disk=s.get(baseUri+'/VmDiskMapping/'+d['value'])
70
    d = disk.json()
71
    if "obiee" in d['virtualDiskId']['name']:
72
      dName = d['virtualDiskId']['name'].replace('obiee_template',i['name'])
73
      dName = dName.split('img')[0]+'img'
74
          print 'value: {} and name {} should be renamed -> {}'.format(d['virtualDiskId']['value'],d['virtualDiskId']['name'],dName),
75
      print
76

77
def cmdVm(s,baseUri,cmd,name):
78
  print "\nVM " + cmd
79
  print "##########"
80
  vm_id=get_id_from_name(s,baseUri,'Vm',name)
81
  print vm_id
82
  r=s.put(baseUri+'/Vm/'+vm_id+'/'+cmd)
83
  job=r.json()
84
  # print job
85
  # wait for the job to complete
86
  vm_id=wait_for_job(job['id']['uri'],s)
87

88
def updateVm(s,baseUri,name):
89
  print "\nVM Update Vm Disk Names:"
90
  print "##########################"
91
  r=s.get(baseUri+'/Vm')
92
  for i in r.json():
93
    if i['name'] == name:
94
      #print i
95
      print '{:20} {:20} {:55}'.format(i['id']['value'],i['vmRunState'],i['name'])
96
      for disk in i['vmDiskMappingIds']:
97
        if 'CDROM' not in disk['name']:
98
          #print disk['value'],
99
          value=s.get(baseUri+'/VmDiskMapping/'+disk['value'])
100
          d = value.json()
101
    oldName = d['virtualDiskId']['name']
102
          newName = d['virtualDiskId']['name'].replace('obiee_template',i['name'])
103
          newName = newName.split('img')[0]+'img'
104
    d['virtualDiskId']['name']=newName
105
    d['id']['name']=newName
106
    d['name']=newName
107

108
          #print 'value: {:20} name: {:55} new name {}'.format(d['virtualDiskId']['value'],d['virtualDiskId']['name'],dName),
109
          print 'value: {:20} name: {:55} new name {}'.format(disk['value'],oldName,newName)
110
          #print d
111
          uri='{base}/VmDiskMapping/{id}'.format(base=baseUri,id=d['id']['value'])
112
    #print uri
113
          r1=s.put(uri,data=json.dumps(d))
114
          job=r1.json()
115
        #print job
116
          # wait for the job to complete
117
          wait_for_job(job['id']['uri'],s)
118

119
      i['vmDiskMappingIds'][0]['name']='new.img'
120
      #print i
121
      uri='{base}/Vm/{id}'.format(base=baseUri,id=i['id']['value'])
122
      #print uri
123

124
      r=s.put(uri,data=json.dumps(i))
125
      job=r.json()
126
      #print job
127
      # wait for the job to complete
128
      wait_for_job(job['id']['uri'],s)
129

130
def updateVmMemory(s,baseUri,name,memory):
131
  print "\nVM Update Vm Memory for " + name
132
  print "########################################"
133
  vm_id=get_id_from_name(s,baseUri,'Vm',name)
134
  uri='{base}/Vm/{id}'.format(base=baseUri,id=vm_id)
135
  r=s.get(uri)
136
  d=r.json()
137
  #print d
138
  d['memory']='512'
139

140
  r=s.put(uri,data=json.dumps(d))
141
  job=r.json()
142
  #print job
143
  # wait for the job to complete
144
  wait_for_job(job['id']['uri'],s)
145

146
def updateVirtualDisk(s,baseUri,id,newDiskName):
147
  print "\nVM Update Vm Disk Mapping for " + id
148
  print "########################################"
149
  uri='{base}/VirtualDisk/{id}'.format(base=baseUri,id=id)
150

151
  r=s.get(uri)
152
  disk=r.json()
153
  #print disk
154

155
  #oldName = disk['virtualDiskId']['name']
156
  #newName = disk['virtualDiskId']['name'].replace('obiee_template',d['name'])
157
  #newName = newName.split('img')[0]+'img'
158

159
  disk['name']=newDiskName
160

161
  #disk['name']='newname_system.img'
162

163
  r=s.put(uri,data=json.dumps(disk))
164
  job=r.json()
165
  # wait for the job to complete
166
  wait_for_job(job['id']['uri'],s)
167

168
def updateVmDiskNames(s,baseUri,name):
169
  print "\nVM Update Vm Disk Names for " + name
170
  print "########################################"
171
  vm_id=get_id_from_name(s,baseUri,'Vm',name)
172
  uri='{base}/Vm/{id}'.format(base=baseUri,id=vm_id)
173
  r=s.get(uri)
174
  vm=r.json()
175

176
  dNum=0
177
  for disk in vm['vmDiskMappingIds']:
178
        if 'CDROM' not in disk['name']:
179
    dNum = dNum +1
180
    newDiskName=name + "_disk" + str(dNum)
181
    #if "system" in disk['name']:
182
    #  newDiskName=name + "_system.img"
183
     #if "data1" in disk['name']:
184
    #  newDiskName=name + "_data1.img"
185

186
    ## update VmDiskMapping as shown in Repository
187
    dMapping=s.get(baseUri+'/VmDiskMapping/'+disk['value'])
188
    dm=dMapping.json()
189
    updateVirtualDisk(s,baseUri,dm['virtualDiskId']['value'],newDiskName)

Main program.

1
import requests
2
import json
3
from ovm_lib import *
4
#import logging
5

6
s=requests.Session()
7
s.auth=('admin','mypassword')
8
s.verify=False #disables SSL certificate verification
9
s.headers.update({'Accept': 'application/json', 'Content-Type': 'application/json'})
10

11
ovmmServer="192.168.1.223:7002"
12
print "Running against OVM Manager Server: " + ovmmServer
13
baseUri='https://'+ovmmServer+'/ovm/core/wsapi/rest'
14

15
#logging.basicConfig(level=logging.DEBUG)
16

17
## Create VM still failing
18
## GENERAL_JSON_PARSING_ERROR', u'message': u'GEN_000031:An error occurred parsing the JSON request'
19

20
def createVm(s,baseUri,repository,serverpool,vmName):
21
  #file:///home/rrosso/OvmSDK_3.4.2.1384/doc/api/webservices_r/resource_VmRs.html#path__Vm.html
22
  #repo_id=get_id_from_name(s,baseUri,'Repository','ovs1')
23
  #sp_id=get_id_from_name(s,baseUri,'ServerPool','ovs-home')
24
  repo_id=get_id_from_name(s,baseUri,'Repository',repository)
25
  sp_id=get_id_from_name(s,baseUri,'ServerPool',serverpool)
26
  #print 'repo_id {:20} ServerPool Id {:55}'.format(repo_id,sp_id)
27
  #OVM> create Vm name=MyVM repository=MyRepository domainType=XEN_HVM \
28
  #server=MyServer startPolicy=USE_POOL_POLICY on ServerPool name=MyServerPool
29

30
  data={ "name": vmName,
31
         "description": "A virtual machine created using the REST API",
32
         "vmDomainType": "XEN_PVM",
33
   "repositoryId": repo_id,
34
         "serverPoolId": sp_id }
35

36
#  data={'serverPoolId':'0004fb00000200006aa35973e4d0e5af','repositoryId':'0004fb00000300000c6c2c52c5708b65'}
37
  print data
38
  uri='{base}/Vm'.format(base=baseUri)
39
  print uri
40
  #print json.dumps(data)
41
  r=s.post(uri,data=json.dumps(data))
42
  job=r.json()
43
  print job
44
  # wait for the job to complete
45
  vm_id=wait_for_job(job['id']['uri'],s)
46

47
## CloneVM failing
48
## The value for the argument "serverPoolId" was found to be null
49
def cloneVm(s,baseUri,templateVm,vmName):
50
  repo_id=get_id_from_name(s,baseUri,'Repository','ovs1')
51
  sp_id=get_id_from_name(s,baseUri,'ServerPool','ovs-home')
52
  template_id=get_id_from_name(s,baseUri,'Vm',templateVm)
53

54
  print 'clone {} into repo_id {:20} ServerPool Id {:55}'.format(template_id,repo_id,sp_id)
55

56
  data={ "serverPoolId": sp_id,
57
     "repositoryId": repo_id,
58
     "createTemplate": False
59
        }
60

61
  uri='{base}/Vm/{vmId}/clone'.format(base=baseUri,vmId=template_id)
62
  r=s.put(uri,data=json.dumps(data))
63
  job=r.json()
64
  print job
65
  # wait for the job to complete
66
  vm_id=wait_for_job(job['id']['uri'],s)
67
  print "new vm id:" + vm_id
68

69
  ## change vm name here?
70

71
if __name__ == "__main__":
72
  print
73
  print
74

75
  #check_manager_state(baseUri,s)
76

77
  #createVm(s,baseUri,'VM3')
78
  createVm(s,baseUri,'ovs2','ovs-home','ovs2-VM3')
79
  #cloneVm(s,baseUri,'Ubuntu.0','VM4')
80

81
  serverList(s,baseUri)
82
  vmList(s,baseUri)
83

84
  #updateVmMemory(s,baseUri,'VM2','512')
85

86
  #updateVmDiskNames(s,baseUri,'VM2')
87
  #showVm(s,baseUri,'VM2')
88

89
  #cmdVm(s,baseUri,'start','VM2')
90
  #cmdVm(s,baseUri,'stop','VM2')