Class: Fog::Compute::RackspaceV2::Real

attach_volume(server_id, volume_id, device)

This operation attaches a volume to the specified server. @param [String] server_id @param [String] volume_id @param [String] device name of the device /dev/xvd[a-p] (optional) @return [Excon::Response] response:

  * body [Hash]:
    * volumeAttachment [Hash]:
      * device [String] - The name of the device, such as /dev/xvdb. Specify auto for auto-assignment.
      * serverId [String] - The id of the server that attached the volume
      * id [String] - The id of the attachment
      * volumeId [String] - The id of the volume that was attached

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Attach_Volume_to_Server.html

authenticate(options={})

change_server_password(server_id, password)

Changes server admin password @param [String] server_id @param [String] password @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @note Though Rackspace does not enforce complexity requirements for the password, the operating system might. If the password is not complex enough, the server might enter an ERROR state. @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Change_Password-d1e3234.html

confirm_resize_server(server_id)

Confirm server resize operation @param [String] server_id The id of the server to revert @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize. @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Revert_Resized_Server-d1e4024.html

Status Transition:
- VERIFY_RESIZE -> ACTIVE
- VERIFY_RESIZE -> ERROR (on error)

create_image(server_id, name, options = {})

Create an image from a running server

@param [String] server_id Id of server to create image from @param [String] name name for created image @param [Hash] options @option options [Hash] :metadata - key value pairs of image metadata @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Create_Image-d1e4655.html

State Transition:
- SAVING -> ACTIVE
- SAVING -> ERROR (on error)

create_keypair(key_name, attributes = nil)

Request a new keypair to be created @param [String] key_name: unique name of the keypair to create @return [Excon::Response] response :

  * body [Hash]: -
    * 'keypair' [Hash]: -
      * 'fingerprint' [String]: unique fingerprint of the keypair
      * 'name' [String]: unique name of the keypair
      * 'private_key' [String]: the private key of the keypair (only available here, at creation time)
      * 'public_key' [String]: the public key of the keypair
      * 'user_id' [String]: the user id

@raise [Fog::Compute::RackspaceV2::NotFound] @raise [Fog::Compute::RackspaceV2::BadRequest] @raise [Fog::Compute::RackspaceV2::InternalServerError] @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/CreateKeyPair.html

create_network(label, cidr)

create_server(name, image_id, flavor_id, min_count, max_count, options = {})

Create server @param [String] name name of server @param [String] image_id of the image used to create server @param [String] flavor_id id of the flavor of the image @param [String] min_count @param [String] max_count @param [Hash] options @option options [Hash] metadata key value pairs of server metadata @option options [String] OS-DCF:diskConfig The disk configuration value. (AUTO or MANUAL) @option options [Hash] personality Hash containing data to inject into the file system of the cloud server instance during server creation. @option options [Boolean] config_drive whether to attach a read-only configuration drive @option options [String] keypair Name of the kay-pair to associate with this server. @option options [Array<Hash>] block_device_mapping A manually specified block device mapping to fully control the creation and

  attachment of volumes to this server. Mutually exclusive with :volume_id or :volume_image_id. If provided, leave image_id
  as "". See http://developer.openstack.org/api-ref-compute-v2-ext.html#ext-os-block-device-mapping-v2-boot for details.

@option options [String] boot_volume_id Id of a pre-created bootable volume to use for this server. If provided, leave image_id as "". @option options [Integer] boot_volume_size Size of the bootable volume to be created expressed in GB. (defaults to 100) @option options [String] boot_image_id Id of an image to create a bootable volume from and attach to this server. If provided,

  leave image_id as "".

@return [Excon::Response] response:

  * body [Hash]:
    * server [Hash]:
      * name [String] - name of server
      * imageRef [String] - id of image used to create server
      * flavorRef [String] - id of flavor used to create server
      * OS-DCF:diskConfig [String] - The disk configuration value.
      * name [String] - name of server
      * metadata [Hash] - Metadata key and value pairs.
      * personality [Array]:
        * [Hash]:
          * path - path of the file created
          * contents - Base 64 encoded file contents
      * networks [Array]:
        * [Hash]:
          * uuid [String] - uuid of attached network
      * config_drive [Boolean]: Wether to use a config drive or not
      * user_data [String]: User data for cloud init

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/CreateServers.html @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Metadata-d1e2529.html @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Personality-d1e2543.html @see docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_extensions.html#diskconfig_attribute @see developer.openstack.org/api-ref-compute-v2-ext.html#ext-os-block-device-mapping-v2-boot

State Transitions
- BUILD -> ACTIVE
- BUILD -> ERROR (on error)

create_virtual_interface(server_id, network_id)

Creates virtual interface for a server @param [String] server_id The server id to create the virtual interface on @param [String] network_id The network id to attach the virtual interface to @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cn-devguide/content/api_create_virtual_interface.html

delete_attachment(server_id, volume_id)

Deletes a specified volume attachment from a specified server instance. @param [String] server_id id of server containing volume to delete @param [String] volume_id id of volume on server to delete @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Volume_Attachment.html

delete_image(image_id)

Delete an image @param [String] image_id Id of image to delete @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Image-d1e4957.html

delete_keypair(key_name)

Delete the key specified with key_name @param [String] key_name name of the key to delete @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] @raise [Fog::Compute::RackspaceV2::BadRequest] @raise [Fog::Compute::RackspaceV2::InternalServerError] @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/DeleteKeyPair.html

delete_metadata_item(collection, obj_id, key)

Deletes a metadata item. @param [String<images, servers>] collection type of metadata @param [String] obj_id id of the object where the metadata is attached @param [String] key the key of the metadata to delete @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Metadata_Item-d1e5790.html

delete_network(id)

delete_server(server_id)

Deletes a specified server instance from the system. @param [String] server_id the id of the server to delete @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Server-d1e2883.html

delete_virtual_interface(server_id, interface_id)

Deletes virtual interface from server @param [String] server_id The server id that contains the virtual interface @param [String] interface_id The id of the virtual interface @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cn-devguide/content/delete_virt_interface_api.html

endpoint_uri(service_endpoint_url=nil)

get_attachment(server_id, volume_id)

Retrieves attachment @param [String] server_id @param [String] volume_id @return [Excon::Response] response:

  * body [Hash]:
    * volumeAttachment [Hash]:
      * device [String] - The name of the device, such as /dev/xvdb. Specify auto for auto-assignment.
      * serverId [String] - The id of the server that attached the volume
      * id [String] - The id of the attachment
      * volumeId [String] - The id of the volume that was attached

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Volume_Attachment_Details.html

get_flavor(flavor_id)

Retrieves flavor detail @param [Sring] flavor_id @return [Excon::Response] response:

  * body [Hash]:
    * flavor [Hash]:
      * disk [Fixnum] - disk size in GB
      * id [String] - id of flavor
      * name [String] - name of flavor
      * ram [Fixnum] - amount of ram in MB
      * swap [Fixnum] - amount of swap in GB
      * vcpus [Fixnum] - number of virtual CPUs
      * links [Array] - links to flavor

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Flavor_Details-d1e4317.html

get_image(image_id)

Retrieves image detail @param [String] image_id @return [Excon::Response] response:

  * body [Hash]:
    * image [Hash]:
      * OS-DCF:diskConfig [String] - The disk configuration value.
      * created [String] - created timestamp
      * id [String] - id of image
      * metadata [Hash] - image metadata
      * minDisk [Fixnum]
      * minRam [Fixnum]
      * name [String] - name of image
      * progress [Fixnum] - progress complete. Value is from 0 to 100.
      * status [String] - status of current image
      * updated [String] - updated timestamp
      * links [Array] - links to flavor

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Image_Details-d1e4848.html

get_keypair(key_name)

Retreive single keypair details @param [String] key_name name of the key for which to request the details @return [Excon::Response] response :

  * body [Hash]: -
    * 'keypair' [Hash]: -
      * 'fingerprint' [String]: unique fingerprint of the keypair
      * 'name' [String]: unique name of the keypair
      * 'public_key' [String]: the public key assigne to the keypair

@raise [Fog::Compute::RackspaceV2::NotFound] @raise [Fog::Compute::RackspaceV2::BadRequest] @raise [Fog::Compute::RackspaceV2::InternalServerError] @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/ListKeyPairs.html

get_metadata_item(collection, obj_id, key)

Retrieves single metadatum item by key. @param [String<images, servers>] collection type of metadata @param [String] obj_id id of the object where the metadata is attached @param [String] key the key of the metadata to retrieve @return [Excon::Response] response:

  * body [Hash]:
    * meta [Hash]:

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Metadata_Item-d1e5507.html

get_network(id)

get_server(server_id)

Retrieves server detail @param [String] server_id @return [Excon::Response] response:

  * body [Hash]:
    * server [Hash]:
      * OS-DCF:diskConfig [String] - The disk configuration value.
      * OS-EXT-STS:power_state [Fixnum] - The power state.
      * OS-EXT-STS:task_state [String] - The task state.
      * OS-EXT-STS:vm_state [String] - The VM state.
      * accessIPv4 [String] - The public IP version 4 access address.
      * accessIPv6 [String] - The public IP version 6 access address.
      * addresses [Hash] - Public and private IP addresses, The version field indicates whether the IP address is version 4 or 6.
      * created [String] - created timestamp
      * hostId [String] - The host id.
      * id [String] - id of image
      * image [Hash]:
        * id [String] - id of the image
        * links [Hash] - links to image
      * flavor [Hash]:
        * id [String] - id of the flavor
        * links [Hash] - links to flavor
      * links [Hash] - links to server
      * metadata [Hash] - server metadata
      * name [String] - name of server
      * progress [Fixnum] - progress complete. Value is from 0 to 100.
      * rax-bandwidth:bandwidth [Array] - The amount of bandwidth used for the specified audit period.
      * status [String] - The server status.
      * tenant_id [String] - The tenant ID.
      * updated [String] - updated timestamp
      * user_id [Array] - The user ID.

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Server_Details-d1e2623.html

get_vnc_console(server_id, console_type)

Get a vnc console for an instance.

Parameters

server_id <~String> - The ID of the server.
console_type <~String> - Type of vnc console to get (‘novnc’ or ‘xvpvnc’).

Returns

response <~Excon::Response>:
- body <~Hash>:
  - url <~String>
  - type <~String>

list_addresses(server_id)

Lists all networks and addresses associated with a specified server. @param [String] server_id @return [Excon::Response] response:

  * body [Hash]:
    * addresses [Hash] - key is the network name and the value are an array of addresses allocated for that network

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError]

list_addresses_by_network(server_id, network_id)

Lists all addresses associated with a specified server and network @param [String] server_id @param [String] network_id @return [Excon::Response] response:

  * body [Hash]:
    * network [Hash]:
      * id [String] - id of network
      * ip [Array]:
        * [Hash]:
          * version [Fixnum] - version of the address
          * addr [String] - ip address

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Addresses_by_Network-d1e3118.html

list_attachments(server_id)

Retrieves list of attached volumes @param [String] server_id @return [Excon::Response] response:

  * body [Hash]:
    * volumeAttachment [Array]:
      * [Hash]:
        * device [String] - The name of the device, such as /dev/xvdb. Specify auto for auto-assignment.
        * serverId [String] - The id of the server that attached the volume
        * id [String] - The id of the attachment
        * volumeId [String] - The id of the volume that was attached

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Volume_Attachments.html

list_flavors()

Retrieves a list of flavors @return [Excon::Response] response:

  * body [Hash]:
    * flavors [Array]:
      * [Hash]:
        * id [String] - flavor id
        * links [Array] - flavor links
        * name [String] - flavor name

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Flavors-d1e4188.html

list_flavors_detail()

Retrieves a list of flavors @return [Excon::Response] response:

  * body [Hash]:
    * flavors [Array]:
      * [Hash]:
        * id [String] - flavor id
        * links [Array] - flavor links
        * name [String] - flavor name
        * ram [Fixnum] - flavor ram
        * disk [Fixnum] - flavor disk
        * vcpus [Fixnum] - flavor vcpus

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Flavors-d1e4188.html

list_images(options = {})

Retrieves a list of images

Parameters

options<~String>:
- ‘name’<~String> - Filters the list of images by image name
- ‘limit’<~String> - Maximum number of objects to return
- ‘marker’<~String> - Only return objects whose name is greater than marker
- ‘status’<~String> - Filters the list of images by status
- ‘type’<~String> - Filters base Rackspace images or anyn custom server images that have been created

@return [Excon::Response] response:

  * body [Hash]:
    * images [Array]:
      * [Hash]:
        * id [String] - image id
        * links [Array] - image links
        * name [String] - image name

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html

list_images_detail(options = {})

Retrieves a list of images

Parameters

options<~String>:
- ‘name’<~String> - Filters the list of images by image name
- ‘limit’<~String> - Maximum number of objects to return
- ‘marker’<~String> - Only return objects whose name is greater than marker
- ‘status’<~String> - Filters the list of images by status
- ‘type’<~String> - Filters base Rackspace images or anyn custom server images that have been created

@return [Excon::Response] response:

  * body [Hash]:
    * images [Array]:
      * [Hash]:
        * id [String] - image id
        * links [Array] - image links
        * name [String] - image name
        * minDisk [Fixnum] - image minimum disk required
        * minRam [Fixnum] - image minimum ram required
        * created [String] - image creation date (ISO 8601 format)
        * updated [String] - date of most recent image update
        * state [String] - image status (e.g. ACTIVE, SAVING, ERROR)
        * progress [Fixnum] - image saving progress

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html

list_keypairs()

Returns a list of all key pairs associated with an account. @return [Excon::Response] response :

  * body [Hash]: -
    * 'keypairs' [Array]: list of keypairs
      * 'keypair' [Hash]: -
          * 'fingerprint' [String]: unique fingerprint of the keypair
          * 'name' [String]: unique name of the keypair
          * 'public_key' [String]: the public key assigned to the keypair

@raise [Fog::Compute::RackspaceV2::NotFound] @raise [Fog::Compute::RackspaceV2::BadRequest] @raise [Fog::Compute::RackspaceV2::InternalServerError] @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/ListKeyPairs.html

list_metadata(collection, obj_id)

Retrieves all metadata associated with a server or an image. @param [String<images, servers>] collection type of metadata @param [String] obj_id id of the object where the metadata is attached @return [Excon::Response] response:

  * body [Hash]:
    * meta [Hash]:

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Metadata-d1e5089.html

list_networks()

list_servers()

Retrieves list of servers @return [Excon::Response] response:

  * body [Hash]:
    * server [Hash]:
      * OS-DCF:diskConfig [String] - The disk configuration value.
      * OS-EXT-STS:power_state [Fixnum] - The power state.
      * OS-EXT-STS:task_state [String] - The task state.
      * OS-EXT-STS:vm_state [String] - The VM state.
      * accessIPv4 [String] - The public IP version 4 access address.
      * accessIPv6 [String] - The public IP version 6 access address.
      * addresses [Hash] - Public and private IP addresses, The version field indicates whether the IP address is version 4 or 6.
      * created [String] - created timestamp
      * hostId [String] - The host id.
      * id [String] - id of image
      * image [Hash]:
        * id [String] - id of the image
        * links [Hash] - links to image
      * flavor [Hash]:
        * id [String] - id of the flavor
        * links [Hash] - links to flavor
      * links [Hash] - links to server
      * metadata [Hash] - server metadata
      * name [String] - name of server
      * progress [Fixnum] - progress complete. Value is from 0 to 100.
      * rax-bandwidth:bandwidth [Array] - The amount of bandwidth used for the specified audit period.
      * status [String] - The server status.
      * tenant_id [String] - The tenant ID.
      * updated [String] - updated timestamp
      * user_id [Array] - The user ID.

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Servers-d1e2078.html

list_virtual_interfaces(server_id)

Lists virtual interfaces for a server @param [String] server_id @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cn-devguide/content/list_virt_interfaces.html

reboot_server(server_id, type)

Reboots server @param [String] server_id @param [String<SOFT,HARD>] type type of reboot @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Reboot_Server-d1e3371.html

rebuild_server(server_id, image_id, options={})

The rebuild operation removes all data on the server and replaces it with the specified image. The serverRef and all IP addresses remain the same. If you specify name, metadata, accessIPv4, or accessIPv6 in the rebuild request, new values replace existing values. Otherwise, these values do not change. @param [String] server_id id of the server to rebuild @param [String] image_id id of image used to rebuild the server @param [Hash] options @option options [String] accessIPv4 The IP version 4 address. @option options [String] accessIPv6 The IP version 6 address. @option options [String] adminPass The administrator password. @option options [Hash] metadata key value pairs of server metadata @option options [String] OS-DCF:diskConfig The disk configuration value. (AUTO or MANUAL) @option options [Hash] personality Hash containing data to inject into the file system of the cloud server instance during server creation. @return [Excon::Response] response:

  * body [Hash]:
    * server [Hash]:
      * name [String] - name of server
      * imageRef [String] - id of image used to create server
      * flavorRef [String] - id of flavor used to create server
      * OS-DCF:diskConfig [String] - The disk configuration value.
      * name [String] - name of server
      * metadata [Hash] - Metadata key and value pairs.
      * personality [Array]:
          * [Hash]:
            * path - path of the file created
            * contents - Base 64 encoded file contents
      * networks [Array]:
        * [Hash]:
          * uuid [String] - uuid of attached network

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Rebuild_Server-d1e3538.html @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Metadata-d1e2529.html @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Personality-d1e2543.html @see docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_extensions.html#diskconfig_attribute

Status Transition:
- ACTIVE -> REBUILD -> ACTIVE
- ACTIVE -> REBUILD -> ERROR (on error)

region()

request(params, parse_json = true)

request_id_header()

rescue_server(server_id)

Puts server into rescue mode @param [String] server_id id of server to rescue @return [Excon::Response] response @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404 @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400 @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500 @raise [Fog::Rackspace::Errors::ServiceError] @note Rescue mode is only guaranteed to be active for 90 minutes @see docs.rackspace.com/servers/api/v2/cs-devguide/content/rescue_mode.html

Status Transition:
- PREP_RESCUE -> RESCUE
- PREP_RESCUE -> ACTIVE (on error)

resize_server(server_id, flavor_id)

Reverts server resize operation @param [String] server_id id of server to resize @param [String] flavor_id id of the desired flavor @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize. @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Revert_Resized_Server-d1e4024.html

Status Transition:
- VERIFY_RESIZE -> ACTIVE
- VERIFY_RESIZE -> ERROR (on error)

revert_resize_server(server_id)

Reverts server resize operation @param [String] server_id @return [Excon::Response] response @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize. @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Revert_Resized_Server-d1e4024.html @see Server#resize

Status Transition:
- VERIFY_RESIZE -> ACTIVE
- VERIFY_RESIZE -> ERROR (on error)

service_name()

set_metadata(collection, obj_id, metadata = {})

Sets metadata associated with a server or an image. @param [String<images, servers>] collection type of metadata @param [String] obj_id id of the object where the metadata is attached @param [Hash] metadata key value pairs of metadata @return [Excon::Response] response:

  * body [Hash]:
    * metadata [Hash]:

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Create_or_Replace_Metadata-d1e5358.html

set_metadata_item(collection, obj_id, key, value)

Sets a single metadatum item by key. @param [String<images, servers>] collection type of metadata @param [String] obj_id id of the object where the metadata is attached @param [String] key the key of the metadata to set @param [String] value the value of the metadata to set @return [Excon::Response] response:

  * body [Hash]:
    * meta [Hash]:

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Create_or_Update_a_Metadata_Item-d1e5633.html

start_server(server_id)

This operation starts a stopped server, and changes its status to ACTIVE. Prior to running this command, the server status must be SHUTTOFF @param [String] server_id id of server to rescue @return [Excon::Response] response @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404 @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400 @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500 @raise [Fog::Rackspace::Errors::ServiceError] @note Rescue mode is only guaranteed to be active for 90 minutes @see developer.rackspace.com/docs/cloud-servers/v2/api-reference/svr-basic-operations/#start-specified-server

stop_server(server_id)

This operation stops a running server, and changes the server status to SHUTOFF and changes the clean_shutdown parameter to TRUE. Prior to running this command, the server status must be ACTIVE or ERROR. @param [String] server_id id of server to rescue @return [Excon::Response] response @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404 @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400 @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500 @raise [Fog::Rackspace::Errors::ServiceError] @note Rescue mode is only guaranteed to be active for 90 minutes @see developer.rackspace.com/docs/cloud-servers/v2/api-reference/svr-basic-operations/#stop-specified-server

unrescue_server(server_id)

Take server out of rescue mode @param [String] server_id id of server @return [Excon::Response] response @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404 @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400 @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500 @raise [Fog::Rackspace::Errors::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/exit_rescue_mode.html

Status Transition:
- RESCUE -> PREP_UNRESCUE -> ACTIVE
- RESCUE -> ERROR (on error)

update_metadata(collection, obj_id, metadata = {})

Updates metadata items for a specified server or image. @param [String<images, servers>] collection type of metadata @param [String] obj_id id of the object where the metadata is attached @param [Hash] metadata key value pairs of metadata @return [Excon::Response] response:

  * body [Hash]:
    * metadata [Hash]:

@raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @see docs.rackspace.com/servers/api/v2/cs-devguide/content/Update_Metadata-d1e5208.html

update_server(server_id, options={})

Update the editable attributes of a specified server. @param [String] server_id @param [Hash] options @option options [Hash] name name for server @option options [String] accessIPv4 The IP version 4 address. @option options [Hash] accessIPv6 The IP version 6 address. @raise [Fog::Compute::RackspaceV2::NotFound] - HTTP 404 @raise [Fog::Compute::RackspaceV2::BadRequest] - HTTP 400 @raise [Fog::Compute::RackspaceV2::InternalServerError] - HTTP 500 @raise [Fog::Compute::RackspaceV2::ServiceError] @note If you edit the server name, the server host name does not change. Also, server names are not guaranteed to be unique. @see docs.rackspace.com/servers/api/v2/cs-devguide/content/ServerUpdate.html

Methods

Public Class methods

Public Instance methods

Parameters

Returns

Parameters

Parameters