Dell PowerStore 5000X EMC PowerStore CLI Guide
Dell PowerStore 5000X Manual
 |
View all Dell PowerStore 5000X manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell PowerStore 5000X manual content summary:
- Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 1
Dell EMC PowerStore CLI Guide - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 2
of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 3
The create action command...8 The set action command...9 The show action command...9 The delete action command...11 Get help...11 Help on the PowerStore CLI client...11 Help on object types...11 Help on actions...12 Manage SSL certificates...13 View the switches...13 Access the system...14 Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 4
to the PowerStore Documentation page at www.dell.com/ powerstoredocs. • Troubleshooting For information about products, software updates, licensing, and service, go to www.dell.com/support and locate the appropriate product support page. • Technical support For technical support and service requests - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 5
to the system through the secure HTTPS protocol using the PowerStore REST API. Install the PowerStore CLI client About this task To install the PowerStore CLI client: Steps 1. Go to your support website. 2. Download the PowerStore CLI client for your operating system. 3. Perform the following - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 6
the installer and follow the prompts. The default installation location is: • 64-bit systems: C:\Program Files\Dell EMC\PowerStore CLI • 32-bit systems: C:\Program Files (x86)\Dell EMC\PowerStore Manager CLI NOTE: Check the box to have the installation directory added to the PATH system variable - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 7
View the switches provides details on all available switches. Object types Object types identify the type of entity on which to perform an action, such as a local_user, host, volume, or cluster. All actions require an object type. The one exception is the -help switch, which can be used without an - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 8
on object types or objects: creating, modifying or configuring, viewing, and deleting. This section explains each of these four action commands. PowerStore CLI command syntax explains the relationship between action commands, object types, and objects. The create action command The create action - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 9
The set action command The set action command modifies an object instance that is specified by object type and object qualifier. If the object identified by the object qualifier does not exist, an error results. Format [] set [] Example The - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 10
Name-value pair format 1: ID SP Ports Health state 2: ID SP Ports Health state = la0_SPA = SPA = eth0_SPA,eth1_SPA = OK (5) = la0_SPB = SPB = eth0_SPB,eth1_SPB = OK (5) Table format ID | SP | Ports | Health state la0_SPA | SPA | eth0_SPA,eth1_SPA | OK (5) la0_SPB | SPB | - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 11
syntax • Details about a specific action such as syntax and description of each parameter Help on the PowerStore CLI client For help on the client, including the use cases, switches, and system requests, type type with the -help switch to view a list of supported action commands. Introduction 11 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 12
of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the false } New value for is_replication_destination property. The modification is only supported for primary and clone volume, only when the current value is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 13
SSL) certificates to secure communications between the CLI client and the system. You can manage these certificates and configure a policy for the PowerStore CLI to use when receiving unknown certificates. All downloaded certificates are stored in the secure, local lockbox on the client system. Save - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 14
for logging in to the system. Specify the port number through which to access the system. NOTE: If you do not include the -port switch, PowerStore CLI accesses the system through default port 443. Save the destination, port pair, and SSL policy as defaults. You can use the -default switch with - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 15
(UTC-03:00) User: admin 1: id = DNS1 addresses = 10.244.53.108, 10.244.53.109 Save PowerStore CLI settings You can save the following settings on the host on which you run PowerStore CLI: • User access credentials, including your username and password, for each system you access For more information - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 16
Table of Contents Compute 1 discovered_initiator 1 show 1 host 2 show 4 create 7 delete 8 set 8 attach 10 detach 11 host_group 11 show 12 create 14 delete 15 set 15 attach 16 detach 16 host_virtual_volume_mapping 17 show 17 host_volume_mapping 20 show 21 vcenter 24 show 24 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 17
refresh 43 import_host_volume 43 show 45 import_psgroup 47 show 48 discover 50 import_psgroup_volume 50 show 52 import_snapshot_schedules 54 import_session 55 show 58 create 62 delete 63 set 63 cancel 64 cleanup 64 cutover 65 pause 65 resume 66 import_storage_center 66 show 67 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 18
show 99 import_vnx_volume 101 show 104 migration_recommendation 107 show 112 create 113 delete 114 create_migration_sessions 114 start_migration_sessions 115 migration_session 115 show 117 create 122 delete 123 cutover 124 pause 124 resume 124 sync 125 Monitoring 126 alert 126 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 19
create 174 delete 174 set 175 replication_session 176 show 178 failover 182 pause 183 reprotect 184 resume 185 sync 185 snapshot_rule 186 show 187 create 189 delete 190 set 190 Settings 191 audit_event 191 show 193 chap_config 195 show 195 set 196 dns 197 show 197 set 198 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 20
upload 216 local_user 216 show 217 create 218 delete 218 set 219 login_session 220 show 220 network 221 show 222 set 224 replace 226 scale 228 ntp 229 show 230 set 231 physical_switch 231 show 232 create 233 delete 235 set 235 role 236 show 237 security_config 238 show 238 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 21
Storage 254 file_dns 254 show 255 create 257 delete 258 set 258 file_ftp 259 show 261 create 264 delete 267 set 267 file_interface 270 show 271 create 274 delete 275 set 275 file_interface_route 276 show 278 create 279 delete 280 set 281 file_kerberos 281 show 282 create 284 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 22
set 302 file_nis 302 show 303 create 305 delete 306 set 306 file_system 307 show 312 create 318 delete 321 set 322 clone 325 refresh 328 refresh_quota 328 restore 329 snapshot 329 file_tree_quota 332 show 334 create 338 delete 338 set 339 refresh 340 file_user_quota 340 show - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 23
nas_server/download 367 group 367 homedir 368 hosts 368 netgroup 369 nsswitch 369 ntxmap 370 passwd 370 user_mapping_report 370 nas_server/upload 371 group 371 homedir 371 hosts 372 netgroup 372 nsswitch 373 ntxmap 373 passwd 374 nfs_export 374 show 376 create 380 delete 382 set - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 24
443 snapshot 444 volume_group 445 show 449 create 453 delete 453 set 454 add_members 455 clone 456 refresh 457 remove_members 458 restore 459 snapshot 460 Support 460 maintenance_window 461 show 461 set 463 service_config 463 show 464 set 465 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 25
service_user 465 show 466 set 466 System and Hardware 467 appliance 467 show 468 set 476 forecast 477 time_to_full 477 bond 478 show 479 cluster 482 show 483 set 484 forecast 485 time_to_full 485 eth_port 486 show 490 set 497 fc_port 498 show 502 set 507 hardware 508 show 514 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 26
- Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 27
- Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 28
Compute Manage host configurations, virtual machines and VMware integration discovered_initiator List initiators currently connected to the cluster that are not associated with an initiator group or host. An initiator currently connected to the cluster, but not associated with any host. Attributes - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 29
host group, if host is part of host group. host_initiators Filtering on the fields of this embedded resource is not supported. See host_initiators for more details os_type_l10n Localized message string corresponding to os_type host_group This is the embeddable reference form of host_group_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 30
import_host_system This is the embeddable reference form of import_host_system_id attribute. See import_host_system for more details mapped_hosts This is the inverse of the resource type host_volume_mapping association. See host_volume_mapping for more details host_virtual_volume_mappings This is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 31
Unique identifier of the appliance containing the session. node_id Unique identifier of node on the appliance on which active session is create. bond_id Unique identifier of the bond the initiator is logged into. Null if one of the following is nonnull: veth_id, eth_port_id or fc_port_id. fc_port_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 32
Attribute id import_host_system.agent_address import_host_system.agent_api_version import_host_system.agent_port import_host_system.agent_status import_host_system.agent_status_l10n import_host_system.agent_type import_host_system.agent_type_l10n import_host_system.agent_version import_host_system. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 33
Attribute os_type os_type_l10n Select X Sort X X X Format host [{-id | -name }] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique id of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 34
Display output in CSV format. table Display output in a table. json Display output in JSON format. create Add a host. Format host create -name -os_type {Windows | Linux | ESXi | AIX | HP-UX | Solaris} ( -initiators -port_name -port_type {iSCSI | FC} [-chap_single_username ] [{ - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 35
be performed are modify name, modify description, remove initiator(s) from host, add initiator(s) to host, update existing initiator(s) with chap username/password. This will only support one of add, remove and update initiator operations in a single request. 8 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 36
Format host {-id | -name } set [-name ] [-description ] [- remove_initiators ,..] ( [-add_initiators -port_name -port_type {iSCSI | FC} [- chap_single_username ] [{-chap_single_password | -chap_single_passwordSecure}] [- - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 37
-chap_single_passwordSecure Secure version of -chap_single_password. Value will be queried interactively. -chap_mutual_username Username for CHAP authentication. This value must be 1 to 64 UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication. - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 38
Format host {-id | -name } attach -volume_id [-logical_unit_number ] [-async] Action qualifiers -id Unique id of the host. -name Unique name of the existing object (host). -volume_id Volume to attach. -logical_unit_number Logical unit number for the volume, if - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 39
associations from host, host_volume_mapping, host_virtual_volume_mapping Attributes id The host group unique identifier. name The host group name. This property supports case-insensitive filtering description A description for the host group. hosts This is the inverse of the resource type host - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 40
Attribute hosts.id hosts.name hosts.os_type hosts.os_type_l10n id mapped_host_groups.host_group_id mapped_host_groups.host_id mapped_host_groups.id mapped_host_groups.logical_unit_number mapped_host_groups.volume_id name Select X Sort X X X X X X X X X X X X Format host_group [{-id < - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 41
fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 42
that can be performed are modify name, remove host(s) from host group, add host(s) to host group. Modify request will only support either a add_host(s) or remove_host(s) at a time along with modifying host name Format host_group {-id | -name } set [-name ] [-description - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 43
-add_host_ids List of hosts to be added to host group. The operation fails if the host(s) to be added are attached to volume. -async Perform asynchronous operation. attach Attach host group to volume. Format host_group {-id | -name } attach -volume_id [-logical_unit_number - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 44
-volume_id Volume to detach. -async Perform asynchronous operation. host_virtual_volume_mapping Virtual volume mapping details. Virtual volume mapping details. This resource type has queriable associations from host, host_group, virtual_volume Attributes id Unique identifier of a mapping between a - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 45
Attribute host.host_initiators host.id host.name host.os_type host.os_type_l10n host_group.description host_group.id host_group.name host_group_id host_id id virtual_volume.appliance_id virtual_volume.creation_timestamp virtual_volume.creator_type virtual_volume.creator_type_l10n virtual_volume. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 46
Attribute virtual_volume.migration_session_id virtual_volume.name virtual_volume.parent_id virtual_volume.profile_id virtual_volume.size virtual_volume.source_id virtual_volume.source_timestamp virtual_volume.storage_container_id virtual_volume.type virtual_volume.type_l10n virtual_volume.usage_type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 47
field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 48
both be set. volume_id Unique identifier of the volume to which the host is attached. logical_unit_number Logical unit number for the host volume access. host This is the embeddable reference form of host_id attribute. See host for more details host_group This is the embeddable reference form of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 49
Attribute host_id id logical_unit_number volume.appliance_id volume.creation_timestamp volume.description volume.id volume.is_replication_destination volume.location_history volume.migration_session_id volume.name volume.node_affinity volume.node_affinity_l10n volume.performance_policy_id volume. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 50
Attribute volume.wwn volume_id Select X Sort X X Format host_volume_mapping [-id ] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 51
of storage container and other functionality that requires communication with vCenter. In Unified+ deployments, the one vCenter instance residing in the PowerStore cluster will be prepopulated here and cannot be deleted, nor may any other vCenters be added. For Unified deployments, one external - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 52
-id Unique identifier of the vCenter to query. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 53
Action qualifiers -address IP address of vCenter host, in IPv4, IPv6, or hostname format. -username User name to login to vCenter. -password Password to login to vCenter. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation. delete - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 54
applicable to VM snapshots. vcenter_instance_uuid UUID instance of the vCenter that hosts the VM. name User-assigned name of the VM in vCenter. This property supports case-insensitive filtering description Description of the VM in vCenter. type Type of VM: Primary A base VM. Template 27 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 55
and snapshot VMs. is_consistent Indicates whether the VM snapshot is crash-consistent. is_consistent_snaps_supported Indicates whether the VM supports creating crash-consistent snapshots. Not applicable to snapshot VMs. protection_data Protection data associated with the VM snapshot. Filtering - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 56
Localized message string corresponding to status protection_policy This is the embeddable reference form of protection_policy_id attribute. See policy for more details parent This is the embeddable reference form of parent_id attribute. See virtual_machine for more details children This is the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 57
Attribute children.cpu_count children.description children.guest_os children.id children.instance_uuid children.is_consistent children.is_consistent_snaps_supported children.memory_mb children.name children.protection_data children.protection_policy_id children.status children.status_l10n children. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 58
Attribute is_consistent is_consistent_snaps_supported memory_mb name parent.cpu_count parent.description parent.guest_os parent.id parent.instance_uuid parent.is_consistent parent.is_consistent_snaps_supported parent.memory_mb parent.name parent.protection_data parent.protection_policy_id parent. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 59
Attribute protection_policy.description protection_policy.id protection_policy.is_replica protection_policy.name protection_policy.type protection_policy.type_l10n protection_policy_id status status_l10n type type_l10n vcenter_instance_uuid Select X Sort X X X X X X X X X X X X X X - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 60
field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 61
Perform asynchronous operation. set Modify a virtual machine. This operation cannot be used on virtual machine snapshots or templates. Format virtual_machine {-id | -name } set [-protection_policy_id ] [-async] Action qualifiers -id Unique identifier of the virtual machine to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 62
Protocol type is internet SCSI. FC Protocol type is Fibre Channel. FCoE Protocol type is Fibre Channel over Ethernet. Unknown Protocol type is unknown to PowerStore. import_host_system_id Unique identifier of the import host system. protocol_l10n Localized message string corresponding to protocol 35 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 63
show Property capabilities Attribute id import_host_system_id iqn_or_wwn protocol protocol_l10n Select X Sort X X X X X X X X X Format import_host_initiator [-id ] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-output {nvp | csv - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 64
with the import_host_system details. Also, import_host_system supports FC and ISCSI connections between Host and source arrays. So for a single import_host_system which supports both FC and ISCSI; there would be Power_Path POWER PATH MPIO. Unknown Type of host agent is unknown to PowerStore. 37 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 65
import host system. Valid values are: Windows Windows. Linux Linux. ESXi ESXi. Unknown Operating system of the host system is unknown to PowerStore. os_version Operating system version of the import host system. agent_status Status of the import host system. Valid values are: Unknown Agent status - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 66
last_update_time Time when the import host system was last updated. agent_type_l10n Localized message string corresponding to agent_type os_type_l10n Localized message string corresponding to os_type agent_status_l10n Localized message string corresponding to agent_status hosts This is the inverse - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 67
Attribute hosts.os_type hosts.os_type_l10n id last_update_time os_type os_type_l10n os_version user_name Select X Sort X X X X X X X X X X X X X Format import_host_system [-id ] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 68
-all Query all records. -output 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. create Add an import host system so that it can be mapped to a volume. Before mapping an import host - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 69
Unknown Operating system of the host system is unknown to PowerStore. -agent_address Hostname or IPv4 address of the import host system. -agent_port TCP port of the import host system. -user_name Username for the import host system. - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 70
id Unique identifier of the import host volume. host_system_id Unique identifier of the import host system. name Name of the import host volume. This property supports case-insensitive filtering array_type 43 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 71
host volume is migrating. active_path Active path of the host volume. protocols Supported protocols for the import host volume. mount_paths Mount paths on the import ongoing cancel operation. None Migration state is not known to PowerStore. naa_id Unique identifier of a volume that is presented to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 72
Time when the import host volume was last updated. array_type_l10n Localized message string corresponding to array_type status_l10n Localized message string corresponding to status active_path_l10n Localized message string corresponding to active_path protocols_l10n Localized message array - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 73
Attribute naa_id name protocols protocols_l10n size status status_l10n Select X Sort X X X X X X X X X X X X X Format import_host_volume [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 74
Peer Storage Group (PS Group) volumes that can be imported to PowerStore. PS Group details. This resource type has queriable association from import_psgroup_volume PS Group. name Name of the PS Group. This property supports case-insensitive filtering serial_number Serial number of the PS Group. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 75
address is not configured, this address is also used for management operations. last_update_time Time when the PS Group was last updated. import_psgroup_volumes This is the inverse of the resource type import_psgroup_volume association. See import_psgroup_volume for more details show Property - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 76
Attribute import_psgroup_volumes.wwn last_update_time management_address name serial_number user_name Select X Sort X X X X X X X X X X Format import_psgroup [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 77
operation. import_psgroup_volume Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. PS Group volume instance details. This resource type has queriable association from import_psgroup Attributes id Unique identifier of the volume - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 78
import_psgroup_id Unique identifier of the PS Group with which the volume is associated. name Name of the volume. This property supports case-insensitive filtering size Size of the volume, in bytes. block_size Block size of the volume. Valid values are: 512_Bytes 512 byte block size. 4K_Bytes - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 79
Aborted Volume migration is aborted Unknown Volume migration state is unknown to PowerStore. importable_criteria Volume import criteria. If the value is not Ready, the volume is not importable. host_volume_ids Unique identifiers of the host volumes associated with the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 80
Attribute import_psgroup.management_address import_psgroup.name import_psgroup.serial_number import_psgroup.user_name import_psgroup_id importable_criteria importable_criteria_l10n is_online is_read_only migration_state migration_state_l10n name size wwn Select X Sort X X X X X X X X X X - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 81
-sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 82
the migration of volumes and consistency groups from a heritage Dell EMC storage system to a PowerStore storage system. The import is non-disruptive to hosts User-specified name of the import session. This property supports case-insensitive filtering description User-specified description of the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 83
) order. This occurs when there are more active import sessions than supported. In_Progress Indicates that a queued import session is now in progress. estimated time left for the copy. Host IOs are pointed to PowerStore in this state. The import process keeps the source and destination - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 84
Indicates that an attempt to cancel the import of a volume failed in a consistency group import. Cancel_In_Progress Indicates that a cancel is in progress. Cleanup_In_Progress Indicates that the import of one or more volumes in a consistency group failed. When this occurs, you must roll back the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 85
protection_policy_id Unique identifier of the local protection policy in the PowerStore storage system that will be applied on an imported destination volume or consistency group after cutover. Only snapshot policies are supported in an import. Once the import completes, you can add a replication - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 86
Attribute automatic_cutover average_transfer_rate current_transfer_rate description destination_resource_id destination_resource_type destination_resource_type_l10n error estimated_completion_timestamp id last_update_timestamp name parent_session_id progress_percentage protection_policy_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 87
Attribute remote_system.discovery_chap_mode remote_system.discovery_chap_mode_l10n remote_system.id remote_system.iscsi_addresses remote_system.management_address remote_system.name remote_system.serial_number remote_system.session_chap_mode remote_system.session_chap_mode_l10n remote_system.state - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 88
field offset ] [{-limit | -all}] [-output {nvp | csv [-table] [noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the import session -name Unique name of the existing object (import_session). -select Display selected attributes in the output. -sort Sorts - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 89
name must be unique in the PowerStore cluster and can contain a maximum Indicates whether the import session cutover is manual (true) or automatic (false). -protection_policy_id group after the import completes. Only snapshot policies are supported in an import. Once the import completes, you can - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 90
Date and time at which the import session is scheduled to start. The date time is specified in ISO 8601 format with the time expressed in UTC format. -async Perform asynchronous operation. delete Delete an import session that is in a Completed, Failed, or Cancelled state. Delete removes the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 91
cancel Cancel an active import session. Cancel is allowed when the import is in a Scheduled, Queued, Copy_In_Progress, or Ready_For_Cutover state. After a successful cancellation, the host is mapped to original source volume, all paths are cleaned up, and the import state is Cancelled. The import - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 92
the Cutover operation to complete the import. Until the cutover is complete, PowerStore forwards IO to the source volume to keep it in sync with all data copy stops, but IO to the source still occurs. Pause is only supported when the import job is in a in Copy_In_Progress state. You can resume or - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 93
and consistency groups that can be imported to PowerStore. This resource type has queriable associations from source storage system for import. name Name of the SC array. This property supports case-insensitive filtering management_address Management address to use for communicating with the SC - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 94
: Up Volume state is up. Down Volume state is down. Degraded Volume is in degraded state. Unknown Volume migration state is unknown to PowerStore. last_update_time Timestamp at which the SC array details were last updated. This includes the information about the array and its importable volumes and - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 95
Attribute import_storage_center_consistency_groups.importable_criteria Select X Sort import_storage_center_consistency_groups.importable_criteria_l10n X import_storage_center_consistency_groups.name X import_storage_center_volumes.health X import_storage_center_volumes.health_l10n X - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 96
Attribute management_address model name serial_number status status_l10n user_name Select X Sort X X X X X X X X X X X X X Format import_storage_center [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 97
Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_storage_center_volume, import_storage_center Attributes id Unique identifier of the SC consistency group. 70 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 98
name Name of the SC consistency group. This property supports case-insensitive filtering import_storage_center_id Unique identifier of the SC array. importable_criteria Volume import criteria. If the value is not Ready, the volume is not importable. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 99
Attribute import_storage_center.user_name Select X Sort import_storage_center_id X X import_storage_center_volumes.health X import_storage_center_volumes.health_l10n X import_storage_center_volumes.host_volume_ids X import_storage_center_volumes.id X import_storage_center_volumes. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 100
Attribute name Select X Sort X Format import_storage_center_consistency_group [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 101
Center (SC) volumes that can be imported to PowerStore. This resource type has queriable associations from import_storage_center, import_storage_center_consistency_group the SC volume. name Name of the SC volume. This property supports case-insensitive filtering size Size of the SC volume, in bytes. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 102
in progress. ◦ Done- Volume is migrated. Aborted Volume migration is aborted Not_Applicable Volume migration state is not applicable when storage system supports only agentless import Unknown Volume migration state is unknown to PowerStore. is_read_only Indicates whether the volume is read-only. 75 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 103
importable_criteria Volume import criteria. If the value is not Ready, the volume is not importable. host_volume_ids List of host volume identifiers that correspond to SC volumes. import_storage_center_consistency_group_id Unique identifier of an SC consistency group, if the volume is part of one - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 104
Attribute import_storage_center.id import_storage_center.last_update_time import_storage_center.management_address import_storage_center.model import_storage_center.name import_storage_center.serial_number import_storage_center.status import_storage_center.status_l10n import_storage_center.user_name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 105
Attribute migration_state migration_state_l10n name size wwn Select X Sort X X X X X X X X X Format import_storage_center_volume [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 106
that is a source storage system for import. This is the serial number of the storage system. name Name of the Unity storage system. This property supports case-insensitive filtering 79 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 107
of the Unity storage system. software_version Software version of the Unity storage system. api_version Version of the API that the Unity storage system supports. health Health status of the Unity storage system. Values are: Unknown The status of the system cannot be determined. Ok The system is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 108
last_updated_timestamp Date and time when the Unity storage system details were last updated. These details include the Unity storage system and information about its importable volumes and consistency groups. The timestamp is updated when the Unity storage system is created and whenever the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 109
Attribute import_unity_volumes.id import_unity_volumes.import_unity_consistency_group_id import_unity_volumes.import_unity_id import_unity_volumes.importable_criteria import_unity_volumes.importable_criteria_l10n import_unity_volumes.is_replication_destination import_unity_volumes.is_thin_clone - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 110
Format import_unity [{-id | -name }] show [-select ,..] [-sort [+|],..] [-offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the Unity storage system. -name Unique - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 111
the Unity consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_unity_volume, import_unity group. name Name of the consistency group. This property supports case-insensitive filtering import_unity_id Unique identifier of the Unity storage - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 112
show Property capabilities Attribute id import_unity.api_version import_unity.health import_unity.health_l10n import_unity.id import_unity.last_updated_timestamp import_unity.management_address import_unity.model import_unity.name import_unity.serial_number import_unity.software_version import_unity - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 113
Attribute import_unity_volumes.importable_criteria_l10n import_unity_volumes.is_replication_destination import_unity_volumes.is_thin_clone import_unity_volumes.migration_state import_unity_volumes.migration_state_l10n import_unity_volumes.name import_unity_volumes.size import_unity_volumes.type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 114
field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 115
discover the Unity volumes that can be imported to PowerStore. This resource type has queriable associations from import_unity, WWN) of the Unity volume. name Name of the Unity volume. This property supports case-insensitive filtering size Size of the Unity volume, in bytes. import_unity_id Unique - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 116
migration is in progress. Completed The volume is migrated. Aborted Volume migration is cancelled. Not_Applicable Volume migration state is not applicable if the system only supports agentless import. Unknown 89 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 117
The volume migration state is unknown to PowerStore. is_replication_destination Indicates whether the Unity volume is a replication destination. is_thin_clone Indicates whether the Unity volume is a thin clone. importable_criteria Volume import criteria. If the value - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 118
Attribute import_unity.api_version import_unity.health import_unity.health_l10n import_unity.id import_unity.last_updated_timestamp import_unity.management_address import_unity.model import_unity.name import_unity.serial_number import_unity.software_version import_unity.user_name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 119
Attribute is_thin_clone migration_state migration_state_l10n name size type type_l10n wwn Select X Sort X X X X X X X X X X X X X X X Format import_unity_volume [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 120
object (import_unity_volume). -async Perform asynchronous operation. import_vnx_array Use these resource types to discover the VNX storage system that can be imported to PowerStore. This resource type has queriable associations from import_vnx_volume, import_vnx_consistency_group Attributes 93 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 121
id Unique identifier of the VNX storage system. name Name of the VNX storage system. This property supports case-insensitive filtering serial_number Serial number of the VNX storage system. management_address Management address for communicating with the VNX storage system. This is usually the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 122
show Property capabilities Attribute alternate_management_address id import_vnx_consistency_groups.id import_vnx_consistency_groups.import_vnx_array_id import_vnx_consistency_groups.importable_criteria import_vnx_consistency_groups.importable_criteria_l10n import_vnx_consistency_groups.name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 123
Attribute is_faulted last_updated_timestamp management_address model name serial_number software_version user_name Select X Sort X X X X X X X X X X X X X X X Format import_vnx_array [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 124
existing object (import_vnx_array). -async Perform asynchronous operation. import_vnx_consistency_group Use this resource type to show the VNX consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_vnx_volume, import_vnx_array Attributes 97 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 125
is not compatible. Undetermined The import status cannot be determined due to an internal error. Contact technical support. importable_criteria_l10n Localized message string corresponding to importable_criteria import_vnx_volumes This is the inverse of the resource type import_vnx_volume association - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 126
import_vnx_volume for more details import_vnx_array This is the embeddable reference form of import_vnx_array_id attribute. See import_vnx_array for more details show Property capabilities Attribute id import_vnx_array.alternate_management_address import_vnx_array.id import_vnx_array.is_faulted - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 127
Attribute import_vnx_volumes.import_vnx_consistency_group_id import_vnx_volumes.importable_criteria import_vnx_volumes.importable_criteria_l10n import_vnx_volumes.migration_state import_vnx_volumes.migration_state_l10n import_vnx_volumes.name import_vnx_volumes.size import_vnx_volumes.wwn - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 128
to show the VNX volumes and that can be imported to PowerStore. This resource type has queriable associations from import_vnx_array, import_vnx_consistency_group the VNX volume. name Name of the VNX volume. This property supports case-insensitive filtering wwn World wide name of the VNX volume. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 129
volume is migrated. * Aborted - Volume migration is cancelled. * Not_Applicable - Volume migration state is not applicable if the system only supports agentless import. * Unknown - The volume migration state cannot be determined. import_vnx_array_id Unique identifier of the VNX storage system where - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 130
The import status cannot be determined due to an internal error. Contact technical support. Host_Volume_Offline The host volume is offline. Cluster_Node_Count_MisMatch The host or hosts added to the appliance are not part of the host cluster to which the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 131
XtremIO_Severity_Inappropriate The severity level of the XtremIO system is not suitable for import. XtremIO_State_Inappropriate The state of the XtremIO system is not suitable for import. XtremIO_Volume_Severity_Inappropriate The severity level XtremIO volume is not suitable for import. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 132
Attribute import_vnx_array.id import_vnx_array.is_faulted import_vnx_array.last_updated_timestamp import_vnx_array.management_address import_vnx_array.model import_vnx_array.name import_vnx_array.serial_number import_vnx_array.software_version import_vnx_array.user_name import_vnx_array_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 133
Attribute size wwn Select X Sort X X X Format import_vnx_volume [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 134
Display output in CSV format. table Display output in a table. json Display output in JSON format. migration_recommendation The system produces migration recommendations periodically or upon request, based on capacity usage and recent performance. A recommendation can then be implemented using the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 135
recommendation is paused. Paused migration sessions can be resumed manually. Migration_Error At least one migration session for this recommendation Filtering on the fields of this embedded resource is not supported. See request_parameters for more details sessions_created_timestamp Time at which - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 136
type_l10n Localized message string corresponding to type Attributes of request_parameters evacuate_appliance Evacuate appliance by specifying optional space_to_free See evacuate_appliance for more details Attributes of migration_actions resource_id ID of storage resource migrated by this action. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 137
Migration_Paused The migration session for this recommended action is paused. Migration_Error The migration session for this recommended action has failed. Migration_Successful The migration session for this recommended action has been successfully completed. primary_id Unique ID of the primary - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 138
Resource is not attached to any host. No_Virtual_Machine_Attached Resource is not attached to any virtual machine. Attached_To_Host Resource is attached to host. Attached_To_Virtual_Machine Resource is attached to virtual machine. Volume_Group_Member Resource is a member of volume group. Unspecified - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 139
show Property capabilities Attribute created_timestamp estimated_cost id migration_actions request_parameters rescan_host_list sessions_completed_timestamp sessions_created_timestamp state state_l10n type type_l10n Select X Sort X X X X X X X X X X X X X X X X X X X X X X X - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 140
field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 141
Optional desired amount of used storage (in bytes) to move to other appliances. If space_to_free is not specified, space to be freed is estimated by the system such that migrating objects equivalent to that much amount of storage space would clear Major severity capacity alarm on the appliance. If - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 142
of the migration session instance. name User-specified friendly name of the migration session instance. This property supports caseinsensitive filtering resource_type Storage resource types eligible for migration. source_appliance_id Unique identifier of the source appliance instance. family_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 143
state Migration session states. Initializing Migration session starts and stays in this state until the session initialization completes. Initialized Migration session transitions to this state when session initialization completes. Synchronizing Background copy is in progress. Idle Migration - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 144
Transfer rate of the current sync operation in bytes/sec. progress_percentage Progress percentage of the current sync operation. estimated_completion_timestamp Estimated completion time of the current sync operation. resource_type_l10n Localized message string corresponding to resource_type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 145
Attribute last_sync_timestamp name progress_percentage replication_sessions.estimated_completion_timestamp replication_sessions.id replication_sessions.last_sync_timestamp replication_sessions.local_resource_id replication_sessions.progress_percentage replication_sessions.remote_resource_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 146
Attribute state state_l10n virtual_volumes.appliance_id virtual_volumes.creation_timestamp virtual_volumes.creator_type virtual_volumes.creator_type_l10n virtual_volumes.family_id virtual_volumes.id virtual_volumes.io_priority virtual_volumes.io_priority_l10n virtual_volumes.is_readonly - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 147
Attribute virtual_volumes.type_l10n virtual_volumes.usage_type virtual_volumes.usage_type_l10n virtual_volumes.virtual_machine_uuid volume_groups.creation_timestamp volume_groups.description volume_groups.id volume_groups.is_importing volume_groups.is_protectable volume_groups. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 148
Attribute volumes.description volumes.id volumes.is_replication_destination volumes.location_history volumes.migration_session_id volumes.name volumes.node_affinity volumes.node_affinity_l10n volumes.performance_policy_id volumes.protection_data volumes.protection_policy_id volumes.size volumes. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 149
created in this phase and no background copy is performed until either the sync or cutover operation is invoked. There are no interruptions to any services during this phase. 122 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 150
a maximum of 32 Unicode characters. It cannot contain unprintable characters, special HTTP characters, or whitespace. -automatic_cutover Indicates whether the migration session cutover is manual or automatic. Default for virtual_volume resource type migrations is automatic, otherwise the default is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 151
-force Indicates whether all migration activities will be canceled before deleting the session. -async Perform asynchronous operation. cutover Final phase of the migration, when ownership of the volume, vVol, or volume group is transferred to the new appliance. Format migration_session {-id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 152
the majority of the background copy is completed and there are no interruptions to any services. Sync can be run multiple times to reduce the amount of data that must Indicates whether the migration session cutover is manual or automatic. Default is manual. -async Perform asynchronous operation. 125 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 153
the resource instance which generated this alert. resource_name Name of the resource instance which generated this alert. This property supports caseinsensitive filtering description_l10n Latest event's description text for this alert. generated_timestamp Timestamp of the latest event for this alert - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 154
Timestamp of the event that cleared this alert. called_home_timestamp Timestamp when the event resulted in a notification to support (via Secured Remote Services), if any. email_sent_timestamp Timestamp when the email was sent for the raised alert, if any. acknowledged_timestamp Timestamp - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 155
. system_impact_l10n Describes the possible effect on the system of this event. repair_flow_l10n Suggestions for how to resolve any problems that may arise from this event. severity_l10n Localized message string corresponding to severity resource_type_l10n Localized message string corresponding to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 156
Attribute resource_id resource_name resource_type resource_type_l10n severity severity_l10n state state_l10n Select X Sort X X X X X X X X X X X X X X X Format alert [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 157
of interest happened in the system. Normally, an event that requires attention will generate an alert as well. So, although they may be interesting for troubleshooting, it is not necessary to monitor events. 130 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 158
resource instance which generated this event. This property supports caseinsensitive filtering generated_timestamp Timestamp at which this event occured of this event. repair_flow_l10n Suggestions for how to resolve any problems that may arise from this event. severity_l10n Localized message string - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 159
Attribute generated_timestamp id repair_flow_l10n resource_id resource_name resource_type resource_type_l10n severity severity_l10n system_impact_l10n Select X Sort X X X X X X X X X X X X X X X X X X X Format event [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 160
. resource_id Unique identifier of the resource on which the job is operating. resource_name Name of the resource on which the job is operating. This property supports case-insensitive filtering description_l10n Description of the job. 133 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 161
response_body Base response object Filtering on the fields of this embedded resource is not supported. May be one of the following types: ◦ job_appliance_forecast_response ◦ job_appliance_time_to_full_response ◦ job_cluster_forecast_response ◦ job_cluster_time_to_full_response ◦ job_create_response - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 162
◦ job_volume_clone_response ◦ job_volume_group_clone_response ◦ job_volume_group_refresh_response ◦ job_volume_group_restore_response ◦ job_volume_group_snapshot_response ◦ job_volume_refresh_response ◦ job_volume_restore_response ◦ job_volume_snapshot_response ◦ job_vvol_error_response step_order - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 163
high_value Estimate for the upper bound forecasted value on that particular time. Attributes of job_appliance_time_to_full_response appliance_id Unique ID of appliance. end_of_forecast Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 164
low_value Estimate of the lower bound of the 95% confidence interval for the forecast value at the given timestamp. mean_value Estimate for the mean forecast value at the given timestamp. high_value Estimate of the upper bound of the 95% confidence interval for the forecast value at the given - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 165
time_to_full_status_l10n Localized message string corresponding to time_to_full_status Attributes of job_create_response id Unique identifier of the new instance created. Attributes of job_error_response messages See messages for more details Attributes of job_file_system_clone_response id The id of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 166
rescan_host_list IDs of attached hosts that require a rescan to ensure accessibility of migrated storage objects after migrations complete. Attributes of job_migration_session_create_response id Identifier of the migration_session object. rescan_host_ids List of hosts that be rescanned before a - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 167
backup_snapshot_id Attributes of job_volume_restore_response backup_snapshot_id Attributes of job_volume_snapshot_response id Attributes of job_vvol_error_response error_code description Attributes of messages code Hexadecimal error code of the message. severity Message severity. message_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 168
Attribute children.progress_percentage children.resource_action children.resource_action_l10n children.resource_id children.resource_name children.resource_type children.resource_type_l10n children.response_body children.root_id children.start_time children.state children.state_l10n children. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 169
Attribute leafs.id leafs.parent_id leafs.progress_percentage leafs.resource_action leafs.resource_action_l10n leafs.resource_id leafs.resource_name leafs.resource_type leafs.resource_type_l10n leafs.response_body leafs.root_id leafs.start_time leafs.state leafs.state_l10n leafs.step_order leafs.user - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 170
Attribute parent.progress_percentage parent.resource_action parent.resource_action_l10n parent.resource_id parent.resource_name parent.resource_type parent.resource_type_l10n parent.response_body parent.root_id parent.start_time parent.state parent.state_l10n parent.step_order parent.user parent_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 171
Attribute resource_type_l10n response_body root.description_l10n root.end_time root.estimated_completion_time root.id root.parent_id root.progress_percentage root.resource_action root.resource_action_l10n root.resource_id root.resource_name root.resource_type root.resource_type_l10n root. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 172
Attribute root_id start_time state state_l10n step_order user Select X Sort X X X X X X X X X X X Format job [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 173
One_Hour | One_Day}] [-output {nvp | csv [-table] [- noformat] | table | json [-raw]}] Action qualifiers -entity An enum describing the various entities supported by metrics. performance_metrics_by_appliance Appliance performance metrics. performance_metrics_by_node Node performance metrics. 146 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 174
performance_metrics_by_volume Volume performance metrics. performance_metrics_by_cluster Cluster performance metrics. performance_metrics_by_vm Virtual Machine performance metrics. performance_metrics_by_vg Storage performance metrics for all volumes in a volume group - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 175
copy_metrics_by_appliance Appliance copy metrics copy_metrics_by_cluster Cluster copy metrics copy_metrics_by_vg Copy metrics for each volume group copy_metrics_by_remote_system Copy metrics for each remote system copy_metrics_by_volume Copy metrics for each volume performance_metrics_by_file_system - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 176
resource type has queriable associations from performance_rule, snapshot_rule, replication_rule, virtual_machine, volume, volume_group, file_system Attributes id Unique identifier of the policy. name Policy name. This property supports case-insensitive filtering description Policy description. 149 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 177
type Supported policy types. Protection A protection policy, consisting of snapshot and replication rules. Performance A performance policy, consisting of performance rules. is_replica Indicates whether this is a replica policy, - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 178
Attribute description file_systems.access_policy file_systems.access_policy_l10n file_systems.access_type file_systems.access_type_l10n file_systems.creation_timestamp file_systems.creator_type file_systems.creator_type_l10n file_systems.default_hard_limit file_systems.default_soft_limit - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 179
Attribute file_systems.is_smb_no_notify_enabled file_systems.is_smb_notify_on_access_enabled file_systems.is_smb_notify_on_write_enabled file_systems.is_smb_op_locks_enabled file_systems.is_smb_sync_writes_enabled file_systems.last_refresh_timestamp file_systems.last_writable_timestamp file_systems. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 180
Attribute performance_rules.io_priority_l10n performance_rules.name replication_rules.alert_threshold replication_rules.id replication_rules.is_replica replication_rules.name replication_rules.remote_system_id replication_rules.rpo replication_rules.rpo_l10n snapshot_rules.days_of_week - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 181
Attribute virtual_machines.description virtual_machines.guest_os virtual_machines.id virtual_machines.instance_uuid virtual_machines.is_consistent virtual_machines.is_consistent_snaps_supported virtual_machines.memory_mb virtual_machines.name virtual_machines.protection_data virtual_machines. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 182
Attribute volume_groups.is_write_order_consistent volume_groups.location_history volume_groups.migration_session_id volume_groups.name volume_groups.placement_rule volume_groups.protection_data volume_groups.protection_policy_id volume_groups.type volume_groups.type_l10n volumes.appliance_id volumes - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 183
Attribute volumes.protection_policy_id volumes.size volumes.state volumes.state_l10n volumes.type volumes.type_l10n volumes.wwn Select X Sort X X X X X X Format policy [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 184
-all Query all records. -output 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. create Create a new protection policy. Protection policies can be assigned to volumes or volume groups. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 185
-async Perform asynchronous operation. delete Delete a protection policy. Protection policies that are used by any storage resources can not be deleted. Format policy -id delete [-async] Action qualifiers -id Unique identifier of the protection policy to be deleted. -async Perform - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 186
for replication remote protection and import use-cases. Refer to the RemoteSystemTypeEnum specification for a list of system types supported. NOTE Before creating a remote system relationship with PowerStore remote systems, first establish a Certificate Based Trust between the local and remote - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 187
for the non-PowerStore remote system. data_network_latency Network latency for the remote system. data_connections List of data connections from each appliance in the local cluster to iSCSI target IP address. Filtering on the fields of this embedded resource is not supported. See data_connections - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 188
session_chap_mode_l10n Localized message string corresponding to session_chap_mode data_network_latency_l10n Localized message string corresponding to data_network_latency import_sessions This is the inverse of the resource type import_session association. See import_session for more details - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 189
Attribute description discovery_chap_mode discovery_chap_mode_l10n id import_sessions.automatic_cutover import_sessions.average_transfer_rate import_sessions.current_transfer_rate import_sessions.description import_sessions.destination_resource_id import_sessions.destination_resource_type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 190
Attribute import_sessions.source_resource_id import_sessions.state import_sessions.state_l10n import_sessions.volume_group_id iscsi_addresses management_address name replication_sessions.estimated_completion_timestamp replication_sessions.id replication_sessions.last_sync_timestamp - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 191
Attribute replication_sessions.storage_element_pairs serial_number session_chap_mode session_chap_mode_l10n state state_l10n type type_l10n user_name Select X Sort X X X X X X X X X X X X X X X X Format remote_system [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 192
, include the following parameters: Management address Either an IPv4 or IPv6 address. FQDN is not supported. • Type of remote system • Data network latency type For PowerStore remote system relationships, the relationship is created in both directions. Remote protection policies can be configured - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 193
| High}] [-async] Action qualifiers -management_address Management IP address of the remote system instance. Only IPv4 is supported for nonPowerStore remote systems. Both IPv4 and IPv6 are supported for PowerStore remote systems. -name User-specified name of the remote system. Used only for non - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 194
connection to the remote system. Must be specified when creating a non-PowerStore remote system. -import_chap_info Chap information to be used for session and discovery. This is applicable to non-PowerStore remote systems. -target_session_username Username used by the target to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 195
no management connectivity between the local and remore systems. Only the local end of the relationship is deleted. Manually log in to the remote PowerStore system and remove the relationship. Format remote_system {-id | -name } delete [-async] Action qualifiers -id Unique identifier - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 196
list of valid parameters depends on the type of remote system. For PowerStore remote system relationships: • Description Management address An IPv4 or IPv6 address. FQDN is not supported. For non-PowerStore remote system relationships: • Name • Description Management address An IPv4 address. FQDN is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 197
systems. -remote_passwordSecure Secure version of -remote_password. Value will be queried interactively. -data_network_latency Network latency for the PowerStore remote system. -async Perform asynchronous operation. verify Verify and update the remote system instance. Detects changes in the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 198
id Unique identifier of the replication rule. name Name of the replication rule. This property supports case-insensitive filtering rpo Recovery point objective (RPO), which is the acceptable amount of data, measured in units of time, that may be lost in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 199
Attribute policies.description policies.id policies.is_replica policies.name policies.type policies.type_l10n remote_system_id replication_sessions.estimated_completion_timestamp replication_sessions.id replication_sessions.last_sync_timestamp replication_sessions.local_resource_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 200
Attribute replication_sessions.storage_element_pairs rpo rpo_l10n Select X Sort X X X X Format replication_rule [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 201
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a new replication rule. Format replication_rule create -name -rpo {Five_Minutes | Fifteen_Minutes | Thirty_Minutes | One_Hour | Six_Hours | Twelve_Hours | One_Day} - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 202
Format replication_rule {-id | -name } delete [-async] Action qualifiers -id Unique identifier of the replication rule. -name Unique name of the existing object (replication_rule). -async Perform asynchronous operation. set Modify a replication rule. If the rule is associated with a - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 203
-rpo Recovery point objective (RPO), which is the acceptable amount of data, measured in units of time, that may be lost in case of a failure. -remote_system_id Unique identifier of the remote system to which this rule will replicate the associated resources. -alert_threshold Acceptable delay in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 204
group. For volume/virtual volume replication session, there will be only one storage element pair. Filtering on the fields of this embedded resource is not supported. See storage_element_pairs for more details state_l10n Localized message string corresponding to state role_l10n 177 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 205
Localized message string corresponding to role resource_type_l10n Localized message string corresponding to resource_type remote_system This is the embeddable reference form of remote_system_id attribute. See remote_system for more details migration_session This is the embeddable reference form of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 206
Attribute migration_session.current_transfer_rate migration_session.destination_appliance_id migration_session.estimated_completion_timestamp migration_session.family_id migration_session.id migration_session.last_sync_timestamp migration_session.name migration_session.progress_percentage - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 207
Attribute remote_system.discovery_chap_mode remote_system.discovery_chap_mode_l10n remote_system.id remote_system.iscsi_addresses remote_system.management_address remote_system.name remote_system.serial_number remote_system.session_chap_mode remote_system.session_chap_mode_l10n remote_system.state - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 208
Attribute replication_rule.rpo_l10n replication_rule_id resource_type resource_type_l10n role role_l10n state state_l10n storage_element_pairs Select X Sort X X X X X X X X X X X X X X X X Format replication_session [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 209
Limits the number of listed records. -all Query all records. -output 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. failover Fail over a replication session instance. Failing over the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 210
destination resource from a preview synchronized point-in-time snapshot referred to as replication common-base. After an unplanned failover, you can restore the system from any point-in-time snapshots on the new source resource. Unplanned failovers place the original source resource into destination - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 211
Remembers the restart address before pausing, and resumes from the restart address as recorded when the system entered the System_Paused state In case of loss of network connectivity between two sites, the replication session is paused only on the local system where it is issued. Pause the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 212
with changes on source resource from the previous synchronization cycle. Synchronization happens either automatically according to a set schedule, or manually. User and scheduler-created snapshots are synchronized from the source system to the destination system while maintaining block sharing - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 213
instance. This resource type has queriable association from policy Attributes id Unique identifier of the snapshot rule. name Snapshot rule name. This property supports case-insensitive filtering interval Interval between snapshots. Either the interval parameter or the time_of_day parameter may 186 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 214
be set. Setting one clears the other parameter. time_of_day Time of the day to take a daily snapshot, with format "hh:mm" in 24 hour time format. Either the interval parameter or the time_of_day parameter will be set, but not both. days_of_week Days of the week when the rule should be applied. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 215
Attribute name policies.description policies.id policies.is_replica policies.name policies.type policies.type_l10n time_of_day Select X Sort X X X X X X X X X Format snapshot_rule [{-id | -name }] show [-select ,..] [-sort [+|],..] [-offset ] [{- - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 216
-limit Limits the number of listed records. -all Query all records. -output 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. create Create a new snapshot rule. Format snapshot_rule - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 217
-days_of_week Days of the week when the rule should be applied. Applies only for rules where the time_of_day parameter is set. -async Perform asynchronous operation. delete Delete a snapshot rule Format snapshot_rule {-id | -name } delete [-delete_snaps {yes | true | no | false}] [ - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 218
Unique identifier of the snapshot rule. -name Unique name of the existing object (snapshot_rule). -name Snapshot rule name. -interval Interval between snapshots. Either the interval parameter or the time_of_day parameter may be set. Setting one clears the other parameter. -time_of_day Time of the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 219
Authentication All the authentication events on the system. Authorization All the authorization events on the system. Config All the set operations on the system. Example: POST, PATCH, DELETE. System All the system level operations. Logout All the logging out events on the system. timestamp Time the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 220
message_l10n Localized message string corresponding to message_code. type_l10n Localized message string corresponding to type resource_type_l10n Localized message string corresponding to resource_type resource_action_l10n Localized message string corresponding to resource_action show Property - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 221
Attribute type type_l10n username Select X Sort X X X X X Format audit_event show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 222
json Display output in JSON format. chap_config CHAP is enabled (or not) identically cluster-wide for all iSCSI targets. For both single and mutual CHAP authentication modes, the common username and password for all targets on the cluster are set here. For mutual mode, each initiator also has a - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 223
Format chap_config [-id ] show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id The id of the CHAP configuration object (always "0"). -select Display selected attributes in the output. -output Change the output format. nvp Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 224
CHAP is being used to authenticate the initiator Mutual CHAP is used to authenticate both the initiator and target -async Perform asynchronous operation. dns Manage DNS and NTP settings for the cluster. Attributes id Unique identifier of the DNS setting. addresses DNS server addresses in IPv4 or - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 225
fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 226
email_notify_destination Use these resource types to configure outgoing SMTP and email notifications. Attributes id Unique identifier of the email notification destination. email_address Email address to receive notifications. notify_critical Whether to send notifications for critical alerts. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 227
Action qualifiers -id Unique identifier of the email notification destination. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 228
false}] [-notify_major {yes | true | no | false}] [-notify_minor {yes | true | no | false}] [notify_info {yes | true | no | false}] [-async] Action qualifiers -email_address Email address to receive notifications. -notify_critical Whether to send notifications for critical alerts. -notify_major - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 229
-id Unique identifier of the email notification destination. -email_address Email address to receive notifications. -notify_critical Whether to send notifications for critical alerts. -notify_major Whether to send notifications for major alerts. -notify_minor Whether to send notifications for minor - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 230
the network to which the IP address belongs. ip_port_id Unique identifier of the port that uses this IP address to provide access to storage network services, such as iSCSI. This attribute can be set only for an IP address used by networks of type Storage. appliance_id Unique identifier of the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 231
Attribute appliance.model appliance.name appliance.service_tag appliance_id id ip_port.available_usages ip_port.available_usages_l10n ip_port.bond_id ip_port.current_usages ip_port.current_usages_l10n ip_port.eth_port_id ip_port.id ip_port.partner_id ip_port.target_iqn ip_port.veth_port_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 232
Attribute network.prefix_length network.type network.type_l10n network.vlan_id network_id node.appliance_id node.id node.slot node_id purposes purposes_l10n Select X Sort X X X X X X X X X X X X X X Format ip_pool_address [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 233
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output 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. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 234
available_usages Available IP port usages. current_usages Current IP port usages. bond_id Unique identifier of the bond on top of which the IP port is configured. If the IP port is configured on top of an Ethernet front-end port, this attribute should be empty. eth_port_id Unique identifier of the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 235
Attribute available_usages available_usages_l10n bond.id bond.is_link_up bond.mode bond.mode_l10n bond.mtu bond.name bond_id current_usages current_usages_l10n eth_port.appliance_id eth_port.bond_id eth_port.current_mtu eth_port.current_speed eth_port.current_speed_l10n eth_port.hypervisor_port_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 236
Attribute eth_port.io_module_id eth_port.is_hypervisor_managed eth_port.is_link_up eth_port.mac_address eth_port.name eth_port.node_id eth_port.partner_id eth_port.port_connector_type eth_port.port_connector_type_l10n eth_port.port_index eth_port.requested_speed eth_port.requested_speed_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 237
Attribute ip_pool_addresses.network_id ip_pool_addresses.node_id ip_pool_addresses.purposes ip_pool_addresses.purposes_l10n partner.available_usages partner.available_usages_l10n partner.bond_id partner.current_usages partner.current_usages_l10n partner.eth_port_id partner.id partner.partner_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 238
Attribute veth_port.mac_address veth_port.name veth_port.node_id veth_port.vswitch_name veth_port.vswitch_port_group_name veth_port.vswitch_port_id veth_port.vswitch_port_name veth_port_id Select X Sort X X X X X X X X Format ip_port [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 239
Query all records. -output 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. set Modify IP port parameters. Format ip_port -id set [-add_current_usages {Management | ISCSI | - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 240
This request is valid only on systems where Data at Rest Encryption is enabled and is applicable only on systems that support Data at Rest Encryption. Format keystore_archive regenerate [-async] Action qualifiers -async Perform asynchronous operation. download Download a keystore backup archive file - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 241
appliance is added to the cluster, the process starts over, and the cluster license will need to be updated, either automatically, or manually if network connectivity to the Software Licensing Central is not available. If the system lacks network connectivity to reach the Software Licensing Central - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 242
Format license [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 243
when the cluster is configured, and if it fails, once per day during the trial period. This allows a manual attempt, normally after attempting to correct the network connectivity issue preventing the automatic retrieval. Format license retrieve [-async] Action qualifiers -async Perform asynchronous - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 244
Whether the user account has a default password or not. Only applies to default user accounts. role_id Unique identifier of the role local user account is mapped to. show Property capabilities Attribute id is_built_in is_default_password is_locked name role_id Select X Sort X X X X X Format - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 245
json Display output in JSON format. create Create a new local user account. Any existing local user with either an administrator or a security administrator role can create a new local user account. By default, a new local_user account is NOT locked. Format local_user create -name {-password - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 246
-id Unique identifier of the local user account to be deleted. -async Perform asynchronous operation. set Modify a property of a local user account using the unique identifier. You cannot modify the default "admin" user account. Format local_user -id set [-role_id ] [-is_locked {yes | - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 247
-async Perform asynchronous operation. login_session Use these resource types to manage sessions, roles, and system security configurations. Attributes id Unique identifier of the login session. user Fully qualified user account name being used to log in. role_ids Roles to which the logged-in user - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 248
Format login_session show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 249
Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version. mtu Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes. type_l10n Localized message string corresponding to type ip_version_l10n Localized message string corresponding to ip_version - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 250
Attribute prefix_length type type_l10n vlan_id Select X Sort X X X X X X X Format network [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 251
[-username ] [{-password | -passwordSecure}]] ( [-esxi_credentials [-node_id ] [{-password | -passwordSecure}]].. [-mtu ] [-add_addresses ,..] [-remove_addresses ,..] [-force {yes | true | no | false}] [-async] Action qualifiers -id Unique - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 252
of the cluster management IP address. Should be passed only when reconfiguring cluster management IP address. -username VASA vendor provider user name. -password VASA vendor provider password. -passwordSecure Secure version of -password. Value will be queried interactively. -node_id Node identifier - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 253
-id replace -vlan_id -gateway -prefix_length -cluster_mgmt_address -mtu -ip_pool_addresses ,.. -dns_addresses ,.. -ntp_addresses ,.. [-vasa_provider_credentials [-username ] [{password | -passwordSecure - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 254
the cluster management IP address. Should be passed only when reconfiguring PowerStoreX cluster. -username VASA vendor provider user name. -password VASA vendor provider password. -passwordSecure Secure version of -password. Value will be queried interactively. -node_id Node identifier corresponding - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 255
-connect_method Physical switch connect method type. Valid values are: SSH Secure shell. SNMPv2c SNMPv2 community string. -port Port used for connection to switch. -username Username to connect a physical switch for SSH connection method. -ssh_password SSH password to connect a physical switch if - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 256
least one IP port must be configured for use by the storage network. Format network -id scale [-add_port_ids ,..] [-remove_port_ids ,..] [-force {yes | true | no | false}] [-async] Action qualifiers -id Unique identifier of the IP network. -add_port_ids Unique identifiers of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 257
NTP server addresses. This list may contain IPv4 addresses, IPv6 addresses, and host names. show Property capabilities Attribute addresses id Select X Sort X X X Format ntp [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 258
from physical_switch_connection Attributes id Unique identifier of the physical switch setting. name Name of physical switch. This property supports case-insensitive filtering purpose Physical switch purpose in network. Possible purposes are: Data_and_Management Physical switch for all data - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 259
Management_Only Physical switch for management network only. purpose_l10n Localized message string corresponding to purpose connections This is the inverse of the resource type physical_switch_connection association. See [__definitions_physical_switch_connection_instance] for more details show - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 260
-name Unique name of the existing object (physical_switch). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 261
Action qualifiers -name Name of a physical switch. -purpose Physical switch purpose in network. Possible purposes are: Data_and_Management Physical switch for all data and management networks. Management_Only Physical switch for management network only. -address Physical switch address in IPv4 or - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 262
delete Delete the physical switch settings. Format physical_switch {-id | -name } delete [-async] Action qualifiers -id Unique identifier of the physical switch settings. -name Unique name of the existing object (physical_switch). -async Perform asynchronous operation. set Modify a - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 263
-address Physical switch address in IPv4 or IPv6 or DNS hostname format. -connect_method Physical switch connect method type. Valid values are: SSH Secure shell. SNMPv2c SNMPv2 community string. -port Port used for connection to switch. -username Username to connect a physical switch for SSH - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 264
description Description of the role. show Property capabilities Attribute description id is_built_in name Select X Sort X X X Format role [-id ] show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the role - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 265
security_config system security configuration Attributes id Unique identifier of the system security configuration. idle_timeout Idle time (in seconds) after which login sessions will expire and require re-authentication. show Property capabilities Attribute id idle_timeout Select X Sort X - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 266
Display output in JSON format. smtp_config Use these resource types to configure outgoing SMTP and email notifications. Attributes id Unique identifier of the SMTP configuration. This value is always '0'. address IP address of the SMTP server. port Port used for sending SMTP messages. source_email - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 267
-sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 268
appliance Attributes id Unique identifier of the installed software instance. is_cluster Whether this information represents the common software release version that is supported on all appliances in the cluster. The value is true for the instance representing the cluster. The value is false for - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 269
release_timestamp Date and time when this software package was produced. installed_date Date and time when the software was successfully installed and committed on the cluster. If the software package has not been commited, this value is null. appliance This is the embeddable reference form of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 270
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 271
a complete system software upgrade release. Disk_Firmware A package containing disk firmware updates only, for some or all supported drive types. Hotfix A package containing high priority firmware updates. Language_Pack A package containing additional language definitions. software_package_state - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 272
is_reboot_required Whether a reboot is required during the upgrade process. release_version Version number of the software package. release_timestamp Date and time when this software package was produced. installed_date Date and time when this software package was successfully installed and - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 273
Attribute software_package_type software_package_type_l10n Select X Sort X X X Format software_package [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 274
Display output in CSV format. table Display output in a table. json Display output in JSON format. create Push a software package file from the client to the cluster. When successfully uploaded and verified, the result is a software_package in the downloaded state, ready to install. Format - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 275
appliance is not specified, the upgrade is performed on all appliances in the cluster. Only specify a subset of appliances to upgrade if the time required to upgrade the entire cluster does not fit within a desired maintenance window. When upgrading a subset of appliances, you must adhere to the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 276
operation. x509_certificate Use these resource types to manage SSL/TLS certificates. The X509 Certificate service is part of the credential store services. An X509 Certificate in this service represents a certificate chain, composed of the certificate of each individual member in ordered sequence - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 277
. Filtering on the fields of this embedded resource is not supported. See members for more details type_l10n Localized message string corresponding to type service_l10n Localized message string corresponding to service Attributes of members subject Certificate subject or so called distinguished name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 278
Localized message string corresponding to thumbprint_algorithm show Property capabilities Attribute id is_current is_valid members service service_l10n type type_l10n Select X Sort X X X X X X X Format x509_certificate [-id ] show [-select ,..] [-output {nvp - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 279
text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. decommission Decommission x509 certificates for one service type (currently only Replication_HTTP is supported) of one scope (for example remote system) Format x509_certificate decommission - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 280
Web server Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service -address Peer's ip v4 or v6 address or dns name. -port Peer's port number. -username Username used in basic authentication to remote PowerStore cluster. -password Password used in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 281
the DNS server. nas_server_id Unique identifier of the associated NAS Server instance that uses this DNS object. Only one DNS object per NAS Server is supported. domain Name of the DNS domain, where the NAS Server does host names lookup when an FQDN is not specified in the request. ip_addresses The - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 282
transport_l10n Localized message string corresponding to transport nas_server This is the embeddable reference form of nas_server_id attribute. See nas_server for more details show Property capabilities Attribute domain id ip_addresses nas_server.backup_IPv4_interface_id nas_server. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 283
Attribute nas_server.name nas_server.operational_status nas_server.operational_status_l10n nas_server.preferred_node_id nas_server.production_IPv4_interface_id nas_server.production_IPv6_interface_id nas_server_id transport transport_l10n Select X Sort X X X X X X X X X X X Format - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 284
Action qualifiers -nas_server_id Unique identifier of the associated NAS Server instance that uses this DNS object. Only one DNS object per NAS Server is supported. -domain Name of the DNS domain, where the NAS Server does host names lookup when an FQDN is not specified in the request. -ip_addresses - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 285
DNS uses the TCP protocol -async Perform asynchronous operation. delete Delete DNS settings of a NAS Server. Format file_dns -id delete [-async] Action qualifiers -id Unique identifier of the DNS object. -async Perform asynchronous operation. set Modify the DNS settings of a NAS Server. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 286
LDAP server) or a Windows domain. Windows user names need to be entered using the 'username@domain' or 'domain\\username' formats. Each secure and unsecure service must have a home directory defined in the name server that must be accessible on the NAS server. FTP also allows clients to connect as - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 287
is_smb_authentication_enabled Indicates whether FTP and SFTP clients can be authenticated using an SMB user name. These user names are defined in a Windows domain controller, and their formats are user@domain or domain\\user. Values are: - true - SMB user names are accepted for authentication. - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 288
or denied hosts, depending on the value of the is_allowed_hosts attribute. A host is defined using its IP address. Subnets using CIDR notation are also supported. - If allowed hosts exist, only those hosts and no others can connect to the NAS server through FTP or SFTP. - If denied hosts exist - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 289
Attribute audit_dir audit_max_size default_homedir groups hosts id is_allowed_groups is_allowed_hosts is_allowed_users is_anonymous_authentication_enabled is_audit_enabled is_ftp_enabled is_homedir_limit_enabled is_sftp_enabled is_smb_authentication_enabled is_unix_authentication_enabled - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 290
Attribute nas_server.current_preferred_IPv6_interface_id nas_server.current_unix_directory_service nas_server.current_unix_directory_service_l10n nas_server.default_unix_user nas_server.default_windows_user nas_server.description nas_server.id nas_server.is_auto_user_mapping_enabled nas_server. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 291
-id Unique identifier of the FTP/SFTP Server object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 292
| true | no | false}] [-default_homedir ] [-welcome_message ] [message_of_the_day ] [-is_audit_enabled {yes | true | no | false}] [-audit_dir ] [-audit_max_size ] [-hosts ,..] [users ,..] [-groups ,..] - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 293
or denied hosts, depending on the value of the is_allowed_hosts attribute. A host is defined using its IP address. Subnets using CIDR notation are also supported. - If allowed hosts exist, only those hosts and no others can connect to the NAS server through FTP or SFTP. - If denied hosts exist - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 294
-is_allowed_hosts Indicates whether the hosts attribute contains allowed or denied hosts. Values are: true hosts contains allowed hosts. false - hosts contains denied hosts. -is_allowed_users Indicates whether the users attribute contains allowed or denied users. Values are: - true users contains - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 295
-id Unique identifier of the FTP/SFTP Server object. -is_ftp_enabled Indicates whether the FTP server is enabled on the NAS server specified in the nasServer attribute. Values are: - true - FTP server is enabled on the specified NAS server. - false - FTP server is disabled on the specified NAS - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 296
or denied hosts, depending on the value of the is_allowed_hosts attribute. A host is defined using its IP address. Subnets using CIDR notation are also supported. - If allowed hosts exist, only those hosts and no others can connect to the NAS server through FTP or SFTP. - If denied hosts exist - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 297
combined with users. -groups Allowed or denied user groups, depending on the value of the is_allowed_groups attribute. If allowed groups exist, only users who are members of these groups and no others can connect to the NAS server through FTP or SFTP. - If denied groups exist, all users who are - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 298
packets that have matching VLAN tags. name Name of the network interface. This property supports case-insensitive filtering role ◦ Production - This type of network interface is used for all file protocols and services of a NAS server. This type of interface is inactive while a NAS server is in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 299
Attribute file_interface_routes.id file_interface_routes.operational_status file_interface_routes.operational_status_l10n file_interface_routes.prefix_length gateway id ip_address is_disabled name nas_server.backup_IPv4_interface_id nas_server.backup_IPv6_interface_id nas_server.current_node_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 300
Attribute nas_server.is_username_translation_enabled nas_server.name nas_server.operational_status nas_server.operational_status_l10n nas_server.preferred_node_id nas_server.production_IPv4_interface_id nas_server.production_IPv6_interface_id nas_server_id prefix_length role role_l10n vlan_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 301
server to which the network interface belongs, as defined by the nas_server resource type. -ip_address IP address of the network interface. IPv4 and IPv6 are supported. 274 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 302
. IPv4 and IPv6 are supported. -vlan_id Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets that have matching VLAN tags. -role ◦ Production - This type of network interface is used for all file protocols and services of a NAS server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 303
IP address of the network interface. IPv4 and IPv6 are supported. -prefix_length Prefix length for the interface. IPv4 and IPv6 are supported. -gateway Gateway address for the network interface. IPv4 and IPv6 are supported. -vlan_id Virtual Local Area Network (VLAN) identifier for the interface - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 304
id Unique identifier of the file interface route. file_interface_id Unique identifier of the associated file interface. destination IPv4 or IPv6 address of the target network node based on the specific route type. Values are: ◦ For a default route, there is no value because the system will use the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 305
show Property capabilities Attribute destination file_interface.gateway file_interface.id file_interface.ip_address file_interface.is_disabled file_interface.name file_interface.nas_server_id file_interface.prefix_length file_interface.role file_interface.role_l10n file_interface.vlan_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 306
-id Unique identifier of the file interface route object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 307
• The subnet route establishes a static route to a particular subnet. To create a subnet route, provide the IP address of the target subnet in the destination, the prefix length for that subnet, and the gateway. Format file_interface_route create -file_interface_id [-destination ] [- - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 308
NAS Server uses the RPCSEC_GSS security framework and Kerberos authentication protocol to verify users and services. You can configure a secure NFS environment for a multiprotocol NAS Server or one that supports Unix-only shares. In this environment, user access to NFS file systems is granted based - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 309
of the associated NAS Server instance that uses this Kerberos object. Only one Kerberos object per NAS Server is supported. realm Realm name of the Kerberos Service. kdc_addresses Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses are not - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 310
[-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 311
of the associated NAS Server instance that uses this Kerberos object. Only one Kerberos object per NAS Server is supported. -realm Realm name of the Kerberos Service. -kdc_addresses Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses are not - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 312
qualifiers -id Unique identifier of the Kerberos service object. -realm Realm name of the Kerberos Service. -kdc_addresses Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses are not supported. -add_kdc_addresses Fully Qualified domain names of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 313
list. Cannot be combined with kdc_addresses. IPv4 and IPv6 addresses are not supported. -port_number KDC servers TCP port. -async Perform asynchronous operation. upload_keytab A keytab file is required for secure NFS service with a Linux or Unix Kerberos Key Distribution Center (KDC). The keytab - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 314
that uses this LDAP object. Only one LDAP object per NAS Server is supported. base_DN Name of the LDAP base DN. Base Distinguished Name (BDN) the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the LDAP directory tree to begin a search for information. The - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 315
password to access the LDAP-based directory server. Kerberos Kerberos authentication means the NAS Server uses a KDC to confirm the identity when accessing the Active Directory. protocol Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the network - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 316
RFC2307 OpenLDAP/iPlanet schema. Microsoft Microsoft Identity Management for UNIX (IDMU/SFU) schema. Unknown Unknown protocol. is_config_file_uploaded Indicates whether an LDAP configuration file has been uploaded. is_certificate_uploaded Indicates whether an LDAP certificate file has been uploaded. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 317
Attribute is_config_file_uploaded is_smb_account_used is_verify_server_certificate nas_server.backup_IPv4_interface_id nas_server.backup_IPv6_interface_id nas_server.current_node_id nas_server.current_preferred_IPv4_interface_id nas_server.current_preferred_IPv6_interface_id nas_server. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 318
Attribute nas_server.production_IPv6_interface_id nas_server_id port_number principal profile_DN protocol protocol_l10n realm schema_type schema_type_l10n Select X Sort X X X X X X X X X X X X X X X X X X Format file_ldap [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 319
Display output in JSON format. create Create an LDAP service on a NAS Server. Only one LDAP Service object can be created per NAS Server. Format file_ldap LDAP object. Only one LDAP object per NAS Server is supported. -authentication_type Authentication type for the LDAP server. Anonymous Anonymous - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 320
LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the LDAP directory tree to begin a search for information. The base DN can be expressed as a fully-qualified domain name or in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 321
Bind Distinguished Name (DN) to be used when binding. -bind_password The associated password to be used when binding to the server. -bind_passwordSecure Secure version of -bind_password. Value will be queried interactively. -is_smb_account_used Indicates whether SMB authentication is used to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 322
LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the LDAP directory tree to begin a search for information. The base DN can be expressed as a fully-qualified domain name or in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 323
-remove_addresses IP addresses to remove from the current server IP addresses list. The addresses may be IPv4 or IPv6. Error occurs if an IP address does not exist in the addresses_list. Cannot be combined with addresses. -port_number The TCP/IP port used by the NAS Server to connect to the LDAP - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 324
false Indicates that Kerberos uses its own settings. -principal Specifies the principal name for Kerberos authentication. -realm Specifies the realm name for Kerberos authentication. -password The associated password for Kerberos authentication. -passwordSecure Secure version of -password. Value - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 325
control path traffic from data path traffic, which permits centrally managed and monitored local backup operations. Storage systems support NDMP v2-v4 over the network. Direct-attach NDMP is not supported. This means that the tape drives need to be connected to a media server, and the NAS server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 326
. nas_server_id Unique identifier of the NAS server to be configured with these NDMP settings. user_name User name for accessing the NDMP service. nas_server This is the embeddable reference form of nas_server_id attribute. See nas_server for more details show Property capabilities Attribute id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 327
offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [raw]}] Action qualifiers -id Unique identifier of the NDMP service object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 328
of the NAS server to be configured with these NDMP settings. -user_name User name for accessing the NDMP service. -password Password for the NDMP service user. -passwordSecure Secure version of -password. Value will be queried interactively. -async Perform asynchronous operation. delete Delete an - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 329
version of -password. Value will be queried interactively. -async Perform asynchronous operation. file_nis Use these resources to manage the Network Information Service (NIS) settings object for a NAS Server. One NIS settings object may be configured per NAS server. NIS consists of a directory - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 330
Unique identifier of the associated NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS Server is supported. domain Name of the NIS domain. ip_addresses The list of NIS server IP addresses. nas_server This is the embeddable reference form of nas_server_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 331
Attribute nas_server.description nas_server.id nas_server.is_auto_user_mapping_enabled nas_server.is_username_translation_enabled nas_server.name nas_server.operational_status nas_server.operational_status_l10n nas_server.preferred_node_id nas_server.production_IPv4_interface_id nas_server. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 332
in a table. json Display output in JSON format. create Create a new NIS Service on a NAS Server. Only one NIS Setting object can be created per NAS Server NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS Server is supported. -domain Name of the NIS domain. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 333
delete Delete NIS settings of a NAS Server. Format file_nis -id delete [-async] Action qualifiers -id Unique identifier of the NIS object. -async Perform asynchronous operation. set Modify the NIS settings of a NAS Server. Format file_nis -id set [-domain ] [-ip_addresses < - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 334
associations from nas_server, policy, file_tree_quota, file_user_quota, nfs_export, smb_share Attributes id File system id. name File system name. This property supports case-insensitive filtering description File system description. nas_server_id Id of the NAS Server on which the file system is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 335
UNIX UNIX Security. Windows Windows Security. locking_policy File system locking policies. These policy choices control whether the NFSv4 range locks are honored. Because NFSv3 is advisory by design, this policy specifies that the NFSv4 locking feature behaves like NFSv3 (advisory mode), for - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 336
false Opportunistic file locking is disabled on the file system. is_smb_no_notify_enabled Indicates whether notifications of changes to a directory file structure are enabled. true Change directory notifications are enabled. false Change directory notifications are disabled. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 337
false Stop tracking usages for all users on a file system or a quota tree, and user quota limits will not be enforced. grace_period Grace period of soft limit (seconds): -1: Infinite grace period (Windows policy). 0: Use default grace period of 1 week (default). positive: Grace period after which - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 338
User Created by a user. External_VSS Created by Windows Volume Shadow Copy Service (VSS) to obtain an application consistent snapshot. External_NDMP Created by an NDMP backup operation. External_Restore Created as a backup snapshot before a snapshot restore. External_Replication_Manager Created by - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 339
file_tree_quotas This is the inverse of the resource type file_tree_quota association. See file_tree_quota for more details file_user_quotas This is the inverse of the resource type file_user_quota association. See file_user_quota for more details nfs_exports This is the inverse of the resource type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 340
Attribute file_tree_quotas.file_system_id file_tree_quotas.hard_limit file_tree_quotas.id file_tree_quotas.is_user_quotas_enforced file_tree_quotas.path file_tree_quotas.remaining_grace_period file_tree_quotas.size_used file_tree_quotas.soft_limit file_tree_quotas.state file_tree_quotas.state_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 341
Attribute file_user_quotas.windows_name file_user_quotas.windows_sid filesystem_type filesystem_type_l10n folder_rename_policy folder_rename_policy_l10n grace_period id is_async_MTime_enabled is_modified is_quota_enabled is_smb_no_notify_enabled is_smb_notify_on_access_enabled - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 342
Attribute nas_server.backup_IPv4_interface_id nas_server.backup_IPv6_interface_id nas_server.current_node_id nas_server.current_preferred_IPv4_interface_id nas_server.current_preferred_IPv6_interface_id nas_server.current_unix_directory_service nas_server.current_unix_directory_service_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 343
Attribute nfs_exports.anonymous_UID nfs_exports.default_access nfs_exports.default_access_l10n nfs_exports.description nfs_exports.file_system_id nfs_exports.id nfs_exports.is_no_SUID nfs_exports.min_security nfs_exports.min_security_l10n nfs_exports.name nfs_exports.nfs_owner_username nfs_exports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 344
Attribute protection_policy.name protection_policy.type protection_policy.type_l10n protection_policy_id size_total size_used smb_notify_on_change_dir_depth smb_shares.description smb_shares.file_system_id smb_shares.id smb_shares.is_ABE_enabled smb_shares.is_branch_cache_enabled smb_shares. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 345
Action qualifiers -id File system id. -name Unique name of the existing object (file_system). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 346
Format file_system create -name -size_total -nas_server_id [-description ] [-access_policy {Native | UNIX | Windows}] [locking_policy {Advisory | Mandatory}] [-folder_rename_policy {All_Allowed | SMB_Forbidden | All_Forbidden}] - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 347
Honor SMB and NFS lock range. -folder_rename_policy File system folder rename policies for the file system with multiprotocol access enabled. These policies control whether the directory can be renamed from NFS or SMB clients when at least one file is opened in the directory, or in one of its child - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 348
true File access notifications are enabled on the file system. false File access notifications are disabled on the file system. -is_smb_notify_on_write_enabled Indicates whether file writes notifications are enabled on the file system. Values are: true File writes notifications are enabled on the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 349
Unique name of the existing object (file_system). -async Perform asynchronous operation. set Modify a file system. Format file_system {-id | -name } set [-description ] [-size_total ] [-access_policy {Native | UNIX | Windows}] [ - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 350
Windows Security. -locking_policy File system locking policies. These policy choices control whether the NFSv4 range locks are honored. Because NFSv3 is advisory by design, this policy specifies that the NFSv4 locking feature behaves like NFSv3 (advisory mode), for backward compatiblity with - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 351
the file system. -protection_policy_id Id of the protection policy applied to the file system. -is_quota_enabled Indicates whether quota is enabled. Quotas are not supported for read-only file systems. Default value for the grace period is set to infinite=-1 to match Windows' quota policy Values are - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 352
true Start tracking usages for all users on a file system or a quota tree, and user quota limits will be enforced. false Stop tracking usages for all users on a file system or a quota tree, and user quota limits will not be enforced. -grace_period Grace period of soft limits (seconds): -1: default: - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 353
-name Unique name of the existing object (file_system). -name Name of the clone. -description Description of the clone. -access_policy File system security access policies. Each file system uses its access policy to determine how to reconcile the differences between NFS and SMB access control. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 354
Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. -is_smb_sync_writes_enabled Indicates whether the synchronous writes option is enabled on the file system. Values are: true Synchronous - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 355
-smb_notify_on_change_dir_depth Lowest directory level to which the enabled notifications apply, if any. -is_async_MTime_enabled Indicates whether asynchronous MTIME is enabled on the file system. Values are: true Asynchronous MTIME is enabled on the file system. false Asynchronous MTIME is disabled - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 356
-name Unique name of the existing object (file_system). -async Perform asynchronous operation. restore Restore from a snapshot of a file system. Format file_system {-id | -name } restore [-copy_name ] [-async] Action qualifiers -id File system snapshot id. -name Unique name of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 357
-name Unique name of the existing object (file_system). -name Name of the snapshot. The default name of the snapshot is the date and time when the snapshot is taken. -description Snapshot description -expiration_timestamp Time, when the snapshot will expire. -is_auto_delete_enabled Indicates whether - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 358
File system locking policies. These policy choices control whether the NFSv4 range locks are honored. Because NFSv3 is advisory by design, this policy specifies that the NFSv4 locking feature behaves like NFSv3 (advisory mode), for backward compatiblity with applications expecting an advisory - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 359
true Opportunistic file locking is enabled on the file system. false Opportunistic file locking is disabled on the file system. -is_smb_notify_on_access_enabled Indicates whether file access notifications are enabled on the file system. Values are: true File access notifications are enabled on the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 360
id Unique identifier of the tree quota. file_system_id Unique identifier of the associated file system. path Path relative to the root of the associated filesystem. description Description of the tree quota. is_user_quotas_enforced Whether user quota are enabled on this tree quota. The tree quota - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 361
Localized message string corresponding to state file_system This is the embeddable reference form of file_system_id attribute. See file_system for more details file_user_tree_quotas This is the inverse of the resource type file_user_quota association. See file_user_quota for more details show - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 362
Attribute file_system.folder_rename_policy_l10n file_system.grace_period file_system.id file_system.is_async_MTime_enabled file_system.is_modified file_system.is_quota_enabled file_system.is_smb_no_notify_enabled file_system.is_smb_notify_on_access_enabled file_system.is_smb_notify_on_write_enabled - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 363
Attribute file_system.smb_notify_on_change_dir_depth file_system_id file_user_tree_quotas.file_system_id file_user_tree_quotas.hard_limit file_user_tree_quotas.id file_user_tree_quotas.remaining_grace_period file_user_tree_quotas.size_used file_user_tree_quotas.soft_limit file_user_tree_quotas.state - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 364
Attribute soft_limit state state_l10n Select X Sort X X X X X Format file_tree_quota [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 365
table Display output in a table. json Display output in JSON format. create Create a tree quota instance. Format file_tree_quota create -file_system_id -path [-description ] [hard_limit ] [-soft_limit ] - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 366
Format file_tree_quota -id delete [-async] Action qualifiers -id Unique identifier of the tree quota. -async Perform asynchronous operation. set Modify a tree quota instance. Format file_tree_quota -id set [-description ] [-hard_limit ] [- - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 367
refresh Refresh the cache with the actual value of the tree quota. Format file_tree_quota -id refresh [-async] Action qualifiers -id Unique identifier of the tree quota. -async Perform asynchronous operation. file_user_quota User quota settings in the storage system. A user quota instance - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 368
OK No quota limits are exceeded. Soft_Exceeded Soft limit is exceeded, and grace period is not expired. Soft_Exceeded_And_Expired Soft limit is exceeded, and grace period is expired. Hard_Reached Hard limit is reached. hard_limit Hard limit of the user quota, in bytes. No hard limit when set to 0. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 369
Attribute file_system.access_type file_system.access_type_l10n file_system.creation_timestamp file_system.creator_type file_system.creator_type_l10n file_system.default_hard_limit file_system.default_soft_limit file_system.description file_system.expiration_timestamp file_system.filesystem_type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 370
Attribute file_system.is_smb_op_locks_enabled file_system.is_smb_sync_writes_enabled file_system.last_refresh_timestamp file_system.last_writable_timestamp file_system.locking_policy file_system.locking_policy_l10n file_system.name file_system.nas_server_id file_system.parent_id file_system. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 371
Attribute tree_quota.description tree_quota.file_system_id tree_quota.hard_limit tree_quota.id tree_quota.is_user_quotas_enforced tree_quota.path tree_quota.remaining_grace_period tree_quota.size_used tree_quota.soft_limit tree_quota.state tree_quota.state_l10n tree_quota_id uid unix_name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 372
Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 373
-tree_quota_id Unique identifier of the tree quota in which the new user quota will be created. -uid Unix user identifier (UID) of the user. Preferred identifier. -unix_name Unix username. Identifers are exclusive. Only one of the four identifiers among 'user uid' / 'unix username' / 'windows - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 374
is enabled on a NAS server. A configuration file (named viruschecker.conf) needs to be uploaded before enabling the anti-virus service. The cluster supports third-party anti-virus servers that perform virus scans and reports back to the storage system. For example, when an SMB client creates, moves - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 375
not available, according the policy, the access to the file systems is denied to prevent potential viruses propagation. - false - Anti-virus service is disabled. File systems of the NAS servers are available for access without virus checking is_config_file_uploaded Indicates whether a virus checker - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 376
Attribute nas_server.id nas_server.is_auto_user_mapping_enabled nas_server.is_username_translation_enabled nas_server.name nas_server.operational_status nas_server.operational_status_l10n nas_server.preferred_node_id nas_server.production_IPv4_interface_id nas_server.production_IPv6_interface_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 377
qualifiers -nas_server_id Unique identifier of an associated NAS Server instance that uses this virus checker configuration. Only one virus checker configuration per NAS Server is supported. -async Perform asynchronous operation. delete Delete virus checker settings of a NAS Server. 350 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 378
available, according the policy, the access to the file systems is denied to prevent potential viruses propagation. - false - Anti-virus service is disabled. File systems of the NAS servers are available for access without virus checking. -async Perform asynchronous operation. upload_config Upload - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 379
, file_dns, file_ftp, file_kerberos, file_ldap, file_nis, file_system Attributes id Unique identifier of the NAS server. name Name of the NAS server. This property supports case-insensitive filtering description Description of the NAS server. operational_status NAS server operational status: 352 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 380
of Unix to Windows user mapping failure. When empty, access in such case is denied. current_unix_directory_service Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on. is_username_translation_enabled Enable the possibility - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 381
production_IPv4_interface_id Unique identifier of the preferred IPv4 production interface. production_IPv6_interface_id Unique identifier of the preferred IPv6 production interface. backup_IPv4_interface_id Unique identifier of the preferred IPv4 backup interface. backup_IPv6_interface_id Unique - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 382
file_kerberoses This is the inverse of the resource type file_kerberos association. See file_kerberos for more details file_ldaps This is the inverse of the resource type file_ldap association. See file_ldap for more details file_nises This is the inverse of the resource type file_nis association. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 383
Attribute file_dnses.nas_server_id file_dnses.transport file_dnses.transport_l10n file_ftps.audit_dir file_ftps.audit_max_size file_ftps.default_homedir file_ftps.groups file_ftps.hosts file_ftps.id file_ftps.is_allowed_groups file_ftps.is_allowed_hosts file_ftps.is_allowed_users file_ftps. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 384
Attribute file_ftps.users file_ftps.welcome_message file_interfaces.gateway file_interfaces.id file_interfaces.ip_address file_interfaces.is_disabled file_interfaces.name file_interfaces.nas_server_id file_interfaces.prefix_length file_interfaces.role file_interfaces.role_l10n file_interfaces. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 385
Attribute file_ldaps.bind_DN file_ldaps.id file_ldaps.is_certificate_uploaded file_ldaps.is_config_file_uploaded file_ldaps.is_smb_account_used file_ldaps.is_verify_server_certificate file_ldaps.nas_server_id file_ldaps.port_number file_ldaps.principal file_ldaps.profile_DN file_ldaps.protocol - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 386
Attribute file_nises.nas_server_id file_systems.access_policy file_systems.access_policy_l10n file_systems.access_type file_systems.access_type_l10n file_systems.creation_timestamp file_systems.creator_type file_systems.creator_type_l10n file_systems.default_hard_limit file_systems. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 387
Attribute file_systems.is_smb_no_notify_enabled file_systems.is_smb_notify_on_access_enabled file_systems.is_smb_notify_on_write_enabled file_systems.is_smb_op_locks_enabled file_systems.is_smb_sync_writes_enabled file_systems.last_refresh_timestamp file_systems.last_writable_timestamp file_systems. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 388
Attribute is_auto_user_mapping_enabled is_username_translation_enabled name nfs_servers.credentials_cache_TTL nfs_servers.host_name nfs_servers.id nfs_servers.is_extended_credentials_enabled nfs_servers.is_joined nfs_servers.is_nfsv3_enabled nfs_servers.is_nfsv4_enabled nfs_servers.is_secure_enabled - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 389
Attribute smb_servers.domain smb_servers.id smb_servers.is_joined smb_servers.is_standalone smb_servers.nas_server_id smb_servers.netbios_name smb_servers.workgroup Select X Sort X X X X X X Format nas_server [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 390
}] [-async] Action qualifiers -name Name of the NAS server. -description Description of the NAS server. -current_unix_directory_service Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on. -default_unix_user Default Unix user - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 391
attribute enables you to automatically generates this Unix user (uid), if that Windows user does not have any in the configured Unix directory service (UDS). In a pure SMB or non multi-protocol environment, this should be set to true. -async Perform asynchronous operation. delete Delete a NAS server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 392
node for the NAS server The initial value (on NAS server create) is taken from the current node. -current_unix_directory_service Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on. -default_unix_user Default Unix user name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 393
enables you to automatically generate this Unix user (uid), if that Windows user does not have any in the configured Unix directory service (UDS). In a pure SMB or non multi-protocol environment, this should be set to true. -production_IPv4_interface_id Unique identifier of the preferred IPv4 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 394
updates file ownership on the NAS server's file systems to reflect changes to users' SIDs. A new UID/GID will be obtained from a Unix Directory Service for the user name of the object owner. A user mapping report is also generated. This operation can take a significant amount of time, depending of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 395
-id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). homedir Download a NAS server homedir file containing the template or the actual (if already uploaded) homedir configuration settings. Format nas_server/download [{-f | -d }] {-id < - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 396
-name Unique name of the existing object (nas_server). netgroup Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details. Format nas_server/download [{-f | -d }] {-id | -name } netgroup Action qualifiers - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 397
ntxmap Download an NAS server ntxmap file containing the template or the actual (if already uploaded) ntxmap configuration settings. Format nas_server/download [{-f | -d }] {-id | -name } ntxmap Action qualifiers -f Local path with the file name -d Local folder - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 398
Format nas_server/download [{-f | -d }] {-id | -name } user_mapping_report Action qualifiers -f Local path with the file name -d Local folder where file shall be stored -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 399
Format nas_server/upload {-id | -name } homedir [-body ] [-async] Action qualifiers -id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload the NAS server homedir file. -async Perform asynchronous operation. hosts Upload NAS - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 400
-id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). -body Upload the NAS server netgroup file. -async Perform asynchronous operation. nsswitch Upload the NAS server nsswitch file. Format nas_server/upload {-id | -name } nsswitch [-body - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 401
id of the NFS Export. file_system_id Unique identifier of the file system on which the NFS Export was created. name NFS Export name. This property supports case-insensitive filtering path Local path to a location within the file system. With NFS, each export must have a unique 374 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 402
local path. By default, the system exports the root of the file system (top-most directory) at the time the file system is created. This path specifies the unique location of the file system on the storage system. Before you can create additional exports within an NFS shared folder, you must create - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 403
read_only_hosts Hosts with read-only access to the NFS export and its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. read_only_root_hosts Hosts with read-only and ready-only for root user - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 404
Attribute default_access default_access_l10n description file_system.access_policy file_system.access_policy_l10n file_system.access_type file_system.access_type_l10n file_system.creation_timestamp file_system.creator_type file_system.creator_type_l10n file_system.default_hard_limit file_system. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 405
Attribute file_system.is_modified file_system.is_quota_enabled file_system.is_smb_no_notify_enabled file_system.is_smb_notify_on_access_enabled file_system.is_smb_notify_on_write_enabled file_system.is_smb_op_locks_enabled file_system.is_smb_sync_writes_enabled file_system.last_refresh_timestamp - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 406
Attribute min_security min_security_l10n name nfs_owner_username no_access_hosts path read_only_hosts read_only_root_hosts read_write_hosts read_write_root_hosts Select X Sort X X X X X X X X X X X X X X X X X X X Format nfs_export [{-id | -name }] show [-select < - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 407
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output 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. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 408
-name NFS Export name. -description User defined NFS Export description. -default_access Default access level for all hosts that can access the Export. ◦ No_Access- Deny access to the Export for the hosts. ◦ Read_Only- Allow read only access to the Export for the hosts. ◦ Read_Write- Allow read - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 409
IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. -read_write_hosts Hosts with read and write access to the NFS export and its snapshots.Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 410
Format nfs_export {-id | -name } set [-description ] [-default_access {No_Access | Read_Only | Read_Write | Root | Read_Only_Root}] [-min_security {Sys | Kerberos | Kerberos_With_Integrity | Kerberos_With_Encryption}] [-no_access_hosts ,..] [- add_no_access_hosts < - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 411
◦ Kerberos_With_Encryption- Allow only Kerberos with encryption security for user authentication. -no_access_hosts Hosts with no access to the NFS export or its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 412
Hosts to remove from the current read_only_root_hosts list. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. Error if The host is not present. Cannot combine with read_only_root_hosts. - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 413
server before an NFS client can connect to the storage resources. NFS servers can support the NFSv3 and NFSv4 protocols. The default protocol is NFSv3. It is enabled Kerberos uses its own settings. service_principal_name The Service Principal Name (SPN) for the NFS server. This name is - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 414
16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. Note The NFS server builds its own Unix credential when it supports more than 16 groups. This process can slow performance. credentials_cache_TTL Sets the Time-To-Live - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 415
Attribute nas_server.backup_IPv4_interface_id nas_server.backup_IPv6_interface_id nas_server.current_node_id nas_server.current_preferred_IPv4_interface_id nas_server.current_preferred_IPv6_interface_id nas_server.current_unix_directory_service nas_server.current_unix_directory_service_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 416
Format nfs_server [-id ] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 417
in a Unix credential. Valid values are, - true - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. - false - NFS server supports more than 16 Unix groups in a Unix credential. The NFS - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 418
The NFS server builds its own Unix credential when it supports more than 16 groups. This process can slow performance. -credentials_cache_TTL Sets the Time-To-Live (in minutes) expiration time in minutes for a Windows entry in - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 419
16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. Note The NFS server builds its own Unix credential when it supports more than 16 groups. This process can slow performance. -credentials_cache_TTL Sets the Time-To-Live - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 420
join Join the secure NFS server to the NAS server's AD domain, which is necessary for Secure NFS. Format nfs_server -id join -domain_user_name {-domain_password | -domain_passwordSecure} [-async] Action qualifiers -id Unique identifier of the NFS server. -domain_user_name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 421
Unique identifier representing a performance rule. name Name of the performance rule. This property supports case-insensitive filtering io_priority The I/O priority for quality of service rules. io_priority_l10n Localized message string corresponding to io_priority policies List of the policies that - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 422
Attribute policies.name policies.type policies.type_l10n Select X Sort X X Format performance_rule [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 423
usage of SMB involves computers running Microsoft Windows, but it is commonly supported on other types of systems as well. SMB was formerly known as to prevent authentication errors caused by unsynchronized clocks. Each NAS server supports a maximum of one SMB server. This resource type has queriable - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 424
mark (?) - quotation mark ("") - less than sign () - vertical bar (|) as definied by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/ 909264/) workgroup Applies to stand-alone SMB servers only. Windows network workgroup for the SMB server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 425
Attribute nas_server.current_node_id nas_server.current_preferred_IPv4_interface_id nas_server.current_preferred_IPv6_interface_id nas_server.current_unix_directory_service nas_server.current_unix_directory_service_l10n nas_server.default_unix_user nas_server.default_windows_user nas_server. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 426
] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [raw]}] Action qualifiers -id Unique identifier of the SMB server. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 427
question mark (?) - quotation mark ("") - less than sign () - vertical bar (|) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/909264/) -workgroup Applies to standalone SMB servers only. Windows network workgroup for the SMB server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 428
-async Perform asynchronous operation. delete Delete a SMB server. The SMB server must not be joined to a domain to be deleted. Format smb_server -id delete [-force {yes | true | no | false}] [-async] Action qualifiers -id Unique identifier of the SMB server. -force If false, the delete will - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 429
question mark (?) - quotation mark ("") - less than sign () - vertical bar (|) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/909264/) -workgroup Applies to standalone SMB servers only. Windows network workgroup for the SMB server - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 430
-domain_password Password of the domain-user specified to join the Active Directory domain. -domain_passwordSecure Secure version of -domain_password. Value will be queried interactively. -organizational_unit Organizational unit of the SMB server in Active Directory, if applicable. - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 431
from file_system Attributes id Id of the SMB Share. file_system_id The file system from which the share was created. name SMB share name. This property supports case-insensitive filtering path Local path to the file system or any existing sub-folder of the file system that is shared over the network - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 432
false - BranchCache is disabled. offline_availability Defines valid states of Offline Availability, Manual Only specified files will be available offline. Documents All files that users open will be available offline. Programs Program will preferably run from the offline - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 433
Attribute file_system.creator_type file_system.creator_type_l10n file_system.default_hard_limit file_system.default_soft_limit file_system.description file_system.expiration_timestamp file_system.filesystem_type file_system.filesystem_type_l10n file_system.folder_rename_policy file_system. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 434
Attribute file_system.last_writable_timestamp file_system.locking_policy file_system.locking_policy_l10n file_system.name file_system.nas_server_id file_system.parent_id file_system.protection_policy_id file_system.size_total file_system.size_used file_system.smb_notify_on_change_dir_depth - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 435
Format smb_share [{-id | -name }] show [-select ,..] [-sort [+|],..] [-offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id SMB Share object id. -name Unique name of the existing object ( - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 436
> [-description ] [is_ABE_enabled {yes | true | no | false}] [-is_branch_cache_enabled {yes | true | no | false}] [-offline_availability {Manual | Documents | Programs | None}] [-umask ] [is_continuous_availability_enabled {yes | true | no | false}] [-is_encryption_enabled {yes | true - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 437
Documents All files that users open will be available offline. Programs Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None Prevents clients from storing documents and programs in offline cache (default). - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 438
over the WAN. Values are: - true - BranchCache is enabled. false - BranchCache is disabled. -offline_availability Defines valid states of Offline Availability, Manual Only specified files will be available offline. Documents All files that users open will be available offline. Programs Program will - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 439
across all storage containers in the cluster. Name can be from 1 to 64 UTF-8 characters, and not more than 127 bytes. This property supports case-insensitive filtering quota The total number of bytes that can be provisioned/reserved against this storage container. A value of 0 means there is no - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 440
Attribute id name quota virtual_volumes.appliance_id virtual_volumes.creation_timestamp virtual_volumes.creator_type virtual_volumes.creator_type_l10n virtual_volumes.family_id virtual_volumes.id virtual_volumes.io_priority virtual_volumes.io_priority_l10n virtual_volumes.is_readonly virtual_volumes - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 441
Attribute virtual_volumes.type virtual_volumes.type_l10n virtual_volumes.usage_type virtual_volumes.usage_type_l10n virtual_volumes.virtual_machine_uuid Select X Sort X X X X Format storage_container [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 442
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. create Create a virtual volume (vVol) storage container. Format storage_container create -name [-quota - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 443
-name Unique name of the existing object (storage_container). -force Normally, deletion of a storage container that is mounted or still contains virtual volumes will be rejected. This option overrides that error and allows the delete to continue. Use with great caution. -async Perform asynchronous - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 444
, host_virtual_volume_mapping Attributes id The unique identifier of the virtual volume. name The name of the virtual volume, based on metadata provided by vSphere. This property supports case-insensitive filtering 417 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 445
where the virtual volume resides. storage_container_id The storage container where the virtual volume resides. io_priority The I/O priority for quality of service rules. profile_id The ID of the storage profile governing this virtual volume. creator_type Creator type of the storage resource. * User - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 446
of the moment virtual volume was created at. location_history Filtering on the fields of this embedded resource is not supported. See location_history for more details type_l10n Localized message string corresponding to type usage_type_l10n Localized message string corresponding to usage_type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 447
identifier of the appliance to which the volume was relocated. reason Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration. migrated_on Time when the storage resource location changed - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 448
Attribute appliance_id child_virtual_volumes.appliance_id child_virtual_volumes.creation_timestamp child_virtual_volumes.creator_type child_virtual_volumes.creator_type_l10n child_virtual_volumes.family_id child_virtual_volumes.id child_virtual_volumes.io_priority child_virtual_volumes. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 449
Attribute child_virtual_volumes.usage_type child_virtual_volumes.usage_type_l10n child_virtual_volumes.virtual_machine_uuid creation_timestamp creator_type creator_type_l10n family_id host_virtual_volume_mappings.host_group_id host_virtual_volume_mappings.host_id host_virtual_volume_mappings.id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 450
Attribute migration_session.id migration_session.last_sync_timestamp migration_session.name migration_session.progress_percentage migration_session.resource_type migration_session.resource_type_l10n migration_session.source_appliance_id migration_session.state migration_session.state_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 451
Attribute parent.migration_session_id parent.name parent.parent_id parent.profile_id parent.size parent.source_id parent.source_timestamp parent.storage_container_id parent.type parent.type_l10n parent.usage_type parent.usage_type_l10n parent.virtual_machine_uuid parent_id profile_id size source. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 452
Attribute source.id source.io_priority source.io_priority_l10n source.is_readonly source.location_history source.migration_session_id source.name source.parent_id source.profile_id source.size source.source_id source.source_timestamp source.storage_container_id source.type source.type_l10n source. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 453
Attribute storage_container.name storage_container.quota storage_container_id target_virtual_volumes.appliance_id target_virtual_volumes.creation_timestamp target_virtual_volumes.creator_type target_virtual_volumes.creator_type_l10n target_virtual_volumes.family_id target_virtual_volumes.id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 454
Attribute target_virtual_volumes.type target_virtual_volumes.type_l10n target_virtual_volumes.usage_type target_virtual_volumes.usage_type_l10n target_virtual_volumes.virtual_machine_uuid type type_l10n usage_type usage_type_l10n virtual_machine_uuid Select X Sort X X X X X X X X X X X - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 455
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output 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. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 456
of the volume instance. name Name of the volume. This value must contain 128 or fewer printable Unicode characters. This property supports case-insensitive filtering description Description of the volume. This value must contain 128 or fewer printable Unicode characters. type Type of volume - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 457
the volume if it is part of a migration activity. protection_data Protection data associated with a resource. Filtering on the fields of this embedded resource is not supported. See protection_data for more details location_history Filtering on the fields of this embedded resource is not - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 458
state_l10n Localized message string corresponding to state node_affinity_l10n Localized message string corresponding to node_affinity appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details protection_policy This is the embeddable reference form of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 459
of the appliance to which the volume was relocated. reason Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration. migrated_on Time when the storage resource location changed. 432 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 460
reason_l10n Localized message string corresponding to reason show Property capabilities Attribute appliance.express_service_code appliance.id appliance.model appliance.name appliance.service_tag appliance_id creation_timestamp description id is_replication_destination location_history mapped_volumes - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 461
Attribute migration_session.destination_appliance_id migration_session.estimated_completion_timestamp migration_session.family_id migration_session.id migration_session.last_sync_timestamp migration_session.name migration_session.progress_percentage migration_session.resource_type migration_session. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 462
Attribute protection_policy.name protection_policy.type protection_policy.type_l10n protection_policy_id size state state_l10n type type_l10n volume_groups.creation_timestamp volume_groups.description volume_groups.id volume_groups.is_importing volume_groups.is_protectable volume_groups. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 463
Attribute volume_groups.protection_policy_id volume_groups.type volume_groups.type_l10n wwn Select X Sort X X X X Format volume [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 464
nvp Display output as plain text. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. create Create a volume on the appliance. Format volume create -name -size [-host_id ] [-host_group_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 465
size for the volume, in bytes. -sector_size Optional sector size, in bytes. Only 512-byte and 4096-byte sectors are supported. -protection_policy_id Unique identifier of the protection policy assigned to the volume. -performance_policy_id Unique identifier of the performance policy assigned to the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 466
time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot New value for is_replication_destination property. The modification is only supported for primary and clone volume, only when the current - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 467
-force Normally a replication destination volume cannot be modified since it is controlled by replication. However, there can be cases where replication has failed or is no longer active and the replication destination volume needs to be cleaned up. With the force option, the user will be allowed to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 468
Format volume {-id | -name } clone [-name ] [-description ] [-host_id ] [-host_group_id ] [-logical_unit_number ] [-performance_policy_id ] [-protection_policy_id ] [-async] Action qualifiers -id Unique identifier of the volume or - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 469
Action qualifiers -id Unique identifier of volume to detach. -name Unique name of the existing object (volume). -host_id Unique identifier of the host to be detached from this volume. Only one of host_id or host_group_id can be supplied. -host_group_id Unique identifier of the host group to be - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 470
must contain 128 or fewer printable Unicode characters. -expiration_timestamp Expiration time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires. Use a maximum timestamp value to set an - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 471
must contain 128 or fewer printable Unicode characters. -expiration_timestamp Expiration time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires. Use a maximum timestamp value to set an - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 472
time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never Name of the volume group. This property supports case-insensitive filtering description Description for the volume group. creation_timestamp - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 473
Whether a protection_policy can be applied to the group. ◦ Whether manual snapshots can be taken. ◦ Whether clones of the group can the appliances in the cluster. Filtering on the fields of this embedded resource is not supported. type Type of volume. Primary A base object. Clone A read-write object - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 474
locations. The list of locations includes the move to the current appliance. Filtering on the fields of this embedded resource is not supported. See location_history for more details type_l10n Localized message string corresponding to type protection_policy This is the embeddable reference form of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 475
expiration_timestamp Date when the snapshot can be automatically purged. source_timestamp The time at which the resource was sourced from the resource identified by source_id. family_id Family identifier of the resource. This is the identifier of the primary object at the root of the family tree. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 476
Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration. migrated_on Time when the storage resource location changed. reason_l10n Localized message string corresponding to reason - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 477
Attribute migration_session.id migration_session.last_sync_timestamp migration_session.name migration_session.progress_percentage migration_session.resource_type migration_session.resource_type_l10n migration_session.source_appliance_id migration_session.state migration_session.state_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 478
Attribute type_l10n volumes.appliance_id volumes.creation_timestamp volumes.description volumes.id volumes.is_replication_destination volumes.location_history volumes.migration_session_id volumes.name volumes.node_affinity volumes.node_affinity_l10n volumes.performance_policy_id volumes. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 479
],..] [-offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -select Display selected attributes in the output. -sort Sorts - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 480
create Create a new volume group. The resulting volume group will have a type of Primary. Format volume_group create -name [-description ] [-volume_ids ,..] [is_write_order_consistent {yes | true | no | false}] [-protection_policy_id ] [-async] Action qualifiers -name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 481
• When a snapshot set is deleted, all of its constituent snapshots will also be deleted. Format volume_group {-id | -name } delete [-delete_members {yes | true | no | false}] [-async] Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 482
characters. If an empty string is specified, the description will be cleared. -is_write_order_consistent A boolean flag to indicate whether snapshot sets of the volume group will be write-order consistent. This parameter is only valid when modifying a primary or a clone volume group. - - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 483
-id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -volume_ids A list of primary or clone volumes to be added to the volume group. Snapshots cannot be added to a volume group. All the volumes should be on the same appliance as the current members of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 484
C1) |snapshot set (C2S1) of clone (C2)|id of source snapshot set (C2S1)|source_time of source snapshot set (C2S1)| Refresh operation is only supported if there are no membership changes between the source and target volume groups of the refresh operation. You can refresh a volume group even when the - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 485
-from_object_id Unique identifier of the volume group to refresh from. This is referred to as the source volume group. -create_backup_snap This parameter specifies whether a backup snapshot set of the target volume group needs to be created before refreshing it. This parameter defaults to true, if - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 486
auto-generated profile only initializes the name to an auto-generated, unique value. Other optional parameters are not specified. Restore operation is only supported if there are no membership changes between the target volume group and source snapshot set. You can restore a volume group even when - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 487
Optional description for the snapshot set. If description is not specified, the description for the snapshot set will not be set. -async Perform asynchronous operation. Support Manage service user credentials, perform service actions on the system 460 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 488
maintenance_window Use this resource type to manage the maintenance window configuration for each appliance. The maintenance window allows you to set a time period during which alerts do not generate any notifications. After the specified interval (1-48 hours), the maintenance window will get - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 489
Attribute end_time id is_enabled Select X Sort X X X X X Format maintenance_window [-id ] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 490
and may not be more than 172800 (48 hours). -async Perform asynchronous operation. service_config Manage the service configuration for each appliance. 'SSH Access' Manage the ability for the service user to remotely connect to the nodes in an appliance using SSH. Attributes id Unique identifier for - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 491
is_ssh_enabled The current ssh service access state. true SSH access is enabled false SSH access is disabled show Property capabilities Attribute appliance_id id is_ssh_enabled Select X Sort X X Format service_config [-id ] - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 492
id set -is_ssh_enabled {yes | true | no | false} [-async] Action qualifiers -id Unique identifier of the instance. -is_ssh_enabled Current SSH service access state. true Enables SSH access false Disables SSH access -async Perform asynchronous operation. service_user Use this resource type to - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 493
[-id ] show [-select ,..] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] Action qualifiers -id Unique identifier of the service user. -select Display selected attributes in the output. -output Change the output format. nvp Display output as plain text. csv Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 494
, eth_port, software_installed, virtual_volume, hardware, volume Attributes id Unique identifier of the appliance. name Name of the appliance. This property supports case-insensitive filtering service_tag Dell Service Tag. express_service_code Express Service Code. model Model of the appliance. 467 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 495
nodes This is the inverse of the resource type node association. See node for more details ip_pool_addresses This is the inverse of the resource type ip_pool_address association. See ip_pool_address for more details veth_ports This is the inverse of the resource type veth_port association. See - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 496
Attribute eth_ports.current_speed eth_ports.current_speed_l10n eth_ports.hypervisor_port_id eth_ports.hypervisor_port_name eth_ports.hypervisor_vswitch_id eth_ports.hypervisor_vswitch_name eth_ports.id eth_ports.io_module_id eth_ports.is_hypervisor_managed eth_ports.is_link_up eth_ports.mac_address - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 497
Attribute eth_ports.supported_speeds_l10n express_service_code fc_ports.appliance_id fc_ports.current_speed fc_ports.current_speed_l10n fc_ports.id fc_ports.io_module_id fc_ports.is_link_up fc_ports.name fc_ports.node_id fc_ports.partner_id fc_ports.port_connector_type fc_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 498
Attribute hardware.extra_details hardware.id hardware.is_marked hardware.lifecycle_state hardware.lifecycle_state_l10n hardware.name hardware.parent_id hardware.part_number hardware.serial_number hardware.slot hardware.status_led_state hardware.status_led_state_l10n hardware.type hardware.type_l10n - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 499
Attribute ip_pool_addresses.purposes ip_pool_addresses.purposes_l10n maintenance_windows.appliance_id maintenance_windows.end_time maintenance_windows.id maintenance_windows.is_enabled model name nodes.appliance_id nodes.id nodes.slot sas_ports.appliance_id sas_ports.id sas_ports.io_module_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 500
Attribute sas_ports.speed_l10n service_tag software_installed.id software_installed.installed_date software_installed.is_cluster software_installed.release_timestamp software_installed.release_version veth_ports.appliance_id veth_ports.current_mtu veth_ports.current_speed veth_ports.id veth_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 501
Attribute virtual_volumes.creator_type virtual_volumes.creator_type_l10n virtual_volumes.family_id virtual_volumes.id virtual_volumes.io_priority virtual_volumes.io_priority_l10n virtual_volumes.is_readonly virtual_volumes.location_history virtual_volumes.migration_session_id virtual_volumes.name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 502
Attribute volumes.appliance_id volumes.creation_timestamp volumes.description volumes.id volumes.is_replication_destination volumes.location_history volumes.migration_session_id volumes.name volumes.node_affinity volumes.node_affinity_l10n volumes.performance_policy_id volumes.protection_data - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 503
Action qualifiers -id Unique identifier of the appliance. -name Unique name of the existing object (appliance). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 504
Format appliance {-id | -name } set -name [-async] Action qualifiers -id Unique identifier of the appliance. -name Unique name of the existing object (appliance). -name New name of the appliance. -async Perform asynchronous operation. forecast Forecast capacity usage for an - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 505
Ethernet ports. This resource type has queriable associations from ip_port, eth_port Attributes id Unique identifier of the bond. name Bond name. This property supports case-insensitive filtering is_link_up Indicates whether the bond's link is up. Values are: true Link is up. false Link is down. mtu - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 506
in the active aggregator. mode_l10n Localized message string corresponding to mode ip_ports This is the inverse of the resource type ip_port association. See ip_port for more details eth_ports This is the inverse of the resource type eth_port association. See eth_port for more details show Property - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 507
Attribute eth_ports.node_id eth_ports.partner_id eth_ports.port_connector_type eth_ports.port_connector_type_l10n eth_ports.port_index eth_ports.requested_speed eth_ports.requested_speed_l10n eth_ports.sfp_id eth_ports.supported_speeds eth_ports.supported_speeds_l10n id ip_ports.available_usages - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 508
Attribute is_link_up mode mode_l10n mtu name Select X Sort X X X X X X X X X Format bond [{-id | -name }] show [-select ,..] [-sort [+|-],..] [offset ] [{-limit | -all}] [-output {nvp | csv [-table] [-noformat] | table | json [-raw]}] - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 509
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. cluster Manage clusters Attributes id The id of the cluster. global_id The global id of the cluster. name The name of the cluster. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 510
is_encryption_enabled Whether or not Data at Rest Encryption is enabled on the cluster. compatibility_level The behavioral version of the software version API, and it is used to help ensure compatibility across potentially different software versions. state Possible cluster states. * - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 511
a table. json Display output in JSON format. set Modify cluster properties, such as physical MTU. Format cluster -id set [-name ] [-physical_mtu ] [-async] Action qualifiers -id Unique identifier of the cluster. -name The name of the cluster. The name can be up to 64 UTF - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 512
be overridden for some specific kinds of traffic (management, data, and vmotion). This value must be in the range 1500-9000. -async Perform asynchronous operation. forecast Forecast capacity usage for the cluster. Format cluster -id forecast -metric_type {Physical_Space_Used_One_Day} [-async - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 513
port's link is up. Values are: true Link is up. false Link is down. supported_speeds The list of supported transmission speeds for Ethernet port. current_speed Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 514
second 1_Gbps 1 Gigabits per second 10_Gbps 10 Gigabits per second 25_Gbps 25 Gigabits per second 40_Gbps 40 Gigabits per second requested_speed Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on the port. For - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 515
be set to any value in the range [1500-9000]. The network MTU can be set to any value in the range [1280-9000]. The network MTU must be less than or equal of the Ethernet port in IO module. port_connector_type Type of connector supported by the port. Current values are: Unknown Unknown Connector SC - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 516
. is_hypervisor_managed Indicates whether the port is managed by a hypervisor. hypervisor_port_name Hypervisor front-end port name capabilities. This property supports case-insensitive filtering hypervisor_vswitch_name Name of the virtual switch associated with the hypervisor port. This property - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 517
port_connector_type_l10n Localized message string corresponding to port_connector_type ip_ports This is the inverse of the resource type ip_port association. See ip_port for more details appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details node - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 518
Attribute bond.mode bond.mode_l10n bond.mtu bond.name bond_id current_mtu current_speed current_speed_l10n hypervisor_port_id hypervisor_port_name hypervisor_vswitch_id hypervisor_vswitch_name id io_module.appliance_id io_module.extra_details io_module.id io_module.is_marked io_module. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 519
Attribute io_module.part_number io_module.serial_number io_module.slot io_module.status_led_state io_module.status_led_state_l10n io_module.type io_module.type_l10n io_module_id ip_ports.available_usages ip_ports.available_usages_l10n ip_ports.bond_id ip_ports.current_usages ip_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 520
Attribute name node.appliance_id node.extra_details node.id node.is_marked node.lifecycle_state node.lifecycle_state_l10n node.name node.parent_id node.part_number node.serial_number node.slot node.status_led_state node.status_led_state_l10n node.type node.type_l10n node_id partner.appliance_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 521
Attribute partner.current_speed_l10n partner.hypervisor_port_id partner.hypervisor_port_name partner.hypervisor_vswitch_id partner.hypervisor_vswitch_name partner.id partner.io_module_id partner.is_hypervisor_managed partner.is_link_up partner.mac_address partner.name partner.node_id partner. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 522
Attribute partner_id port_connector_type port_connector_type_l10n port_index requested_speed requested_speed_l10n sfp.appliance_id sfp.extra_details sfp.id sfp.is_marked sfp.lifecycle_state sfp.lifecycle_state_l10n sfp.name sfp.parent_id sfp.part_number sfp.serial_number sfp.slot sfp. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 523
Attribute sfp_id supported_speeds supported_speeds_l10n Select X Sort X X X X X Format eth_port [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 524
, the partner port speed on the other node in the appliance is set to the same requested speed. If the requested speed is not supported by the partner port it is left unchanged. Format eth_port {-id | -name } set -requested_speed {Auto | 10_Mbps | 100_Mbps | 1_Gbps | 10_Gbps | 25_Gbps - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 525
queriable associations from appliance, hardware, fc_port Attributes id Unique identifier of the port. name Name of the port. This property supports case-insensitive filtering appliance_id Unique identifier of the appliance containing the port. node_id Unique identifier of the hardware instance of - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 526
supported_speeds List of supported transmission speeds for the port. current_speed Possible Fibre Channel port speeds. For the current_speed attribute, these values show the current transmission speed on the port. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 527
instance of type 'IO_Module' handling the port. port_index Index of the port in the IO module. port_connector_type Type of connector supported by the port. Current values are: Unknown Unknown Connector SC Subscriber Connector FC_Style1_Copper Fibre Channel Style 1 Copper Connector FC_Style2_Copper - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 528
HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable No Separable Connector MXC_2x16 MXC 2x16 Connector partner_id Unique identifier of the partner port. supported_speeds_l10n Localized message array corresponding to supported_speeds - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 529
show Property capabilities Attribute appliance.express_service_code appliance.id appliance.model appliance.name appliance.service_tag appliance_id current_speed current_speed_l10n id io_module.appliance_id io_module.extra_details io_module.id io_module.is_marked io_module.lifecycle_state io_module. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 530
Attribute io_module.status_led_state io_module.status_led_state_l10n io_module.type io_module.type_l10n io_module_id is_link_up name node.appliance_id node.extra_details node.id node.is_marked node.lifecycle_state node.lifecycle_state_l10n node.name node.parent_id node.part_number node.serial_number - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 531
Attribute node.type_l10n node_id partner.appliance_id partner.current_speed partner.current_speed_l10n partner.id partner.io_module_id partner.is_link_up partner.name partner.node_id partner.partner_id partner.port_connector_type partner.port_connector_type_l10n partner.port_index partner. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 532
Attribute port_connector_type port_connector_type_l10n port_index requested_speed requested_speed_l10n sfp.appliance_id sfp.extra_details sfp.id sfp.is_marked sfp.lifecycle_state sfp.lifecycle_state_l10n sfp.name sfp.parent_id sfp.part_number sfp.serial_number sfp.slot sfp.status_led_state sfp. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 533
Attribute supported_speeds supported_speeds_l10n wwn Select X Sort X X X X X Format fc_port [{-id | -name }] show [-select ,..] [-sort - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 534
partner port speed on the other node in the appliance is set to the same requested speed. If the requested speed is not supported by the partner port, it is left unchanged. Format fc_port {-id | -name } set -requested_speed {Auto | 4_Gbps | 8_Gbps | 16_Gbps | 32_Gbps} [-async] Action - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 535
fc_port, sas_port, eth_port, hardware, appliance Attributes id The unique id of the component. name The name of the component. This property supports case-insensitive filtering type Hardware component type. lifecycle_state Life cycle state of the component. parent_id The id of the component's parent - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 536
is_marked Indicator of whether a component is location marked or not. extra_details Additional hardware details. Contents are specific to each component type. See extra_details for more details type_l10n Localized message string corresponding to type lifecycle_state_l10n Localized message string - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 537
on the SFP hardware type. Current modes are: Unknown This SFP has unknown support. Multi_Mode This SFP supports multi-mode fiber. Single_Mode This SFP supports single-mode fiber. supported_speeds supported_protocol Supported protocol. Available on the SFP hardware type. Current protocols are: 510 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 538
Unknown This SFP has unknown protocol support. FC This SFP supports Fibre Channel. Ethernet This SFP supports Ethernet. FC_Ethernet This SFP supports Fibre Channel or Ethernet. SAS This SFP supports SAS for connections to Expansion Enclosures. connector_type Connector type. Available on the SFP - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 539
hardware type. encryption_status Indicates whether the drive is currently encrypted or not. Available on the Drive hardware type. Current statuses are: Not_Supported Drive does not support encryption. 512 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 540
supports encryption and is locked. Supported_Locked_Cluster_PIN Drive supports encryption and is configured. Supported_Locked_Out Drive supports encryption and is locked out. Supported_Locked_Foreign Drive supports has invalid FIPS compliance. dell_service_tag Dell service tag of the hardware. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 541
Localized message array corresponding to supported_speeds supported_protocol_l10n Localized message string corresponding to supported_protocol connector_type_l10n Localized message string corresponding to connector_type drive_type_l10n Localized message string corresponding to drive_type - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 542
Attribute children.name children.parent_id children.part_number children.serial_number children.slot children.status_led_state children.status_led_state_l10n children.type children.type_l10n extra_details id io_module_eth_ports.appliance_id io_module_eth_ports.bond_id io_module_eth_ports.current_mtu - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 543
Attribute io_module_eth_ports.io_module_id io_module_eth_ports.is_hypervisor_managed io_module_eth_ports.is_link_up io_module_eth_ports.mac_address io_module_eth_ports.name io_module_eth_ports.node_id io_module_eth_ports.partner_id io_module_eth_ports.port_connector_type io_module_eth_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 544
Attribute io_module_fc_ports.name io_module_fc_ports.node_id io_module_fc_ports.partner_id io_module_fc_ports.port_connector_type io_module_fc_ports.port_connector_type_l10n io_module_fc_ports.port_index io_module_fc_ports.requested_speed io_module_fc_ports.requested_speed_l10n io_module_fc_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 545
Attribute io_module_sas_ports.speed io_module_sas_ports.speed_l10n is_marked lifecycle_state lifecycle_state_l10n name node_eth_ports.appliance_id node_eth_ports.bond_id node_eth_ports.current_mtu node_eth_ports.current_speed node_eth_ports.current_speed_l10n node_eth_ports.hypervisor_port_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 546
Attribute node_eth_ports.node_id node_eth_ports.partner_id node_eth_ports.port_connector_type node_eth_ports.port_connector_type_l10n node_eth_ports.port_index node_eth_ports.requested_speed node_eth_ports.requested_speed_l10n node_eth_ports.sfp_id node_eth_ports.supported_speeds node_eth_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 547
Attribute node_fc_ports.port_index node_fc_ports.requested_speed node_fc_ports.requested_speed_l10n node_fc_ports.sfp_id node_fc_ports.supported_speeds node_fc_ports.supported_speeds_l10n node_fc_ports.wwn node_sas_ports.appliance_id node_sas_ports.id node_sas_ports.io_module_id node_sas_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 548
Attribute parent.is_marked parent.lifecycle_state parent.lifecycle_state_l10n parent.name parent.parent_id parent.part_number parent.serial_number parent.slot parent.status_led_state parent.status_led_state_l10n parent.type parent.type_l10n parent_id part_number serial_number sfp_eth_ports. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 549
Attribute sfp_eth_ports.hypervisor_port_name sfp_eth_ports.hypervisor_vswitch_id sfp_eth_ports.hypervisor_vswitch_name sfp_eth_ports.id sfp_eth_ports.io_module_id sfp_eth_ports.is_hypervisor_managed sfp_eth_ports.is_link_up sfp_eth_ports.mac_address sfp_eth_ports.name sfp_eth_ports.node_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 550
Attribute sfp_fc_ports.current_speed_l10n sfp_fc_ports.id sfp_fc_ports.io_module_id sfp_fc_ports.is_link_up sfp_fc_ports.name sfp_fc_ports.node_id sfp_fc_ports.partner_id sfp_fc_ports.port_connector_type sfp_fc_ports.port_connector_type_l10n sfp_fc_ports.port_index sfp_fc_ports.requested_speed - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 551
Attribute sfp_sas_ports.node_id sfp_sas_ports.partner_id sfp_sas_ports.port_index sfp_sas_ports.sfp_id sfp_sas_ports.speed sfp_sas_ports.speed_l10n slot status_led_state status_led_state_l10n type type_l10n Select X Sort X X X X X X X X X X X X X X X Format hardware [{-id | - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 552
set to false. Note that the state returned in the hardware component may not actually change for up to 60 seconds. This operation is currently supported for Base_Enclosure, Expansion_Enclosure, Node and Drive. Note that operations at 525 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 553
the Base_Enclosure and Expansion_Enclosure apply to their children (Nodes and Drives for Base_Enclosure and Drives for Expansion_Enclosure). For components with a single physical LED (Base_Enclosure and Node), setting is_marked=true overrides the status_led_state property from on (or off) to Null, - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 554
appliance_id Unique identifier of the appliance to which the node belongs. appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details ip_pool_addresses This is the inverse of the resource type ip_pool_address association. See ip_pool_address for more - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 555
Attribute ip_pool_addresses.purposes ip_pool_addresses.purposes_l10n slot veth_ports.appliance_id veth_ports.current_mtu veth_ports.current_speed veth_ports.id veth_ports.is_link_up veth_ports.mac_address veth_ports.name veth_ports.node_id veth_ports.vswitch_name veth_ports.vswitch_port_group_name - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 556
resource type has queriable associations from appliance, hardware, sas_port Attributes id Unique identifier of the SAS port. name Name of the SAS port. This property supports case-insensitive filtering appliance_id Unique identifier of the appliance containing the port. 529 - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 557
node_id Unique identifier of the hardware instance of type 'Node' containing the port. is_link_up Indicates whether the SAS port's link is up. Values are: true Link is up. false Link is down. speed SAS port transmission speed. ◦ 3_Gbps- 3 Gigabits per second ◦ 6_Gbps- 6 Gigabits per second ◦ 12_Gbps - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 558
details partner This is the embeddable reference form of partner_id attribute. See sas_port for more details show Property capabilities Attribute appliance.express_service_code appliance.id appliance.model appliance.name appliance.service_tag appliance_id id io_module.appliance_id io_module. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 559
Attribute io_module.slot io_module.status_led_state io_module.status_led_state_l10n io_module.type io_module.type_l10n io_module_id is_link_up name node.appliance_id node.extra_details node.id node.is_marked node.lifecycle_state node.lifecycle_state_l10n node.name node.parent_id node.part_number - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 560
Attribute node.type node.type_l10n node_id partner.appliance_id partner.id partner.io_module_id partner.is_link_up partner.name partner.node_id partner.partner_id partner.port_index partner.sfp_id partner.speed partner.speed_l10n partner_id port_index sfp.appliance_id sfp.extra_details sfp.id sfp. - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 561
Attribute sfp.lifecycle_state_l10n sfp.name sfp.parent_id sfp.part_number sfp.serial_number sfp.slot sfp.status_led_state sfp.status_led_state_l10n sfp.type sfp.type_l10n sfp_id speed speed_l10n Select X Sort X X X X X X X X X X X X X X X Format sas_port [{-id | -name < - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 562
field+ (or just field) sort by field in ascending order. fieldsort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output Change the output format. nvp Display output as plain text. csv Display - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 563
associated with the virtual Ethernet port. vswitch_port_name Name of the virtual switch port associated with the virtual Ethernet port. This property supports case-insensitive filtering ip_ports This is the inverse of the resource type ip_port association. See ip_port for more details appliance This - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 564
Attribute appliance.express_service_code appliance.id appliance.model appliance.name appliance.service_tag appliance_id current_mtu current_speed id ip_ports.available_usages ip_ports.available_usages_l10n ip_ports.bond_id ip_ports.current_usages ip_ports.current_usages_l10n ip_ports.eth_port_id - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 565
Attribute name node.appliance_id node.id node.slot node_id vswitch_name vswitch_port_group_name vswitch_port_id vswitch_port_name Select X Sort X X X X X X X X X X X X X X Format veth_port [{-id | -name }] show [-select ,..] [-sort [+|],..] [-offset - Dell PowerStore 5000X | EMC PowerStore CLI Guide - Page 566
Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -output 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. 539
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
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
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
 |
 |
Dell EMC PowerStore
CLI Guide