Class: HCloud::PrimaryIP

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

Overview

Represents a primary IP

List all primary IPs

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

Sort primary IPs

HCloud::PrimaryIP.sort(id: :asc)
# => [#<HCloud::PrimaryIP id: 1, ...>, ...]

HCloud::PrimaryIP.sort(:id, created: :asc)
# => [#<HCloud::PrimaryIP id: 1, ...>, ...]

Search primary IPs

HCloud::PrimaryIP.where(name: "my_primary_ip")
# => #<HCloud::PrimaryIP id: 1, ...>

HCloud::PrimaryIP.where(ip: "1.2.3.4")
# => #<HCloud::PrimaryIP id: 1, ...>

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

Find primary IP by ID

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

Create primary IP

primary IP = HCloud::PrimaryIP.new(name: "my_primary_ip", type: "ipv4", datacenter: "fsn1-dc8")
primary IP.create
primary IP.created?
# => true

firewall = HCloud::PrimaryIP.create(name: "my_primary_ip")
# => #<HCloud::PrimaryIP id: 1, ...>

Update primary IP

primary IP = HCloud::PrimaryIP.find(1)
primary IP.name = "another_primary_ip"
primary IP.update

Delete primary IP

primary IP = HCloud::PrimaryIP.find(1)
primary IP.delete
primary IP.deleted?
# => true

Actions

List actions

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

Sort actions

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

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

Search actions

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

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

Find action by ID

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

Resource-specific actions

Assign a primary IP to a server

HCloud::PrimaryIP.find(1).assign(assignee_id: 1, assignee_type: "server")
# => #<HCloud::Action id: 1, ...>

Unassign a primary IP from a server

HCloud::PrimaryIP.find(1).unassign
# => #<HCloud::Action id: 1, ...>

Change reverse DNS entry

HCloud::PrimaryIP.find(1).change_dns_ptr(dns_ptr: "server.example.com", ip: "1.2.3.4")
# => #<HCloud::Action id: 1, ...>

Change protection

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

Instance Method Summary collapse

Methods inherited from Resource

#==, attribute, client, #initialize, #inspect, resource_name, #to_h

Constructor Details

This class inherits a constructor from HCloud::Resource

Instance Method Details

#creatable_attributes ⇒ Object 



142
143
144
 
# File 'lib/hcloud/resources/primary_ip.rb', line 142

def creatable_attributes
  [:name, :type, :assignee_id, :assignee_type, :auto_delete, :labels, datacenter: [:id, :name]]
end

#updatable_attributes ⇒ Object 



146
147
148
 
# File 'lib/hcloud/resources/primary_ip.rb', line 146

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