class OvirtSDK4::NetworkService

Gets a logical network.

For example:

“`http GET /ovirt-engine/api/networks/123 HTTP/1.1 “`

Will respond:

“`xml <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> “`

@param opts [Hash] Additional options.

@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 [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 15697
def get(opts = {})
  internal_get(GET, opts)
end

Reference to the service that manages the network labels assigned to this network.

@return [NetworkLabelsService] A reference to `network_labels` service.

# File lib/ovirtsdk4/services.rb, line 15818
def network_labels_service
  @network_labels_service ||= NetworkLabelsService.new(self, 'networklabels')
end

Reference to the service that manages the permissions assigned to this network.

@return [AssignedPermissionsService] A reference to `permissions` service.

# File lib/ovirtsdk4/services.rb, line 15827
def permissions_service
  @permissions_service ||= AssignedPermissionsService.new(self, 'permissions')
end

Removes a logical network, or the association of a logical network to a data center.

For example, to remove the logical network `123` send a request like this:

“`http DELETE /ovirt-engine/api/networks/123 HTTP/1.1 “`

Each network is bound exactly to one data center. So if we disassociate network with data center it has the same result as if we would just remove that network. However it might be more specific to say we're removing network `456` of data center `123`.

For example, to remove the association of network `456` to data center `123` send a request like this:

“`http DELETE /ovirt-engine/api/datacenters/123/networks/456 HTTP/1.1 “`

NOTE: To remove an external logical network, the network has to be removed directly from its provider by https://developer.openstack.org/api-ref/network[OpenStack Networking API]. The entity representing the external network inside {product-name} is removed automatically, if xref:types/open_stack_network_provider/attributes/auto_sync is enabled for the provider, otherwise the entity has to be removed using this method.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @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.

# File lib/ovirtsdk4/services.rb, line 15744
def remove(opts = {})
  internal_remove(REMOVE, opts)
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 15847
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'networklabels'
    return network_labels_service
  end
  if path.start_with?('networklabels/')
    return network_labels_service.service(path[14..-1])
  end
  if path == 'permissions'
    return permissions_service
  end
  if path.start_with?('permissions/')
    return permissions_service.service(path[12..-1])
  end
  if path == 'vnicprofiles'
    return vnic_profiles_service
  end
  if path.start_with?('vnicprofiles/')
    return vnic_profiles_service.service(path[13..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end

Updates a logical network.

The `name`, `description`, `ip`, `vlan`, `stp` and `display` attributes can be updated.

For example, to update the description of the logical network `123` send a request like this:

“`http PUT /ovirt-engine/api/networks/123 HTTP/1.1 “`

With a request body like this:

“`xml <network>

<description>My updated description</description>

</network> “`

The maximum transmission unit of a network is set using a PUT request to specify the integer value of the `mtu` attribute.

For example, to set the maximum transmission unit send a request like this:

“`http PUT /ovirt-engine/api/datacenters/123/networks/456 HTTP/1.1 “`

With a request body like this:

“`xml <network>

<mtu>1500</mtu>

</network> “`

NOTE: Updating external networks is not propagated to the provider.

@param network [Network] The `network` to update. @param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@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 15809
def update(network, opts = {})
  internal_update(network, Network, UPDATE, opts)
end

Reference to the service that manages the vNIC profiles assigned to this network.

@return [AssignedVnicProfilesService] A reference to `vnic_profiles` service.

# File lib/ovirtsdk4/services.rb, line 15836
def vnic_profiles_service
  @vnic_profiles_service ||= AssignedVnicProfilesService.new(self, 'vnicprofiles')
end