Class: Hpe3parSdk::VirtualVolume

Inherits:
Object
  • Object
show all
Defined in:
lib/Hpe3parSdk/models.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object_hash) ⇒ VirtualVolume

Returns a new instance of VirtualVolume.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/Hpe3parSdk/models.rb', line 239

def initialize(object_hash)
  if object_hash == nil
    return
  end

  self.additional_states = object_hash['additionalStates']

  !object_hash['adminSpace'].nil? ? self.admin_space = Space.new(object_hash['adminSpace']) : self.admin_space = nil

  self.base_id = object_hash['baseId']

  self.comment = object_hash['comment']

  !object_hash['capacityEfficiency'].nil? ? self.capacity_efficiency = CapEfficiency.new(object_hash['capacityEfficiency']) : self.capacity_efficiency = nil

  self.copy_of = object_hash['copyOf']

  self.copy_type = object_hash['copyType']

  self.creation_time8601 = object_hash['creationTime8601']

  self.creation_time_sec = object_hash['creationTimeSec']

  self.degraded_states = object_hash['degradedStates']

  self.domain = object_hash['domain']

  self.expiration_time8601 = object_hash['expirationTime8601']

  self.expiration_time_sec = object_hash['expirationTimeSec']

  self.failed_states = object_hash['failedStates']

  self.compression_state = object_hash['compressionState']

  self.deduplication_state = object_hash['deduplicationState']

  self.id = object_hash['id']

  self.links = object_hash['links']

  self.name = object_hash['name']

  self.parent_id = object_hash['parentId']

  self.phys_parent_id = object_hash['physParentId']

  !object_hash['policies'].nil? ? self.policies = Policy.new(object_hash['policies']) : self.policies = nil

  self.provisioning_type = object_hash['provisioningType']

  self.read_only = object_hash['readOnly']

  self.retention_time8601 = object_hash['retentionTime8601']

  self.retention_time_sec = object_hash['retentionTimeSec']

  self.ro_child_id = object_hash['roChildId']

  self.rw_child_id = object_hash['rwChildId']

  self.host_write_mib = object_hash['hostWriteMiB']

  self.total_used_mib = object_hash['totalUsedMiB']

  self.total_reserved_mib = object_hash['totalReservedMiB']

  self.size_mib = object_hash['sizeMiB']

  self.snap_cpg = object_hash['snapCPG']

  !object_hash['snapshotSpace'].nil? ? self.snapshot_space = Space.new(object_hash['snapshotSpace']) : self.snapshot_space = nil

  self.ss_spc_alloc_limit_pct = object_hash['ssSpcAllocLimitPct']

  self.ss_spc_alloc_warning_pct = object_hash['ssSpcAllocWarningPct']

  self.state = object_hash['state']

  self.user_cpg = object_hash['userCPG']

  !object_hash['userSpace'].nil? ? self.user_space = Space.new(object_hash['userSpace']) : self.user_space = nil

  self.usr_spc_alloc_limit_pct = object_hash['usrSpcAllocLimitPct']

  self.usr_spc_alloc_warning_pct = object_hash['usrSpcAllocWarningPct']

  self.uuid = object_hash['uuid']

  self.shared_parent_id = object_hash['sharedParentID']

  self.udid = object_hash['udid']

  self.wwn = object_hash['wwn']
end

Instance Attribute Details

#additional_states ⇒ Object

type - Number

Detailed state of the VV - Hpe3parSdk::VolumeDetailedState



17
18
19
 
# File 'lib/Hpe3parSdk/models.rb', line 17

def additional_states
  @additional_states
end

#admin_space ⇒ Object

type - Space

Administrative space in MiB.



21
22
23
 
# File 'lib/Hpe3parSdk/models.rb', line 21

def admin_space
  @admin_space
end

#base_id ⇒ Object

type - Number

The ID of the volume that is the base volume (at the root of the snapshot tree) for the volume.



27
28
29
 
# File 'lib/Hpe3parSdk/models.rb', line 27

def base_id
  @base_id
end

#capacity_efficiency ⇒ Object

type - CapEfficiency

Capacity efficiency attributes.



35
36
37
 
# File 'lib/Hpe3parSdk/models.rb', line 35

def capacity_efficiency
  @capacity_efficiency
end

#comment ⇒ Object

type - String

Comment associated with the volume.



31
32
33
 
# File 'lib/Hpe3parSdk/models.rb', line 31

def comment
  @comment
end

#compression_state ⇒ Object

type - Number

Volume compression state - Hpe3parSdk::VolumeCompressionState



79
80
81
 
# File 'lib/Hpe3parSdk/models.rb', line 79

def compression_state
  @compression_state
end

#copy_of ⇒ Object

type - String

If the volume is a physical copy or virtual copy of another volume, this field indicates the volume that this volume is a copy of.



42
43
44
 
# File 'lib/Hpe3parSdk/models.rb', line 42

def copy_of
  @copy_of
end

#copy_type ⇒ Object

type - Number

Indicates the copy type of the volume. - Hpe3parSdk::VolumeCopyType



46
47
48
 
# File 'lib/Hpe3parSdk/models.rb', line 46

def copy_type
  @copy_type
end

#creation_time8601 ⇒ Object

type - String

Time of volume creation.



50
51
52
 
# File 'lib/Hpe3parSdk/models.rb', line 50

def creation_time8601
  @creation_time8601
end

#creation_time_sec ⇒ Object

type - Number

Time of volume creation, measured in seconds since 12 AM on 01/01/1970.



55
56
57
 
# File 'lib/Hpe3parSdk/models.rb', line 55

def creation_time_sec
  @creation_time_sec
end

#deduplication_state ⇒ Object

type - Number

Volume deduplication state. - Hpe3parSdk::VolumeDetailedState



83
84
85
 
# File 'lib/Hpe3parSdk/models.rb', line 83

def deduplication_state
  @deduplication_state
end

#degraded_states ⇒ Object

type - Number

Volume detailed state. - Hpe3parSdk::VolumeDetailedState



59
60
61
 
# File 'lib/Hpe3parSdk/models.rb', line 59

def degraded_states
  @degraded_states
end

#domain ⇒ Object

type - String

Volume domain.



63
64
65
 
# File 'lib/Hpe3parSdk/models.rb', line 63

def domain
  @domain
end

#expiration_time8601 ⇒ Object

type - String

Time of volume expiration.



67
68
69
 
# File 'lib/Hpe3parSdk/models.rb', line 67

def expiration_time8601
  @expiration_time8601
end

#expiration_time_sec ⇒ Object

type - Number

Time of volume expiration.



71
72
73
 
# File 'lib/Hpe3parSdk/models.rb', line 71

def expiration_time_sec
  @expiration_time_sec
end

#failed_states ⇒ Object

type - Number

Volume detailed state. - Hpe3parSdk::VolumeDetailedState



75
76
77
 
# File 'lib/Hpe3parSdk/models.rb', line 75

def failed_states
  @failed_states
end

#host_write_mib ⇒ Object

type - Number

Total written to volume. For TDVVs this includes shared data that this volume references.



147
148
149
 
# File 'lib/Hpe3parSdk/models.rb', line 147

def host_write_mib
  @host_write_mib
end

#id ⇒ Object

type - Number

Volume identifier.



87
88
89
 
# File 'lib/Hpe3parSdk/models.rb', line 87

def id
  @id
end

#links ⇒ Object

type - Array of URL links

Links include the URL for space distribution for a particular volume, and the self URL when querying for the single instance.



94
95
96
 
# File 'lib/Hpe3parSdk/models.rb', line 94

def links
  @links
end

#name ⇒ Object

type - String

Volume name.



98
99
100
 
# File 'lib/Hpe3parSdk/models.rb', line 98

def name
  @name
end

#parent_id ⇒ Object

type - Number

ID of the parent in the snapshot tree (not necessarily the same as the CopyOf VV).



104
105
106
 
# File 'lib/Hpe3parSdk/models.rb', line 104

def parent_id
  @parent_id
end

#phys_parent_id ⇒ Object

type - Number

ID of the physical parent. Valid for a physical copy only.



109
110
111
 
# File 'lib/Hpe3parSdk/models.rb', line 109

def phys_parent_id
  @phys_parent_id
end

#policies ⇒ Object

type - Policy

Policies used for the volume.



113
114
115
 
# File 'lib/Hpe3parSdk/models.rb', line 113

def policies
  @policies
end

#provisioning_type ⇒ Object

type - Number

Volume provisioning. - Hpe3parSdk::VolumeProvisioningType



117
118
119
 
# File 'lib/Hpe3parSdk/models.rb', line 117

def provisioning_type
  @provisioning_type
end

#read_only ⇒ Object

type - Boolean

Enables (true) or disables (false) read/write.



122
123
124
 
# File 'lib/Hpe3parSdk/models.rb', line 122

def read_only
  @read_only
end

#retention_time8601 ⇒ Object

type - String

Time of volume retention time expiration.



127
128
129
 
# File 'lib/Hpe3parSdk/models.rb', line 127

def retention_time8601
  @retention_time8601
end

#retention_time_sec ⇒ Object

type - Number

Time of volume retention expiration.



131
132
133
 
# File 'lib/Hpe3parSdk/models.rb', line 131

def retention_time_sec
  @retention_time_sec
end

#ro_child_id ⇒ Object

type - Number

ID of the read-only child volume in the snapshot tree.



136
137
138
 
# File 'lib/Hpe3parSdk/models.rb', line 136

def ro_child_id
  @ro_child_id
end

#rw_child_id ⇒ Object

type - Number

ID of the read/write child volume in the snapshot tree.



141
142
143
 
# File 'lib/Hpe3parSdk/models.rb', line 141

def rw_child_id
  @rw_child_id
end

#shared_parent_id ⇒ Object

type - Number

The ID of the shared volume that this volume is associated with.



228
229
230
 
# File 'lib/Hpe3parSdk/models.rb', line 228

def shared_parent_id
  @shared_parent_id
end

#size_mib ⇒ Object

type - Number

Detailed Virtual size of volume in MiB (10242 bytes).



161
162
163
 
# File 'lib/Hpe3parSdk/models.rb', line 161

def size_mib
  @size_mib
end

#snap_cpg ⇒ Object

type - String

CPG name from which the snapshot (snap and admin) space is allocated.



166
167
168
 
# File 'lib/Hpe3parSdk/models.rb', line 166

def snap_cpg
  @snap_cpg
end

#snapshot_space ⇒ Object

type - Space

Snapshot space in MiB.



170
171
172
 
# File 'lib/Hpe3parSdk/models.rb', line 170

def snapshot_space
  @snapshot_space
end

#ss_spc_alloc_limit_pct ⇒ Object

type - Number

Sets a snapshot space allocation limit. Prevents the snapshot space of the volume from growing beyond the indicated percentage of the volume size.



178
179
180
 
# File 'lib/Hpe3parSdk/models.rb', line 178

def ss_spc_alloc_limit_pct
  @ss_spc_alloc_limit_pct
end

#ss_spc_alloc_warning_pct ⇒ Object

type - Number

Enables a snapshot space allocation warning. Generates a warning alert when the reserved snapshot space of the virtual volume exceeds the indicated percentage of the virtual volume size. - Hpe3parSdk::VolumeDetailedState



187
188
189
 
# File 'lib/Hpe3parSdk/models.rb', line 187

def ss_spc_alloc_warning_pct
  @ss_spc_alloc_warning_pct
end

#state ⇒ Object

type - Number

State of the volume. - Hpe3parSdk::CPGState



191
192
193
 
# File 'lib/Hpe3parSdk/models.rb', line 191

def state
  @state
end

#total_reserved_mib ⇒ Object

type - Number

Total Reserved space.



156
157
158
 
# File 'lib/Hpe3parSdk/models.rb', line 156

def total_reserved_mib
  @total_reserved_mib
end

#total_used_mib ⇒ Object

type - Number

Total used space. Sum of used UserSpace and used Snapshot space.



152
153
154
 
# File 'lib/Hpe3parSdk/models.rb', line 152

def total_used_mib
  @total_used_mib
end

#udid ⇒ Object

type - Number

User-Defined identifier per VV for OpenVMS hosts.



233
234
235
 
# File 'lib/Hpe3parSdk/models.rb', line 233

def udid
  @udid
end

#user_cpg ⇒ Object

type - String

CPG name from which the user space is allocated.



196
197
198
 
# File 'lib/Hpe3parSdk/models.rb', line 196

def user_cpg
  @user_cpg
end

#user_space ⇒ Object

type - Space

User space in MiB.



200
201
202
 
# File 'lib/Hpe3parSdk/models.rb', line 200

def user_space
  @user_space
end

#usr_spc_alloc_limit_pct ⇒ Object

type - Number

This field sets the user space allocation limit. The user space of the TPVV is prevented from growing beyond the specified percentage of the volume size. After the size is reached, any new writes to the volume will fail.



209
210
211
 
# File 'lib/Hpe3parSdk/models.rb', line 209

def usr_spc_alloc_limit_pct
  @usr_spc_alloc_limit_pct
end

#usr_spc_alloc_warning_pct ⇒ Object

type - Number

This field enables a user space allocation warning. It specifies that a warning alert is generated when the reserved user space of the TPVV exceeds the specified percentage of the volume size.



218
219
220
 
# File 'lib/Hpe3parSdk/models.rb', line 218

def usr_spc_alloc_warning_pct
  @usr_spc_alloc_warning_pct
end

#uuid ⇒ Object

type - String

The UUID that was automatically assigned to the volume at creation.



223
224
225
 
# File 'lib/Hpe3parSdk/models.rb', line 223

def uuid
  @uuid
end

#wwn ⇒ Object

type - String

Volume WWN.



237
238
239
 
# File 'lib/Hpe3parSdk/models.rb', line 237

def wwn
  @wwn
end