class OvirtSDK4::DataCentersService

Constants

ADD
LIST

Public Instance Methods

add(data_center, opts = {}) click to toggle source

Creates a new data center.

Creation of a new data center requires the `name` and `local` elements. For example, to create a data center named `mydc` that uses shared storage (NFS, iSCSI or fibre channel) send a request like this:

source

POST /ovirt-engine/api/datacenters


With a request body like this:

source,xml

<data_center>

<name>mydc</name>
<local>false</local>

</data_center>


@param data_center [DataCenter] The data center that is being added.

@param opts [Hash] Additional options.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [DataCenter]

# File lib/ovirtsdk4/services.rb, line 6942
def add(data_center, opts = {})
  internal_add(data_center, DataCenter, ADD, opts)
end
data_center_service(id) click to toggle source

Reference to the service that manages a specific data center.

@param id [String] The identifier of the `data_center`.

@return [DataCenterService] A reference to the `data_center` service.

# File lib/ovirtsdk4/services.rb, line 7055
def data_center_service(id)
  DataCenterService.new(self, id)
end
list(opts = {}) click to toggle source

Lists the data centers.

The following request retrieves a representation of the data centers:

source

GET /ovirt-engine/api/datacenters


The above request performed with `curl`:

source,bash

curl \ –request GET \ –cacert /etc/pki/ovirt-engine/ca.pem \ –header “Version: 4” \ –header “Accept: application/xml” \ –user “admin@internal:mypassword” \ myengine.example.com/ovirt-engine/api/datacenters


This is what an example response could look like:

source,xml

<data_center href=“/ovirt-engine/api/datacenters/123” id=“123”>

<name>Default</name>
<description>The default Data Center</description>
<link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
<link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
<link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
<link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
<link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
<link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
<link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
<local>false</local>
<quota_mode>disabled</quota_mode>
<status>up</status>
<supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
</supported_versions>
<version>
  <major>4</major>
  <minor>0</minor>
</version>

</data_center>


Note the `id` code of your `Default` data center. This code identifies this data center in relation to other resources of your virtual environment.

The data center also contains a link to the storage domains collection. The data center uses this collection to attach storage domains from the storage domains main collection.

The order of the returned list of data centers is guaranteed only if the `sortby` clause is included in the `search` parameter.

@param opts [Hash] Additional options.

@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into

account. The default value is `true`, which means that case is taken into account. If you want to search
ignoring case set it to `false`.

@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Integer] :max Sets the maximum number of data centers to return. If not specified all the data centers are returned.

@option opts [String] :search A query string used to restrict the returned data centers.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [Array<DataCenter>]

# File lib/ovirtsdk4/services.rb, line 7044
def list(opts = {})
  internal_get(LIST, opts)
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 7066
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return data_center_service(path)
  end
  return data_center_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end