Dell PowerStore 500T EMC PowerStore CLI Reference Guide
Dell PowerStore 500T Manual
 |
View all Dell PowerStore 500T manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell PowerStore 500T manual content summary:
- Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 1
Dell EMC PowerStore CLI Reference Guide © 2021 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 trademarks of their respective owners. June 2021 Rev. A03 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 2
Table of Contents Compute 12 discovered_initiator 12 show 12 host 13 show 16 create 18 delete 20 set 20 attach 22 detach 23 host_group 23 show 24 create 26 delete 27 set 27 attach 28 detach 28 host_virtual_volume_mapping 29 show 29 host_volume_mapping 32 show 33 vcenter 36 show - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 3
refresh 60 import_host_volume 60 show 62 import_psgroup 64 show 66 discover 68 import_psgroup_volume 68 show 71 import_snapshot_schedules 73 import_session 73 show 79 create 82 delete 84 set 84 cancel 85 cleanup 85 cutover 86 enable_destination_volume[Added in 1.0.2 86 pause 87 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 4
discover 122 import_vnx_consistency_group 123 show 124 import_vnx_volume 127 show 131 import_xtremio 133 show 137 discover[Added in 1.0.2 140 import_xtremio_consistency_group 140 show 141 import_snapshot_schedules[Added in . 1.0.2 144 import_xtremio_volume 144 show 147 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 5
create[Added in . 2.0.0.0 211 delete[Added in 2.0.0.0 212 set[Added in 2.0.0.0 212 test[Added in 2.0.0.0 213 Protection 213 policy 214 show 215 create 222 delete 222 set 223 remote_system 224 show 227 create 231 delete 234 set 235 verify 236 replication_rule 236 show 238 create - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 6
dns 269 show 270 set 271 email_notify_destination 271 show 272 create 273 delete 274 set 274 test 275 ip_pool_address 275 show 276 ip_port 279 show 281 set 286 keystore_archive 287 regenerate 287 download 287 ldap_account 288 show 289 create[Added in . 1.0.3 289 delete[Added in . - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 7
create[Added in . 2.0.0.0 310 delete[Added in 2.0.0.0 312 set 312 replace 314 scale 317 ntp 318 show 318 set 319 physical_switch 320 show 320 create 322 delete 323 set 324 role 325 show 325 security_config 326 show 326 set[Added in 2.0.0.0 327 smtp_config 328 show 328 set 329 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 8
exchange 354 reset_certificates[Added in . 2.0.0.0 355 Storage 356 file_dns 356 show 357 create 359 delete 360 set 360 file_ftp 361 show 364 create 367 delete 370 set 370 file_interface 373 show 375 create 377 delete 378 set 379 file_interface_route 379 show 381 create 383 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 9
create 405 delete 405 set 406 file_nis 406 show 407 create 409 delete 410 set 410 file_system 411 show 417 create 424 delete 426 set 427 clone 430 refresh 433 refresh_quota 433 restore 433 snapshot 434 file_tree_quota 437 show 439 create 443 delete 444 set 445 refresh 446 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 10
ping 473 update_user_mappings 474 nas_server/download 474 group 474 homedir 475 hosts 475 netgroup 476 nsswitch 476 ntxmap 477 passwd 477 user_mapping_report 478 nas_server/upload 478 group 478 homedir 479 hosts 479 netgroup 479 nsswitch 480 ntxmap 480 passwd 481 nfs_export 481 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 11
555 snapshot 556 volume_group 557 show 561 create 565 delete 566 set 566 add_members 568 clone 568 refresh 569 remove_members 571 restore 571 snapshot 572 Support 573 maintenance_window 573 show 574 set 576 remote_support_contact 576 10 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 12
show 577 set[Added in 2.0.0.0 577 service_config 578 show 578 set 579 service_user 580 show 580 set 581 System and Hardware 582 appliance 582 show 583 create[Added in . 2.0.0.0 593 delete[Added in 2.0.0.0 594 set 594 forecast 595 time_to_full 595 validate_create[Added in 2.0.0.0 596 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 13
show 679 Compute Manage host configurations, virtual machines and VMware integration discovered_initiator Use this resource type to list initiators currently connected to the cluster that are not associated with a host. An initiator currently connected to the cluster, but not associated with any - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 14
associations from host_group, import_host_system, host_volume_mapping, host_virtual_volume_mapping Attributes id Type: string Unique identifier of the host. name Type: string The host name. This property supports case-insensitive filtering. description Type: string A description for the host. 13 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 15
is part of host group. host_initiators Type: array of objects Filtering on the fields of this embedded resource is not supported. See host_initiators for more details type_l10n[Added in 2.0.0.0] Type: string Localized message string corresponding to type Was added in version 2.0.0.0. os_type_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 16
port_name IQN name aka address for iSCSI or WWN name for FC (SCSI) or NQN name for all NVMe-oF port types. port_type Protocol type of the host initiator. iSCSI An iSCSI host initiator. FC A Fibre Channel host initiator. NVMe A NVMe host initiator. Single type for all NVMe Fabrics types (NVMe/FC, - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 17
veth_id Unique identifier of the virtual Ethernet port the initiator is logged into. Null if one of the following is non-null: bond, eth_port_id or fc_port_id. eth_port_id Unique identifier of the Ethernet port the initiator is logged into. Null if one of the following is non-null: bond_id, veth_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 18
Attribute import_host_system.agent_type import_host_system.agent_type_l10n import_host_system.agent_version import_host_system.id import_host_system.last_update_time import_host_system.os_type import_host_system.os_type_l10n import_host_system.os_version import_host_system.user_name mapped_hosts. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 19
Action qualifiers -id Unique identifier of the host. -name Unique name of the existing object (host). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 20
Format host create -name -os_type { Windows | Linux | ESXi | AIX | HP-UX | Solaris } ( -initiators -port_name -port_type { iSCSI | FC | NVMe[Added in 2.0.0.0] } [ -chap_single_username ] [ { -chap_single_password | -chap_single_passwordSecure } ] [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 21
object (host). -async Perform asynchronous operation. set Modify a host. Only one of add, remove and update initiator operations are supported in a single request. Format host { -id | -name } set [ -name ] [ -description ] [ -remove_initiators - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 22
-id Unique identifier of the host. -name Unique name of the existing object (host). -name The host name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters. -description An optional description for the host. The description should not be more - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 23
username is required when the cluster CHAP mode is mutual authentication. -chap_mutual_password Password for CHAP authentication. This value must be 12 to 64 UTF-8 characters. This password is not queriable. CHAP password is required when the cluster CHAP mode is mutual authentication. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 24
Action qualifiers -id Unique identifier 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 desired. -async Perform asynchronous operation. detach Detach host from volume. Format host { -id | - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 25
id Type: string The host group unique identifier. name Type: string The host group name. This property supports case-insensitive filtering. description Type: string A description for the host group. hosts This is the inverse of the resource type host association. See host for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 26
Attribute hosts.id hosts.name hosts.os_type hosts.os_type_l10n hosts.type hosts.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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 27
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 28
of the host group. -name Unique name of the existing object (host_group). -async Perform asynchronous operation. set Modify a host group. Modify does not support rename and add/modify at the same time. Format host_group { -id | -name } set [ -name ] [ -description - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 29
-async Perform asynchronous operation. attach Attach host group to volume. Format host_group { -id | -name } attach -volume_id [ -logical_unit_number ] [ -async ] Action qualifiers -id Unique identifier of the host group. -name Unique name of the existing object ( - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 30
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 Type: string Unique identifier of a mapping between a host and a virtual volume. host_id Type: string Unique - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 31
Attribute host.host_initiators host.id host.name host.os_type host.os_type_l10n host.type host.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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 32
Attribute virtual_volume.is_readonly virtual_volume.location_history 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 33
-sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 34
be set. host_group_id Type: string Unique identifier of a host group attached to a volume. The host_id and host_group_id cannot both be set. volume_id Type: string Unique identifier of the volume to which the host is attached. logical_unit_number Type: 32-bit signed integer (0 to 2147483647) Logical - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 35
Attribute host.type host.type_l10n host_group.description host_group.id host_group.name host_group_id 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 36
Attribute volume.performance_policy_id volume.protection_data volume.protection_policy_id volume.size volume.state volume.state_l10n volume.type volume.type_l10n volume.wwn volume_id Select X Sort X X X X X X X X X X Search X Format host_volume_mapping [ -id ] show [ -select < - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 37
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 500T | EMC PowerStore CLI Reference Guide - Page 38
username Type: string User name to login to vCenter. vendor_provider_status[Added in 2.0.0.0] Type: enumerated value ("Not_Registered", "Offline", "Online") General status of the VASA vendor provider in vCenter. A VASA vendor provider is required for HCI deployments, and optional for SAN deployments - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 39
Attribute 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.protection_policy_id virtual_machines.status virtual_machines. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 40
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 41
the VASA vendor provider from the vCenter. This will only happen if the provider is not connected to any other PowerStore systems. -async Perform asynchronous operation. set Modify a vCenter settings. Format vcenter -id set [ -address ] [ -username ] [ { -password - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 42
-id Unique identifier of the vCenter to modify. -address IP address of vCenter host, in IPv4, IPv6, or hostname format. Must be a new address of the same vCenter. -username User name to login to vCenter. Password needs to be provided to modify the user name. -password Password to login to vCenter. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 43
that hosts the VM. Was deprecated in version 2.0.0.0. name Type: string User-assigned name of the VM in vCenter. This property supports case-insensitive filtering. description Type: string Description of the VM in vCenter. type Type: enumerated value ("Primary", "Snapshot", "Template") Type of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 44
protection_data Type: object Protection data associated with the VM snapshot. Filtering on the fields of this embedded resource is not supported. See protection_data for more details type_l10n Type: string Localized message string corresponding to type. status_l10n Type: string Localized message - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 45
parent This is the embeddable reference form of parent_id attribute. See virtual_machine for more details children This is the inverse of the resource type virtual_machine association. See virtual_machine for more details vcenter This is the embeddable reference form of vcenter_id attribute. See - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 46
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 500T | EMC PowerStore CLI Reference Guide - Page 47
Attribute instance_uuid 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 48
Attribute parent.vcenter_instance_uuid protection_data 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.address vcenter.id vcenter. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 49
Attribute 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 500T | EMC PowerStore CLI Reference Guide - Page 50
Attribute virtual_volumes.usage_type_l10n virtual_volumes.virtual_machine_uuid Select X Sort X Search Format virtual_machine [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 51
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. delete Delete a virtual machine snapshot. This operation cannot be used on a base virtual machine or virtual machine template. Format virtual_machine { -id | -name } delete [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 52
snapshot Create a snapshot of a virtual machine. This operation cannot be used on a virtual machine snapshot or template. Format virtual_machine { -id | -name } snapshot [ -name ] [ -description ] [ -async ] Action qualifiers -id Unique identifier of the virtual - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 53
. 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 Type: string Unique identifier of the import host system. protocol_l10n Type: string Localized message string corresponding to protocol - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 54
already present, the same Host will be updated 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 two Hosts entries for representing the FC - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 55
host system. Valid values are: EQL EQL MPIO. Native_MPIO Native MPIO. Power_Path POWER PATH MPIO. Unknown Type of host agent is unknown to PowerStore. agent_port Type: 32-bit signed integer (0 to 2147483647) TCP port on the import host system. agent_version Type: string Version of the import - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 56
", "Unknown", Running Agent is up and running. Conflict_Detected Agent detected that there are multiple MPIOs installed on the host and Destination Powerstore MPIO is not able to claim destination device as some other MPIO has already claimed it. Version_Unsupported Agent detected that the OS - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 57
agent_status_l10n Type: string Localized message string corresponding to agent_status. hosts This is the inverse of the resource type host association. See host for more details show Property capabilities Attribute agent_address agent_api_version agent_port agent_status agent_status_l10n agent_type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 58
Attribute hosts.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 Search X X X X X X Format import_host_system [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 59
system of the import host system. Valid values are: Windows Windows. Linux Linux. ESXi ESXi. 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. 58 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 60
-user_name Username for the import host system. -password Password for the specified username. -passwordSecure Secure version of -password. Value will be queried interactively. -chap_single_username Username for single CHAP authentication. This username is required when the cluster is using single - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 61
host volume. host_system_id Type: string Unique identifier of the import host system. name Type: string Name of the import host volume. This property supports case-insensitive filtering. array_type Type: enumerated value ("PS", "SC", "Unity", "Unknown", "VNX") Product type of the storage system. 60 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 62
value ("Destination", "None", "Source") Active path of the host volume. protocols Type: array of enumerated values ("FC", "FCoE", "Other", "Unknown", "iSCSI") Supported protocols for the import host volume. mount_paths Type: array of strings Mount paths on the import host system. import_state Type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 63
Cancel_Forced None Aborted the ongoing cancel operation. Migration state is not known to PowerStore. naa_id Type: string Unique identifier of a volume that is presented to the import host. last_update_time Type: date time Time when the import host volume was - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 64
Attribute array_identifier array_type array_type_l10n host_system_id id import_state import_state_l10n is_migrating last_update_time mount_paths 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 X X X X X X X X X X X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 65
. json Display output in JSON format. import_psgroup Use these resource types to discover the 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 Attributes id Type: string 64 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 66
Unique identifier of the PS Group. name Type: string Name of the PS Group. This property supports case-insensitive filtering. serial_number Type: string Serial number of the PS Group. management_address Type: string Management address of the PS Group. This can be an - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 67
import_psgroup_volumes This is the inverse of the resource type import_psgroup_volume association. See import_psgroup_volume for more details show Property capabilities Attribute description group_address id import_psgroup_volumes.block_size import_psgroup_volumes.block_size_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 68
Attribute management_address name serial_number supported_import_type supported_import_type_l10n user_name Select X Sort X X X X X X X X X X X Search X X X X X X Format import_psgroup [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 69
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 Type: string Unique identifier of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 70
: string Unique identifier of the PS Group with which the volume is associated. name Type: string Name of the volume. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) Size of the volume, in bytes. block_size Type: enumerated value ("4K_Bytes - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 71
. Aborted Volume migration is aborted Unknown Volume migration state is unknown to PowerStore. importable_criteria Type: enumerated value ("Cluster_Node_Count_MisMatch", "Host_Not_Added", "Host_Volume_Offline", "Imported", "In_Progress", "Incompatible_Firmware", "Incompatible_Host_Agent - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 72
for more details show Property capabilities Attribute block_size block_size_l10n host_volume_ids id import_psgroup.description import_psgroup.group_address import_psgroup.id import_psgroup.last_update_time import_psgroup.management_address import_psgroup.name import_psgroup.serial_number - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 73
Attribute migration_state migration_state_l10n name size wwn Select X Sort X X X X X X X X X Search X X X X X Format import_psgroup_volume [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 74
. import_session Use the import_session resource type to initiate and manage 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 that access the volume during the import. The import process runs - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 75
Was added in version 1.0.2. name Type: string User-specified name of the import session. This property supports case-insensitive filtering. description Type: string User-specified description of the import session. remote_system_id Type: string Unique identifier of the storage system that contains - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 76
(FIFO) order. This occurs when there are more active import sessions than supported. Indicates that a queued import session is now in progress. Indicates that 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 500T | EMC PowerStore CLI Reference Guide - Page 77
Import_Completed Indicates that all operations completed successfully for a given import after a commit. In this state, the source volume is no longer mapped to the host and all stale paths are cleaned up. Cancelled Indicates that a user forcefully cancelled the import. Failed Indicates that - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 78
Type: string 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 500T | EMC PowerStore CLI Reference Guide - Page 79
specified in ISO 8601 format with the time expressed in UTC format. error Type: object Filtering on the fields of this embedded resource is not supported. See error for more details last_update_timestamp Type: date time Date and time when was the import was last updated. This value is updated each - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 80
show Property capabilities 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 81
Attribute remote_system.description 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 82
Attribute type type_l10n volume_group_id Select X Sort X X X X X Search X X X Format import_session [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 83
: import_psgroup_volume * Unity : import_unity_volume, import_unity_consistency_group -name Name of the import session. The name must be unique in the PowerStore cluster and can contain a maximum of 128 unicode characters. It cannot contain special HTTP characters, unprintable characters, or white - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 84
any. -automatic_cutover Indicates whether the import session cutover is manual (true) or automatic (false). -protection_policy_id Unique identifier of volume or consistency group after the import completes. Only snapshot policies are supported in an import. Once the import completes, you can add a - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 85
-scheduled_timestamp 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 86
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 500T | EMC PowerStore CLI Reference Guide - Page 87
session is created with the automatic_cutover attribute set to false, you must use 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 host IOs. You can cancel the import during this state if you - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 88
pause Pauses an ongoing import session. When this occurs, the background 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 cancel the paused import. Format import_session { -id | -name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 89
and consistency groups that can be imported to PowerStore. This resource type has queriable associations from for import. name Type: string Name of the SC array. This property supports case-insensitive filtering. management_address Type: string Management address to use for communicating with - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 90
: 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 Type: date time Timestamp at which the SC array details were last updated. This includes the information about the array and its - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 91
import_storage_center_consistency_groups This is the inverse of the resource type import_storage_center_consistency_group association. See import_storage_center_consistency_group for more details show Property capabilities Attribute api_version Select X Sort X id X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 92
Attribute import_storage_center_volumes.is_active import_storage_center_volumes.is_read_only import_storage_center_volumes.migration_state import_storage_center_volumes.migration_state_l10n import_storage_center_volumes.name import_storage_center_volumes.size import_storage_center_volumes.wwn - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 93
-name Unique name of the existing object (import_storage_center). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 94
volumes and consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_storage_center_volume, string Name of the SC consistency group. This property supports case-insensitive filtering. import_storage_center_id Type: string Unique identifier of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 95
import_storage_center This is the embeddable reference form of import_storage_center_id attribute. See import_storage_center for more details show Property capabilities Attribute id import_storage_center.api_version import_storage_center.id import_storage_center.last_update_time - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 96
Attribute Select import_storage_center_volumes.import_storage_center_consiste ncy_group_id X Sort import_storage_center_volumes.import_storage_center_consiste X ncy_group_names import_storage_center_volumes.import_storage_center_id X import_storage_center_volumes.importable_criteria X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 97
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 98
Center (SC) volumes that can be imported to PowerStore. This resource type has queriable associations from import_storage_center, the SC volume. name Type: string Name of the SC volume. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) Size - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 99
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 Type: boolean Indicates whether the volume is read-only. importable_criteria Type: enumerated - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 100
"VNX_Internal_Volume", "VNX_Not_Ready", "XtremIO_Severity_Inappropriate", "XtremIO_State_Inappropriate", "XtremIO_Volume_Severity_Inappropriate", "XtremIO_Volume_State_Inappropriate") Volume import criteria. If the value is not Ready, the volume is not importable. host_volume_ids Type: array of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 101
Attribute health Select X Sort X health_l10n X X host_volume_ids X X id X X import_storage_center.api_version X import_storage_center.id X import_storage_center.last_update_time X import_storage_center.management_address X import_storage_center.model X import_storage_center. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 102
Attribute import_storage_center_consistency_group.name import_storage_center_consistency_group_id import_storage_center_consistency_group_names import_storage_center_id importable_criteria importable_criteria_l10n is_active is_read_only migration_state migration_state_l10n name size wwn Select X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 103
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 104
for import. This is the serial number of the storage system. name Type: string Name of the Unity storage system. This property supports case-insensitive filtering. management_address Type: string Management address to use for communicating with the Unity storage system. The address can be an - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 105
Ok_But The system is operating normally but there are potential issues. Degraded The system is working, but performance may not be optimum. Minor The system is working, but it has experienced one or more minor failures. Major The system is failing; some or all of its functions may be degraded - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 106
Localized message string corresponding to supported_import_type Was added in version 1.0.2. import_unity_volumes This is the inverse of the resource type import_unity_volume association. See import_unity_volume for more details import_unity_consistency_groups This is the inverse of the resource type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 107
Attribute import_unity_volumes.importable_criteria 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 108
field offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the Unity storage system. -name Unique name of the existing object (import_unity). -select Display selected - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 109
the Unity consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_unity_volume, name Type: string Name of the consistency group. This property supports case-insensitive filtering. import_unity_id Type: string Unique identifier of the Unity - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 110
import_unity_volume for more details import_unity This is the embeddable reference form of import_unity_id attribute. See import_unity for more details show Property capabilities Attribute id import_unity.api_version import_unity.health import_unity.health_l10n import_unity.id import_unity. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 111
Attribute import_unity_volumes.host_volume_ids 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 112
-id Unique identifier of the Unity consistency group. -name Unique name of the existing object (import_unity_consistency_group). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 113
the Unity volumes that can be imported to PowerStore. This resource type has queriable associations from import_unity of the Unity volume. name Type: string Name of the Unity volume. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) Size of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 114
health Type: enumerated value ("Critical", "Degraded", "Major", "Minor", "Non_Recoverable", "Ok", "Ok_But", "Unknown") Health status of the Unity storage system. Values are: Unknown The status of the system cannot be determined. Ok The system is operating normally. Ok_But The system is - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 115
cancelled. Not_Applicable Volume migration state is not applicable if the system only supports agentless import. Unknown The volume migration state is unknown to PowerStore. is_replication_destination Type: boolean Indicates whether the Unity volume is a replication destination. is_thin_clone - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 116
List of host volume identifiers that correspond to Unity volumes. health_l10n Type: string Localized message string corresponding to health. type_l10n Type: string Localized message string corresponding to type. migration_state_l10n Type: string Localized message string corresponding to - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 117
Attribute 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.supported_import_type import_unity.supported_import_type_l10n import_unity - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 118
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 Search X X X X X X X X Format import_unity_volume [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 119
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 id Type: string Unique identifier of the VNX - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 120
name Type: string Name of the VNX storage system. This property supports case-insensitive filtering. serial_number Type: string Serial number of the VNX storage system. management_address Type: string Management address for communicating with the VNX storage system. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 121
The software version of the block operating environment of the VNX storage system. supported_import_type[Added in 1.0.2] Type: enumerated "Not_Supported") value ("Agentless", "Non_Disruptive_And_Agentless", Was added in version 1.0.2. supported_import_type_l10n[Added in 1.0.2] Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 122
Attribute import_vnx_volumes.id import_vnx_volumes.import_vnx_array_id 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 123
field offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of a VNX storage system. -name Unique name of the existing object (import_vnx_array). -select Display selected - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 124
show the VNX consistency groups that can be imported to PowerStore. This resource type has queriable associations from import_vnx_volume, name Type: string Name of the consistency group. This property supports case-insensitive filtering. import_vnx_array_id Type: string Unique identifier of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 125
array is not compatible. The import status cannot be determined due to an internal error. Contact technical support. Values was added in 1.0.2: Ready_For_Agentless_Import. importable_criteria_l10n Type: string Localized message string corresponding to importable_criteria. import_vnx_volumes This is - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 126
Attribute 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.supported_import_type import_vnx_array. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 127
Attribute import_vnx_volumes.name import_vnx_volumes.size import_vnx_volumes.wwn importable_criteria importable_criteria_l10n name Select X Sort X X X X X X X X Search X X X Format import_vnx_consistency_group [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 128
the VNX volumes and that can be imported to PowerStore. This resource type has queriable associations from import_vnx_array, import_vnx_consistency_group volume. name Type: string Name of the VNX volume. This property supports case-insensitive filtering. wwn Type: string World wide name of the VNX - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 129
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 Type: string Unique identifier of the VNX storage - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 130
is not compatible. The agent version on the host is not compatible. The import status cannot be determined due to an internal error. Contact technical support. The host volume is offline. The host or hosts added to the appliance are not part of the host cluster to which the volume is - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 131
VNX_Not_Ready The VNX volume is not in a ready state. VNX_Internal_Volume The VNX volume is an internal volume. Unity_System_Health_Inappropriate The health of the Unity system is not suitable for import. Unity_Volume_Health_Inappropriate The health of the Unity volume is not suitable for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 132
import_vnx_array This is the embeddable reference form of import_vnx_array_id attribute. See import_vnx_array for more details import_vnx_consistency_group This is the embeddable reference form of import_vnx_consistency_group_id attribute. See import_vnx_consistency_group for more details show - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 133
Attribute import_vnx_array_id import_vnx_consistency_group.id import_vnx_consistency_group.import_vnx_array_id import_vnx_consistency_group.importable_criteria import_vnx_consistency_group.importable_criteria_l10n import_vnx_consistency_group.name import_vnx_consistency_group_id importable_criteria - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 134
in JSON format. import_xtremio Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. An instance of an XtremIO storage system Was added in version 1.0.2. This resource type has queriable associations from import_xtremio_volume - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 135
string Serial number of the XtremIO storage system. cluster_guid Type: string Cluster GUID of the XtremIO storage system. platform[Added in 1.0.2] Type: enumerated value "Not_Supported") value ("Agentless", "Non_Disruptive_And_Agentless", Supported import types for the source storage system. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 136
Not_Supported The source array does not support import. Was added in version 1.0.2. state[Added in 1.0.2] Type: enumerated value ("Active", " is in attempting to start sate. Unknown XtremIO state is unknown to PowerStore. Was added in version 1.0.2. severity[Added in 1.0.2] Type: enumerated - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 137
is Major. Critical - The highest severity for this entity and all contained/members is Critical. * Unknown The severity is unknown to PowerStore Was added in version 1.0.2. user_name Type: string User account name used to communicate with the XtremIO storage system. last_updated_timestamp Type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 138
import_xtremio_volume for more details import_xtremio_consistency_groups[Added in 1.0.2] This is the inverse of the resource type import_xtremio_consistency_group association. See import_xtremio_consistency_group for more details show Property capabilities Attribute cluster_guid Select X Sort X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 139
Attribute import_xtremio_volumes.is_replication_destination import_xtremio_volumes.name import_xtremio_volumes.severity import_xtremio_volumes.severity_l10n import_xtremio_volumes.size import_xtremio_volumes.wwn last_updated_timestamp management_address name platform platform_l10n serial_number - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 140
Format import_xtremio [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 141
XtremIO volumes and consistency groups that can be imported to PowerStore. An instance of XtremIO consistency group. Was added in name Type: string Name of the consistency group. This property supports case-insensitive filtering. import_xtremio_id Type: string Unique identifier of the XtremIO - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 142
importable_criteria_l10n[Added in 1.0.2] Type: string Localized message string corresponding to importable_criteria Was added in version 1.0.2. import_xtremio_volumes[Added in 1.0.2] This is the inverse of the resource type import_xtremio_volume association. See import_xtremio_volume for more - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 143
Attribute import_xtremio.supported_import_type Select X Sort import_xtremio.supported_import_type_l10n X import_xtremio.user_name X import_xtremio.xms_version X import_xtremio_id X X import_xtremio_volumes.certainty X import_xtremio_volumes.certainty_l10n X import_xtremio_volumes.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 144
Attribute importable_criteria_l10n name Select X Sort X X X Search X X Format import_xtremio_consistency_group [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 145
types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. An instance of an XtremIO volume Was added in version 1.0.2. This resource type of the XtremIO volume. name Type: string Name of the XtremIO volume. This property supports case-insensitive filtering. 144 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 146
- The highest severity for this entity and all contained/members is Critical. * Unknown The severity is unknown to PowerStore Was added in version 1.0.2. certainty[Added in 1.0.2] Type: enumerated value ("Add_Pending", "Modify_Pending", "Ok", "Remove_Pending", "Unknown") Indicates confidence that - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 147
Unknown The certainty is unknown to PowerStore. Was added in version 1.0.2. is_read_only Type: boolean Indicates whether the XtremIO volume is a read only volume. is_replication_destination Type: boolean Indicates whether the XtremIO volume is a - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 148
severity_l10n[Added in 1.0.2] Type: string Localized message string corresponding to severity Was added in version 1.0.2. certainty_l10n[Added in 1.0.2] Type: string Localized message string corresponding to certainty Was added in version 1.0.2. importable_criteria_l10n[Added in 1.0.2] Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 149
Attribute import_xtremio.platform_l10n import_xtremio.serial_number import_xtremio.severity import_xtremio.severity_l10n import_xtremio.software_version import_xtremio.state import_xtremio.state_l10n import_xtremio.supported_import_type import_xtremio.supported_import_type_l10n import_xtremio. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 150
Attribute is_read_only is_replication_destination name severity severity_l10n size wwn Select X Sort X X X X X X X X X X X X X Search X X X X X X X Format import_xtremio_volume [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 151
-query Query records that fulfill the specified condition. -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. import_snapshot_schedules[Added in 1.0.2] Return the snapshot - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 152
not be a roll back for any sync operation. Migration_Paused At least one migration session for this recommendation is paused. Paused migration sessions can be resumed manually. 151 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 153
Type: object Set evacuate_appliance parameters to evacuate space Filtering on the fields of this embedded resource is not supported. See request_parameters for more details sessions_created_timestamp Type: date time Time at which migration sessions were created for the recommendation - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 154
Filtering on the fields of this embedded resource is not supported. See migration_actions for more details state_l10n Type: string Localized message string corresponding to state. type_l10n Type: string Localized message string corresponding to type. Attributes of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 155
action_state State of a recommended migration action. Recommendation_Created This action has been recommended, but no other action has been taken. Migration_Session_Created A migration session was successfully created for this recommended action. Migration_Session_Create_Failed A migration - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 156
volume Standalone attached/unattached volume family. virtual_volume Standalone attached/unattached virtual volume family. host Logical group of all volume families attached to a host. virtual_machine Logical group of all virtual volume families attached to a virtual machine. volume_group - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 157
migration_reason_l10n Localized message string corresponding to migration_reason Attributes of evacuate_appliance appliance_id ID of appliance on which available space is desired. space_to_free Optional desired amount of used storage (in bytes) to move to other appliances. If space_to_free is not - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 158
resource_type Resource type resource_ids List of resource ids to be evacuated 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 159
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 160
-evacuate_appliance Evacuate appliance by specifying optional space_to_free -appliance_id ID of appliance on which available space is desired. -space_to_free 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 161
cluster. -async Perform asynchronous operation. delete Delete a migration recommendation. Format migration_recommendation -id delete [ -async ] Action qualifiers -id Unique ID of the migration recommendation. -async Perform asynchronous operation. set[Added in 2.0.0.0] Modify migration - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 162
-async Perform asynchronous operation. create_migration_sessions Create the migration sessions to implement a migration recommendation. If the response contains a list of hosts to rescan, those hosts must be rescanned before starting the sessions or the host(s) may lose access to the data when the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 163
name Type: string User-specified friendly name of the migration session instance. This property supports caseinsensitive filtering. resource_type Type: enumerated value ("virtual_volume", "volume", "volume_group") Storage resource types eligible for migration. source_appliance_id Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 164
Cutting_Over Final phase of the migration, when ownership of the volume, vVol, or application group is transferred to the new appliance. Deleting Migration session is being deleted. Completed Migration session is complete and it is safe to delete the session. Pausing Migration session - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 165
resource_type_l10n Type: string Localized message string corresponding to resource_type. state_l10n Type: string Localized message string corresponding to state. virtual_volumes This is the inverse of the resource type virtual_volume association. See virtual_volume for more details volumes This is - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 166
Attribute progress_percentage replication_sessions.estimated_completion_timestamp replication_sessions.failover_test_in_progress replication_sessions.id replication_sessions.last_sync_duration replication_sessions.last_sync_timestamp replication_sessions.local_resource_id replication_sessions. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 167
Attribute source_appliance_id 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 168
Attribute virtual_volumes.type 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 500T | EMC PowerStore CLI Reference Guide - Page 169
Attribute volumes.creation_timestamp volumes.description volumes.id volumes.is_replication_destination volumes.location_history volumes.migration_session_id volumes.name volumes.nguid volumes.node_affinity volumes.node_affinity_l10n volumes.nsid volumes.performance_policy_id volumes.protection_data - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 170
- Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 171
or cutover operation is invoked. There are no interruptions to any services during this phase. Format migration_session create -resource_type { volume | . -automatic_cutover Indicates whether the migration session cutover is manual or automatic. Default for virtual_volume resource type migrations is - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 172
-name Unique name of the existing object (migration_session). -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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 173
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. 172 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 174
Monitoring View event logs and alerts alert Use these resource types to manage events and alerts in the system. An alert is a summation of one or more events that need (or needed) attention. Some events require attention and result in an alert being generated. Other events can update or clear an - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 175
which generated this alert. resource_name Type: string Name of the resource instance which generated this alert. This property supports caseinsensitive filtering. description_l10n Type: string Latest event's description text for this alert. generated_timestamp Type: date time Timestamp of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 176
called_home_timestamp Type: date time Timestamp when the event resulted in a notification to support (via Secured Remote Services), if any. email_sent_timestamp Type: date time Timestamp when the email was sent for the raised alert, if any. snmp_sent_timestamp[Added in 2.0.0.0] Type: date time - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 177
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 500T | EMC PowerStore CLI Reference Guide - Page 178
Attribute email_sent_timestamp event_code events generated_timestamp id is_acknowledged raised_timestamp resource_id resource_name resource_type resource_type_l10n severity severity_l10n snmp_sent_timestamp state state_l10n Select X Sort X X X X X X X X X X X X X X X X X X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 179
-sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 180
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. Attributes id Type: string Unique identifier of this occurrence of an event. event_code Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 181
resource instance which generated this event. This property supports caseinsensitive filtering. generated_timestamp Type: date time Timestamp at event. repair_flow_l10n Type: string Suggestions for how to resolve any problems that may arise from this event. severity_l10n Type: string Localized - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 182
Localized message string corresponding to resource_type. show Property capabilities Attribute description_l10n event_code 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 183
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 184
identifier of the resource on which the job is operating. resource_name Type: string Name of the resource on which the job is operating. This property supports case-insensitive filtering. description_l10n Type: string 183 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 185
Description of the job. state[Deprecated in 1.0.2] Type: enumerated value ("COMPLETED", "FAILED", "FAILING", "IN_PROGRESS", "PENDING", "QUEUED", "SKIPPED", "UNRECOVERABLE_FAILED") Was deprecated in version 1.0.2. start_time Type: date time Date and time when the job execution started. phase[Added in - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 186
object Base response object Filtering on the fields of this embedded resource is not supported. May be one of the following types: ◦ job_appliance_create_error_response[Added in 2.0.0.0] ◦ job_appliance_forecast_response ◦ job_appliance_time_to_full_response ◦ job_appliance_validate_create_response - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 187
response_status[Added in 2.0.0.0] Type: enumerated value ("200", "201", "202", "204", "206", "207", "400", "401", "403", "404", "405", "406", "415", "416", "422", "500", "503") Was added in version 2.0.0.0. step_order Type: 32-bit signed integer (0 to 2147483647) Order of a given job step with - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 188
messages See messages for more details issues See issues[Added in 2.0.0.0] for more details Attributes of job_appliance_forecast_response timestamp Date-time of the forecast data. low_value Estimate for the lower bound forecasted value on that particular time. mean_value Estimate for the mean - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 189
Major Time to full value is less than or equal to 14 days. Major alert indicated. None There is insufficient forecast data to project time to full to at least 28 days. No alert indicated, but available data cannot guarantee OK status. time_to_full_status_l10n Localized message string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 190
time_to_full_pessimistic Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval. time_to_full_optimistic Optimistic date-time for time to full based on the lower bound of the forecast 95% confidence interval. time_to_full_status Type of alert - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 191
Attributes of job_file_system_snapshot_response id The unique identifier of the created snapshot. Attributes of job_job_response id The id of the job created by the request. Attributes of job_keystore_archive_regenerate_response download_uri A Uniform Resource Identifier which can be used in a - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 192
Attributes of job_volume_group_refresh_response backup_snapshot_id Unique identifier of the backup snapshot set. This parameter will not be available if the create_backup_snap flag was set to false. Attributes of job_volume_group_restore_response backup_snapshot_id Unique identifier of the backup - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 193
LDAP_HTTP and Type of CA, scope value is LDAP Domain Name. is_current Indicates whether this is the current X509 certificate to be used by the service or this X509 certificate will be used in the future. When is_current is false for a X509 Certificate, this X509 Certificate will not be picked up - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 194
Localized message string corresponding to type Was added in version 2.0.0.0. service_l10n[Added in 2.0.0.0] Localized message string corresponding to service Was added in version 2.0.0.0. Attributes of messages code Hexadecimal error code of the message. severity Message severity. message_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 195
Attributes of messages code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of issues[Added in 2.0.0.0] reason Error - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 196
Attributes of members subject Certificate subject or so called distinguished name. serial_number Certificate serial number. signature_algorithm Certificate signature algorithm. issuer Distinguished name of the certificate issuer. valid_from Date and time when the certificate becomes valid. valid_to - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 197
Attributes of reason code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of resolution code Hexadecimal error code of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 198
message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. Attributes of reason code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 199
code Hexadecimal error code of the message. severity Message severity. message_l10n The message description in the specified locale with arguments substituted. arguments Arguments (if applicable) for the error message. show Property capabilities Attribute children.description_l10n children.end_time - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 200
Attribute children.response_body children.response_status children.response_status_l10n children.root_id children.start_time children.state children.state_l10n children.step_order children.user description_l10n end_time estimated_completion_time id leafs.description_l10n leafs.end_time leafs. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 201
Attribute leafs.resource_action leafs.resource_action_l10n leafs.resource_id leafs.resource_name leafs.resource_type leafs.resource_type_l10n leafs.response_body leafs.response_status leafs.response_status_l10n leafs.root_id leafs.start_time leafs.state leafs.state_l10n leafs.step_order leafs.user - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 202
Attribute parent.phase_l10n 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.response_status parent.response_status_l10n parent.root_id parent.start_time - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 203
Attribute resource_action resource_action_l10n resource_id resource_name resource_type resource_type_l10n response_body response_status response_status_l10n root.description_l10n root.end_time root.estimated_completion_time root.id root.parent_id root.phase root.phase_l10n root.progress_percentage - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 204
Attribute root.resource_type root.resource_type_l10n root.response_body root.response_status root.response_status_l10n root.root_id root.start_time root.state root.state_l10n root.step_order root.user root_id start_time state state_l10n step_order user Select X Sort X X X X X X X X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 205
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 206
] | 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. performance_metrics_by_volume Volume performance metrics - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 207
space_metrics_by_cluster Cluster space metrics space_metrics_by_appliance Appliance space metrics space_metrics_by_volume Volume space metrics space_metrics_by_volume_family Volume family space metrics space_metrics_by_vm Virtual Machine space metrics space_metrics_by_storage_container - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 208
performance_metrics_smb2_builtinclie nt_by_node Performance metrics for the SMB2 protocol built-in client performance_metrics_nfs_by_node Performance metrics for the NFS protocol performance_metrics_nfsv3_by_node Performance metrics for the NFSv3 protocol performance_metrics_nfsv4_by_node - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 209
Attributes id Type: string Unique remote syslog server identifier. remote_server_address Type: string IPv4 or IPv6 address, or DNS name of the log server. port Type: 32-bit signed integer (0 to 65535) Port used for connection to the remote server. protocol_type[Added in 2.0.0.0] Type: enumerated - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 210
If true, then this instance will receive audit messages. status[Added in 2.0.0.0] Type: enumerated value ("Connected", "Not_Connected") The status of the remote syslog server. Connected The system can be connected to. Not_Connected The system cannot be connected to. Was added in version - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 211
Attribute is_enabled port protocol_type protocol_type_l10n remote_server_address status status_l10n Select X Sort X X X X X X X X X X X X X Search X X X X X X X Format remote_syslog_server [ -id[Added in 2.0.0.0] ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 212
-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[Added in 2.0.0.0] Create a remote_syslog_server object. Was added in version 2.0.0.0. Format remote_syslog_server - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 213
None Do not enforce security when transmitting audit logs. Was added in version 2.0.0.0. -is_enabled If true, then this instance will receive audit messages. -async Perform asynchronous operation. delete[Added in 2.0.0.0] Delete a remote_syslog_server object. Was added in version 2.0.0.0. Format - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 214
TCP Use the Transmission Control Protocol. UDP Use the User Datagram Protocol. Was added in version 2.0.0.0. -encryption Available encryption types. TLS Create a private connection via Transport Layer Security. None Do not enforce security when transmitting audit logs. Was added in version - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 215
virtual_machine, volume, volume_group, file_system Attributes id Type: string Unique identifier of the policy. name Type: string Policy name. This property supports case-insensitive filtering. description Type: string Policy description. type Type: enumerated value ("Performance", "Protection - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 216
more details volumes This is the inverse of the resource type volume association. See volume for more details volume_groups This is the inverse of the resource type volume_group association. See volume_group for more details file_systems This is the inverse of the resource type file_system - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 217
Attribute file_systems.default_hard_limit file_systems.default_soft_limit file_systems.description file_systems.expiration_timestamp file_systems.filesystem_type file_systems.filesystem_type_l10n file_systems.folder_rename_policy file_systems.folder_rename_policy_l10n file_systems.grace_period - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 218
Attribute file_systems.locking_policy_l10n file_systems.name file_systems.nas_server_id file_systems.parent_id file_systems.protection_policy_id file_systems.size_total file_systems.size_used file_systems.smb_notify_on_change_dir_depth id is_replica name performance_rules.id performance_rules. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 219
Attribute replication_rules.rpo_l10n snapshot_rules.days_of_week snapshot_rules.days_of_week_l10n snapshot_rules.desired_retention snapshot_rules.id snapshot_rules.interval snapshot_rules.interval_l10n snapshot_rules.is_replica snapshot_rules.name snapshot_rules.time_of_day snapshot_rules.timezone - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 220
Attribute virtual_machines.memory_mb virtual_machines.name virtual_machines.protection_data virtual_machines.protection_policy_id virtual_machines.status virtual_machines.status_l10n virtual_machines.type virtual_machines.type_l10n virtual_machines.vcenter_id virtual_machines.vcenter_instance_uuid - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 221
Attribute volume_groups.protection_data volume_groups.protection_policy_id volume_groups.type volume_groups.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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 222
Attribute volumes.state_l10n volumes.type volumes.type_l10n volumes.wwn Select X Sort X X X Search Format policy [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 223
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. When a protection policy is assigned to a volume or - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 224
Format policy -id delete [ -async ] Action qualifiers -id Unique identifier of the protection policy to be deleted. -async Perform asynchronous operation. set Modify a protection policy. Format policy { -id | -name } set [ -name ] [ -description ] [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 225
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 500T | EMC PowerStore CLI Reference Guide - Page 226
in version 2.0.0.0. management_address Type: string Management IP address of the remote system instance. type Type: enumerated value ("PS_Equallogic", "PowerStore", "Storage_Center", "Unity", "VNX", "XtremIO") Type of the remote system. user_name Type: string Username used to access the non - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 227
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 for more details type_l10n Type: string Localized message string corresponding to type. state_l10n Type: string Localized message string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 228
replication_session for more details Attributes of data_connections node_id Unique identifier of the local, initiating node. initiator_address Initiating address from the local node. target_address Target address from the remote system. status Status of the data connection. status_l10n Localized - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 229
Attribute import_sessions.current_transfer_rate import_sessions.description import_sessions.destination_resource_id import_sessions.destination_resource_type import_sessions.destination_resource_type_l10n import_sessions.error import_sessions.estimated_completion_timestamp import_sessions.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 230
Attribute iscsi_addresses management_address name replication_sessions.estimated_completion_timestamp replication_sessions.failover_test_in_progress replication_sessions.id replication_sessions.last_sync_duration replication_sessions.last_sync_timestamp replication_sessions.local_resource_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 231
Attribute serial_number session_chap_mode session_chap_mode_l10n state state_l10n type type_l10n user_name version Select X Sort X X X X X X X X X X X X X X X X X Search X X X X X X X X X Format remote_system [ { -id | -name } ] show [ -select ,... ] [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 232
, 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 500T | EMC PowerStore CLI Reference Guide - Page 233
| 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 500T | EMC PowerStore CLI Reference Guide - Page 234
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 500T | EMC PowerStore CLI Reference Guide - Page 235
is 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 236
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 500T | EMC PowerStore CLI Reference Guide - Page 237
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 500T | EMC PowerStore CLI Reference Guide - Page 238
: string Unique identifier of the replication rule. name Type: string Name of the replication rule. This property supports case-insensitive filtering. rpo Type: enumerated value ("Fifteen_Minutes", "Five_Minutes", "One_Day", "One_Hour", "Six_Hours", "Thirty_Minutes", "Twelve_Hours") Recovery point - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 239
show Property capabilities Attribute alert_threshold id is_replica name policies.description policies.id policies.is_replica policies.name policies.type policies.type_l10n remote_system_id replication_sessions.estimated_completion_timestamp replication_sessions.failover_test_in_progress - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 240
Attribute replication_sessions.remote_system_id replication_sessions.replication_rule_id replication_sessions.resource_type replication_sessions.resource_type_l10n replication_sessions.role replication_sessions.role_l10n replication_sessions.state replication_sessions.state_l10n replication_sessions - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 241
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 242
-alert_threshold Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold. Alert threshold has the default value of one RPO in minutes. -async Perform asynchronous - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 243
Format replication_rule { -id | -name } set [ -name ] [ -rpo { Five_Minutes | Fifteen_Minutes | Thirty_Minutes | One_Hour | Six_Hours | Twelve_Hours | One_Day } ] [ -remote_system_id ] [ -alert_threshold ] [ -async ] Action qualifiers -id Unique identifier - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 244
Destination storage resources are in replication destination mode, which disables any write access to the destination resource. Any operations such as resizing the volume, restoring the snapshot, or changing membership for a volume group on the resource are not allowed. On the source end, volumes - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 245
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 failover_test_in_progress[Added in 2.0.0.0] Type: boolean 244 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 246
Indicates whether a test failover is in progress at the destination site of this session. Was added in version 2.0.0.0. state_l10n Type: string Localized message string corresponding to state. role_l10n Type: string Localized message string corresponding to role. resource_type_l10n Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 247
Attribute estimated_completion_timestamp failover_test_in_progress id last_sync_duration last_sync_timestamp local_resource_id migration_session.created_timestamp migration_session.current_transfer_rate migration_session.destination_appliance_id migration_session.estimated_completion_timestamp - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 248
Attribute progress_percentage remote_resource_id remote_system.data_connection_state remote_system.data_connection_state_l10n remote_system.data_connections remote_system.data_network_latency remote_system.data_network_latency_l10n remote_system.description remote_system.discovery_chap_mode - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 249
Attribute remote_system.user_name remote_system.version remote_system_id replication_rule.alert_threshold replication_rule.id replication_rule.is_replica replication_rule.name replication_rule.remote_system_id replication_rule.rpo replication_rule.rpo_l10n replication_rule_id resource_type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 250
-id Unique identifier of the replication session. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 251
failover, stop I/O operations for any applications and hosts. If a synchronization error occurs during a planned failover, the replication session enters the System_Paused state. You cannot pause a replication session during a planned failover. The following operations can be performed during - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 252
failover. If a failover_snapshot_id is not specified, the destination will be restored to the last common base snapshot. This identifier is not supported when a failover test is in progress. Was added in version 2.0.0.0. -force Indicates whether an unplanned failover needs to be performed for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 253
paused: Pause Use to place both sites into the Paused state Failover Use to get production access from the disaster recovery site • Delete the replication session by removing the protection policy on the storage resource The following system operations may also pause, and subsequently resume, a - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 254
synchronization cycle if the session was in the following states when the session was paused: • Synchronizing • System_Paused When only the replication session on the local system is paused, resuming the session pauses both sites. You cannot resume replication sessions paused by the system. The - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 255
• DR_Failover_In_Progress • Failed_Over • Paused_For_NDU • Paused_For_Migration During the test, the following restrictions apply: • Membership changes are not allowed for destination resources that belong to a volume group. • The session cannot be failed over (planned or unplanned). Was added in - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 256
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 500T | EMC PowerStore CLI Reference Guide - Page 257
id Type: string Unique identifier of the snapshot rule. name Type: string Snapshot rule name. This property supports case-insensitive filtering. interval Type: enumerated value ("Eight_Hours", "Fifteen_Minutes", "Five_Minutes", "Four_Hours", "One_Day", "One_Hour", "Six_Hours", "Thirty_Minutes - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 258
"AsiaRangoon", "AsiaSeoul", "AsiaSingapore", "AsiaTehran", "AtlanticCape_Verde", "AtlanticReykjavik", "AustraliaAdelaide", "AustraliaBrisbane", "AustraliaDarwin", "AustraliaEucla", "AustraliaLord_Howe", "AustraliaSydney", "BrazilEast", "CST6CDT", "CanadaAtlantic", "CanadaNewfoundland", " - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 259
days_of_week_l10n Type: array of strings Localized message array corresponding to days_of_week. policies List of the policies that are associated with this snapshot_rule. See policy for more details show Property capabilities Attribute days_of_week days_of_week_l10n desired_retention id interval - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 260
Attribute timezone_l10n Select X Sort X Search X Format snapshot_rule [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 261
table Display output in a table. json Display output in JSON format. create Create a new snapshot rule. Format snapshot_rule create -name -desired_retention [ -interval { Five_Minutes | Fifteen_Minutes | Thirty_Minutes | One_Hour | Two_Hours | Three_Hours | Four_Hours | Six_Hours | - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 262
-timezone[Added in 2.0.0.0] Was added in version 2.0.0.0. -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 < - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 263
EtcGMT_plus_5 | AmericaCaracas | AmericaCuiaba | AmericaSanto_Domingo | CanadaAtlantic | AmericaAsuncion | EtcGMT_plus_4 | CanadaNewfoundland | ChileContinental | BrazilEast | AmericaGodthab | AmericaMiquelon | AmericaBuenos_Aires | EtcGMT_plus_3 | AmericaNoronha | EtcGMT_plus_2 | - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 264
Settings Configure general settings on the system including: • Networking • Licensing • Updates audit_event Use this resource type to query audit log information. Attributes id Type: string Unique identifier of the audit log entry. type Type: enumerated value ("Authentication", "Authorization", " - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 265
is_successful Type: boolean Whether the event was successful or not. client_address Type: string FQDN/IP Address of the client from where the event was initiated. server_address Type: string IP Address on which the request was targeted. appliance_id Type: string Unique identifier of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 266
Resource Type for the given resource. resource_action Type: enumerated value ("add_members", "attach", "bind", "cancel", "cleanup", "clone", "create", "create_migration_sessions", "cutover", "decommission", "delete", "detach", "discover", "download", "exchange", "failover", "forecast", "generate", " - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 267
show Property capabilities Attribute appliance_id client_address id is_successful job_id message_arguments message_code message_l10n resource_action resource_action_l10n resource_type resource_type_l10n server_address timestamp type type_l10n username Select X Sort X X X X X X X X X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 268
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 269
id Unique id of the CHAP config settings instance (always "0"). mode Available CHAP modes that describe or set the iSCSI CHAP mode for the entire cluster. Disabled CHAP is not used in the cluster Single CHAP is being used to authenticate the initiator Mutual CHAP is used to authenticate both the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 270
table Display output in a table. json Display output in JSON format. set Modify the CHAP configuration settings object. To enable either Single or Mutual CHAP modes, the username and password must already be set, or included in the same request as the new mode. Format chap_config -id set - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 271
show Property capabilities Attribute addresses id Select X Sort X X X Search X X Format dns [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 272
csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify a DNS setting. Format dns -id set -addresses ,... [ -async ] Action qualifiers -id Unique identifier of the DNS setting. -addresses DNS server addresses in IPv4 or - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 273
Whether to send notifications for major alerts. notify_minor Type: boolean Whether to send notifications for minor alerts. notify_info Type: boolean Whether to send notifications for informational alerts. show Property capabilities Attribute email_address id notify_critical notify_info notify_major - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 274
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 275
-notify_info Whether send notifications for informational alerts. -async Perform asynchronous operation. delete Delete an email notification destination. Format email_notify_destination -id delete [ -async ] Action qualifiers -id Unique identifier of the email notification destination. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 276
[Added in 2.0.0.0] Type: string Name of the IP address. This property supports case-insensitive filtering. Was added in version 2.0.0.0. network_id Type: string Unique IP address to provide access to storage network services, such as iSCSI. This attribute can be set only for an IP address used - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 277
type Storage. appliance_id Type: string Unique identifier of the appliance to which the IP address belongs. node_id Type: string Unique identifier of the cluster node to which the IP address belongs. address Type: string IP address value, in IPv4 or IPv6 format. purposes Type: array of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 278
Attribute address appliance.drive_failure_tolerance_level appliance.drive_failure_tolerance_level_l10n appliance.express_service_code appliance.id 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 279
Attribute name network.gateway network.id network.ip_version network.ip_version_l10n network.mtu network.name network.prefix_length network.purposes network.purposes_l10n network.type network.type_l10n network.vlan_id network_id node.appliance_id node.id node.slot node_id purposes purposes_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 280
field offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of a configured IP address. -name Unique name of the existing object (ip_pool_address). -select Display selected - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 281
virtual Ethernet ports. This resource type has queriable associations from ip_pool_address, ip_port, bond, eth_port, veth_port Attributes id Type: string Unique identifier of the IP port. partner_id Type: string Identifier of the IP port that is configured on top of physical Ethernet port or virtual - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 282
on top of a bond on a Unified appliance. veth_port_id Type: string Unique identifier of the virtual Ethernet front-end port on top of which the IP port is configured. This attribute can be set when the IP port is used by a Unified+ appliance. For a Unified appliance, the value of veth_port_id should - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 283
Attribute bond.id bond.is_link_up bond.mode bond.mode_l10n bond.mtu bond.name bond.partner_id bond.type bond.type_l10n 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.hardware_parent_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 284
Attribute eth_port.hypervisor_vswitch_name eth_port.id 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 285
Attribute ip_pool_addresses.address ip_pool_addresses.appliance_id ip_pool_addresses.id ip_pool_addresses.ip_port_id ip_pool_addresses.name ip_pool_addresses.network_id ip_pool_addresses.node_id ip_pool_addresses.purposes ip_pool_addresses.purposes_l10n partner.available_usages partner. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 286
Attribute veth_port.appliance_id veth_port.current_mtu veth_port.current_speed veth_port.id veth_port.is_link_up veth_port.mac_address veth_port.name veth_port.node_id veth_port.partner_id veth_port.vswitch_name veth_port.vswitch_port_group_name veth_port.vswitch_port_id veth_port.vswitch_port_name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 287
field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 288
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 500T | EMC PowerStore CLI Reference Guide - Page 289
. ldap_account Use this resource type to manage LDAP accounts that map to LDAP users or groups in LDAP server to administrative roles on the PowerStore array. Information about an LDAP account. Was added in version 1.0.3. Attributes id Unique identifier of the LDAP account. name Name of the LDAP - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 290
show Property capabilities Attribute dn domain_id id name role_id type type_l10n Select X Sort X X X X X X Search Format ldap_account [ -id ] show [ -select ,... ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 291
Format ldap_account create -domain_id -name -role_id [ -type { User | Group } ] [ -async ] Action qualifiers -domain_id Unique identifier of the LDAP domain to which LDAP user or group belongs. -name Name of the new LDAP account to be created. The name value can be 1 to 64 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 292
[Added in 1.0.3] Types of LDAP server:\n AD Active directory\n OpenLDAP Open source implementation of LDAP Was added in version 1.0.3. protocol[Added in 1.0.3] Types of directory service protocol:\n 291 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 293
LDAP Lightweight directory access protocol\n LDAPS Secure lightweight directory access protocol Was added in version 1.0.3. bind_user Distinguished Name (DN) of the user to be used when binding; that is, authenticating and setting up the connection to the LDAP Server. ldap_timeout Timeout for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 294
ldap_server_type_l10n[Added in 1.0.3] Localized message string corresponding to ldap_server_type Was added in version 1.0.3. protocol_l10n[Added in 1.0.3] Localized message string corresponding to protocol Was added in version 1.0.3. show Property capabilities Attribute bind_user domain_name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 295
Attribute user_object_class user_search_path Select X Sort X Search Format ldap_domain [ -id ] show [ -select ,... ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the LDAP domain. -select Display selected - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 296
. Default values are LDAP(389), LDAPs(636), GlobalCatalog LDAP(3268), Global Catalog LDAPs(3269). -protocol Types of directory service protocol:\n LDAP Lightweight directory access protocol\n LDAPS Secure lightweight directory access protocol Was added in version 1.0.3. -ldap_server_type Types of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 297
reply from the LDAP server after the specified timeout, it stops sending requests. Default value is 30000 (30 seconds). -is_global_catalog Whether or not the catalog is global. Default value is false. -user_id_attribute Name of the LDAP attribute whose value indicates the unique identifier of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 298
:\n AD Active directory\n OpenLDAP Open source implementation of LDAP Was added in version 1.0.3. -protocol Types of directory service protocol:\n LDAP Lightweight directory access protocol\n LDAPS Secure lightweight directory access protocol Was added in version 1.0.3. -bind_user Distinguished - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 299
-bind_password Password to use when binding a new LDAP session. -bind_passwordSecure Secure version of -bind_password. Value will be queried interactively. -ldap_timeout Timeout for establishing a connection to an LDAP server. If the system does not receive a reply from the LDAP server after the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 300
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 500T | EMC PowerStore CLI Reference Guide - Page 301
Whether or not the cluster currently has a valid license. trial_expiration_timestamp Type: date time If not currently licensed, the date the trial period expires. If the trial period expires, new provisioning operations will not be allowed. activation_file_content Type: string The content of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 302
. This runs automatically 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 303
-license_file The file to upload containing the software license to install the license on the cluster. -async Perform asynchronous operation. local_user Use this resource type to manage local user accounts. Information about a local user. Attributes id Unique identifier of the local user account. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 304
Attribute role_id Select X Sort Search Format local_user [ -id ] show [ -select ,... ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the local user account. -select Display selected attributes in the output. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 305
character, one numeric character, and one special character from this list -passwordSecure Secure version of -password. Value will be queried interactively. -role_id The unique identifier of the role to which the new local user will be mapped. Where role_id "1" is for Administrator, "2" is for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 306
VM Administrator and "5" is for Security Administrator. A local user with either an administration or a security administration role can change the role of any other local user. You cannot change the role of the account you are currently logged-in to. -is_locked Lock or unlock the local user account - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 307
is_built_in_user Indicates whether the logged-in user is predefined. show Property capabilities Attribute id idle_timeout is_built_in_user is_password_change_required role_ids user Select X Sort X X X X X Search Format login_session show [ -select ,... ] [ -output { nvp | csv [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 308
[Added in 2.0.0.0] Type: array of enumerated values ("ISCSI") Purposes of the network. This returns a list of purposes for the networks that support multiple purposes per network, like storage network. Empty list is returned for single purposed networks, like management, vMotion, ICD and ICM. Was - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 309
prefix_length Type: 32-bit signed integer (1 to 127) Network prefix length, used for both IPv4 and IPv6. gateway Type: string Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version. mtu Type: 32-bit signed integer (1280 to 9000) Maximum Transmission Unit (MTU) packet size - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 310
Attribute ip_pool_addresses.ip_port_id ip_pool_addresses.name ip_pool_addresses.network_id ip_pool_addresses.node_id ip_pool_addresses.purposes ip_pool_addresses.purposes_l10n ip_version ip_version_l10n mtu name prefix_length purposes purposes_l10n type type_l10n vlan_id Select X Sort X X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 311
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 312
Name of the network. -ip_version IP protocol version. -purposes Purposes of the network. This returns a list of purposes for the networks that support multiple purposes per network, like storage network. Returns an empty list for the single purposed networks, like management, vMotion, ICD and ICM - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 313
delete[Added in 2.0.0.0] Delete network. Was added in version 2.0.0.0. Format network { -id | -name } delete [ -async ] Action qualifiers -id Unique identifier of the network. -name Unique name of the existing object (network). -async Perform asynchronous operation. set Modify IP - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 314
-prefix_length Network prefix length. (Used for both IPv4 and IPv6). -cluster_mgmt_address ◦ New cluster management IP address in IPv4 or IPv6 format, corresponding to the network's IP version. ◦ This can only be specified when reconfiguring the management network. Caution Changing the cluster - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 315
-remove_addresses IP addresses to remove in IPv4 or IPv6 format. -force Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints. Normally the command will fail with an error when: - Some of system network - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 316
-gateway Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version. Specify empty string to remove the gateway. -prefix_length Network prefix length. (Used for both IPv4 and IPv6). -cluster_mgmt_address New cluster management IP address in IPv4 or IPv6 format, corresponding - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 317
PowerStoreX cluster. -address IP address of the SMTP server. -port Port used for sending SMTP messages. -source_email Source email address used for sending SMTP messages. -name Name of a physical switch. -purpose Physical switch purpose in network. Possible purposes are: Data_and_Management Physical - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 318
-snmp_community_stringSecure Secure version of -snmp_community_string. Value will be queried interactively. -force Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints. Normally the command will fail with - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 319
Normally the command will fail with an error when: ◦ system network ports on top of which IP ports are configured are in degraded state or have cabling issues, ◦ or network IP addresses applied as a result of network scaling have duplicates in the network environment. When force is true, the command - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 320
-id Unique identifier of the NTP setting. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 321
id Type: string Unique identifier of the physical switch setting. name Type: string Name of physical switch. This property supports case-insensitive filtering. purpose Type: enumerated value ("Data_and_Management", "Management_Only") Physical switch purpose in network. Possible purposes are - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 322
Attribute connections.address connections.connect_method connections.connect_method_l10n connections.physical_switch_id connections.port connections.username id name purpose purpose_l10n Select X Sort X X X X X X X X X X X X X Search X X X X Format physical_switch [ { -id | - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 323
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 324
-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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 325
set Modify a physical switch settings. Format physical_switch { -id | -name } set [ -name ] [ -purpose { Data_and_Management | Management_Only } ] ( [ -connections -address -connect_method { SSH | SNMPv2c } [ -port ] [ -username ] [ { -ssh_password - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 326
-ssh_passwordSecure Secure version of -ssh_password. Value will be queried interactively. -snmp_community_string SNMPv2 community string, if SNMPv2c connect method is specified. -snmp_community_stringSecure Secure version of -snmp_community_string. Value will be queried interactively. -async Perform - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 327
Action qualifiers -id Unique identifier of the role. -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 output in a table. json Display output in JSON format. security_config - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 328
Attribute protocol_mode protocol_mode_l10n Select X Sort X Search Format security_config [ -id ] show [ -select ,... ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Unique identifier of the instance. -select Display selected - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 329
3. TLS 1.2: Only TLS 1.2 is enabled. Was added in version 2.0.0.0. -async Perform asynchronous operation. smtp_config Use these resource types to configure outgoing SMTP and email notifications. Attributes id Type: string Unique identifier of the SMTP configuration. This value is always '0'. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 330
Format smtp_config [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 331
Format smtp_config -id set [ -address ] [ -port ] [ -source_email ] [ -async ] Action qualifiers -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. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 332
(0 to 2147483647) Port number to use with the address of the SNMP server. version[Added in 2.0.0.0] Type: enumerated value ("V2c", "V3") Supported SNMP protocol versions: V2c SNMP version 2c, V3 SNMP version 3 Was added in version 2.0.0.0. alert_severity[Added in 2.0.0.0] Type: enumerated value - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 333
privacy_protocol[Added in 2.0.0.0] Type: enumerated value ("AES256", "None", "TDES") Relevant only for SNMPv3. Supported SNMP privacy protocol: None No encryption on the wire. AES256 Encryption class for AES 256. TDES Privacy protocol class for Triple DES (DESEDE). Was added - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 334
Attribute ip_address port privacy_protocol privacy_protocol_l10n trap_community user_name version version_l10n Select X Sort X X X X X X X X X X X X X X X Search X X X X X X X X Format snmp_server [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 335
FQDN of the SNMP server. -port Port number to use with the address of the SNMP server: 162, [1024-49151] -version Supported SNMP protocol versions: V2c SNMP version 2c, V3 SNMP version 3 Was added in version 2.0.0.0. -alert_severity Possible severities. Was added in version 2.0.0.0. -trap_community - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 336
. SHA256 The HMAC192SHA256AuthProtocol class implements the Secure Hash Authentication Was added in version 2.0.0.0. -privacy_protocol Relevant only for SNMPv3. Supported SNMP privacy protocol: None No encryption on the wire. AES256 Encryption class for AES 256. TDES Privacy protocol class - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 337
. SHA256 The HMAC192SHA256AuthProtocol class implements the Secure Hash Authentication Was added in version 2.0.0.0. -privacy_protocol Relevant only for SNMPv3. Supported SNMP privacy protocol: None No encryption on the wire. AES256 Encryption class for AES 256. TDES Privacy protocol class - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 338
Unique identifier of the installed software instance. is_cluster Type: boolean 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 appliance - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 339
Build version of the installed software package release. Was added in version 2.0.0.0. release_timestamp Type: date time Date and time when this software package was produced. installed_date Type: date time Date and time when the software was successfully installed and committed on the cluster. If - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 340
Attribute appliance.drive_failure_tolerance_level_l10n appliance.express_service_code appliance.id appliance.model appliance.name appliance.service_tag build_flavor build_flavor_l10n build_id build_type build_type_l10n build_version id installed_date is_cluster release_timestamp release_version - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 341
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 342
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. Pre_Upgrade_HCI - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 343
Installed The package has been successfully installed. Install_Failed Installing the package failed. Download_Failed Downloading the package failed. size Type: size (0 to 9223372036854775807 (8192.00P)) File size of the software package in bytes. is_reboot_required Type: boolean Whether a - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 344
Unique identifier of this build. Was added in version 2.0.0.0. software_package_type_l10n Type: string Localized message string corresponding to software_package_type. software_package_state_l10n Type: string Localized message string corresponding to software_package_state. build_flavor_l10n[Added - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 345
Attribute justification_l10n name release_timestamp release_version size software_package_state software_package_state_l10n software_package_type software_package_type_l10n Select X Sort X X X X X X X X X X X X X X X X X Search X X X X X X X X X Format software_package [ { -id < - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 346
-limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 347
-id Unique identifier of the software package to delete. -name Unique name of the existing object (software_package). -async Perform asynchronous operation. install Start a software upgrade background job for the specified appliance within the cluster. If an appliance is not specified, the upgrade - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 348
operation. x509_certificate Use this resource type 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 500T | EMC PowerStore CLI Reference Guide - Page 349
. 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 500T | EMC PowerStore CLI Reference Guide - Page 350
certificate should have the largest depth for the certificate chain. thumbprint_algorithm_l10n Localized message string corresponding to thumbprint_algorithm show Property capabilities Attribute id is_current is_valid members service service_l10n Select X Sort X X X X X Search 349 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 351
. Was added in version 2.0.0.0. Format x509_certificate create -type { Server | Client | CA_Client_Validation | CA_Server_Validation } -service { Management_HTTP | Replication_HTTP | VASA_HTTP | Import_HTTP | LDAP_HTTP | Syslog_HTTP } -certificate [ -scope ] [ -private_key - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 352
chain from end-entity certificate to the root certificate. -scope Scope defines a subset of certificates belonging to one Service. Scope has different meanings from different Services and types. For example, in Replication_HTTP, CA type certificates will use scope to indicate the origin of these - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 353
is false for a X509 Certificate, this X509 Certificate will not be picked up by the service. Potential usage of this attribute is to prepare for the certificate roll-over/rotation. -async both be false. Only Syslog_HTTP and VASA_HTTP are supported service types. Was added in version 2.0.0.0. 352 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 354
which the certificate is used: Management HTTP Management Web server Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP. -dns_name DNS names in the certificate extensions -ip_addresses - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 355
of CA, Scope value can be null(unused and optional); Certificate with Service LDAP_HTTP and Type of CA, Scope value is LDAP Domain Name. -common_name Part of distinguished name. e.g., www.dell.common. -organizational_unit Part of distinguished name. e.g., Security Department. -organization Part of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 356
VASA HTTP VASA provider service Import HTTP External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP. -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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 357
Replication HTTP Remote Replication service VASA HTTP VASA provider service Import HTTP External web service Values was added in Server instance that uses this DNS object. Only one DNS object per NAS Server is supported. domain Type: string Name of the DNS domain, where the NAS Server does host - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 358
ip_addresses Type: array of strings The list of DNS server IP addresses. The addresses may be IPv4 or IPv6. transport Type: enumerated value ("TCP", "UDP") Transport used when connecting to the DNS Server: UDP DNS uses the UDP protocol (default) TCP DNS uses the TCP protocol. transport_l10n Type: - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 359
Attribute 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.is_username_translation_enabled nas_server.name nas_server.operational_status nas_server. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 360
} ] [ -async ] 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. 359 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 361
-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 list of DNS server IP addresses. The addresses may be IPv4 or IPv6. -transport Transport used when connecting to the DNS Server: UDP DNS uses the UDP protocol ( - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 362
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 500T | EMC PowerStore CLI Reference Guide - Page 363
nas_server_id Type: string Unique identifier of the NAS server that is configured with the FTP server. is_ftp_enabled Type: boolean Indicates whether the FTP server is enabled on the NAS server. Values are: - true - FTP server is enabled on the specified NAS server. - false - FTP server is disabled - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 364
Allowed 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 363 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 365
SFTP. - If denied hosts exist, they always have access denied to the NAS server through FTP or SFTP. - If the list is empty, there is no restriction to NAS server access through FTP or SFTP based on the host IP address. - The addresses may be IPv4 or IPv6. users Type: array of strings Allowed or - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 366
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 500T | EMC PowerStore CLI Reference Guide - Page 367
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 500T | EMC PowerStore CLI Reference Guide - Page 368
-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. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 369
-message_of_the_day ] [ -is_audit_enabled { yes | true | no | false } ] [ -audit_dir ] [ -audit_max_size ] [ -hosts ,... ] [ -users ,... ] [ -groups ,... ] [ -is_allowed_hosts { yes | true | no | false } ] [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 370
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 500T | EMC PowerStore CLI Reference Guide - Page 371
-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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 372
-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 500T | EMC PowerStore CLI Reference Guide - Page 373
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 500T | EMC PowerStore CLI Reference Guide - Page 374
-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 members of those groups - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 375
name Type: string Name of the network interface. This property supports case-insensitive filtering. role Type: enumerated value ("Backup", "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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 376
file_interface_routes This is the inverse of the resource type file_interface_route association. See file_interface_route for more details show Property capabilities Attribute file_interface_routes.destination file_interface_routes.file_interface_id file_interface_routes.gateway - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 377
Attribute 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.is_username_translation_enabled nas_server.name nas_server.operational_status nas_server. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 378
-id Unique identifier of the file interface. -name Unique name of the existing object (file_interface). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 379
. 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 500T | EMC PowerStore CLI Reference Guide - Page 380
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 500T | EMC PowerStore CLI Reference Guide - Page 381
Note: IP routes connect an interface (IP address) to the larger network through gateways. Without routes and gateway specified, the interface is no longer accessible outside of its immediate subnet. As a result, network shares and exports associated with the interface are no longer available to - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 382
Invalid_IP_Version Source interfaces have a different IP protocol version than the route. Invalid_Source_Interface No source interfaces set up on the system. Invalid_Gateway Source interfaces in a different subnet than the gateway. Not_Operational The route is not operational. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 383
Attribute file_interface_id gateway id operational_status operational_status_l10n prefix_length Select X Sort X X X X X X X X X X X Search X X X X X X Format file_interface_route [ -id ] show [ -select ,... ] [ -sort [+|-],... ] [ -offset ] [ { -limit - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 384
-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 and configure a new file interface route. There are three types of routes - Subnet, Default, and Host. • A - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 385
-gateway IP address of the gateway associated with the route. -async Perform asynchronous operation. delete Delete file interface route. Format file_interface_route -id delete [ -async ] Action qualifiers -id Unique identifier of the file interface route object. -async Perform asynchronous - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 386
of the associated NAS Server instance that uses this Kerberos object. Only one Kerberos object per NAS Server is supported. realm Type: string Realm name of the Kerberos Service. kdc_addresses Type: array of strings Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 387
details show Property capabilities Attribute id kdc_addresses 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 388
offset ] [ { -limit | -all } ] [ -query ] [ -output { nvp | csv [ -table ] [ -noformat ] | table | json [ -raw ] } ] Action qualifiers -id Kerberos service object. -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 389
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 500T | EMC PowerStore CLI Reference Guide - Page 390
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 500T | EMC PowerStore CLI Reference Guide - Page 391
and authorization operations by helping to centralize user and group management across the network. A NAS Server can use LDAP as a Unix Directory Service to map users, retrieve netgroups, and build a Unix credential. When an initial LDAP configuration is applied, the system checks for the type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 392
LDAP object per NAS Server is supported. base_DN Type: string Name of the 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 393
LDAP LDAP protocol without SSL. LDAPS (Default) LDAP protocol with SSL. When you enable LDAPS, make sure to specify the appropriate LDAPS port (usually port 636) and to upload an LDAPS trust certificate to the LDAP server. is_verify_server_certificate Type: boolean Indicates whether a - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 394
Microsoft Microsoft Identity Management for UNIX (IDMU/SFU) schema. Unknown Unknown protocol. is_config_file_uploaded Type: boolean Indicates whether an LDAP configuration file has been uploaded. is_certificate_uploaded Type: boolean Indicates whether an LDAP certificate file has been uploaded. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 395
Attribute id is_certificate_uploaded 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 396
Attribute nas_server.preferred_node_id nas_server.production_IPv4_interface_id 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 X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 397
. json 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 create -nas_server_id one LDAP object per NAS Server is supported. -authentication_type Authentication type for the LDAP server. 396 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 398
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 500T | EMC PowerStore CLI Reference Guide - Page 399
-profile_DN For an iPlanet LDAP server, specifies the DN of the entry with the configuration profile. -bind_DN 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 400
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 500T | EMC PowerStore CLI Reference Guide - Page 401
IPv6. Error occurs if an IP address already exists in the addresses list. Cannot be combined with addresses. -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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 402
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 500T | EMC PowerStore CLI Reference Guide - Page 403
of the LDAP settings object. file_ndmp Use this resource type to manage NDMP services. NDMP is a standard for backing up file servers on a network. monitored local backup operations. Storage systems support NDMP v2-v4 over the network. Direct-attach NDMP is not supported. This means that the tape - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 404
identifier of the NAS server to be configured with these NDMP settings. user_name Type: string 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 nas_server - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 405
| -all } ] [ -query ] [ -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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 406
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 500T | EMC PowerStore CLI Reference Guide - Page 407
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 500T | EMC PowerStore CLI Reference Guide - Page 408
. nas_server_id Type: string Unique identifier of the associated NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS Server is supported. domain Type: string Name of the NIS domain. ip_addresses Type: array of strings The list of NIS server IP addresses. nas_server - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 409
Attribute 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.is_username_translation_enabled nas_server.name nas_server.operational_status nas_server.operational_status_l10n nas_server.preferred_node_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 410
> -ip_addresses ,... [ -async ] Action qualifiers -nas_server_id 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. 409 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 411
-async Perform asynchronous operation. 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 412
name Type: string Name of the file system. This property supports case-insensitive filtering. description Type: string Description of the file of a clone has been deleted the object_id will contain the null GUID 00000000-0000-0000-0000-000000000000. filesystem_type Type: enumerated value ("Primary", - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 413
size_used Type: size (0 to 9223372036854775807 (8192.00P)) Size used, in bytes, for the data and metadata of the file system. Value is always rounded up to next MB. protection_policy_id Type: string Unique identifier of the protection policy applied to the file system. access_policy Type: - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 414
SMB_Forbidden A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. All_Forbidden Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 415
Indicates whether file writes notifications are enabled on the file system. Values are: true File writes notification are enabled on the file system. false File writes notifications are disabled on the file system. smb_notify_on_change_dir_depth Type: 32-bit signed integer (0 to 2147483647) Lowest - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 416
can be used to compute the amount of space consumed without limiting the space). default_soft_limit Type: size (0 to 9223372036854775807 (8192.00P)) Default soft limit of user quotas and tree quotas (bytes). (0 means 'No limitation'). creation_timestamp Type: date time Time, in seconds, when the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 417
creator types. Scheduler Created by a snapshot schedule. 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 418
creator_type_l10n Type: string Localized message string corresponding to creator_type. nas_server This is the embeddable reference form of nas_server_id attribute. See nas_server for more details protection_policy This is the embeddable reference form of protection_policy_id attribute. See policy - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 419
Attribute creator_type_l10n default_hard_limit default_soft_limit description expiration_timestamp file_tree_quotas.description file_tree_quotas.file_system_id file_tree_quotas.grace_period file_tree_quotas.hard_limit file_tree_quotas.id file_tree_quotas.is_user_quotas_enforced file_tree_quotas.path - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 420
Attribute file_user_quotas.size_used file_user_quotas.soft_limit file_user_quotas.state file_user_quotas.state_l10n file_user_quotas.tree_quota_id file_user_quotas.uid file_user_quotas.unix_name file_user_quotas.windows_name file_user_quotas.windows_sid filesystem_type filesystem_type_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 421
Attribute is_smb_op_locks_enabled is_smb_sync_writes_enabled last_refresh_timestamp last_writable_timestamp locking_policy locking_policy_l10n name nas_server.backup_IPv4_interface_id nas_server.backup_IPv6_interface_id nas_server.current_node_id nas_server.current_preferred_IPv4_interface_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 422
Attribute 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 nfs_exports.anonymous_GID nfs_exports.anonymous_UID nfs_exports.default_access nfs_exports. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 423
Attribute nfs_exports.read_only_root_hosts nfs_exports.read_write_hosts nfs_exports.read_write_root_hosts parent_id protection_policy.description protection_policy.id protection_policy.is_replica protection_policy.name protection_policy.type protection_policy.type_l10n protection_policy_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 424
Attribute smb_shares.name smb_shares.offline_availability smb_shares.offline_availability_l10n smb_shares.path smb_shares.umask Select X Sort X X X X Search Format file_system [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 425
-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 file system. Format file_system create -name -size_total - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 426
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 500T | EMC PowerStore CLI Reference Guide - Page 427
-is_smb_op_locks_enabled Indicates whether opportunistic file locking is enabled on the file system. Values are: 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 428
Action qualifiers -id Unique identifier of the file system. -name 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 429
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 500T | EMC PowerStore CLI Reference Guide - Page 430
. -protection_policy_id Unique identifier 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 431
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 Infinite grace (Windows policy). 0 Use system default of 1 week. Positive Grace period after which the soft - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 432
-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 500T | EMC PowerStore CLI Reference Guide - Page 433
-is_smb_sync_writes_enabled Indicates whether the synchronous writes option is enabled on the file system. Values are: true Synchronous writes option is enabled on the file system. false Synchronous writes option is disabled on the file system. -is_smb_no_notify_enabled Indicates whether - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 434
false Asynchronous MTIME is disabled on the file system. -async Perform asynchronous operation. refresh Refresh a snapshot of a file system. The content of the snapshot is replaced with the current content of the parent file system. Format file_system { -id | -name } refresh [ -async - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 435
200 Success with backup snapshot. 204 Success without backup snapshot. Format file_system { -id | -name } restore [ -copy_name ] [ -async ] Action qualifiers -id Unique identifier of the file system snapshot. -name Unique name of the existing object (file_system). -copy_name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 436
-description Description of the snapshot. -expiration_timestamp Time, when the snapshot will expire. -is_auto_delete_enabled Indicates whether the snapshot can be automatically deleted per threshold settings. Values are: true Snapshot can be automatically deleted per threshold settings. false - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 437
-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 directories. All_Allowed All - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 438
-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 file system. false File writes notifications are disabled on the file system. -smb_notify_on_change_dir_depth Lowest directory - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 439
Description of the tree quota. is_user_quotas_enforced Type: boolean Whether user quota are enabled on this tree quota. The tree quota itself is enforced regardless of this parameter. state Type: enumerated value "Soft_Exceeded_And_Expired") ("Hard_Reached", "Ok", "Soft_Exceeded", State of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 440
grace_period[Added in 2.0.0.0] Type: 32-bit signed integer (-1 to 2147483647) Grace period of soft limit (seconds). This will override the default grace period set at filesystem level. -1 Infinite grace period (Windows policy). 0 Use default grace period of 1 week (default). Positive Grace - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 441
Attribute 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.folder_rename_policy_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 442
Attribute 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 file_system_id file_user_tree_quotas. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 443
Attribute file_user_tree_quotas.windows_name file_user_tree_quotas.windows_sid grace_period hard_limit id is_user_quotas_enforced path remaining_grace_period size_used soft_limit state state_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 Search X X X X X X X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 444
-offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text. csv Display output in CSV format. table - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 445
rounded up to match the physical block size of the filesystem. -soft_limit Soft limit of the tree quota, in bytes. No hard limit when set to 0. Value is always rounded up to match the physical block size of the filesystem. -is_user_quotas_enforced Whether the quota must be enabled for all users, - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 446
set Modify a tree quota instance. Format file_tree_quota -id set [ -description ] [ -hard_limit ] [ -soft_limit ] [ -is_user_quotas_enforced { yes | true | no | false } ] [ -grace_period[Added in 2.0.0.0] < - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 447
-async Perform asynchronous operation. 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 448
Unix username. windows_name Type: string Windows username. The format is domain\\user for the domain user. windows_sid Type: string Windows Security Identifier of the user. state Type: enumerated value "Soft_Exceeded_And_Expired") ("Hard_Reached", "Ok", State of the user quota or tree quota - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 449
state_l10n Type: string 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 tree_quota This is the embeddable reference form of tree_quota_id attribute. See file_tree_quota for more details - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 450
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 500T | EMC PowerStore CLI Reference Guide - Page 451
Attribute file_system.smb_notify_on_change_dir_depth file_system_id hard_limit id remaining_grace_period size_used soft_limit state state_l10n tree_quota.description tree_quota.file_system_id tree_quota.grace_period tree_quota.hard_limit tree_quota.id tree_quota.is_user_quotas_enforced tree_quota. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 452
Attribute tree_quota_id uid unix_name windows_name windows_sid Select X Sort X X X X X X X X X Search X X X X X Format file_user_quota [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 453
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 user quota instance. Format file_user_quota create -file_system_id [ -tree_quota_id ] [ -uid ] [ -unix_name < - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 454
-soft_limit Soft limit of the user quota, in bytes. No hard limit when set to 0. Value is rounded up to match the physical block size of the filesystem. -async Perform asynchronous operation. set Modify a user quota instance. Format file_user_quota -id set [ -hard_limit - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 455
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 500T | EMC PowerStore CLI Reference Guide - Page 456
Attribute id is_config_file_uploaded is_enabled 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 457
Attribute nas_server.production_IPv6_interface_id nas_server_id Select X Sort X X Search X Format file_virus_checker [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 458
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. Format file_virus_checker -id delete [ -async ] Action - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 459
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 500T | EMC PowerStore CLI Reference Guide - Page 460
id Type: string Unique identifier of the NAS server. name Type: string Name of the NAS server. This property supports case-insensitive filtering. description Type: string Description of the NAS server. operational_status Type: enumerated value ("Degraded", "Failover", "Started", "Starting - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 461
connect. This attribute 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 Type: string 460 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 462
Unique identifier of the preferred IPv4 production interface. production_IPv6_interface_id Type: string Unique identifier of the preferred IPv6 production interface. backup_IPv4_interface_id Type: string Unique identifier of the preferred IPv4 backup interface. backup_IPv6_interface_id Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 463
smb_servers This is the inverse of the resource type smb_server association. See smb_server for more details file_dnses This is the inverse of the resource type file_dns association. See file_dns for more details file_ftps This is the inverse of the resource type file_ftp association. See file_ftp - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 464
Attribute description file_dnses.domain file_dnses.id file_dnses.ip_addresses 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 465
Attribute file_ftps.is_smb_authentication_enabled file_ftps.is_unix_authentication_enabled file_ftps.message_of_the_day file_ftps.nas_server_id file_ftps.users file_ftps.welcome_message file_interfaces.gateway file_interfaces.id file_interfaces.ip_address file_interfaces.is_disabled file_interfaces. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 466
Attribute file_ldaps.addresses file_ldaps.authentication_type file_ldaps.authentication_type_l10n file_ldaps.base_DN 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 467
Attribute file_ndmps.user_name file_nises.domain file_nises.id file_nises.ip_addresses 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 468
Attribute file_systems.id file_systems.is_async_MTime_enabled file_systems.is_modified file_systems.is_quota_enabled 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 469
Attribute file_virus_checkers.is_config_file_uploaded file_virus_checkers.is_enabled file_virus_checkers.nas_server_id id is_auto_user_mapping_enabled is_username_translation_enabled name nfs_servers.credentials_cache_TTL nfs_servers.host_name nfs_servers.id nfs_servers. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 470
Attribute production_IPv4_interface_id production_IPv6_interface_id smb_servers.computer_name smb_servers.description 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 471
{ yes | true | no | false } ] [ -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. 470 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 472
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 500T | EMC PowerStore CLI Reference Guide - Page 473
to an AD domain. -domain_password Administrator password used to unjoin the associated SMB servers from the Active Directory (AD) domain before deleting the NAS server. This parameter is required when the skipDomainUnjoin parameter is false or not set, and the NAS server has SMB servers joined to an - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 474
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 500T | EMC PowerStore CLI Reference Guide - Page 475
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 500T | EMC PowerStore CLI Reference Guide - Page 476
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). homedir Download a NAS server homedir file containing the template or the actual (if already uploaded) homedir - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 477
-d Local folder where file shall be stored -id Unique identifier of the NAS server. -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 < - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 478
-id Unique identifier of the NAS server. -name Unique name of the existing object (nas_server). 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 } ] { - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 479
-name Unique name of the existing object (nas_server). user_mapping_report Download the report generated by the update_user_mappings action. Format nas_server/download [ { -f | -d } ] { -id | -name } user_mapping_report Action qualifiers -f Local path with the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 480
homedir Upload the NAS server homedir file. 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 481
Action qualifiers -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 } - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 482
-body Upload the NAS server ntxmap file. -async Perform asynchronous operation. passwd Upload NAS server passwd file. Format nas_server/upload { -id | -name } passwd [ -body ] [ -async ] Action qualifiers -id Unique identifier of the NAS server. -name Unique name of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 483
NFS Export name. This property supports case-insensitive filtering. path Type: string Local path to a location within the file system. With NFS, each export must have a unique local path. By default, - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 484
Kerberos Allow only Kerberos security for user authentication. ◦ Kerberos_With_Integrity- Allow only Kerberos with integrity and Kerberos with encryption security for user authentication. ◦ Kerberos_With_Encryption- Allow only Kerberos with encryption security for user authentication. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 485
anonymous_UID Type: 32-bit signed integer Specifies the user ID of the anonymous account. anonymous_GID Type: 32-bit signed integer Specifies the group ID of the anonymous account. is_no_SUID Type: boolean If set, do not allow access to set SUID. Otherwise, allow access. default_access_l10n Type: - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 486
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 500T | EMC PowerStore CLI Reference Guide - Page 487
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 500T | EMC PowerStore CLI Reference Guide - Page 488
Attribute 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 Search X X X X X Format nfs_export [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 489
-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 an NFS Export for a Snapshot. Format nfs_export create -file_system_id -path -name [ - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 490
◦ Read_Write- Allow read write access to the Export for the hosts. Root Allow read write access to the Export for the hosts. Allow access to the Export for root user. ◦ Read_Only_Root- Allow read only root access to the Export for the hosts. -min_security NFS enforced security type for users - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 491
-anonymous_GID Specifies the group ID of the anonymous account. -is_no_SUID If set, do not allow access to set SUID. Otherwise, allow access. -async Perform asynchronous operation. delete Delete NFS Export. Format nfs_export { -id | -name } delete [ -async ] Action qualifiers -id NFS - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 492
-name Unique name of the existing object (nfs_export). -description 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. ◦ - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 493
-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 @. -add_read_only_hosts Hosts to add to the current read_only_hosts list - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 494
. At least one NFS share must be created from an NFS 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 when the NFS server is created and remains active until the NFS - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 495
the configured SMB Server settings are used for Kerberos authentication. false Indicates that Kerberos uses its own settings. service_principal_name Type: string The Service Principal Name (SPN) for the NFS server. This name is updated automatically when the NFS server configuration changes. 494 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 496
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 the performance. credentials_cache_TTL Type: 32-bit signed - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 497
Attribute is_secure_enabled is_use_smb_config_enabled 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 498
Attribute nas_server_id service_principal_name Select X Sort X X X Search X X Format nfs_server [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 499
json Display output in JSON format. create Create an NFS server. Format nfs_server create -nas_server_id [ -host_name ] [ -is_nfsv3_enabled { yes | true | no | false } ] [ -is_nfsv4_enabled { yes | true | no | false } ] [ -is_secure_enabled { yes | true | no | false } ] [ - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 500
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 the performance. -credentials_cache_TTL Sets the Time-To - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 501
. 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 server will send additional request to Unix Directory service to identify Unix groups. Note The NFS server builds its - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 502
-credentials_cache_TTL Sets the Time-To-Live (in minutes) expiration stamp for a Windows entry in the credentials cache. When failed mapping entries expire, the system retries mapping the UID to the SID. -async Perform asynchronous operation. join Join the secure NFS server to the NAS server's AD - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 503
rule. name Type: string Name of the performance rule. This property supports case-insensitive filtering. io_priority Type: enumerated value ("High", "Low", "Medium") The I/O priority for quality of service rules. io_priority_l10n Type: string Localized message string corresponding to io_priority - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 504
Attribute io_priority_l10n name policies.description policies.id policies.is_replica policies.name policies.type policies.type_l10n Select X Sort X X X X X X X X X Search X X Format performance_rule [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 505
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 500T | EMC PowerStore CLI Reference Guide - Page 506
the first word will be kept - parentheses (()) - braces ({}) - underscore (_) - white space (blank) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/909264/). domain Type: string Domain name where SMB server is registered in Active Directory, if applicable - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 507
details show Property capabilities Attribute computer_name description domain id is_joined is_standalone 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 508
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 netbios_name workgroup Select X Sort X X X X X X X X X X X Search X X X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 509
-all Query all records. -query Query records that fulfill the specified condition. -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 an SMB server. Format - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 510
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 500T | EMC PowerStore CLI Reference Guide - Page 511
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 500T | EMC PowerStore CLI Reference Guide - Page 512
-local_admin_passwordSecure Secure version of -local_admin_password. Value will be queried interactively. -async Perform asynchronous operation. join Join the SMB server to an Active Directory domain. Format smb_server -id join -domain_user_name { -domain_password | - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 513
Id of the SMB Share. file_system_id Type: string The file system from which the share was created. name Type: string SMB share name. This property supports case-insensitive filtering. path Type: string Local path to the file system or any existing sub-folder of the file system that is shared over - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 514
- true - BranchCache is enabled. false - BranchCache is disabled. offline_availability Type: enumerated value ("Documents", "Manual", "None", "Programs") Defines valid states of Offline Availability, Manual Only specified files will be available offline. Documents All files that users open will - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 515
Programs None Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. Prevents clients from storing documents and programs in offline cache (default). umask Type: string The default UNIX umask for new files created - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 516
Attribute 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.folder_rename_policy_l10n file_system.grace_period file_system.id file_system. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 517
Attribute 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 file_system_id id is_ABE_enabled is_branch_cache_enabled is_continuous_availability_enabled - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 518
-id SMB Share object id. -name Unique name of the existing object (smb_share). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 519
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 500T | EMC PowerStore CLI Reference Guide - Page 520
] [ -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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 521
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 500T | EMC PowerStore CLI Reference Guide - Page 522
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 Type: size (0 to 9223372036854775807 (8192.00P)) The total number of bytes that can be provisioned/reserved against this - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 523
Attribute 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 500T | EMC PowerStore CLI Reference Guide - Page 524
Attribute virtual_volumes.usage_type_l10n virtual_volumes.virtual_machine_uuid Select X Sort X Search Format storage_container [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 525
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 ] [ -async ] Action qualifiers -name Name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 526
-async Perform asynchronous operation. set Modify a storage container. Format storage_container { -id | -name } set [ -name ] [ -quota ] [ -async ] Action qualifiers -id Storage container ID. -name Unique name of the existing object ( - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 527
identifier of the virtual volume. name Type: string The name of the virtual volume, based on metadata provided by vSphere. This property supports case-insensitive filtering. size Type: size (0 to 9223372036854775807 (8192.00P)) The size of the virtual volume in bytes. type Type: enumerated value - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 528
The storage container where the virtual volume resides. io_priority Type: enumerated value ("High", "Low", "Medium") The I/O priority for quality of service rules. profile_id Type: string The ID of the storage profile governing this virtual volume. creator_type Type: enumerated value ("Scheduler - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 529
virtual volume was created at. location_history Type: array of objects Filtering on the fields of this embedded resource is not supported. See location_history for more details type_l10n Type: string Localized message string corresponding to type. usage_type_l10n Type: string Localized message - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 530
Localized message string corresponding to io_priority. creator_type_l10n Type: string Localized message string corresponding to creator_type. appliance This is the embeddable reference form of appliance_id attribute. See appliance for more details storage_container This is the embeddable reference - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 531
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 500T | EMC PowerStore CLI Reference Guide - Page 532
Attribute child_virtual_volumes.creator_type_l10n child_virtual_volumes.family_id child_virtual_volumes.id child_virtual_volumes.io_priority child_virtual_volumes.io_priority_l10n child_virtual_volumes.is_readonly child_virtual_volumes.location_history child_virtual_volumes.migration_session_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 533
Attribute 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 host_virtual_volume_mappings.virtual_volume_id id io_priority io_priority_l10n is_readonly location_history migration_session. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 534
Attribute migration_session.resource_type migration_session.resource_type_l10n migration_session.source_appliance_id migration_session.state migration_session.state_l10n migration_session_id name parent.appliance_id parent.creation_timestamp parent.creator_type parent.creator_type_l10n parent. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 535
Attribute 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.appliance_id source.creation_timestamp source.creator_type source. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 536
Attribute 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.usage_type source.usage_type_l10n source.virtual_machine_uuid source_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 537
Attribute 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 target_virtual_volumes.io_priority target_virtual_volumes.io_priority_l10n target_virtual_volumes.is_readonly - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 538
Attribute target_virtual_volumes.virtual_machine_uuid type type_l10n usage_type usage_type_l10n virtual_machine_uuid virtual_machines.cpu_count virtual_machines.description virtual_machines.guest_os virtual_machines.id virtual_machines.instance_uuid virtual_machines.is_consistent virtual_machines. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 539
Attribute virtual_machines.vcenter_id virtual_machines.vcenter_instance_uuid Select X Sort X Search Format virtual_volume [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 540
Unique identifier of the volume instance. name Type: string Name of the volume. This value must contain 128 or fewer printable Unicode characters. This property supports case-insensitive filtering. 539 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 541
description Type: string Description of the volume. This value must contain 128 or fewer printable Unicode characters. type Type: enumerated value ("Clone", "Primary", "Snapshot") Type of volume. Primary A base object. Clone A read-write object that shares storage with the object from which it is - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 542
Initializing Volume is starting but not yet ready for use. Offline Volume is not available. Destroying Volume is being deleted. No new operations are allowed. size Type: size (1048576 (1.00M) to 281474976710656 (256.00T)) Size of the volume in bytes. Minimum volume size is 1MB. Maximum volume - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 543
of a migration activity. protection_data Type: object 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 Type: array of objects Filtering on the fields of this embedded resource is not - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 544
host_volume_mapping for more details volume_groups List of the volume_groups that are associated with this volume. See volume_group for more details Attributes of protection_data created_by_rule_id Unique identifier of the snapshot rule that created the snapshot. created_by_rule_name The name of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 545
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 500T | EMC PowerStore CLI Reference Guide - Page 546
Attribute appliance_id creation_timestamp description id is_replication_destination location_history mapped_volumes.host_group_id mapped_volumes.host_id mapped_volumes.id mapped_volumes.logical_unit_number mapped_volumes.volume_id migration_session.created_timestamp migration_session. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 547
Attribute migration_session.resource_type_l10n migration_session.source_appliance_id migration_session.state migration_session.state_l10n migration_session_id name nguid node_affinity node_affinity_l10n nsid performance_policy_id protection_data protection_policy.description protection_policy.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 548
Attribute 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.is_replication_destination volume_groups.is_write_order_consistent volume_groups.location_history volume_groups. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 549
Action qualifiers -id Unique identifier of the volume to query. -name Unique name of the existing object (volume). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 550
a volume group. -min_size Optional minimum 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. 549 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 551
-performance_policy_id Unique identifier of the performance policy assigned to the volume. -async Perform asynchronous operation. delete Delete a volume. • A volume which is attached to a host or host group or is a member of a volume group cannot be deleted. • A volume which has protection policies - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 552
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 500T | EMC PowerStore CLI Reference Guide - Page 553
attach Attach a volume to a host or host group. Format volume { -id | -name } attach [ -host_id ] [ -host_group_id ] [ -logical_unit_number ] [ -async ] Action qualifiers -id Unique identifier of volume to attach. -name Unique name of the existing object ( - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 554
-description Description of the clone. This value must contain 128 or fewer printable Unicode characters. -host_id Unique identifier of the host to be attached to the clone. Only one of host_id or host_group_id can be supplied. -host_group_id Unique identifier of the host group to be attached to the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 555
-async Perform asynchronous operation. refresh Refresh the contents of the target volume from another volume in the same family. By default, a backup snapshot of the target volume is created before the target volume is refreshed. To skip creating a backup snapshot, set the create_backup_snap - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 556
-expiration_timestamp Time at which the snapshot will expire. 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 expiration to never expire. -creator_type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 557
policy assigned to the snapshot. -expiration_timestamp Time at which the snapshot will expire. 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 expiration - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 558
snapshot will expire. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the . name Type: string Name of the volume group. This property supports case-insensitive filtering. description Type: string Description for the volume group - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 559
◦ Whether a protection_policy can be applied to the group. ◦ Whether manual snapshots can be taken. ◦ Whether clones of the group can be created Filtering on the fields of this embedded resource is not supported. type Type: enumerated value ("Clone", "Primary", "Snapshot") Type of volume. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 560
. 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 Type: string Localized message string corresponding to type. protection_policy This is the embeddable reference form - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 561
migration_session This is the embeddable reference form of migration_session_id attribute. See migration_session for more details volumes List of the volumes that are associated with this volume_group. See volume for more details Attributes of protection_data created_by_rule_id Unique identifier of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 562
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 500T | EMC PowerStore CLI Reference Guide - Page 563
Attribute location_history migration_session.created_timestamp 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 564
Attribute protection_policy.is_replica protection_policy.name protection_policy.type protection_policy.type_l10n protection_policy_id type type_l10n volumes.appliance_id volumes.creation_timestamp volumes.description volumes.id volumes.is_replication_destination volumes.location_history volumes. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 565
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 Search Format volume_group [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 566
-query Query records that fulfill the specified condition. -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 volume group. The resulting volume group - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 567
consistent. This parameter defaults to true, if not specified. -protection_policy_id Unique identifier of an optional protection policy to assign to the volume group. -async Perform asynchronous operation. delete Delete a volume group, snapshot set, or clone. Before you try deleting a volume group, - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 568
Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -name New name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case of the name provided is reserved, uniqueness - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 569
-force Normally a replication destination volume group 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 group needs to be cleaned up. With the force option, the user will - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 570
only initializes the name to an auto-generated, unique value. Other optional parameters are not specified. The table below outlines supported modes of operation and resulting updates to source_id and source_time attributes of protection_data. |Target volume group|Source volume group|New source_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 571
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 500T | EMC PowerStore CLI Reference Guide - Page 572
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 500T | EMC PowerStore CLI Reference Guide - Page 573
-description ] [ -expiration_timestamp[Added in 2.0.0.0] ] ] [ -async ] Action qualifiers -id Unique identifier of the volume group. -name Unique name of the existing object (volume_group). -from_snap_id Unique identifier of the snapshot set to restore from. This is referred to as - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 574
:ss.SSSZ. By default, expiration time will not be set. Was added in version 2.0.0.0. -async Perform asynchronous operation. Support Manage service user credentials, perform service actions on the system maintenance_window Use this resource type to manage the maintenance window configuration for each - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 575
id Type: string Unique identifier of the maintenance window. appliance_id Type: string Appliance id on which this maintenance window is configured. is_enabled Type: boolean Whether the maintenance window is active. end_time Type: date time Time when the maintenance window will close (or did close). - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 576
Attribute id is_enabled Select X Sort X X X Search X X Format maintenance_window [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 577
as true, and may not be more than 172800 (48 hours). -async Perform asynchronous operation. remote_support_contact Manage remote support contact. Remote support instance properties. Was added in version 2.0.0.0. Attributes id The unique id of the remote_support_contact instance. first_name[Added in - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 578
format. table Display output in a table. json Display output in JSON format. set[Added in 2.0.0.0] Modify the remote support contact information. Was added in version 2.0.0.0. Format remote_support_contact -id set [ -last_name ] [ -first_name ] [ -email ] [ -phone - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 579
contact for this system. Was added in version 2.0.0.0. -phone The phone number of this support contact for this system. Was added in version 2.0.0.0. -async Perform asynchronous operation. service_config Manage the service configuration for each appliance. 'SSH Access' Manage the ability for the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 580
. csv Display output in CSV format. table Display output in a table. json Display output in JSON format. set Modify the service configuration for an appliance. Format service_config -id set -is_ssh_enabled { yes | true | no | false } [ -async ] Action qualifiers -id Unique identifier - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 581
. SSH can be enabled or disabled using the service_config modify operation. Attributes id Unique identifier of the service user account. name Name of the service user account. Always 'service' in this release. is_built_in Whether the user account is built-in or not. is_default_password Whether the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 582
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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 583
of the appliance. name Type: string Name of the appliance. This property supports case-insensitive filtering. service_tag Type: string Dell Service Tag. express_service_code Type: string Express Service Code. model Type: string Model of the appliance. drive_failure_tolerance_level[Added in - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 584
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 500T | EMC PowerStore CLI Reference Guide - Page 585
Attribute eth_ports.bond_id eth_ports.current_mtu eth_ports.current_speed eth_ports.current_speed_l10n eth_ports.hardware_parent_id 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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 586
Attribute eth_ports.requested_speed_l10n eth_ports.sfp_id eth_ports.stale_state eth_ports.stale_state_l10n eth_ports.supported_speeds eth_ports.supported_speeds_l10n express_service_code fc_ports.appliance_id fc_ports.current_speed fc_ports.current_speed_l10n fc_ports.hardware_parent_id fc_ports.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 587
Attribute fc_ports.protocols_l10n fc_ports.requested_speed fc_ports.requested_speed_l10n fc_ports.sfp_id fc_ports.stale_state fc_ports.stale_state_l10n fc_ports.supported_speeds fc_ports.supported_speeds_l10n fc_ports.wwn fc_ports.wwn_nvme hardware.appliance_id hardware.extra_details hardware.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 588
Attribute hardware.stale_state hardware.stale_state_l10n hardware.status_led_state hardware.status_led_state_l10n hardware.type hardware.type_l10n id ip_pool_addresses.address ip_pool_addresses.appliance_id ip_pool_addresses.id ip_pool_addresses.ip_port_id ip_pool_addresses.name ip_pool_addresses. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 589
Attribute name nodes.appliance_id nodes.id nodes.slot sas_ports.appliance_id sas_ports.hardware_parent_id sas_ports.id sas_ports.io_module_id sas_ports.is_link_up sas_ports.name sas_ports.node_id sas_ports.partner_id sas_ports.port_index sas_ports.sfp_id sas_ports.speed sas_ports.speed_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 590
Attribute software_installed.build_id software_installed.build_type software_installed.build_type_l10n software_installed.build_version software_installed.id software_installed.installed_date software_installed.is_cluster software_installed.release_timestamp software_installed.release_version - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 591
Attribute veth_ports.vswitch_port_name 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 500T | EMC PowerStore CLI Reference Guide - Page 592
Attribute virtual_volumes.usage_type virtual_volumes.usage_type_l10n virtual_volumes.virtual_machine_uuid volumes.appliance_id volumes.creation_timestamp volumes.description volumes.id volumes.is_replication_destination volumes.location_history volumes.migration_session_id volumes.name volumes.nguid - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 593
Attribute volumes.type volumes.type_l10n volumes.wwn Select X Sort X X Search Format appliance [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 594
address. It is unique to this appliance and is set by Zeroconf. Use the PowerStore Discovery Tool to get the link local address. -name The name of the new Set to true to ignore warnings about unreachable external network services discovered while adding an appliance. This can be useful for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 595
-drive_failure_tolerance_level Possible drive failure tolerance levels. Single A single drive failure can be tolerated without data loss. Double Two drive failure can be tolerated without data loss. Was added in version 2.0.0.0. -async Perform asynchronous operation. delete[Added in 2.0.0.0] Remove - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 596
-async Perform asynchronous operation. forecast Forecast capacity usage for an appliance. Format appliance { -id | -name } forecast -metric_type { Physical_Space_Used_One_Day } [ -async ] Action qualifiers -id Unique id of the appliance. -name Unique name of the existing object ( - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 597
address. It is unique to this appliance and is set by Zeroconf. Use the PowerStore Discovery Tool to get the link local address. -name The name of the new Set to true to ignore warnings about unreachable external network services discovered while adding an appliance. This can be useful for - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 598
id Type: string Unique identifier of the bond. name Type: string Bond name. The bond name may not exceed 15 characters. This property supports case-insensitive filtering. partner_id[Added in 2.0.0.0] Type: string Identifier of the bond with the same physical location on the other node of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 599
failed interface. This mode does not require any special switch support. Adaptive_Load_Balancing This mode includes Transmit Load Balancing (TLB) and (RLB) for IPv4 traffic and does not require any special switch support. Receive load balancing is achieved by ARP negotiation. type[Added in - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 600
Attribute eth_ports.appliance_id eth_ports.bond_id eth_ports.current_mtu eth_ports.current_speed eth_ports.current_speed_l10n eth_ports.hardware_parent_id eth_ports.hypervisor_port_id eth_ports.hypervisor_port_name eth_ports.hypervisor_vswitch_id eth_ports.hypervisor_vswitch_name eth_ports.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 601
Attribute eth_ports.requested_speed eth_ports.requested_speed_l10n eth_ports.sfp_id eth_ports.stale_state eth_ports.stale_state_l10n eth_ports.supported_speeds eth_ports.supported_speeds_l10n id ip_ports.available_usages ip_ports.available_usages_l10n ip_ports.bond_id ip_ports.current_usages - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 602
Attribute mtu name partner.description partner.id partner.is_link_up partner.mode partner.mode_l10n partner.mtu partner.name partner.partner_id partner.type partner.type_l10n partner_id 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 Search X X X X X Format - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 603
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 604
name The name of the cluster. management_address The floating management IP address for the cluster in IPv4 or IPv6 format. storage_discovery_address The floating storage discovery IP address for the cluster in IPv4 or IPv6 format. If multiple storage discovery addresses are configured, this - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 605
state_l10n Localized string corresponding to state. system_time[Added in 2.0.0.0] Current clock time for the system. System time and all the system reported times are in UTC (GMT+0:00) format. The system time is controlled via NTP. It cannot be set directly. Was added in version 2.0.0.0. show - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 606
for any failed secondary appliance. Look for these alerts in the PowerStore Manager. Resolve issues on failed appliances before adding the appliances to When creating a cluster asynchronously, wait for ~10 minutes until Job Service is initialized before querying the status of the running job. Was - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 607
true to ignore network warnings about unreachable external network services discovered while cluster creation. This can be useful appliance and is set by Zeroconf. Use the PowerStore Discovery Tool to get the link local addresses of available PowerStore appliances on the local subnet. -name The name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 608
-type Network type. Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the cluster. Storage External data transfer. VMotion Data movement controlled by VMotion. -prefix_length Network prefix length, - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 609
-connections Physical switch connection configuration setting during cluster creation. Was added in version 2.0.0.0. -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 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 610
system credentials for vCenter to use for communicating with the storage system using VASA. Parameters are required when creating PowerStore X cluster and optional for PowerStore cluster. Was added in version 2.0.0.0. -username Username of the local user account which will be used by vSphere to - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 611
Metric type to be forecast. -async Perform asynchronous operation. validate_create[Added in 2.0.0.0] Validate the create cluster configuration for a PowerStore or PowerStore X Cluster of one or more appliances. Success is returned when all the validations have been run. The response shows whether - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 612
true to ignore network warnings about unreachable external network services discovered while cluster creation. This can be useful appliance and is set by Zeroconf. Use the PowerStore Discovery Tool to get the link local addresses of available PowerStore appliances on the local subnet. -name The name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 613
Was added in version 2.0.0.0. -networks Network configuration setting during cluster creation. Was added in version 2.0.0.0. -type Network type. Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 614
Data_and_Management Physical switch for all data and management networks. Management_Only Physical switch for management network only. -connections Physical switch connection configuration setting during cluster creation. Was added in version 2.0.0.0. -address Physical switch address in IPv4 or - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 615
with the storage system using VASA. Parameters are required when creating PowerStore X cluster and optional for PowerStore cluster. Was added in version 2.0.0.0. -username Username of the identifier. name Type: string Ethernet port name. This property supports case-insensitive filtering. 614 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 616
. supported_speeds Type: array of enumerated values ("100_Mbps", "10_Gbps", "10_Mbps", "1_Gbps", "25_Gbps", "40_Gbps", "Auto") The list of supported transmission speeds for Ethernet port. current_speed Type: enumerated value ("100_Mbps", "10_Gbps", "10_Mbps", "1_Gbps", "25_Gbps", "40_Gbps", "Auto - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 617
per second 40_Gbps 40 Gigabits per second. requested_speed Type: enumerated value ("100_Mbps", "10_Gbps", "10_Mbps", "1_Gbps", "25_Gbps", "40_Gbps", "Auto") Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 618
"FC_Style2_Copper", "FiberJack", "HSSDC_II", "LC", "MT_RJ", "MU", "MXC_2x16", "No_Separable", "Optical_Pigtail", "RJ45", "SC", "SG", "Unknown") Type of connector supported by the port. Current values are: Unknown Unknown Connector SC Subscriber Connector FC_Style1_Copper Fibre Channel Style - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 619
Indicates whether the port is managed by a hypervisor. hypervisor_port_name Type: string Hypervisor front-end port name capabilities. This property supports case-insensitive filtering. hypervisor_vswitch_name Type: string Name of the virtual switch associated with the hypervisor port. This property - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 620
Indicator of the stale state of the port. Was added in version 2.0.0.0. supported_speeds_l10n Type: array of strings Localized message array corresponding to supported_speeds. current_speed_l10n Type: string Localized message string corresponding to current_speed. requested_speed_l10n Type: string - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 621
more details partner This is the embeddable reference form of partner_id attribute. See eth_port for more details show Property capabilities Attribute appliance.drive_failure_tolerance_level appliance.drive_failure_tolerance_level_l10n appliance.express_service_code appliance.id appliance.model - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 622
Attribute bond.type_l10n bond_id current_mtu current_speed current_speed_l10n hardware_parent.appliance_id hardware_parent.extra_details hardware_parent.id hardware_parent.is_marked hardware_parent.lifecycle_state hardware_parent.lifecycle_state_l10n hardware_parent.name hardware_parent.parent_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 623
Attribute hardware_parent.type_l10n hardware_parent_id 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.lifecycle_state io_module.lifecycle_state_l10n io_module.name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 624
Attribute 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.current_usages_l10n ip_ports.eth_port_id ip_ports.id ip_ports.partner_id ip_ports.target_iqn ip_ports. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 625
Attribute node.is_marked node.lifecycle_state node.lifecycle_state_l10n node.name node.parent_id node.part_number node.serial_number node.slot node.stale_state node.stale_state_l10n node.status_led_state node.status_led_state_l10n node.type node.type_l10n node_id partner.appliance_id partner.bond_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 626
Attribute 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.partner_id partner. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 627
Attribute partner.supported_speeds_l10n 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 628
Attribute sfp.status_led_state_l10n sfp.type sfp.type_l10n sfp_id stale_state stale_state_l10n supported_speeds supported_speeds_l10n Select X Sort X X X X X X X X X X X X Search X X X X X Format eth_port [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 629
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 500T | EMC PowerStore CLI Reference Guide - Page 630
, hardware, fc_port Attributes id Type: string Unique identifier of the port. name Type: string Name of the port. This property supports case-insensitive filtering. appliance_id Type: string Unique identifier of the appliance containing the port. node_id Type: string Unique identifier of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 631
is up. false Link is down. supported_speeds Type: array of enumerated values ("16_Gbps", "32_Gbps", "4_Gbps", "8_Gbps", "Auto") List of supported transmission speeds for the port. current_speed Type: enumerated value ("16_Gbps", "32_Gbps", "4_Gbps", "8_Gbps", "Auto") Possible Fibre Channel port - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 632
"FC_Style2_Copper", "FiberJack", "HSSDC_II", "LC", "MT_RJ", "MU", "MXC_2x16", "No_Separable", "Optical_Pigtail", "RJ45", "SC", "SG", "Unknown") Type of connector supported by the port. Current values are: Unknown Unknown Connector SC Subscriber Connector FC_Style1_Copper Fibre Channel Style - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 633
: string Unique identifier of the partner port. protocols[Added in 2.0.0.0] Type: array of enumerated values ("NVMe", "SCSI") List of supported protocols for the port. Was added in version 2.0.0.0. stale_state[Added in 2.0.0.0] Type: enumerated value ("Disconnected", "Not_Stale") Indicator of the - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 634
Localized message array corresponding to supported_speeds. current_speed_l10n Type: string Localized message string corresponding to current_speed. requested_speed_l10n Type: string Localized message string corresponding to requested_speed. port_connector_type_l10n Type: string Localized message - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 635
show Property capabilities Attribute appliance.drive_failure_tolerance_level appliance.drive_failure_tolerance_level_l10n appliance.express_service_code appliance.id appliance.model appliance.name appliance.service_tag appliance_id current_speed current_speed_l10n hardware_parent.appliance_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 636
Attribute hardware_parent.slot hardware_parent.stale_state hardware_parent.stale_state_l10n hardware_parent.status_led_state hardware_parent.status_led_state_l10n hardware_parent.type hardware_parent.type_l10n hardware_parent_id id io_module.appliance_id io_module.extra_details io_module.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 637
Attribute io_module.stale_state_l10n 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. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 638
Attribute node.status_led_state node.status_led_state_l10n node.type node.type_l10n node_id partner.appliance_id partner.current_speed partner.current_speed_l10n partner.hardware_parent_id partner.id partner.io_module_id partner.is_link_up partner.name partner.node_id partner.partner_id partner. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 639
Attribute partner.requested_speed_l10n partner.sfp_id partner.stale_state partner.stale_state_l10n partner.supported_speeds partner.supported_speeds_l10n partner.wwn partner.wwn_nvme partner_id port_connector_type port_connector_type_l10n port_index protocols protocols_l10n requested_speed - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 640
Attribute sfp.lifecycle_state_l10n sfp.name sfp.parent_id sfp.part_number sfp.serial_number sfp.slot sfp.stale_state sfp.stale_state_l10n sfp.status_led_state sfp.status_led_state_l10n sfp.type sfp.type_l10n sfp_id stale_state stale_state_l10n supported_speeds supported_speeds_l10n wwn wwn_nvme - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 641
Action qualifiers -id Unique identifier of the FC front-end port. -name Unique name of the existing object (fc_port). -select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 642
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 qualifiers -id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 643
name Type: string The name of the component. This property supports case-insensitive filtering. type Type: enumerated value ("Appliance", "Base_Enclosure", "Battery", "DIMM", "Drive", "Expansion_Enclosure", "Fan", "IO_Module", "Link_Control_Card", "M2_Drive", "Node", "Power_Supply", "SFP") Hardware - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 644
is_marked Type: boolean Indicator of whether a component is location marked or not. extra_details Type: object Additional hardware details. Contents are specific to each component type. See extra_details for more details stale_state[Added in 2.0.0.0] Type: enumerated value ("Disconnected", " - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 645
node_sas_ports This is the inverse of the resource type sas_port association. See sas_port for more details sfp_sas_ports This is the inverse of the resource type sas_port association. See sas_port for more details io_module_sas_ports[Deprecated in 2.0.0.0] This is the inverse of the resource type - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 646
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: Unknown - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 647
FC_Style2_Copper Fibre Channel Style 1 Copper Connector BNC_TNC Bayonet/Threaded Neill-Concelman Connector FC_Coaxial_Headers Fibre Channel Coaxial Headers Connector FiberJack Fiber Jack Connector LC Lucent Connector MT_RJ - Mechanical Transfer Registered Jack Connector MU Multiple - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 648
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 invalid FIPS compliance. dell_service_tag Dell service tag of the hardware. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 649
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 encryption_status_l10n Localized message string corresponding to - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 650
Attribute children.lifecycle_state_l10n children.name children.parent_id children.part_number children.serial_number children.slot children.stale_state children.stale_state_l10n children.status_led_state children.status_led_state_l10n children.type children.type_l10n extra_details - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 651
Attribute hardware_parent_eth_ports.hypervisor_vswitch_id hardware_parent_eth_ports.hypervisor_vswitch_name hardware_parent_eth_ports.id hardware_parent_eth_ports.io_module_id hardware_parent_eth_ports.is_hypervisor_managed hardware_parent_eth_ports.is_link_up hardware_parent_eth_ports.mac_address - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 652
Attribute hardware_parent_fc_ports.current_speed hardware_parent_fc_ports.current_speed_l10n hardware_parent_fc_ports.hardware_parent_id hardware_parent_fc_ports.id hardware_parent_fc_ports.io_module_id hardware_parent_fc_ports.is_link_up hardware_parent_fc_ports.name hardware_parent_fc_ports. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 653
Attribute hardware_parent_fc_ports.wwn hardware_parent_fc_ports.wwn_nvme hardware_parent_sas_ports.appliance_id hardware_parent_sas_ports.hardware_parent_id hardware_parent_sas_ports.id hardware_parent_sas_ports.io_module_id hardware_parent_sas_ports.is_link_up hardware_parent_sas_ports.name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 654
Attribute io_module_eth_ports.current_speed_l10n io_module_eth_ports.hardware_parent_id io_module_eth_ports.hypervisor_port_id io_module_eth_ports.hypervisor_port_name io_module_eth_ports.hypervisor_vswitch_id io_module_eth_ports.hypervisor_vswitch_name io_module_eth_ports.id io_module_eth_ports. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 655
Attribute io_module_eth_ports.stale_state_l10n io_module_eth_ports.supported_speeds io_module_eth_ports.supported_speeds_l10n io_module_fc_ports.appliance_id io_module_fc_ports.current_speed io_module_fc_ports.current_speed_l10n io_module_fc_ports.hardware_parent_id io_module_fc_ports.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 656
Attribute io_module_fc_ports.stale_state io_module_fc_ports.stale_state_l10n io_module_fc_ports.supported_speeds io_module_fc_ports.supported_speeds_l10n io_module_fc_ports.wwn io_module_fc_ports.wwn_nvme io_module_sas_ports.appliance_id io_module_sas_ports.hardware_parent_id io_module_sas_ports.id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 657
Attribute 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.hardware_parent_id node_eth_ports.hypervisor_port_id node_eth_ports.hypervisor_port_name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 658
Attribute 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.stale_state node_eth_ports.stale_state_l10n node_eth_ports.supported_speeds - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 659
Attribute node_fc_ports.port_connector_type_l10n node_fc_ports.port_index node_fc_ports.protocols node_fc_ports.protocols_l10n node_fc_ports.requested_speed node_fc_ports.requested_speed_l10n node_fc_ports.sfp_id node_fc_ports.stale_state node_fc_ports.stale_state_l10n node_fc_ports.supported_speeds - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 660
Attribute node_sas_ports.port_index node_sas_ports.sfp_id node_sas_ports.speed node_sas_ports.speed_l10n node_sas_ports.stale_state node_sas_ports.stale_state_l10n parent.appliance_id parent.extra_details parent.id parent.is_marked parent.lifecycle_state parent.lifecycle_state_l10n parent.name - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 661
Attribute parent.type parent.type_l10n parent_id part_number serial_number sfp_eth_ports.appliance_id sfp_eth_ports.bond_id sfp_eth_ports.current_mtu sfp_eth_ports.current_speed sfp_eth_ports.current_speed_l10n sfp_eth_ports.hardware_parent_id sfp_eth_ports.hypervisor_port_id sfp_eth_ports. - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 662
Attribute sfp_eth_ports.node_id sfp_eth_ports.partner_id sfp_eth_ports.port_connector_type sfp_eth_ports.port_connector_type_l10n sfp_eth_ports.port_index sfp_eth_ports.requested_speed sfp_eth_ports.requested_speed_l10n sfp_eth_ports.sfp_id sfp_eth_ports.stale_state sfp_eth_ports.stale_state_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 663
Attribute 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.protocols sfp_fc_ports.protocols_l10n sfp_fc_ports.requested_speed sfp_fc_ports.requested_speed_l10n sfp_fc_ports.sfp_id sfp_fc_ports.stale_state sfp_fc_ports - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 664
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 sfp_sas_ports.stale_state sfp_sas_ports.stale_state_l10n slot stale_state stale_state_l10n status_led_state status_led_state_l10n type type_l10n Select - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 665
-select Display selected attributes in the output. -sort Sorts output field+ (or just field) sort by field in ascending order. field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. - - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 666
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 the Base_Enclosure and Expansion_Enclosure apply to their children (Nodes and Drives - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 667
Attributes id Type: string Unique identifier of the node. slot Type: 32-bit signed integer (0 to 2147483647) Slot number of the node. appliance_id Type: string Unique identifier of the appliance to which the node belongs. appliance This is the embeddable reference form of appliance_id attribute. See - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 668
Attribute appliance_id id ip_pool_addresses.address ip_pool_addresses.appliance_id ip_pool_addresses.id ip_pool_addresses.ip_port_id ip_pool_addresses.name ip_pool_addresses.network_id ip_pool_addresses.node_id ip_pool_addresses.purposes ip_pool_addresses.purposes_l10n slot veth_ports.appliance_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 669
Attribute veth_ports.vswitch_name veth_ports.vswitch_port_group_name veth_ports.vswitch_port_id veth_ports.vswitch_port_name Select X Sort X X X Search Format node [ -id ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 670
, sas_port Attributes id Type: string Unique identifier of the SAS port. name Type: string Name of the SAS port. This property supports case-insensitive filtering. appliance_id Type: string Unique identifier of the appliance containing the port. node_id Type: string Unique identifier of the hardware - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 671
◦ 3_Gbps- 3 Gigabits per second ◦ 6_Gbps- 6 Gigabits per second ◦ 12_Gbps- 12 Gigabits per second. sfp_id Type: string Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port. io_module_id[Deprecated in 2.0.0.0] Type: string Unique identifier of - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 672
details node This is the embeddable reference form of node_id attribute. See hardware for more details sfp This is the embeddable reference form of sfp_id attribute. See hardware for more details io_module This is the embeddable reference form of io_module_id attribute. See hardware for more details - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 673
Attribute hardware_parent.is_marked hardware_parent.lifecycle_state hardware_parent.lifecycle_state_l10n hardware_parent.name hardware_parent.parent_id hardware_parent.part_number hardware_parent.serial_number hardware_parent.slot hardware_parent.stale_state hardware_parent.stale_state_l10n - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 674
Attribute io_module.lifecycle_state_l10n io_module.name io_module.parent_id io_module.part_number io_module.serial_number io_module.slot io_module.stale_state io_module.stale_state_l10n io_module.status_led_state io_module.status_led_state_l10n io_module.type io_module.type_l10n io_module_id - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 675
Attribute node.name node.parent_id node.part_number node.serial_number node.slot node.stale_state node.stale_state_l10n node.status_led_state node.status_led_state_l10n node.type node.type_l10n node_id partner.appliance_id partner.hardware_parent_id partner.id partner.io_module_id partner.is_link_up - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 676
Attribute partner.sfp_id partner.speed partner.speed_l10n partner.stale_state partner.stale_state_l10n partner_id port_index 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 500T | EMC PowerStore CLI Reference Guide - Page 677
Attribute sfp.status_led_state_l10n sfp.type sfp.type_l10n sfp_id speed speed_l10n stale_state stale_state_l10n Select X Sort X X X X X X X X X X X X Search X X X X X Format sas_port [ { -id | -name } ] show [ -select ,... ] [ -sort - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 678
-all Query all records. -query Query records that fulfill the specified condition. -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. veth_port Use these resource types to - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 679
name Type: string Virtual Ethernet port name. This property supports case-insensitive filtering. mac_address Type: string Virtual Ethernet port MAC address. is_link_up Type: of the virtual switch port associated with the virtual Ethernet port. This property supports case-insensitive filtering. 678 - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 680
ip_ports This is the inverse of the resource type ip_port association. See ip_port for more details partner This is the embeddable reference form of partner_id attribute. See veth_port for more details appliance This is the embeddable reference form of appliance_id attribute. See appliance for more - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 681
Attribute ip_ports.current_usages ip_ports.current_usages_l10n ip_ports.eth_port_id ip_ports.id ip_ports.partner_id ip_ports.target_iqn ip_ports.veth_port_id is_link_up mac_address name node.appliance_id node.id node.slot node_id partner.appliance_id partner.current_mtu partner.current_speed partner - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 682
Attribute partner.node_id partner.partner_id partner.vswitch_name partner.vswitch_port_group_name partner.vswitch_port_id partner.vswitch_port_name partner_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 X Search X - Dell PowerStore 500T | EMC PowerStore CLI Reference Guide - Page 683
field- sort by field in descending order. -offset Start record list starting from specific value. -limit Limits the number of listed records. -all Query all records. -query Query records that fulfill the specified condition. -output Change the output format. nvp Display output as plain text.
-
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
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
-
577
-
578
-
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
-
683
 |
 |
Dell EMC PowerStore
CLI
Reference
Guide
June
202
1
Rev. A0
3
© 202
1
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 trademarks of their respective owners.