CLI:Volume show: Difference between revisions

[unchecked revision][unchecked revision]
Content deleted Content added
No edit summary
Line 13:
 
== Syntax ==
<pre>
The syntax for this commands starts with <code>volume show</code>
cli> volume show -h
volume [ { -id <value> | -name <value> } ] show [ -select <field>,.. ] [ -sort <sort field>[+|-] ] [ -offset <value> ] [ {
-limit <value> | -all } ] [ -output { nvp | csv [ -table ] | table | json [ -raw ] } ]
 
Where <field> is one of:
appliance_id, creation_timestamp, description, id, is_replication_destination, location_history, migration_session_id, name,
node_affinity, node_affinity_l10n, performance_policy_id, protection_data, protection_policy_id, size, state, state_l10n,
type, type_l10n, wwn, <appliance>, <mapped_volumes>, <migration_session>, <protection_policy>, <volume_groups>
 
Where <appliance> is one of:
appliance.id, appliance.name, appliance.service_tag, appliance.express_service_code, appliance.model
 
Where <mapped_volumes> is one of:
mapped_volumes.id, mapped_volumes.host_id, mapped_volumes.host_group_id, mapped_volumes.volume_id,
mapped_volumes.logical_unit_number
 
Where <migration_session> is one of:
migration_session.id, migration_session.name, migration_session.resource_type, migration_session.source_appliance_id,
migration_session.family_id, migration_session.destination_appliance_id, migration_session.state,
migration_session.created_timestamp, migration_session.last_sync_timestamp, migration_session.current_transfer_rate,
migration_session.progress_percentage, migration_session.estimated_completion_timestamp,
migration_session.resource_type_l10n, migration_session.state_l10n
 
Where <protection_policy> is one of:
protection_policy.id, protection_policy.name, protection_policy.description, protection_policy.type,
protection_policy.is_replica, protection_policy.type_l10n
 
Where <volume_groups> is one of:
volume_groups.id, volume_groups.name, volume_groups.description, volume_groups.creation_timestamp,
volume_groups.is_protectable, volume_groups.protection_policy_id, volume_groups.migration_session_id,
volume_groups.is_write_order_consistent, volume_groups.placement_rule, volume_groups.type,
volume_groups.is_replication_destination, volume_groups.protection_data, volume_groups.is_importing,
volume_groups.location_history, volume_groups.type_l10n
 
Where <sort field> is one of:
appliance_id, creation_timestamp, description, id, is_replication_destination, location_history, migration_session_id, name,
node_affinity, node_affinity_l10n, performance_policy_id, protection_data, protection_policy_id, size, state, state_l10n,
type, type_l10n, wwn
 
Where:
[Optional] { -id <value> | -name <value> }
-id <value>
Unique identifier of the volume to query.
 
-name <value>
Unique name of the existing object (volume).
 
[Optional] -select <field>,..
Display selected attributes in the output.
 
[Optional] -sort <sort field>[+|-]
Sorts output
* field+ (or just field) - sort by field in ascending order.
* field- - sort by field in descending order.
 
[Optional] -offset <value>
Start record list starting from specific value.
 
[Optional] { -limit <value> | -all }
-limit <value>
Limits the number of listed records.
 
-all
Query all records.
 
[Optional] -output { nvp | csv [ -table ] | table | json [ -raw ] }
Change the output format.
* nvp - Display output as plain text.
* csv - Display output in CSV format.
* table - Display output in a table.
* json - Display output in JSON format.
 
cli>
</pre>
 
== Example ==