class Fog::OpenStack::Baremetal::Real

Public Class Methods

not_found_class() click to toggle source
# File lib/fog/openstack/baremetal.rb, line 250
def self.not_found_class
  Fog::OpenStack::Baremetal::NotFound
end

Public Instance Methods

create_chassis(attributes) click to toggle source

Create a new chassis

Attributes ===

description = Free text description of the chassis extra = Record arbitrary key/value metadata. Can be specified multiple times

# File lib/fog/openstack/baremetal/requests/create_chassis.rb, line 10
def create_chassis(attributes)
  desired_options = [
    :description,
    :extra
  ]

  # Filter only allowed creation attributes
  data = attributes.select { |key, _value| desired_options.include?(key.to_sym) }

  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 201],
    :method  => 'POST',
    :path    => 'chassis'
  )
end
create_node(attributes) click to toggle source

Create a new node

Attributes ===

chassis_uuid = UUID of the chassis that this node belongs to driver = Driver used to control the node [REQUIRED] driver_info = Key/value pairs used by the driver, such as out-of-band management credentials. Can be

specified multiple times

extra = Record arbitrary key/value metadata. Can be specified multiple times uuid = Unique UUID for the node properties = Key/value pairs describing the physical characteristics of the node. This is exported to

Nova and used by the scheduler. Can be specified multiple times
# File lib/fog/openstack/baremetal/requests/create_node.rb, line 16
def create_node(attributes)
  desired_options = [
    :chassis_uuid,
    :driver,
    :driver_info,
    :extra,
    :uuid,
    :properties
  ]

  # Filter only allowed creation attributes
  data = attributes.select { |key, _value| desired_options.include?(key.to_sym) }

  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 201],
    :method  => 'POST',
    :path    => 'nodes'
  )
end
create_port(attributes) click to toggle source

Create a new port

Attributes ===

address = MAC Address for this port extra = Record arbitrary key/value metadata. Can be specified multiple times node_uuid = UUID of the node that this port belongs to

# File lib/fog/openstack/baremetal/requests/create_port.rb, line 11
def create_port(attributes)
  desired_options = [
    :address,
    :extra,
    :node_uuid
  ]

  # Filter only allowed creation attributes
  data = attributes.select { |key, _value| desired_options.include?(key.to_sym) }

  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 201],
    :method  => 'POST',
    :path    => 'ports'
  )
end
default_service_type() click to toggle source
# File lib/fog/openstack/baremetal.rb, line 254
def default_service_type
  %w[baremetal]
end
delete_chassis(chassis_uuid) click to toggle source
# File lib/fog/openstack/baremetal/requests/delete_chassis.rb, line 5
def delete_chassis(chassis_uuid)
  data = {:chassis_uuid => chassis_uuid}
  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 204],
    :method  => 'DELETE',
    :path    => 'chassis'
  )
end
delete_node(node_uuid) click to toggle source
# File lib/fog/openstack/baremetal/requests/delete_node.rb, line 5
def delete_node(node_uuid)
  data = {:node_ident => node_uuid}
  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 204],
    :method  => 'DELETE',
    :path    => 'nodes'
  )
end
delete_port(port_uuid) click to toggle source
# File lib/fog/openstack/baremetal/requests/delete_port.rb, line 5
def delete_port(port_uuid)
  data = {:port_uuid => port_uuid}
  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 204],
    :method  => 'DELETE',
    :path    => 'ports'
  )
end
get_chassis(chassis_uuid) click to toggle source
# File lib/fog/openstack/baremetal/requests/get_chassis.rb, line 5
def get_chassis(chassis_uuid)
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => "chassis/#{chassis_uuid}"
  )
end
get_driver(driver_name) click to toggle source
# File lib/fog/openstack/baremetal/requests/get_driver.rb, line 5
def get_driver(driver_name)
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => "drivers/#{driver_name}"
  )
end
get_driver_properties(driver_name) click to toggle source
# File lib/fog/openstack/baremetal/requests/get_driver_properties.rb, line 5
def get_driver_properties(driver_name)
  data = {:driver_name => driver_name}
  request(
    :body    => Fog::JSON.encode(data),
    :expects => [200, 204],
    :method  => 'GET',
    :path    => "drivers/properties"
  )
end
get_node(node_id) click to toggle source
# File lib/fog/openstack/baremetal/requests/get_node.rb, line 5
def get_node(node_id)
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => "nodes/#{node_id}"
  )
end
get_port(port_id) click to toggle source
# File lib/fog/openstack/baremetal/requests/get_port.rb, line 5
def get_port(port_id)
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => "ports/#{port_id}"
  )
end
list_chassis(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_chassis.rb, line 5
def list_chassis(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'chassis',
    :query   => options
  )
end
list_chassis_detailed(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_chassis_detailed.rb, line 5
def list_chassis_detailed(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'chassis/detail',
    :query   => options
  )
end
list_drivers(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_drivers.rb, line 5
def list_drivers(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'drivers',
    :query   => options
  )
end
list_nodes(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_nodes.rb, line 5
def list_nodes(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'nodes',
    :query   => options
  )
end
list_nodes_detailed(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_nodes_detailed.rb, line 5
def list_nodes_detailed(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'nodes/detail',
    :query   => options
  )
end
list_ports(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_ports.rb, line 5
def list_ports(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'ports',
    :query   => options
  )
end
list_ports_detailed(options = {}) click to toggle source
# File lib/fog/openstack/baremetal/requests/list_ports_detailed.rb, line 5
def list_ports_detailed(options = {})
  request(
    :expects => [200, 204],
    :method  => 'GET',
    :path    => 'ports/detail',
    :query   => options
  )
end
patch_chassis(chassis_uuid, patch) click to toggle source

Patch a chassis

parameter example:

{:op=> 'replace', :path => “/extra/placement”, :value => “somewhere”}

Patch parameter, list of jsonpatch ===

op = Operations: 'add', 'replace' or 'remove' path = Attributes to add/replace or remove (only PATH is necessary on remove),

e.g. /extra/placement

value = Value to set

# File lib/fog/openstack/baremetal/requests/patch_chassis.rb, line 15
def patch_chassis(chassis_uuid, patch)
  request(
    :body    => Fog::JSON.encode(patch),
    :expects => 200,
    :method  => 'PATCH',
    :path    => "chassis/#{chassis_uuid}"
  )
end
patch_node(node_uuid, patch) click to toggle source

Patch a node

parameter example:

{:op=> 'replace', :path => “/driver”, :value => “pxe_ssh”}

Patch parameter, list of jsonpatch ===

op = Operations: 'add', 'replace' or 'remove' path = Attributes to add/replace or remove (only PATH is necessary on remove),

e.g. /driver_info/ipmi_address

value = Value to set

# File lib/fog/openstack/baremetal/requests/patch_node.rb, line 15
def patch_node(node_uuid, patch)
  request(
    :body    => Fog::JSON.encode(patch),
    :expects => 200,
    :method  => 'PATCH',
    :path    => "nodes/#{node_uuid}"
  )
end
patch_port(port_uuid, patch) click to toggle source

Patch a port

parameter example:

{:op=> 'replace', :path => “/driver_info/ipmi_address”, :value => “192.0.2.1”}

Patch parameter, list of jsonpatch ===

op = Operations: 'add', 'replace' or 'remove' path = Attributes to add/replace or remove (only PATH is necessary on remove),

e.g. /driver_info/ipmi_address

value = Value to set

# File lib/fog/openstack/baremetal/requests/patch_port.rb, line 15
def patch_port(port_uuid, patch)
  request(
    :body    => Fog::JSON.encode(patch),
    :expects => 200,
    :method  => 'PATCH',
    :path    => "ports/#{port_uuid}"
  )
end
set_node_maintenance(node_uuid, parameters = nil) click to toggle source
# File lib/fog/openstack/baremetal/requests/set_node_maintenance.rb, line 5
def set_node_maintenance(node_uuid, parameters = nil)
  request(
    :expects => [200, 202, 204],
    :method  => 'PUT',
    :path    => "nodes/#{node_uuid}/maintenance",
    :query   => parameters
  )
end
set_node_power_state(node_id, power_state) click to toggle source
# File lib/fog/openstack/baremetal/requests/set_node_power_state.rb, line 5
def set_node_power_state(node_id, power_state)
  data = {
    'target' => power_state
  }

  request(
    :body    => Fog::JSON.encode(data),
    :expects => 202,
    :method  => 'PUT',
    :path    => "nodes/#{node_id}/states/power"
  )
end
set_node_provision_state(node_id, provision_state) click to toggle source
# File lib/fog/openstack/baremetal/requests/set_node_provision_state.rb, line 5
def set_node_provision_state(node_id, provision_state)
  data = {
    'target' => provision_state
  }

  request(
    :body    => Fog::JSON.encode(data),
    :expects => 202,
    :method  => 'PUT',
    :path    => "nodes/#{node_id}/states/provision",
    :headers => {
      :'X-OpenStack-Ironic-API-Version' => 'latest'
    }
  )
end
unset_node_maintenance(node_uuid, parameters = nil) click to toggle source
# File lib/fog/openstack/baremetal/requests/unset_node_maintenance.rb, line 5
def unset_node_maintenance(node_uuid, parameters = nil)
  request(
    :expects => [200, 202, 204],
    :method  => 'DELETE',
    :path    => "nodes/#{node_uuid}/maintenance",
    :query   => parameters
  )
end