ovirt-engine-sdk 4.0.7 → 4.0.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.adoc +10 -0
- data/lib/ovirtsdk4/connection.rb +29 -4
- data/lib/ovirtsdk4/readers.rb +8 -0
- data/lib/ovirtsdk4/services.rb +2733 -265
- data/lib/ovirtsdk4/types.rb +43 -0
- data/lib/ovirtsdk4/version.rb +1 -1
- data/lib/ovirtsdk4/writers.rb +2 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6b366c99ed9573af389d9ef85f6369e8b6c490ae
|
4
|
+
data.tar.gz: 2df99eef60a03608c252f38cdd4387003bef0385
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 576d84f2923bbcf61e60437acc23301b4b8189634f74ce133f443fd38cf1e74fe91f4a13ff6bab9a5fb6a8a956e690f9136ff0fe032c49aa0e6685ad3b9d55a7
|
7
|
+
data.tar.gz: b86cbc5412c5d77f88cfe2a4295e1ef7b8c2f340abbabea0fa51242907374544729b6d38ad263989b5a3e3496e30454bfefb7cb773fe8d00de2e37e8cef6df83
|
data/CHANGES.adoc
CHANGED
@@ -2,6 +2,16 @@
|
|
2
2
|
|
3
3
|
This document describes the relevant changes between releases of the SDK.
|
4
4
|
|
5
|
+
== 4.0.8 / Jan 27 2017
|
6
|
+
|
7
|
+
Update to model 4.0.41:
|
8
|
+
|
9
|
+
* Add `initial_size` attribute to the `Disk` type.
|
10
|
+
|
11
|
+
New features:
|
12
|
+
|
13
|
+
* Accept CA files and strings.
|
14
|
+
|
5
15
|
== 4.0.7 / Jan 12 2017
|
6
16
|
|
7
17
|
New features:
|
data/lib/ovirtsdk4/connection.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2015-
|
2
|
+
# Copyright (c) 2015-2017 Red Hat, Inc.
|
3
3
|
#
|
4
4
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
5
|
# you may not use this file except in compliance with the License.
|
@@ -15,6 +15,7 @@
|
|
15
15
|
#
|
16
16
|
|
17
17
|
require 'json'
|
18
|
+
require 'tempfile'
|
18
19
|
require 'uri'
|
19
20
|
|
20
21
|
module OvirtSDK4
|
@@ -54,8 +55,14 @@ module OvirtSDK4
|
|
54
55
|
# name should be checked.
|
55
56
|
#
|
56
57
|
# @option opts [String] :ca_file The name of a PEM file containing the trusted CA certificates. The certificate
|
57
|
-
# presented by the server will be verified using these CA certificates. If
|
58
|
-
# certificates store is used.
|
58
|
+
# presented by the server will be verified using these CA certificates. If neither this nor the `ca_certs`
|
59
|
+
# options are provided, then the system wide CA certificates store is used. If both options are provided,
|
60
|
+
# then the certificates from both options will be trusted.
|
61
|
+
#
|
62
|
+
# @option opts [Array<String>] :ca_certs An array of strings containing the trusted CA certificates, in PEM
|
63
|
+
# format. The certificate presented by the server will be verified using these CA certificates. If neither this
|
64
|
+
# nor the `ca_file` options are provided, then the system wide CA certificates store is used. If both options
|
65
|
+
# are provided, then the certificates from both options will be trusted.
|
59
66
|
#
|
60
67
|
# @option opts [Boolean] :debug (false) A boolean flag indicating if debug output should be generated. If the
|
61
68
|
# values is `true` and the `log` parameter isn't `nil` then the data sent to and received from the server will be
|
@@ -91,6 +98,7 @@ module OvirtSDK4
|
|
91
98
|
@token = opts[:token]
|
92
99
|
@insecure = opts[:insecure] || false
|
93
100
|
@ca_file = opts[:ca_file]
|
101
|
+
@ca_certs = opts[:ca_certs]
|
94
102
|
@debug = opts[:debug] || false
|
95
103
|
@log = opts[:log]
|
96
104
|
@kerberos = opts[:kerberos] || false
|
@@ -100,10 +108,24 @@ module OvirtSDK4
|
|
100
108
|
@proxy_username = opts[:proxy_username]
|
101
109
|
@proxy_password = opts[:proxy_password]
|
102
110
|
|
111
|
+
# Create a temporary file to store the CA certificates, and populate it with the contents of the 'ca_file' and
|
112
|
+
# 'ca_certs' options. The file will be removed when the connection is closed.
|
113
|
+
@ca_store = nil
|
114
|
+
if @ca_file || @ca_certs
|
115
|
+
@ca_store = Tempfile.new('ca_store')
|
116
|
+
@ca_store.write(::File.read(@ca_file)) if @ca_file
|
117
|
+
if @ca_certs
|
118
|
+
@ca_certs.each do |ca_cert|
|
119
|
+
@ca_store.write(ca_cert)
|
120
|
+
end
|
121
|
+
end
|
122
|
+
@ca_store.close
|
123
|
+
end
|
124
|
+
|
103
125
|
# Create the HTTP client:
|
104
126
|
@client = HttpClient.new(
|
105
127
|
insecure: @insecure,
|
106
|
-
ca_file: @
|
128
|
+
ca_file: @ca_store ? @ca_store.path : nil,
|
107
129
|
debug: @debug,
|
108
130
|
log: @log,
|
109
131
|
timeout: @timeout,
|
@@ -399,6 +421,9 @@ module OvirtSDK4
|
|
399
421
|
|
400
422
|
# Close the HTTP client:
|
401
423
|
@client.close if @client
|
424
|
+
|
425
|
+
# Remove the temporary file that contains the trusted CA certificates:
|
426
|
+
@ca_store.unlink if @ca_store
|
402
427
|
end
|
403
428
|
end
|
404
429
|
end
|
data/lib/ovirtsdk4/readers.rb
CHANGED
@@ -2997,6 +2997,8 @@ module OvirtSDK4
|
|
2997
2997
|
object.id = value if not value.nil?
|
2998
2998
|
value = reader.get_attribute('image_id')
|
2999
2999
|
object.image_id = value if not value.nil?
|
3000
|
+
value = reader.get_attribute('initial_size')
|
3001
|
+
object.initial_size = value if not value.nil?
|
3000
3002
|
value = reader.get_attribute('interface')
|
3001
3003
|
object.interface = value if not value.nil?
|
3002
3004
|
value = reader.get_attribute('logical_name')
|
@@ -3050,6 +3052,8 @@ module OvirtSDK4
|
|
3050
3052
|
object.id = Reader.read_string(reader)
|
3051
3053
|
when 'image_id'
|
3052
3054
|
object.image_id = Reader.read_string(reader)
|
3055
|
+
when 'initial_size'
|
3056
|
+
object.initial_size = Reader.read_integer(reader)
|
3053
3057
|
when 'interface'
|
3054
3058
|
object.interface = Reader.read_string(reader)
|
3055
3059
|
when 'logical_name'
|
@@ -3389,6 +3393,8 @@ module OvirtSDK4
|
|
3389
3393
|
object.id = value if not value.nil?
|
3390
3394
|
value = reader.get_attribute('image_id')
|
3391
3395
|
object.image_id = value if not value.nil?
|
3396
|
+
value = reader.get_attribute('initial_size')
|
3397
|
+
object.initial_size = value if not value.nil?
|
3392
3398
|
value = reader.get_attribute('interface')
|
3393
3399
|
object.interface = value if not value.nil?
|
3394
3400
|
value = reader.get_attribute('logical_name')
|
@@ -3442,6 +3448,8 @@ module OvirtSDK4
|
|
3442
3448
|
object.id = Reader.read_string(reader)
|
3443
3449
|
when 'image_id'
|
3444
3450
|
object.image_id = Reader.read_string(reader)
|
3451
|
+
when 'initial_size'
|
3452
|
+
object.initial_size = Reader.read_integer(reader)
|
3445
3453
|
when 'interface'
|
3446
3454
|
object.interface = Reader.read_string(reader)
|
3447
3455
|
when 'logical_name'
|
data/lib/ovirtsdk4/services.rb
CHANGED
@@ -2791,9 +2791,66 @@ module OvirtSDK4
|
|
2791
2791
|
end
|
2792
2792
|
|
2793
2793
|
#
|
2794
|
-
#
|
2794
|
+
# Assign a new permission to a user or group for specific entity.
|
2795
2795
|
#
|
2796
|
-
#
|
2796
|
+
# For example, to assign the `UserVmManager` role to the virtual machine with id `123` to the user with id `456`
|
2797
|
+
# send a request like this:
|
2798
|
+
#
|
2799
|
+
# ....
|
2800
|
+
# POST /ovirt-engine/api/vms/123/permissions
|
2801
|
+
# ....
|
2802
|
+
#
|
2803
|
+
# With a request body like this:
|
2804
|
+
#
|
2805
|
+
# [source,xml]
|
2806
|
+
# ----
|
2807
|
+
# <permission>
|
2808
|
+
# <role>
|
2809
|
+
# <name>UserVmManager</name>
|
2810
|
+
# </role>
|
2811
|
+
# <user id="456"/>
|
2812
|
+
# </permission>
|
2813
|
+
# ----
|
2814
|
+
#
|
2815
|
+
# To assign the `SuperUser` role to the system to the user with id `456` send a request like this:
|
2816
|
+
#
|
2817
|
+
# ....
|
2818
|
+
# POST /ovirt-engine/api/permissions
|
2819
|
+
# ....
|
2820
|
+
#
|
2821
|
+
# With a request body like this:
|
2822
|
+
#
|
2823
|
+
# [source,xml]
|
2824
|
+
# ----
|
2825
|
+
# <permission>
|
2826
|
+
# <role>
|
2827
|
+
# <name>SuperUser</name>
|
2828
|
+
# </role>
|
2829
|
+
# <user id="456"/>
|
2830
|
+
# </permission>
|
2831
|
+
# ----
|
2832
|
+
#
|
2833
|
+
# If you want to assign permission to the group instead of the user please replace the `user` element with the
|
2834
|
+
# `group` element with proper `id` of the group. For example to assign the `UserRole` role to the cluster with
|
2835
|
+
# id `123` to the group with id `789` send a request like this:
|
2836
|
+
#
|
2837
|
+
# ....
|
2838
|
+
# POST /ovirt-engine/api/clusters/123/permissions
|
2839
|
+
# ....
|
2840
|
+
#
|
2841
|
+
# With a request body like this:
|
2842
|
+
#
|
2843
|
+
# [source,xml]
|
2844
|
+
# ----
|
2845
|
+
# <permission>
|
2846
|
+
# <role>
|
2847
|
+
# <name>UserRole</name>
|
2848
|
+
# </role>
|
2849
|
+
# <group id="789"/>
|
2850
|
+
# </permission>
|
2851
|
+
# ----
|
2852
|
+
#
|
2853
|
+
# @param permission [Permission] The permission.
|
2797
2854
|
#
|
2798
2855
|
# @param opts [Hash] Additional options.
|
2799
2856
|
#
|
@@ -2827,7 +2884,29 @@ module OvirtSDK4
|
|
2827
2884
|
end
|
2828
2885
|
|
2829
2886
|
#
|
2830
|
-
#
|
2887
|
+
# List all the permissions of the specific entity.
|
2888
|
+
#
|
2889
|
+
# For example to list all the permissions of the cluster with id `123` send a request like this:
|
2890
|
+
#
|
2891
|
+
# ....
|
2892
|
+
# GET /ovirt-engine/api/clusters/123/permissions
|
2893
|
+
# ....
|
2894
|
+
#
|
2895
|
+
# [source,xml]
|
2896
|
+
# ----
|
2897
|
+
# <permissions>
|
2898
|
+
# <permission id="456">
|
2899
|
+
# <cluster id="123"/>
|
2900
|
+
# <role id="789"/>
|
2901
|
+
# <user id="451"/>
|
2902
|
+
# </permission>
|
2903
|
+
# <permission id="654">
|
2904
|
+
# <cluster id="123"/>
|
2905
|
+
# <role id="789"/>
|
2906
|
+
# <group id="127"/>
|
2907
|
+
# </permission>
|
2908
|
+
# </permissions>
|
2909
|
+
# ----
|
2831
2910
|
#
|
2832
2911
|
# @param opts [Hash] Additional options.
|
2833
2912
|
#
|
@@ -2995,7 +3074,23 @@ module OvirtSDK4
|
|
2995
3074
|
end
|
2996
3075
|
|
2997
3076
|
#
|
2998
|
-
#
|
3077
|
+
# Gets the information about the assigned tag.
|
3078
|
+
#
|
3079
|
+
# For example to retrieve the information about the tag with the id `456` which is assigned to virtual machine
|
3080
|
+
# with id `123` send a request like this:
|
3081
|
+
#
|
3082
|
+
# ....
|
3083
|
+
# GET /ovirt-engine/api/vms/123/tags/456
|
3084
|
+
# ....
|
3085
|
+
#
|
3086
|
+
# [source,xml]
|
3087
|
+
# ----
|
3088
|
+
# <tag href="/ovirt-engine/api/tags/456" id="456">
|
3089
|
+
# <name>root</name>
|
3090
|
+
# <description>root</description>
|
3091
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
3092
|
+
# </tag>
|
3093
|
+
# ----
|
2999
3094
|
#
|
3000
3095
|
# @param opts [Hash] Additional options.
|
3001
3096
|
#
|
@@ -3019,7 +3114,13 @@ module OvirtSDK4
|
|
3019
3114
|
end
|
3020
3115
|
|
3021
3116
|
#
|
3022
|
-
#
|
3117
|
+
# Unassign tag from specific entity in the system.
|
3118
|
+
#
|
3119
|
+
# For example to unassign the tag with id `456` from virtual machine with id `123` send a request like this:
|
3120
|
+
#
|
3121
|
+
# ....
|
3122
|
+
# DELETE /ovirt-engine/api/vms/123/tags/456
|
3123
|
+
# ....
|
3023
3124
|
#
|
3024
3125
|
# @param opts [Hash] Additional options.
|
3025
3126
|
#
|
@@ -3080,9 +3181,24 @@ module OvirtSDK4
|
|
3080
3181
|
end
|
3081
3182
|
|
3082
3183
|
#
|
3083
|
-
#
|
3184
|
+
# Assign tag to specific entity in the system.
|
3084
3185
|
#
|
3085
|
-
#
|
3186
|
+
# For example to assign tag `mytag` to virtual machine with the id `123` send a request like this:
|
3187
|
+
#
|
3188
|
+
# ....
|
3189
|
+
# POST /ovirt-engine/api/vms/123/tags
|
3190
|
+
# ....
|
3191
|
+
#
|
3192
|
+
# With a request body like this:
|
3193
|
+
#
|
3194
|
+
# [source,xml]
|
3195
|
+
# ----
|
3196
|
+
# <tag>
|
3197
|
+
# <name>mytag</name>
|
3198
|
+
# </tag>
|
3199
|
+
# ----
|
3200
|
+
#
|
3201
|
+
# @param tag [Tag] The assigned tag.
|
3086
3202
|
#
|
3087
3203
|
# @param opts [Hash] Additional options.
|
3088
3204
|
#
|
@@ -3116,7 +3232,24 @@ module OvirtSDK4
|
|
3116
3232
|
end
|
3117
3233
|
|
3118
3234
|
#
|
3119
|
-
#
|
3235
|
+
# List all tags assigned to the specific entity.
|
3236
|
+
#
|
3237
|
+
# For example to list all the tags of the virtual machine with id `123` send a request like this:
|
3238
|
+
#
|
3239
|
+
# ....
|
3240
|
+
# GET /ovirt-engine/api/vms/123/tags
|
3241
|
+
# ....
|
3242
|
+
#
|
3243
|
+
# [source,xml]
|
3244
|
+
# ----
|
3245
|
+
# <tags>
|
3246
|
+
# <tag href="/ovirt-engine/api/tags/222" id="222">
|
3247
|
+
# <name>mytag</name>
|
3248
|
+
# <description>mytag</description>
|
3249
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
3250
|
+
# </tag>
|
3251
|
+
# </tags>
|
3252
|
+
# ----
|
3120
3253
|
#
|
3121
3254
|
# @param opts [Hash] Additional options.
|
3122
3255
|
#
|
@@ -3147,7 +3280,7 @@ module OvirtSDK4
|
|
3147
3280
|
end
|
3148
3281
|
|
3149
3282
|
#
|
3150
|
-
#
|
3283
|
+
# Reference to the service that manages assignment of specific tag.
|
3151
3284
|
#
|
3152
3285
|
# @param id [String] The identifier of the `tag`.
|
3153
3286
|
#
|
@@ -3953,7 +4086,22 @@ module OvirtSDK4
|
|
3953
4086
|
end
|
3954
4087
|
|
3955
4088
|
#
|
3956
|
-
#
|
4089
|
+
# Get a bookmark.
|
4090
|
+
#
|
4091
|
+
# An example for getting a bookmark:
|
4092
|
+
#
|
4093
|
+
# [source]
|
4094
|
+
# ----
|
4095
|
+
# GET /ovirt-engine/api/bookmarks/123
|
4096
|
+
# ----
|
4097
|
+
#
|
4098
|
+
# [source,xml]
|
4099
|
+
# ----
|
4100
|
+
# <bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
|
4101
|
+
# <name>example_vm</name>
|
4102
|
+
# <value>vm: name=example*</value>
|
4103
|
+
# </bookmark>
|
4104
|
+
# ----
|
3957
4105
|
#
|
3958
4106
|
# @param opts [Hash] Additional options.
|
3959
4107
|
#
|
@@ -3977,7 +4125,14 @@ module OvirtSDK4
|
|
3977
4125
|
end
|
3978
4126
|
|
3979
4127
|
#
|
3980
|
-
#
|
4128
|
+
# Remove a bookmark.
|
4129
|
+
#
|
4130
|
+
# An example for removing a bookmark:
|
4131
|
+
#
|
4132
|
+
# [source]
|
4133
|
+
# ----
|
4134
|
+
# DELETE /ovirt-engine/api/bookmarks/123
|
4135
|
+
# ----
|
3981
4136
|
#
|
3982
4137
|
# @param opts [Hash] Additional options.
|
3983
4138
|
#
|
@@ -3997,9 +4152,26 @@ module OvirtSDK4
|
|
3997
4152
|
end
|
3998
4153
|
|
3999
4154
|
#
|
4000
|
-
#
|
4155
|
+
# Update a bookmark.
|
4001
4156
|
#
|
4002
|
-
#
|
4157
|
+
# An example for updating a bookmark:
|
4158
|
+
#
|
4159
|
+
# [source]
|
4160
|
+
# ----
|
4161
|
+
# PUT /ovirt-engine/api/bookmarks/123
|
4162
|
+
# ----
|
4163
|
+
#
|
4164
|
+
# With the request body:
|
4165
|
+
#
|
4166
|
+
# [source,xml]
|
4167
|
+
# ----
|
4168
|
+
# <bookmark>
|
4169
|
+
# <name>new_example_vm</name>
|
4170
|
+
# <value>vm: name=new_example*</value>
|
4171
|
+
# </bookmark>
|
4172
|
+
# ----
|
4173
|
+
#
|
4174
|
+
# @param bookmark [Bookmark] The updated bookmark.
|
4003
4175
|
# @param opts [Hash] Additional options.
|
4004
4176
|
#
|
4005
4177
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -4081,9 +4253,24 @@ module OvirtSDK4
|
|
4081
4253
|
end
|
4082
4254
|
|
4083
4255
|
#
|
4084
|
-
#
|
4256
|
+
# Adding a new bookmark.
|
4257
|
+
#
|
4258
|
+
# Example of adding a bookmark:
|
4259
|
+
#
|
4260
|
+
# [source]
|
4261
|
+
# ----
|
4262
|
+
# POST /ovirt-engine/api/bookmarks
|
4263
|
+
# ----
|
4085
4264
|
#
|
4086
|
-
#
|
4265
|
+
# [source,xml]
|
4266
|
+
# ----
|
4267
|
+
# <bookmark>
|
4268
|
+
# <name>new_example_vm</name>
|
4269
|
+
# <value>vm: name=new_example*</value>
|
4270
|
+
# </bookmark>
|
4271
|
+
# ----
|
4272
|
+
#
|
4273
|
+
# @param bookmark [Bookmark] The added bookmark.
|
4087
4274
|
#
|
4088
4275
|
# @param opts [Hash] Additional options.
|
4089
4276
|
#
|
@@ -4117,7 +4304,28 @@ module OvirtSDK4
|
|
4117
4304
|
end
|
4118
4305
|
|
4119
4306
|
#
|
4120
|
-
#
|
4307
|
+
# Listing all the available bookmarks.
|
4308
|
+
#
|
4309
|
+
# Example of listing bookmarks:
|
4310
|
+
#
|
4311
|
+
# [source]
|
4312
|
+
# ----
|
4313
|
+
# GET /ovirt-engine/api/bookmarks
|
4314
|
+
# ----
|
4315
|
+
#
|
4316
|
+
# [source,xml]
|
4317
|
+
# ----
|
4318
|
+
# <bookmarks>
|
4319
|
+
# <bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
|
4320
|
+
# <name>database</name>
|
4321
|
+
# <value>vm: name=database*</value>
|
4322
|
+
# </bookmark>
|
4323
|
+
# <bookmark href="/ovirt-engine/api/bookmarks/456" id="456">
|
4324
|
+
# <name>example</name>
|
4325
|
+
# <value>vm: name=example*</value>
|
4326
|
+
# </bookmark>
|
4327
|
+
# </bookmarks>
|
4328
|
+
# ----
|
4121
4329
|
#
|
4122
4330
|
# @param opts [Hash] Additional options.
|
4123
4331
|
#
|
@@ -4148,7 +4356,7 @@ module OvirtSDK4
|
|
4148
4356
|
end
|
4149
4357
|
|
4150
4358
|
#
|
4151
|
-
#
|
4359
|
+
# A reference to the service managing a specific bookmark.
|
4152
4360
|
#
|
4153
4361
|
# @param id [String] The identifier of the `bookmark`.
|
4154
4362
|
#
|
@@ -4204,7 +4412,85 @@ module OvirtSDK4
|
|
4204
4412
|
end
|
4205
4413
|
|
4206
4414
|
#
|
4207
|
-
#
|
4415
|
+
# Get information about the cluster.
|
4416
|
+
#
|
4417
|
+
# An example of getting a cluster:
|
4418
|
+
#
|
4419
|
+
# [source]
|
4420
|
+
# ----
|
4421
|
+
# GET /ovirt-engine/api/clusters/123
|
4422
|
+
# ----
|
4423
|
+
#
|
4424
|
+
# [source,xml]
|
4425
|
+
# ----
|
4426
|
+
# <cluster href="/ovirt-engine/api/clusters/123" id="123">
|
4427
|
+
# <actions>
|
4428
|
+
# <link href="/ovirt-engine/api/clusters/123/resetemulatedmachine" rel="resetemulatedmachine"/>
|
4429
|
+
# </actions>
|
4430
|
+
# <name>Default</name>
|
4431
|
+
# <description>The default server cluster</description>
|
4432
|
+
# <link href="/ovirt-engine/api/clusters/123/networks" rel="networks"/>
|
4433
|
+
# <link href="/ovirt-engine/api/clusters/123/permissions" rel="permissions"/>
|
4434
|
+
# <link href="/ovirt-engine/api/clusters/123/glustervolumes" rel="glustervolumes"/>
|
4435
|
+
# <link href="/ovirt-engine/api/clusters/123/glusterhooks" rel="glusterhooks"/>
|
4436
|
+
# <link href="/ovirt-engine/api/clusters/123/affinitygroups" rel="affinitygroups"/>
|
4437
|
+
# <link href="/ovirt-engine/api/clusters/123/cpuprofiles" rel="cpuprofiles"/>
|
4438
|
+
# <ballooning_enabled>false</ballooning_enabled>
|
4439
|
+
# <cpu>
|
4440
|
+
# <architecture>x86_64</architecture>
|
4441
|
+
# <type>Intel Penryn Family</type>
|
4442
|
+
# </cpu>
|
4443
|
+
# <error_handling>
|
4444
|
+
# <on_error>migrate</on_error>
|
4445
|
+
# </error_handling>
|
4446
|
+
# <fencing_policy>
|
4447
|
+
# <enabled>true</enabled>
|
4448
|
+
# <skip_if_connectivity_broken>
|
4449
|
+
# <enabled>false</enabled>
|
4450
|
+
# <threshold>50</threshold>
|
4451
|
+
# </skip_if_connectivity_broken>
|
4452
|
+
# <skip_if_sd_active>
|
4453
|
+
# <enabled>false</enabled>
|
4454
|
+
# </skip_if_sd_active>
|
4455
|
+
# </fencing_policy>
|
4456
|
+
# <gluster_service>false</gluster_service>
|
4457
|
+
# <ha_reservation>false</ha_reservation>
|
4458
|
+
# <ksm>
|
4459
|
+
# <enabled>true</enabled>
|
4460
|
+
# <merge_across_nodes>true</merge_across_nodes>
|
4461
|
+
# </ksm>
|
4462
|
+
# <maintenance_reason_required>false</maintenance_reason_required>
|
4463
|
+
# <memory_policy>
|
4464
|
+
# <over_commit>
|
4465
|
+
# <percent>100</percent>
|
4466
|
+
# </over_commit>
|
4467
|
+
# <transparent_hugepages>
|
4468
|
+
# <enabled>true</enabled>
|
4469
|
+
# </transparent_hugepages>
|
4470
|
+
# </memory_policy>
|
4471
|
+
# <migration>
|
4472
|
+
# <auto_converge>inherit</auto_converge>
|
4473
|
+
# <bandwidth>
|
4474
|
+
# <assignment_method>auto</assignment_method>
|
4475
|
+
# </bandwidth>
|
4476
|
+
# <compressed>inherit</compressed>
|
4477
|
+
# </migration>
|
4478
|
+
# <optional_reason>false</optional_reason>
|
4479
|
+
# <required_rng_sources>
|
4480
|
+
# <required_rng_source>random</required_rng_source>
|
4481
|
+
# </required_rng_sources>
|
4482
|
+
# <scheduling_policy href="/ovirt-engine/api/schedulingpolicies/456" id="456"/>
|
4483
|
+
# <threads_as_cores>false</threads_as_cores>
|
4484
|
+
# <trusted_service>false</trusted_service>
|
4485
|
+
# <tunnel_migration>false</tunnel_migration>
|
4486
|
+
# <version>
|
4487
|
+
# <major>4</major>
|
4488
|
+
# <minor>0</minor>
|
4489
|
+
# </version>
|
4490
|
+
# <virt_service>true</virt_service>
|
4491
|
+
# <data_center href="/ovirt-engine/api/datacenters/111" id="111"/>
|
4492
|
+
# </cluster>
|
4493
|
+
# ----
|
4208
4494
|
#
|
4209
4495
|
# @param opts [Hash] Additional options.
|
4210
4496
|
#
|
@@ -4350,7 +4636,7 @@ module OvirtSDK4
|
|
4350
4636
|
end
|
4351
4637
|
|
4352
4638
|
#
|
4353
|
-
#
|
4639
|
+
# Reference to the service that manages affinity groups.
|
4354
4640
|
#
|
4355
4641
|
# @return [AffinityGroupsService] A reference to `affinity_groups` service.
|
4356
4642
|
#
|
@@ -4359,7 +4645,7 @@ module OvirtSDK4
|
|
4359
4645
|
end
|
4360
4646
|
|
4361
4647
|
#
|
4362
|
-
#
|
4648
|
+
# Reference to the service that manages assigned CPU profiles for cluster.
|
4363
4649
|
#
|
4364
4650
|
# @return [AssignedCpuProfilesService] A reference to `cpu_profiles` service.
|
4365
4651
|
#
|
@@ -4368,7 +4654,7 @@ module OvirtSDK4
|
|
4368
4654
|
end
|
4369
4655
|
|
4370
4656
|
#
|
4371
|
-
#
|
4657
|
+
# Reference to the service that manages the Gluster hooks for cluster.
|
4372
4658
|
#
|
4373
4659
|
# @return [GlusterHooksService] A reference to `gluster_hooks` service.
|
4374
4660
|
#
|
@@ -4377,7 +4663,7 @@ module OvirtSDK4
|
|
4377
4663
|
end
|
4378
4664
|
|
4379
4665
|
#
|
4380
|
-
#
|
4666
|
+
# Reference to the service that manages Gluster volumes for cluster.
|
4381
4667
|
#
|
4382
4668
|
# @return [GlusterVolumesService] A reference to `gluster_volumes` service.
|
4383
4669
|
#
|
@@ -4395,7 +4681,7 @@ module OvirtSDK4
|
|
4395
4681
|
end
|
4396
4682
|
|
4397
4683
|
#
|
4398
|
-
#
|
4684
|
+
# Reference to the service that manages assigned networks for cluster.
|
4399
4685
|
#
|
4400
4686
|
# @return [AssignedNetworksService] A reference to `networks` service.
|
4401
4687
|
#
|
@@ -4404,7 +4690,7 @@ module OvirtSDK4
|
|
4404
4690
|
end
|
4405
4691
|
|
4406
4692
|
#
|
4407
|
-
#
|
4693
|
+
# Reference to permissions.
|
4408
4694
|
#
|
4409
4695
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
4410
4696
|
#
|
@@ -4498,6 +4784,37 @@ module OvirtSDK4
|
|
4498
4784
|
#
|
4499
4785
|
# Provides the information about the capabilities of the specific cluster level managed by this service.
|
4500
4786
|
#
|
4787
|
+
# For example, to find what CPU types are supported by level 3.6 you can send a request like this:
|
4788
|
+
#
|
4789
|
+
# [source]
|
4790
|
+
# ----
|
4791
|
+
# GET /ovirt-engine/api/clusterlevels/3.6
|
4792
|
+
# ----
|
4793
|
+
#
|
4794
|
+
# That will return a <<types/cluster_level, ClusterLevel>> object containing the supported CPU types, and other
|
4795
|
+
# information which describes the cluster level:
|
4796
|
+
#
|
4797
|
+
# [source,xml]
|
4798
|
+
# ----
|
4799
|
+
# <cluster_level id="3.6">
|
4800
|
+
# <cpu_types>
|
4801
|
+
# <cpu_type>
|
4802
|
+
# <name>Intel Conroe Family</name>
|
4803
|
+
# <level>3</level>
|
4804
|
+
# <architecture>x86_64</architecture>
|
4805
|
+
# </cpu_type>
|
4806
|
+
# ...
|
4807
|
+
# </cpu_types>
|
4808
|
+
# <permits>
|
4809
|
+
# <permit id="1">
|
4810
|
+
# <name>create_vm</name>
|
4811
|
+
# <administrative>false</administrative>
|
4812
|
+
# </permit>
|
4813
|
+
# ...
|
4814
|
+
# </permits>
|
4815
|
+
# </cluster_level>
|
4816
|
+
# ----
|
4817
|
+
#
|
4501
4818
|
# @param opts [Hash] Additional options.
|
4502
4819
|
#
|
4503
4820
|
# @return [ClusterLevel]
|
@@ -4563,6 +4880,23 @@ module OvirtSDK4
|
|
4563
4880
|
#
|
4564
4881
|
# Lists the cluster levels supported by the system.
|
4565
4882
|
#
|
4883
|
+
# [source]
|
4884
|
+
# ----
|
4885
|
+
# GET /ovirt-engine/api/clusterlevels
|
4886
|
+
# ----
|
4887
|
+
#
|
4888
|
+
# This will return a list of available cluster levels.
|
4889
|
+
#
|
4890
|
+
# [source,xml]
|
4891
|
+
# ----
|
4892
|
+
# <cluster_levels>
|
4893
|
+
# <cluster_level id="4.0">
|
4894
|
+
# ...
|
4895
|
+
# </cluster_level>
|
4896
|
+
# ...
|
4897
|
+
# </cluster_levels>
|
4898
|
+
# ----
|
4899
|
+
#
|
4566
4900
|
# @param opts [Hash] Additional options.
|
4567
4901
|
#
|
4568
4902
|
# @return [Array<ClusterLevel>]
|
@@ -4751,7 +5085,7 @@ module OvirtSDK4
|
|
4751
5085
|
end
|
4752
5086
|
|
4753
5087
|
#
|
4754
|
-
#
|
5088
|
+
# Reference to the service that manages a specific cluster.
|
4755
5089
|
#
|
4756
5090
|
# @param id [String] The identifier of the `cluster`.
|
4757
5091
|
#
|
@@ -5141,7 +5475,44 @@ module OvirtSDK4
|
|
5141
5475
|
end
|
5142
5476
|
|
5143
5477
|
#
|
5144
|
-
#
|
5478
|
+
# Get a data center.
|
5479
|
+
#
|
5480
|
+
# An example of getting a data center:
|
5481
|
+
#
|
5482
|
+
# [source]
|
5483
|
+
# ----
|
5484
|
+
# GET /ovirt-engine/api/datacenters/123
|
5485
|
+
# ----
|
5486
|
+
#
|
5487
|
+
# [source,xml]
|
5488
|
+
# ----
|
5489
|
+
# <data_center href="/ovirt-engine/api/datacenters/123" id="123">
|
5490
|
+
# <name>Default</name>
|
5491
|
+
# <description>The default Data Center</description>
|
5492
|
+
# <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
|
5493
|
+
# <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
|
5494
|
+
# <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
|
5495
|
+
# <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
|
5496
|
+
# <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
|
5497
|
+
# <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
|
5498
|
+
# <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
|
5499
|
+
# <local>false</local>
|
5500
|
+
# <quota_mode>disabled</quota_mode>
|
5501
|
+
# <status>up</status>
|
5502
|
+
# <storage_format>v3</storage_format>
|
5503
|
+
# <supported_versions>
|
5504
|
+
# <version>
|
5505
|
+
# <major>4</major>
|
5506
|
+
# <minor>0</minor>
|
5507
|
+
# </version>
|
5508
|
+
# </supported_versions>
|
5509
|
+
# <version>
|
5510
|
+
# <major>4</major>
|
5511
|
+
# <minor>0</minor>
|
5512
|
+
# </version>
|
5513
|
+
# <mac_pool href="/ovirt-engine/api/macpools/456" id="456"/>
|
5514
|
+
# </data_center>
|
5515
|
+
# ----
|
5145
5516
|
#
|
5146
5517
|
# @param opts [Hash] Additional options.
|
5147
5518
|
#
|
@@ -5284,7 +5655,7 @@ module OvirtSDK4
|
|
5284
5655
|
end
|
5285
5656
|
|
5286
5657
|
#
|
5287
|
-
#
|
5658
|
+
# Reference to the iSCSI bonds service.
|
5288
5659
|
#
|
5289
5660
|
# @return [IscsiBondsService] A reference to `iscsi_bonds` service.
|
5290
5661
|
#
|
@@ -5293,7 +5664,7 @@ module OvirtSDK4
|
|
5293
5664
|
end
|
5294
5665
|
|
5295
5666
|
#
|
5296
|
-
#
|
5667
|
+
# Returns a reference to the service, that manages the networks, that are associated with the data center.
|
5297
5668
|
#
|
5298
5669
|
# @return [NetworksService] A reference to `networks` service.
|
5299
5670
|
#
|
@@ -5302,7 +5673,7 @@ module OvirtSDK4
|
|
5302
5673
|
end
|
5303
5674
|
|
5304
5675
|
#
|
5305
|
-
#
|
5676
|
+
# Reference to the permissions service.
|
5306
5677
|
#
|
5307
5678
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
5308
5679
|
#
|
@@ -5311,7 +5682,7 @@ module OvirtSDK4
|
|
5311
5682
|
end
|
5312
5683
|
|
5313
5684
|
#
|
5314
|
-
#
|
5685
|
+
# Reference to the QOSs service.
|
5315
5686
|
#
|
5316
5687
|
# @return [QossService] A reference to `qoss` service.
|
5317
5688
|
#
|
@@ -5320,7 +5691,7 @@ module OvirtSDK4
|
|
5320
5691
|
end
|
5321
5692
|
|
5322
5693
|
#
|
5323
|
-
#
|
5694
|
+
# Reference to the quotas service.
|
5324
5695
|
#
|
5325
5696
|
# @return [QuotasService] A reference to `quotas` service.
|
5326
5697
|
#
|
@@ -5331,7 +5702,7 @@ module OvirtSDK4
|
|
5331
5702
|
#
|
5332
5703
|
# Attach and detach storage domains to and from a data center.
|
5333
5704
|
#
|
5334
|
-
# For attaching a single storage domain we should use the
|
5705
|
+
# For attaching a single storage domain we should use the following POST request:
|
5335
5706
|
#
|
5336
5707
|
# [source]
|
5337
5708
|
# ----
|
@@ -5347,7 +5718,7 @@ module OvirtSDK4
|
|
5347
5718
|
# </storage_domain>
|
5348
5719
|
# ----
|
5349
5720
|
#
|
5350
|
-
# For detaching a single storage domain we should use the
|
5721
|
+
# For detaching a single storage domain we should use the following DELETE request:
|
5351
5722
|
#
|
5352
5723
|
# [source]
|
5353
5724
|
# ----
|
@@ -5607,7 +5978,7 @@ module OvirtSDK4
|
|
5607
5978
|
end
|
5608
5979
|
|
5609
5980
|
#
|
5610
|
-
#
|
5981
|
+
# Reference to the service that manages a specific data center.
|
5611
5982
|
#
|
5612
5983
|
# @param id [String] The identifier of the `data_center`.
|
5613
5984
|
#
|
@@ -5665,6 +6036,24 @@ module OvirtSDK4
|
|
5665
6036
|
#
|
5666
6037
|
# Returns the details of the attachment, including the bootable flag and link to the disk.
|
5667
6038
|
#
|
6039
|
+
# An example of getting a disk attachment:
|
6040
|
+
#
|
6041
|
+
# [source]
|
6042
|
+
# ----
|
6043
|
+
# GET /ovirt-engine/api/vms/123/diskattachments/456
|
6044
|
+
# ----
|
6045
|
+
#
|
6046
|
+
# [source,xml]
|
6047
|
+
# ----
|
6048
|
+
# <disk_attachment href="/ovirt-engine/api/vms/123/diskattachments/456" id="456">
|
6049
|
+
# <active>true</active>
|
6050
|
+
# <bootable>true</bootable>
|
6051
|
+
# <interface>virtio</interface>
|
6052
|
+
# <disk href="/ovirt-engine/api/disks/456" id="456"/>
|
6053
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
6054
|
+
# </disk_attachment>
|
6055
|
+
# ----
|
6056
|
+
#
|
5668
6057
|
# @param opts [Hash] Additional options.
|
5669
6058
|
#
|
5670
6059
|
# @return [DiskAttachment]
|
@@ -5687,9 +6076,18 @@ module OvirtSDK4
|
|
5687
6076
|
end
|
5688
6077
|
|
5689
6078
|
#
|
5690
|
-
# Removes the disk attachment.
|
6079
|
+
# Removes the disk attachment.
|
6080
|
+
#
|
6081
|
+
# This will only detach the disk from the virtual machine, but won't remove it from
|
5691
6082
|
# the system, unless the `detach_only` parameter is `false`.
|
5692
6083
|
#
|
6084
|
+
# An example of removing a disk attachment:
|
6085
|
+
#
|
6086
|
+
# [source]
|
6087
|
+
# ----
|
6088
|
+
# DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true
|
6089
|
+
# ----
|
6090
|
+
#
|
5693
6091
|
# @param opts [Hash] Additional options.
|
5694
6092
|
#
|
5695
6093
|
# @option opts [Boolean] :detach_only Indicates if the disk should only be detached from the virtual machine, but not removed from the system.
|
@@ -5717,6 +6115,7 @@ module OvirtSDK4
|
|
5717
6115
|
# <disk_attachment>
|
5718
6116
|
# <bootable>true</bootable>
|
5719
6117
|
# <interface>ide</interface>
|
6118
|
+
# <active>true</active>
|
5720
6119
|
# <disk>
|
5721
6120
|
# <name>mydisk</name>
|
5722
6121
|
# <provisioned_size>1024</provisioned_size>
|
@@ -5808,6 +6207,7 @@ module OvirtSDK4
|
|
5808
6207
|
# <disk_attachment>
|
5809
6208
|
# <bootable>true</bootable>
|
5810
6209
|
# <interface>ide</interface>
|
6210
|
+
# <active>true</active>
|
5811
6211
|
# <disk id="123"/>
|
5812
6212
|
# </disk_attachment>
|
5813
6213
|
# ----
|
@@ -5819,6 +6219,7 @@ module OvirtSDK4
|
|
5819
6219
|
# <disk_attachment>
|
5820
6220
|
# <bootable>true</bootable>
|
5821
6221
|
# <interface>ide</interface>
|
6222
|
+
# <active>true</active>
|
5822
6223
|
# <disk>
|
5823
6224
|
# <name>mydisk</name>
|
5824
6225
|
# <provisioned_size>1024</provisioned_size>
|
@@ -5836,6 +6237,11 @@ module OvirtSDK4
|
|
5836
6237
|
# POST /ovirt-engine/api/vms/345/diskattachments
|
5837
6238
|
# ----
|
5838
6239
|
#
|
6240
|
+
# IMPORTANT: The server accepts requests that don't contain the `active` attribute, but the effect is
|
6241
|
+
# undefined. In some cases the disk will be automatically activated and in other cases it won't. To
|
6242
|
+
# avoid issues it is strongly recommended to always include the `active` attribute with the desired
|
6243
|
+
# value.
|
6244
|
+
#
|
5839
6245
|
# @param attachment [DiskAttachment] The `attachment` to add.
|
5840
6246
|
#
|
5841
6247
|
# @param opts [Hash] Additional options.
|
@@ -6389,11 +6795,17 @@ module OvirtSDK4
|
|
6389
6795
|
|
6390
6796
|
#
|
6391
6797
|
# Adds a new floating disk.
|
6392
|
-
# When creating a new floating <<types/disk,Disk>>, the API requires the `storage_domain`, `provisioned_size` and
|
6393
|
-
# `format` attributes.
|
6394
6798
|
#
|
6395
|
-
#
|
6396
|
-
#
|
6799
|
+
# There are three types of disks that can be added - disk image, direct LUN and
|
6800
|
+
# https://wiki.openstack.org/wiki/Cinder[Cinder] disk.
|
6801
|
+
#
|
6802
|
+
# *Adding a new image disk:*
|
6803
|
+
#
|
6804
|
+
# When creating a new floating image <<types/disk,Disk>>, the API requires the `storage_domain`, `provisioned_size`
|
6805
|
+
# and `format` attributes.
|
6806
|
+
#
|
6807
|
+
# To create a new floating image disk with specified `provisioned_size`, `format` and `name` on a storage domain
|
6808
|
+
# with an id `123`, send a request as follows:
|
6397
6809
|
#
|
6398
6810
|
# [source]
|
6399
6811
|
# ----
|
@@ -6406,15 +6818,85 @@ module OvirtSDK4
|
|
6406
6818
|
# ----
|
6407
6819
|
# <disk>
|
6408
6820
|
# <storage_domains>
|
6409
|
-
# <storage_domain id="
|
6821
|
+
# <storage_domain id="123"/>
|
6410
6822
|
# </storage_domains>
|
6411
|
-
# <name>
|
6823
|
+
# <name>mydisk</name>
|
6412
6824
|
# <provisioned_size>1048576</provisioned_size>
|
6413
6825
|
# <format>cow</format>
|
6414
6826
|
# </disk>
|
6415
6827
|
# ----
|
6416
6828
|
#
|
6417
|
-
#
|
6829
|
+
#
|
6830
|
+
# *Adding a new direct LUN disk:*
|
6831
|
+
#
|
6832
|
+
# When adding a new floating direct LUN via the API, there are two flavors that can be used:
|
6833
|
+
#
|
6834
|
+
# . With a `host` element - in this case, the host is used for sanity checks (e.g., that the LUN is visible) and
|
6835
|
+
# to retrieve basic information about the LUN (e.g., size and serial).
|
6836
|
+
# . Without a `host` element - in this case, the operation is a database-only operation, and the storage is never
|
6837
|
+
# accessed.
|
6838
|
+
#
|
6839
|
+
# To create a new floating direct LUN disk with a `host` element with an id `123`, specified `alias`, `type` and
|
6840
|
+
# `logical_unit` with an id `456` (that has the attributes `address`, `port` and `target`),
|
6841
|
+
# send a request as follows:
|
6842
|
+
#
|
6843
|
+
# [source]
|
6844
|
+
# ----
|
6845
|
+
# POST /ovirt-engine/api/disks
|
6846
|
+
# ----
|
6847
|
+
#
|
6848
|
+
# With a request body as follows:
|
6849
|
+
#
|
6850
|
+
# [source,xml]
|
6851
|
+
# ----
|
6852
|
+
# <disk>
|
6853
|
+
# <alias>mylun</alias>
|
6854
|
+
# <lun_storage>
|
6855
|
+
# <host id="123"/>
|
6856
|
+
# <type>iscsi</type>
|
6857
|
+
# <logical_units>
|
6858
|
+
# <logical_unit id="456">
|
6859
|
+
# <address>10.35.10.20</address>
|
6860
|
+
# <port>3260</port>
|
6861
|
+
# <target>iqn.2017-01.com.myhost:444</target>
|
6862
|
+
# </logical_unit>
|
6863
|
+
# </logical_units>
|
6864
|
+
# </lun_storage>
|
6865
|
+
# </disk>
|
6866
|
+
# ----
|
6867
|
+
#
|
6868
|
+
# To create a new floating direct LUN disk without using a host, remove the `host` element.
|
6869
|
+
#
|
6870
|
+
#
|
6871
|
+
# *Adding a new Cinder disk:*
|
6872
|
+
#
|
6873
|
+
# To create a new floating Cinder disk, send a request as follows:
|
6874
|
+
#
|
6875
|
+
# [source]
|
6876
|
+
# ----
|
6877
|
+
# POST /ovirt-engine/api/disks
|
6878
|
+
# ----
|
6879
|
+
#
|
6880
|
+
# With a request body as follows:
|
6881
|
+
#
|
6882
|
+
# [source,xml]
|
6883
|
+
# ----
|
6884
|
+
# <disk>
|
6885
|
+
# <openstack_volume_type>
|
6886
|
+
# <name>myceph</name>
|
6887
|
+
# </openstack_volume_type>
|
6888
|
+
# <storage_domains>
|
6889
|
+
# <storage_domain>
|
6890
|
+
# <name>cinderDomain</name>
|
6891
|
+
# </storage_domain>
|
6892
|
+
# </storage_domains>
|
6893
|
+
# <provisioned_size>1073741824</provisioned_size>
|
6894
|
+
# <interface>virtio</interface>
|
6895
|
+
# <format>raw</format>
|
6896
|
+
# </disk>
|
6897
|
+
# ----
|
6898
|
+
#
|
6899
|
+
# @param disk [Disk] The disk.
|
6418
6900
|
#
|
6419
6901
|
# @param opts [Hash] Additional options.
|
6420
6902
|
#
|
@@ -6448,7 +6930,37 @@ module OvirtSDK4
|
|
6448
6930
|
end
|
6449
6931
|
|
6450
6932
|
#
|
6451
|
-
#
|
6933
|
+
# Get list of disks.
|
6934
|
+
#
|
6935
|
+
# [source]
|
6936
|
+
# ----
|
6937
|
+
# GET /ovirt-engine/api/disks
|
6938
|
+
# ----
|
6939
|
+
#
|
6940
|
+
# You will get a XML response which will look like this one:
|
6941
|
+
#
|
6942
|
+
# [source,xml]
|
6943
|
+
# ----
|
6944
|
+
# <disks>
|
6945
|
+
# <disk id="123">
|
6946
|
+
# <actions>...</actions>
|
6947
|
+
# <name>MyDisk</name>
|
6948
|
+
# <description>MyDisk description</description>
|
6949
|
+
# <link href="/ovirt-engine/api/disks/123/permissions" rel="permissions"/>
|
6950
|
+
# <link href="/ovirt-engine/api/disks/123/statistics" rel="statistics"/>
|
6951
|
+
# <actual_size>5345845248</actual_size>
|
6952
|
+
# <alias>MyDisk alias</alias>
|
6953
|
+
# ...
|
6954
|
+
# <status>ok</status>
|
6955
|
+
# <storage_type>image</storage_type>
|
6956
|
+
# <wipe_after_delete>false</wipe_after_delete>
|
6957
|
+
# <disk_profile id="123"/>
|
6958
|
+
# <quota id="123"/>
|
6959
|
+
# <storage_domains>...</storage_domains>
|
6960
|
+
# </disk>
|
6961
|
+
# ...
|
6962
|
+
# </disks>
|
6963
|
+
# ----
|
6452
6964
|
#
|
6453
6965
|
# @param opts [Hash] Additional options.
|
6454
6966
|
#
|
@@ -6494,7 +7006,7 @@ module OvirtSDK4
|
|
6494
7006
|
end
|
6495
7007
|
|
6496
7008
|
#
|
6497
|
-
#
|
7009
|
+
# Reference to a service managing a specific disk.
|
6498
7010
|
#
|
6499
7011
|
# @param id [String] The identifier of the `disk`.
|
6500
7012
|
#
|
@@ -6550,7 +7062,26 @@ module OvirtSDK4
|
|
6550
7062
|
end
|
6551
7063
|
|
6552
7064
|
#
|
6553
|
-
#
|
7065
|
+
# Gets the authentication domain information.
|
7066
|
+
#
|
7067
|
+
# Usage:
|
7068
|
+
#
|
7069
|
+
# ....
|
7070
|
+
# GET /ovirt-engine/api/domains/5678
|
7071
|
+
# ....
|
7072
|
+
#
|
7073
|
+
# Will return the domain information:
|
7074
|
+
#
|
7075
|
+
# [source,xml]
|
7076
|
+
# ----
|
7077
|
+
# <domain href="/ovirt-engine/api/domains/5678" id="5678">
|
7078
|
+
# <name>internal-authz</name>
|
7079
|
+
# <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
|
7080
|
+
# <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
|
7081
|
+
# <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
|
7082
|
+
# <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
|
7083
|
+
# </domain>
|
7084
|
+
# ----
|
6554
7085
|
#
|
6555
7086
|
# @param opts [Hash] Additional options.
|
6556
7087
|
#
|
@@ -6574,7 +7105,7 @@ module OvirtSDK4
|
|
6574
7105
|
end
|
6575
7106
|
|
6576
7107
|
#
|
6577
|
-
#
|
7108
|
+
# Reference to a service to manage domain groups.
|
6578
7109
|
#
|
6579
7110
|
# @return [DomainGroupsService] A reference to `groups` service.
|
6580
7111
|
#
|
@@ -6583,7 +7114,7 @@ module OvirtSDK4
|
|
6583
7114
|
end
|
6584
7115
|
|
6585
7116
|
#
|
6586
|
-
#
|
7117
|
+
# Reference to a service to manage domain users.
|
6587
7118
|
#
|
6588
7119
|
# @return [DomainUsersService] A reference to `users` service.
|
6589
7120
|
#
|
@@ -6812,7 +7343,29 @@ module OvirtSDK4
|
|
6812
7343
|
end
|
6813
7344
|
|
6814
7345
|
#
|
6815
|
-
#
|
7346
|
+
# Gets the domain user information.
|
7347
|
+
#
|
7348
|
+
# Usage:
|
7349
|
+
#
|
7350
|
+
# ....
|
7351
|
+
# GET /ovirt-engine/api/domains/5678/users/1234
|
7352
|
+
# ....
|
7353
|
+
#
|
7354
|
+
# Will return the domain user information:
|
7355
|
+
#
|
7356
|
+
# [source,xml]
|
7357
|
+
# ----
|
7358
|
+
# <user href="/ovirt-engine/api/users/1234" id="1234">
|
7359
|
+
# <name>admin</name>
|
7360
|
+
# <namespace>*</namespace>
|
7361
|
+
# <principal>admin</principal>
|
7362
|
+
# <user_name>admin@internal-authz</user_name>
|
7363
|
+
# <domain href="/ovirt-engine/api/domains/5678" id="5678">
|
7364
|
+
# <name>internal-authz</name>
|
7365
|
+
# </domain>
|
7366
|
+
# <groups/>
|
7367
|
+
# </user>
|
7368
|
+
# ----
|
6816
7369
|
#
|
6817
7370
|
# @param opts [Hash] Additional options.
|
6818
7371
|
#
|
@@ -6877,7 +7430,31 @@ module OvirtSDK4
|
|
6877
7430
|
end
|
6878
7431
|
|
6879
7432
|
#
|
6880
|
-
#
|
7433
|
+
# List all the users in the domain.
|
7434
|
+
#
|
7435
|
+
# Usage:
|
7436
|
+
#
|
7437
|
+
# ....
|
7438
|
+
# GET /ovirt-engine/api/domains/5678/users
|
7439
|
+
# ....
|
7440
|
+
#
|
7441
|
+
# Will return the list of users in the domain:
|
7442
|
+
#
|
7443
|
+
# [source,xml]
|
7444
|
+
# ----
|
7445
|
+
# <users>
|
7446
|
+
# <user href="/ovirt-engine/api/domains/5678/users/1234" id="1234">
|
7447
|
+
# <name>admin</name>
|
7448
|
+
# <namespace>*</namespace>
|
7449
|
+
# <principal>admin</principal>
|
7450
|
+
# <user_name>admin@internal-authz</user_name>
|
7451
|
+
# <domain href="/ovirt-engine/api/domains/5678" id="5678">
|
7452
|
+
# <name>internal-authz</name>
|
7453
|
+
# </domain>
|
7454
|
+
# <groups/>
|
7455
|
+
# </user>
|
7456
|
+
# </users>
|
7457
|
+
# ----
|
6881
7458
|
#
|
6882
7459
|
# @param opts [Hash] Additional options.
|
6883
7460
|
#
|
@@ -6923,7 +7500,7 @@ module OvirtSDK4
|
|
6923
7500
|
end
|
6924
7501
|
|
6925
7502
|
#
|
6926
|
-
#
|
7503
|
+
# Reference to a service to view details of a domain user.
|
6927
7504
|
#
|
6928
7505
|
# @param id [String] The identifier of the `user`.
|
6929
7506
|
#
|
@@ -6979,7 +7556,28 @@ module OvirtSDK4
|
|
6979
7556
|
end
|
6980
7557
|
|
6981
7558
|
#
|
6982
|
-
#
|
7559
|
+
# List all the authentication domains in the system.
|
7560
|
+
#
|
7561
|
+
# Usage:
|
7562
|
+
#
|
7563
|
+
# ....
|
7564
|
+
# GET /ovirt-engine/api/domains
|
7565
|
+
# ....
|
7566
|
+
#
|
7567
|
+
# Will return the list of domains:
|
7568
|
+
#
|
7569
|
+
# [source,xml]
|
7570
|
+
# ----
|
7571
|
+
# <domains>
|
7572
|
+
# <domain href="/ovirt-engine/api/domains/5678" id="5678">
|
7573
|
+
# <name>internal-authz</name>
|
7574
|
+
# <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
|
7575
|
+
# <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
|
7576
|
+
# <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
|
7577
|
+
# <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
|
7578
|
+
# </domain>
|
7579
|
+
# </domains>
|
7580
|
+
# ----
|
6983
7581
|
#
|
6984
7582
|
# @param opts [Hash] Additional options.
|
6985
7583
|
#
|
@@ -7010,7 +7608,7 @@ module OvirtSDK4
|
|
7010
7608
|
end
|
7011
7609
|
|
7012
7610
|
#
|
7013
|
-
#
|
7611
|
+
# Reference to a service to view details of a domain.
|
7014
7612
|
#
|
7015
7613
|
# @param id [String] The identifier of the `domain`.
|
7016
7614
|
#
|
@@ -7066,7 +7664,35 @@ module OvirtSDK4
|
|
7066
7664
|
end
|
7067
7665
|
|
7068
7666
|
#
|
7069
|
-
#
|
7667
|
+
# Get an event.
|
7668
|
+
#
|
7669
|
+
# An example of getting an event:
|
7670
|
+
#
|
7671
|
+
# [source]
|
7672
|
+
# ----
|
7673
|
+
# GET /ovirt-engine/api/events/123
|
7674
|
+
# ----
|
7675
|
+
#
|
7676
|
+
# [source,xml]
|
7677
|
+
# ----
|
7678
|
+
# <event href="/ovirt-engine/api/events/123" id="123">
|
7679
|
+
# <description>Host example.com was added by admin@internal-authz.</description>
|
7680
|
+
# <code>42</code>
|
7681
|
+
# <correlation_id>135</correlation_id>
|
7682
|
+
# <custom_id>-1</custom_id>
|
7683
|
+
# <flood_rate>30</flood_rate>
|
7684
|
+
# <origin>oVirt</origin>
|
7685
|
+
# <severity>normal</severity>
|
7686
|
+
# <time>2016-12-11T11:13:44.654+02:00</time>
|
7687
|
+
# <cluster href="/ovirt-engine/api/clusters/456" id="456"/>
|
7688
|
+
# <host href="/ovirt-engine/api/hosts/789" id="789"/>
|
7689
|
+
# <user href="/ovirt-engine/api/users/987" id="987"/>
|
7690
|
+
# </event>
|
7691
|
+
# ----
|
7692
|
+
#
|
7693
|
+
# Note that the number of fields changes according to the information that resides on the event.
|
7694
|
+
# For example, for storage domain related events you will get the storage domain reference,
|
7695
|
+
# as well as the reference for the data center this storage domain resides in.
|
7070
7696
|
#
|
7071
7697
|
# @param opts [Hash] Additional options.
|
7072
7698
|
#
|
@@ -7235,7 +7861,7 @@ module OvirtSDK4
|
|
7235
7861
|
# GET /ovirt-engine/api/events
|
7236
7862
|
# ----
|
7237
7863
|
#
|
7238
|
-
# To the above request we get following
|
7864
|
+
# To the above request we get following response:
|
7239
7865
|
#
|
7240
7866
|
# [source,xml]
|
7241
7867
|
# ----
|
@@ -7420,7 +8046,7 @@ module OvirtSDK4
|
|
7420
8046
|
end
|
7421
8047
|
|
7422
8048
|
#
|
7423
|
-
#
|
8049
|
+
# Reference to the service that manages a specific event.
|
7424
8050
|
#
|
7425
8051
|
# @param id [String] The identifier of the `event`.
|
7426
8052
|
#
|
@@ -9213,13 +9839,37 @@ module OvirtSDK4
|
|
9213
9839
|
end
|
9214
9840
|
|
9215
9841
|
#
|
9216
|
-
#
|
9842
|
+
# Activate the bricks post data migration of remove brick operation.
|
9843
|
+
#
|
9844
|
+
# Used to activate brick(s) once the data migration from bricks is complete but user no longer wishes to remove
|
9845
|
+
# bricks. The bricks that were previously marked for removal will now be used as normal bricks.
|
9846
|
+
#
|
9847
|
+
# For example, to retain the bricks that on glustervolume `123` from which data was migrated, send a request like
|
9848
|
+
# this:
|
9849
|
+
#
|
9850
|
+
# [source]
|
9851
|
+
# ----
|
9852
|
+
# POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activate
|
9853
|
+
# ----
|
9854
|
+
#
|
9855
|
+
# With a request body like this:
|
9856
|
+
#
|
9857
|
+
# [source,xml]
|
9858
|
+
# ----
|
9859
|
+
# <action>
|
9860
|
+
# <bricks>
|
9861
|
+
# <brick>
|
9862
|
+
# <name>host1:/rhgs/brick1</name>
|
9863
|
+
# </brick>
|
9864
|
+
# </bricks>
|
9865
|
+
# </action>
|
9866
|
+
# ----
|
9217
9867
|
#
|
9218
9868
|
# @param opts [Hash] Additional options.
|
9219
9869
|
#
|
9220
9870
|
# @option opts [Boolean] :async Indicates if the activation should be performed asynchronously.
|
9221
9871
|
#
|
9222
|
-
# @option opts [Array<GlusterBrick>] :bricks
|
9872
|
+
# @option opts [Array<GlusterBrick>] :bricks The list of bricks that need to be re-activated.
|
9223
9873
|
#
|
9224
9874
|
def activate(opts = {})
|
9225
9875
|
action = Action.new(opts)
|
@@ -9242,13 +9892,39 @@ module OvirtSDK4
|
|
9242
9892
|
end
|
9243
9893
|
|
9244
9894
|
#
|
9245
|
-
# Adds
|
9246
|
-
#
|
9895
|
+
# Adds a list of bricks to gluster volume.
|
9896
|
+
#
|
9897
|
+
# Used to expand a gluster volume by adding bricks. For replicated volume types, the parameter `replica_count`
|
9898
|
+
# needs to be passed. In case the replica count is being increased, then the number of bricks needs to be
|
9899
|
+
# equivalent to the number of replica sets.
|
9900
|
+
#
|
9901
|
+
# For example, to add bricks to gluster volume `123`, send a request like this:
|
9902
|
+
#
|
9903
|
+
# [source]
|
9904
|
+
# ----
|
9905
|
+
# POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
|
9906
|
+
# ----
|
9907
|
+
#
|
9908
|
+
# With a request body like this:
|
9909
|
+
#
|
9910
|
+
# [source,xml]
|
9911
|
+
# ----
|
9912
|
+
# <bricks>
|
9913
|
+
# <brick>
|
9914
|
+
# <server_id>111</server_id>
|
9915
|
+
# <brick_dir>/export/data/brick3</brick_dir>
|
9916
|
+
# </brick>
|
9917
|
+
# </bricks>
|
9918
|
+
# ----
|
9247
9919
|
#
|
9248
9920
|
# @param bricks [Array<GlusterBrick>] The list of bricks to be added to the volume
|
9249
9921
|
#
|
9250
9922
|
# @param opts [Hash] Additional options.
|
9251
9923
|
#
|
9924
|
+
# @option opts [Integer] :replica_count Replica count of volume post add operation.
|
9925
|
+
#
|
9926
|
+
# @option opts [Integer] :stripe_count Stripe count of volume post add operation.
|
9927
|
+
#
|
9252
9928
|
# @return [Array<GlusterBrick>]
|
9253
9929
|
#
|
9254
9930
|
def add(bricks, opts = {})
|
@@ -9261,6 +9937,16 @@ module OvirtSDK4
|
|
9261
9937
|
end
|
9262
9938
|
end
|
9263
9939
|
query = {}
|
9940
|
+
value = opts[:replica_count]
|
9941
|
+
unless value.nil?
|
9942
|
+
value = Writer.render_integer(value)
|
9943
|
+
query['replica_count'] = value
|
9944
|
+
end
|
9945
|
+
value = opts[:stripe_count]
|
9946
|
+
unless value.nil?
|
9947
|
+
value = Writer.render_integer(value)
|
9948
|
+
query['stripe_count'] = value
|
9949
|
+
end
|
9264
9950
|
request = HttpRequest.new(method: :POST, url: @path, query: query)
|
9265
9951
|
begin
|
9266
9952
|
writer = XmlWriter.new(nil, true)
|
@@ -9284,7 +9970,34 @@ module OvirtSDK4
|
|
9284
9970
|
end
|
9285
9971
|
|
9286
9972
|
#
|
9287
|
-
#
|
9973
|
+
# Lists the bricks of a gluster volume.
|
9974
|
+
#
|
9975
|
+
# For example, to list bricks of gluster volume `123`, send a request like this:
|
9976
|
+
#
|
9977
|
+
# [source]
|
9978
|
+
# ----
|
9979
|
+
# GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
|
9980
|
+
# ----
|
9981
|
+
#
|
9982
|
+
# Provides an output as below:
|
9983
|
+
#
|
9984
|
+
# [source,xml]
|
9985
|
+
# ----
|
9986
|
+
# <bricks>
|
9987
|
+
# <brick id="234">
|
9988
|
+
# <name>host1:/rhgs/data/brick1</name>
|
9989
|
+
# <brick_dir>/rhgs/data/brick1</brick_dir>
|
9990
|
+
# <server_id>111</server_id>
|
9991
|
+
# <status>up</status>
|
9992
|
+
# </brick>
|
9993
|
+
# <brick id="233">
|
9994
|
+
# <name>host2:/rhgs/data/brick1</name>
|
9995
|
+
# <brick_dir>/rhgs/data/brick1</brick_dir>
|
9996
|
+
# <server_id>222</server_id>
|
9997
|
+
# <status>up</status>
|
9998
|
+
# </brick>
|
9999
|
+
# </bricks>
|
10000
|
+
# ----
|
9288
10001
|
#
|
9289
10002
|
# @param opts [Hash] Additional options.
|
9290
10003
|
#
|
@@ -9315,13 +10028,41 @@ module OvirtSDK4
|
|
9315
10028
|
end
|
9316
10029
|
|
9317
10030
|
#
|
9318
|
-
#
|
10031
|
+
# Start migration of data prior to removing bricks.
|
10032
|
+
#
|
10033
|
+
# Removing bricks is a two-step process, where the data on bricks to be removed, is first migrated to remaining
|
10034
|
+
# bricks. Once migration is completed the removal of bricks is confirmed via the API
|
10035
|
+
# <<services/gluster_bricks/methods/remove, remove>>. If at any point, the action needs to be cancelled
|
10036
|
+
# <<services/gluster_bricks/methods/stop_migrate, stopmigrate>> has to be called.
|
10037
|
+
#
|
10038
|
+
# For instance, to delete a brick from a gluster volume with id `123`, send a request:
|
10039
|
+
#
|
10040
|
+
# [source]
|
10041
|
+
# ----
|
10042
|
+
# POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrate
|
10043
|
+
# ----
|
10044
|
+
#
|
10045
|
+
# With a request body like this:
|
10046
|
+
#
|
10047
|
+
# [source,xml]
|
10048
|
+
# ----
|
10049
|
+
# <action>
|
10050
|
+
# <bricks>
|
10051
|
+
# <brick>
|
10052
|
+
# <name>host1:/rhgs/brick1</name>
|
10053
|
+
# </brick>
|
10054
|
+
# </bricks>
|
10055
|
+
# </action>
|
10056
|
+
# ----
|
10057
|
+
#
|
10058
|
+
# The migration process can be tracked from the job id returned from the API using
|
10059
|
+
# <<services/job/methods/get, job>> and steps in job using <<services/step/methods/get, step>>
|
9319
10060
|
#
|
9320
10061
|
# @param opts [Hash] Additional options.
|
9321
10062
|
#
|
9322
10063
|
# @option opts [Boolean] :async Indicates if the migration should be performed asynchronously.
|
9323
10064
|
#
|
9324
|
-
# @option opts [Array<GlusterBrick>] :bricks
|
10065
|
+
# @option opts [Array<GlusterBrick>] :bricks List of bricks for which data migration needs to be started.
|
9325
10066
|
#
|
9326
10067
|
def migrate(opts = {})
|
9327
10068
|
action = Action.new(opts)
|
@@ -9344,12 +10085,35 @@ module OvirtSDK4
|
|
9344
10085
|
end
|
9345
10086
|
|
9346
10087
|
#
|
9347
|
-
# Removes
|
10088
|
+
# Removes bricks from gluster volume.
|
10089
|
+
#
|
10090
|
+
# The recommended way to remove bricks without data loss is to first migrate the data using
|
10091
|
+
# <<services/gluster_bricks/methods/stop_migrate, stopmigrate>> and then removing them. If migrate was not called on
|
10092
|
+
# bricks prior to remove, the bricks are removed without data migration which may lead to data loss.
|
10093
|
+
#
|
10094
|
+
# For example, to delete the bricks from gluster volume `123`, send a request like this:
|
10095
|
+
#
|
10096
|
+
# [source]
|
10097
|
+
# ----
|
10098
|
+
# DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
|
10099
|
+
# ----
|
10100
|
+
#
|
10101
|
+
# With a request body like this:
|
10102
|
+
#
|
10103
|
+
# [source,xml]
|
10104
|
+
# ----
|
10105
|
+
# <bricks>
|
10106
|
+
# <brick>
|
10107
|
+
# <name>host:brick_directory</name>
|
10108
|
+
# </brick>
|
10109
|
+
# </bricks>
|
10110
|
+
# ----
|
9348
10111
|
#
|
9349
10112
|
# @param opts [Hash] Additional options.
|
9350
10113
|
#
|
9351
10114
|
# @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
|
9352
10115
|
# @option opts [Array<GlusterBrick>] :bricks The list of bricks to be removed
|
10116
|
+
# @option opts [Integer] :replica_count Replica count of volume post add operation.
|
9353
10117
|
def remove(opts = {})
|
9354
10118
|
query = {}
|
9355
10119
|
value = opts[:async]
|
@@ -9361,6 +10125,11 @@ module OvirtSDK4
|
|
9361
10125
|
unless value.nil?
|
9362
10126
|
query['bricks'] = value
|
9363
10127
|
end
|
10128
|
+
value = opts[:replica_count]
|
10129
|
+
unless value.nil?
|
10130
|
+
value = Writer.render_integer(value)
|
10131
|
+
query['replica_count'] = value
|
10132
|
+
end
|
9364
10133
|
request = HttpRequest.new(method: :DELETE, url: @path, query: query)
|
9365
10134
|
response = @connection.send(request)
|
9366
10135
|
unless response.code == 200
|
@@ -9369,13 +10138,36 @@ module OvirtSDK4
|
|
9369
10138
|
end
|
9370
10139
|
|
9371
10140
|
#
|
9372
|
-
#
|
10141
|
+
# Stops migration of data from bricks for a remove brick operation.
|
10142
|
+
#
|
10143
|
+
# To cancel data migration that was started as part of the 2-step remove brick process in case the user wishes to
|
10144
|
+
# continue using the bricks. The bricks that were marked for removal will function as normal bricks post this
|
10145
|
+
# operation.
|
10146
|
+
#
|
10147
|
+
# For example, to stop migration of data from the bricks of gluster volume `123`, send a request like this:
|
10148
|
+
#
|
10149
|
+
# [source]
|
10150
|
+
# ----
|
10151
|
+
# POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrate
|
10152
|
+
# ----
|
10153
|
+
#
|
10154
|
+
# With a request body like this:
|
10155
|
+
#
|
10156
|
+
# [source,xml]
|
10157
|
+
# ----
|
10158
|
+
# <bricks>
|
10159
|
+
# <brick>
|
10160
|
+
# <name>host:brick_directory</name>
|
10161
|
+
# </brick>
|
10162
|
+
# </bricks>
|
10163
|
+
# ----
|
9373
10164
|
#
|
9374
10165
|
# @param opts [Hash] Additional options.
|
9375
10166
|
#
|
9376
10167
|
# @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
|
9377
10168
|
#
|
9378
|
-
# @option opts [Array<GlusterBrick>] :bricks
|
10169
|
+
# @option opts [Array<GlusterBrick>] :bricks List of bricks for which data migration needs to be stopped. This list should match the arguments passed to
|
10170
|
+
# <<services/gluster_bricks/methods/migrate, migrate>>.
|
9379
10171
|
#
|
9380
10172
|
def stop_migrate(opts = {})
|
9381
10173
|
action = Action.new(opts)
|
@@ -9398,7 +10190,7 @@ module OvirtSDK4
|
|
9398
10190
|
end
|
9399
10191
|
|
9400
10192
|
#
|
9401
|
-
#
|
10193
|
+
# Returns a reference to the service managing a single gluster brick.
|
9402
10194
|
#
|
9403
10195
|
# @param id [String] The identifier of the `brick`.
|
9404
10196
|
#
|
@@ -9721,10 +10513,44 @@ module OvirtSDK4
|
|
9721
10513
|
end
|
9722
10514
|
|
9723
10515
|
#
|
9724
|
-
# Creates a new
|
9725
|
-
#
|
10516
|
+
# Creates a new gluster volume.
|
10517
|
+
#
|
10518
|
+
# The volume is created based on properties of the `volume` parameter. The properties `name`, `volume_type` and
|
10519
|
+
# `bricks` are required.
|
10520
|
+
#
|
10521
|
+
# For example, to add a volume with name `myvolume` to the cluster `123`, send the following request:
|
10522
|
+
#
|
10523
|
+
# [source]
|
10524
|
+
# ----
|
10525
|
+
# POST /ovirt-engine/api/clusters/123/glustervolumes
|
10526
|
+
# ----
|
10527
|
+
#
|
10528
|
+
# With the following request body:
|
9726
10529
|
#
|
9727
|
-
#
|
10530
|
+
# [source,xml]
|
10531
|
+
# ----
|
10532
|
+
# <gluster_volume>
|
10533
|
+
# <name>myvolume</name>
|
10534
|
+
# <volume_type>replicate</volume_type>
|
10535
|
+
# <replica_count>3</replica_count>
|
10536
|
+
# <bricks>
|
10537
|
+
# <brick>
|
10538
|
+
# <server_id>server1</server_id>
|
10539
|
+
# <brick_dir>/exp1</brick_dir>
|
10540
|
+
# </brick>
|
10541
|
+
# <brick>
|
10542
|
+
# <server_id>server2</server_id>
|
10543
|
+
# <brick_dir>/exp1</brick_dir>
|
10544
|
+
# </brick>
|
10545
|
+
# <brick>
|
10546
|
+
# <server_id>server3</server_id>
|
10547
|
+
# <brick_dir>/exp1</brick_dir>
|
10548
|
+
# </brick>
|
10549
|
+
# <bricks>
|
10550
|
+
# </gluster_volume>
|
10551
|
+
# ----
|
10552
|
+
#
|
10553
|
+
# @param volume [GlusterVolume] The gluster volume definition from which to create the volume is passed as input and the newly created
|
9728
10554
|
# volume is returned.
|
9729
10555
|
#
|
9730
10556
|
# @param opts [Hash] Additional options.
|
@@ -9759,7 +10585,15 @@ module OvirtSDK4
|
|
9759
10585
|
end
|
9760
10586
|
|
9761
10587
|
#
|
9762
|
-
#
|
10588
|
+
# Lists all gluster volumes in the cluster.
|
10589
|
+
#
|
10590
|
+
# For example, to list all Gluster Volumes in cluster `456`, send a request like
|
10591
|
+
# this:
|
10592
|
+
#
|
10593
|
+
# [source]
|
10594
|
+
# ----
|
10595
|
+
# GET /ovirt-engine/api/clusters/456/glustervolumes
|
10596
|
+
# ----
|
9763
10597
|
#
|
9764
10598
|
# @param opts [Hash] Additional options.
|
9765
10599
|
#
|
@@ -9805,7 +10639,7 @@ module OvirtSDK4
|
|
9805
10639
|
end
|
9806
10640
|
|
9807
10641
|
#
|
9808
|
-
#
|
10642
|
+
# Reference to a service managing gluster volume.
|
9809
10643
|
#
|
9810
10644
|
# @param id [String] The identifier of the `volume`.
|
9811
10645
|
#
|
@@ -10004,7 +10838,7 @@ module OvirtSDK4
|
|
10004
10838
|
#
|
10005
10839
|
# [source]
|
10006
10840
|
# ----
|
10007
|
-
# GET /
|
10841
|
+
# GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true
|
10008
10842
|
# ----
|
10009
10843
|
#
|
10010
10844
|
# The default value is `false`.
|
@@ -10385,7 +11219,26 @@ module OvirtSDK4
|
|
10385
11219
|
end
|
10386
11220
|
|
10387
11221
|
#
|
10388
|
-
#
|
11222
|
+
# Retrieve information about a particular host's device.
|
11223
|
+
#
|
11224
|
+
# An example of getting a host device:
|
11225
|
+
#
|
11226
|
+
# [source]
|
11227
|
+
# ----
|
11228
|
+
# GET /ovirt-engine/api/hosts/123/devices/456
|
11229
|
+
# ----
|
11230
|
+
#
|
11231
|
+
# [source,xml]
|
11232
|
+
# ----
|
11233
|
+
# <host_device href="/ovirt-engine/api/hosts/123/devices/456" id="456">
|
11234
|
+
# <name>usb_1_9_1_1_0</name>
|
11235
|
+
# <capability>usb</capability>
|
11236
|
+
# <host href="/ovirt-engine/api/hosts/123" id="123"/>
|
11237
|
+
# <parent_device href="/ovirt-engine/api/hosts/123/devices/789" id="789">
|
11238
|
+
# <name>usb_1_9_1</name>
|
11239
|
+
# </parent_device>
|
11240
|
+
# </host_device>
|
11241
|
+
# ----
|
10389
11242
|
#
|
10390
11243
|
# @param opts [Hash] Additional options.
|
10391
11244
|
#
|
@@ -10450,7 +11303,7 @@ module OvirtSDK4
|
|
10450
11303
|
end
|
10451
11304
|
|
10452
11305
|
#
|
10453
|
-
#
|
11306
|
+
# List the devices of a host.
|
10454
11307
|
#
|
10455
11308
|
# @param opts [Hash] Additional options.
|
10456
11309
|
#
|
@@ -10481,7 +11334,7 @@ module OvirtSDK4
|
|
10481
11334
|
end
|
10482
11335
|
|
10483
11336
|
#
|
10484
|
-
#
|
11337
|
+
# Reference to the service that can be used to access a specific host device.
|
10485
11338
|
#
|
10486
11339
|
# @param id [String] The identifier of the `device`.
|
10487
11340
|
#
|
@@ -10720,7 +11573,7 @@ module OvirtSDK4
|
|
10720
11573
|
end
|
10721
11574
|
|
10722
11575
|
#
|
10723
|
-
#
|
11576
|
+
# Reference to the service that manages a single network interface.
|
10724
11577
|
#
|
10725
11578
|
# @param id [String] The identifier of the `nic`.
|
10726
11579
|
#
|
@@ -10863,7 +11716,24 @@ module OvirtSDK4
|
|
10863
11716
|
end
|
10864
11717
|
|
10865
11718
|
#
|
10866
|
-
#
|
11719
|
+
# Get list of storages.
|
11720
|
+
#
|
11721
|
+
# [source]
|
11722
|
+
# ----
|
11723
|
+
# GET /ovirt-engine/api/hosts/123/storage
|
11724
|
+
# ----
|
11725
|
+
#
|
11726
|
+
# The XML response you get will be like this one:
|
11727
|
+
#
|
11728
|
+
# [source,xml]
|
11729
|
+
# ----
|
11730
|
+
# <host_storages>
|
11731
|
+
# <host_storage id="123">
|
11732
|
+
# ...
|
11733
|
+
# </host_storage>
|
11734
|
+
# ...
|
11735
|
+
# </host_storages>
|
11736
|
+
# ----
|
10867
11737
|
#
|
10868
11738
|
# @param opts [Hash] Additional options.
|
10869
11739
|
#
|
@@ -10878,21 +11748,21 @@ module OvirtSDK4
|
|
10878
11748
|
#
|
10879
11749
|
# [source,xml]
|
10880
11750
|
# ----
|
10881
|
-
# <host_storage id="
|
11751
|
+
# <host_storage id="123">
|
10882
11752
|
# <logical_units>
|
10883
|
-
# <logical_unit id="
|
11753
|
+
# <logical_unit id="123">
|
10884
11754
|
# <lun_mapping>0</lun_mapping>
|
10885
11755
|
# <paths>1</paths>
|
10886
11756
|
# <product_id>lun0</product_id>
|
10887
|
-
# <serial>
|
11757
|
+
# <serial>123</serial>
|
10888
11758
|
# <size>10737418240</size>
|
10889
11759
|
# <status>used</status>
|
10890
11760
|
# <vendor_id>LIO-ORG</vendor_id>
|
10891
|
-
# <volume_group_id>
|
11761
|
+
# <volume_group_id>123</volume_group_id>
|
10892
11762
|
# </logical_unit>
|
10893
11763
|
# </logical_units>
|
10894
11764
|
# <type>iscsi</type>
|
10895
|
-
# <host id="
|
11765
|
+
# <host id="123"/>
|
10896
11766
|
# </host_storage>
|
10897
11767
|
# ----
|
10898
11768
|
#
|
@@ -10900,20 +11770,20 @@ module OvirtSDK4
|
|
10900
11770
|
#
|
10901
11771
|
# [source,xml]
|
10902
11772
|
# ----
|
10903
|
-
# <host_storage id="
|
11773
|
+
# <host_storage id="123">
|
10904
11774
|
# <logical_units>
|
10905
|
-
# <logical_unit id="
|
11775
|
+
# <logical_unit id="123">
|
10906
11776
|
# <lun_mapping>0</lun_mapping>
|
10907
11777
|
# <paths>1</paths>
|
10908
11778
|
# <product_id>lun0</product_id>
|
10909
|
-
# <serial>
|
11779
|
+
# <serial>123</serial>
|
10910
11780
|
# <size>10737418240</size>
|
10911
11781
|
# <vendor_id>LIO-ORG</vendor_id>
|
10912
|
-
# <volume_group_id>
|
11782
|
+
# <volume_group_id>123</volume_group_id>
|
10913
11783
|
# </logical_unit>
|
10914
11784
|
# </logical_units>
|
10915
11785
|
# <type>iscsi</type>
|
10916
|
-
# <host id="
|
11786
|
+
# <host id="123"/>
|
10917
11787
|
# </host_storage>
|
10918
11788
|
# ----
|
10919
11789
|
#
|
@@ -10942,7 +11812,7 @@ module OvirtSDK4
|
|
10942
11812
|
end
|
10943
11813
|
|
10944
11814
|
#
|
10945
|
-
#
|
11815
|
+
# Reference to a service managing the storage.
|
10946
11816
|
#
|
10947
11817
|
# @param id [String] The identifier of the `storage`.
|
10948
11818
|
#
|
@@ -11084,7 +11954,28 @@ module OvirtSDK4
|
|
11084
11954
|
end
|
11085
11955
|
|
11086
11956
|
#
|
11087
|
-
#
|
11957
|
+
# Get a list of all available hosts.
|
11958
|
+
#
|
11959
|
+
# For example, to list the hosts send the following request:
|
11960
|
+
#
|
11961
|
+
# ....
|
11962
|
+
# GET /ovirt-engine/api/hosts
|
11963
|
+
# ....
|
11964
|
+
#
|
11965
|
+
# The response body will be something like this:
|
11966
|
+
#
|
11967
|
+
# [source,xml]
|
11968
|
+
# ----
|
11969
|
+
# <hosts>
|
11970
|
+
# <host href="/ovirt-engine/api/hosts/123" id="123">
|
11971
|
+
# ...
|
11972
|
+
# </host>
|
11973
|
+
# <host href="/ovirt-engine/api/hosts/456" id="456">
|
11974
|
+
# ...
|
11975
|
+
# </host>
|
11976
|
+
# ...
|
11977
|
+
# </host>
|
11978
|
+
# ----
|
11088
11979
|
#
|
11089
11980
|
# @param opts [Hash] Additional options.
|
11090
11981
|
#
|
@@ -11137,7 +12028,7 @@ module OvirtSDK4
|
|
11137
12028
|
end
|
11138
12029
|
|
11139
12030
|
#
|
11140
|
-
#
|
12031
|
+
# A Reference to service managing a specific host.
|
11141
12032
|
#
|
11142
12033
|
# @param id [String] The identifier of the `host`.
|
11143
12034
|
#
|
@@ -11193,7 +12084,22 @@ module OvirtSDK4
|
|
11193
12084
|
end
|
11194
12085
|
|
11195
12086
|
#
|
11196
|
-
#
|
12087
|
+
# Get an icon.
|
12088
|
+
#
|
12089
|
+
# [source]
|
12090
|
+
# ----
|
12091
|
+
# GET /ovirt-engine/api/icons/123
|
12092
|
+
# ----
|
12093
|
+
#
|
12094
|
+
# You will get a XML response like this one:
|
12095
|
+
#
|
12096
|
+
# [source,xml]
|
12097
|
+
# ----
|
12098
|
+
# <icon id="123">
|
12099
|
+
# <data>Some binary data here</data>
|
12100
|
+
# <media_type>image/png</media_type>
|
12101
|
+
# </icon>
|
12102
|
+
# ----
|
11197
12103
|
#
|
11198
12104
|
# @param opts [Hash] Additional options.
|
11199
12105
|
#
|
@@ -11258,7 +12164,25 @@ module OvirtSDK4
|
|
11258
12164
|
end
|
11259
12165
|
|
11260
12166
|
#
|
11261
|
-
#
|
12167
|
+
# Get a list of icons.
|
12168
|
+
#
|
12169
|
+
# [source]
|
12170
|
+
# ----
|
12171
|
+
# GET /ovirt-engine/api/icons
|
12172
|
+
# ----
|
12173
|
+
#
|
12174
|
+
# You will get a XML response which is similar to this one:
|
12175
|
+
#
|
12176
|
+
# [source,xml]
|
12177
|
+
# ----
|
12178
|
+
# <icons>
|
12179
|
+
# <icon id="123">
|
12180
|
+
# <data>...</data>
|
12181
|
+
# <media_type>image/png</media_type>
|
12182
|
+
# </icon>
|
12183
|
+
# ...
|
12184
|
+
# </icons>
|
12185
|
+
# ----
|
11262
12186
|
#
|
11263
12187
|
# @param opts [Hash] Additional options.
|
11264
12188
|
#
|
@@ -11289,7 +12213,7 @@ module OvirtSDK4
|
|
11289
12213
|
end
|
11290
12214
|
|
11291
12215
|
#
|
11292
|
-
#
|
12216
|
+
# Reference to the service that manages an specific icon.
|
11293
12217
|
#
|
11294
12218
|
# @param id [String] The identifier of the `icon`.
|
11295
12219
|
#
|
@@ -11837,7 +12761,12 @@ module OvirtSDK4
|
|
11837
12761
|
end
|
11838
12762
|
|
11839
12763
|
#
|
11840
|
-
#
|
12764
|
+
# Get a specific instance type and it's attributes.
|
12765
|
+
#
|
12766
|
+
# [source]
|
12767
|
+
# ----
|
12768
|
+
# GET /ovirt-engine/api/instancetypes/123
|
12769
|
+
# ----
|
11841
12770
|
#
|
11842
12771
|
# @param opts [Hash] Additional options.
|
11843
12772
|
#
|
@@ -11861,7 +12790,15 @@ module OvirtSDK4
|
|
11861
12790
|
end
|
11862
12791
|
|
11863
12792
|
#
|
11864
|
-
#
|
12793
|
+
# Removes a specific instance type from the system.
|
12794
|
+
#
|
12795
|
+
# If a virtual machine was created using an instance type X after removal of the instance type
|
12796
|
+
# the virtual machine's instance type will be set to `custom`.
|
12797
|
+
#
|
12798
|
+
# [source]
|
12799
|
+
# ----
|
12800
|
+
# DELETE /ovirt-engine/api/instancetypes/123
|
12801
|
+
# ----
|
11865
12802
|
#
|
11866
12803
|
# @param opts [Hash] Additional options.
|
11867
12804
|
#
|
@@ -11881,7 +12818,35 @@ module OvirtSDK4
|
|
11881
12818
|
end
|
11882
12819
|
|
11883
12820
|
#
|
11884
|
-
#
|
12821
|
+
# Update a specific instance type and it's attributes.
|
12822
|
+
#
|
12823
|
+
# All the attributes are editable after creation.
|
12824
|
+
# If a virtual machine was created using an instance type X and some configuration in instance
|
12825
|
+
# type X was updated, the virtual machine's configuration will be updated automatically by the
|
12826
|
+
# engine.
|
12827
|
+
#
|
12828
|
+
# [source]
|
12829
|
+
# ----
|
12830
|
+
# PUT /ovirt-engine/api/instancetypes/123
|
12831
|
+
# ----
|
12832
|
+
#
|
12833
|
+
# For example, to update the memory of instance type `123` to 1 GiB and set the cpu topology
|
12834
|
+
# to 2 sockets and 1 core, send a request like this:
|
12835
|
+
#
|
12836
|
+
# [source, xml]
|
12837
|
+
# ----
|
12838
|
+
#
|
12839
|
+
# <instance_type>
|
12840
|
+
# <memory>1073741824</memory>
|
12841
|
+
# <cpu>
|
12842
|
+
# <topology>
|
12843
|
+
# <cores>1</cores>
|
12844
|
+
# <sockets>2</sockets>
|
12845
|
+
# <threads>1</threads>
|
12846
|
+
# </topology>
|
12847
|
+
# </cpu>
|
12848
|
+
# </instance_type>
|
12849
|
+
# ----
|
11885
12850
|
#
|
11886
12851
|
# @param instance_type [InstanceType] The `instance_type` to update.
|
11887
12852
|
# @param opts [Hash] Additional options.
|
@@ -11924,7 +12889,8 @@ module OvirtSDK4
|
|
11924
12889
|
end
|
11925
12890
|
|
11926
12891
|
#
|
11927
|
-
#
|
12892
|
+
# Reference to the service that manages the graphic consoles that are attached to this
|
12893
|
+
# instance type.
|
11928
12894
|
#
|
11929
12895
|
# @return [GraphicsConsolesService] A reference to `graphics_consoles` service.
|
11930
12896
|
#
|
@@ -11933,7 +12899,7 @@ module OvirtSDK4
|
|
11933
12899
|
end
|
11934
12900
|
|
11935
12901
|
#
|
11936
|
-
#
|
12902
|
+
# Reference to the service that manages the NICs that are attached to this instance type.
|
11937
12903
|
#
|
11938
12904
|
# @return [InstanceTypeNicsService] A reference to `nics` service.
|
11939
12905
|
#
|
@@ -11942,7 +12908,7 @@ module OvirtSDK4
|
|
11942
12908
|
end
|
11943
12909
|
|
11944
12910
|
#
|
11945
|
-
#
|
12911
|
+
# Reference to the service that manages the watchdogs that are attached to this instance type.
|
11946
12912
|
#
|
11947
12913
|
# @return [InstanceTypeWatchdogsService] A reference to `watchdogs` service.
|
11948
12914
|
#
|
@@ -12010,7 +12976,7 @@ module OvirtSDK4
|
|
12010
12976
|
end
|
12011
12977
|
|
12012
12978
|
#
|
12013
|
-
#
|
12979
|
+
# Gets network interface configuration of the instance type.
|
12014
12980
|
#
|
12015
12981
|
# @param opts [Hash] Additional options.
|
12016
12982
|
#
|
@@ -12034,7 +13000,7 @@ module OvirtSDK4
|
|
12034
13000
|
end
|
12035
13001
|
|
12036
13002
|
#
|
12037
|
-
#
|
13003
|
+
# Remove the network interface from the instance type.
|
12038
13004
|
#
|
12039
13005
|
# @param opts [Hash] Additional options.
|
12040
13006
|
#
|
@@ -12054,7 +13020,7 @@ module OvirtSDK4
|
|
12054
13020
|
end
|
12055
13021
|
|
12056
13022
|
#
|
12057
|
-
# Updates the
|
13023
|
+
# Updates the network interface configuration of the instance type.
|
12058
13024
|
#
|
12059
13025
|
# @param nic [Nic] The `nic` to update.
|
12060
13026
|
# @param opts [Hash] Additional options.
|
@@ -12138,7 +13104,7 @@ module OvirtSDK4
|
|
12138
13104
|
end
|
12139
13105
|
|
12140
13106
|
#
|
12141
|
-
#
|
13107
|
+
# Add new network interface to the instance type.
|
12142
13108
|
#
|
12143
13109
|
# @param nic [Nic] The `nic` to add.
|
12144
13110
|
#
|
@@ -12174,12 +13140,14 @@ module OvirtSDK4
|
|
12174
13140
|
end
|
12175
13141
|
|
12176
13142
|
#
|
12177
|
-
#
|
13143
|
+
# Lists all the configured network interface of the instance type.
|
12178
13144
|
#
|
12179
13145
|
# @param opts [Hash] Additional options.
|
12180
13146
|
#
|
12181
13147
|
# @option opts [Integer] :max Sets the maximum number of NICs to return. If not specified all the NICs are returned.
|
12182
13148
|
#
|
13149
|
+
# @option opts [String] :search A query string used to restrict the returned templates.
|
13150
|
+
#
|
12183
13151
|
# @return [Array<Nic>]
|
12184
13152
|
#
|
12185
13153
|
def list(opts = {})
|
@@ -12189,6 +13157,10 @@ module OvirtSDK4
|
|
12189
13157
|
value = Writer.render_integer(value)
|
12190
13158
|
query['max'] = value
|
12191
13159
|
end
|
13160
|
+
value = opts[:search]
|
13161
|
+
unless value.nil?
|
13162
|
+
query['search'] = value
|
13163
|
+
end
|
12192
13164
|
request = HttpRequest.new(method: :GET, url: @path, query: query)
|
12193
13165
|
response = @connection.send(request)
|
12194
13166
|
case response.code
|
@@ -12261,7 +13233,7 @@ module OvirtSDK4
|
|
12261
13233
|
end
|
12262
13234
|
|
12263
13235
|
#
|
12264
|
-
#
|
13236
|
+
# Gets watchdog configuration of the instance type.
|
12265
13237
|
#
|
12266
13238
|
# @param opts [Hash] Additional options.
|
12267
13239
|
#
|
@@ -12285,7 +13257,7 @@ module OvirtSDK4
|
|
12285
13257
|
end
|
12286
13258
|
|
12287
13259
|
#
|
12288
|
-
#
|
13260
|
+
# Remove a watchdog from the instance type.
|
12289
13261
|
#
|
12290
13262
|
# @param opts [Hash] Additional options.
|
12291
13263
|
#
|
@@ -12305,7 +13277,7 @@ module OvirtSDK4
|
|
12305
13277
|
end
|
12306
13278
|
|
12307
13279
|
#
|
12308
|
-
# Updates the
|
13280
|
+
# Updates the watchdog configuration of the instance type.
|
12309
13281
|
#
|
12310
13282
|
# @param watchdog [Watchdog] The `watchdog` to update.
|
12311
13283
|
# @param opts [Hash] Additional options.
|
@@ -12389,7 +13361,7 @@ module OvirtSDK4
|
|
12389
13361
|
end
|
12390
13362
|
|
12391
13363
|
#
|
12392
|
-
#
|
13364
|
+
# Add new watchdog to the instance type.
|
12393
13365
|
#
|
12394
13366
|
# @param watchdog [Watchdog] The `watchdog` to add.
|
12395
13367
|
#
|
@@ -12425,11 +13397,14 @@ module OvirtSDK4
|
|
12425
13397
|
end
|
12426
13398
|
|
12427
13399
|
#
|
12428
|
-
#
|
13400
|
+
# Lists all the configured watchdogs of the instance type.
|
12429
13401
|
#
|
12430
13402
|
# @param opts [Hash] Additional options.
|
12431
13403
|
#
|
12432
|
-
# @option opts [Integer] :max Sets the maximum number of watchdogs to return. If not specified all the watchdogs are
|
13404
|
+
# @option opts [Integer] :max Sets the maximum number of watchdogs to return. If not specified all the watchdogs are
|
13405
|
+
# returned.
|
13406
|
+
#
|
13407
|
+
# @option opts [String] :search A query string used to restrict the returned templates.
|
12433
13408
|
#
|
12434
13409
|
# @return [Array<Watchdog>]
|
12435
13410
|
#
|
@@ -12440,6 +13415,10 @@ module OvirtSDK4
|
|
12440
13415
|
value = Writer.render_integer(value)
|
12441
13416
|
query['max'] = value
|
12442
13417
|
end
|
13418
|
+
value = opts[:search]
|
13419
|
+
unless value.nil?
|
13420
|
+
query['search'] = value
|
13421
|
+
end
|
12443
13422
|
request = HttpRequest.new(method: :GET, url: @path, query: query)
|
12444
13423
|
response = @connection.send(request)
|
12445
13424
|
case response.code
|
@@ -12512,7 +13491,91 @@ module OvirtSDK4
|
|
12512
13491
|
end
|
12513
13492
|
|
12514
13493
|
#
|
12515
|
-
#
|
13494
|
+
# Creates a new instance type.
|
13495
|
+
#
|
13496
|
+
# This requires only a name attribute and can include all hardware configurations of the
|
13497
|
+
# virtual machine.
|
13498
|
+
#
|
13499
|
+
# [source]
|
13500
|
+
# ----
|
13501
|
+
# POST /ovirt-engine/api/instancetypes
|
13502
|
+
# ----
|
13503
|
+
#
|
13504
|
+
# With a request body like this:
|
13505
|
+
#
|
13506
|
+
# [source,xml]
|
13507
|
+
# ----
|
13508
|
+
# <instance_type>
|
13509
|
+
# <name>myinstancetype</name>
|
13510
|
+
# </template>
|
13511
|
+
# ----
|
13512
|
+
#
|
13513
|
+
# Creating an instance type with all hardware configurations with a request body like this:
|
13514
|
+
#
|
13515
|
+
# [source,xml]
|
13516
|
+
# ----
|
13517
|
+
# <instance_type>
|
13518
|
+
# <name>myinstancetype</name>
|
13519
|
+
# <console>
|
13520
|
+
# <enabled>true</enabled>
|
13521
|
+
# </console>
|
13522
|
+
# <cpu>
|
13523
|
+
# <topology>
|
13524
|
+
# <cores>2</cores>
|
13525
|
+
# <sockets>2</sockets>
|
13526
|
+
# <threads>1</threads>
|
13527
|
+
# </topology>
|
13528
|
+
# </cpu>
|
13529
|
+
# <custom_cpu_model>AMD Opteron_G2</custom_cpu_model>
|
13530
|
+
# <custom_emulated_machine>q35</custom_emulated_machine>
|
13531
|
+
# <display>
|
13532
|
+
# <monitors>1</monitors>
|
13533
|
+
# <single_qxl_pci>true</single_qxl_pci>
|
13534
|
+
# <smartcard_enabled>true</smartcard_enabled>
|
13535
|
+
# <type>spice</type>
|
13536
|
+
# </display>
|
13537
|
+
# <high_availability>
|
13538
|
+
# <enabled>true</enabled>
|
13539
|
+
# <priority>1</priority>
|
13540
|
+
# </high_availability>
|
13541
|
+
# <io>
|
13542
|
+
# <threads>2</threads>
|
13543
|
+
# </io>
|
13544
|
+
# <memory>4294967296</memory>
|
13545
|
+
# <memory_policy>
|
13546
|
+
# <ballooning>true</ballooning>
|
13547
|
+
# <guaranteed>268435456</guaranteed>
|
13548
|
+
# </memory_policy>
|
13549
|
+
# <migration>
|
13550
|
+
# <auto_converge>inherit</auto_converge>
|
13551
|
+
# <compressed>inherit</compressed>
|
13552
|
+
# <policy id="00000000-0000-0000-0000-000000000000"/>
|
13553
|
+
# </migration>
|
13554
|
+
# <migration_downtime>2</migration_downtime>
|
13555
|
+
# <os>
|
13556
|
+
# <boot>
|
13557
|
+
# <devices>
|
13558
|
+
# <device>hd</device>
|
13559
|
+
# </devices>
|
13560
|
+
# </boot>
|
13561
|
+
# </os>
|
13562
|
+
# <rng_device>
|
13563
|
+
# <rate>
|
13564
|
+
# <bytes>200</bytes>
|
13565
|
+
# <period>2</period>
|
13566
|
+
# </rate>
|
13567
|
+
# <source>urandom</source>
|
13568
|
+
# </rng_device>
|
13569
|
+
# <soundcard_enabled>true</soundcard_enabled>
|
13570
|
+
# <usb>
|
13571
|
+
# <enabled>true</enabled>
|
13572
|
+
# <type>native</type>
|
13573
|
+
# </usb>
|
13574
|
+
# <virtio_scsi>
|
13575
|
+
# <enabled>true</enabled>
|
13576
|
+
# </virtio_scsi>
|
13577
|
+
# </instance_type>
|
13578
|
+
# ----
|
12516
13579
|
#
|
12517
13580
|
# @param instance_type [InstanceType] The `instance_type` to add.
|
12518
13581
|
#
|
@@ -12548,21 +13611,37 @@ module OvirtSDK4
|
|
12548
13611
|
end
|
12549
13612
|
|
12550
13613
|
#
|
12551
|
-
#
|
13614
|
+
# Lists all existing instance types in the system.
|
12552
13615
|
#
|
12553
13616
|
# @param opts [Hash] Additional options.
|
12554
13617
|
#
|
12555
|
-
# @option opts [
|
13618
|
+
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed
|
13619
|
+
# taking case into account. The default value is `true`, which means that case is taken
|
13620
|
+
# into account. If you want to search ignoring case set it to `false`.
|
13621
|
+
#
|
13622
|
+
# @option opts [Integer] :max Sets the maximum number of instance types to return. If not specified all the instance
|
13623
|
+
# types are returned.
|
13624
|
+
#
|
13625
|
+
# @option opts [String] :search A query string used to restrict the returned templates.
|
12556
13626
|
#
|
12557
13627
|
# @return [Array<InstanceType>]
|
12558
13628
|
#
|
12559
13629
|
def list(opts = {})
|
12560
13630
|
query = {}
|
13631
|
+
value = opts[:case_sensitive]
|
13632
|
+
unless value.nil?
|
13633
|
+
value = Writer.render_boolean(value)
|
13634
|
+
query['case_sensitive'] = value
|
13635
|
+
end
|
12561
13636
|
value = opts[:max]
|
12562
13637
|
unless value.nil?
|
12563
13638
|
value = Writer.render_integer(value)
|
12564
13639
|
query['max'] = value
|
12565
13640
|
end
|
13641
|
+
value = opts[:search]
|
13642
|
+
unless value.nil?
|
13643
|
+
query['search'] = value
|
13644
|
+
end
|
12566
13645
|
request = HttpRequest.new(method: :GET, url: @path, query: query)
|
12567
13646
|
response = @connection.send(request)
|
12568
13647
|
case response.code
|
@@ -12659,7 +13738,7 @@ module OvirtSDK4
|
|
12659
13738
|
end
|
12660
13739
|
|
12661
13740
|
#
|
12662
|
-
# Removes of an
|
13741
|
+
# Removes of an existing iSCSI bond.
|
12663
13742
|
#
|
12664
13743
|
# For example, to remove the iSCSI bond `456` send a request like this:
|
12665
13744
|
#
|
@@ -12965,7 +14044,21 @@ module OvirtSDK4
|
|
12965
14044
|
end
|
12966
14045
|
|
12967
14046
|
#
|
12968
|
-
#
|
14047
|
+
# Set an external job execution to be cleared by the system.
|
14048
|
+
#
|
14049
|
+
# For example, to set a job with identifier `123` send the following request:
|
14050
|
+
#
|
14051
|
+
# [source]
|
14052
|
+
# ----
|
14053
|
+
# POST /ovirt-engine/api/jobs/clear
|
14054
|
+
# ----
|
14055
|
+
#
|
14056
|
+
# With the following request body:
|
14057
|
+
#
|
14058
|
+
# [source,xml]
|
14059
|
+
# ----
|
14060
|
+
# <action/>
|
14061
|
+
# ----
|
12969
14062
|
#
|
12970
14063
|
# @param opts [Hash] Additional options.
|
12971
14064
|
#
|
@@ -12992,13 +14085,30 @@ module OvirtSDK4
|
|
12992
14085
|
end
|
12993
14086
|
|
12994
14087
|
#
|
12995
|
-
#
|
14088
|
+
# Marks an external job execution as ended.
|
14089
|
+
#
|
14090
|
+
# For example, to terminate a job with identifier `123` send the following request:
|
14091
|
+
#
|
14092
|
+
# [source]
|
14093
|
+
# ----
|
14094
|
+
# POST /ovirt-engine/api/jobs/end
|
14095
|
+
# ----
|
14096
|
+
#
|
14097
|
+
# With the following request body:
|
14098
|
+
#
|
14099
|
+
# [source,xml]
|
14100
|
+
# ----
|
14101
|
+
# <action>
|
14102
|
+
# <force>true</force>
|
14103
|
+
# <status>finished</status>
|
14104
|
+
# </action>
|
14105
|
+
# ----
|
12996
14106
|
#
|
12997
14107
|
# @param opts [Hash] Additional options.
|
12998
14108
|
#
|
12999
14109
|
# @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
|
13000
14110
|
#
|
13001
|
-
# @option opts [Boolean] :force
|
14111
|
+
# @option opts [Boolean] :force Indicates if the job should be forcibly terminated.
|
13002
14112
|
#
|
13003
14113
|
def end_(opts = {})
|
13004
14114
|
action = Action.new(opts)
|
@@ -13021,7 +14131,33 @@ module OvirtSDK4
|
|
13021
14131
|
end
|
13022
14132
|
|
13023
14133
|
#
|
13024
|
-
#
|
14134
|
+
# Retrieves a job.
|
14135
|
+
#
|
14136
|
+
# [source]
|
14137
|
+
# ----
|
14138
|
+
# GET /ovirt-engine/api/jobs/123
|
14139
|
+
# ----
|
14140
|
+
#
|
14141
|
+
# You will receive response in XML like this one:
|
14142
|
+
#
|
14143
|
+
# [source,xml]
|
14144
|
+
# ----
|
14145
|
+
# <job href="/ovirt-engine/api/jobs/123" id="123">
|
14146
|
+
# <actions>
|
14147
|
+
# <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
|
14148
|
+
# <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
|
14149
|
+
# </actions>
|
14150
|
+
# <description>Adding Disk</description>
|
14151
|
+
# <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
|
14152
|
+
# <auto_cleared>true</auto_cleared>
|
14153
|
+
# <end_time>2016-12-12T23:07:29.758+02:00</end_time>
|
14154
|
+
# <external>false</external>
|
14155
|
+
# <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
|
14156
|
+
# <start_time>2016-12-12T23:07:26.593+02:00</start_time>
|
14157
|
+
# <status>failed</status>
|
14158
|
+
# <owner href="/ovirt-engine/api/users/456" id="456"/>
|
14159
|
+
# </job>
|
14160
|
+
# ----
|
13025
14161
|
#
|
13026
14162
|
# @param opts [Hash] Additional options.
|
13027
14163
|
#
|
@@ -13045,7 +14181,7 @@ module OvirtSDK4
|
|
13045
14181
|
end
|
13046
14182
|
|
13047
14183
|
#
|
13048
|
-
#
|
14184
|
+
# List all the steps of the job.
|
13049
14185
|
#
|
13050
14186
|
# @return [StepsService] A reference to `steps` service.
|
13051
14187
|
#
|
@@ -13101,9 +14237,46 @@ module OvirtSDK4
|
|
13101
14237
|
end
|
13102
14238
|
|
13103
14239
|
#
|
13104
|
-
#
|
14240
|
+
# Add an external job.
|
14241
|
+
#
|
14242
|
+
# For example, to add a job with the following request:
|
14243
|
+
#
|
14244
|
+
# [source]
|
14245
|
+
# ----
|
14246
|
+
# POST /ovirt-engine/api/jobs
|
14247
|
+
# ----
|
14248
|
+
#
|
14249
|
+
# With the following request body:
|
14250
|
+
#
|
14251
|
+
# [source,xml]
|
14252
|
+
# ----
|
14253
|
+
# <job>
|
14254
|
+
# <description>Doing some work</description>
|
14255
|
+
# <auto_cleared>true</auto_cleared>
|
14256
|
+
# </job>
|
14257
|
+
# ----
|
14258
|
+
#
|
14259
|
+
# The response should look like:
|
14260
|
+
#
|
14261
|
+
# [source,xml]
|
14262
|
+
# ----
|
14263
|
+
# <job href="/ovirt-engine/api/jobs/123" id="123">
|
14264
|
+
# <actions>
|
14265
|
+
# <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
|
14266
|
+
# <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
|
14267
|
+
# </actions>
|
14268
|
+
# <description>Doing some work</description>
|
14269
|
+
# <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
|
14270
|
+
# <auto_cleared>true</auto_cleared>
|
14271
|
+
# <external>true</external>
|
14272
|
+
# <last_updated>2016-12-13T02:15:42.130+02:00</last_updated>
|
14273
|
+
# <start_time>2016-12-13T02:15:42.130+02:00</start_time>
|
14274
|
+
# <status>started</status>
|
14275
|
+
# <owner href="/ovirt-engine/api/users/456" id="456"/>
|
14276
|
+
# </job>
|
14277
|
+
# ----
|
13105
14278
|
#
|
13106
|
-
# @param job [Job]
|
14279
|
+
# @param job [Job] Job that will be added.
|
13107
14280
|
#
|
13108
14281
|
# @param opts [Hash] Additional options.
|
13109
14282
|
#
|
@@ -13137,7 +14310,36 @@ module OvirtSDK4
|
|
13137
14310
|
end
|
13138
14311
|
|
13139
14312
|
#
|
13140
|
-
#
|
14313
|
+
# Retrieves the representation of the jobs.
|
14314
|
+
#
|
14315
|
+
# [source]
|
14316
|
+
# ----
|
14317
|
+
# GET /ovirt-engine/api/jobs
|
14318
|
+
# ----
|
14319
|
+
#
|
14320
|
+
# You will receive response in XML like this one:
|
14321
|
+
#
|
14322
|
+
# [source,xml]
|
14323
|
+
# ----
|
14324
|
+
# <jobs>
|
14325
|
+
# <job href="/ovirt-engine/api/jobs/123" id="123">
|
14326
|
+
# <actions>
|
14327
|
+
# <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
|
14328
|
+
# <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
|
14329
|
+
# </actions>
|
14330
|
+
# <description>Adding Disk</description>
|
14331
|
+
# <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
|
14332
|
+
# <auto_cleared>true</auto_cleared>
|
14333
|
+
# <end_time>2016-12-12T23:07:29.758+02:00</end_time>
|
14334
|
+
# <external>false</external>
|
14335
|
+
# <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
|
14336
|
+
# <start_time>2016-12-12T23:07:26.593+02:00</start_time>
|
14337
|
+
# <status>failed</status>
|
14338
|
+
# <owner href="/ovirt-engine/api/users/456" id="456"/>
|
14339
|
+
# </job>
|
14340
|
+
# ...
|
14341
|
+
# </jobs>
|
14342
|
+
# ----
|
13141
14343
|
#
|
13142
14344
|
# @param opts [Hash] Additional options.
|
13143
14345
|
#
|
@@ -13168,7 +14370,7 @@ module OvirtSDK4
|
|
13168
14370
|
end
|
13169
14371
|
|
13170
14372
|
#
|
13171
|
-
#
|
14373
|
+
# Reference to the job service.
|
13172
14374
|
#
|
13173
14375
|
# @param id [String] The identifier of the `job`.
|
13174
14376
|
#
|
@@ -13224,7 +14426,36 @@ module OvirtSDK4
|
|
13224
14426
|
end
|
13225
14427
|
|
13226
14428
|
#
|
13227
|
-
#
|
14429
|
+
# Retrieves the representation of the Katello errata.
|
14430
|
+
#
|
14431
|
+
# [source]
|
14432
|
+
# ----
|
14433
|
+
# GET /ovirt-engine/api/katelloerrata
|
14434
|
+
# ----
|
14435
|
+
#
|
14436
|
+
# You will receive response in XML like this one:
|
14437
|
+
#
|
14438
|
+
# [source,xml]
|
14439
|
+
# ----
|
14440
|
+
# <katello_errata>
|
14441
|
+
# <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
|
14442
|
+
# <name>RHBA-2013:XYZ</name>
|
14443
|
+
# <description>The description of the erratum</description>
|
14444
|
+
# <title>some bug fix update</title>
|
14445
|
+
# <type>bugfix</type>
|
14446
|
+
# <issued>2013-11-20T02:00:00.000+02:00</issued>
|
14447
|
+
# <solution>Few guidelines regarding the solution</solution>
|
14448
|
+
# <summary>Updated packages that fix one bug are now available for XYZ</summary>
|
14449
|
+
# <packages>
|
14450
|
+
# <package>
|
14451
|
+
# <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
|
14452
|
+
# </package>
|
14453
|
+
# ...
|
14454
|
+
# </packages>
|
14455
|
+
# </katello_erratum>
|
14456
|
+
# ...
|
14457
|
+
# </katello_errata>
|
14458
|
+
# ----
|
13228
14459
|
#
|
13229
14460
|
# @param opts [Hash] Additional options.
|
13230
14461
|
#
|
@@ -13255,7 +14486,8 @@ module OvirtSDK4
|
|
13255
14486
|
end
|
13256
14487
|
|
13257
14488
|
#
|
13258
|
-
#
|
14489
|
+
# Reference to the Katello erratum service.
|
14490
|
+
# Use this service to view the erratum by its id.
|
13259
14491
|
#
|
13260
14492
|
# @param id [String] The identifier of the `katello_erratum`.
|
13261
14493
|
#
|
@@ -13311,7 +14543,33 @@ module OvirtSDK4
|
|
13311
14543
|
end
|
13312
14544
|
|
13313
14545
|
#
|
13314
|
-
#
|
14546
|
+
# Retrieves a Katello erratum.
|
14547
|
+
#
|
14548
|
+
# [source]
|
14549
|
+
# ----
|
14550
|
+
# GET /ovirt-engine/api/katelloerrata/123
|
14551
|
+
# ----
|
14552
|
+
#
|
14553
|
+
# You will receive response in XML like this one:
|
14554
|
+
#
|
14555
|
+
# [source,xml]
|
14556
|
+
# ----
|
14557
|
+
# <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
|
14558
|
+
# <name>RHBA-2013:XYZ</name>
|
14559
|
+
# <description>The description of the erratum</description>
|
14560
|
+
# <title>some bug fix update</title>
|
14561
|
+
# <type>bugfix</type>
|
14562
|
+
# <issued>2013-11-20T02:00:00.000+02:00</issued>
|
14563
|
+
# <solution>Few guidelines regarding the solution</solution>
|
14564
|
+
# <summary>Updated packages that fix one bug are now available for XYZ</summary>
|
14565
|
+
# <packages>
|
14566
|
+
# <package>
|
14567
|
+
# <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
|
14568
|
+
# </package>
|
14569
|
+
# ...
|
14570
|
+
# </packages>
|
14571
|
+
# </katello_erratum>
|
14572
|
+
# ----
|
13315
14573
|
#
|
13316
14574
|
# @param opts [Hash] Additional options.
|
13317
14575
|
#
|
@@ -13815,7 +15073,33 @@ module OvirtSDK4
|
|
13815
15073
|
end
|
13816
15074
|
|
13817
15075
|
#
|
13818
|
-
#
|
15076
|
+
# Gets a logical network.
|
15077
|
+
#
|
15078
|
+
# For example:
|
15079
|
+
#
|
15080
|
+
# [source]
|
15081
|
+
# ----
|
15082
|
+
# GET /ovirt-engine/api/networks/123
|
15083
|
+
# ----
|
15084
|
+
#
|
15085
|
+
# Will respond:
|
15086
|
+
#
|
15087
|
+
# [source,xml]
|
15088
|
+
# ----
|
15089
|
+
# <network href="/ovirt-engine/api/networks/123" id="123">
|
15090
|
+
# <name>ovirtmgmt</name>
|
15091
|
+
# <description>Default Management Network</description>
|
15092
|
+
# <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
|
15093
|
+
# <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
|
15094
|
+
# <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
|
15095
|
+
# <mtu>0</mtu>
|
15096
|
+
# <stp>false</stp>
|
15097
|
+
# <usages>
|
15098
|
+
# <usage>vm</usage>
|
15099
|
+
# </usages>
|
15100
|
+
# <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
|
15101
|
+
# </network>
|
15102
|
+
# ----
|
13819
15103
|
#
|
13820
15104
|
# @param opts [Hash] Additional options.
|
13821
15105
|
#
|
@@ -13839,7 +15123,7 @@ module OvirtSDK4
|
|
13839
15123
|
end
|
13840
15124
|
|
13841
15125
|
#
|
13842
|
-
# Removes a logical network.
|
15126
|
+
# Removes a logical network, or the association of a logical network to a data center.
|
13843
15127
|
#
|
13844
15128
|
# For example, to remove the logical network `123` send a request like this:
|
13845
15129
|
#
|
@@ -13848,6 +15132,17 @@ module OvirtSDK4
|
|
13848
15132
|
# DELETE /ovirt-engine/api/networks/123
|
13849
15133
|
# ----
|
13850
15134
|
#
|
15135
|
+
# Each network is bound exactly to one data center. So if we disassociate network with data center it has the same
|
15136
|
+
# result as if we would just remove that network. However it might be more specific to say we're removing network
|
15137
|
+
# `456` of data center `123`.
|
15138
|
+
#
|
15139
|
+
# For example, to remove the association of network `456` to data center `123` send a request like this:
|
15140
|
+
#
|
15141
|
+
# [source]
|
15142
|
+
# ----
|
15143
|
+
# DELETE /ovirt-engine/api/datacenters/123/networks/456
|
15144
|
+
# ----
|
15145
|
+
#
|
13851
15146
|
# @param opts [Hash] Additional options.
|
13852
15147
|
#
|
13853
15148
|
# @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
|
@@ -13869,8 +15164,8 @@ module OvirtSDK4
|
|
13869
15164
|
# Updates a logical network.
|
13870
15165
|
#
|
13871
15166
|
# The `name`, `description`, `ip`, `vlan`, `stp` and `display` attributes can be updated.
|
13872
|
-
#
|
13873
|
-
# For example, to update the description of the
|
15167
|
+
#
|
15168
|
+
# For example, to update the description of the logical network `123` send a request like this:
|
13874
15169
|
#
|
13875
15170
|
# [source]
|
13876
15171
|
# ----
|
@@ -13886,6 +15181,26 @@ module OvirtSDK4
|
|
13886
15181
|
# </network>
|
13887
15182
|
# ----
|
13888
15183
|
#
|
15184
|
+
#
|
15185
|
+
# The maximum transmission unit of a network is set using a PUT request to
|
15186
|
+
# specify the integer value of the `mtu` attribute.
|
15187
|
+
#
|
15188
|
+
# For example, to set the maximum transmission unit send a request like this:
|
15189
|
+
#
|
15190
|
+
# [source]
|
15191
|
+
# ----
|
15192
|
+
# PUT /ovirt-engine/api/datacenters/123/networks/456
|
15193
|
+
# ----
|
15194
|
+
#
|
15195
|
+
# With a request body like this:
|
15196
|
+
#
|
15197
|
+
# [source,xml]
|
15198
|
+
# ----
|
15199
|
+
# <network>
|
15200
|
+
# <mtu>1500</mtu>
|
15201
|
+
# </network>
|
15202
|
+
# ----
|
15203
|
+
#
|
13889
15204
|
# @param network [Network] The `network` to update.
|
13890
15205
|
# @param opts [Hash] Additional options.
|
13891
15206
|
#
|
@@ -13927,7 +15242,7 @@ module OvirtSDK4
|
|
13927
15242
|
end
|
13928
15243
|
|
13929
15244
|
#
|
13930
|
-
#
|
15245
|
+
# Reference to the service that manages the network labels assigned to this network.
|
13931
15246
|
#
|
13932
15247
|
# @return [NetworkLabelsService] A reference to `network_labels` service.
|
13933
15248
|
#
|
@@ -13936,7 +15251,7 @@ module OvirtSDK4
|
|
13936
15251
|
end
|
13937
15252
|
|
13938
15253
|
#
|
13939
|
-
#
|
15254
|
+
# Reference to the service that manages the permissions assigned to this network.
|
13940
15255
|
#
|
13941
15256
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
13942
15257
|
#
|
@@ -13945,7 +15260,7 @@ module OvirtSDK4
|
|
13945
15260
|
end
|
13946
15261
|
|
13947
15262
|
#
|
13948
|
-
#
|
15263
|
+
# Reference to the service that manages the vNIC profiles assigned to this network.
|
13949
15264
|
#
|
13950
15265
|
# @return [AssignedVnicProfilesService] A reference to `vnic_profiles` service.
|
13951
15266
|
#
|
@@ -14505,7 +15820,7 @@ module OvirtSDK4
|
|
14505
15820
|
#
|
14506
15821
|
# You can attach labels to a logical network to automate the association of that logical network with physical host
|
14507
15822
|
# network interfaces to which the same label has been attached.
|
14508
|
-
#
|
15823
|
+
#
|
14509
15824
|
# For example, to attach the label `mylabel` to a logical network having id `123` send a request like this:
|
14510
15825
|
#
|
14511
15826
|
# [source]
|
@@ -14641,7 +15956,7 @@ module OvirtSDK4
|
|
14641
15956
|
end
|
14642
15957
|
|
14643
15958
|
#
|
14644
|
-
# Creates new logical network.
|
15959
|
+
# Creates a new logical network, or associates an existing network with a data center.
|
14645
15960
|
#
|
14646
15961
|
# Creation of a new network requires the `name` and `data_center` elements.
|
14647
15962
|
#
|
@@ -14662,6 +15977,23 @@ module OvirtSDK4
|
|
14662
15977
|
# </network>
|
14663
15978
|
# ----
|
14664
15979
|
#
|
15980
|
+
#
|
15981
|
+
# To associate the existing network `456` with the data center `123` send a request like this:
|
15982
|
+
#
|
15983
|
+
# [source]
|
15984
|
+
# ----
|
15985
|
+
# POST /ovirt-engine/api/datacenters/123/networks
|
15986
|
+
# ----
|
15987
|
+
#
|
15988
|
+
# With a request body like this:
|
15989
|
+
#
|
15990
|
+
# [source,xml]
|
15991
|
+
# ----
|
15992
|
+
# <network>
|
15993
|
+
# <name>ovirtmgmt</name>
|
15994
|
+
# </network>
|
15995
|
+
# ----
|
15996
|
+
#
|
14665
15997
|
# @param network [Network] The `network` to add.
|
14666
15998
|
#
|
14667
15999
|
# @param opts [Hash] Additional options.
|
@@ -14771,7 +16103,7 @@ module OvirtSDK4
|
|
14771
16103
|
end
|
14772
16104
|
|
14773
16105
|
#
|
14774
|
-
#
|
16106
|
+
# Reference to the service that manages a specific network.
|
14775
16107
|
#
|
14776
16108
|
# @param id [String] The identifier of the `network`.
|
14777
16109
|
#
|
@@ -15489,6 +16821,13 @@ module OvirtSDK4
|
|
15489
16821
|
#
|
15490
16822
|
# Returns the representation of the object managed by this service.
|
15491
16823
|
#
|
16824
|
+
# For example, to get the OpenStack network provider with identifier `1234`, send a request like this:
|
16825
|
+
#
|
16826
|
+
# [source]
|
16827
|
+
# ----
|
16828
|
+
# GET /ovirt-engine/api/openstacknetworkproviders/1234
|
16829
|
+
# ----
|
16830
|
+
#
|
15492
16831
|
# @param opts [Hash] Additional options.
|
15493
16832
|
#
|
15494
16833
|
# @return [OpenStackNetworkProvider]
|
@@ -15538,7 +16877,14 @@ module OvirtSDK4
|
|
15538
16877
|
end
|
15539
16878
|
|
15540
16879
|
#
|
15541
|
-
#
|
16880
|
+
# Removes the provider.
|
16881
|
+
#
|
16882
|
+
# For example, to remove the OpenStack network provider with identifier `1234`, send a request like this:
|
16883
|
+
#
|
16884
|
+
# [source]
|
16885
|
+
# ----
|
16886
|
+
# DELETE /ovirt-engine/api/openstacknetworkproviders/1234
|
16887
|
+
# ----
|
15542
16888
|
#
|
15543
16889
|
# @param opts [Hash] Additional options.
|
15544
16890
|
#
|
@@ -15585,9 +16931,30 @@ module OvirtSDK4
|
|
15585
16931
|
end
|
15586
16932
|
|
15587
16933
|
#
|
15588
|
-
# Updates the
|
16934
|
+
# Updates the provider.
|
16935
|
+
#
|
16936
|
+
# For example, to update `provider_name`, `requires_authentication`, `url`, `tenant_name` and `type` properties,
|
16937
|
+
# for the OpenStack network provider with identifier `1234`, send a request like this:
|
16938
|
+
#
|
16939
|
+
# [source]
|
16940
|
+
# ----
|
16941
|
+
# PUT /ovirt-engine/api/openstacknetworkproviders/1234
|
16942
|
+
# ----
|
16943
|
+
#
|
16944
|
+
# With a request body like this:
|
16945
|
+
#
|
16946
|
+
# [source,xml]
|
16947
|
+
# ----
|
16948
|
+
# <openstack_network_provider>
|
16949
|
+
# <name>ovn-network-provider</name>
|
16950
|
+
# <requires_authentication>false</requires_authentication>
|
16951
|
+
# <url>http://some_server_url.domain.com:9696</url>
|
16952
|
+
# <tenant_name>oVirt</tenant_name>
|
16953
|
+
# <type>external</type>
|
16954
|
+
# </openstack_network_provider>
|
16955
|
+
# ----
|
15589
16956
|
#
|
15590
|
-
# @param provider [OpenStackNetworkProvider] The
|
16957
|
+
# @param provider [OpenStackNetworkProvider] The provider to update.
|
15591
16958
|
# @param opts [Hash] Additional options.
|
15592
16959
|
#
|
15593
16960
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -15637,7 +17004,7 @@ module OvirtSDK4
|
|
15637
17004
|
end
|
15638
17005
|
|
15639
17006
|
#
|
15640
|
-
#
|
17007
|
+
# Reference to OpenStack networks service.
|
15641
17008
|
#
|
15642
17009
|
# @return [OpenstackNetworksService] A reference to `networks` service.
|
15643
17010
|
#
|
@@ -15767,7 +17134,7 @@ module OvirtSDK4
|
|
15767
17134
|
end
|
15768
17135
|
|
15769
17136
|
#
|
15770
|
-
#
|
17137
|
+
# Reference to OpenStack network provider service.
|
15771
17138
|
#
|
15772
17139
|
# @param id [String] The identifier of the `provider`.
|
15773
17140
|
#
|
@@ -17125,7 +18492,23 @@ module OvirtSDK4
|
|
17125
18492
|
end
|
17126
18493
|
|
17127
18494
|
#
|
17128
|
-
#
|
18495
|
+
# Gets the information about the permit of the role.
|
18496
|
+
#
|
18497
|
+
# For example to retrieve the information about the permit with the id `456` of the role with the id `123`
|
18498
|
+
# send a request like this:
|
18499
|
+
#
|
18500
|
+
# ....
|
18501
|
+
# GET /ovirt-engine/api/roles/123/permits/456
|
18502
|
+
# ....
|
18503
|
+
#
|
18504
|
+
# [source,xml]
|
18505
|
+
# ----
|
18506
|
+
# <permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
|
18507
|
+
# <name>change_vm_cd</name>
|
18508
|
+
# <administrative>false</administrative>
|
18509
|
+
# <role href="/ovirt-engine/api/roles/123" id="123"/>
|
18510
|
+
# </permit>
|
18511
|
+
# ----
|
17129
18512
|
#
|
17130
18513
|
# @param opts [Hash] Additional options.
|
17131
18514
|
#
|
@@ -17149,7 +18532,13 @@ module OvirtSDK4
|
|
17149
18532
|
end
|
17150
18533
|
|
17151
18534
|
#
|
17152
|
-
#
|
18535
|
+
# Removes the permit from the role.
|
18536
|
+
#
|
18537
|
+
# For example to remove the permit with id `456` from the role with id `123` send a request like this:
|
18538
|
+
#
|
18539
|
+
# ....
|
18540
|
+
# DELETE /ovirt-engine/api/roles/123/permits/456
|
18541
|
+
# ....
|
17153
18542
|
#
|
17154
18543
|
# @param opts [Hash] Additional options.
|
17155
18544
|
#
|
@@ -17210,8 +18599,22 @@ module OvirtSDK4
|
|
17210
18599
|
end
|
17211
18600
|
|
17212
18601
|
#
|
17213
|
-
# Adds a permit to the
|
17214
|
-
#
|
18602
|
+
# Adds a permit to the role. The permit name can be retrieved from the <<services/cluster_levels>> service.
|
18603
|
+
#
|
18604
|
+
# For example to assign a permit `create_vm` to the role with id `123` send a request like this:
|
18605
|
+
#
|
18606
|
+
# ....
|
18607
|
+
# POST /ovirt-engine/api/roles/123/permits
|
18608
|
+
# ....
|
18609
|
+
#
|
18610
|
+
# With a request body like this:
|
18611
|
+
#
|
18612
|
+
# [source,xml]
|
18613
|
+
# ----
|
18614
|
+
# <permit>
|
18615
|
+
# <name>create_vm</name>
|
18616
|
+
# </permit>
|
18617
|
+
# ----
|
17215
18618
|
#
|
17216
18619
|
# @param permit [Permit] The permit to add.
|
17217
18620
|
#
|
@@ -17247,7 +18650,29 @@ module OvirtSDK4
|
|
17247
18650
|
end
|
17248
18651
|
|
17249
18652
|
#
|
17250
|
-
#
|
18653
|
+
# List the permits of the role.
|
18654
|
+
#
|
18655
|
+
# For example to list the permits of the role with the id `123` send a request like this:
|
18656
|
+
#
|
18657
|
+
# ....
|
18658
|
+
# GET /ovirt-engine/api/roles/123/permits
|
18659
|
+
# ....
|
18660
|
+
#
|
18661
|
+
# [source,xml]
|
18662
|
+
# ----
|
18663
|
+
# <permits>
|
18664
|
+
# <permit href="/ovirt-engine/api/roles/123/permits/5" id="5">
|
18665
|
+
# <name>change_vm_cd</name>
|
18666
|
+
# <administrative>false</administrative>
|
18667
|
+
# <role href="/ovirt-engine/api/roles/123" id="123"/>
|
18668
|
+
# </permit>
|
18669
|
+
# <permit href="/ovirt-engine/api/roles/123/permits/7" id="7">
|
18670
|
+
# <name>connect_to_vm</name>
|
18671
|
+
# <administrative>false</administrative>
|
18672
|
+
# <role href="/ovirt-engine/api/roles/123" id="123"/>
|
18673
|
+
# </permit>
|
18674
|
+
# </permits>
|
18675
|
+
# ----
|
17251
18676
|
#
|
17252
18677
|
# @param opts [Hash] Additional options.
|
17253
18678
|
#
|
@@ -18358,7 +19783,25 @@ module OvirtSDK4
|
|
18358
19783
|
end
|
18359
19784
|
|
18360
19785
|
#
|
18361
|
-
#
|
19786
|
+
# Get the role.
|
19787
|
+
#
|
19788
|
+
# [source]
|
19789
|
+
# ----
|
19790
|
+
# GET /ovirt-engine/api/roles/123
|
19791
|
+
# ----
|
19792
|
+
#
|
19793
|
+
# You will receive XML response like this one:
|
19794
|
+
#
|
19795
|
+
# [source,xml]
|
19796
|
+
# ----
|
19797
|
+
# <role id="123">
|
19798
|
+
# <name>MyRole</name>
|
19799
|
+
# <description>MyRole description</description>
|
19800
|
+
# <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
|
19801
|
+
# <administrative>true</administrative>
|
19802
|
+
# <mutable>false</mutable>
|
19803
|
+
# </role>
|
19804
|
+
# ----
|
18362
19805
|
#
|
18363
19806
|
# @param opts [Hash] Additional options.
|
18364
19807
|
#
|
@@ -18431,7 +19874,7 @@ module OvirtSDK4
|
|
18431
19874
|
# </group>
|
18432
19875
|
# ----
|
18433
19876
|
#
|
18434
|
-
# @param role [Role]
|
19877
|
+
# @param role [Role] Updated role.
|
18435
19878
|
# @param opts [Hash] Additional options.
|
18436
19879
|
#
|
18437
19880
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -18472,7 +19915,7 @@ module OvirtSDK4
|
|
18472
19915
|
end
|
18473
19916
|
|
18474
19917
|
#
|
18475
|
-
#
|
19918
|
+
# Sub-resource locator method, returns permits service.
|
18476
19919
|
#
|
18477
19920
|
# @return [PermitsService] A reference to `permits` service.
|
18478
19921
|
#
|
@@ -18553,7 +19996,7 @@ module OvirtSDK4
|
|
18553
19996
|
# </group>
|
18554
19997
|
# ----
|
18555
19998
|
#
|
18556
|
-
# @param role [Role]
|
19999
|
+
# @param role [Role] Role that will be added.
|
18557
20000
|
#
|
18558
20001
|
# @param opts [Hash] Additional options.
|
18559
20002
|
#
|
@@ -18587,7 +20030,28 @@ module OvirtSDK4
|
|
18587
20030
|
end
|
18588
20031
|
|
18589
20032
|
#
|
18590
|
-
#
|
20033
|
+
# List roles.
|
20034
|
+
#
|
20035
|
+
# [source]
|
20036
|
+
# ----
|
20037
|
+
# GET /ovirt-engine/api/roles
|
20038
|
+
# ----
|
20039
|
+
#
|
20040
|
+
# You will receive response in XML like this one:
|
20041
|
+
#
|
20042
|
+
# [source,xml]
|
20043
|
+
# ----
|
20044
|
+
# <roles>
|
20045
|
+
# <role id="123">
|
20046
|
+
# <name>SuperUser</name>
|
20047
|
+
# <description>Roles management administrator</description>
|
20048
|
+
# <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
|
20049
|
+
# <administrative>true</administrative>
|
20050
|
+
# <mutable>false</mutable>
|
20051
|
+
# </role>
|
20052
|
+
# ...
|
20053
|
+
# </roles>
|
20054
|
+
# ----
|
18591
20055
|
#
|
18592
20056
|
# @param opts [Hash] Additional options.
|
18593
20057
|
#
|
@@ -20263,7 +21727,63 @@ module OvirtSDK4
|
|
20263
21727
|
end
|
20264
21728
|
|
20265
21729
|
#
|
20266
|
-
#
|
21730
|
+
# Retrieves a list of statistics.
|
21731
|
+
#
|
21732
|
+
# For example, to retrieve the statistics for virtual machine `123` send a
|
21733
|
+
# request like this:
|
21734
|
+
#
|
21735
|
+
# [source]
|
21736
|
+
# ----
|
21737
|
+
# GET /ovirt-engine/api/vms/123/statistics
|
21738
|
+
# ----
|
21739
|
+
#
|
21740
|
+
# The result will be like this:
|
21741
|
+
#
|
21742
|
+
# [source,xml]
|
21743
|
+
# ----
|
21744
|
+
# <statistics>
|
21745
|
+
# <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
|
21746
|
+
# <name>memory.installed</name>
|
21747
|
+
# <description>Total memory configured</description>
|
21748
|
+
# <kind>gauge</kind>
|
21749
|
+
# <type>integer</type>
|
21750
|
+
# <unit>bytes</unit>
|
21751
|
+
# <values>
|
21752
|
+
# <value>
|
21753
|
+
# <datum>1073741824</datum>
|
21754
|
+
# </value>
|
21755
|
+
# </values>
|
21756
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
21757
|
+
# </statistic>
|
21758
|
+
# ...
|
21759
|
+
# </statistics>
|
21760
|
+
# ----
|
21761
|
+
#
|
21762
|
+
# Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
|
21763
|
+
#
|
21764
|
+
# [source]
|
21765
|
+
# ----
|
21766
|
+
# GET /ovirt-engine/api/vms/123/statistics/456
|
21767
|
+
# ----
|
21768
|
+
#
|
21769
|
+
# Outputs:
|
21770
|
+
#
|
21771
|
+
# [source,xml]
|
21772
|
+
# ----
|
21773
|
+
# <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
|
21774
|
+
# <name>memory.installed</name>
|
21775
|
+
# <description>Total memory configured</description>
|
21776
|
+
# <kind>gauge</kind>
|
21777
|
+
# <type>integer</type>
|
21778
|
+
# <unit>bytes</unit>
|
21779
|
+
# <values>
|
21780
|
+
# <value>
|
21781
|
+
# <datum>1073741824</datum>
|
21782
|
+
# </value>
|
21783
|
+
# </values>
|
21784
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
21785
|
+
# </statistic>
|
21786
|
+
# ----
|
20267
21787
|
#
|
20268
21788
|
# @param opts [Hash] Additional options.
|
20269
21789
|
#
|
@@ -20350,15 +21870,33 @@ module OvirtSDK4
|
|
20350
21870
|
end
|
20351
21871
|
|
20352
21872
|
#
|
20353
|
-
#
|
21873
|
+
# Marks an external step execution as ended.
|
21874
|
+
#
|
21875
|
+
# For example, to terminate a step with identifier `456` which belongs to a `job` with identifier `123` send the
|
21876
|
+
# following request:
|
21877
|
+
#
|
21878
|
+
# [source]
|
21879
|
+
# ----
|
21880
|
+
# POST /ovirt-engine/api/jobs/123/steps/456/end
|
21881
|
+
# ----
|
21882
|
+
#
|
21883
|
+
# With the following request body:
|
21884
|
+
#
|
21885
|
+
# [source,xml]
|
21886
|
+
# ----
|
21887
|
+
# <action>
|
21888
|
+
# <force>true</force>
|
21889
|
+
# <succeeded>true</succeeded>
|
21890
|
+
# </action>
|
21891
|
+
# ----
|
20354
21892
|
#
|
20355
21893
|
# @param opts [Hash] Additional options.
|
20356
21894
|
#
|
20357
21895
|
# @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
|
20358
21896
|
#
|
20359
|
-
# @option opts [Boolean] :force
|
21897
|
+
# @option opts [Boolean] :force Indicates if the step should be forcibly terminated.
|
20360
21898
|
#
|
20361
|
-
# @option opts [Boolean] :succeeded
|
21899
|
+
# @option opts [Boolean] :succeeded Indicates the resolution of the step execution.
|
20362
21900
|
#
|
20363
21901
|
def end_(opts = {})
|
20364
21902
|
action = Action.new(opts)
|
@@ -20381,7 +21919,31 @@ module OvirtSDK4
|
|
20381
21919
|
end
|
20382
21920
|
|
20383
21921
|
#
|
20384
|
-
#
|
21922
|
+
# Retrieves a step.
|
21923
|
+
#
|
21924
|
+
# [source]
|
21925
|
+
# ----
|
21926
|
+
# GET /ovirt-engine/api/jobs/123/steps/456
|
21927
|
+
# ----
|
21928
|
+
#
|
21929
|
+
# You will receive response in XML like this one:
|
21930
|
+
#
|
21931
|
+
# [source,xml]
|
21932
|
+
# ----
|
21933
|
+
# <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
|
21934
|
+
# <actions>
|
21935
|
+
# <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
|
21936
|
+
# </actions>
|
21937
|
+
# <description>Validating</description>
|
21938
|
+
# <end_time>2016-12-12T23:07:26.627+02:00</end_time>
|
21939
|
+
# <external>false</external>
|
21940
|
+
# <number>0</number>
|
21941
|
+
# <start_time>2016-12-12T23:07:26.605+02:00</start_time>
|
21942
|
+
# <status>finished</status>
|
21943
|
+
# <type>validating</type>
|
21944
|
+
# <job href="/ovirt-engine/api/jobs/123" id="123"/>
|
21945
|
+
# </step>
|
21946
|
+
# ----
|
20385
21947
|
#
|
20386
21948
|
# @param opts [Hash] Additional options.
|
20387
21949
|
#
|
@@ -20461,9 +22023,48 @@ module OvirtSDK4
|
|
20461
22023
|
end
|
20462
22024
|
|
20463
22025
|
#
|
20464
|
-
#
|
22026
|
+
# Add an external step to an existing job or to an existing step.
|
22027
|
+
#
|
22028
|
+
# For example, to add a step to `job` with identifier `123` send the
|
22029
|
+
# following request:
|
22030
|
+
#
|
22031
|
+
# [source]
|
22032
|
+
# ----
|
22033
|
+
# POST /ovirt-engine/api/jobs/123/steps
|
22034
|
+
# ----
|
22035
|
+
#
|
22036
|
+
# With the following request body:
|
22037
|
+
#
|
22038
|
+
# [source,xml]
|
22039
|
+
# ----
|
22040
|
+
# <step>
|
22041
|
+
# <description>Validating</description>
|
22042
|
+
# <start_time>2016-12-12T23:07:26.605+02:00</start_time>
|
22043
|
+
# <status>started</status>
|
22044
|
+
# <type>validating</type>
|
22045
|
+
# </step>
|
22046
|
+
# ----
|
22047
|
+
#
|
22048
|
+
# The response should look like:
|
22049
|
+
#
|
22050
|
+
# [source,xml]
|
22051
|
+
# ----
|
22052
|
+
# <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
|
22053
|
+
# <actions>
|
22054
|
+
# <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
|
22055
|
+
# </actions>
|
22056
|
+
# <description>Validating</description>
|
22057
|
+
# <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
|
22058
|
+
# <external>true</external>
|
22059
|
+
# <number>2</number>
|
22060
|
+
# <start_time>2016-12-13T01:06:15.380+02:00</start_time>
|
22061
|
+
# <status>started</status>
|
22062
|
+
# <type>validating</type>
|
22063
|
+
# <job href="/ovirt-engine/api/jobs/123" id="123"/>
|
22064
|
+
# </step>
|
22065
|
+
# ----
|
20465
22066
|
#
|
20466
|
-
# @param step [Step]
|
22067
|
+
# @param step [Step] Step that will be added.
|
20467
22068
|
#
|
20468
22069
|
# @param opts [Hash] Additional options.
|
20469
22070
|
#
|
@@ -20497,7 +22098,34 @@ module OvirtSDK4
|
|
20497
22098
|
end
|
20498
22099
|
|
20499
22100
|
#
|
20500
|
-
#
|
22101
|
+
# Retrieves the representation of the steps.
|
22102
|
+
#
|
22103
|
+
# [source]
|
22104
|
+
# ----
|
22105
|
+
# GET /ovirt-engine/api/job/123/steps
|
22106
|
+
# ----
|
22107
|
+
#
|
22108
|
+
# You will receive response in XML like this one:
|
22109
|
+
#
|
22110
|
+
# [source,xml]
|
22111
|
+
# ----
|
22112
|
+
# <steps>
|
22113
|
+
# <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
|
22114
|
+
# <actions>
|
22115
|
+
# <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
|
22116
|
+
# </actions>
|
22117
|
+
# <description>Validating</description>
|
22118
|
+
# <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
|
22119
|
+
# <external>true</external>
|
22120
|
+
# <number>2</number>
|
22121
|
+
# <start_time>2016-12-13T01:06:15.380+02:00</start_time>
|
22122
|
+
# <status>started</status>
|
22123
|
+
# <type>validating</type>
|
22124
|
+
# <job href="/ovirt-engine/api/jobs/123" id="123"/>
|
22125
|
+
# </step>
|
22126
|
+
# ...
|
22127
|
+
# </steps>
|
22128
|
+
# ----
|
20501
22129
|
#
|
20502
22130
|
# @param opts [Hash] Additional options.
|
20503
22131
|
#
|
@@ -20528,7 +22156,7 @@ module OvirtSDK4
|
|
20528
22156
|
end
|
20529
22157
|
|
20530
22158
|
#
|
20531
|
-
#
|
22159
|
+
# Reference to the step service.
|
20532
22160
|
#
|
20533
22161
|
# @param id [String] The identifier of the `step`.
|
20534
22162
|
#
|
@@ -22365,6 +23993,26 @@ module OvirtSDK4
|
|
22365
23993
|
# </storage_domain>
|
22366
23994
|
# ----
|
22367
23995
|
#
|
23996
|
+
# To create a new iSCSI storage domain send a request like this:
|
23997
|
+
#
|
23998
|
+
# [source,xml]
|
23999
|
+
# ----
|
24000
|
+
# <storage_domain>
|
24001
|
+
# <name>myiscsi</name>
|
24002
|
+
# <type>data</type>
|
24003
|
+
# <storage>
|
24004
|
+
# <type>iscsi</type>
|
24005
|
+
# <logical_units>
|
24006
|
+
# <logical_unit id="3600144f09dbd050000004eedbd340001"/>
|
24007
|
+
# <logical_unit id="3600144f09dbd050000004eedbd340002"/>
|
24008
|
+
# </logical_units>
|
24009
|
+
# </storage>
|
24010
|
+
# <host>
|
24011
|
+
# <name>myhost</name>
|
24012
|
+
# </host>
|
24013
|
+
# </storage_domain>
|
24014
|
+
# ----
|
24015
|
+
#
|
22368
24016
|
# @param storage_domain [StorageDomain] The `storage_domain` to add.
|
22369
24017
|
#
|
22370
24018
|
# @param opts [Hash] Additional options.
|
@@ -23398,7 +25046,7 @@ module OvirtSDK4
|
|
23398
25046
|
end
|
23399
25047
|
|
23400
25048
|
#
|
23401
|
-
#
|
25049
|
+
# List all the jobs monitored by the engine.
|
23402
25050
|
#
|
23403
25051
|
# @return [JobsService] A reference to `jobs` service.
|
23404
25052
|
#
|
@@ -23407,7 +25055,7 @@ module OvirtSDK4
|
|
23407
25055
|
end
|
23408
25056
|
|
23409
25057
|
#
|
23410
|
-
#
|
25058
|
+
# List the available Katello errata assigned to the engine.
|
23411
25059
|
#
|
23412
25060
|
# @return [EngineKatelloErrataService] A reference to `katello_errata` service.
|
23413
25061
|
#
|
@@ -23857,9 +25505,66 @@ module OvirtSDK4
|
|
23857
25505
|
end
|
23858
25506
|
|
23859
25507
|
#
|
23860
|
-
#
|
25508
|
+
# Assign a new permission to a user or group for specific entity.
|
25509
|
+
#
|
25510
|
+
# For example, to assign the `UserVmManager` role to the virtual machine with id `123` to the user with id `456`
|
25511
|
+
# send a request like this:
|
25512
|
+
#
|
25513
|
+
# ....
|
25514
|
+
# POST /ovirt-engine/api/vms/123/permissions
|
25515
|
+
# ....
|
25516
|
+
#
|
25517
|
+
# With a request body like this:
|
25518
|
+
#
|
25519
|
+
# [source,xml]
|
25520
|
+
# ----
|
25521
|
+
# <permission>
|
25522
|
+
# <role>
|
25523
|
+
# <name>UserVmManager</name>
|
25524
|
+
# </role>
|
25525
|
+
# <user id="456"/>
|
25526
|
+
# </permission>
|
25527
|
+
# ----
|
25528
|
+
#
|
25529
|
+
# To assign the `SuperUser` role to the system to the user with id `456` send a request like this:
|
25530
|
+
#
|
25531
|
+
# ....
|
25532
|
+
# POST /ovirt-engine/api/permissions
|
25533
|
+
# ....
|
23861
25534
|
#
|
23862
|
-
#
|
25535
|
+
# With a request body like this:
|
25536
|
+
#
|
25537
|
+
# [source,xml]
|
25538
|
+
# ----
|
25539
|
+
# <permission>
|
25540
|
+
# <role>
|
25541
|
+
# <name>SuperUser</name>
|
25542
|
+
# </role>
|
25543
|
+
# <user id="456"/>
|
25544
|
+
# </permission>
|
25545
|
+
# ----
|
25546
|
+
#
|
25547
|
+
# If you want to assign permission to the group instead of the user please replace the `user` element with the
|
25548
|
+
# `group` element with proper `id` of the group. For example to assign the `UserRole` role to the cluster with
|
25549
|
+
# id `123` to the group with id `789` send a request like this:
|
25550
|
+
#
|
25551
|
+
# ....
|
25552
|
+
# POST /ovirt-engine/api/clusters/123/permissions
|
25553
|
+
# ....
|
25554
|
+
#
|
25555
|
+
# With a request body like this:
|
25556
|
+
#
|
25557
|
+
# [source,xml]
|
25558
|
+
# ----
|
25559
|
+
# <permission>
|
25560
|
+
# <role>
|
25561
|
+
# <name>UserRole</name>
|
25562
|
+
# </role>
|
25563
|
+
# <group id="789"/>
|
25564
|
+
# </permission>
|
25565
|
+
# ----
|
25566
|
+
#
|
25567
|
+
# @param permission [Permission] The permission.
|
23863
25568
|
#
|
23864
25569
|
# @param opts [Hash] Additional options.
|
23865
25570
|
#
|
@@ -23893,7 +25598,29 @@ module OvirtSDK4
|
|
23893
25598
|
end
|
23894
25599
|
|
23895
25600
|
#
|
23896
|
-
#
|
25601
|
+
# List all the permissions of the specific entity.
|
25602
|
+
#
|
25603
|
+
# For example to list all the permissions of the cluster with id `123` send a request like this:
|
25604
|
+
#
|
25605
|
+
# ....
|
25606
|
+
# GET /ovirt-engine/api/clusters/123/permissions
|
25607
|
+
# ....
|
25608
|
+
#
|
25609
|
+
# [source,xml]
|
25610
|
+
# ----
|
25611
|
+
# <permissions>
|
25612
|
+
# <permission id="456">
|
25613
|
+
# <cluster id="123"/>
|
25614
|
+
# <role id="789"/>
|
25615
|
+
# <user id="451"/>
|
25616
|
+
# </permission>
|
25617
|
+
# <permission id="654">
|
25618
|
+
# <cluster id="123"/>
|
25619
|
+
# <role id="789"/>
|
25620
|
+
# <group id="127"/>
|
25621
|
+
# </permission>
|
25622
|
+
# </permissions>
|
25623
|
+
# ----
|
23897
25624
|
#
|
23898
25625
|
# @param opts [Hash] Additional options.
|
23899
25626
|
#
|
@@ -23974,7 +25701,21 @@ module OvirtSDK4
|
|
23974
25701
|
end
|
23975
25702
|
|
23976
25703
|
#
|
23977
|
-
#
|
25704
|
+
# Gets the information about the tag.
|
25705
|
+
#
|
25706
|
+
# For example to retrieve the information about the tag with the id `123` send a request like this:
|
25707
|
+
#
|
25708
|
+
# ....
|
25709
|
+
# GET /ovirt-engine/api/tags/123
|
25710
|
+
# ....
|
25711
|
+
#
|
25712
|
+
# [source,xml]
|
25713
|
+
# ----
|
25714
|
+
# <tag href="/ovirt-engine/api/tags/123" id="123">
|
25715
|
+
# <name>root</name>
|
25716
|
+
# <description>root</description>
|
25717
|
+
# </tag>
|
25718
|
+
# ----
|
23978
25719
|
#
|
23979
25720
|
# @param opts [Hash] Additional options.
|
23980
25721
|
#
|
@@ -23998,7 +25739,13 @@ module OvirtSDK4
|
|
23998
25739
|
end
|
23999
25740
|
|
24000
25741
|
#
|
24001
|
-
#
|
25742
|
+
# Removes the tag from the system.
|
25743
|
+
#
|
25744
|
+
# For example to remove the tag with id `123` send a request like this:
|
25745
|
+
#
|
25746
|
+
# ....
|
25747
|
+
# DELETE /ovirt-engine/api/tags/123
|
25748
|
+
# ....
|
24002
25749
|
#
|
24003
25750
|
# @param opts [Hash] Additional options.
|
24004
25751
|
#
|
@@ -24018,9 +25765,36 @@ module OvirtSDK4
|
|
24018
25765
|
end
|
24019
25766
|
|
24020
25767
|
#
|
24021
|
-
# Updates the
|
25768
|
+
# Updates the tag entity.
|
25769
|
+
#
|
25770
|
+
# For example to update parent tag to tag with id `456` of the tag with id `123` send a request like this:
|
24022
25771
|
#
|
24023
|
-
#
|
25772
|
+
# ....
|
25773
|
+
# PUT /ovirt-engine/api/tags/123
|
25774
|
+
# ....
|
25775
|
+
#
|
25776
|
+
# With request body like:
|
25777
|
+
#
|
25778
|
+
# [source,xml]
|
25779
|
+
# ----
|
25780
|
+
# <tag>
|
25781
|
+
# <parent id="456"/>
|
25782
|
+
# </tag>
|
25783
|
+
# ----
|
25784
|
+
#
|
25785
|
+
# You may also specify a tag name instead of id. For example to update parent tag to tag with name `mytag`
|
25786
|
+
# of the tag with id `123` send a request like this:
|
25787
|
+
#
|
25788
|
+
# [source,xml]
|
25789
|
+
# ----
|
25790
|
+
# <tag>
|
25791
|
+
# <parent>
|
25792
|
+
# <name>mytag</name>
|
25793
|
+
# </parent>
|
25794
|
+
# </tag>
|
25795
|
+
# ----
|
25796
|
+
#
|
25797
|
+
# @param tag [Tag] The updated tag.
|
24024
25798
|
# @param opts [Hash] Additional options.
|
24025
25799
|
#
|
24026
25800
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -24102,9 +25876,39 @@ module OvirtSDK4
|
|
24102
25876
|
end
|
24103
25877
|
|
24104
25878
|
#
|
24105
|
-
#
|
25879
|
+
# Add a new tag to the system.
|
25880
|
+
#
|
25881
|
+
# For example, to add new tag with name `mytag` to the system send a request like this:
|
25882
|
+
#
|
25883
|
+
# ....
|
25884
|
+
# POST /ovirt-engine/api/tags
|
25885
|
+
# ....
|
25886
|
+
#
|
25887
|
+
# With a request body like this:
|
25888
|
+
#
|
25889
|
+
# [source,xml]
|
25890
|
+
# ----
|
25891
|
+
# <tag>
|
25892
|
+
# <name>mytag</name>
|
25893
|
+
# </tag>
|
25894
|
+
# ----
|
25895
|
+
#
|
25896
|
+
# NOTE: The root tag is a special pseudo-tag assumed as the default parent tag if no parent tag is specified.
|
25897
|
+
# The root tag cannot be deleted nor assigned a parent tag.
|
25898
|
+
#
|
25899
|
+
# To create new tag with specific parent tag send a request body like this:
|
25900
|
+
#
|
25901
|
+
# [source,xml]
|
25902
|
+
# ----
|
25903
|
+
# <tag>
|
25904
|
+
# <name>mytag</name>
|
25905
|
+
# <parent>
|
25906
|
+
# <name>myparenttag</name>
|
25907
|
+
# </parent>
|
25908
|
+
# </tag>
|
25909
|
+
# ----
|
24106
25910
|
#
|
24107
|
-
# @param tag [Tag] The
|
25911
|
+
# @param tag [Tag] The added tag.
|
24108
25912
|
#
|
24109
25913
|
# @param opts [Hash] Additional options.
|
24110
25914
|
#
|
@@ -24138,7 +25942,40 @@ module OvirtSDK4
|
|
24138
25942
|
end
|
24139
25943
|
|
24140
25944
|
#
|
24141
|
-
#
|
25945
|
+
# List the tags in the system.
|
25946
|
+
#
|
25947
|
+
# For example to list the full hierarchy of the tags in the system send a request like this:
|
25948
|
+
#
|
25949
|
+
# ....
|
25950
|
+
# GET /ovirt-engine/api/tags
|
25951
|
+
# ....
|
25952
|
+
#
|
25953
|
+
# [source,xml]
|
25954
|
+
# ----
|
25955
|
+
# <tags>
|
25956
|
+
# <tag href="/ovirt-engine/api/tags/222" id="222">
|
25957
|
+
# <name>root2</name>
|
25958
|
+
# <description>root2</description>
|
25959
|
+
# <parent href="/ovirt-engine/api/tags/111" id="111"/>
|
25960
|
+
# </tag>
|
25961
|
+
# <tag href="/ovirt-engine/api/tags/333" id="333">
|
25962
|
+
# <name>root3</name>
|
25963
|
+
# <description>root3</description>
|
25964
|
+
# <parent href="/ovirt-engine/api/tags/222" id="222"/>
|
25965
|
+
# </tag>
|
25966
|
+
# <tag href="/ovirt-engine/api/tags/111" id="111">
|
25967
|
+
# <name>root</name>
|
25968
|
+
# <description>root</description>
|
25969
|
+
# </tag>
|
25970
|
+
# </tags>
|
25971
|
+
# ----
|
25972
|
+
#
|
25973
|
+
# In the previous XML output you can see the following hierarchy of the tags:
|
25974
|
+
# ....
|
25975
|
+
# root: (id: 111)
|
25976
|
+
# - root2 (id: 222)
|
25977
|
+
# - root3 (id: 333)
|
25978
|
+
# ....
|
24142
25979
|
#
|
24143
25980
|
# @param opts [Hash] Additional options.
|
24144
25981
|
#
|
@@ -24169,7 +26006,7 @@ module OvirtSDK4
|
|
24169
26006
|
end
|
24170
26007
|
|
24171
26008
|
#
|
24172
|
-
#
|
26009
|
+
# Reference to the service that manages a specific tag.
|
24173
26010
|
#
|
24174
26011
|
# @param id [String] The identifier of the `tag`.
|
24175
26012
|
#
|
@@ -24274,7 +26111,7 @@ module OvirtSDK4
|
|
24274
26111
|
end
|
24275
26112
|
|
24276
26113
|
#
|
24277
|
-
# Returns the
|
26114
|
+
# Returns the information about this template or template version.
|
24278
26115
|
#
|
24279
26116
|
# @param opts [Hash] Additional options.
|
24280
26117
|
#
|
@@ -24305,7 +26142,7 @@ module OvirtSDK4
|
|
24305
26142
|
end
|
24306
26143
|
|
24307
26144
|
#
|
24308
|
-
#
|
26145
|
+
# Removes a virtual machine template.
|
24309
26146
|
#
|
24310
26147
|
# [source]
|
24311
26148
|
# ----
|
@@ -24404,7 +26241,7 @@ module OvirtSDK4
|
|
24404
26241
|
end
|
24405
26242
|
|
24406
26243
|
#
|
24407
|
-
#
|
26244
|
+
# Returns a reference to the service that manages the CDROMs that are associated with the template.
|
24408
26245
|
#
|
24409
26246
|
# @return [TemplateCdromsService] A reference to `cdroms` service.
|
24410
26247
|
#
|
@@ -24432,7 +26269,7 @@ module OvirtSDK4
|
|
24432
26269
|
end
|
24433
26270
|
|
24434
26271
|
#
|
24435
|
-
#
|
26272
|
+
# Returns a reference to the service that manages the NICs that are associated with the template.
|
24436
26273
|
#
|
24437
26274
|
# @return [TemplateNicsService] A reference to `nics` service.
|
24438
26275
|
#
|
@@ -24441,7 +26278,7 @@ module OvirtSDK4
|
|
24441
26278
|
end
|
24442
26279
|
|
24443
26280
|
#
|
24444
|
-
#
|
26281
|
+
# Returns a reference to the service that manages the permissions that are associated with the template.
|
24445
26282
|
#
|
24446
26283
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
24447
26284
|
#
|
@@ -24450,7 +26287,7 @@ module OvirtSDK4
|
|
24450
26287
|
end
|
24451
26288
|
|
24452
26289
|
#
|
24453
|
-
#
|
26290
|
+
# Returns a reference to the service that manages the tags that are associated with the template.
|
24454
26291
|
#
|
24455
26292
|
# @return [AssignedTagsService] A reference to `tags` service.
|
24456
26293
|
#
|
@@ -24459,7 +26296,7 @@ module OvirtSDK4
|
|
24459
26296
|
end
|
24460
26297
|
|
24461
26298
|
#
|
24462
|
-
#
|
26299
|
+
# Returns a reference to the service that manages the _watchdogs_ that are associated with the template.
|
24463
26300
|
#
|
24464
26301
|
# @return [TemplateWatchdogsService] A reference to `watchdogs` service.
|
24465
26302
|
#
|
@@ -24551,7 +26388,14 @@ module OvirtSDK4
|
|
24551
26388
|
end
|
24552
26389
|
|
24553
26390
|
#
|
24554
|
-
# Returns the
|
26391
|
+
# Returns the information about this CD-ROM device.
|
26392
|
+
#
|
26393
|
+
# For example, to get information about the CD-ROM device of template `123` send a request like:
|
26394
|
+
#
|
26395
|
+
# [source]
|
26396
|
+
# ----
|
26397
|
+
# GET /ovirt-engine/api/templates/123/cdroms/
|
26398
|
+
# ----
|
24555
26399
|
#
|
24556
26400
|
# @param opts [Hash] Additional options.
|
24557
26401
|
#
|
@@ -24620,7 +26464,7 @@ module OvirtSDK4
|
|
24620
26464
|
#
|
24621
26465
|
# @param opts [Hash] Additional options.
|
24622
26466
|
#
|
24623
|
-
# @option opts [Integer] :max Sets the maximum number of
|
26467
|
+
# @option opts [Integer] :max Sets the maximum number of CD-ROMs to return. If not specified all the CD-ROMs are returned.
|
24624
26468
|
#
|
24625
26469
|
# @return [Array<Cdrom>]
|
24626
26470
|
#
|
@@ -24647,7 +26491,7 @@ module OvirtSDK4
|
|
24647
26491
|
end
|
24648
26492
|
|
24649
26493
|
#
|
24650
|
-
#
|
26494
|
+
# Returns a reference to the service that manages a specific CD-ROM device.
|
24651
26495
|
#
|
24652
26496
|
# @param id [String] The identifier of the `cdrom`.
|
24653
26497
|
#
|
@@ -25650,7 +27494,7 @@ module OvirtSDK4
|
|
25650
27494
|
# </template>
|
25651
27495
|
# ----
|
25652
27496
|
#
|
25653
|
-
# @param template [Template] The
|
27497
|
+
# @param template [Template] The information about the template or template version.
|
25654
27498
|
#
|
25655
27499
|
# @param opts [Hash] Additional options.
|
25656
27500
|
#
|
@@ -25712,7 +27556,16 @@ module OvirtSDK4
|
|
25712
27556
|
end
|
25713
27557
|
|
25714
27558
|
#
|
25715
|
-
# Returns the
|
27559
|
+
# Returns the list of virtual machine templates.
|
27560
|
+
#
|
27561
|
+
# For example:
|
27562
|
+
#
|
27563
|
+
# [source]
|
27564
|
+
# ----
|
27565
|
+
# GET /ovirt-engine/api/templates
|
27566
|
+
# ----
|
27567
|
+
#
|
27568
|
+
# Will return the list of virtual machines and virtual machine templates.
|
25716
27569
|
#
|
25717
27570
|
# @param opts [Hash] Additional options.
|
25718
27571
|
#
|
@@ -25765,7 +27618,7 @@ module OvirtSDK4
|
|
25765
27618
|
end
|
25766
27619
|
|
25767
27620
|
#
|
25768
|
-
#
|
27621
|
+
# Returns a reference to the service that manages a specific virtual machine template.
|
25769
27622
|
#
|
25770
27623
|
# @param id [String] The identifier of the `template`.
|
25771
27624
|
#
|
@@ -25993,7 +27846,36 @@ module OvirtSDK4
|
|
25993
27846
|
end
|
25994
27847
|
|
25995
27848
|
#
|
25996
|
-
#
|
27849
|
+
# Gets the system user information.
|
27850
|
+
#
|
27851
|
+
# Usage:
|
27852
|
+
#
|
27853
|
+
# ....
|
27854
|
+
# GET /ovirt-engine/api/users/1234
|
27855
|
+
# ....
|
27856
|
+
#
|
27857
|
+
# Will return the user information:
|
27858
|
+
#
|
27859
|
+
# [source,xml]
|
27860
|
+
# ----
|
27861
|
+
# <user href="/ovirt-engine/api/users/1234" id="1234">
|
27862
|
+
# <name>admin</name>
|
27863
|
+
# <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
|
27864
|
+
# <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
|
27865
|
+
# <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
|
27866
|
+
# <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
|
27867
|
+
# <department></department>
|
27868
|
+
# <domain_entry_id>23456</domain_entry_id>
|
27869
|
+
# <email>user1@domain.com</email>
|
27870
|
+
# <last_name>Lastname</last_name>
|
27871
|
+
# <namespace>*</namespace>
|
27872
|
+
# <principal>user1</principal>
|
27873
|
+
# <user_name>user1@domain-authz</user_name>
|
27874
|
+
# <domain href="/ovirt-engine/api/domains/45678" id="45678">
|
27875
|
+
# <name>domain-authz</name>
|
27876
|
+
# </domain>
|
27877
|
+
# </user>
|
27878
|
+
# ----
|
25997
27879
|
#
|
25998
27880
|
# @param opts [Hash] Additional options.
|
25999
27881
|
#
|
@@ -26017,7 +27899,13 @@ module OvirtSDK4
|
|
26017
27899
|
end
|
26018
27900
|
|
26019
27901
|
#
|
26020
|
-
#
|
27902
|
+
# Removes the system user.
|
27903
|
+
#
|
27904
|
+
# Usage:
|
27905
|
+
#
|
27906
|
+
# ....
|
27907
|
+
# DELETE /ovirt-engine/api/users/1234
|
27908
|
+
# ....
|
26021
27909
|
#
|
26022
27910
|
# @param opts [Hash] Additional options.
|
26023
27911
|
#
|
@@ -26212,7 +28100,35 @@ module OvirtSDK4
|
|
26212
28100
|
end
|
26213
28101
|
|
26214
28102
|
#
|
26215
|
-
#
|
28103
|
+
# List all the users in the system.
|
28104
|
+
#
|
28105
|
+
# Usage:
|
28106
|
+
#
|
28107
|
+
# ....
|
28108
|
+
# GET /ovirt-engine/api/users
|
28109
|
+
# ....
|
28110
|
+
#
|
28111
|
+
# Will return the list of users:
|
28112
|
+
#
|
28113
|
+
# [source,xml]
|
28114
|
+
# ----
|
28115
|
+
# <users>
|
28116
|
+
# <user href="/ovirt-engine/api/users/1234" id="1234">
|
28117
|
+
# <name>admin</name>
|
28118
|
+
# <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
|
28119
|
+
# <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
|
28120
|
+
# <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
|
28121
|
+
# <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
|
28122
|
+
# <domain_entry_id>23456</domain_entry_id>
|
28123
|
+
# <namespace>*</namespace>
|
28124
|
+
# <principal>user1</principal>
|
28125
|
+
# <user_name>user1@domain-authz</user_name>
|
28126
|
+
# <domain href="/ovirt-engine/api/domains/45678" id="45678">
|
28127
|
+
# <name>domain-authz</name>
|
28128
|
+
# </domain>
|
28129
|
+
# </user>
|
28130
|
+
# </users>
|
28131
|
+
# ----
|
26216
28132
|
#
|
26217
28133
|
# @param opts [Hash] Additional options.
|
26218
28134
|
#
|
@@ -27528,7 +29444,8 @@ module OvirtSDK4
|
|
27528
29444
|
end
|
27529
29445
|
|
27530
29446
|
#
|
27531
|
-
#
|
29447
|
+
# Reference to the service that can show the applicable errata available on the virtual machine.
|
29448
|
+
# This information is taken from Katello.
|
27532
29449
|
#
|
27533
29450
|
# @return [KatelloErrataService] A reference to `katello_errata` service.
|
27534
29451
|
#
|
@@ -27755,7 +29672,7 @@ module OvirtSDK4
|
|
27755
29672
|
end
|
27756
29673
|
|
27757
29674
|
#
|
27758
|
-
# Returns the
|
29675
|
+
# Returns the information about the application.
|
27759
29676
|
#
|
27760
29677
|
# @param opts [Hash] Additional options.
|
27761
29678
|
#
|
@@ -27827,7 +29744,7 @@ module OvirtSDK4
|
|
27827
29744
|
end
|
27828
29745
|
|
27829
29746
|
#
|
27830
|
-
# Returns
|
29747
|
+
# Returns a list of applications installed in the virtual machine.
|
27831
29748
|
#
|
27832
29749
|
# @param opts [Hash] Additional options.
|
27833
29750
|
#
|
@@ -27865,7 +29782,7 @@ module OvirtSDK4
|
|
27865
29782
|
end
|
27866
29783
|
|
27867
29784
|
#
|
27868
|
-
#
|
29785
|
+
# Returns a reference to the service that provides information about a specific application.
|
27869
29786
|
#
|
27870
29787
|
# @param id [String] The identifier of the `application`.
|
27871
29788
|
#
|
@@ -27923,6 +29840,28 @@ module OvirtSDK4
|
|
27923
29840
|
#
|
27924
29841
|
# Returns the information about this CDROM device.
|
27925
29842
|
#
|
29843
|
+
# The information consists of `cdrom` attribute containing reference to the CDROM device, the virtual machine,
|
29844
|
+
# and optionally the inserted disk.
|
29845
|
+
#
|
29846
|
+
# If there is a disk inserted then the `file` attribute will contain a reference to the ISO image:
|
29847
|
+
#
|
29848
|
+
# [source,xml]
|
29849
|
+
# ----
|
29850
|
+
# <cdrom href="..." id="00000000-0000-0000-0000-000000000000">
|
29851
|
+
# <file id="mycd.iso"/>
|
29852
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
29853
|
+
# </cdrom>
|
29854
|
+
# ----
|
29855
|
+
#
|
29856
|
+
# If there is no disk inserted then the `file` attribute won't be reported:
|
29857
|
+
#
|
29858
|
+
# [source,xml]
|
29859
|
+
# ----
|
29860
|
+
# <cdrom href="..." id="00000000-0000-0000-0000-000000000000">
|
29861
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
29862
|
+
# </cdrom>
|
29863
|
+
# ----
|
29864
|
+
#
|
27926
29865
|
# @param opts [Hash] Additional options.
|
27927
29866
|
#
|
27928
29867
|
# @option opts [Boolean] :current Indicates if the operation should return the information for the currently running virtual machine. This
|
@@ -27953,7 +29892,58 @@ module OvirtSDK4
|
|
27953
29892
|
end
|
27954
29893
|
|
27955
29894
|
#
|
27956
|
-
# Updates the information about this CDROM device.
|
29895
|
+
# Updates the information about this CDROM device.
|
29896
|
+
#
|
29897
|
+
# It allows to change or eject the disk by changing the value of the `file` attribute.
|
29898
|
+
# For example, to insert or change the disk send a request like this:
|
29899
|
+
#
|
29900
|
+
# [source]
|
29901
|
+
# ----
|
29902
|
+
# PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000
|
29903
|
+
# ----
|
29904
|
+
#
|
29905
|
+
# The body should contain the new value for the `file` attribute:
|
29906
|
+
#
|
29907
|
+
# [source,xml]
|
29908
|
+
# ----
|
29909
|
+
# <cdrom>
|
29910
|
+
# <file id="mycd.iso"/>
|
29911
|
+
# </cdrom>
|
29912
|
+
# ----
|
29913
|
+
#
|
29914
|
+
# The value of the `id` attribute, `mycd.iso` in this example, should correspond to a file available in an
|
29915
|
+
# attached ISO storage domain.
|
29916
|
+
#
|
29917
|
+
# To eject the disk use a `file` with an empty `id`:
|
29918
|
+
#
|
29919
|
+
# [source,xml]
|
29920
|
+
# ----
|
29921
|
+
# <cdrom>
|
29922
|
+
# <file id=""/>
|
29923
|
+
# </cdrom>
|
29924
|
+
# ----
|
29925
|
+
#
|
29926
|
+
# By default the above operations change permanently the disk that will be visible to the virtual machine
|
29927
|
+
# after the next boot, but they don't have any effect on the currently running virtual machine. If you want
|
29928
|
+
# to change the disk that is visible to the current running virtual machine, add the `current=true` parameter.
|
29929
|
+
# For example, to eject the current disk send a request like this:
|
29930
|
+
#
|
29931
|
+
# [source]
|
29932
|
+
# ----
|
29933
|
+
# PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true
|
29934
|
+
# ----
|
29935
|
+
#
|
29936
|
+
# With a request body like this:
|
29937
|
+
#
|
29938
|
+
# [source,xml]
|
29939
|
+
# ----
|
29940
|
+
# <cdrom>
|
29941
|
+
# <file id=""/>
|
29942
|
+
# </cdrom>
|
29943
|
+
# ----
|
29944
|
+
#
|
29945
|
+
# IMPORTANT: The changes made with the `current=true` parameter are never persisted, so they won't have any
|
29946
|
+
# effect after the virtual machine is rebooted.
|
27957
29947
|
#
|
27958
29948
|
# @param cdrom [Cdrom] The information about the CDROM device.
|
27959
29949
|
# @param opts [Hash] Additional options.
|
@@ -28652,7 +30642,35 @@ module OvirtSDK4
|
|
28652
30642
|
end
|
28653
30643
|
|
28654
30644
|
#
|
28655
|
-
#
|
30645
|
+
# Retrieve information about particular host device attached to given virtual machine.
|
30646
|
+
#
|
30647
|
+
# Example:
|
30648
|
+
#
|
30649
|
+
# [source]
|
30650
|
+
# ----
|
30651
|
+
# GET /ovirt-engine/api/vms/123/hostdevices/456
|
30652
|
+
# ----
|
30653
|
+
#
|
30654
|
+
# [source,xml]
|
30655
|
+
# ----
|
30656
|
+
# <host_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
|
30657
|
+
# <name>pci_0000_04_00_0</name>
|
30658
|
+
# <capability>pci</capability>
|
30659
|
+
# <iommu_group>30</iommu_group>
|
30660
|
+
# <placeholder>true</placeholder>
|
30661
|
+
# <product id="0x13ba">
|
30662
|
+
# <name>GM107GL [Quadro K2200]</name>
|
30663
|
+
# </product>
|
30664
|
+
# <vendor id="0x10de">
|
30665
|
+
# <name>NVIDIA Corporation</name>
|
30666
|
+
# </vendor>
|
30667
|
+
# <host href="/ovirt-engine/api/hosts/543" id="543"/>
|
30668
|
+
# <parent_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
|
30669
|
+
# <name>pci_0000_00_03_0</name>
|
30670
|
+
# </parent_device>
|
30671
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
30672
|
+
# </host_device>
|
30673
|
+
# ----
|
28656
30674
|
#
|
28657
30675
|
# @param opts [Hash] Additional options.
|
28658
30676
|
#
|
@@ -28676,7 +30694,17 @@ module OvirtSDK4
|
|
28676
30694
|
end
|
28677
30695
|
|
28678
30696
|
#
|
28679
|
-
#
|
30697
|
+
# Remove the attachment of this host device from given virtual machine.
|
30698
|
+
#
|
30699
|
+
# NOTE: In case this device serves as an IOMMU placeholder, it cannot be removed (remove will result only
|
30700
|
+
# in setting its `placeholder` flag to `true`). Note that all IOMMU placeholder devices will be removed
|
30701
|
+
# automatically as soon as there will be no more non-placeholder devices (all devices from given IOMMU
|
30702
|
+
# group are detached).
|
30703
|
+
#
|
30704
|
+
# [source]
|
30705
|
+
# ----
|
30706
|
+
# DELETE /ovirt-engine/api/vms/123/hostdevices/456
|
30707
|
+
# ----
|
28680
30708
|
#
|
28681
30709
|
# @param opts [Hash] Additional options.
|
28682
30710
|
#
|
@@ -28737,9 +30765,33 @@ module OvirtSDK4
|
|
28737
30765
|
end
|
28738
30766
|
|
28739
30767
|
#
|
28740
|
-
#
|
30768
|
+
# Attach target device to given virtual machine.
|
30769
|
+
#
|
30770
|
+
# Example:
|
30771
|
+
#
|
30772
|
+
# [source]
|
30773
|
+
# ----
|
30774
|
+
# POST /ovirt-engine/api/vms/123/hostdevices
|
30775
|
+
# ----
|
30776
|
+
#
|
30777
|
+
# With request body of type <<types/host_device,HostDevice>>, for example
|
30778
|
+
#
|
30779
|
+
# [source,xml]
|
30780
|
+
# ----
|
30781
|
+
# <host_device id="123" />
|
30782
|
+
# ----
|
30783
|
+
#
|
30784
|
+
# NOTE: A necessary precondition for a successful host device attachment is that the virtual machine must be pinned
|
30785
|
+
# to *exactly* one host. The device ID is then taken relative to this host.
|
28741
30786
|
#
|
28742
|
-
#
|
30787
|
+
# NOTE: Attachment of a PCI device that is part of a bigger IOMMU group will result in attachment of the remaining
|
30788
|
+
# devices from that IOMMU group as "placeholders". These devices are then identified using the `placeholder`
|
30789
|
+
# attribute of the <<types/host_device,HostDevice>> type set to `true`.
|
30790
|
+
#
|
30791
|
+
# In case you want attach a device that already serves as an IOMMU placeholder, simply issue an explicit Add operation
|
30792
|
+
# for it, and its `placeholder` flag will be cleared, and the device will be accessible to the virtual machine.
|
30793
|
+
#
|
30794
|
+
# @param device [HostDevice] The host device to be attached to given virtual machine.
|
28743
30795
|
#
|
28744
30796
|
# @param opts [Hash] Additional options.
|
28745
30797
|
#
|
@@ -28773,7 +30825,7 @@ module OvirtSDK4
|
|
28773
30825
|
end
|
28774
30826
|
|
28775
30827
|
#
|
28776
|
-
#
|
30828
|
+
# List the host devices assigned to given virtual machine.
|
28777
30829
|
#
|
28778
30830
|
# @param opts [Hash] Additional options.
|
28779
30831
|
#
|
@@ -28804,7 +30856,7 @@ module OvirtSDK4
|
|
28804
30856
|
end
|
28805
30857
|
|
28806
30858
|
#
|
28807
|
-
#
|
30859
|
+
# Returns a reference to the service that manages a specific host device attached to given virtual machine.
|
28808
30860
|
#
|
28809
30861
|
# @param id [String] The identifier of the `device`.
|
28810
30862
|
#
|
@@ -28993,6 +31045,7 @@ module OvirtSDK4
|
|
28993
31045
|
# <nic>
|
28994
31046
|
# <name>mynic</name>
|
28995
31047
|
# <interface>e1000</interface>
|
31048
|
+
# <vnic_profile id='789'/>
|
28996
31049
|
# </nic>
|
28997
31050
|
# ----
|
28998
31051
|
#
|
@@ -29361,9 +31414,7 @@ module OvirtSDK4
|
|
29361
31414
|
# <vm_numa_node>
|
29362
31415
|
# <numa_node_pins>
|
29363
31416
|
# <numa_node_pin>
|
29364
|
-
# <host_numa_node id="789"/>
|
29365
31417
|
# <index>0</index>
|
29366
|
-
# <pinned>true</pinned>
|
29367
31418
|
# </numa_node_pin>
|
29368
31419
|
# </numa_node_pins>
|
29369
31420
|
# </vm_numa_node>
|
@@ -29638,7 +31689,33 @@ module OvirtSDK4
|
|
29638
31689
|
end
|
29639
31690
|
|
29640
31691
|
#
|
29641
|
-
#
|
31692
|
+
# Get the virtual machine pool.
|
31693
|
+
#
|
31694
|
+
# [source]
|
31695
|
+
# ----
|
31696
|
+
# GET /ovirt-engine/api/vmpools/123
|
31697
|
+
# ----
|
31698
|
+
#
|
31699
|
+
# You will get a XML response like that one:
|
31700
|
+
# [source,xml]
|
31701
|
+
# ----
|
31702
|
+
# <vm_pool id="123">
|
31703
|
+
# <actions>...</actions>
|
31704
|
+
# <name>MyVmPool</name>
|
31705
|
+
# <description>MyVmPool description</description>
|
31706
|
+
# <link href="/ovirt-engine/api/vmpools/123/permissions" rel="permissions"/>
|
31707
|
+
# <max_user_vms>1</max_user_vms>
|
31708
|
+
# <prestarted_vms>0</prestarted_vms>
|
31709
|
+
# <size>100</size>
|
31710
|
+
# <stateful>false</stateful>
|
31711
|
+
# <type>automatic</type>
|
31712
|
+
# <use_latest_template_version>false</use_latest_template_version>
|
31713
|
+
# <cluster id="123"/>
|
31714
|
+
# <template id="123"/>
|
31715
|
+
# <vm id="123">...</vm>
|
31716
|
+
# ...
|
31717
|
+
# </vm_pool>
|
31718
|
+
# ----
|
29642
31719
|
#
|
29643
31720
|
# @param opts [Hash] Additional options.
|
29644
31721
|
#
|
@@ -29757,7 +31834,7 @@ module OvirtSDK4
|
|
29757
31834
|
end
|
29758
31835
|
|
29759
31836
|
#
|
29760
|
-
#
|
31837
|
+
# Reference to a service managing the virtual machine pool assigned permissions.
|
29761
31838
|
#
|
29762
31839
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
29763
31840
|
#
|
@@ -29834,7 +31911,7 @@ module OvirtSDK4
|
|
29834
31911
|
# </vmpool>
|
29835
31912
|
# ----
|
29836
31913
|
#
|
29837
|
-
# @param pool [VmPool]
|
31914
|
+
# @param pool [VmPool] Pool to add.
|
29838
31915
|
#
|
29839
31916
|
# @param opts [Hash] Additional options.
|
29840
31917
|
#
|
@@ -29868,7 +31945,24 @@ module OvirtSDK4
|
|
29868
31945
|
end
|
29869
31946
|
|
29870
31947
|
#
|
29871
|
-
#
|
31948
|
+
# Get a list of available virtual machines pools.
|
31949
|
+
#
|
31950
|
+
# [source]
|
31951
|
+
# ----
|
31952
|
+
# GET /ovirt-engine/api/vmpools
|
31953
|
+
# ----
|
31954
|
+
#
|
31955
|
+
# You will receive the following response:
|
31956
|
+
#
|
31957
|
+
# [source,xml]
|
31958
|
+
# ----
|
31959
|
+
# <vm_pools>
|
31960
|
+
# <vm_pool id="123">
|
31961
|
+
# ...
|
31962
|
+
# </vm_pool>
|
31963
|
+
# ...
|
31964
|
+
# </vm_pools>
|
31965
|
+
# ----
|
29872
31966
|
#
|
29873
31967
|
# @param opts [Hash] Additional options.
|
29874
31968
|
#
|
@@ -29921,7 +32015,7 @@ module OvirtSDK4
|
|
29921
32015
|
end
|
29922
32016
|
|
29923
32017
|
#
|
29924
|
-
#
|
32018
|
+
# Reference to the service that manages a specific virtual machine pool.
|
29925
32019
|
#
|
29926
32020
|
# @param id [String] The identifier of the `pool`.
|
29927
32021
|
#
|
@@ -30305,7 +32399,7 @@ module OvirtSDK4
|
|
30305
32399
|
end
|
30306
32400
|
|
30307
32401
|
#
|
30308
|
-
# Returns the
|
32402
|
+
# Returns the information about the watchdog.
|
30309
32403
|
#
|
30310
32404
|
# @param opts [Hash] Additional options.
|
30311
32405
|
#
|
@@ -30329,7 +32423,14 @@ module OvirtSDK4
|
|
30329
32423
|
end
|
30330
32424
|
|
30331
32425
|
#
|
30332
|
-
#
|
32426
|
+
# Removes the watchdog from the virtual machine.
|
32427
|
+
#
|
32428
|
+
# For example, to remove a watchdog from a virtual machine, send a request like this:
|
32429
|
+
#
|
32430
|
+
# [source]
|
32431
|
+
# ----
|
32432
|
+
# DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000
|
32433
|
+
# ----
|
30333
32434
|
#
|
30334
32435
|
# @param opts [Hash] Additional options.
|
30335
32436
|
#
|
@@ -30349,9 +32450,36 @@ module OvirtSDK4
|
|
30349
32450
|
end
|
30350
32451
|
|
30351
32452
|
#
|
30352
|
-
# Updates the
|
32453
|
+
# Updates the information about the watchdog.
|
30353
32454
|
#
|
30354
|
-
#
|
32455
|
+
# You can update the information using `action` and `model` elements.
|
32456
|
+
#
|
32457
|
+
# For example, to update a watchdog, send a request like this:
|
32458
|
+
#
|
32459
|
+
# [source]
|
32460
|
+
# ----
|
32461
|
+
# PUT /ovirt-engine/api/vms/123/watchdogs
|
32462
|
+
# <watchdog>
|
32463
|
+
# <action>reset</action>
|
32464
|
+
# </watchdog>
|
32465
|
+
# ----
|
32466
|
+
#
|
32467
|
+
# with response body:
|
32468
|
+
#
|
32469
|
+
# [source,xml]
|
32470
|
+
# ----
|
32471
|
+
# <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
|
32472
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
32473
|
+
# <action>reset</action>
|
32474
|
+
# <model>i6300esb</model>
|
32475
|
+
# </watchdog>
|
32476
|
+
# ----
|
32477
|
+
#
|
32478
|
+
# @param watchdog [Watchdog] The information about the watchdog.
|
32479
|
+
#
|
32480
|
+
# The request data must contain at least one of `model` and `action`
|
32481
|
+
# elements. The response data contains complete information about the
|
32482
|
+
# updated watchdog.
|
30355
32483
|
# @param opts [Hash] Additional options.
|
30356
32484
|
#
|
30357
32485
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -30433,9 +32561,35 @@ module OvirtSDK4
|
|
30433
32561
|
end
|
30434
32562
|
|
30435
32563
|
#
|
30436
|
-
# Adds
|
32564
|
+
# Adds new watchdog to the virtual machine.
|
30437
32565
|
#
|
30438
|
-
#
|
32566
|
+
# For example, to add a watchdog to a virtual machine, send a request like this:
|
32567
|
+
#
|
32568
|
+
# [source]
|
32569
|
+
# ----
|
32570
|
+
# POST /ovirt-engine/api/vms/123/watchdogs
|
32571
|
+
# <watchdog>
|
32572
|
+
# <action>poweroff</action>
|
32573
|
+
# <model>i6300esb</model>
|
32574
|
+
# </watchdog>
|
32575
|
+
# ----
|
32576
|
+
#
|
32577
|
+
# with response body:
|
32578
|
+
#
|
32579
|
+
# [source,xml]
|
32580
|
+
# ----
|
32581
|
+
# <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
|
32582
|
+
# <vm href="/ovirt-engine/api/vms/123" id="123"/>
|
32583
|
+
# <action>poweroff</action>
|
32584
|
+
# <model>i6300esb</model>
|
32585
|
+
# </watchdog>
|
32586
|
+
# ----
|
32587
|
+
#
|
32588
|
+
# @param watchdog [Watchdog] The information about the watchdog.
|
32589
|
+
#
|
32590
|
+
# The request data must contain `model` element (such as `i6300esb`) and `action` element
|
32591
|
+
# (one of `none`, `reset`, `poweroff`, `dump`, `pause`). The response data additionally
|
32592
|
+
# contains references to the added watchdog and to the virtual machine.
|
30439
32593
|
#
|
30440
32594
|
# @param opts [Hash] Additional options.
|
30441
32595
|
#
|
@@ -30469,7 +32623,7 @@ module OvirtSDK4
|
|
30469
32623
|
end
|
30470
32624
|
|
30471
32625
|
#
|
30472
|
-
#
|
32626
|
+
# The list of watchdogs of the virtual machine.
|
30473
32627
|
#
|
30474
32628
|
# @param opts [Hash] Additional options.
|
30475
32629
|
#
|
@@ -30500,7 +32654,7 @@ module OvirtSDK4
|
|
30500
32654
|
end
|
30501
32655
|
|
30502
32656
|
#
|
30503
|
-
#
|
32657
|
+
# Returns a reference to the service that manages a specific watchdog.
|
30504
32658
|
#
|
30505
32659
|
# @param id [String] The identifier of the `watchdog`.
|
30506
32660
|
#
|
@@ -30944,7 +33098,7 @@ module OvirtSDK4
|
|
30944
33098
|
end
|
30945
33099
|
|
30946
33100
|
#
|
30947
|
-
#
|
33101
|
+
# Retrieves details about a vNIC profile.
|
30948
33102
|
#
|
30949
33103
|
# @param opts [Hash] Additional options.
|
30950
33104
|
#
|
@@ -30968,7 +33122,7 @@ module OvirtSDK4
|
|
30968
33122
|
end
|
30969
33123
|
|
30970
33124
|
#
|
30971
|
-
#
|
33125
|
+
# Removes the vNIC profile.
|
30972
33126
|
#
|
30973
33127
|
# @param opts [Hash] Additional options.
|
30974
33128
|
#
|
@@ -30988,9 +33142,9 @@ module OvirtSDK4
|
|
30988
33142
|
end
|
30989
33143
|
|
30990
33144
|
#
|
30991
|
-
# Updates
|
33145
|
+
# Updates details of a vNIC profile.
|
30992
33146
|
#
|
30993
|
-
# @param profile [VnicProfile] The
|
33147
|
+
# @param profile [VnicProfile] The vNIC profile that is being updated.
|
30994
33148
|
# @param opts [Hash] Additional options.
|
30995
33149
|
#
|
30996
33150
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -31087,9 +33241,72 @@ module OvirtSDK4
|
|
31087
33241
|
end
|
31088
33242
|
|
31089
33243
|
#
|
31090
|
-
#
|
33244
|
+
# Add a vNIC profile.
|
31091
33245
|
#
|
31092
|
-
#
|
33246
|
+
# For example to add vNIC profile `123` to network `456` send a request to:
|
33247
|
+
#
|
33248
|
+
# [source]
|
33249
|
+
# ----
|
33250
|
+
# POST /ovirt-engine/api/networks/456/vnicprofiles
|
33251
|
+
# ----
|
33252
|
+
#
|
33253
|
+
# With the following body:
|
33254
|
+
#
|
33255
|
+
# [source,xml]
|
33256
|
+
# ----
|
33257
|
+
# <vnic_profile id="123">
|
33258
|
+
# <name>new_vNIC_name</name>
|
33259
|
+
# <pass_through>
|
33260
|
+
# <mode>disabled</mode>
|
33261
|
+
# </pass_through>
|
33262
|
+
# <port_mirroring>false</port_mirroring>
|
33263
|
+
# </vnic_profile>
|
33264
|
+
# ----
|
33265
|
+
#
|
33266
|
+
# Please note that there is a default network filter to each VNIC profile.
|
33267
|
+
# For more details of how the default network filter is calculated please refer to
|
33268
|
+
# the documentation in <<services/network_filters,NetworkFilters>>.
|
33269
|
+
#
|
33270
|
+
# The output of creating a new VNIC profile depends in the body arguments that were given.
|
33271
|
+
# In case no network filter was given, the default network filter will be configured. For example:
|
33272
|
+
#
|
33273
|
+
# [source,xml]
|
33274
|
+
# ----
|
33275
|
+
# <vnic_profile href="/ovirt-engine/api/vnicprofiles/123" id="123">
|
33276
|
+
# <name>new_vNIC_name</name>
|
33277
|
+
# <link href="/ovirt-engine/api/vnicprofiles/123/permissions" rel="permissions"/>
|
33278
|
+
# <pass_through>
|
33279
|
+
# <mode>disabled</mode>
|
33280
|
+
# </pass_through>
|
33281
|
+
# <port_mirroring>false</port_mirroring>
|
33282
|
+
# <network href="/ovirt-engine/api/networks/456" id="456"/>
|
33283
|
+
# <network_filter href="/ovirt-engine/api/networkfilters/789" id="789"/>
|
33284
|
+
# </vnic_profile>
|
33285
|
+
# ----
|
33286
|
+
#
|
33287
|
+
# In case an empty network filter was given, no network filter will be configured for the specific VNIC profile
|
33288
|
+
# regardless of the VNIC profile's default network filter. For example:
|
33289
|
+
#
|
33290
|
+
# [source,xml]
|
33291
|
+
# ----
|
33292
|
+
# <vnic_profile>
|
33293
|
+
# <name>no_network_filter</name>
|
33294
|
+
# <network_filter/>
|
33295
|
+
# </vnic_profile>
|
33296
|
+
# ----
|
33297
|
+
#
|
33298
|
+
# In case that a specific valid network filter id was given, the VNIC profile will be configured with the given
|
33299
|
+
# network filter regardless of the VNIC profiles's default network filter. For example:
|
33300
|
+
#
|
33301
|
+
# [source,xml]
|
33302
|
+
# ----
|
33303
|
+
# <vnic_profile>
|
33304
|
+
# <name>user_choice_network_filter</name>
|
33305
|
+
# <network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>
|
33306
|
+
# </vnic_profile>
|
33307
|
+
# ----
|
33308
|
+
#
|
33309
|
+
# @param profile [VnicProfile] The vNIC profile that is being added.
|
31093
33310
|
#
|
31094
33311
|
# @param opts [Hash] Additional options.
|
31095
33312
|
#
|
@@ -31123,7 +33340,7 @@ module OvirtSDK4
|
|
31123
33340
|
end
|
31124
33341
|
|
31125
33342
|
#
|
31126
|
-
#
|
33343
|
+
# List all vNIC profiles.
|
31127
33344
|
#
|
31128
33345
|
# @param opts [Hash] Additional options.
|
31129
33346
|
#
|
@@ -31678,7 +33895,36 @@ module OvirtSDK4
|
|
31678
33895
|
end
|
31679
33896
|
|
31680
33897
|
#
|
31681
|
-
#
|
33898
|
+
# Retrieves the representation of the Katello errata.
|
33899
|
+
#
|
33900
|
+
# [source]
|
33901
|
+
# ----
|
33902
|
+
# GET /ovirt-engine/api/katelloerrata
|
33903
|
+
# ----
|
33904
|
+
#
|
33905
|
+
# You will receive response in XML like this one:
|
33906
|
+
#
|
33907
|
+
# [source,xml]
|
33908
|
+
# ----
|
33909
|
+
# <katello_errata>
|
33910
|
+
# <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
|
33911
|
+
# <name>RHBA-2013:XYZ</name>
|
33912
|
+
# <description>The description of the erratum</description>
|
33913
|
+
# <title>some bug fix update</title>
|
33914
|
+
# <type>bugfix</type>
|
33915
|
+
# <issued>2013-11-20T02:00:00.000+02:00</issued>
|
33916
|
+
# <solution>Few guidelines regarding the solution</solution>
|
33917
|
+
# <summary>Updated packages that fix one bug are now available for XYZ</summary>
|
33918
|
+
# <packages>
|
33919
|
+
# <package>
|
33920
|
+
# <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
|
33921
|
+
# </package>
|
33922
|
+
# ...
|
33923
|
+
# </packages>
|
33924
|
+
# </katello_erratum>
|
33925
|
+
# ...
|
33926
|
+
# </katello_errata>
|
33927
|
+
# ----
|
31682
33928
|
#
|
31683
33929
|
# @param opts [Hash] Additional options.
|
31684
33930
|
#
|
@@ -31709,7 +33955,8 @@ module OvirtSDK4
|
|
31709
33955
|
end
|
31710
33956
|
|
31711
33957
|
#
|
31712
|
-
#
|
33958
|
+
# Reference to the Katello erratum service.
|
33959
|
+
# Use this service to view the erratum by its id.
|
31713
33960
|
#
|
31714
33961
|
# @param id [String] The identifier of the `katello_erratum`.
|
31715
33962
|
#
|
@@ -32022,7 +34269,54 @@ module OvirtSDK4
|
|
32022
34269
|
end
|
32023
34270
|
|
32024
34271
|
#
|
32025
|
-
#
|
34272
|
+
# Get details of a brick.
|
34273
|
+
#
|
34274
|
+
# Retrieves status details of brick from underlying gluster volume with header `All-Content` set to `true`. This is
|
34275
|
+
# the equivalent of running `gluster volume status <volumename> <brickname> detail`.
|
34276
|
+
#
|
34277
|
+
# For example, to get the details of brick `234` of gluster volume `123`, send a request like this:
|
34278
|
+
#
|
34279
|
+
# [source]
|
34280
|
+
# ----
|
34281
|
+
# GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
|
34282
|
+
# ----
|
34283
|
+
#
|
34284
|
+
# Which will return a response body like this:
|
34285
|
+
#
|
34286
|
+
# [source,xml]
|
34287
|
+
# ----
|
34288
|
+
# <brick id="234">
|
34289
|
+
# <name>host1:/rhgs/data/brick1</name>
|
34290
|
+
# <brick_dir>/rhgs/data/brick1</brick_dir>
|
34291
|
+
# <server_id>111</server_id>
|
34292
|
+
# <status>up</status>
|
34293
|
+
# <device>/dev/mapper/RHGS_vg1-lv_vmaddldisks</device>
|
34294
|
+
# <fs_name>xfs</fs_name>
|
34295
|
+
# <gluster_clients>
|
34296
|
+
# <gluster_client>
|
34297
|
+
# <bytes_read>2818417648</bytes_read>
|
34298
|
+
# <bytes_written>1384694844</bytes_written>
|
34299
|
+
# <client_port>1011</client_port>
|
34300
|
+
# <host_name>client2</host_name>
|
34301
|
+
# </gluster_client>
|
34302
|
+
# </gluster_clients>
|
34303
|
+
# <memory_pools>
|
34304
|
+
# <memory_pool>
|
34305
|
+
# <name>data-server:fd_t</name>
|
34306
|
+
# <alloc_count>1626348</alloc_count>
|
34307
|
+
# <cold_count>1020</cold_count>
|
34308
|
+
# <hot_count>4</hot_count>
|
34309
|
+
# <max_alloc>23</max_alloc>
|
34310
|
+
# <max_stdalloc>0</max_stdalloc>
|
34311
|
+
# <padded_size>140</padded_size>
|
34312
|
+
# <pool_misses>0</pool_misses>
|
34313
|
+
# </memory_pool>
|
34314
|
+
# </memory_pools>
|
34315
|
+
# <mnt_options>rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota</mnt_options>
|
34316
|
+
# <pid>25589</pid>
|
34317
|
+
# <port>49155</port>
|
34318
|
+
# </brick>
|
34319
|
+
# ----
|
32026
34320
|
#
|
32027
34321
|
# @param opts [Hash] Additional options.
|
32028
34322
|
#
|
@@ -32046,7 +34340,18 @@ module OvirtSDK4
|
|
32046
34340
|
end
|
32047
34341
|
|
32048
34342
|
#
|
32049
|
-
# Removes
|
34343
|
+
# Removes a brick.
|
34344
|
+
#
|
34345
|
+
# Removes a brick from the underlying gluster volume and deletes entries from database. This can be used only when
|
34346
|
+
# removing a single brick without data migration. To remove multiple bricks and with data migration, use
|
34347
|
+
# <<services/gluster_bricks/methods/migrate, migrate>> instead.
|
34348
|
+
#
|
34349
|
+
# For example, to delete brick `234` from gluster volume `123`, send a request like this:
|
34350
|
+
#
|
34351
|
+
# [source]
|
34352
|
+
# ----
|
34353
|
+
# DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
|
34354
|
+
# ----
|
32050
34355
|
#
|
32051
34356
|
# @param opts [Hash] Additional options.
|
32052
34357
|
#
|
@@ -32066,7 +34371,11 @@ module OvirtSDK4
|
|
32066
34371
|
end
|
32067
34372
|
|
32068
34373
|
#
|
32069
|
-
# Replaces this brick with a new one.
|
34374
|
+
# Replaces this brick with a new one.
|
34375
|
+
#
|
34376
|
+
# IMPORTANT: This operation has been deprecated since version 3.5 of the engine and will be removed in the future.
|
34377
|
+
# Use <<services/gluster_bricks/methods/add, add brick(s)>> and
|
34378
|
+
# <<services/gluster_bricks/methods/migrate, migrate brick(s)>> instead.
|
32070
34379
|
#
|
32071
34380
|
# @param opts [Hash] Additional options.
|
32072
34381
|
#
|
@@ -32151,7 +34460,47 @@ module OvirtSDK4
|
|
32151
34460
|
end
|
32152
34461
|
|
32153
34462
|
#
|
32154
|
-
#
|
34463
|
+
# Get the gluster volume details.
|
34464
|
+
#
|
34465
|
+
# For example, to get details of a gluster volume with identifier `123` in cluster `456`, send a request like this:
|
34466
|
+
#
|
34467
|
+
# [source]
|
34468
|
+
# ----
|
34469
|
+
# GET /ovirt-engine/api/clusters/456/glustervolumes/123
|
34470
|
+
# ----
|
34471
|
+
#
|
34472
|
+
# This GET request will return the following output:
|
34473
|
+
#
|
34474
|
+
# [source,xml]
|
34475
|
+
# ----
|
34476
|
+
# <gluster_volume id="123">
|
34477
|
+
# <name>data</name>
|
34478
|
+
# <link href="/ovirt-engine/api/clusters/456/glustervolumes/123/glusterbricks" rel="glusterbricks"/>
|
34479
|
+
# <disperse_count>0</disperse_count>
|
34480
|
+
# <options>
|
34481
|
+
# <option>
|
34482
|
+
# <name>storage.owner-gid</name>
|
34483
|
+
# <value>36</value>
|
34484
|
+
# </option>
|
34485
|
+
# <option>
|
34486
|
+
# <name>performance.io-cache</name>
|
34487
|
+
# <value>off</value>
|
34488
|
+
# </option>
|
34489
|
+
# <option>
|
34490
|
+
# <name>cluster.data-self-heal-algorithm</name>
|
34491
|
+
# <value>full</value>
|
34492
|
+
# </option>
|
34493
|
+
# </options>
|
34494
|
+
# <redundancy_count>0</redundancy_count>
|
34495
|
+
# <replica_count>3</replica_count>
|
34496
|
+
# <status>up</status>
|
34497
|
+
# <stripe_count>0</stripe_count>
|
34498
|
+
# <transport_types>
|
34499
|
+
# <transport_type>tcp</transport_type>
|
34500
|
+
# </transport_types>
|
34501
|
+
# <volume_type>replicate</volume_type>
|
34502
|
+
# </gluster_volume>
|
34503
|
+
# ----
|
32155
34504
|
#
|
32156
34505
|
# @param opts [Hash] Additional options.
|
32157
34506
|
#
|
@@ -32175,11 +34524,19 @@ module OvirtSDK4
|
|
32175
34524
|
end
|
32176
34525
|
|
32177
34526
|
#
|
32178
|
-
#
|
34527
|
+
# Get gluster volume profile statistics.
|
34528
|
+
#
|
34529
|
+
# For example, to get profile statistics for a gluster volume with identifier `123` in cluster `456`, send a
|
34530
|
+
# request like this:
|
34531
|
+
#
|
34532
|
+
# [source]
|
34533
|
+
# ----
|
34534
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics
|
34535
|
+
# ----
|
32179
34536
|
#
|
32180
34537
|
# @param opts [Hash] Additional options.
|
32181
34538
|
#
|
32182
|
-
# @option opts [GlusterVolumeProfileDetails] :details
|
34539
|
+
# @option opts [GlusterVolumeProfileDetails] :details Gluster volume profiling information returned from the action.
|
32183
34540
|
#
|
32184
34541
|
def get_profile_statistics(opts = {})
|
32185
34542
|
action = Action.new(opts)
|
@@ -32203,15 +34560,30 @@ module OvirtSDK4
|
|
32203
34560
|
end
|
32204
34561
|
|
32205
34562
|
#
|
32206
|
-
#
|
34563
|
+
# Rebalance the gluster volume.
|
34564
|
+
#
|
34565
|
+
# Rebalancing a gluster volume helps to distribute the data evenly across all the bricks. After expanding or
|
34566
|
+
# shrinking a gluster volume (without migrating data), we need to rebalance the data among the bricks. In a
|
34567
|
+
# non-replicated volume, all bricks should be online to perform the rebalance operation. In a replicated volume, at
|
34568
|
+
# least one of the bricks in the replica should be online.
|
34569
|
+
#
|
34570
|
+
# For example, to rebalance a gluster volume with identifier `123` in cluster `456`, send a request like this:
|
34571
|
+
#
|
34572
|
+
# [source]
|
34573
|
+
# ----
|
34574
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance
|
34575
|
+
# ----
|
32207
34576
|
#
|
32208
34577
|
# @param opts [Hash] Additional options.
|
32209
34578
|
#
|
32210
34579
|
# @option opts [Boolean] :async Indicates if the rebalance should be performed asynchronously.
|
32211
34580
|
#
|
32212
|
-
# @option opts [Boolean] :fix_layout
|
34581
|
+
# @option opts [Boolean] :fix_layout If set to true, rebalance will only fix the layout so that new data added to the volume is distributed
|
34582
|
+
# across all the hosts. But it will not migrate/rebalance the existing data. Default is `false`.
|
32213
34583
|
#
|
32214
|
-
# @option opts [Boolean] :force
|
34584
|
+
# @option opts [Boolean] :force Indicates if the rebalance should be force started. The rebalance command can be executed with the force
|
34585
|
+
# option even when the older clients are connected to the cluster. However, this could lead to a data loss
|
34586
|
+
# situation. Default is `false`.
|
32215
34587
|
#
|
32216
34588
|
def rebalance(opts = {})
|
32217
34589
|
action = Action.new(opts)
|
@@ -32234,7 +34606,14 @@ module OvirtSDK4
|
|
32234
34606
|
end
|
32235
34607
|
|
32236
34608
|
#
|
32237
|
-
#
|
34609
|
+
# Removes the gluster volume.
|
34610
|
+
#
|
34611
|
+
# For example, to remove a volume with identifier `123` in cluster `456`, send a request like this:
|
34612
|
+
#
|
34613
|
+
# [source]
|
34614
|
+
# ----
|
34615
|
+
# DELETE /ovirt-engine/api/clusters/456/glustervolumes/123
|
34616
|
+
# ----
|
32238
34617
|
#
|
32239
34618
|
# @param opts [Hash] Additional options.
|
32240
34619
|
#
|
@@ -32254,7 +34633,15 @@ module OvirtSDK4
|
|
32254
34633
|
end
|
32255
34634
|
|
32256
34635
|
#
|
32257
|
-
#
|
34636
|
+
# Resets all the options set in the gluster volume.
|
34637
|
+
#
|
34638
|
+
# For example, to reset all options in a gluster volume with identifier `123` in cluster `456`, send a request like
|
34639
|
+
# this:
|
34640
|
+
#
|
34641
|
+
# [source]
|
34642
|
+
# ----
|
34643
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions
|
34644
|
+
# ----
|
32258
34645
|
#
|
32259
34646
|
# @param opts [Hash] Additional options.
|
32260
34647
|
#
|
@@ -32281,7 +34668,24 @@ module OvirtSDK4
|
|
32281
34668
|
end
|
32282
34669
|
|
32283
34670
|
#
|
32284
|
-
#
|
34671
|
+
# Resets a particular option in the gluster volume.
|
34672
|
+
#
|
34673
|
+
# For example, to reset a particular option `option1` in a gluster volume with identifier `123` in cluster `456`,
|
34674
|
+
# send a request like this:
|
34675
|
+
#
|
34676
|
+
# [source]
|
34677
|
+
# ----
|
34678
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption
|
34679
|
+
# ----
|
34680
|
+
#
|
34681
|
+
# With the following request body:
|
34682
|
+
#
|
34683
|
+
# [source,xml]
|
34684
|
+
# ----
|
34685
|
+
# <action>
|
34686
|
+
# <option name="option1"/>
|
34687
|
+
# </action>
|
34688
|
+
# ----
|
32285
34689
|
#
|
32286
34690
|
# @param opts [Hash] Additional options.
|
32287
34691
|
#
|
@@ -32289,7 +34693,7 @@ module OvirtSDK4
|
|
32289
34693
|
#
|
32290
34694
|
# @option opts [Boolean] :force
|
32291
34695
|
#
|
32292
|
-
# @option opts [Option] :option
|
34696
|
+
# @option opts [Option] :option Option to reset.
|
32293
34697
|
#
|
32294
34698
|
def reset_option(opts = {})
|
32295
34699
|
action = Action.new(opts)
|
@@ -32312,13 +34716,30 @@ module OvirtSDK4
|
|
32312
34716
|
end
|
32313
34717
|
|
32314
34718
|
#
|
32315
|
-
#
|
34719
|
+
# Sets a particular option in the gluster volume.
|
34720
|
+
#
|
34721
|
+
# For example, to set `option1` with value `value1` in a gluster volume with identifier `123` in cluster `456`,
|
34722
|
+
# send a request like this:
|
34723
|
+
#
|
34724
|
+
# [source]
|
34725
|
+
# ----
|
34726
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption
|
34727
|
+
# ----
|
34728
|
+
#
|
34729
|
+
# With the following request body:
|
34730
|
+
#
|
34731
|
+
# [source,xml]
|
34732
|
+
# ----
|
34733
|
+
# <action>
|
34734
|
+
# <option name="option1" value="value1"/>
|
34735
|
+
# </action>
|
34736
|
+
# ----
|
32316
34737
|
#
|
32317
34738
|
# @param opts [Hash] Additional options.
|
32318
34739
|
#
|
32319
34740
|
# @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
|
32320
34741
|
#
|
32321
|
-
# @option opts [Option] :option
|
34742
|
+
# @option opts [Option] :option Option to set.
|
32322
34743
|
#
|
32323
34744
|
def set_option(opts = {})
|
32324
34745
|
action = Action.new(opts)
|
@@ -32341,13 +34762,22 @@ module OvirtSDK4
|
|
32341
34762
|
end
|
32342
34763
|
|
32343
34764
|
#
|
32344
|
-
#
|
34765
|
+
# Starts the gluster volume.
|
34766
|
+
#
|
34767
|
+
# A Gluster Volume should be started to read/write data. For example, to start a gluster volume with identifier
|
34768
|
+
# `123` in cluster `456`, send a request like this:
|
34769
|
+
#
|
34770
|
+
# [source]
|
34771
|
+
# ----
|
34772
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/start
|
34773
|
+
# ----
|
32345
34774
|
#
|
32346
34775
|
# @param opts [Hash] Additional options.
|
32347
34776
|
#
|
32348
34777
|
# @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
|
32349
34778
|
#
|
32350
|
-
# @option opts [Boolean] :force
|
34779
|
+
# @option opts [Boolean] :force Indicates if the volume should be force started. If a gluster volume is started already but few/all bricks
|
34780
|
+
# are down then force start can be used to bring all the bricks up. Default is `false`.
|
32351
34781
|
#
|
32352
34782
|
def start(opts = {})
|
32353
34783
|
action = Action.new(opts)
|
@@ -32370,7 +34800,14 @@ module OvirtSDK4
|
|
32370
34800
|
end
|
32371
34801
|
|
32372
34802
|
#
|
32373
|
-
#
|
34803
|
+
# Start profiling the gluster volume.
|
34804
|
+
#
|
34805
|
+
# For example, to start profiling a gluster volume with identifier `123` in cluster `456`, send a request like this:
|
34806
|
+
#
|
34807
|
+
# [source]
|
34808
|
+
# ----
|
34809
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile
|
34810
|
+
# ----
|
32374
34811
|
#
|
32375
34812
|
# @param opts [Hash] Additional options.
|
32376
34813
|
#
|
@@ -32397,7 +34834,16 @@ module OvirtSDK4
|
|
32397
34834
|
end
|
32398
34835
|
|
32399
34836
|
#
|
32400
|
-
#
|
34837
|
+
# Stops the gluster volume.
|
34838
|
+
#
|
34839
|
+
# Stopping a volume will make its data inaccessible.
|
34840
|
+
#
|
34841
|
+
# For example, to stop a gluster volume with identifier `123` in cluster `456`, send a request like this:
|
34842
|
+
#
|
34843
|
+
# [source]
|
34844
|
+
# ----
|
34845
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop
|
34846
|
+
# ----
|
32401
34847
|
#
|
32402
34848
|
# @param opts [Hash] Additional options.
|
32403
34849
|
#
|
@@ -32426,7 +34872,14 @@ module OvirtSDK4
|
|
32426
34872
|
end
|
32427
34873
|
|
32428
34874
|
#
|
32429
|
-
#
|
34875
|
+
# Stop profiling the gluster volume.
|
34876
|
+
#
|
34877
|
+
# For example, to stop profiling a gluster volume with identifier `123` in cluster `456`, send a request like this:
|
34878
|
+
#
|
34879
|
+
# [source]
|
34880
|
+
# ----
|
34881
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile
|
34882
|
+
# ----
|
32430
34883
|
#
|
32431
34884
|
# @param opts [Hash] Additional options.
|
32432
34885
|
#
|
@@ -32453,7 +34906,15 @@ module OvirtSDK4
|
|
32453
34906
|
end
|
32454
34907
|
|
32455
34908
|
#
|
32456
|
-
#
|
34909
|
+
# Stop rebalancing the gluster volume.
|
34910
|
+
#
|
34911
|
+
# For example, to stop rebalancing a gluster volume with identifier `123` in cluster `456`, send a request like
|
34912
|
+
# this:
|
34913
|
+
#
|
34914
|
+
# [source]
|
34915
|
+
# ----
|
34916
|
+
# POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance
|
34917
|
+
# ----
|
32457
34918
|
#
|
32458
34919
|
# @param opts [Hash] Additional options.
|
32459
34920
|
#
|
@@ -32480,7 +34941,7 @@ module OvirtSDK4
|
|
32480
34941
|
end
|
32481
34942
|
|
32482
34943
|
#
|
32483
|
-
#
|
34944
|
+
# Reference to a service managing gluster bricks.
|
32484
34945
|
#
|
32485
34946
|
# @return [GlusterBricksService] A reference to `gluster_bricks` service.
|
32486
34947
|
#
|
@@ -32932,15 +35393,15 @@ module OvirtSDK4
|
|
32932
35393
|
end
|
32933
35394
|
|
32934
35395
|
#
|
32935
|
-
#
|
35396
|
+
# Discover iSCSI targets on the host, using the initiator details.
|
32936
35397
|
#
|
32937
35398
|
# @param opts [Hash] Additional options.
|
32938
35399
|
#
|
32939
35400
|
# @option opts [Boolean] :async Indicates if the discovery should be performed asynchronously.
|
32940
35401
|
#
|
32941
|
-
# @option opts [IscsiDetails] :iscsi
|
35402
|
+
# @option opts [IscsiDetails] :iscsi The target iSCSI device.
|
32942
35403
|
#
|
32943
|
-
# @option opts [Array<String>] :iscsi_targets
|
35404
|
+
# @option opts [Array<String>] :iscsi_targets The iSCSI targets.
|
32944
35405
|
#
|
32945
35406
|
def iscsi_discover(opts = {})
|
32946
35407
|
action = Action.new(opts)
|
@@ -32964,13 +35425,13 @@ module OvirtSDK4
|
|
32964
35425
|
end
|
32965
35426
|
|
32966
35427
|
#
|
32967
|
-
#
|
35428
|
+
# Login to iSCSI targets on the host, using the target details.
|
32968
35429
|
#
|
32969
35430
|
# @param opts [Hash] Additional options.
|
32970
35431
|
#
|
32971
35432
|
# @option opts [Boolean] :async Indicates if the login should be performed asynchronously.
|
32972
35433
|
#
|
32973
|
-
# @option opts [IscsiDetails] :iscsi
|
35434
|
+
# @option opts [IscsiDetails] :iscsi The target iSCSI device.
|
32974
35435
|
#
|
32975
35436
|
def iscsi_login(opts = {})
|
32976
35437
|
action = Action.new(opts)
|
@@ -32993,7 +35454,7 @@ module OvirtSDK4
|
|
32993
35454
|
end
|
32994
35455
|
|
32995
35456
|
#
|
32996
|
-
#
|
35457
|
+
# Refresh the host devices and capabilities.
|
32997
35458
|
#
|
32998
35459
|
# @param opts [Hash] Additional options.
|
32999
35460
|
#
|
@@ -33365,7 +35826,8 @@ module OvirtSDK4
|
|
33365
35826
|
end
|
33366
35827
|
|
33367
35828
|
#
|
33368
|
-
#
|
35829
|
+
# Reference to the host devices service.
|
35830
|
+
# Use this service to view the devices of the host object.
|
33369
35831
|
#
|
33370
35832
|
# @return [HostDevicesService] A reference to `devices` service.
|
33371
35833
|
#
|
@@ -33374,7 +35836,8 @@ module OvirtSDK4
|
|
33374
35836
|
end
|
33375
35837
|
|
33376
35838
|
#
|
33377
|
-
#
|
35839
|
+
# Reference to the fence agents service.
|
35840
|
+
# Use this service to manage fence and power management agents on the host object.
|
33378
35841
|
#
|
33379
35842
|
# @return [FenceAgentsService] A reference to `fence_agents` service.
|
33380
35843
|
#
|
@@ -33383,7 +35846,8 @@ module OvirtSDK4
|
|
33383
35846
|
end
|
33384
35847
|
|
33385
35848
|
#
|
33386
|
-
#
|
35849
|
+
# Reference to the host hooks service.
|
35850
|
+
# Use this service to view the hooks available in the host object.
|
33387
35851
|
#
|
33388
35852
|
# @return [HostHooksService] A reference to `hooks` service.
|
33389
35853
|
#
|
@@ -33392,7 +35856,8 @@ module OvirtSDK4
|
|
33392
35856
|
end
|
33393
35857
|
|
33394
35858
|
#
|
33395
|
-
#
|
35859
|
+
# Reference to the service that can show the applicable errata available on the host.
|
35860
|
+
# This information is taken from Katello.
|
33396
35861
|
#
|
33397
35862
|
# @return [KatelloErrataService] A reference to `katello_errata` service.
|
33398
35863
|
#
|
@@ -33401,7 +35866,8 @@ module OvirtSDK4
|
|
33401
35866
|
end
|
33402
35867
|
|
33403
35868
|
#
|
33404
|
-
#
|
35869
|
+
# Reference to the network attachments service. You can use this service to attach
|
35870
|
+
# Logical networks to host interfaces.
|
33405
35871
|
#
|
33406
35872
|
# @return [NetworkAttachmentsService] A reference to `network_attachments` service.
|
33407
35873
|
#
|
@@ -33419,7 +35885,7 @@ module OvirtSDK4
|
|
33419
35885
|
end
|
33420
35886
|
|
33421
35887
|
#
|
33422
|
-
#
|
35888
|
+
# Reference to the service that manage NUMA nodes for the host.
|
33423
35889
|
#
|
33424
35890
|
# @return [HostNumaNodesService] A reference to `numa_nodes` service.
|
33425
35891
|
#
|
@@ -33428,7 +35894,8 @@ module OvirtSDK4
|
|
33428
35894
|
end
|
33429
35895
|
|
33430
35896
|
#
|
33431
|
-
#
|
35897
|
+
# Reference to the host permission service.
|
35898
|
+
# Use this service to manage permissions on the host object.
|
33432
35899
|
#
|
33433
35900
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
33434
35901
|
#
|
@@ -33446,7 +35913,7 @@ module OvirtSDK4
|
|
33446
35913
|
end
|
33447
35914
|
|
33448
35915
|
#
|
33449
|
-
#
|
35916
|
+
# Reference to the service that manage hosts storage.
|
33450
35917
|
#
|
33451
35918
|
# @return [HostStorageService] A reference to `storage` service.
|
33452
35919
|
#
|
@@ -33455,7 +35922,7 @@ module OvirtSDK4
|
|
33455
35922
|
end
|
33456
35923
|
|
33457
35924
|
#
|
33458
|
-
#
|
35925
|
+
# Reference to storage connection extensions.
|
33459
35926
|
#
|
33460
35927
|
# @return [StorageServerConnectionExtensionsService] A reference to `storage_connection_extensions` service.
|
33461
35928
|
#
|
@@ -33464,7 +35931,8 @@ module OvirtSDK4
|
|
33464
35931
|
end
|
33465
35932
|
|
33466
35933
|
#
|
33467
|
-
#
|
35934
|
+
# Reference to the host tags service.
|
35935
|
+
# Use this service to manage tags on the host object.
|
33468
35936
|
#
|
33469
35937
|
# @return [AssignedTagsService] A reference to `tags` service.
|
33470
35938
|
#
|
@@ -33473,7 +35941,7 @@ module OvirtSDK4
|
|
33473
35941
|
end
|
33474
35942
|
|
33475
35943
|
#
|
33476
|
-
#
|
35944
|
+
# Reference to unmanaged networks.
|
33477
35945
|
#
|
33478
35946
|
# @return [UnmanagedNetworksService] A reference to `unmanaged_networks` service.
|
33479
35947
|
#
|
@@ -33666,7 +36134,7 @@ module OvirtSDK4
|
|
33666
36134
|
end
|
33667
36135
|
|
33668
36136
|
#
|
33669
|
-
#
|
36137
|
+
# Reference to the service that manages the network attachments assigned to this network interface.
|
33670
36138
|
#
|
33671
36139
|
# @return [NetworkAttachmentsService] A reference to `network_attachments` service.
|
33672
36140
|
#
|
@@ -33675,7 +36143,7 @@ module OvirtSDK4
|
|
33675
36143
|
end
|
33676
36144
|
|
33677
36145
|
#
|
33678
|
-
#
|
36146
|
+
# Reference to the service that manages the network labels assigned to this network interface.
|
33679
36147
|
#
|
33680
36148
|
# @return [NetworkLabelsService] A reference to `network_labels` service.
|
33681
36149
|
#
|