In Files

Parent

Methods

Class/Module Index [+]

Quicksearch

Fog::Compute::Brightbox::Real

The Real Service actually makes real connections to the Brightbox service.

Public Instance Methods

activate_console_server(identifier) click to toggle source

Enable console access via VNC to the server for 15 minutes.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_activate_console_server

# File lib/fog/brightbox/requests/compute/activate_console_server.rb, line 13
def activate_console_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/servers/#{identifier}/activate_console", [202])
end
add_listeners_load_balancer(identifier, options) click to toggle source

Adds a number of listeners to the load balancer to enable balancing across nodes for those settings.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array] :listeners Array of Listener parameters. Timeout is optional and specified in milliseconds.

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#load_balancer_add_listeners_load_balancer

# File lib/fog/brightbox/requests/compute/add_listeners_load_balancer.rb, line 15
def add_listeners_load_balancer(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/load_balancers/#{identifier}/add_listeners", [202], options)
end
add_nodes_load_balancer(identifier, options) click to toggle source

Add a number of nodes to the load balancer

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array] :nodes Array of Node parameters

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#load_balancer_add_nodes_load_balancer

# File lib/fog/brightbox/requests/compute/add_nodes_load_balancer.rb, line 15
def add_nodes_load_balancer(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/load_balancers/#{identifier}/add_nodes", [202], options)
end
add_servers_server_group(identifier, options) click to toggle source

Add a number of servers to the server group.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array<Hash>] :servers Array of Hashes containing `{"server" => server_id}` for each server to add

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_group_add_servers_server_group

@example

Compute[:brightbox].add_servers_server_group "grp-12345", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}]
# File lib/fog/brightbox/requests/compute/add_servers_server_group.rb, line 18
def add_servers_server_group(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/server_groups/#{identifier}/add_servers", [202], options)
end
apply_to_firewall_policy(identifier, options) click to toggle source

Applies firewall policy to given server group

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :server_group Server Group to apply to

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#firewall_policy_apply_to_firewall_policy

# File lib/fog/brightbox/requests/compute/apply_to_firewall_policy.rb, line 15
def apply_to_firewall_policy(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/firewall_policies/#{identifier}/apply_to", [202], options)
end
create_api_client(options) click to toggle source

Create a new API client for the account.

@param [Hash] options @option options [String] :name @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#api_client_create_api_client

# File lib/fog/brightbox/requests/compute/create_api_client.rb, line 15
def create_api_client(options)
  wrapped_request("post", "/1.0/api_clients", [201], options)
end
create_application(options) click to toggle source

Create a new application for the user.

@param [Hash] options @option options [String] :name @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#application_create_application

# File lib/fog/brightbox/requests/compute/create_application.rb, line 15
def create_application(options)
  wrapped_request("post", "/1.0/applications", [201], options)
end
create_cloud_ip(options = {}) click to toggle source

Requests a new cloud IP address for the account.

@param [Hash] options @option options [String] :reverse_dns Reverse DNS hostname @option options [String] :name Name for Cloud IP @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening.

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#cloud_ip_create_cloud_ip

# File lib/fog/brightbox/requests/compute/create_cloud_ip.rb, line 16
def create_cloud_ip(options = {})
  wrapped_request("post", "/1.0/cloud_ips", [201], options)
end
create_firewall_policy(options) click to toggle source

Create a new firewall policy for the account.

Optionally applying to a server group at creation time.

@param [Hash] options @option options [String] :server_group @option options [String] :name Editable label @option options [String] :description Longer editable description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#firewall_policy_create_firewall_policy

# File lib/fog/brightbox/requests/compute/create_firewall_policy.rb, line 18
def create_firewall_policy(options)
  wrapped_request("post", "/1.0/firewall_policies", [201], options)
end
create_firewall_rule(options) click to toggle source

Create a new firewall rule for a firewall policy.

@param [Hash] options @option options [String] :firewall_policy @option options [String] :protocol @option options [String] :source Required unless destination is set. @option options [String] :source_port @option options [String] :destination Required unless source is set @option options [String] :destination_port @option options [String] :icmp_type_name @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#firewall_rule_create_firewall_rule

# File lib/fog/brightbox/requests/compute/create_firewall_rule.rb, line 21
def create_firewall_rule(options)
  wrapped_request("post", "/1.0/firewall_rules", [202], options)
end
create_image(options) click to toggle source

Create a new image for the account by registering it against an image stored within the Brightbox cloud image library.

The disk image must be in place before you can attempt to create a reference in the API.

@param [Hash] options @option options [String] :source Filename of the image file uploaded to /incoming via FTP @option options [String] :arch OS architecture this image is built for @option options [String] :name Name for this image. If no name is specified, a name will be autogenerated based on the source filename &amp; current time. Can be modified later. @option options [String] :username Username for the image @option options [Boolean] :public @option options [Boolean] :compatibility_mode @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#image_create_image

# File lib/fog/brightbox/requests/compute/create_image.rb, line 22
def create_image(options)
  wrapped_request("post", "/1.0/images", [201], options)
end
create_load_balancer(options) click to toggle source

Create a new load balancer for the account.

@param [Hash] options @option options [String] :name Editable label @option options [Array] :nodes Array of Node parameters @option options [String] :policy Method of Load balancing to use @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000). @option options [String] :healthcheck Healthcheck options - only "port" and "type" required

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#load_balancer_create_load_balancer

# File lib/fog/brightbox/requests/compute/create_load_balancer.rb, line 18
def create_load_balancer(options)
  wrapped_request("post", "/1.0/load_balancers", [202], options)
end
create_server(options) click to toggle source

Create a new server for the account based on the required disk image.

Optionally can setup the type of server, zone to locate it, groups to join and custom metadata.

@param [Hash] options @option options [String] :image @option options [String] :name Editable label @option options [String] :server_type @option options [String] :zone Zone in which to create new Server @option options [String] :user_data @option options [Array] :server_groups Array of server groups to add server to

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_create_server

# File lib/fog/brightbox/requests/compute/create_server.rb, line 21
def create_server(options)
  wrapped_request("post", "/1.0/servers", [202], options)
end
create_server_group(options) click to toggle source

Create a new server group for the account.

@param [Hash] options @option options [String] :name Editable user label @option options [String] :description Editable user description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_group_create_server_group

# File lib/fog/brightbox/requests/compute/create_server_group.rb, line 15
def create_server_group(options)
  wrapped_request("post", "/1.0/server_groups", [202], options)
end
destroy_api_client(identifier) click to toggle source

Destroy the API client.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#api_client_destroy_api_client

# File lib/fog/brightbox/requests/compute/destroy_api_client.rb, line 13
def destroy_api_client(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/api_clients/#{identifier}", [200])
end
destroy_application(identifier) click to toggle source

Destroy the application.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#application_destroy_application

# File lib/fog/brightbox/requests/compute/destroy_application.rb, line 13
def destroy_application(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/applications/#{identifier}", [200])
end
destroy_cloud_ip(identifier) click to toggle source

Release the cloud IP address from the account's ownership.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#cloud_ip_destroy_cloud_ip

# File lib/fog/brightbox/requests/compute/destroy_cloud_ip.rb, line 13
def destroy_cloud_ip(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/cloud_ips/#{identifier}", [200])
end
destroy_firewall_policy(identifier) click to toggle source

Destroy the firewall policy if not in use.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#firewall_policy_destroy_firewall_policy

# File lib/fog/brightbox/requests/compute/destroy_firewall_policy.rb, line 13
def destroy_firewall_policy(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/firewall_policies/#{identifier}", [202])
end
destroy_firewall_rule(identifier) click to toggle source

Destroy the firewall rule.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#firewall_rule_destroy_firewall_rule

# File lib/fog/brightbox/requests/compute/destroy_firewall_rule.rb, line 13
def destroy_firewall_rule(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/firewall_rules/#{identifier}", [202])
end
destroy_image(identifier) click to toggle source

Destroy the image.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#image_destroy_image

# File lib/fog/brightbox/requests/compute/destroy_image.rb, line 13
def destroy_image(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/images/#{identifier}", [202])
end
destroy_load_balancer(identifier) click to toggle source

Destroy the LoadBalancer

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#load_balancer_destroy_load_balancer

# File lib/fog/brightbox/requests/compute/destroy_load_balancer.rb, line 13
def destroy_load_balancer(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/load_balancers/#{identifier}", [202])
end
destroy_server(identifier) click to toggle source

Destroy the server and free up the resources.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_destroy_server

# File lib/fog/brightbox/requests/compute/destroy_server.rb, line 13
def destroy_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/servers/#{identifier}", [202])
end
destroy_server_group(identifier) click to toggle source

Destroy the server group if not in use.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_group_destroy_server_group

# File lib/fog/brightbox/requests/compute/destroy_server_group.rb, line 13
def destroy_server_group(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("delete", "/1.0/server_groups/#{identifier}", [202])
end
get_account(identifier = nil) click to toggle source

Get full details of the account.

@overload get_account(identifier)

@param [String] identifier Unique reference to identify the resource

@overload get_account()

@deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#account_get_account

# File lib/fog/brightbox/requests/compute/get_account.rb, line 17
def get_account(identifier = nil)
  if identifier.nil? || identifier.empty?
    Fog::Logger.deprecation("get_account() without a parameter is deprecated, use get_scoped_account instead [light_black](#{caller.first})[/]")
    get_scoped_account
  else
    wrapped_request("get", "/1.0/accounts/#{identifier}", [200])
  end
end
get_api_client(identifier) click to toggle source

Get full details of the API client.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#api_client_get_api_client

# File lib/fog/brightbox/requests/compute/get_api_client.rb, line 13
def get_api_client(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/api_clients/#{identifier}", [200])
end
get_application(identifier) click to toggle source

Get full details of the application.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#application_get_application

# File lib/fog/brightbox/requests/compute/get_application.rb, line 13
def get_application(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/applications/#{identifier}", [200])
end
get_authenticated_user() click to toggle source

Requests details about authenticated user from the API

@return [Hash] The JSON response parsed to a Hash

# File lib/fog/brightbox/requests/compute/get_authenticated_user.rb, line 9
def get_authenticated_user
  wrapped_request("get", "/1.0/user", [200])
end
get_cloud_ip(identifier) click to toggle source

Get full details of the cloud IP address.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#cloud_ip_get_cloud_ip

# File lib/fog/brightbox/requests/compute/get_cloud_ip.rb, line 13
def get_cloud_ip(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/cloud_ips/#{identifier}", [200])
end
get_firewall_policy(identifier) click to toggle source

Get details of the firewall policy

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#firewall_policy_get_firewall_policy

# File lib/fog/brightbox/requests/compute/get_firewall_policy.rb, line 13
def get_firewall_policy(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/firewall_policies/#{identifier}", [200])
end
get_firewall_rule(identifier) click to toggle source

Get full details of the firewall rule.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#firewall_rule_get_firewall_rule

# File lib/fog/brightbox/requests/compute/get_firewall_rule.rb, line 13
def get_firewall_rule(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/firewall_rules/#{identifier}", [200])
end
get_image(identifier) click to toggle source

Get full details of the image.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#image_get_image

# File lib/fog/brightbox/requests/compute/get_image.rb, line 13
def get_image(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/images/#{identifier}", [200])
end
get_interface(identifier) click to toggle source

Get full details of the interface.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#interface_get_interface

# File lib/fog/brightbox/requests/compute/get_interface.rb, line 13
def get_interface(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/interfaces/#{identifier}", [200])
end
get_load_balancer(identifier) click to toggle source

Get full details of the load balancer.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#load_balancer_get_load_balancer

# File lib/fog/brightbox/requests/compute/get_load_balancer.rb, line 13
def get_load_balancer(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/load_balancers/#{identifier}", [200])
end
get_scoped_account() click to toggle source

Requests details about currently scoped account

@return [Hash] The JSON response parsed to a Hash

# File lib/fog/brightbox/requests/compute/get_scoped_account.rb, line 8
def get_scoped_account
  wrapped_request("get", "/1.0/account", [200])
end
get_server(identifier) click to toggle source

Get full details of the server.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_get_server

# File lib/fog/brightbox/requests/compute/get_server.rb, line 13
def get_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/servers/#{identifier}", [200])
end
get_server_group(identifier) click to toggle source

Get details of the server group.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_group_get_server_group

# File lib/fog/brightbox/requests/compute/get_server_group.rb, line 13
def get_server_group(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/server_groups/#{identifier}", [200])
end
get_server_type(identifier) click to toggle source

Get full details of the server type.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_type_get_server_type

# File lib/fog/brightbox/requests/compute/get_server_type.rb, line 13
def get_server_type(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/server_types/#{identifier}", [200])
end
get_user(identifier = nil) click to toggle source

Get full details of the user.

@overload get_user(identifier)

@param [String] identifier Unique reference to identify the resource

@overload get_user()

@deprecated Use {Fog::Compute::Brightbox::Real#get_authenticated_user} instead

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#user_get_user

# File lib/fog/brightbox/requests/compute/get_user.rb, line 17
def get_user(identifier = nil)
  if identifier.nil? || identifier == ""
    Fog::Logger.deprecation("get_user() without a parameter is deprecated, use get_authenticated_user instead [light_black](#{caller.first})[/]")
    get_authenticated_user
  else
    wrapped_request("get", "/1.0/users/#{identifier}", [200])
  end
end
get_zone(identifier) click to toggle source

Get full details of the zone.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#zone_get_zone

# File lib/fog/brightbox/requests/compute/get_zone.rb, line 13
def get_zone(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("get", "/1.0/zones/#{identifier}", [200])
end
list_accounts() click to toggle source

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#account_list_accounts

# File lib/fog/brightbox/requests/compute/list_accounts.rb, line 10
def list_accounts
  wrapped_request("get", "/1.0/accounts", [200])
end
list_api_clients() click to toggle source

Lists summary details of API clients owned by the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#api_client_list_api_clients

# File lib/fog/brightbox/requests/compute/list_api_clients.rb, line 12
def list_api_clients
  wrapped_request("get", "/1.0/api_clients", [200])
end
list_applications() click to toggle source

Lists summary details of applications available to the user

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#application_list_applications

# File lib/fog/brightbox/requests/compute/list_applications.rb, line 12
def list_applications
  wrapped_request("get", "/1.0/applications", [200])
end
list_cloud_ips() click to toggle source

Lists summary details of cloud IP addresses owned by the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#cloud_ip_list_cloud_ips

# File lib/fog/brightbox/requests/compute/list_cloud_ips.rb, line 12
def list_cloud_ips
  wrapped_request("get", "/1.0/cloud_ips", [200])
end
list_firewall_policies() click to toggle source

Lists summary details of firewall policies

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#firewall_policy_list_firewall_policies

# File lib/fog/brightbox/requests/compute/list_firewall_policies.rb, line 12
def list_firewall_policies
  wrapped_request("get", "/1.0/firewall_policies", [200])
end
list_images() click to toggle source

Lists summary details of images available for use by the Account. It includes those available to all customers

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#image_list_images

# File lib/fog/brightbox/requests/compute/list_images.rb, line 12
def list_images
  wrapped_request("get", "/1.0/images", [200])
end
list_load_balancers() click to toggle source

Lists summary details of load balancers owned by the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#load_balancer_list_load_balancers

# File lib/fog/brightbox/requests/compute/list_load_balancers.rb, line 12
def list_load_balancers
  wrapped_request("get", "/1.0/load_balancers", [200])
end
list_server_groups() click to toggle source

Lists summary details of server groups owned by the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_group_list_server_groups

# File lib/fog/brightbox/requests/compute/list_server_groups.rb, line 12
def list_server_groups
  wrapped_request("get", "/1.0/server_groups", [200])
end
list_server_types() click to toggle source

Lists summary details of server types available to the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_type_list_server_types

# File lib/fog/brightbox/requests/compute/list_server_types.rb, line 12
def list_server_types
  wrapped_request("get", "/1.0/server_types", [200])
end
list_servers() click to toggle source

Lists summary details of servers owned by the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_list_servers

# File lib/fog/brightbox/requests/compute/list_servers.rb, line 12
def list_servers
  wrapped_request("get", "/1.0/servers", [200])
end
list_users() click to toggle source

Lists summary details of user.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#user_list_users

# File lib/fog/brightbox/requests/compute/list_users.rb, line 12
def list_users
  wrapped_request("get", "/1.0/users", [200])
end
list_zones() click to toggle source

Lists summary details of zones available to the account.

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#zone_list_zones

# File lib/fog/brightbox/requests/compute/list_zones.rb, line 12
def list_zones
  wrapped_request("get", "/1.0/zones", [200])
end
map_cloud_ip(identifier, options) click to toggle source

Maps (or points) a cloud IP address at a server's interface or a load balancer to allow them to respond to public requests.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :destination The ID of an Interface or LoadBalancer to map the Cloud IP against

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#cloud_ip_map_cloud_ip

# File lib/fog/brightbox/requests/compute/map_cloud_ip.rb, line 15
def map_cloud_ip(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/cloud_ips/#{identifier}/map", [202], options)
end
move_servers_server_group(identifier, options) click to toggle source

Removes a number of server from the server group and adds them to another server group given in parameters.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array<Hash>] :servers Array of Hashes containing `{"server" => server_id}` for each server to remove @option options [String] :destination ServerGroup to move servers to

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_group_move_servers_server_group

@example

Compute[:brightbox].remove_servers_server_group "grp-12345", :destination => "grp-67890", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}]
# File lib/fog/brightbox/requests/compute/move_servers_server_group.rb, line 19
def move_servers_server_group(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/server_groups/#{identifier}/move_servers", [202], options)
end
remove_firewall_policy(identifier, options) click to toggle source

Removes firewall policy from given server group

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :server_group Server Group to remove

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#firewall_policy_remove_firewall_policy

# File lib/fog/brightbox/requests/compute/remove_firewall_policy.rb, line 15
def remove_firewall_policy(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/firewall_policies/#{identifier}/remove", [202], options)
end
remove_listeners_load_balancer(identifier, options) click to toggle source

Removes a number of listeners from a load balancer to cease balancing across nodes for those settings.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array] :listeners Array of Listener parameters

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#load_balancer_remove_listeners_load_balancer

# File lib/fog/brightbox/requests/compute/remove_listeners_load_balancer.rb, line 15
def remove_listeners_load_balancer(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/load_balancers/#{identifier}/remove_listeners", [202], options)
end
remove_nodes_load_balancer(identifier, options) click to toggle source

Remove a number of nodes from the load balancer

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array] :nodes Array of Node parameters

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#load_balancer_remove_nodes_load_balancer

# File lib/fog/brightbox/requests/compute/remove_nodes_load_balancer.rb, line 15
def remove_nodes_load_balancer(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/load_balancers/#{identifier}/remove_nodes", [202], options)
end
remove_servers_server_group(identifier, options) click to toggle source

Remove a number of servers from the server group.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [Array<Hash>] :servers Array of Hashes containing {"server" => server_id} for each server

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_group_remove_servers_server_group

@example

Compute[:brightbox].remove_servers_server_group "grp-12345", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}]
# File lib/fog/brightbox/requests/compute/remove_servers_server_group.rb, line 18
def remove_servers_server_group(identifier, options)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/server_groups/#{identifier}/remove_servers", [202], options)
end
request(*args) click to toggle source

Makes an API request to the given path using passed options or those set with the service setup

@todo Standard Fog behaviour is to return the Excon::Response but

this was unintentionally changed to be the Hash version of the
data in the body. This loses access to some details and should
be corrected in a backwards compatible manner

@overload request(params)

@param [Hash] params Excon compatible options
@option params [String] :body text to be sent over a socket
@option params [Hash<Symbol, String>] :headers The default headers to supply in a request
@option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
@option params [String] :path appears after 'scheme://host:port/'
@option params [Fixnum] :port The port on which to connect, to the destination host
@option params [Hash]   :query appended to the 'scheme://host:port/path/' in the form of '?key=value'
@option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
@return [Excon::Response]
@see https://github.com/geemus/excon/blob/master/lib/excon/connection.rb

@overload request(method, path, expected_responses, params = {})

@param [String] method HTTP method to use for the request
@param [String] path   The absolute path for the request
@param [Array<Fixnum>] expected_responses HTTP response codes that have been successful
@param [Hash] params Keys and values for JSON
@option params [String] :account_id The scoping account if required
@deprecated #request with multiple arguments is deprecated
  since it is inconsistent with original fog version.
@return [Hash]
# File lib/fog/brightbox/compute.rb, line 401
def request(*args)
  if args.size == 1
    authenticated_request(*args)
  else
    Fog::Logger.deprecation("#request with multiple parameters is deprecated, use #wrapped_request instead [light_black](#{caller.first})[/]")
    wrapped_request(*args)
  end
end
reset_ftp_password_account(identifier = nil) click to toggle source

Reset the image library ftp password for the account.

@note The response is the only time the new password is available in plaintext.

@overload reset_ftp_password_account(identifier)

@param [String] identifier Unique reference to identify the resource

@overload reset_ftp_password_account()

@deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#account_reset_ftp_password_account

# File lib/fog/brightbox/requests/compute/reset_ftp_password_account.rb, line 20
def reset_ftp_password_account(identifier = nil)
  if identifier.nil? || identifier.empty?
    Fog::Logger.deprecation("reset_ftp_password_account() without a parameter is deprecated, use reset_ftp_password_scoped_account instead [light_black](#{caller.first})[/]")
    reset_ftp_password_scoped_account
  else
    wrapped_request("post", "/1.0/accounts/#{identifier}/reset_ftp_password", [200])
  end
end
reset_ftp_password_scoped_account() click to toggle source

Resets the image library ftp password for the scoped account

@note The response is the only time the new password is available in plaintext.

@return [Hash] The JSON response parsed to a Hash

# File lib/fog/brightbox/requests/compute/reset_ftp_password_scoped_account.rb, line 11
def reset_ftp_password_scoped_account
  wrapped_request("post", "/1.0/account/reset_ftp_password", [200])
end
reset_secret_api_client(identifier) click to toggle source

Resets the secret used by the API client to a new generated value.

The response is the only time the new secret is available in plaintext.

Already authenticated tokens will still continue to be valid until expiry.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#api_client_reset_secret_api_client

# File lib/fog/brightbox/requests/compute/reset_secret_api_client.rb, line 18
def reset_secret_api_client(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/api_clients/#{identifier}/reset_secret", [200])
end
reset_secret_application(identifier) click to toggle source

Resets the secret used by the application to a new generated value.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#application_reset_secret_application

# File lib/fog/brightbox/requests/compute/reset_secret_application.rb, line 13
def reset_secret_application(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/applications/#{identifier}/reset_secret", [200])
end
shutdown_server(identifier) click to toggle source

Will issue a safe shutdown request for the server.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_shutdown_server

# File lib/fog/brightbox/requests/compute/shutdown_server.rb, line 13
def shutdown_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/servers/#{identifier}/shutdown", [202])
end
snapshot_server(identifier) click to toggle source

Will issue a request to snapshot the Server

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_snapshot_server

# File lib/fog/brightbox/requests/compute/snapshot_server.rb, line 13
def snapshot_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/servers/#{identifier}/snapshot", [202])
end
start_server(identifier) click to toggle source

Will issue a start request for the server to become active.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_start_server

# File lib/fog/brightbox/requests/compute/start_server.rb, line 13
def start_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/servers/#{identifier}/start", [202])
end
stop_server(identifier) click to toggle source

Will issue a stop request for the server to become inactive.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#server_stop_server

# File lib/fog/brightbox/requests/compute/stop_server.rb, line 13
def stop_server(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/servers/#{identifier}/stop", [202])
end
unmap_cloud_ip(identifier) click to toggle source

Unmaps a cloud IP address from its current destination making it available to remap. This remains in the account's pool of addresses.

@param [String] identifier Unique reference to identify the resource

@return [Hash] The JSON response parsed to a Hash

@see api.gb1.brightbox.com/1.0/#cloud_ip_unmap_cloud_ip

# File lib/fog/brightbox/requests/compute/unmap_cloud_ip.rb, line 13
def unmap_cloud_ip(identifier)
  return nil if identifier.nil? || identifier == ""
  wrapped_request("post", "/1.0/cloud_ips/#{identifier}/unmap", [202])
end
update_account(*args) click to toggle source

Update some details of the account.

@overload update_account(identifier, options)

@param [String] identifier Unique reference to identify the resource
@param [Hash] options
@option options [String] :name Account name
@option options [String] :address_1 First line of address
@option options [String] :address_2 Second line of address
@option options [String] :city City part of address
@option options [String] :county County part of address
@option options [String] :postcode Postcode or Zipcode
@option options [String] :country_code ISO 3166-1 two letter code (example: `GB`)
@option options [String] :vat_registration_number Must be a valid EU VAT number or `nil`
@option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`

@overload update_account(options)

@deprecated Use {Fog::Compute::Brightbox::Real#update_scoped_account} instead

@param [Hash] options
@option options [String] :name Account name
@option options [String] :address_1 First line of address
@option options [String] :address_2 Second line of address
@option options [String] :city City part of address
@option options [String] :county County part of address
@option options [String] :postcode Postcode or Zipcode
@option options [String] :country_code ISO 3166-1 two letter code (example: `GB`)
@option options [String] :vat_registration_number Must be a valid EU VAT number or `nil`
@option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#account_update_account

# File lib/fog/brightbox/requests/compute/update_account.rb, line 38
def update_account(*args)
  if args.size == 2
    identifier = args[0]
    options = args[1]
  elsif args.size == 1
    options = args[0]
  else
    raise ArgumentError, "wrong number of arguments (0 for 2)"
  end

  return nil if options.empty? || options.nil?
  if identifier.nil? || identifier.empty?
    Fog::Logger.deprecation("update_account() without a parameter is deprecated, use update_scoped_account instead [light_black](#{caller.first})[/]")
    update_scoped_account(options)
  else
    wrapped_request("put", "/1.0/accounts/#{identifier}", [200], options)
  end
end
update_api_client(identifier, options) click to toggle source

Update some details of the API client.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#api_client_update_api_client

# File lib/fog/brightbox/requests/compute/update_api_client.rb, line 16
def update_api_client(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/api_clients/#{identifier}", [200], options)
end
update_application(identifier, options) click to toggle source

Update some details of the application.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#application_update_application

# File lib/fog/brightbox/requests/compute/update_application.rb, line 16
def update_application(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/applications/#{identifier}", [200], options)
end
update_cloud_ip(identifier, options) click to toggle source

Update some details of the cloud IP address.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :reverse_dns Reverse DNS hostname @option options [String] :name Name for Cloud IP @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening.

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#cloud_ip_update_cloud_ip

# File lib/fog/brightbox/requests/compute/update_cloud_ip.rb, line 17
def update_cloud_ip(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/cloud_ips/#{identifier}", [200], options)
end
update_firewall_policy(identifier, options) click to toggle source

Updates details of the firewall policy

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name Editable label @option options [String] :description Longer editable description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#firewall_policy_update_firewall_policy

# File lib/fog/brightbox/requests/compute/update_firewall_policy.rb, line 16
def update_firewall_policy(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/firewall_policies/#{identifier}", [200], options)
end
update_firewall_rule(identifier, options) click to toggle source

Update some settings of the firewall rule.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :protocol @option options [String] :source Required unless destination is set. @option options [String] :source_port @option options [String] :destination Required unless source is set @option options [String] :destination_port @option options [String] :icmp_type_name @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#firewall_rule_update_firewall_rule

# File lib/fog/brightbox/requests/compute/update_firewall_rule.rb, line 21
def update_firewall_rule(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/firewall_rules/#{identifier}", [202], options)
end
update_image(identifier, options) click to toggle source

Update some details of the image.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name @option options [String] :username @option options [String] :arch @option options [String] :status @option options [Boolean] :public @option options [Boolean] :compatibility_mode @option options [String] :description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#image_update_image

# File lib/fog/brightbox/requests/compute/update_image.rb, line 21
def update_image(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/images/#{identifier}", [200], options)
end
update_load_balancer(identifier, options) click to toggle source

Update some details of the load balancer.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name Editable label @option options [Array] :nodes Array of Node parameters @option options [String] :policy Method of Load balancing to use @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000). @option options [String] :healthcheck Healthcheck options - only "port" and "type" required

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#load_balancer_update_load_balancer

# File lib/fog/brightbox/requests/compute/update_load_balancer.rb, line 19
def update_load_balancer(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/load_balancers/#{identifier}", [202], options)
end
update_scoped_account(options) click to toggle source

Requests an update to the currently scoped account

@param [Hash] options @option options [String] :name Account name @option options [String] :address_1 First line of address @option options [String] :address_2 Second line of address @option options [String] :city City part of address @option options [String] :county County part of address @option options [String] :postcode Postcode or Zipcode @option options [String] :country_code ISO 3166-1 two letter code (example: `GB`) @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil` @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#account_update_account

# File lib/fog/brightbox/requests/compute/update_scoped_account.rb, line 22
def update_scoped_account(options)
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/account", [200], options)
end
update_server(identifier, options) click to toggle source

Update some details of the server.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name Editable label @option options [String] :user_data User defined metadata @option options [Boolean] :compatibility_mode Server needs to be shutdown and restarted for changes to this to take effect

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_update_server

# File lib/fog/brightbox/requests/compute/update_server.rb, line 17
def update_server(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/servers/#{identifier}", [200], options)
end
update_server_group(identifier, options) click to toggle source

Update some details of the server group.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name Editable user label @option options [String] :description Editable user description

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#server_group_update_server_group

# File lib/fog/brightbox/requests/compute/update_server_group.rb, line 16
def update_server_group(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/server_groups/#{identifier}", [202], options)
end
update_user(identifier, options) click to toggle source

Update some details of your user profile.

@param [String] identifier Unique reference to identify the resource @param [Hash] options @option options [String] :name @option options [String] :email_address @option options [String] :ssh_key @option options [String] :password A password string that conforms to the minimum requirements @option options [String] :password_confirmation A password string that conforms to the minimum requirements

@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed

@see api.gb1.brightbox.com/1.0/#user_update_user

# File lib/fog/brightbox/requests/compute/update_user.rb, line 19
def update_user(identifier, options)
  return nil if identifier.nil? || identifier == ""
  return nil if options.empty? || options.nil?
  wrapped_request("put", "/1.0/users/#{identifier}", [200], options)
end
wrapped_request(method, path, expected_responses, parameters = {}) click to toggle source

Makes a request but with seperated arguments and parses the response to a hash

@note wrapped_request is the non-standard form of request introduced by mistake

@param [String] method HTTP method to use for the request @param [String] path The absolute path for the request @param [Array<Fixnum>] expected_responses HTTP response codes that have been successful @param [Hash] parameters Keys and values for JSON @option parameters [String] :account_id The scoping account if required

@return [Hash]

# File lib/fog/brightbox/compute.rb, line 421
def wrapped_request(method, path, expected_responses, parameters = {})
  _wrapped_request(method, path, expected_responses, parameters)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.