/ 
IBM-StorageSystem-0.045
River stage one • 3 direct dependents • 3 total dependents
/ IBM::StorageSystem::VDisk::Copy

NAME

IBM::StorageSystem::VDisk::Copy - Class for operations with IBM StorageSystem VDisk Copies

VERSION

Version 0.01

SYNOPSIS

IBM::StorageSystem::VDisk::Copy - Class for operations with IBM StorageSystem VDisk Copies

	use IBM::StorageSystem;
        
	my $ibm = IBM::StorageSystem->new( user            => 'admin',
			 	   host            => 'my-v7000',
				   key_path        => '/path/to/my/.ssh/private_key'
			) or die "Couldn't create object! $!\n";

	# Print the status of copy 0 of VDisk 0
	print "Status: " . $ibm->vdisk(0)->copy(0)->status . "\n";

	# Print each VDisk by name and each of the VDisk copies status
	foreach my $vdisk ( $ibm->get_vdisks ) { 
        	print "VDisk : " . $vdisk->name . "\n";

        	foreach my $copy ( $vdisk->get_copys ) { 
        	        printf( "\tCopy: %-2s - Status : %-20s\n", $copy->copy_id, $copy->status )
        	}   
	}

METHODS

autoexpand

Specifies whether autoexpand is enabled on a space-efficient volume. The value can be on or off.

capacity

Returns the volume copy capacity in bytes.

copy_id

Specifies a system-assigned identifier for the volume copy. The value can be 0 or 1.

easy_tier

This value is set by the user and determines whether Easy Tier(R) is permitted to manage the pool.

Note:

  1. If easy_tier is on, then easy_tier_status can take on any value.

  2. if easy_tier is off, then easy_tier_status is measured or inactive.

easy_tier_status

Which Easy Tier functions are active for the volume copy:

Active

May move extents of this volume copy for performance (automatic data placement).

Measured

Statistics are being gathered for this volume copy, but no extents will be moved.

Inactive

No Easy Tier function is active.

fast_write_state

Specifies the cache state of the volume copy. The value can be empty, not_empty, corrupt, or repairing. The value is always empty for non-space-efficient copies. A cache state of corrupt indicates that the volume is space-efficient and requires repair that is initiated by a recovervdisk command or the repairsevdiskcopy command.

free_capacity

Specifies the difference between the real_capacity and used_capacity values.

Remember: This value is zero for fully-allocated copies.

grainsize

For space-efficient volume copies, returns the copy grain size chosen at creation time.

mdisk_grp_id

Returns the volume copy MDisk group numerical ID.

mdisk_grp_name

Returns the volume copy MDisk group name.

mdisk_id

Specifies the ID of the storage pool that the volume copy belongs to.

mdisk_name

Specifies the name of the storage pool that the volume copy belongs to.

overallocation

Expressed as a percentage, specifies the ratio of volume capacity to real_capacity values. This value is always 100 for non-space-efficient volumes.

primary

Indicates whether the volume copy is the primary copy. A volume has exactly one primary copy. The value can be yes or no.

real_capacity

Specifies the amount of physical storage that is allocated from an storage pool to this volume copy. If the volume copy is not space-efficient, the value is the same as the volume capacity. If the volume copy is space-efficient, the value can be different.

Remember: This value is the same as the volume capacity value for fully-allocated copies.

se_copy

Specifies if the copy is space-efficient.

status

The value can be online or offline. A copy is offline if all nodes cannot access the storage pool that contains the copy.

sync

Indicates whether the volume copy is synchronized.

tier

Which tier information is being reported: generic_ssd or generic_hdd.

Note that this method returns an array of the available tier types and that the ordering of these types is preserved from the CLI output. The ordering of these types can be used to retrieve the tier capacity of each tier type with the tier_capacity command.

tier_capacity

The total MDisk capacity assigned to the volume in the tier.

Note: For space-efficient copies, the capacity by tier will be the real capacity.

Also Note that this method returns an array of all values of tier capacity the index of which corresponds with the array indexes of tier types as returned by the tier method.

For example, to print each tier type and the corresponding tier capacity for a copy:

my $copy = $ibm->vdisk(0)->copy(0);

for ( my $i = 0; $i < scalar @{ $copy->tier } ; $i++ ) {
	print "Tier: " . $copy->tier->[$i] .
		" - Capacity: " . $copy->tier_capacity->[$i] . "\n"
}

type

Specifies the virtualization type of the volume. The value can be striped, sequential or image.

used_capacity

Specifies the portion of real_capacity that is being used to store data. For non-space-efficient copies, this value is the same as the volume capacity. If the volume copy is space-efficient, the value increases from zero to the real_capacity value as more of the volume is written to.

Remember: This value is the same as the volume capacity value for fully-allocated copies.

vdisk_id

Returns the VDisk numerical ID of the volume copy.

vdisk_name

Returns the VDisk name of the volume copy.

warning

Expressed as a percentage, for space-efficient volume copies only. A warning is generated when the ratio of used_capacity to volume capacity reaches the specified level.

AUTHOR

Luke Poskitt, <ltp at cpan.org>

BUGS

Please report any bugs or feature requests to bug-ibm-v7000-vdisk-copy at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IBM-StorageSystem-VDisk::Copy. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc IBM::StorageSystem::VDisk::Copy

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Luke Poskitt.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.