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
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
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
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"}]
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
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
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
@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
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
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 & 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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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"}]
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
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
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
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"}]
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]
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
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
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
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
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
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
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
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
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
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
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
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
@return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
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
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
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]