class OvirtSDK4::NetworksService
Constants
- ADD
- LIST
Public Instance Methods
Creates a new logical network, or associates an existing network with a data center.
Creation of a new network requires the `name` and `data_center` elements.
For example, to create a network named `mynetwork` for data center `123` send a request like this:
- source
POST /ovirt-engine/api/networks
With a request body like this:
- source,xml
<network>
<name>mynetwork</name> <data_center id="123"/>
</network>
To associate the existing network `456` with the data center `123` send a request like this:
- source
POST /ovirt-engine/api/datacenters/123/networks
With a request body like this:
- source,xml
<network>
<name>ovirtmgmt</name>
</network>
To create a network named `exnetwork` on top of an external OpenStack network provider `456` send a request like this:
- source
POST /ovirt-engine/api/networks
- source,xml
<network>
<name>exnetwork</name> <external_provider id="456"/> <data_center id="123"/>
</network>
@param network [Network] The `network` to add.
@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 [Network]
# File lib/ovirtsdk4/services.rb, line 16663 def add(network, opts = {}) internal_add(network, Network, ADD, opts) end
List
logical networks.
For example:
- source
GET /ovirt-engine/api/networks
Will respond:
- source,xml
<networks>
<network href="/ovirt-engine/api/networks/123" id="123"> <name>ovirtmgmt</name> <description>Default Management Network</description> <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/> <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/> <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/> <mtu>0</mtu> <stp>false</stp> <usages> <usage>vm</usage> </usages> <data_center href="/ovirt-engine/api/datacenters/456" id="456"/> </network> ...
</networks>
The order of the returned list of networks 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 [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 networks to return. If not specified all the networks are returned.
@option opts [String] :search A query string used to restrict the returned networks.
@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<Network>]
# File lib/ovirtsdk4/services.rb, line 16735 def list(opts = {}) internal_get(LIST, opts) end
Reference to the service that manages a specific network.
@param id [String] The identifier of the `network`.
@return [NetworkService] A reference to the `network` service.
# File lib/ovirtsdk4/services.rb, line 16746 def network_service(id) NetworkService.new(self, id) end
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 16757 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return network_service(path) end return network_service(path[0..(index - 1)]).service(path[(index + 1)..-1]) end