Class: HCloud::Network

Inherits:
Resource show all
Defined in:
lib/hcloud/resources/network.rb

Overview

Represents a network

List all networks

HCloud::Network.all
# => [#<HCloud::Network id: 1, ...>, ...]

Search networks

HCloud::Network.where(name: "my_network")
# => #<HCloud::Network id: 1, ...>

HCloud::Network.where(label_selector: "environment=production")
# => #<HCloud::Network id: 1, ...>

Find network by ID

HCloud::Network.find(1)
# => #<HCloud::Network id: 1, ...>

Create network

network = HCloud::Network.new(name: "my_network", ip_range: "10.0.0.0/16")
network.create
network.created?
# => true

network = HCloud::Network.create(name: "my_network", ip_range: "10.0.0.0/16")
# => #<HCloud::Network id: 1, ...>

Update network

network = HCloud::Network.find(1)
network.name = "another_network"
network.update

Delete network

network = HCloud::Network.find(1)
network.delete
network.deleted?
# => true

List network members

HCloud::Network.find(1).members
# => [#<HCloud::NetworkMember type: "server", id: 1, ...>, ...]

Sort network members

HCloud::Network.find(1).members.sort(ip: :asc)
# => [#<HCloud::NetworkMember type: "server", id: 1, ...>, ...]

Search network members

HCloud::Network.find(1).members.where(type: "load_balancer", status: "ok")
# => [#<HCloud::NetworkMember type: "load_balancer", id: 1, ...>, ...]

Get the attached resource of a network member

HCloud::Network.find(1).members.first.resource
# => #<HCloud::Server id: 1, ...>

Actions

List actions

actions = HCloud::Network.find(1).actions
# => [#<HCloud::Action id: 1, ...>, ...]

Sort actions

HCloud::Network.find(1).actions.sort(finished: :desc)
# => [#<HCloud::Action id: 1, ...>, ...]

HCloud::Network.find(1).actions.sort(:command, finished: :asc)
# => [#<HCloud::Actions id: 1, ...>, ...]

Search actions

HCloud::Network.find(1).actions.where(command: "assign_floating_ip")
# => #<HCloud::Action id: 1, ...>

HCloud::Network.find(1).actions.where(status: "success")
# => #<HCloud::Action id: 1, ...>

Find action by ID

HCloud::Network.find(1).actions.find(1)
# => #<HCloud::Action id: 1, ...>

Resource-specific actions

Change protection

HCloud::Network.find(1).change_protection(delete: true)
# => #<HCloud::Action id: 1, ...>

Add a route

HCloud::Network.find(1).add_route(destination: "10.100.1.0/24", gateway: "10.0.1.1")
# => #<HCloud::Action id: 1, ...>

Add a subnet

HCloud::Network.find(1).add_subnet(ip_range: "10.0.1.0/24", network_zone: "eu-central", type: "cloud")
# => #<HCloud::Action id: 1, ...>

Change the IP range

HCloud::Network.find(1).change_ip_range(ip_range: "10.0.0.0/15")
# => #<HCloud::Action id: 1, ...>

Delete a route

HCloud::Network.find(1).delete_route(destination: "10.100.1.0/24", gateway: "10.0.1.1")
# => #<HCloud::Action id: 1, ...>

Delete a subnet

HCloud::Network.find(1).delete_subnet(ip_range: "10.0.1.0/24", network_zone: "eu-central", type: "cloud")
# => #<HCloud::Action id: 1, ...>

Instance Method Summary collapse

Methods inherited from Resource

#==, client, #initialize, #mutable?, resource_name, #to_h

Constructor Details

This class inherits a constructor from HCloud::Resource

Instance Method Details

#creatable_attributes ⇒ Object



176
177
178
# File 'lib/hcloud/resources/network.rb', line 176

def creatable_attributes
  [:name, :labels, :ip_range, :expose_routes_to_vswitch, :routes, :subnets]
end

#members ⇒ Object



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/hcloud/resources/network.rb', line 158

def members
  raise Errors::MissingIDError unless id

  Collection.new do |params|
    response = client
      .get("#{resource_path}/#{id}/members", params)

    data = response
      .fetch(:members)
      .map { |attrs| NetworkMember.new attrs }

    meta = response
      .fetch(:meta)

    [data, meta]
  end
end

#updatable_attributes ⇒ Object



180
181
182
# File 'lib/hcloud/resources/network.rb', line 180

def updatable_attributes
  [:name, :expose_routes_to_vswitch, :labels]
end