Class: OneviewSDK::API200::Volume

Inherits:
Resource
  • Object
show all
Defined in:
lib/oneview-sdk/resource/api200/volume.rb

Overview

Volume resource implementation

Constant Summary collapse

BASE_URI =
'/rest/storage-volumes'.freeze

Constants inherited from Resource

Resource::UNIQUE_IDENTIFIERS

Instance Attribute Summary

Attributes inherited from Resource

#api_version, #client, #data, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#==, #[], #[]=, build_query, #create!, #each, #eql?, #exists?, find_by, from_file, get_all, #initialize, #like?, #refresh, #retrieve!, #schema, schema, #set, #set_all, #to_file, #update

Constructor Details

This class inherits a constructor from OneviewSDK::Resource

Class Method Details

.get_attachable_volumes(client) ⇒ Array<OneviewSDK::Volume>

Gets all the attachable volumes managed by the appliance

Parameters:

Returns:

  • (Array<OneviewSDK::Volume>)

    Array of volumes


153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 153

def self.get_attachable_volumes(client)
  results = []
  uri = "#{BASE_URI}/attachable-volumes"
  loop do
    response = client.rest_get(uri)
    body = client.response_handler(response)
    members = body['members']
    members.each { |member| results.push(OneviewSDK::Volume.new(client, member)) }
    break unless body['nextPageUri']
    uri = body['nextPageUri']
  end
  results
end

.get_extra_managed_volume_paths(client) ⇒ Object

Gets the list of extra managed storage volume paths

Parameters:

Returns:

  • response


170
171
172
173
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 170

def self.get_extra_managed_volume_paths(client)
  response = client.rest_get(BASE_URI + '/repair?alertFixType=ExtraManagedStorageVolumePaths')
  client.response_handler(response)
end

Instance Method Details

#createResource

Note:

provisioning parameters are required for creation, but not afterwards; after creation, they will be removed.

Creates the volume

Returns:

Raises:


33
34
35
36
37
38
39
40
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 33

def create
  ensure_client
  response = @client.rest_post(self.class::BASE_URI, { 'body' => @data }, @api_version)
  body = @client.response_handler(response)
  set_all(body)
  @data.delete('provisioningParameters')
  self
end

#create_snapshot(snapshot, description = nil) ⇒ true

Creates a snapshot of the volume

Parameters:

  • snapshot (String, OneviewSDK::VolumeSnapshot)

    String or OneviewSDK::VolumeSnapshot object

  • description (String) (defaults to: nil)

    Provide a description

Returns:

  • (true)

    if snapshot was created successfully


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 93

def create_snapshot(snapshot, description = nil)
  ensure_uri && ensure_client
  if snapshot.is_a?(OneviewSDK::Resource) || snapshot.is_a?(Hash)
    name = snapshot[:name] || snapshot['name']
    description ||= snapshot[:description] || snapshot['description']
  else
    name = snapshot
  end
  data = {
    type: 'Snapshot',
    description: description,
    name: name
  }
  response = @client.rest_post("#{@data['uri']}/snapshots", { 'body' => data }, @api_version)
  @client.response_handler(response)
  true
end

#delete(flag = :all) ⇒ true

Deletes the resource from OneView or from Oneview and storage system

Parameters:

  • flag (Symbol) (defaults to: :all)

    Delete storage system from Oneview only or in storage system as well

Returns:

  • (true)

    if resource was deleted successfully


45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 45

def delete(flag = :all)
  ensure_client && ensure_uri
  case flag
  when :oneview
    response = @client.rest_api(:delete, @data['uri'], { 'exportOnly' => true }, @api_version)
    @client.response_handler(response)
  when :all
    response = @client.rest_api(:delete, @data['uri'], {}, @api_version)
    @client.response_handler(response)
  else
    raise InvalidResource, 'Invalid flag value, use :oneview or :all'
  end
  true
end

#delete_snapshot(name) ⇒ true

Deletes a snapshot of the volume

Parameters:

  • name (String)

    snapshot name

Returns:

  • (true)

    if snapshot was created successfully


114
115
116
117
118
119
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 114

def delete_snapshot(name)
  result = get_snapshot(name)
  response = @client.rest_api(:delete, result['uri'], {}, @api_version)
  @client.response_handler(response)
  true
end

#get_snapshot(name) ⇒ Hash

Retrieves a snapshot by name

Parameters:

  • name (String)

Returns:

  • (Hash)

    snapshot data


124
125
126
127
128
129
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 124

def get_snapshot(name)
  results = get_snapshots
  results.each do |snapshot|
    return snapshot if snapshot['name'] == name
  end
end

#get_snapshotsArray

Gets all the snapshots of this volume

Returns:

  • (Array)

    Array of snapshots


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 133

def get_snapshots
  ensure_uri && ensure_client
  results = []
  uri = "#{@data['uri']}/snapshots"
  loop do
    response = @client.rest_get(uri, @api_version)
    body = @client.response_handler(response)
    members = body['members']
    members.each do |member|
      results.push(member)
    end
    break unless body['nextPageUri']
    uri = body['nextPageUri']
  end
  results
end

#repairObject

Removes extra presentation from the volume

Returns:

  • response


177
178
179
180
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 177

def repair
  response = client.rest_post(BASE_URI + '/repair', 'body' => { resourceUri: @data['uri'], type: 'ExtraManagedStorageVolumePaths' })
  client.response_handler(response)
end

#set_snapshot_pool(storage_pool) ⇒ Object

Sets the snapshot pool to the volume

Parameters:

  • storage_pool (OneviewSDK::StoragePool)

    Storage Pool to use for snapshots


84
85
86
87
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 84

def set_snapshot_pool(storage_pool)
  assure_uri(storage_pool)
  set('snapshotPoolUri', storage_pool['uri'])
end

#set_storage_pool(storage_pool) ⇒ Object

Sets the storage pool to the volume

Parameters:

  • storage_pool (OneviewSDK::StoragePool)

    Storage pool


69
70
71
72
73
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 69

def set_storage_pool(storage_pool)
  assure_uri(storage_pool)
  self['provisioningParameters'] ||= {}
  self['provisioningParameters']['storagePoolUri'] = storage_pool['uri']
end

#set_storage_system(storage_system) ⇒ Object

Sets the storage system to the volume

Parameters:

  • storage_system (OneviewSDK::StorageSystem)

    Storage System


62
63
64
65
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 62

def set_storage_system(storage_system)
  assure_uri(storage_system)
  set('storageSystemUri', storage_system['uri'])
end

#set_storage_volume_template(storage_volume_template) ⇒ Object

Adds the storage volume template to the volume

Parameters:

  • storage_volume_template (OneviewSDK::VolumeTemplate)

    Storage Volume Template


77
78
79
80
# File 'lib/oneview-sdk/resource/api200/volume.rb', line 77

def set_storage_volume_template(storage_volume_template)
  assure_uri(storage_volume_template)
  set('templateUri', storage_volume_template['uri'])
end