ovirt-engine-sdk 4.1.7 → 4.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGES.adoc +34 -0
- data/README.adoc +656 -27
- data/ext/ovirtsdk4c/ov_http_client.c +9 -1
- data/lib/ovirtsdk4/probe.rb +55 -2
- data/lib/ovirtsdk4/readers.rb +4 -0
- data/lib/ovirtsdk4/service.rb +1 -1
- data/lib/ovirtsdk4/services.rb +843 -114
- data/lib/ovirtsdk4/types.rb +23 -0
- data/lib/ovirtsdk4/version.rb +1 -1
- data/lib/ovirtsdk4/writers.rb +1 -0
- metadata +3 -3
@@ -311,9 +311,17 @@ static void* ov_http_client_header_task(void* data) {
|
|
311
311
|
/* We should always tell the library that we processed all the data: */
|
312
312
|
context_ptr->result = context_ptr->size * context_ptr->nitems;
|
313
313
|
|
314
|
-
/*
|
314
|
+
/* The library provides the headers for all the responses it receives, including the responses for intermediate
|
315
|
+
requests used for authentication negotation. We are interested only in the headers of the last response, so
|
316
|
+
if the given data is the begin of a new response, we clear the headers hash. */
|
315
317
|
length = context_ptr->result;
|
316
318
|
buffer = context_ptr->buffer;
|
319
|
+
if (length >= 5 && strncmp("HTTP/", buffer, 5) == 0) {
|
320
|
+
rb_hash_clear(response_ptr->headers);
|
321
|
+
return NULL;
|
322
|
+
}
|
323
|
+
|
324
|
+
/* Remove trailing white space: */
|
317
325
|
while (length > 0 && isspace(buffer[length - 1])) {
|
318
326
|
length--;
|
319
327
|
}
|
data/lib/ovirtsdk4/probe.rb
CHANGED
@@ -67,6 +67,45 @@ module OvirtSDK4
|
|
67
67
|
end
|
68
68
|
end
|
69
69
|
|
70
|
+
ENGINE_CERTIFICATE_PATH =
|
71
|
+
'/ovirt-engine/services/pki-resource?resource=engine-certificate&format=OPENSSH-PUBKEY'.freeze
|
72
|
+
|
73
|
+
#
|
74
|
+
# This class method receives a set of options that define the server to probe and returns a boolean value
|
75
|
+
# that represents whether an oVirt instance was detected.
|
76
|
+
#
|
77
|
+
# @param opts [Hash] The options used to create the probe.
|
78
|
+
#
|
79
|
+
# @option opts [String] :host The name or IP address of the host to probe.
|
80
|
+
#
|
81
|
+
# @option opts [Integer] :port (443) The port number to probe.
|
82
|
+
#
|
83
|
+
# @option opts [String] :log The logger where the log messages will be written.
|
84
|
+
#
|
85
|
+
# @option opts [Boolean] :debug (false) A boolean flag indicating if debug output should be generated. If the
|
86
|
+
# values is `true` and the `log` parameter isn't `nil` then the data sent to and received from the server will
|
87
|
+
# be written to the log. Be aware that user names and passwords will also be written, so handle with care.
|
88
|
+
#
|
89
|
+
# @option opts [String] :proxy_url A string containing the protocol, address and port number of the proxy server
|
90
|
+
# to use to connect to the server. For example, in order to use the HTTP proxy `proxy.example.com` that is
|
91
|
+
# listening on port `3128` the value should be `http://proxy.example.com:3128`. This is optional, and if not
|
92
|
+
# given the connection will go directly to the server specified in the `url` parameter.
|
93
|
+
#
|
94
|
+
# @option opts [Integer] :timeout (0) Set a connection timeout, in seconds. If the value is 0 no timeout is set.
|
95
|
+
#
|
96
|
+
# @return [Boolean] Boolean value, `true` if an oVirt instance was detected.
|
97
|
+
#
|
98
|
+
def self.exists?(opts)
|
99
|
+
probe = nil
|
100
|
+
begin
|
101
|
+
opts[:insecure] = true
|
102
|
+
probe = Probe.new(opts)
|
103
|
+
probe.exists?
|
104
|
+
ensure
|
105
|
+
probe.close if probe
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
70
109
|
#
|
71
110
|
# Creates a new probe.
|
72
111
|
#
|
@@ -117,6 +156,7 @@ module OvirtSDK4
|
|
117
156
|
@proxy_url = opts[:proxy_url]
|
118
157
|
@proxy_username = opts[:proxy_username]
|
119
158
|
@proxy_password = opts[:proxy_password]
|
159
|
+
@timeout = opts[:timeout]
|
120
160
|
|
121
161
|
# Create the HTTP client:
|
122
162
|
@client = HttpClient.new(
|
@@ -128,7 +168,8 @@ module OvirtSDK4
|
|
128
168
|
debug: @debug,
|
129
169
|
proxy_url: @proxy_url,
|
130
170
|
proxy_username: @proxy_username,
|
131
|
-
proxy_password: @proxy_password
|
171
|
+
proxy_password: @proxy_password,
|
172
|
+
timeout: @timeout
|
132
173
|
)
|
133
174
|
end
|
134
175
|
|
@@ -145,6 +186,18 @@ module OvirtSDK4
|
|
145
186
|
detect_version(path).map { |version| ProbeResult.new(version: version) }
|
146
187
|
end
|
147
188
|
|
189
|
+
#
|
190
|
+
# Probes the server to detect if it has an ovirt instance running on it
|
191
|
+
#
|
192
|
+
# @return [Boolean] `true` if oVirt instance was detected, false otherwise
|
193
|
+
#
|
194
|
+
# @api private
|
195
|
+
#
|
196
|
+
def exists?
|
197
|
+
response = send(path: ENGINE_CERTIFICATE_PATH)
|
198
|
+
response.code == 200
|
199
|
+
end
|
200
|
+
|
148
201
|
#
|
149
202
|
# Releases the resources used by this probe.
|
150
203
|
#
|
@@ -184,8 +237,8 @@ module OvirtSDK4
|
|
184
237
|
|
185
238
|
# Set authentication:
|
186
239
|
request.username = @username
|
187
|
-
request.password = @password
|
188
240
|
|
241
|
+
request.password = @password
|
189
242
|
# Send the request and wait for the response:
|
190
243
|
@client.send(request)
|
191
244
|
response = @client.wait(request)
|
data/lib/ovirtsdk4/readers.rb
CHANGED
@@ -4171,6 +4171,8 @@ module OvirtSDK4
|
|
4171
4171
|
object.flood_rate = value if not value.nil?
|
4172
4172
|
value = reader.get_attribute('id')
|
4173
4173
|
object.id = value if not value.nil?
|
4174
|
+
value = reader.get_attribute('index')
|
4175
|
+
object.index = value if not value.nil?
|
4174
4176
|
value = reader.get_attribute('name')
|
4175
4177
|
object.name = value if not value.nil?
|
4176
4178
|
value = reader.get_attribute('origin')
|
@@ -4204,6 +4206,8 @@ module OvirtSDK4
|
|
4204
4206
|
object.flood_rate = Reader.read_integer(reader)
|
4205
4207
|
when 'id'
|
4206
4208
|
object.id = Reader.read_string(reader)
|
4209
|
+
when 'index'
|
4210
|
+
object.index = Reader.read_integer(reader)
|
4207
4211
|
when 'name'
|
4208
4212
|
object.name = Reader.read_string(reader)
|
4209
4213
|
when 'origin'
|
data/lib/ovirtsdk4/service.rb
CHANGED
@@ -288,7 +288,7 @@ module OvirtSDK4
|
|
288
288
|
result = Future.new(@connection, request) do |response|
|
289
289
|
raise response if response.is_a?(Exception)
|
290
290
|
case response.code
|
291
|
-
when 200
|
291
|
+
when 200, 201, 202
|
292
292
|
action = check_action(response)
|
293
293
|
action.send(member) if member
|
294
294
|
else
|
data/lib/ovirtsdk4/services.rb
CHANGED
@@ -959,20 +959,20 @@ module OvirtSDK4
|
|
959
959
|
private_constant :ADD
|
960
960
|
|
961
961
|
#
|
962
|
-
#
|
962
|
+
# Adds a virtual machine to the affinity group.
|
963
963
|
#
|
964
|
-
# For example, to add the virtual machine
|
964
|
+
# For example, to add the virtual machine `789` to the affinity group `456` of cluster `123`, send a request like
|
965
|
+
# this:
|
965
966
|
#
|
966
|
-
#
|
967
|
-
#
|
968
|
-
#
|
969
|
-
# ----
|
967
|
+
# ....
|
968
|
+
# POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms
|
969
|
+
# ....
|
970
970
|
#
|
971
971
|
# With the following body:
|
972
972
|
#
|
973
973
|
# [source,xml]
|
974
974
|
# ----
|
975
|
-
# <vm id="
|
975
|
+
# <vm id="789"/>
|
976
976
|
# ----
|
977
977
|
#
|
978
978
|
# @param vm [Vm] The `vm` to add.
|
@@ -1003,6 +1003,8 @@ module OvirtSDK4
|
|
1003
1003
|
#
|
1004
1004
|
# List all virtual machines assigned to this affinity group.
|
1005
1005
|
#
|
1006
|
+
# The order of the returned virtual machines isn't guaranteed.
|
1007
|
+
#
|
1006
1008
|
# @param opts [Hash] Additional options.
|
1007
1009
|
#
|
1008
1010
|
# @option opts [Integer] :max Sets the maximum number of virtual machines to return. If not specified, all the virtual machines are
|
@@ -1119,6 +1121,8 @@ module OvirtSDK4
|
|
1119
1121
|
#
|
1120
1122
|
# List existing affinity groups.
|
1121
1123
|
#
|
1124
|
+
# The order of the affinity groups results isn't guaranteed.
|
1125
|
+
#
|
1122
1126
|
# @param opts [Hash] Additional options.
|
1123
1127
|
#
|
1124
1128
|
# @option opts [Integer] :max Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned.
|
@@ -1423,6 +1427,8 @@ module OvirtSDK4
|
|
1423
1427
|
#
|
1424
1428
|
# List all hosts with the label.
|
1425
1429
|
#
|
1430
|
+
# The order of the returned hosts isn't guaranteed.
|
1431
|
+
#
|
1426
1432
|
# @param opts [Hash] Additional options.
|
1427
1433
|
#
|
1428
1434
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -1591,7 +1597,9 @@ module OvirtSDK4
|
|
1591
1597
|
private_constant :LIST
|
1592
1598
|
|
1593
1599
|
#
|
1594
|
-
# List all
|
1600
|
+
# List all virtual machines with the label.
|
1601
|
+
#
|
1602
|
+
# The order of the returned virtual machines isn't guaranteed.
|
1595
1603
|
#
|
1596
1604
|
# @param opts [Hash] Additional options.
|
1597
1605
|
#
|
@@ -1690,6 +1698,8 @@ module OvirtSDK4
|
|
1690
1698
|
#
|
1691
1699
|
# Lists all labels present in the system.
|
1692
1700
|
#
|
1701
|
+
# The order of the returned labels isn't guaranteed.
|
1702
|
+
#
|
1693
1703
|
# @param opts [Hash] Additional options.
|
1694
1704
|
#
|
1695
1705
|
# @option opts [Integer] :max Sets the maximum number of labels to return. If not specified all the labels are returned.
|
@@ -1861,6 +1871,8 @@ module OvirtSDK4
|
|
1861
1871
|
#
|
1862
1872
|
# Lists all labels that are attached to an entity.
|
1863
1873
|
#
|
1874
|
+
# The order of the returned entities isn't guaranteed.
|
1875
|
+
#
|
1864
1876
|
# @param opts [Hash] Additional options.
|
1865
1877
|
#
|
1866
1878
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -2032,7 +2044,9 @@ module OvirtSDK4
|
|
2032
2044
|
private_constant :LIST
|
2033
2045
|
|
2034
2046
|
#
|
2035
|
-
#
|
2047
|
+
# List the CPU profiles assigned to the cluster.
|
2048
|
+
#
|
2049
|
+
# The order of the returned CPU profiles isn't guaranteed.
|
2036
2050
|
#
|
2037
2051
|
# @param opts [Hash] Additional options.
|
2038
2052
|
#
|
@@ -2206,7 +2220,9 @@ module OvirtSDK4
|
|
2206
2220
|
private_constant :LIST
|
2207
2221
|
|
2208
2222
|
#
|
2209
|
-
# Returns the
|
2223
|
+
# Returns the list of disk profiles assigned to the storage domain.
|
2224
|
+
#
|
2225
|
+
# The order of the returned disk profiles isn't guaranteed.
|
2210
2226
|
#
|
2211
2227
|
# @param opts [Hash] Additional options.
|
2212
2228
|
#
|
@@ -2383,6 +2399,8 @@ module OvirtSDK4
|
|
2383
2399
|
# </permissions>
|
2384
2400
|
# ----
|
2385
2401
|
#
|
2402
|
+
# The order of the returned permissions isn't guaranteed.
|
2403
|
+
#
|
2386
2404
|
# @param opts [Hash] Additional options.
|
2387
2405
|
#
|
2388
2406
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -2450,7 +2468,9 @@ module OvirtSDK4
|
|
2450
2468
|
private_constant :LIST
|
2451
2469
|
|
2452
2470
|
#
|
2453
|
-
# Returns the
|
2471
|
+
# Returns the roles assigned to the permission.
|
2472
|
+
#
|
2473
|
+
# The order of the returned roles isn't guaranteed.
|
2454
2474
|
#
|
2455
2475
|
# @param opts [Hash] Additional options.
|
2456
2476
|
#
|
@@ -2680,6 +2700,8 @@ module OvirtSDK4
|
|
2680
2700
|
# </tags>
|
2681
2701
|
# ----
|
2682
2702
|
#
|
2703
|
+
# The order of the returned tags isn't guaranteed.
|
2704
|
+
#
|
2683
2705
|
# @param opts [Hash] Additional options.
|
2684
2706
|
#
|
2685
2707
|
# @option opts [Integer] :max Sets the maximum number of tags to return. If not specified all the tags are returned.
|
@@ -2867,7 +2889,9 @@ module OvirtSDK4
|
|
2867
2889
|
private_constant :LIST
|
2868
2890
|
|
2869
2891
|
#
|
2870
|
-
# Returns the
|
2892
|
+
# Returns the list of VNIC profiles assifned to the network.
|
2893
|
+
#
|
2894
|
+
# The order of the returned VNIC profiles isn't guaranteed.
|
2871
2895
|
#
|
2872
2896
|
# @param opts [Hash] Additional options.
|
2873
2897
|
#
|
@@ -3096,7 +3120,7 @@ module OvirtSDK4
|
|
3096
3120
|
private_constant :ADD
|
3097
3121
|
|
3098
3122
|
#
|
3099
|
-
#
|
3123
|
+
# Attaches an existing storage domain to the data center.
|
3100
3124
|
#
|
3101
3125
|
# @param storage_domain [StorageDomain] The `storage_domain` to add.
|
3102
3126
|
#
|
@@ -3124,7 +3148,9 @@ module OvirtSDK4
|
|
3124
3148
|
private_constant :LIST
|
3125
3149
|
|
3126
3150
|
#
|
3127
|
-
# Returns the
|
3151
|
+
# Returns the list of storage domains attached to the data center.
|
3152
|
+
#
|
3153
|
+
# The order of the returned storage domains isn't guaranteed.
|
3128
3154
|
#
|
3129
3155
|
# @param opts [Hash] Additional options.
|
3130
3156
|
#
|
@@ -3302,7 +3328,9 @@ module OvirtSDK4
|
|
3302
3328
|
private_constant :LIST
|
3303
3329
|
|
3304
3330
|
#
|
3305
|
-
# Returns the
|
3331
|
+
# Returns the list of balance modules used by the scheduling policy.
|
3332
|
+
#
|
3333
|
+
# The order of the returned balance modules isn't guaranteed.
|
3306
3334
|
#
|
3307
3335
|
# @param opts [Hash] Additional options.
|
3308
3336
|
#
|
@@ -3584,6 +3612,8 @@ module OvirtSDK4
|
|
3584
3612
|
# </bookmarks>
|
3585
3613
|
# ----
|
3586
3614
|
#
|
3615
|
+
# The order of the returned bookmarks isn't guaranteed.
|
3616
|
+
#
|
3587
3617
|
# @param opts [Hash] Additional options.
|
3588
3618
|
#
|
3589
3619
|
# @option opts [Integer] :max Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.
|
@@ -4090,6 +4120,8 @@ module OvirtSDK4
|
|
4090
4120
|
# </cluster_levels>
|
4091
4121
|
# ----
|
4092
4122
|
#
|
4123
|
+
# The order of the returned cluster levels isn't guaranteed.
|
4124
|
+
#
|
4093
4125
|
# @param opts [Hash] Additional options.
|
4094
4126
|
#
|
4095
4127
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -4300,6 +4332,8 @@ module OvirtSDK4
|
|
4300
4332
|
#
|
4301
4333
|
# Lists the networks that are assigned to the cluster.
|
4302
4334
|
#
|
4335
|
+
# The order of the returned clusters isn't guaranteed.
|
4336
|
+
#
|
4303
4337
|
# @param opts [Hash] Additional options.
|
4304
4338
|
#
|
4305
4339
|
# @option opts [Integer] :max Sets the maximum number of networks to return. If not specified, all the networks are returned.
|
@@ -4419,7 +4453,10 @@ module OvirtSDK4
|
|
4419
4453
|
private_constant :LIST
|
4420
4454
|
|
4421
4455
|
#
|
4422
|
-
# Returns the
|
4456
|
+
# Returns the list of clusters of the system.
|
4457
|
+
#
|
4458
|
+
# The order of the returned clusters is guaranteed only if the `sortby` clause is included in the
|
4459
|
+
# `search` parameter.
|
4423
4460
|
#
|
4424
4461
|
# @param opts [Hash] Additional options.
|
4425
4462
|
#
|
@@ -4692,7 +4729,9 @@ module OvirtSDK4
|
|
4692
4729
|
private_constant :LIST
|
4693
4730
|
|
4694
4731
|
#
|
4695
|
-
# Returns the
|
4732
|
+
# Returns the list of CPU profiles of the system.
|
4733
|
+
#
|
4734
|
+
# The order of the returned list of CPU profiles isn't guranteed.
|
4696
4735
|
#
|
4697
4736
|
# @param opts [Hash] Additional options.
|
4698
4737
|
#
|
@@ -5218,6 +5257,8 @@ module OvirtSDK4
|
|
5218
5257
|
#
|
5219
5258
|
# Lists networks in the data center.
|
5220
5259
|
#
|
5260
|
+
# The order of the returned list of networks isn't guaranteed.
|
5261
|
+
#
|
5221
5262
|
# @param opts [Hash] Additional options.
|
5222
5263
|
#
|
5223
5264
|
# @option opts [Integer] :max Sets the maximum number of networks to return. If not specified, all the networks are returned.
|
@@ -5392,6 +5433,9 @@ module OvirtSDK4
|
|
5392
5433
|
# The data center also contains a link to the storage domains collection. The data center uses this collection to
|
5393
5434
|
# attach storage domains from the storage domains main collection.
|
5394
5435
|
#
|
5436
|
+
# The order of the returned list of data centers is guaranteed only if the `sortby` clause is included in the
|
5437
|
+
# `search` parameter.
|
5438
|
+
#
|
5395
5439
|
# @param opts [Hash] Additional options.
|
5396
5440
|
#
|
5397
5441
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -5686,6 +5730,8 @@ module OvirtSDK4
|
|
5686
5730
|
#
|
5687
5731
|
# List the disk that are attached to the virtual machine.
|
5688
5732
|
#
|
5733
|
+
# The order of the returned list of disks attachments isn't guaranteed.
|
5734
|
+
#
|
5689
5735
|
# @param opts [Hash] Additional options.
|
5690
5736
|
#
|
5691
5737
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -5900,7 +5946,9 @@ module OvirtSDK4
|
|
5900
5946
|
private_constant :LIST
|
5901
5947
|
|
5902
5948
|
#
|
5903
|
-
# Returns the
|
5949
|
+
# Returns the list of disk profiles of the system.
|
5950
|
+
#
|
5951
|
+
# The order of the returned list of disk profiles isn't guaranteed.
|
5904
5952
|
#
|
5905
5953
|
# @param opts [Hash] Additional options.
|
5906
5954
|
#
|
@@ -6047,7 +6095,9 @@ module OvirtSDK4
|
|
6047
6095
|
private_constant :LIST
|
6048
6096
|
|
6049
6097
|
#
|
6050
|
-
# Returns the
|
6098
|
+
# Returns the list of disk snapshots of the storage domain.
|
6099
|
+
#
|
6100
|
+
# The order of the returned list of disk snapshots isn't guaranteed.
|
6051
6101
|
#
|
6052
6102
|
# @param opts [Hash] Additional options.
|
6053
6103
|
#
|
@@ -6279,6 +6329,9 @@ module OvirtSDK4
|
|
6279
6329
|
# </disks>
|
6280
6330
|
# ----
|
6281
6331
|
#
|
6332
|
+
# The order of the returned list of disks is guaranteed only if the `sortby` clause is included in the
|
6333
|
+
# `search` parameter.
|
6334
|
+
#
|
6282
6335
|
# @param opts [Hash] Additional options.
|
6283
6336
|
#
|
6284
6337
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -6521,7 +6574,9 @@ module OvirtSDK4
|
|
6521
6574
|
private_constant :LIST
|
6522
6575
|
|
6523
6576
|
#
|
6524
|
-
# Returns the
|
6577
|
+
# Returns the list of groups.
|
6578
|
+
#
|
6579
|
+
# The order of the returned list of groups isn't guaranteed.
|
6525
6580
|
#
|
6526
6581
|
# @param opts [Hash] Additional options.
|
6527
6582
|
#
|
@@ -6699,6 +6754,8 @@ module OvirtSDK4
|
|
6699
6754
|
# </users>
|
6700
6755
|
# ----
|
6701
6756
|
#
|
6757
|
+
# The order of the returned list of users isn't guaranteed.
|
6758
|
+
#
|
6702
6759
|
# @param opts [Hash] Additional options.
|
6703
6760
|
#
|
6704
6761
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -6796,6 +6853,8 @@ module OvirtSDK4
|
|
6796
6853
|
# </domains>
|
6797
6854
|
# ----
|
6798
6855
|
#
|
6856
|
+
# The order of the returned list of domains isn't guaranteed.
|
6857
|
+
#
|
6799
6858
|
# @param opts [Hash] Additional options.
|
6800
6859
|
#
|
6801
6860
|
# @option opts [Integer] :max Sets the maximum number of domains to return. If not specified all the domains are returned.
|
@@ -7082,16 +7141,25 @@ module OvirtSDK4
|
|
7082
7141
|
# * id="1" - The API logs in the admin user account.
|
7083
7142
|
# * id="2" - The API logs out of the admin user account.
|
7084
7143
|
#
|
7144
|
+
# The order of the returned list of events is always garanteed. If the `sortby` clause is included in the
|
7145
|
+
# `search` parameter, then the events will be ordered according to that clause. If the `sortby` clause isn't
|
7146
|
+
# included, then the events will be sorted by the numeric value of the `id` attribute, starting with the
|
7147
|
+
# highest value. This, combined with the `max` parameter, simplifies obtaining the most recent event:
|
7148
|
+
#
|
7149
|
+
# ....
|
7150
|
+
# GET /ovirt-engine/api/events?max=1
|
7151
|
+
# ....
|
7152
|
+
#
|
7085
7153
|
# @param opts [Hash] Additional options.
|
7086
7154
|
#
|
7087
7155
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
7088
7156
|
# account. The default value is `true`, which means that case is taken into account. If you want to search
|
7089
7157
|
# ignoring case set it to `false`.
|
7090
7158
|
#
|
7091
|
-
# @option opts [Integer] :from Indicates the
|
7092
|
-
# strictly increasing, so when this parameter is used only the events with
|
7093
|
-
#
|
7094
|
-
# with
|
7159
|
+
# @option opts [Integer] :from Indicates the event index after which events should be returned. The indexes of events are
|
7160
|
+
# strictly increasing, so when this parameter is used only the events with greater indexes
|
7161
|
+
# will be returned. For example, the following request will return only the events
|
7162
|
+
# with indexes greater than `123`:
|
7095
7163
|
#
|
7096
7164
|
# [source]
|
7097
7165
|
# ----
|
@@ -7249,7 +7317,26 @@ module OvirtSDK4
|
|
7249
7317
|
private_constant :GET
|
7250
7318
|
|
7251
7319
|
#
|
7252
|
-
#
|
7320
|
+
# Retrieves external compute resource details.
|
7321
|
+
#
|
7322
|
+
# For example, to get the details of compute resource `234` of provider `123`, send a request like this:
|
7323
|
+
#
|
7324
|
+
# ....
|
7325
|
+
# GET /ovirt-engine/api/externalhostproviders/123/computeresources/234
|
7326
|
+
# ....
|
7327
|
+
#
|
7328
|
+
# It will return a response like this:
|
7329
|
+
#
|
7330
|
+
# [source,xml]
|
7331
|
+
# ----
|
7332
|
+
# <external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
|
7333
|
+
# <name>hostname</name>
|
7334
|
+
# <provider>oVirt</provider>
|
7335
|
+
# <url>https://hostname/api</url>
|
7336
|
+
# <user>admin@internal</user>
|
7337
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7338
|
+
# </external_compute_resource>
|
7339
|
+
# ----
|
7253
7340
|
#
|
7254
7341
|
# @param opts [Hash] Additional options.
|
7255
7342
|
#
|
@@ -7302,7 +7389,31 @@ module OvirtSDK4
|
|
7302
7389
|
private_constant :LIST
|
7303
7390
|
|
7304
7391
|
#
|
7305
|
-
#
|
7392
|
+
# Retrieves a list of external compute resources.
|
7393
|
+
#
|
7394
|
+
# For example, to retrieve the compute resources of external host provider `123`, send a request like this:
|
7395
|
+
#
|
7396
|
+
# ....
|
7397
|
+
# GET /ovirt-engine/api/externalhostproviders/123/computeresources
|
7398
|
+
# ....
|
7399
|
+
#
|
7400
|
+
# It will return a response like this:
|
7401
|
+
#
|
7402
|
+
# [source,xml]
|
7403
|
+
# ----
|
7404
|
+
# <external_compute_resources>
|
7405
|
+
# <external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
|
7406
|
+
# <name>hostname</name>
|
7407
|
+
# <provider>oVirt</provider>
|
7408
|
+
# <url>https://address/api</url>
|
7409
|
+
# <user>admin@internal</user>
|
7410
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7411
|
+
# </external_compute_resource>
|
7412
|
+
# ...
|
7413
|
+
# </external_compute_resources>
|
7414
|
+
# ----
|
7415
|
+
#
|
7416
|
+
# The order of the returned list of compute resources isn't guaranteed.
|
7306
7417
|
#
|
7307
7418
|
# @param opts [Hash] Additional options.
|
7308
7419
|
#
|
@@ -7324,7 +7435,7 @@ module OvirtSDK4
|
|
7324
7435
|
end
|
7325
7436
|
|
7326
7437
|
#
|
7327
|
-
#
|
7438
|
+
# This service manages compute resource instance
|
7328
7439
|
#
|
7329
7440
|
# @param id [String] The identifier of the `resource`.
|
7330
7441
|
#
|
@@ -7371,7 +7482,30 @@ module OvirtSDK4
|
|
7371
7482
|
private_constant :GET
|
7372
7483
|
|
7373
7484
|
#
|
7374
|
-
#
|
7485
|
+
# Get discovered host info.
|
7486
|
+
#
|
7487
|
+
# Retrieves information about an host that is managed in external provider management system, such as Foreman. The
|
7488
|
+
# information includes hostname, address, subnet, base image and more.
|
7489
|
+
#
|
7490
|
+
# For example, to get the details of host `234` from provider `123`, send a request like this:
|
7491
|
+
#
|
7492
|
+
# ....
|
7493
|
+
# GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234
|
7494
|
+
# ....
|
7495
|
+
#
|
7496
|
+
# The result will be like this:
|
7497
|
+
#
|
7498
|
+
# [source,xml]
|
7499
|
+
# ----
|
7500
|
+
# <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/234" id="234">
|
7501
|
+
# <name>mac001a4ad04040</name>
|
7502
|
+
# <ip>10.34.67.43</ip>
|
7503
|
+
# <last_report>2017-04-24 11:05:41 UTC</last_report>
|
7504
|
+
# <mac>00:1a:4a:d0:40:40</mac>
|
7505
|
+
# <subnet_name>sat0</subnet_name>
|
7506
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7507
|
+
# </external_discovered_host>
|
7508
|
+
# ----
|
7375
7509
|
#
|
7376
7510
|
# @param opts [Hash] Additional options.
|
7377
7511
|
#
|
@@ -7424,7 +7558,41 @@ module OvirtSDK4
|
|
7424
7558
|
private_constant :LIST
|
7425
7559
|
|
7426
7560
|
#
|
7427
|
-
#
|
7561
|
+
# Get list of discovered hosts' information.
|
7562
|
+
#
|
7563
|
+
# Discovered hosts are fetched from third-party providers such as Foreman.
|
7564
|
+
#
|
7565
|
+
# To list all discovered hosts for provider `123` send the following:
|
7566
|
+
#
|
7567
|
+
# [source]
|
7568
|
+
# ----
|
7569
|
+
# GET /ovirt-engine/api/externalhostproviders/123/discoveredhost
|
7570
|
+
# ----
|
7571
|
+
#
|
7572
|
+
# [source,xml]
|
7573
|
+
# ----
|
7574
|
+
# <external_discovered_hosts>
|
7575
|
+
# <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/456" id="456">
|
7576
|
+
# <name>mac001a4ad04031</name>
|
7577
|
+
# <ip>10.34.67.42</ip>
|
7578
|
+
# <last_report>2017-04-24 11:05:41 UTC</last_report>
|
7579
|
+
# <mac>00:1a:4a:d0:40:31</mac>
|
7580
|
+
# <subnet_name>sat0</subnet_name>
|
7581
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7582
|
+
# </external_discovered_host>
|
7583
|
+
# <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/789" id="789">
|
7584
|
+
# <name>mac001a4ad04040</name>
|
7585
|
+
# <ip>10.34.67.43</ip>
|
7586
|
+
# <last_report>2017-04-24 11:05:41 UTC</last_report>
|
7587
|
+
# <mac>00:1a:4a:d0:40:40</mac>
|
7588
|
+
# <subnet_name>sat0</subnet_name>
|
7589
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7590
|
+
# </external_discovered_host>
|
7591
|
+
# ...
|
7592
|
+
# </external_discovered_hosts>
|
7593
|
+
# ----
|
7594
|
+
#
|
7595
|
+
# The order of the returned list of hosts isn't guaranteed.
|
7428
7596
|
#
|
7429
7597
|
# @param opts [Hash] Additional options.
|
7430
7598
|
#
|
@@ -7545,7 +7713,27 @@ module OvirtSDK4
|
|
7545
7713
|
private_constant :GET
|
7546
7714
|
|
7547
7715
|
#
|
7548
|
-
#
|
7716
|
+
# Get host group information.
|
7717
|
+
#
|
7718
|
+
# For example, to get the details of hostgroup `234` of provider `123`, send a request like this:
|
7719
|
+
#
|
7720
|
+
# ....
|
7721
|
+
# GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234
|
7722
|
+
# ....
|
7723
|
+
#
|
7724
|
+
# It will return a response like this:
|
7725
|
+
#
|
7726
|
+
# [source,xml]
|
7727
|
+
# ----
|
7728
|
+
# <external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
|
7729
|
+
# <name>rhel7</name>
|
7730
|
+
# <architecture_name>x86_64</architecture_name>
|
7731
|
+
# <domain_name>s.com</domain_name>
|
7732
|
+
# <operating_system_name>RedHat 7.3</operating_system_name>
|
7733
|
+
# <subnet_name>sat0</subnet_name>
|
7734
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7735
|
+
# </external_host_group>
|
7736
|
+
# ----
|
7549
7737
|
#
|
7550
7738
|
# @param opts [Hash] Additional options.
|
7551
7739
|
#
|
@@ -7598,7 +7786,35 @@ module OvirtSDK4
|
|
7598
7786
|
private_constant :LIST
|
7599
7787
|
|
7600
7788
|
#
|
7601
|
-
#
|
7789
|
+
# Get host groups list from external host provider.
|
7790
|
+
#
|
7791
|
+
# Host group is a term of host providers - the host group includes provision details. This API returns all possible
|
7792
|
+
# hostgroups exposed by the external provider.
|
7793
|
+
#
|
7794
|
+
# For example, to get the details of all host groups of provider `123`, send a request like this:
|
7795
|
+
#
|
7796
|
+
# ....
|
7797
|
+
# GET /ovirt-engine/api/externalhostproviders/123/hostgroups
|
7798
|
+
# ....
|
7799
|
+
#
|
7800
|
+
# The response will be like this:
|
7801
|
+
#
|
7802
|
+
# [source,xml]
|
7803
|
+
# ----
|
7804
|
+
# <external_host_groups>
|
7805
|
+
# <external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
|
7806
|
+
# <name>rhel7</name>
|
7807
|
+
# <architecture_name>x86_64</architecture_name>
|
7808
|
+
# <domain_name>example.com</domain_name>
|
7809
|
+
# <operating_system_name>RedHat 7.3</operating_system_name>
|
7810
|
+
# <subnet_name>sat0</subnet_name>
|
7811
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
|
7812
|
+
# </external_host_group>
|
7813
|
+
# ...
|
7814
|
+
# </external_host_groups>
|
7815
|
+
# ----
|
7816
|
+
#
|
7817
|
+
# The order of the returned list of host groups isn't guaranteed.
|
7602
7818
|
#
|
7603
7819
|
# @param opts [Hash] Additional options.
|
7604
7820
|
#
|
@@ -7620,7 +7836,7 @@ module OvirtSDK4
|
|
7620
7836
|
end
|
7621
7837
|
|
7622
7838
|
#
|
7623
|
-
#
|
7839
|
+
# This service manages hostgroup instance.
|
7624
7840
|
#
|
7625
7841
|
# @param id [String] The identifier of the `group`.
|
7626
7842
|
#
|
@@ -7695,7 +7911,9 @@ module OvirtSDK4
|
|
7695
7911
|
private_constant :LIST
|
7696
7912
|
|
7697
7913
|
#
|
7698
|
-
# Returns the
|
7914
|
+
# Returns the list of external host providers.
|
7915
|
+
#
|
7916
|
+
# The order of the returned list of host providers isn't guaranteed.
|
7699
7917
|
#
|
7700
7918
|
# @param opts [Hash] Additional options.
|
7701
7919
|
#
|
@@ -7765,7 +7983,9 @@ module OvirtSDK4
|
|
7765
7983
|
private_constant :LIST
|
7766
7984
|
|
7767
7985
|
#
|
7768
|
-
#
|
7986
|
+
# Return the list of external hosts.
|
7987
|
+
#
|
7988
|
+
# The order of the returned list of hosts isn't guaranteed.
|
7769
7989
|
#
|
7770
7990
|
# @param opts [Hash] Additional options.
|
7771
7991
|
#
|
@@ -7849,7 +8069,13 @@ module OvirtSDK4
|
|
7849
8069
|
end
|
7850
8070
|
|
7851
8071
|
#
|
7852
|
-
#
|
8072
|
+
# In order to test connectivity for external provider we need
|
8073
|
+
# to run following request where 123 is an id of a provider.
|
8074
|
+
#
|
8075
|
+
# [source]
|
8076
|
+
# ----
|
8077
|
+
# POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
|
8078
|
+
# ----
|
7853
8079
|
#
|
7854
8080
|
# @param opts [Hash] Additional options.
|
7855
8081
|
#
|
@@ -7869,7 +8095,7 @@ module OvirtSDK4
|
|
7869
8095
|
end
|
7870
8096
|
|
7871
8097
|
#
|
7872
|
-
#
|
8098
|
+
# A service to view certificates for this external provider.
|
7873
8099
|
#
|
7874
8100
|
# @return [ExternalProviderCertificatesService] A reference to `certificates` service.
|
7875
8101
|
#
|
@@ -7916,7 +8142,23 @@ module OvirtSDK4
|
|
7916
8142
|
private_constant :GET
|
7917
8143
|
|
7918
8144
|
#
|
7919
|
-
#
|
8145
|
+
# Get specific certificate.
|
8146
|
+
#
|
8147
|
+
# [source]
|
8148
|
+
# ----
|
8149
|
+
# GET /ovirt-engine/api/externalhostproviders/123/certificate/0
|
8150
|
+
# ----
|
8151
|
+
#
|
8152
|
+
# And here is sample response:
|
8153
|
+
#
|
8154
|
+
# [source,xml]
|
8155
|
+
# ----
|
8156
|
+
# <certificate id="0">
|
8157
|
+
# <organization>provider.example.com</organization>
|
8158
|
+
# <subject>CN=provider.example.com</subject>
|
8159
|
+
# <content>...</content>
|
8160
|
+
# </certificate>
|
8161
|
+
# ----
|
7920
8162
|
#
|
7921
8163
|
# @param opts [Hash] Additional options.
|
7922
8164
|
#
|
@@ -7969,7 +8211,25 @@ module OvirtSDK4
|
|
7969
8211
|
private_constant :LIST
|
7970
8212
|
|
7971
8213
|
#
|
7972
|
-
# Returns the
|
8214
|
+
# Returns the chain of certificates presented by the external provider.
|
8215
|
+
#
|
8216
|
+
# [source]
|
8217
|
+
# ----
|
8218
|
+
# GET /ovirt-engine/api/externalhostproviders/123/certificates
|
8219
|
+
# ----
|
8220
|
+
#
|
8221
|
+
# And here is sample response:
|
8222
|
+
#
|
8223
|
+
# [source,xml]
|
8224
|
+
# ----
|
8225
|
+
# <certificates>
|
8226
|
+
# <certificate id="789">...</certificate>
|
8227
|
+
# ...
|
8228
|
+
# </certificates>
|
8229
|
+
# ----
|
8230
|
+
#
|
8231
|
+
# The order of the returned certificates is always guaranteed to be the sign order: the first is the
|
8232
|
+
# certificate of the server itself, the second the certificate of the CA that signs the first, so on.
|
7973
8233
|
#
|
7974
8234
|
# @param opts [Hash] Additional options.
|
7975
8235
|
#
|
@@ -7991,7 +8251,8 @@ module OvirtSDK4
|
|
7991
8251
|
end
|
7992
8252
|
|
7993
8253
|
#
|
7994
|
-
#
|
8254
|
+
# Reference to service that manages a specific certificate
|
8255
|
+
# for this external provider.
|
7995
8256
|
#
|
7996
8257
|
# @param id [String] The identifier of the `certificate`.
|
7997
8258
|
#
|
@@ -8119,7 +8380,27 @@ module OvirtSDK4
|
|
8119
8380
|
private_constant :GET
|
8120
8381
|
|
8121
8382
|
#
|
8122
|
-
#
|
8383
|
+
# Gets details of this fence agent.
|
8384
|
+
#
|
8385
|
+
# [source]
|
8386
|
+
# ----
|
8387
|
+
# GET /ovirt-engine/api/hosts/123/fenceagents/0
|
8388
|
+
# ----
|
8389
|
+
#
|
8390
|
+
# And here is sample response:
|
8391
|
+
#
|
8392
|
+
# [source,xml]
|
8393
|
+
# ----
|
8394
|
+
# <agent id="0">
|
8395
|
+
# <type>apc</type>
|
8396
|
+
# <order>1</order>
|
8397
|
+
# <ip>192.168.1.101</ip>
|
8398
|
+
# <user>user</user>
|
8399
|
+
# <password>xxx</password>
|
8400
|
+
# <port>9</port>
|
8401
|
+
# <options>name1=value1, name2=value2</options>
|
8402
|
+
# </agent>
|
8403
|
+
# ----
|
8123
8404
|
#
|
8124
8405
|
# @param opts [Hash] Additional options.
|
8125
8406
|
#
|
@@ -8145,7 +8426,12 @@ module OvirtSDK4
|
|
8145
8426
|
private_constant :REMOVE
|
8146
8427
|
|
8147
8428
|
#
|
8148
|
-
#
|
8429
|
+
# Removes a fence agent for a specific host.
|
8430
|
+
#
|
8431
|
+
# [source]
|
8432
|
+
# ----
|
8433
|
+
# DELETE /ovirt-engine/api/hosts/123/fenceagents/0
|
8434
|
+
# ----
|
8149
8435
|
#
|
8150
8436
|
# @param opts [Hash] Additional options.
|
8151
8437
|
#
|
@@ -8172,7 +8458,7 @@ module OvirtSDK4
|
|
8172
8458
|
#
|
8173
8459
|
# Updates the `agent`.
|
8174
8460
|
#
|
8175
|
-
# @param agent [Agent]
|
8461
|
+
# @param agent [Agent] Fence agent details.
|
8176
8462
|
# @param opts [Hash] Additional options.
|
8177
8463
|
#
|
8178
8464
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -8253,7 +8539,31 @@ module OvirtSDK4
|
|
8253
8539
|
private_constant :LIST
|
8254
8540
|
|
8255
8541
|
#
|
8256
|
-
# Returns the
|
8542
|
+
# Returns the list of fencing agents configured for the host.
|
8543
|
+
#
|
8544
|
+
# [source]
|
8545
|
+
# ----
|
8546
|
+
# GET /ovirt-engine/api/hosts/123/fenceagents
|
8547
|
+
# ----
|
8548
|
+
#
|
8549
|
+
# And here is sample response:
|
8550
|
+
#
|
8551
|
+
# [source,xml]
|
8552
|
+
# ----
|
8553
|
+
# <agents>
|
8554
|
+
# <agent id="0">
|
8555
|
+
# <type>apc</type>
|
8556
|
+
# <order>1</order>
|
8557
|
+
# <ip>192.168.1.101</ip>
|
8558
|
+
# <user>user</user>
|
8559
|
+
# <password>xxx</password>
|
8560
|
+
# <port>9</port>
|
8561
|
+
# <options>name1=value1, name2=value2</options>
|
8562
|
+
# </agent>
|
8563
|
+
# </agents>
|
8564
|
+
# ----
|
8565
|
+
#
|
8566
|
+
# The order of the returned list of fencing agents isn't guaranteed.
|
8257
8567
|
#
|
8258
8568
|
# @param opts [Hash] Additional options.
|
8259
8569
|
#
|
@@ -8275,7 +8585,8 @@ module OvirtSDK4
|
|
8275
8585
|
end
|
8276
8586
|
|
8277
8587
|
#
|
8278
|
-
#
|
8588
|
+
# Reference to service that manages a specific fence agent
|
8589
|
+
# for this host.
|
8279
8590
|
#
|
8280
8591
|
# @param id [String] The identifier of the `agent`.
|
8281
8592
|
#
|
@@ -8377,7 +8688,9 @@ module OvirtSDK4
|
|
8377
8688
|
private_constant :LIST
|
8378
8689
|
|
8379
8690
|
#
|
8380
|
-
# Returns the
|
8691
|
+
# Returns the list of ISO images and virtual floppy disks available in the storage domain.
|
8692
|
+
#
|
8693
|
+
# The order returned list of ISO images and virtual floppy disks isn't guaranteed.
|
8381
8694
|
#
|
8382
8695
|
# @param opts [Hash] Additional options.
|
8383
8696
|
#
|
@@ -8561,7 +8874,9 @@ module OvirtSDK4
|
|
8561
8874
|
private_constant :LIST
|
8562
8875
|
|
8563
8876
|
#
|
8564
|
-
# Returns the
|
8877
|
+
# Returns the list of filters used by the scheduling policy.
|
8878
|
+
#
|
8879
|
+
# The order of the returned list of filters isn't guaranteed.
|
8565
8880
|
#
|
8566
8881
|
# @param opts [Hash] Additional options.
|
8567
8882
|
#
|
@@ -8764,6 +9079,8 @@ module OvirtSDK4
|
|
8764
9079
|
# </bricks>
|
8765
9080
|
# ----
|
8766
9081
|
#
|
9082
|
+
# The order of the returned list is based on the brick order provided at gluster volume creation.
|
9083
|
+
#
|
8767
9084
|
# @param opts [Hash] Additional options.
|
8768
9085
|
#
|
8769
9086
|
# @option opts [Integer] :max Sets the maximum number of bricks to return. If not specified all the bricks are returned.
|
@@ -9129,7 +9446,9 @@ module OvirtSDK4
|
|
9129
9446
|
private_constant :LIST
|
9130
9447
|
|
9131
9448
|
#
|
9132
|
-
# Returns the
|
9449
|
+
# Returns the list of hooks.
|
9450
|
+
#
|
9451
|
+
# The order of the returned list of hooks isn't guaranteed.
|
9133
9452
|
#
|
9134
9453
|
# @param opts [Hash] Additional options.
|
9135
9454
|
#
|
@@ -9274,6 +9593,8 @@ module OvirtSDK4
|
|
9274
9593
|
# GET /ovirt-engine/api/clusters/456/glustervolumes
|
9275
9594
|
# ----
|
9276
9595
|
#
|
9596
|
+
# The order of the returned list of volumes isn't guaranteed.
|
9597
|
+
#
|
9277
9598
|
# @param opts [Hash] Additional options.
|
9278
9599
|
#
|
9279
9600
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -9347,7 +9668,30 @@ module OvirtSDK4
|
|
9347
9668
|
private_constant :GET
|
9348
9669
|
|
9349
9670
|
#
|
9350
|
-
#
|
9671
|
+
# Gets the system group information.
|
9672
|
+
#
|
9673
|
+
# Usage:
|
9674
|
+
#
|
9675
|
+
# ....
|
9676
|
+
# GET /ovirt-engine/api/groups/123
|
9677
|
+
# ....
|
9678
|
+
#
|
9679
|
+
# Will return the group information:
|
9680
|
+
#
|
9681
|
+
# [source,xml]
|
9682
|
+
# ----
|
9683
|
+
# <group href="/ovirt-engine/api/groups/123" id="123">
|
9684
|
+
# <name>mygroup</name>
|
9685
|
+
# <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
|
9686
|
+
# <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
|
9687
|
+
# <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
|
9688
|
+
# <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
|
9689
|
+
# <namespace>DC=example,DC=com</namespace>
|
9690
|
+
# <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
|
9691
|
+
# <name>myextension-authz</name>
|
9692
|
+
# </domain>
|
9693
|
+
# </group>
|
9694
|
+
# ----
|
9351
9695
|
#
|
9352
9696
|
# @param opts [Hash] Additional options.
|
9353
9697
|
#
|
@@ -9373,7 +9717,13 @@ module OvirtSDK4
|
|
9373
9717
|
private_constant :REMOVE
|
9374
9718
|
|
9375
9719
|
#
|
9376
|
-
#
|
9720
|
+
# Removes the system group.
|
9721
|
+
#
|
9722
|
+
# Usage:
|
9723
|
+
#
|
9724
|
+
# ....
|
9725
|
+
# DELETE /ovirt-engine/api/groups/123
|
9726
|
+
# ....
|
9377
9727
|
#
|
9378
9728
|
# @param opts [Hash] Additional options.
|
9379
9729
|
#
|
@@ -9392,7 +9742,7 @@ module OvirtSDK4
|
|
9392
9742
|
end
|
9393
9743
|
|
9394
9744
|
#
|
9395
|
-
#
|
9745
|
+
# Reference to the service that manages the collection of permissions assigned to this system group.
|
9396
9746
|
#
|
9397
9747
|
# @return [AssignedPermissionsService] A reference to `permissions` service.
|
9398
9748
|
#
|
@@ -9401,7 +9751,7 @@ module OvirtSDK4
|
|
9401
9751
|
end
|
9402
9752
|
|
9403
9753
|
#
|
9404
|
-
#
|
9754
|
+
# Reference to the service that manages the collection of roles assigned to this system group.
|
9405
9755
|
#
|
9406
9756
|
# @return [AssignedRolesService] A reference to `roles` service.
|
9407
9757
|
#
|
@@ -9410,7 +9760,7 @@ module OvirtSDK4
|
|
9410
9760
|
end
|
9411
9761
|
|
9412
9762
|
#
|
9413
|
-
#
|
9763
|
+
# Reference to the service that manages the collection of tags assigned to this system group.
|
9414
9764
|
#
|
9415
9765
|
# @return [AssignedTagsService] A reference to `tags` service.
|
9416
9766
|
#
|
@@ -9491,7 +9841,7 @@ module OvirtSDK4
|
|
9491
9841
|
# </group>
|
9492
9842
|
# ----
|
9493
9843
|
#
|
9494
|
-
# @param group [Group] The
|
9844
|
+
# @param group [Group] The group to be added.
|
9495
9845
|
#
|
9496
9846
|
# @param opts [Hash] Additional options.
|
9497
9847
|
#
|
@@ -9519,7 +9869,35 @@ module OvirtSDK4
|
|
9519
9869
|
private_constant :LIST
|
9520
9870
|
|
9521
9871
|
#
|
9522
|
-
#
|
9872
|
+
# List all the groups in the system.
|
9873
|
+
#
|
9874
|
+
# Usage:
|
9875
|
+
#
|
9876
|
+
# ....
|
9877
|
+
# GET /ovirt-engine/api/groups
|
9878
|
+
# ....
|
9879
|
+
#
|
9880
|
+
# Will return the list of groups:
|
9881
|
+
#
|
9882
|
+
# [source,xml]
|
9883
|
+
# ----
|
9884
|
+
# <groups>
|
9885
|
+
# <group href="/ovirt-engine/api/groups/123" id="123">
|
9886
|
+
# <name>mygroup</name>
|
9887
|
+
# <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
|
9888
|
+
# <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
|
9889
|
+
# <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
|
9890
|
+
# <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
|
9891
|
+
# <namespace>DC=example,DC=com</namespace>
|
9892
|
+
# <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
|
9893
|
+
# <name>myextension-authz</name>
|
9894
|
+
# </domain>
|
9895
|
+
# </group>
|
9896
|
+
# ...
|
9897
|
+
# </groups>
|
9898
|
+
# ----
|
9899
|
+
#
|
9900
|
+
# The order of the returned list of groups isn't guaranteed.
|
9523
9901
|
#
|
9524
9902
|
# @param opts [Hash] Additional options.
|
9525
9903
|
#
|
@@ -9547,7 +9925,7 @@ module OvirtSDK4
|
|
9547
9925
|
end
|
9548
9926
|
|
9549
9927
|
#
|
9550
|
-
#
|
9928
|
+
# Reference to the service that manages a specific group.
|
9551
9929
|
#
|
9552
9930
|
# @param id [String] The identifier of the `group`.
|
9553
9931
|
#
|
@@ -9668,6 +10046,8 @@ module OvirtSDK4
|
|
9668
10046
|
#
|
9669
10047
|
# List the devices of a host.
|
9670
10048
|
#
|
10049
|
+
# The order of the returned list of devices isn't guaranteed.
|
10050
|
+
#
|
9671
10051
|
# @param opts [Hash] Additional options.
|
9672
10052
|
#
|
9673
10053
|
# @option opts [Integer] :max Sets the maximum number of devices to return. If not specified all the devices are returned.
|
@@ -9788,7 +10168,9 @@ module OvirtSDK4
|
|
9788
10168
|
private_constant :LIST
|
9789
10169
|
|
9790
10170
|
#
|
9791
|
-
# Returns the
|
10171
|
+
# Returns the list of hooks configured for the host.
|
10172
|
+
#
|
10173
|
+
# The order of the returned list of hooks isn't guranteed.
|
9792
10174
|
#
|
9793
10175
|
# @param opts [Hash] Additional options.
|
9794
10176
|
#
|
@@ -9858,7 +10240,9 @@ module OvirtSDK4
|
|
9858
10240
|
private_constant :LIST
|
9859
10241
|
|
9860
10242
|
#
|
9861
|
-
# Returns the
|
10243
|
+
# Returns the list of network interfaces of the host.
|
10244
|
+
#
|
10245
|
+
# The order of the returned list of network interfaces isn't guaranteed.
|
9862
10246
|
#
|
9863
10247
|
# @param opts [Hash] Additional options.
|
9864
10248
|
#
|
@@ -9928,7 +10312,9 @@ module OvirtSDK4
|
|
9928
10312
|
private_constant :LIST
|
9929
10313
|
|
9930
10314
|
#
|
9931
|
-
# Returns the
|
10315
|
+
# Returns the list of NUMA nodes of the host.
|
10316
|
+
#
|
10317
|
+
# The order of the returned list of NUMA nodes isn't guaranteed.
|
9932
10318
|
#
|
9933
10319
|
# @param opts [Hash] Additional options.
|
9934
10320
|
#
|
@@ -10017,6 +10403,8 @@ module OvirtSDK4
|
|
10017
10403
|
# </host_storages>
|
10018
10404
|
# ----
|
10019
10405
|
#
|
10406
|
+
# The order of the returned list of storages isn't guaranteed.
|
10407
|
+
#
|
10020
10408
|
# @param opts [Hash] Additional options.
|
10021
10409
|
#
|
10022
10410
|
# @option opts [Boolean] :report_status Indicates if the status of the LUNs in the storage should be checked.
|
@@ -10199,6 +10587,7 @@ module OvirtSDK4
|
|
10199
10587
|
end
|
10200
10588
|
|
10201
10589
|
LIST = [
|
10590
|
+
[:all_content, TrueClass].freeze,
|
10202
10591
|
[:case_sensitive, TrueClass].freeze,
|
10203
10592
|
[:filter, TrueClass].freeze,
|
10204
10593
|
[:max, Integer].freeze,
|
@@ -10231,8 +10620,27 @@ module OvirtSDK4
|
|
10231
10620
|
# </host>
|
10232
10621
|
# ----
|
10233
10622
|
#
|
10623
|
+
# The order of the returned list of hosts is guaranteed only if the `sortby` clause is included in
|
10624
|
+
# the `search` parameter.
|
10625
|
+
#
|
10234
10626
|
# @param opts [Hash] Additional options.
|
10235
10627
|
#
|
10628
|
+
# @option opts [Boolean] :all_content Indicates if all of the attributes of the hosts should be included in the response.
|
10629
|
+
#
|
10630
|
+
# By default the following host attributes are excluded:
|
10631
|
+
#
|
10632
|
+
# - `hosted_engine`
|
10633
|
+
#
|
10634
|
+
# For example, to retrieve the complete representation of the hosts:
|
10635
|
+
#
|
10636
|
+
# ....
|
10637
|
+
# GET /ovirt-engine/api/hosts?all_content=true
|
10638
|
+
# ....
|
10639
|
+
#
|
10640
|
+
# NOTE: These attributes are not included by default because retrieving them impacts performance. They are
|
10641
|
+
# seldom used and require additional queries to the database. Use this parameter with caution and only when
|
10642
|
+
# specifically required.
|
10643
|
+
#
|
10236
10644
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
10237
10645
|
# account. The default value is `true`, which means that case is taken into account. If you want to search
|
10238
10646
|
# ignoring case set it to `false`.
|
@@ -10394,6 +10802,8 @@ module OvirtSDK4
|
|
10394
10802
|
# </icons>
|
10395
10803
|
# ----
|
10396
10804
|
#
|
10805
|
+
# The order of the returned list of icons isn't guaranteed.
|
10806
|
+
#
|
10397
10807
|
# @param opts [Hash] Additional options.
|
10398
10808
|
#
|
10399
10809
|
# @option opts [Integer] :max Sets the maximum number of icons to return. If not specified all the icons are returned.
|
@@ -10731,6 +11141,8 @@ module OvirtSDK4
|
|
10731
11141
|
# Retrieves the list of image transfers that are currently
|
10732
11142
|
# being performed.
|
10733
11143
|
#
|
11144
|
+
# The order of the returned list of image transfers isn't guaranteed.
|
11145
|
+
#
|
10734
11146
|
# @param opts [Hash] Additional options.
|
10735
11147
|
#
|
10736
11148
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -10798,7 +11210,9 @@ module OvirtSDK4
|
|
10798
11210
|
private_constant :LIST
|
10799
11211
|
|
10800
11212
|
#
|
10801
|
-
# Returns the
|
11213
|
+
# Returns the list of images available in the storage domain or provider.
|
11214
|
+
#
|
11215
|
+
# The order of the returned list of images isn't guaranteed.
|
10802
11216
|
#
|
10803
11217
|
# @param opts [Hash] Additional options.
|
10804
11218
|
#
|
@@ -11167,6 +11581,8 @@ module OvirtSDK4
|
|
11167
11581
|
#
|
11168
11582
|
# Lists all the configured graphics consoles of the instance type.
|
11169
11583
|
#
|
11584
|
+
# The order of the returned list of graphics consoles isn't guaranteed.
|
11585
|
+
#
|
11170
11586
|
# @param opts [Hash] Additional options.
|
11171
11587
|
#
|
11172
11588
|
# @option opts [Integer] :max Sets the maximum number of consoles to return. If not specified all the consoles are returned.
|
@@ -11371,6 +11787,8 @@ module OvirtSDK4
|
|
11371
11787
|
#
|
11372
11788
|
# Lists all the configured network interface of the instance type.
|
11373
11789
|
#
|
11790
|
+
# The order of the returned list of network interfaces isn't guaranteed.
|
11791
|
+
#
|
11374
11792
|
# @param opts [Hash] Additional options.
|
11375
11793
|
#
|
11376
11794
|
# @option opts [Integer] :max Sets the maximum number of NICs to return. If not specified all the NICs are returned.
|
@@ -11577,6 +11995,8 @@ module OvirtSDK4
|
|
11577
11995
|
#
|
11578
11996
|
# Lists all the configured watchdogs of the instance type.
|
11579
11997
|
#
|
11998
|
+
# The order of the returned list of watchdogs isn't guaranteed.
|
11999
|
+
#
|
11580
12000
|
# @param opts [Hash] Additional options.
|
11581
12001
|
#
|
11582
12002
|
# @option opts [Integer] :max Sets the maximum number of watchdogs to return. If not specified all the watchdogs are
|
@@ -11763,6 +12183,8 @@ module OvirtSDK4
|
|
11763
12183
|
#
|
11764
12184
|
# Lists all existing instance types in the system.
|
11765
12185
|
#
|
12186
|
+
# The order of the returned list of instance types isn't guaranteed.
|
12187
|
+
#
|
11766
12188
|
# @param opts [Hash] Additional options.
|
11767
12189
|
#
|
11768
12190
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed
|
@@ -12050,7 +12472,9 @@ module OvirtSDK4
|
|
12050
12472
|
private_constant :LIST
|
12051
12473
|
|
12052
12474
|
#
|
12053
|
-
# Returns the
|
12475
|
+
# Returns the list of iSCSI bonds configured in the data center.
|
12476
|
+
#
|
12477
|
+
# The order of the returned list of iSCSI bonds isn't guaranteed.
|
12054
12478
|
#
|
12055
12479
|
# @param opts [Hash] Additional options.
|
12056
12480
|
#
|
@@ -12244,6 +12668,8 @@ module OvirtSDK4
|
|
12244
12668
|
#
|
12245
12669
|
# List all the steps of the job.
|
12246
12670
|
#
|
12671
|
+
# The order of the returned list of steps isn't guaranteed.
|
12672
|
+
#
|
12247
12673
|
# @return [StepsService] A reference to `steps` service.
|
12248
12674
|
#
|
12249
12675
|
def steps_service
|
@@ -12385,6 +12811,8 @@ module OvirtSDK4
|
|
12385
12811
|
# </jobs>
|
12386
12812
|
# ----
|
12387
12813
|
#
|
12814
|
+
# The order of the returned list of jobs isn't guaranteed.
|
12815
|
+
#
|
12388
12816
|
# @param opts [Hash] Additional options.
|
12389
12817
|
#
|
12390
12818
|
# @option opts [Integer] :max Sets the maximum number of jobs to return. If not specified all the jobs are returned.
|
@@ -12484,6 +12912,8 @@ module OvirtSDK4
|
|
12484
12912
|
# </katello_errata>
|
12485
12913
|
# ----
|
12486
12914
|
#
|
12915
|
+
# The order of the returned list of erratum isn't guaranteed.
|
12916
|
+
#
|
12487
12917
|
# @param opts [Hash] Additional options.
|
12488
12918
|
#
|
12489
12919
|
# @option opts [Integer] :max Sets the maximum number of errata to return. If not specified all the errata are returned.
|
@@ -12828,7 +13258,9 @@ module OvirtSDK4
|
|
12828
13258
|
private_constant :LIST
|
12829
13259
|
|
12830
13260
|
#
|
12831
|
-
#
|
13261
|
+
# Return the list of MAC address pools of the system.
|
13262
|
+
#
|
13263
|
+
# The returned list of MAC address pools isn't guaranteed.
|
12832
13264
|
#
|
12833
13265
|
# @param opts [Hash] Additional options.
|
12834
13266
|
#
|
@@ -13353,7 +13785,9 @@ module OvirtSDK4
|
|
13353
13785
|
private_constant :LIST
|
13354
13786
|
|
13355
13787
|
#
|
13356
|
-
# Returns the
|
13788
|
+
# Returns the list of network attachments of the host or host NIC.
|
13789
|
+
#
|
13790
|
+
# The order of the returned list of network attachments isn't guaranteed.
|
13357
13791
|
#
|
13358
13792
|
# @param opts [Hash] Additional options.
|
13359
13793
|
#
|
@@ -13476,6 +13910,8 @@ module OvirtSDK4
|
|
13476
13910
|
#
|
13477
13911
|
# Retrieves the representations of the network filters.
|
13478
13912
|
#
|
13913
|
+
# The order of the returned list of network filters isn't guaranteed.
|
13914
|
+
#
|
13479
13915
|
# @param opts [Hash] Additional options.
|
13480
13916
|
#
|
13481
13917
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -13670,7 +14106,9 @@ module OvirtSDK4
|
|
13670
14106
|
private_constant :LIST
|
13671
14107
|
|
13672
14108
|
#
|
13673
|
-
# Returns the
|
14109
|
+
# Returns the list of labels attached to the network or host NIC.
|
14110
|
+
#
|
14111
|
+
# The order of the returned list of labels isn't guaranteed.
|
13674
14112
|
#
|
13675
14113
|
# @param opts [Hash] Additional options.
|
13676
14114
|
#
|
@@ -13836,6 +14274,9 @@ module OvirtSDK4
|
|
13836
14274
|
# </networks>
|
13837
14275
|
# ----
|
13838
14276
|
#
|
14277
|
+
# The order of the returned list of networks is guaranteed only if the `sortby` clause is included in the
|
14278
|
+
# `search` parameter.
|
14279
|
+
#
|
13839
14280
|
# @param opts [Hash] Additional options.
|
13840
14281
|
#
|
13841
14282
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -14079,7 +14520,13 @@ module OvirtSDK4
|
|
14079
14520
|
end
|
14080
14521
|
|
14081
14522
|
#
|
14082
|
-
#
|
14523
|
+
# In order to test connectivity for external provider we need
|
14524
|
+
# to run following request where 123 is an id of a provider.
|
14525
|
+
#
|
14526
|
+
# [source]
|
14527
|
+
# ----
|
14528
|
+
# POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
|
14529
|
+
# ----
|
14083
14530
|
#
|
14084
14531
|
# @param opts [Hash] Additional options.
|
14085
14532
|
#
|
@@ -14128,7 +14575,7 @@ module OvirtSDK4
|
|
14128
14575
|
end
|
14129
14576
|
|
14130
14577
|
#
|
14131
|
-
#
|
14578
|
+
# A service to view certificates for this external provider.
|
14132
14579
|
#
|
14133
14580
|
# @return [ExternalProviderCertificatesService] A reference to `certificates` service.
|
14134
14581
|
#
|
@@ -14218,7 +14665,9 @@ module OvirtSDK4
|
|
14218
14665
|
private_constant :LIST
|
14219
14666
|
|
14220
14667
|
#
|
14221
|
-
# Returns the
|
14668
|
+
# Returns the list of providers.
|
14669
|
+
#
|
14670
|
+
# The order of the returned list of providers isn't guaranteed.
|
14222
14671
|
#
|
14223
14672
|
# @param opts [Hash] Additional options.
|
14224
14673
|
#
|
@@ -14290,6 +14739,8 @@ module OvirtSDK4
|
|
14290
14739
|
#
|
14291
14740
|
# Lists the images of a Glance image storage domain.
|
14292
14741
|
#
|
14742
|
+
# The order of the returned list of images isn't guaranteed.
|
14743
|
+
#
|
14293
14744
|
# @param opts [Hash] Additional options.
|
14294
14745
|
#
|
14295
14746
|
# @option opts [Integer] :max Sets the maximum number of images to return. If not specified all the images are returned.
|
@@ -14529,7 +14980,13 @@ module OvirtSDK4
|
|
14529
14980
|
end
|
14530
14981
|
|
14531
14982
|
#
|
14532
|
-
#
|
14983
|
+
# In order to test connectivity for external provider we need
|
14984
|
+
# to run following request where 123 is an id of a provider.
|
14985
|
+
#
|
14986
|
+
# [source]
|
14987
|
+
# ----
|
14988
|
+
# POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
|
14989
|
+
# ----
|
14533
14990
|
#
|
14534
14991
|
# @param opts [Hash] Additional options.
|
14535
14992
|
#
|
@@ -14599,7 +15056,7 @@ module OvirtSDK4
|
|
14599
15056
|
end
|
14600
15057
|
|
14601
15058
|
#
|
14602
|
-
#
|
15059
|
+
# A service to view certificates for this external provider.
|
14603
15060
|
#
|
14604
15061
|
# @return [ExternalProviderCertificatesService] A reference to `certificates` service.
|
14605
15062
|
#
|
@@ -14690,7 +15147,9 @@ module OvirtSDK4
|
|
14690
15147
|
private_constant :LIST
|
14691
15148
|
|
14692
15149
|
#
|
14693
|
-
# Returns the
|
15150
|
+
# Returns the list of providers.
|
15151
|
+
#
|
15152
|
+
# The order of the returned list of providers isn't guaranteed.
|
14694
15153
|
#
|
14695
15154
|
# @param opts [Hash] Additional options.
|
14696
15155
|
#
|
@@ -14760,7 +15219,9 @@ module OvirtSDK4
|
|
14760
15219
|
private_constant :LIST
|
14761
15220
|
|
14762
15221
|
#
|
14763
|
-
# Returns the
|
15222
|
+
# Returns the list of networks.
|
15223
|
+
#
|
15224
|
+
# The order of the returned list of networks isn't guaranteed.
|
14764
15225
|
#
|
14765
15226
|
# @param opts [Hash] Additional options.
|
14766
15227
|
#
|
@@ -14934,7 +15395,9 @@ module OvirtSDK4
|
|
14934
15395
|
private_constant :LIST
|
14935
15396
|
|
14936
15397
|
#
|
14937
|
-
# Returns the
|
15398
|
+
# Returns the list of sub-networks.
|
15399
|
+
#
|
15400
|
+
# The order of the returned list of sub-networks isn't guaranteed.
|
14938
15401
|
#
|
14939
15402
|
# @param opts [Hash] Additional options.
|
14940
15403
|
#
|
@@ -15134,7 +15597,9 @@ module OvirtSDK4
|
|
15134
15597
|
private_constant :LIST
|
15135
15598
|
|
15136
15599
|
#
|
15137
|
-
# Returns the
|
15600
|
+
# Returns the list of authentication keys.
|
15601
|
+
#
|
15602
|
+
# The order of the returned list of authentication keys isn't guaranteed.
|
15138
15603
|
#
|
15139
15604
|
# @param opts [Hash] Additional options.
|
15140
15605
|
#
|
@@ -15268,7 +15733,13 @@ module OvirtSDK4
|
|
15268
15733
|
end
|
15269
15734
|
|
15270
15735
|
#
|
15271
|
-
#
|
15736
|
+
# In order to test connectivity for external provider we need
|
15737
|
+
# to run following request where 123 is an id of a provider.
|
15738
|
+
#
|
15739
|
+
# [source]
|
15740
|
+
# ----
|
15741
|
+
# POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
|
15742
|
+
# ----
|
15272
15743
|
#
|
15273
15744
|
# @param opts [Hash] Additional options.
|
15274
15745
|
#
|
@@ -15326,7 +15797,7 @@ module OvirtSDK4
|
|
15326
15797
|
end
|
15327
15798
|
|
15328
15799
|
#
|
15329
|
-
#
|
15800
|
+
# A service to view certificates for this external provider.
|
15330
15801
|
#
|
15331
15802
|
# @return [ExternalProviderCertificatesService] A reference to `certificates` service.
|
15332
15803
|
#
|
@@ -15448,6 +15919,8 @@ module OvirtSDK4
|
|
15448
15919
|
#
|
15449
15920
|
# Retrieves the list of volume providers.
|
15450
15921
|
#
|
15922
|
+
# The order of the returned list of volume providers isn't guaranteed.
|
15923
|
+
#
|
15451
15924
|
# @param opts [Hash] Additional options.
|
15452
15925
|
#
|
15453
15926
|
# @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
|
@@ -15568,7 +16041,9 @@ module OvirtSDK4
|
|
15568
16041
|
private_constant :LIST
|
15569
16042
|
|
15570
16043
|
#
|
15571
|
-
# Returns the
|
16044
|
+
# Returns the list of volume types.
|
16045
|
+
#
|
16046
|
+
# The order of the returned list of volume types isn't guaranteed.
|
15572
16047
|
#
|
15573
16048
|
# @param opts [Hash] Additional options.
|
15574
16049
|
#
|
@@ -15690,7 +16165,9 @@ module OvirtSDK4
|
|
15690
16165
|
private_constant :LIST
|
15691
16166
|
|
15692
16167
|
#
|
15693
|
-
# Returns the
|
16168
|
+
# Returns the list of types of operating system available in the system.
|
16169
|
+
#
|
16170
|
+
# The order of the returned list of operating systems isn't guaranteed.
|
15694
16171
|
#
|
15695
16172
|
# @param opts [Hash] Additional options.
|
15696
16173
|
#
|
@@ -16002,6 +16479,8 @@ module OvirtSDK4
|
|
16002
16479
|
# </permits>
|
16003
16480
|
# ----
|
16004
16481
|
#
|
16482
|
+
# The order of the returned list of permits isn't guaranteed.
|
16483
|
+
#
|
16005
16484
|
# @param opts [Hash] Additional options.
|
16006
16485
|
#
|
16007
16486
|
# @option opts [Integer] :max Sets the maximum number of permits to return. If not specified all the permits are returned.
|
@@ -16069,7 +16548,26 @@ module OvirtSDK4
|
|
16069
16548
|
private_constant :GET
|
16070
16549
|
|
16071
16550
|
#
|
16072
|
-
#
|
16551
|
+
# Get specified QoS in the data center.
|
16552
|
+
#
|
16553
|
+
# [source]
|
16554
|
+
# ----
|
16555
|
+
# GET /ovirt-engine/api/datacenters/123/qoss/123
|
16556
|
+
# ----
|
16557
|
+
#
|
16558
|
+
# You will get response like this one below:
|
16559
|
+
#
|
16560
|
+
# [source,xml]
|
16561
|
+
# ----
|
16562
|
+
# <qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
|
16563
|
+
# <name>123</name>
|
16564
|
+
# <description>123</description>
|
16565
|
+
# <max_iops>1</max_iops>
|
16566
|
+
# <max_throughput>1</max_throughput>
|
16567
|
+
# <type>storage</type>
|
16568
|
+
# <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
|
16569
|
+
# </qos>
|
16570
|
+
# ----
|
16073
16571
|
#
|
16074
16572
|
# @param opts [Hash] Additional options.
|
16075
16573
|
#
|
@@ -16095,7 +16593,12 @@ module OvirtSDK4
|
|
16095
16593
|
private_constant :REMOVE
|
16096
16594
|
|
16097
16595
|
#
|
16098
|
-
#
|
16596
|
+
# Remove specified QoS from datacenter.
|
16597
|
+
#
|
16598
|
+
# [source]
|
16599
|
+
# ----
|
16600
|
+
# DELETE /ovirt-engine/api/datacenters/123/qoss/123
|
16601
|
+
# ----
|
16099
16602
|
#
|
16100
16603
|
# @param opts [Hash] Additional options.
|
16101
16604
|
#
|
@@ -16120,9 +16623,37 @@ module OvirtSDK4
|
|
16120
16623
|
private_constant :UPDATE
|
16121
16624
|
|
16122
16625
|
#
|
16123
|
-
#
|
16626
|
+
# Update the specified QoS in the dataCenter.
|
16627
|
+
#
|
16628
|
+
# [source]
|
16629
|
+
# ----
|
16630
|
+
# PUT /ovirt-engine/api/datacenters/123/qoss/123
|
16631
|
+
# ----
|
16632
|
+
#
|
16633
|
+
# For example with curl:
|
16124
16634
|
#
|
16125
|
-
#
|
16635
|
+
# [source]
|
16636
|
+
# ----
|
16637
|
+
# curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
|
16638
|
+
# "<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \
|
16639
|
+
# https://engine/ovirt-engine/api/datacenters/123/qoss/123
|
16640
|
+
# ----
|
16641
|
+
#
|
16642
|
+
# You will receive response like this:
|
16643
|
+
#
|
16644
|
+
# [source,xml]
|
16645
|
+
# ----
|
16646
|
+
# <qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
|
16647
|
+
# <name>321</name>
|
16648
|
+
# <description>321</description>
|
16649
|
+
# <max_iops>10</max_iops>
|
16650
|
+
# <max_throughput>1</max_throughput>
|
16651
|
+
# <type>storage</type>
|
16652
|
+
# <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
|
16653
|
+
# </qos>
|
16654
|
+
# ----
|
16655
|
+
#
|
16656
|
+
# @param qos [Qos] Updated QoS object.
|
16126
16657
|
# @param opts [Hash] Additional options.
|
16127
16658
|
#
|
16128
16659
|
# @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
|
@@ -16203,7 +16734,25 @@ module OvirtSDK4
|
|
16203
16734
|
private_constant :LIST
|
16204
16735
|
|
16205
16736
|
#
|
16206
|
-
# Returns the
|
16737
|
+
# Returns the list of _quality of service_ configurations available in the data center.
|
16738
|
+
#
|
16739
|
+
# [source]
|
16740
|
+
# ----
|
16741
|
+
# GET /ovirt-engine/api/datacenter/123/qoss
|
16742
|
+
# ----
|
16743
|
+
#
|
16744
|
+
# You will get response which will look like this:
|
16745
|
+
#
|
16746
|
+
# [source, xml]
|
16747
|
+
# ----
|
16748
|
+
# <qoss>
|
16749
|
+
# <qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos>
|
16750
|
+
# <qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos>
|
16751
|
+
# <qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos>
|
16752
|
+
# </qoss>
|
16753
|
+
# ----
|
16754
|
+
#
|
16755
|
+
# The returned list of quality of service configurations isn't guaranteed.
|
16207
16756
|
#
|
16208
16757
|
# @param opts [Hash] Additional options.
|
16209
16758
|
#
|
@@ -16574,7 +17123,9 @@ module OvirtSDK4
|
|
16574
17123
|
private_constant :LIST
|
16575
17124
|
|
16576
17125
|
#
|
16577
|
-
# Returns the
|
17126
|
+
# Returns the set of quota limits configured for the cluster.
|
17127
|
+
#
|
17128
|
+
# The returned list of quota limits isn't guaranteed.
|
16578
17129
|
#
|
16579
17130
|
# @param opts [Hash] Additional options.
|
16580
17131
|
#
|
@@ -16748,7 +17299,9 @@ module OvirtSDK4
|
|
16748
17299
|
private_constant :LIST
|
16749
17300
|
|
16750
17301
|
#
|
16751
|
-
# Returns the
|
17302
|
+
# Returns the list of storage limits configured for the quota.
|
17303
|
+
#
|
17304
|
+
# The order of the returned list of storage limits isn't guaranteed.
|
16752
17305
|
#
|
16753
17306
|
# @param opts [Hash] Additional options.
|
16754
17307
|
#
|
@@ -16860,7 +17413,9 @@ module OvirtSDK4
|
|
16860
17413
|
private_constant :LIST
|
16861
17414
|
|
16862
17415
|
#
|
16863
|
-
# Lists quotas of a data center
|
17416
|
+
# Lists quotas of a data center.
|
17417
|
+
#
|
17418
|
+
# The order of the returned list of quotas isn't guaranteed.
|
16864
17419
|
#
|
16865
17420
|
# @param opts [Hash] Additional options.
|
16866
17421
|
#
|
@@ -17169,6 +17724,8 @@ module OvirtSDK4
|
|
17169
17724
|
# </roles>
|
17170
17725
|
# ----
|
17171
17726
|
#
|
17727
|
+
# The order of the returned list of roles isn't guaranteed.
|
17728
|
+
#
|
17172
17729
|
# @param opts [Hash] Additional options.
|
17173
17730
|
#
|
17174
17731
|
# @option opts [Integer] :max Sets the maximum number of roles to return. If not specified all the roles are returned.
|
@@ -17265,7 +17822,9 @@ module OvirtSDK4
|
|
17265
17822
|
private_constant :LIST
|
17266
17823
|
|
17267
17824
|
#
|
17268
|
-
# Returns the
|
17825
|
+
# Returns the list of scheduling policies available in the system.
|
17826
|
+
#
|
17827
|
+
# The order of the returned list of scheduling policies isn't guaranteed.
|
17269
17828
|
#
|
17270
17829
|
# @param opts [Hash] Additional options.
|
17271
17830
|
#
|
@@ -17572,7 +18131,9 @@ module OvirtSDK4
|
|
17572
18131
|
private_constant :LIST
|
17573
18132
|
|
17574
18133
|
#
|
17575
|
-
# Returns the
|
18134
|
+
# Returns the list of scheduling policy units available in the system.
|
18135
|
+
#
|
18136
|
+
# The order of the returned list of scheduling policy units isn't guaranteed.
|
17576
18137
|
#
|
17577
18138
|
# @param opts [Hash] Additional options.
|
17578
18139
|
#
|
@@ -17857,7 +18418,9 @@ module OvirtSDK4
|
|
17857
18418
|
private_constant :LIST
|
17858
18419
|
|
17859
18420
|
#
|
17860
|
-
# Returns the
|
18421
|
+
# Returns the list of CD-ROM devices of the snapshot.
|
18422
|
+
#
|
18423
|
+
# The order of the returned list of CD-ROM devices isn't guaranteed.
|
17861
18424
|
#
|
17862
18425
|
# @param opts [Hash] Additional options.
|
17863
18426
|
#
|
@@ -17979,7 +18542,9 @@ module OvirtSDK4
|
|
17979
18542
|
private_constant :LIST
|
17980
18543
|
|
17981
18544
|
#
|
17982
|
-
# Returns the
|
18545
|
+
# Returns the list of disks of the snapshot.
|
18546
|
+
#
|
18547
|
+
# The order of the returned list of disks isn't guaranteed.
|
17983
18548
|
#
|
17984
18549
|
# @param opts [Hash] Additional options.
|
17985
18550
|
#
|
@@ -18101,7 +18666,9 @@ module OvirtSDK4
|
|
18101
18666
|
private_constant :LIST
|
18102
18667
|
|
18103
18668
|
#
|
18104
|
-
# Returns the
|
18669
|
+
# Returns the list of NICs of the snapshot.
|
18670
|
+
#
|
18671
|
+
# The order of the returned list of NICs isn't guaranteed.
|
18105
18672
|
#
|
18106
18673
|
# @param opts [Hash] Additional options.
|
18107
18674
|
#
|
@@ -18231,7 +18798,9 @@ module OvirtSDK4
|
|
18231
18798
|
private_constant :LIST
|
18232
18799
|
|
18233
18800
|
#
|
18234
|
-
# Returns the
|
18801
|
+
# Returns the list of snapshots of the storage domain or virtual machine.
|
18802
|
+
#
|
18803
|
+
# The order of the returned list of snapshots isn't guaranteed.
|
18235
18804
|
#
|
18236
18805
|
# @param opts [Hash] Additional options.
|
18237
18806
|
#
|
@@ -18434,7 +19003,9 @@ module OvirtSDK4
|
|
18434
19003
|
private_constant :LIST
|
18435
19004
|
|
18436
19005
|
#
|
18437
|
-
# Returns
|
19006
|
+
# Returns ths list of SSH public keys of the user.
|
19007
|
+
#
|
19008
|
+
# The order of the returned list of keys isn't guaranteed.
|
18438
19009
|
#
|
18439
19010
|
# @param opts [Hash] Additional options.
|
18440
19011
|
#
|
@@ -18614,6 +19185,8 @@ module OvirtSDK4
|
|
18614
19185
|
# </statistic>
|
18615
19186
|
# ----
|
18616
19187
|
#
|
19188
|
+
# The order of the returned list of statistics isn't guaranteed.
|
19189
|
+
#
|
18617
19190
|
# @param opts [Hash] Additional options.
|
18618
19191
|
#
|
18619
19192
|
# @option opts [Integer] :max Sets the maximum number of statistics to return. If not specified all the statistics are returned.
|
@@ -18912,6 +19485,8 @@ module OvirtSDK4
|
|
18912
19485
|
# </steps>
|
18913
19486
|
# ----
|
18914
19487
|
#
|
19488
|
+
# The order of the returned list of steps isn't guaranteed.
|
19489
|
+
#
|
18915
19490
|
# @param opts [Hash] Additional options.
|
18916
19491
|
#
|
18917
19492
|
# @option opts [Integer] :max Sets the maximum number of steps to return. If not specified all the steps are returned.
|
@@ -19153,6 +19728,9 @@ module OvirtSDK4
|
|
19153
19728
|
# </action>
|
19154
19729
|
# ----
|
19155
19730
|
#
|
19731
|
+
# Note that this operation is only applicable to block storage domains (i.e., storage domains with the
|
19732
|
+
# <<types/storage_type, storage type> of iSCSI or FCP).
|
19733
|
+
#
|
19156
19734
|
# @param opts [Hash] Additional options.
|
19157
19735
|
#
|
19158
19736
|
# @option opts [Array<LogicalUnit>] :logical_units The logical units that needs to be reduced from the storage domain.
|
@@ -19594,7 +20172,10 @@ module OvirtSDK4
|
|
19594
20172
|
private_constant :LIST
|
19595
20173
|
|
19596
20174
|
#
|
19597
|
-
# Returns the
|
20175
|
+
# Returns the list of disks available in the storage domain.
|
20176
|
+
#
|
20177
|
+
# The order of the returned list of disks is guaranteed only if the `sortby` clause is included in
|
20178
|
+
# the `search` parameter.
|
19598
20179
|
#
|
19599
20180
|
# @param opts [Hash] Additional options.
|
19600
20181
|
#
|
@@ -19774,7 +20355,9 @@ module OvirtSDK4
|
|
19774
20355
|
private_constant :LIST
|
19775
20356
|
|
19776
20357
|
#
|
19777
|
-
# Returns the
|
20358
|
+
# Returns the list of connections to storage servers that existin the storage domain.
|
20359
|
+
#
|
20360
|
+
# The order of the returned list of connections isn't guaranteed.
|
19778
20361
|
#
|
19779
20362
|
# @param opts [Hash] Additional options.
|
19780
20363
|
#
|
@@ -20027,7 +20610,9 @@ module OvirtSDK4
|
|
20027
20610
|
private_constant :LIST
|
20028
20611
|
|
20029
20612
|
#
|
20030
|
-
# Returns the
|
20613
|
+
# Returns the list of templates availalbe in the storage domain.
|
20614
|
+
#
|
20615
|
+
# The order of the returned list of templates isn't guaranteed.
|
20031
20616
|
#
|
20032
20617
|
# @param opts [Hash] Additional options.
|
20033
20618
|
#
|
@@ -20417,6 +21002,8 @@ module OvirtSDK4
|
|
20417
21002
|
#
|
20418
21003
|
# List the disks that are attached to the virtual machine.
|
20419
21004
|
#
|
21005
|
+
# The order of the returned list of disk attachments isn't guaranteed.
|
21006
|
+
#
|
20420
21007
|
# @param opts [Hash] Additional options.
|
20421
21008
|
#
|
20422
21009
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -20484,7 +21071,9 @@ module OvirtSDK4
|
|
20484
21071
|
private_constant :LIST
|
20485
21072
|
|
20486
21073
|
#
|
20487
|
-
# Returns the
|
21074
|
+
# Returns the list of virtual machines of the export storage domain.
|
21075
|
+
#
|
21076
|
+
# The order of the returned list of virtual machines isn't guaranteed.
|
20488
21077
|
#
|
20489
21078
|
# @param opts [Hash] Additional options.
|
20490
21079
|
#
|
@@ -20667,7 +21256,10 @@ module OvirtSDK4
|
|
20667
21256
|
private_constant :LIST
|
20668
21257
|
|
20669
21258
|
#
|
20670
|
-
# Returns the
|
21259
|
+
# Returns the list of storage domains of the system.
|
21260
|
+
#
|
21261
|
+
# The order of the returned list of storage domains is guaranteed only if the `sortby` clause is included
|
21262
|
+
# in the `search` parameter.
|
20671
21263
|
#
|
20672
21264
|
# @param opts [Hash] Additional options.
|
20673
21265
|
#
|
@@ -21061,7 +21653,9 @@ module OvirtSDK4
|
|
21061
21653
|
private_constant :LIST
|
21062
21654
|
|
21063
21655
|
#
|
21064
|
-
# Returns the
|
21656
|
+
# Returns the list os storage connection extensions.
|
21657
|
+
#
|
21658
|
+
# The order of the returned list of storage connections isn't guaranteed.
|
21065
21659
|
#
|
21066
21660
|
# @param opts [Hash] Additional options.
|
21067
21661
|
#
|
@@ -21180,7 +21774,9 @@ module OvirtSDK4
|
|
21180
21774
|
private_constant :LIST
|
21181
21775
|
|
21182
21776
|
#
|
21183
|
-
# Returns the
|
21777
|
+
# Returns the list of storage connections.
|
21778
|
+
#
|
21779
|
+
# The order of the returned list of connections isn't guaranteed.
|
21184
21780
|
#
|
21185
21781
|
# @param opts [Hash] Additional options.
|
21186
21782
|
#
|
@@ -22078,6 +22674,8 @@ module OvirtSDK4
|
|
22078
22674
|
# </permissions>
|
22079
22675
|
# ----
|
22080
22676
|
#
|
22677
|
+
# The order of the returned permissions isn't guaranteed.
|
22678
|
+
#
|
22081
22679
|
# @param opts [Hash] Additional options.
|
22082
22680
|
#
|
22083
22681
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -22390,6 +22988,8 @@ module OvirtSDK4
|
|
22390
22988
|
# - root3 (id: 333)
|
22391
22989
|
# ....
|
22392
22990
|
#
|
22991
|
+
# The order of the returned list of tags isn't guaranteed.
|
22992
|
+
#
|
22393
22993
|
# @param opts [Hash] Additional options.
|
22394
22994
|
#
|
22395
22995
|
# @option opts [Integer] :max Sets the maximum number of tags to return. If not specified all the tags are returned.
|
@@ -22810,7 +23410,9 @@ module OvirtSDK4
|
|
22810
23410
|
private_constant :LIST
|
22811
23411
|
|
22812
23412
|
#
|
22813
|
-
# Returns the
|
23413
|
+
# Returns the list of CD-ROM devices of the template.
|
23414
|
+
#
|
23415
|
+
# The order of the returned list of CD-ROM devices isn't guaranteed.
|
22814
23416
|
#
|
22815
23417
|
# @param opts [Hash] Additional options.
|
22816
23418
|
#
|
@@ -23090,6 +23692,8 @@ module OvirtSDK4
|
|
23090
23692
|
#
|
23091
23693
|
# List the disks that are attached to the template.
|
23092
23694
|
#
|
23695
|
+
# The order of the returned list of attachments isn't guaranteed.
|
23696
|
+
#
|
23093
23697
|
# @param opts [Hash] Additional options.
|
23094
23698
|
#
|
23095
23699
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
@@ -23156,7 +23760,9 @@ module OvirtSDK4
|
|
23156
23760
|
private_constant :LIST
|
23157
23761
|
|
23158
23762
|
#
|
23159
|
-
# Returns the
|
23763
|
+
# Returns the list of disks of the template.
|
23764
|
+
#
|
23765
|
+
# The order of the returned list of disks isn't guaranteed.
|
23160
23766
|
#
|
23161
23767
|
# @param opts [Hash] Additional options.
|
23162
23768
|
#
|
@@ -23332,6 +23938,8 @@ module OvirtSDK4
|
|
23332
23938
|
#
|
23333
23939
|
# Lists all the configured graphics consoles of the template.
|
23334
23940
|
#
|
23941
|
+
# The order of the returned list of graphics consoles isn't guaranteed.
|
23942
|
+
#
|
23335
23943
|
# @param opts [Hash] Additional options.
|
23336
23944
|
#
|
23337
23945
|
# @option opts [Integer] :max Sets the maximum number of consoles to return. If not specified all the consoles are returned.
|
@@ -23533,7 +24141,9 @@ module OvirtSDK4
|
|
23533
24141
|
private_constant :LIST
|
23534
24142
|
|
23535
24143
|
#
|
23536
|
-
# Returns the
|
24144
|
+
# Returns the list of NICs of the template.
|
24145
|
+
#
|
24146
|
+
# The order of the returned list of NICs isn't guaranteed.
|
23537
24147
|
#
|
23538
24148
|
# @param opts [Hash] Additional options.
|
23539
24149
|
#
|
@@ -23736,7 +24346,9 @@ module OvirtSDK4
|
|
23736
24346
|
private_constant :LIST
|
23737
24347
|
|
23738
24348
|
#
|
23739
|
-
# Returns the
|
24349
|
+
# Returns the list of watchdogs.
|
24350
|
+
#
|
24351
|
+
# The order of the returned list of watchdogs isn't guaranteed.
|
23740
24352
|
#
|
23741
24353
|
# @param opts [Hash] Additional options.
|
23742
24354
|
#
|
@@ -23809,7 +24421,9 @@ module OvirtSDK4
|
|
23809
24421
|
#
|
23810
24422
|
# Creates a new template.
|
23811
24423
|
#
|
23812
|
-
# This requires the `name` and `vm` elements.
|
24424
|
+
# This requires the `name` and `vm` elements. To identify the virtual machine use the `vm.id` or `vm.name`
|
24425
|
+
# attributes. For example, to create a template from virtual machine with identifier `123` send a request
|
24426
|
+
# like this:
|
23813
24427
|
#
|
23814
24428
|
# [source]
|
23815
24429
|
# ----
|
@@ -23826,6 +24440,30 @@ module OvirtSDK4
|
|
23826
24440
|
# </template>
|
23827
24441
|
# ----
|
23828
24442
|
#
|
24443
|
+
# The disks of the template can be customized, making some of their characteristics different to the disks of the
|
24444
|
+
# original virtual machine. To do so use the `vm.disk_attachments` attribute, specifying the identifier of the disk
|
24445
|
+
# of the original virtual machine and the characteristics that you want to change. For example, if the original
|
24446
|
+
# virtual machine has a disk with identifier `456`, and, for that disk, you want to change the format to
|
24447
|
+
# <<types/disk_format, _Copy On Write_>> and make the disk <<types/disk, sparse>>, send a request body
|
24448
|
+
# like this:
|
24449
|
+
#
|
24450
|
+
# [source,xml]
|
24451
|
+
# ----
|
24452
|
+
# <template>
|
24453
|
+
# <name>mytemplate</name>
|
24454
|
+
# <vm id="123">
|
24455
|
+
# <disk_attachments>
|
24456
|
+
# <disk_attachment>
|
24457
|
+
# <disk id="456">
|
24458
|
+
# <format>cow</format>
|
24459
|
+
# <sparse>true</sparse>
|
24460
|
+
# </disk>
|
24461
|
+
# </disk_attachment>
|
24462
|
+
# </disk_attachments>
|
24463
|
+
# </vm>
|
24464
|
+
# </template>
|
24465
|
+
# ----
|
24466
|
+
#
|
23829
24467
|
# The template can be created as a sub version of an existing template.This requires the `name` and `vm` attributes
|
23830
24468
|
# for the new template, and the `base_template` and `version_name` attributes for the new template version. The
|
23831
24469
|
# `base_template` and `version_name` attributes must be specified within a `version` section enclosed in the
|
@@ -23918,6 +24556,8 @@ module OvirtSDK4
|
|
23918
24556
|
#
|
23919
24557
|
# Will return the list of virtual machines and virtual machine templates.
|
23920
24558
|
#
|
24559
|
+
# The order of the returned list of templates isn't guaranteed.
|
24560
|
+
#
|
23921
24561
|
# @param opts [Hash] Additional options.
|
23922
24562
|
#
|
23923
24563
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -24071,7 +24711,9 @@ module OvirtSDK4
|
|
24071
24711
|
private_constant :LIST
|
24072
24712
|
|
24073
24713
|
#
|
24074
|
-
# Returns the
|
24714
|
+
# Returns the list of unmanaged networks of the host.
|
24715
|
+
#
|
24716
|
+
# The order of the returned list of networks isn't guaranteed.
|
24075
24717
|
#
|
24076
24718
|
# @param opts [Hash] Additional options.
|
24077
24719
|
#
|
@@ -24410,6 +25052,8 @@ module OvirtSDK4
|
|
24410
25052
|
# </users>
|
24411
25053
|
# ----
|
24412
25054
|
#
|
25055
|
+
# The order of the returned list of users isn't guaranteed.
|
25056
|
+
#
|
24413
25057
|
# @param opts [Hash] Additional options.
|
24414
25058
|
#
|
24415
25059
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -24588,7 +25232,9 @@ module OvirtSDK4
|
|
24588
25232
|
private_constant :LIST
|
24589
25233
|
|
24590
25234
|
#
|
24591
|
-
# Returns the
|
25235
|
+
# Returns the list of networks.
|
25236
|
+
#
|
25237
|
+
# The order of the returned list of networks isn't guaranteed.
|
24592
25238
|
#
|
24593
25239
|
# @param opts [Hash] Additional options.
|
24594
25240
|
#
|
@@ -25826,6 +26472,8 @@ module OvirtSDK4
|
|
25826
26472
|
#
|
25827
26473
|
# Returns a list of applications installed in the virtual machine.
|
25828
26474
|
#
|
26475
|
+
# The order of the returned list of applications isn't guaranteed.
|
26476
|
+
#
|
25829
26477
|
# @param opts [Hash] Additional options.
|
25830
26478
|
#
|
25831
26479
|
# @option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
|
@@ -26058,6 +26706,8 @@ module OvirtSDK4
|
|
26058
26706
|
#
|
26059
26707
|
# Returns the list of CDROM devices of the virtual machine.
|
26060
26708
|
#
|
26709
|
+
# The order of the returned list of CD-ROM devices isn't guaranteed.
|
26710
|
+
#
|
26061
26711
|
# @param opts [Hash] Additional options.
|
26062
26712
|
#
|
26063
26713
|
# @option opts [Integer] :max Sets the maximum number of CDROMs to return. If not specified all the CDROMs are returned.
|
@@ -26377,7 +27027,9 @@ module OvirtSDK4
|
|
26377
27027
|
private_constant :LIST
|
26378
27028
|
|
26379
27029
|
#
|
26380
|
-
# Returns the
|
27030
|
+
# Returns the list of disks of the virtual machine.
|
27031
|
+
#
|
27032
|
+
# The order of the returned list of disks isn't guaranteed.
|
26381
27033
|
#
|
26382
27034
|
# @param opts [Hash] Additional options.
|
26383
27035
|
#
|
@@ -26727,6 +27379,8 @@ module OvirtSDK4
|
|
26727
27379
|
#
|
26728
27380
|
# Lists all the configured graphics consoles of the virtual machine.
|
26729
27381
|
#
|
27382
|
+
# The order of the returned list of graphics consoles isn't guaranteed.
|
27383
|
+
#
|
26730
27384
|
# @param opts [Hash] Additional options.
|
26731
27385
|
#
|
26732
27386
|
# @option opts [Boolean] :current Use the following query to obtain the current run-time configuration of the graphics consoles.
|
@@ -26972,6 +27626,8 @@ module OvirtSDK4
|
|
26972
27626
|
#
|
26973
27627
|
# List the host devices assigned to given virtual machine.
|
26974
27628
|
#
|
27629
|
+
# The order of the returned list of devices isn't guaranteed.
|
27630
|
+
#
|
26975
27631
|
# @param opts [Hash] Additional options.
|
26976
27632
|
#
|
26977
27633
|
# @option opts [Integer] :max Sets the maximum number of devices to return. If not specified all the devices are returned.
|
@@ -27343,7 +27999,9 @@ module OvirtSDK4
|
|
27343
27999
|
private_constant :LIST
|
27344
28000
|
|
27345
28001
|
#
|
27346
|
-
# Returns the
|
28002
|
+
# Returns the list of NICs of the virtual machine.
|
28003
|
+
#
|
28004
|
+
# The order of the returned list of NICs isn't guaranteed.
|
27347
28005
|
#
|
27348
28006
|
# @param opts [Hash] Additional options.
|
27349
28007
|
#
|
@@ -27599,6 +28257,8 @@ module OvirtSDK4
|
|
27599
28257
|
#
|
27600
28258
|
# Lists virtual NUMA nodes of a virtual machine.
|
27601
28259
|
#
|
28260
|
+
# The order of the returned list of NUMA nodes isn't guaranteed.
|
28261
|
+
#
|
27602
28262
|
# @param opts [Hash] Additional options.
|
27603
28263
|
#
|
27604
28264
|
# @option opts [Integer] :max Sets the maximum number of nodes to return. If not specified all the nodes are returned.
|
@@ -27943,6 +28603,9 @@ module OvirtSDK4
|
|
27943
28603
|
# </vm_pools>
|
27944
28604
|
# ----
|
27945
28605
|
#
|
28606
|
+
# The order of the returned list of pools is guaranteed only if the `sortby` clause is included in the
|
28607
|
+
# `search` parameter.
|
28608
|
+
#
|
27946
28609
|
# @param opts [Hash] Additional options.
|
27947
28610
|
#
|
27948
28611
|
# @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
|
@@ -28071,7 +28734,9 @@ module OvirtSDK4
|
|
28071
28734
|
private_constant :LIST
|
28072
28735
|
|
28073
28736
|
#
|
28074
|
-
# Returns the
|
28737
|
+
# Returns the list of reported devices of the virtual machine.
|
28738
|
+
#
|
28739
|
+
# The order of the returned list of devices isn't guaranteed.
|
28075
28740
|
#
|
28076
28741
|
# @param opts [Hash] Additional options.
|
28077
28742
|
#
|
@@ -28219,6 +28884,8 @@ module OvirtSDK4
|
|
28219
28884
|
# </sessions>
|
28220
28885
|
# ----
|
28221
28886
|
#
|
28887
|
+
# The order of the returned list of sessions isn't guaranteed.
|
28888
|
+
#
|
28222
28889
|
# @param opts [Hash] Additional options.
|
28223
28890
|
#
|
28224
28891
|
# @option opts [Integer] :max Sets the maximum number of sessions to return. If not specified all the sessions are returned.
|
@@ -28482,6 +29149,8 @@ module OvirtSDK4
|
|
28482
29149
|
#
|
28483
29150
|
# The list of watchdogs of the virtual machine.
|
28484
29151
|
#
|
29152
|
+
# The order of the returned list of watchdogs isn't guaranteed.
|
29153
|
+
#
|
28485
29154
|
# @param opts [Hash] Additional options.
|
28486
29155
|
#
|
28487
29156
|
# @option opts [Integer] :max Sets the maximum number of watchdogs to return. If not specified all the watchdogs are returned.
|
@@ -28792,7 +29461,10 @@ module OvirtSDK4
|
|
28792
29461
|
private_constant :LIST
|
28793
29462
|
|
28794
29463
|
#
|
28795
|
-
# Returns the
|
29464
|
+
# Returns the list of virtual machines of the system.
|
29465
|
+
#
|
29466
|
+
# The order of the returned list of virtual machines is guaranteed only if the `sortby` clause is included
|
29467
|
+
# in the `search` parameter.
|
28796
29468
|
#
|
28797
29469
|
# @param opts [Hash] Additional options.
|
28798
29470
|
#
|
@@ -29102,6 +29774,8 @@ module OvirtSDK4
|
|
29102
29774
|
#
|
29103
29775
|
# List all vNIC profiles.
|
29104
29776
|
#
|
29777
|
+
# The order of the returned list of vNIC profiles isn't guaranteed.
|
29778
|
+
#
|
29105
29779
|
# @param opts [Hash] Additional options.
|
29106
29780
|
#
|
29107
29781
|
# @option opts [Integer] :max Sets the maximum number of profiles to return. If not specified all the profiles are returned.
|
@@ -29278,7 +29952,9 @@ module OvirtSDK4
|
|
29278
29952
|
private_constant :LIST
|
29279
29953
|
|
29280
29954
|
#
|
29281
|
-
# Returns the
|
29955
|
+
# Returns the list of weights.
|
29956
|
+
#
|
29957
|
+
# The order of the returned list of weights isn't guaranteed.
|
29282
29958
|
#
|
29283
29959
|
# @param opts [Hash] Additional options.
|
29284
29960
|
#
|
@@ -29622,6 +30298,8 @@ module OvirtSDK4
|
|
29622
30298
|
# </katello_errata>
|
29623
30299
|
# ----
|
29624
30300
|
#
|
30301
|
+
# The order of the returned list of erratum isn't guaranteed.
|
30302
|
+
#
|
29625
30303
|
# @param opts [Hash] Additional options.
|
29626
30304
|
#
|
29627
30305
|
# @option opts [Integer] :max Sets the maximum number of errata to return. If not specified all the errata are returned.
|
@@ -29690,7 +30368,28 @@ module OvirtSDK4
|
|
29690
30368
|
private_constant :GET
|
29691
30369
|
|
29692
30370
|
#
|
29693
|
-
#
|
30371
|
+
# Get external host provider information
|
30372
|
+
#
|
30373
|
+
# Host provider, Foreman or Satellite, can be set as an external provider in ovirt. To see details about specific
|
30374
|
+
# host providers attached to ovirt use this API.
|
30375
|
+
#
|
30376
|
+
# For example, to get the details of host provider `123`, send a request like this:
|
30377
|
+
#
|
30378
|
+
# ....
|
30379
|
+
# GET /ovirt-engine/api/externalhostproviders/123
|
30380
|
+
# ....
|
30381
|
+
#
|
30382
|
+
# The response will be like this:
|
30383
|
+
#
|
30384
|
+
# [source,xml]
|
30385
|
+
# ----
|
30386
|
+
# <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123">
|
30387
|
+
# <name>mysatellite</name>
|
30388
|
+
# <requires_authentication>true</requires_authentication>
|
30389
|
+
# <url>https://mysatellite.example.com</url>
|
30390
|
+
# <username>admin</username>
|
30391
|
+
# </external_host_provider>
|
30392
|
+
# ----
|
29694
30393
|
#
|
29695
30394
|
# @param opts [Hash] Additional options.
|
29696
30395
|
#
|
@@ -29755,7 +30454,13 @@ module OvirtSDK4
|
|
29755
30454
|
end
|
29756
30455
|
|
29757
30456
|
#
|
29758
|
-
#
|
30457
|
+
# In order to test connectivity for external provider we need
|
30458
|
+
# to run following request where 123 is an id of a provider.
|
30459
|
+
#
|
30460
|
+
# [source]
|
30461
|
+
# ----
|
30462
|
+
# POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
|
30463
|
+
# ----
|
29759
30464
|
#
|
29760
30465
|
# @param opts [Hash] Additional options.
|
29761
30466
|
#
|
@@ -29804,7 +30509,7 @@ module OvirtSDK4
|
|
29804
30509
|
end
|
29805
30510
|
|
29806
30511
|
#
|
29807
|
-
#
|
30512
|
+
# A service to view certificates for this external provider.
|
29808
30513
|
#
|
29809
30514
|
# @return [ExternalProviderCertificatesService] A reference to `certificates` service.
|
29810
30515
|
#
|
@@ -30583,7 +31288,9 @@ module OvirtSDK4
|
|
30583
31288
|
#
|
30584
31289
|
# @option opts [Boolean] :async Indicates if the approval should be performed asynchronously.
|
30585
31290
|
#
|
30586
|
-
# @option opts [Cluster] :cluster
|
31291
|
+
# @option opts [Cluster] :cluster Cluster where the host will be added after approving it.
|
31292
|
+
#
|
31293
|
+
# @option opts [Host] :host Host to approve.
|
30587
31294
|
#
|
30588
31295
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|
30589
31296
|
#
|
@@ -30767,6 +31474,7 @@ module OvirtSDK4
|
|
30767
31474
|
end
|
30768
31475
|
|
30769
31476
|
GET = [
|
31477
|
+
[:all_content, TrueClass].freeze,
|
30770
31478
|
[:filter, TrueClass].freeze,
|
30771
31479
|
].freeze
|
30772
31480
|
|
@@ -30775,8 +31483,29 @@ module OvirtSDK4
|
|
30775
31483
|
#
|
30776
31484
|
# Get the host details.
|
30777
31485
|
#
|
31486
|
+
# [source]
|
31487
|
+
# ----
|
31488
|
+
# GET /ovirt-engine/api/hosts/123
|
31489
|
+
# ----
|
31490
|
+
#
|
30778
31491
|
# @param opts [Hash] Additional options.
|
30779
31492
|
#
|
31493
|
+
# @option opts [Boolean] :all_content Indicates if all of the attributes of the host should be included in the response.
|
31494
|
+
#
|
31495
|
+
# By default the following attributes are excluded:
|
31496
|
+
#
|
31497
|
+
# - `hosted_engine`
|
31498
|
+
#
|
31499
|
+
# For example, to retrieve the complete representation of host '123':
|
31500
|
+
#
|
31501
|
+
# ....
|
31502
|
+
# GET /ovirt-engine/api/hosts/123?all_content=true
|
31503
|
+
# ....
|
31504
|
+
#
|
31505
|
+
# NOTE: These attributes are not included by default because retrieving them impacts performance. They are
|
31506
|
+
# seldom used and require additional queries to the database. Use this parameter with caution and only when
|
31507
|
+
# specifically required.
|
31508
|
+
#
|
30780
31509
|
# @option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
|
30781
31510
|
#
|
30782
31511
|
# @option opts [Hash] :headers ({}) Additional HTTP headers.
|