Skip to content

Commit 17fc0a6

Browse files
committed
Initial commit
0 parents  commit 17fc0a6

File tree

11 files changed

+831
-0
lines changed

11 files changed

+831
-0
lines changed

.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
*.DS_Store
2+
*.egg*
3+
*.log
4+
*.mo
5+
*.pyc
6+
*.swo
7+
*.swp
8+
*~
9+
.coverage
10+
.idea
11+
.testrepository
12+
.tox
13+
AUTHORS
14+
build
15+
ChangeLog
16+
dist
17+
# Doc related
18+
doc/build
19+
doc/source/api/
20+
# Development environment files
21+
.project
22+
.pydevproject
23+
cover
24+
# Files created by releasenotes build
25+
releasenotes/build

LICENSE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+

README.rst

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
Python Oracle VM Client
2+
=======================
3+
4+
* Author: Cloudbase Solutions
5+
* Contact: info@cloudbasesolutions.com
6+
* Home page: http://cloudbase.it
7+
* Source: https://github.com/cloudbase/python-ovmclient
8+
* License: Apache 2.0
9+
10+
Usage
11+
-----
12+
13+
VM lifecycle
14+
~~~~~~~~~~~~
15+
16+
How to create, modify, start, stop and delete a VM::
17+
18+
import ovmclient
19+
from ovmclient import constants
20+
21+
client = ovmclient.Client(
22+
'https://host:7002/ovm/core/wsapi/rest', 'admin', 'yadayada')
23+
24+
# Make sure the manager is running
25+
client.managers.wait_for_manager_state()
26+
27+
repo_id = client.repositories.get_id_by_name('repo1')
28+
pool_id = client.server_pools.get_id_by_name('pool1')
29+
network_id = client.networks.get_id_by_name('management')
30+
31+
# Create a virtual disk
32+
disk_data = {
33+
'diskType': constants.DISK_TYPE_VIRTUAL_DISK,
34+
'size': 1024 * 1024 * 1024,
35+
'shareable': False,
36+
'name': 'dummy.img',
37+
}
38+
39+
job = client.jobs.wait_for_job(
40+
client.repository_virtual_disks(repo_id).create(disk_data, sparse='true'))
41+
disk_id = job['resultId']
42+
43+
# Create a VM
44+
vm_data = {
45+
'name': 'vm1',
46+
'description': 'Blah',
47+
'vmDomainType': constants.VM_DOMAIN_TYPE_XEN_HVM_PV_DRIVERS,
48+
'repositoryId': repo_id,
49+
'serverPoolId': pool_id,
50+
'cpuCount': 4,
51+
'cpuCountLimit': 4,
52+
'hugePagesEnabled': False,
53+
'memory': 1024,
54+
'memoryLimit': 1024,
55+
'osType': 'Oracle Linux 7',
56+
}
57+
58+
job = client.jobs.wait_for_job(client.vms.create(vm_data))
59+
vm_id = job['resultId']
60+
61+
# Map the virtual disk
62+
vm_disk_mapping_data = {
63+
'virtualDiskId': disk_id,
64+
'diskWriteMode': constants.DISK_WRITE_MODE_READ_WRITE,
65+
'emulatedBlockDevice': False,
66+
'storageElementId': None,
67+
'diskTarget': 0,
68+
}
69+
70+
job = client.jobs.wait_for_job(
71+
client.vm_disk_mappings(vm_id).create(vm_disk_mapping_data))
72+
73+
# Add a vnic
74+
vnic_data = {
75+
'networkId': network_id,
76+
}
77+
78+
client.jobs.wait_for_job(client.vm_virtual_nics(vm_id).create(vnic_data))
79+
80+
# Retrieve the VM
81+
vm = client.vms.get_by_id(vm_id)
82+
83+
# Update the VM, e.g. setting a new name
84+
vm['name'] = 'vm2'
85+
client.jobs.wait_for_job(client.vms.update(vm_id, vm))
86+
87+
# Start the VM
88+
client.jobs.wait_for_job(client.vms.start(vm_id))
89+
90+
# Kill the VM
91+
client.jobs.wait_for_job(client.vms.kill(vm_id))
92+
93+
# Delete the VM
94+
client.jobs.wait_for_job(client.vms.delete(vm_id))
95+
96+
# Delete the virtual disk
97+
client.jobs.wait_for_job(
98+
client.repository_virtual_disks(repo_id).delete(disk_id))
99+
100+
101+
Cloning a VM
102+
~~~~~~~~~~~~
103+
104+
How to clone a VM or a VM template::
105+
106+
import ovmclient
107+
from ovmclient import constants
108+
109+
client = ovmclient.Client(
110+
'https://host:7002/ovm/core/wsapi/rest', 'admin', 'yadayada')
111+
112+
# Make sure the manager is running
113+
client.managers.wait_for_manager_state()
114+
115+
pool_id = client.server_pools.get_id_by_name('pool1')
116+
117+
# Get an existing VM or a VM template
118+
vm_id = client.vms.get_id_by_name('vm1')
119+
120+
# Set to True to create a VM template, False for a regular VM
121+
create_template = True
122+
123+
# Clone the VM
124+
job = client.jobs.wait_for_job(
125+
client.vms.clone(vm_id, pool_id, create_template=create_template))
126+
new_vm_id = job['resultId']
127+
128+
# Rename the VM template
129+
data = client.vms.get_by_id(new_vm_id)
130+
data["name"] = 'new_name'
131+
client.jobs.wait_for_job(client.vms.update(new_vm_id, data))
132+
133+
# Delete the VM template
134+
client.jobs.wait_for_job(client.vms.delete(new_vm_id))
135+
136+
137+
Discovering servers
138+
~~~~~~~~~~~~~~~~~~~
139+
140+
How to discover and take ownership of an unowned Oracle VM host::
141+
142+
import ovmclient
143+
from ovmclient import constants
144+
145+
client = ovmclient.Client(
146+
'https://host:7002/ovm/core/wsapi/rest', 'admin', 'yadayada')
147+
148+
# Make sure the manager is running
149+
client.managers.wait_for_manager_state()
150+
151+
# Discover a new host and take ownership
152+
client.servers.discover('newovmhost')

0 commit comments

Comments
 (0)