Dell PowerStore 500T EMC PowerStore REST API 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 REST API Reference Guide - Page 1
Dell EMC PowerStore REST API 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 REST API Reference Guide - Page 2
Storage cluster API Table of Contents Changelog 30 Version 2.0.0.0 30 Paths 30 Parameters 31 Enumeration values 31 Definitions 32 Definition members 38 Version 1.0.3 43 Paths 43 Enumeration values 44 Definitions 44 Definition members 44 Version 1.0.2 44 Paths 45 Enumeration values 45 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 3
chap_config 57 GET /chap_config 57 GET /chap_config/{id 58 PATCH /chap_config/{id 58 cluster 59 GET /cluster 59 POST /cluster 60 POST /cluster/validate_create 60 GET /cluster/{id 61 PATCH /cluster/{id 62 POST /cluster/{id}/forecast 63 POST /cluster/{id}/time_to_full 63 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 4
PATCH /file_dns/{id 77 file_ftp 77 GET /file_ftp 78 POST /file_ftp 78 GET /file_ftp/{id 79 DELETE /file_ftp/{id 79 PATCH /file_ftp/{id 80 file_interface 80 GET /file_interface 80 POST /file_interface 81 GET /file_interface/{id 81 DELETE /file_interface/{id 82 PATCH /file_interface/{id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 5
DELETE /file_ndmp/{id 97 PATCH /file_ndmp/{id 98 file_nis 98 GET /file_nis 99 POST /file_nis 99 GET /file_nis/{id 99 DELETE /file_nis/{id 100 PATCH /file_nis/{id 100 file_system 101 GET /file_system 101 POST /file_system 102 GET /file_system/{id 102 DELETE /file_system/{id 103 PATCH / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 6
GET /hardware 118 GET /hardware/{id 118 PATCH /hardware/{id 119 POST /hardware/{id}/drive_repurpose 120 host 120 GET /host 120 POST /host 121 GET /host/{id 122 DELETE /host/{id 122 PATCH /host/{id 123 POST /host/{id}/attach 124 POST /host/{id}/detach 124 host_group 125 GET /host_group - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 7
POST /import_psgroup/{id}/discover 138 import_psgroup_volume 139 GET /import_psgroup_volume 139 GET /import_psgroup_volume/{id 139 POST /import_psgroup_volume/{id}/import_snapshot_schedules 140 import_session 141 GET /import_session 141 POST /import_session 141 GET /import_session/{id 142 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 8
POST /import_unity_volume/{id}/import_snapshot_schedules 158 import_vnx_array 159 GET /import_vnx_array 159 GET /import_vnx_array/{id 159 POST /import_vnx_array/{id}/discover 160 import_vnx_consistency_group 160 GET /import_vnx_consistency_group 161 GET /import_vnx_consistency_group/{id 161 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 9
PATCH /ldap_account/{id 175 ldap_domain 176 GET /ldap_domain 176 POST /ldap_domain 177 GET /ldap_domain/{id 177 DELETE /ldap_domain/{id 178 PATCH /ldap_domain/{id 178 POST /ldap_domain/{id}/verify 179 license 179 GET /license 180 GET /license/{id 180 POST /license/upload 181 POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 10
DELETE /migration_session/{id 194 POST /migration_session/{id}/pause 195 POST /migration_session/{id}/resume 196 POST /migration_session/{id}/sync 196 POST /migration_session/{id}/cutover 197 nas_server 198 GET /nas_server 198 POST /nas_server 198 GET /nas_server/{id 199 DELETE /nas_server - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 11
PATCH /nfs_export/{id 218 nfs_server 219 GET /nfs_server 219 POST /nfs_server 220 GET /nfs_server/{id 220 DELETE /nfs_server/{id 221 PATCH /nfs_server/{id 221 POST /nfs_server/{id}/join 222 POST /nfs_server/{id}/unjoin 223 node 223 GET /node 223 GET /node/{id 224 ntp 224 GET /ntp 225 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 12
POST /remote_syslog_server/{id}/test 238 remote_system 239 GET /remote_system 239 POST /remote_system 239 GET /remote_system/{id 240 DELETE /remote_system/{id 241 PATCH /remote_system/{id 242 POST /remote_system/{id}/verify 243 replication_rule 243 GET /replication_rule 243 POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 13
PATCH /service_user/{id 262 smb_server 263 GET /smb_server 263 POST /smb_server 264 GET /smb_server/{id 264 DELETE /smb_server/{id 265 PATCH /smb_server/{id 265 POST /smb_server/{id}/join 266 POST /smb_server/{id}/unjoin 267 smb_share 267 GET /smb_share 267 POST /smb_share 268 GET / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 14
POST /software_package/{id}/install 282 POST /software_package/{id}/puhc 283 storage_container 284 GET /storage_container 284 POST /storage_container 284 GET /storage_container/{id 285 DELETE /storage_container/{id 285 PATCH /storage_container/{id 286 POST /storage_container/{id}/mount 287 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 15
volume_group 304 GET /volume_group 304 POST /volume_group 304 GET /volume_group/{id 305 DELETE /volume_group/{id 305 PATCH /volume_group/{id 306 POST /volume_group/{id}/add_members 307 POST /volume_group/{id}/remove_members 307 POST /volume_group/{id}/snapshot 308 POST /volume_group/{id}/ - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 16
FileInterfaceRouteOperationalStatusEnum 324 FileLDAPAuthenticationTypeEnum 324 FileLDAPProtocolEnum 325 FileLDAPSchemaTypeEnum 325 FileQuotaStateEnum 325 FileSystemAccessPolicyEnum 325 FileSystemFolderRenamePolicyEnum 326 FileSystemLockingPolicyEnum 326 FileSystemSnapshotAccessTypeEnum 326 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 17
IpPurposeTypeEnum 341 IpVersionTypeEnum 342 JobPhaseEnum 343 JobStateEnum 343 LDAPAccountTypeEnum 343 LDAPProtocolEnum 343 LDAPServerTypeEnum 344 LocationHistoryReasonEnum 344 MessageSeverityEnum 344 MetricsEntityEnum 344 MetricsIntervalEnum 347 MigrationRecommendationActionStateEnum 347 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 18
ReplicationStateEnum 358 ResourceActionEnum 359 ResourceTypeEnum 359 SCStatusEnum 360 SMBShareOfflineAvailabilityEnum 360 SNMPAuthProtocolEnum 360 SNMPPrivacyProtocolEnum 361 SNMPSeverityEnum 361 SNMPVersionEnum 361 SasPortSpeedEnum 361 ScScheduleTypeEnum 362 ScSnapshotProfileTypeEnum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 19
VolumeBlockSizeEnum 372 VolumeImportableCriteriaEnum 372 VolumeStateEnum 374 VolumeStatusEnum 375 VolumeTypeEnum 375 WeekOfMonthEnum 375 X509CertificateServiceEnum 376 X509CertificateUsageTypeEnum 376 XtremIOCertaintyEnum 376 XtremIODurationUnitEnum 377 XtremIOObjectSeverityEnum 377 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 20
base_performance_metrics_by_fe_eth_port 405 base_performance_metrics_by_fe_eth_port_rollup 406 base_performance_metrics_by_fe_fc_node 408 base_performance_metrics_by_fe_fc_node_rollup 411 base_performance_metrics_by_fe_fc_port 416 base_performance_metrics_by_fe_fc_port_rollup 419 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 21
base_performance_metrics_file_by_node 487 base_performance_metrics_file_by_node_rollup 488 base_response 490 base_space_metrics_by_appliance 491 base_space_metrics_by_appliance_rollup 493 base_space_metrics_by_cluster 497 base_space_metrics_by_cluster_rollup 500 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 22
consistency_group_member_host_mapping 529 copy_metrics_by_appliance 530 copy_metrics_by_cluster 531 copy_metrics_by_remote_system 533 copy_metrics_by_vg 534 copy_metrics_by_volume 536 create_response 537 data_connection_instance 537 discovered_initiator_instance 538 dns_instance 538 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 23
file_ldap_modify 571 file_ndmp_create 573 file_ndmp_instance 573 file_ndmp_modify 573 file_nis_create 574 file_nis_instance 574 file_nis_modify 574 file_system_clone 575 file_system_clone_response 577 file_system_create 577 file_system_instance 579 file_system_modify 585 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 24
host_virtual_volume_mapping_instance 612 host_volume_mapping_instance 613 import_host_initiator_instance 613 import_host_system_create 614 import_host_system_instance 615 import_host_volume_instance 616 import_psgroup_instance 618 import_psgroup_schedule_instance 619 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 25
ip_port_modify 652 job_appliance_create_error_response 653 job_appliance_forecast_response 653 job_appliance_time_to_full_response 654 job_appliance_validate_create_response 655 job_cluster_create_error_response 655 job_cluster_forecast_response 656 job_cluster_time_to_full_response 656 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 26
local_user_create 677 local_user_instance 678 local_user_modify 679 location_history_instance 679 login_session_instance 680 maintenance_window_instance 680 maintenance_window_modify 681 member_certificate_instance 681 metrics_generate 683 metrics_generate_response 683 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 27
nfs_server_unjoin 720 node_instance 720 ntp_instance 720 ntp_modify 721 performance_metrics_by_appliance 721 performance_metrics_by_appliance_rollup 723 performance_metrics_by_cluster 726 performance_metrics_by_cluster_rollup 727 performance_metrics_by_fe_eth_node 730 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 28
sdnas_smb_v1_node_metrics_instance 808 sdnas_smb_v1_node_metrics_rollup 809 sdnas_smb_v2_client_metrics_instance 811 sdnas_smb_v2_client_metrics_rollup 813 sdnas_smb_v2_node_metrics_instance 815 sdnas_smb_v2_node_metrics_rollup 817 sdnas_smb_cache_metrics_instance 819 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 29
replication_start_failover_test 853 replication_stop_failover_test 853 role_instance 854 sas_port_instance 854 sc_profile_rule_instance 856 security_config_instance 857 security_config_modify 857 service_config_instance 858 service_config_modify 858 service_user_instance 858 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 30
space_metrics_by_vm 898 space_metrics_by_vm_rollup 899 space_metrics_by_volume 901 space_metrics_by_volume_family 902 space_metrics_by_volume_family_rollup 904 space_metrics_by_volume_rollup 906 storage_container_create 907 storage_container_delete 908 storage_container_instance 908 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 31
volume_group_restore 931 volume_group_restore_response 931 volume_group_snapshot 931 volume_group_snapshot_response 932 volume_instance 932 volume_modify 935 volume_refresh 936 volume_refresh_response 937 volume_restore 937 volume_restore_response 937 volume_snapshot 938 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 32
• GET /remote_support_contact/{id} • PATCH /remote_support_contact/{id} • GET /remote_syslog_server • POST /remote_syslog_server • DELETE /remote_syslog_server/{id} • GET /remote_syslog_server/{id} • PATCH /remote_syslog_server/{id} • POST /remote_syslog_server/{id}/test • POST /replication_session - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 33
• External_Replication_Iscsi in IpPurposeTypeEnum • performance_metrics_by_ip_port, performance_metrics_file_by_appliance, wear_metrics_by_drive_daily in MetricsEntityEnum performance_metrics_file_by_node, performance_metrics_file_by_cluster, • Migration_Start_Failed in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 34
• SNMPSeverityEnum • SNMPVersionEnum • SecurityProtocolModeEnum • SoftwareInstalledBuildFlavorEnum • SoftwareInstalledBuildTypeEnum • SoftwarePackageBuildFlavorEnum • SoftwarePackageBuildTypeEnum • TimeZoneEnum • VendorProviderStatusEnum • alert_instance::snmp_sent_timestamp • appliance_create • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 35
• base_performance_metrics_by_smb_node_rollup::max_total_bandwidth • base_performance_metrics_file_by_appliance • base_performance_metrics_file_by_appliance_rollup • base_performance_metrics_file_by_cluster • base_performance_metrics_file_by_cluster_rollup • base_performance_metrics_file_by_node • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 36
• base_space_metrics_by_cluster_rollup::last_shared_logical_used_file_system • base_space_metrics_by_cluster_rollup::last_shared_logical_used_vvol • base_space_metrics_by_cluster_rollup::max_logical_used_volume • base_space_metrics_by_cluster_rollup::max_logical_used_file_system • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 37
• file_tree_quota_modify::grace_period • hardware_instance::stale_state_l10n • host_instance::type_l10n • ip_pool_address_instance::name • job_appliance_create_error_response • job_appliance_validate_create_response • job_cluster_create_error_response • job_cluster_validate_create_response • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 38
• remote_support_contact_modify::phone • remote_syslog_server_create • remote_syslog_server_instance • remote_syslog_server_instance::protocol_type_l10n • remote_syslog_server_instance::encryption_l10n • remote_syslog_server_instance::status_l10n • remote_syslog_server_modify • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 39
• software_package_instance::build_flavor_l10n • software_package_instance::build_type_l10n • validate_create_issue • vasa_provider_credentials • vcenter_delete • vcenter_instance::vendor_provider_status_l10n • veth_port_instance::partner_id • virtual_machine_instance::vcenter_id • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 40
• vcenter_instance_uuid in virtual_machine_instance Added • snmp_sent_timestamp in alert_instance • drive_failure_tolerance_level in appliance_instance • drive_failure_tolerance_level_l10n in appliance_instance • read_bandwidth in base_performance_metrics_by_nfs • write_bandwidth in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 41
• last_shared_logical_used_vvol in base_space_metrics_by_appliance_rollup • max_logical_used_volume in base_space_metrics_by_appliance_rollup • max_logical_used_file_system in base_space_metrics_by_appliance_rollup • max_logical_used_vvol in base_space_metrics_by_appliance_rollup • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 42
• hardware_parent_id in eth_port_instance • stale_state in eth_port_instance • stale_state_l10n in eth_port_instance • hardware_parent in eth_port_instance • wwn_nvme in fc_port_instance • hardware_parent_id in fc_port_instance • protocols in fc_port_instance • stale_state in fc_port_instance • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 43
• first_name in remote_support_contact_instance • last_name in remote_support_contact_instance • email in remote_support_contact_instance • phone in remote_support_contact_instance • last_name in remote_support_contact_modify • first_name in remote_support_contact_modify • email in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 44
• build_id in software_installed_instance • build_flavor_l10n in software_installed_instance • build_type_l10n in software_installed_instance • build_version in software_package_instance • build_flavor in software_package_instance • build_type in software_package_instance • build_id in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 45
• PATCH /ldap_account/{id} • GET /ldap_domain • POST /ldap_domain • DELETE /ldap_domain/{id} • GET /ldap_domain/{id} • PATCH /ldap_domain/{id} • POST /ldap_domain/{id}/verify Enumeration values Added • LDAP_HTTP, Syslog_HTTP in X509CertificateServiceEnum Definitions Added • LDAPAccountTypeEnum • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 46
Paths Added • POST /import_session/{id}/enable_destination_volume • POST /import_session/{id}/start_copy • GET /import_xtremio • GET /import_xtremio/{id} • POST /import_xtremio/{id}/discover • GET /import_xtremio_consistency_group • GET /import_xtremio_consistency_group/{id} • POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 47
• XtremIOObjectSeverityEnum • XtremIOPlatformEnum • XtremIOScheduleStateEnum • XtremIOScheduleTypeEnum • XtremIOStateEnum • consistency_group_member_host_mapping • import_psgroup_instance::supported_import_type_l10n • import_session_enable_destination_volume • import_session_instance::type_l10n • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 48
Definition members Deprecated • state in job_instance • state_l10n in job_instance Added • supported_import_type in import_psgroup_instance • supported_import_type_l10n in import_psgroup_instance • type in import_session_create • host_ids in import_session_create • consistency_group_member_host_ids - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 49
• certainty_l10n in import_xtremio_volume_instance • importable_criteria_l10n in import_xtremio_volume_instance • import_xtremio in import_xtremio_volume_instance • import_xtremio_consistency_group in import_xtremio_volume_instance • phase in job_instance • phase_l10n in job_instance Resources - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 50
Responses HTTP Code 200 Description Success 404 Not Found Schema alert_instance error_response PATCH /alert/{id} Description Modify an alert. acknowledged_severity parameter, if included, will cause the request to fail when the alert's severity is higher than the acknowledged_severity - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 51
cluster has the appropriate number of unused IP addresses. Unused IP addresses for the Management and Storage Networks are required. In addition, PowerStore X appliances also require IP addresses for the vMotion Network. The required number of IP addresses for each network depends on the appliance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 52
Type Body Name body required Schema appliance_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response appliance_create_ error_response error_response POST /appliance/validate_create Description Validate the add appliance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 53
GET /appliance/{id} Description Query a specific appliance in a cluster. Parameters Type Path Name id required Description Unique identifier of the appliance. Responses HTTP Code 200 Description Success 404 Not found Consumes • application/json Produces • application/json DELETE / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 54
Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Consumes • application/json Produces • application/json PATCH /appliance/{id} Description Modify an appliance. Parameters Type Path Name id required Description Unique identifier of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 55
HTTP Code 422 Description Operation Failed Consumes • application/json Produces • application/json POST /appliance/{id}/forecast Description Forecast capacity usage for an appliance. Parameters Type Path Name id required Description Unique id of the appliance. Body body required Responses - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 56
Produces • application/json POST /appliance/{id}/time_to_full Description Returns information about when an appliance is forecast to reach 100% capacity usage. Parameters Type Path Name id required Description Unique id of the appliance. Schema string Body body required appliance_time_to_f - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 57
Description Query audit log entries. Responses HTTP Code Description 200 OK 206 Partial content of audit event instance objects Schema < audit_event_insta nce > array < audit_event_insta nce > array Produces • application/json bond Use this resource types to manage the configuration of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 58
CHAP mode is in disabled mode. GET /chap_config Description Query the list of (one) CHAP configuration settings objects. This resource type collection query does not support filtering, sorting or pagination. Responses 57 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 59
HTTP Code Description 200 Success 206 Partial content of chap config instance objects Schema < chap_config_insta nce > array < chap_config_insta nce > array GET /chap_config/{id} Description Query the CHAP configuration settings object. Parameters Type Path Name id required Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 60
cluster Manage clusters GET /cluster Description Query the details about the cluster. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code 200 Description Success Schema < cluster_instance > array 206 Partial content of cluster instance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 61
generated for any failed secondary appliance. Look for these alerts in the PowerStore Manager. Resolve issues on failed appliances before adding the appliances to creating a cluster asynchronously, wait for ~10 minutes until Job Service is initialized before querying the status of the running job. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 62
Description 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 any of the validations detected - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 63
HTTP Code 404 Description Not Found Produces • application/json PATCH /cluster/{id} Description Update properties of the cluster. Parameters Type Path Name id required Description Unique identifier of the cluster. Body body optional Responses HTTP Code 204 Description Success 400 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 64
POST /cluster/{id}/forecast Description Forecast capacity usage for the cluster. Parameters Type Path Name id required Description Unique id of the cluster. Body body required Schema string cluster_forecast Responses HTTP Code Description 200 Success 204 Success 400 Invalid Request - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 65
that are not associated with a host. GET /discovered_initiator Description Query connected initiators that are not associated with a host. This resource type collection query does not support filtering, sorting or pagination. Responses 64 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 66
HTTP Code Description 200 Success 206 Partial content of discovered initiator instance objects Produces • application/json dns Manage DNS and NTP settings for the cluster. GET /dns Description Query DNS settings for a cluster. Responses HTTP Code 200 Description Success 206 Partial - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 67
Type Path Name id required Description Unique identifier of the DNS setting. Responses HTTP Code 200 Description Success 404 Not Found Consumes • application/json Produces • application/json PATCH /dns/{id} Description Modify a DNS setting. Parameters Type Path Name id required Body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 68
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response Consumes • application/json Produces • application/json email_notify_destination Use these resource types to configure outgoing SMTP and email notifications. GET /email_notify_destination - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 69
Parameters Type Body Name body required Description Email address to receive notifications. Schema email_notify_destina tion_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 70
Parameters Type Path Name id required Description Schema Unique identifier of the email notification string destination. Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /email_notify_destination/{id} - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 71
POST /email_notify_destination/{id}/test Description Send a test email to an email address. Parameters Type Path Name id required Description Schema Unique identifier destination. of the email notification string Responses HTTP Code 204 Description Success 400 Invalid request 404 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 72
default, the partner port speed on the other node in the appliance is set to the same requested speed. If the requested speed is not supported by the partner port it is left unchanged. Parameters Type Path Name id required Description Unique identifier of the port. Schema string 71 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 73
Type Body Name body required Description Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed event Use these resource types to manage events and alerts in the system. GET /event Description Returns all events in the database. Responses - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 74
Parameters Type Path Name id required Description Event Id Responses HTTP Code 200 Description Event Object 404 Not Found Schema string Schema event_instance error_response fc_port Use this resource type to retrieve information about Fibre Channel (FC) front-end ports and to set their - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 75
default, the partner port speed on the other node in the appliance is set to the same requested speed. If the requested speed is not supported by the partner port, it is left unchanged. Parameters Type Path Name id required Description Unique identifier of the FC front-end port. Schema string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 76
HTTP Code 422 Description Operation Failed Schema error_response file_dns Use these resources to configure the Domain Name System (DNS) settings for a NAS server. One DNS settings object may be configured per NAS server. A DNS is a hierarchical system responsible for converting domain names to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 77
Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed GET /file_dns/{id} Description Query a specific DNS settings object of a NAS Server. Parameters Type Path Name id required Description Unique identifier of the DNS object. Responses HTTP Code 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 78
(FTP) server per NAS server. One FTP server can be configured per NAS server to have both secure and unsecure services running. By default when an FTP server is created, the unsecure service will be running. FTP is a standard network protocol used to transfer files from one host to another host over - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 79
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 REST API Reference Guide - Page 80
HTTP Code 422 Description Operation Failed Schema error_response GET /file_ftp/{id} Description Query a specific FTP/SFTP server for its settings. Parameters Type Path Name id required Description Schema Unique identifier of the FTP/SFTP Server object. string Responses HTTP Code 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 81
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response PATCH /file_ftp/{id} Description Modify an FTP/SFTP server settings. Parameters Type Path Name id required Description Schema Unique identifier of the FTP/SFTP Server object. string Body body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 82
Responses HTTP Code Description 200 Success 206 Partial content of file interface instance objects Schema < file_interface_inst ance > array < file_interface_inst ance > array POST /file_interface Description Create a file interface. Parameters Type Body Name body required Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 83
Responses HTTP Code 200 Description Success 404 Not Found DELETE /file_interface/{id} Description Delete a file interface. Parameters Type Path Name id required Description Unique identifier of the file interface. Responses HTTP Code 204 Description Success 404 Not Found 422 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 84
Type Body Name body required Description Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema file_interface_modif y Schema No Content error_response error_response error_response file_interface_route Use this resource type to manage - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 85
HTTP Code Description 206 Partial content of file interface route instance objects Schema < file_interface_rout e_instance > array POST /file_interface_route Description Create and configure a new file interface route. There are three types of routes - Subnet, Default, and Host. • A default - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 86
Parameters Type Path Name id required Description Schema Unique identifier of the file interface route string object. Responses HTTP Code Description 200 Success 404 Not Found Schema file_interface_rout e_instance error_response DELETE /file_interface_route/{id} Description Delete - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 87
NAS Server uses the RPCSEC_GSS security framework and Kerberos authentication protocol to verify users and services. You can configure a secure NFS environment for a multiprotocol NAS Server or one that supports Unix-only shares. In this environment, user access to NFS file systems is granted based - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 88
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /file_kerberos/{id} Description Query a specific Kerberos service settings of a NAS Server. Parameters Type Path Name id required Description Kerberos - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 89
Kerberos configuration of a NAS Server. Parameters Type Path Name id required Description Schema Unique identifier of the Kerberos service object. string Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 90
file can be generated using the KDC server. Parameters Type Path Name id required Description Schema Unique identifier of the Kerberos service object. string FormDat body a optional file Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found Schema No Content - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 91
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 REST API Reference Guide - Page 92
object can be created per NAS Server. Parameters Type Body Name body required Description Name of the LDAP service to create. Schema file_ldap_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 93
GET /file_ldap/{id} Description Query a specific NAS Server's LDAP settings object. Parameters Type Path Name id required Description Unique identifier of the LDAP settings object. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema file_ldap_instance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 94
PATCH /file_ldap/{id} Description Modify a NAS Server's LDAP settings object. Parameters Type Path Name id required Description Schema Unique identifier of the LDAP settings object id. string Body body required file_ldap_modify Responses HTTP Code 204 Description Success 400 Invalid - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 95
HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Consumes • multipart/form-data GET /file_ldap/{id}/download_config Parameters Type Path Name id required Description Unique identifier - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 96
Type Path Name id required FormDat body a required Description Unique identifier of the LDAP settings object. Schema string file Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 97
monitored local backup operations. Storage systems support NDMP v2-v4 over the network. Direct-attach NDMP is not supported. This means that the tape security information. GET /file_ndmp Description Query configured NDMP service instances. Responses HTTP Code Description 200 Success Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 98
string Responses HTTP Code 200 Description Success 404 Not Found Schema file_ndmp_instanc e error_response DELETE /file_ndmp/{id} Description Delete an NDMP service configuration instance of a NAS Server. Parameters Type Path Name id required Description Unique identifier of the NDMP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 99
404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response 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 REST API Reference Guide - Page 100
Success. 206 Partial content of file nis instance objects Schema < file_nis_instance > array < file_nis_instance > array POST /file_nis Description Create a new NIS Service on a NAS Server. Only one NIS Setting object can be created per NAS Server. Parameters Type Body Name body required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 101
Parameters Type Path Name id required Description Unique identifier of the NIS object. Responses HTTP Code 200 Description Success 404 Not Found DELETE /file_nis/{id} Description Delete NIS settings of a NAS Server. Parameters Type Path Name id required Description Unique identifier of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 102
Parameters Type Path Name id required Body body required Description Unique identifier of the NIS object. Responses HTTP Code 204 Description Success. 400 Invalid Request 404 Not Found 422 Operation Failed file_system Use this resource type to manage NAS file systems. GET / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 103
POST /file_system Description Create a file system. Parameters Type Body Name body required Schema file_system_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /file_system/{id} - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 104
DELETE /file_system/{id} Description Delete a file system. Parameters Type Path Name id required Description Unique identifier of the file system. Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed PATCH /file_system/{id} Description Modify a file system. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 105
HTTP Code 400 Description Invalid Request 404 Not Found 422 Operation Failed POST /file_system/{id}/clone Description Create a clone of a file system. Parameters Type Path Name id required Description Unique identifier of the file system. Body body required Responses HTTP Code 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 106
Parameters Type Path Name id required Body body optional Description Unique identifier of the file system. Schema string file_system_snapsho t Responses HTTP Code 200 Description Success 204 Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema file_system_snaps - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 107
HTTP Code 400 Description Invalid request 404 Not Found 422 Operation Failed Schema error_response error_response error_response POST /file_system/{id}/restore Description Restore from a snapshot of a file system. Success responses indicates the following: 200 Success with backup snapshot. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 108
POST /file_system/{id}/refresh_quota Description Refresh the actual content of tree and user quotas objects. Parameters Type Path Name id required Description Unique identifier of the file system. Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 109
HTTP Code Description 206 Partial content of file tree quota instance objects Schema < file_tree_quota_in stance > array POST /file_tree_quota Description Create a tree quota instance. Parameters Type Body Name body required Schema file_tree_quota_create Responses HTTP Code 201 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 110
HTTP Code 200 Description Success 404 Not Found DELETE /file_tree_quota/{id} Description Delete a tree quota instance. Parameters Type Path Name id required Description Unique identifier of the tree quota. Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 111
Type Body Name body required Description Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed POST /file_tree_quota/{id}/refresh Description Refresh the cache with the actual value of the tree quota. Parameters Type Path Name id required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 112
file_user_quota User quota settings in the storage system. A user quota instance represents a quota limit applied to a user within a quota tree or a filesystem. GET /file_user_quota Description List user quota instances. Responses HTTP Code Description 200 Success Schema < file_user_quota_in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 113
GET /file_user_quota/{id} Description Query a user quota instance. Parameters Type Path Name id required Description Unique identifier of the file user quota. Responses HTTP Code 200 Description Success 404 Not Found PATCH /file_user_quota/{id} Description Modify a user quota instance. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 114
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 REST API Reference Guide - Page 115
GET /file_virus_checker Description Query all virus checker settings of the NAS Servers. Responses HTTP Code Description 200 Success 206 Partial content of file virus checker instance objects Schema < file_virus_checker _instance > array < file_virus_checker _instance > array POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 116
GET /file_virus_checker/{id} Description Query a specific virus checker setting of a NAS Server. Parameters Type Path Name id required Description Schema Unique identifier of the virus checker instance. string Responses HTTP Code 200 Description Success 404 Not Found Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 117
PATCH /file_virus_checker/{id} Description Modify the virus checker settings of a NAS Server. Parameters Type Path Name id required Description Schema Unique identifier of the virus checker instance. string Body body required file_virus_checker_ modify Responses HTTP Code 204 Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 118
Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Consumes • multipart/form-data GET /file_virus_checker/{id}/download_config Description Download a virus checker configuration - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 119
hardware This provides the hardware component inventory of the system. GET /hardware Description Query hardware components Responses HTTP Code Description 200 Success 206 Partial content of hardware instance objects Produces • application/json GET /hardware/{id} Description Get a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 120
HTTP Code 404 Description Not Found Produces • application/json PATCH /hardware/{id} Description Modify a hardware instance. Parameters Type Path Name id required Description The hardware component to modify. Body body required Responses HTTP Code 204 Description Success 400 Invalid - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 121
POST /hardware/{id}/drive_repurpose Description A drive that has been used in a different appliance will be locked for use only in that appliance. This operation will allow a locked drive to be used in the current appliance. All data on the drive will become unrecoverable. It will fail if the drive - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 122
Responses HTTP Code 200 Description Success 206 Partial content of host instance objects Produces • application/json POST /host Description Add a host. Parameters Type Body Name body required Responses HTTP Code 201 Description Success 400 Invalid request 422 Operation Failed - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 123
GET /host/{id} Description Query details about a specific host. Parameters Type Path Name id required Description Unique identifier of the host. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema host_instance error_response Produces • application/json - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 124
error_response Produces • application/json PATCH /host/{id} Description Modify a host. Only one of add, remove and update initiator operations are supported in a single request. Parameters Type Path Name id required Description Unique identifier of the host. Schema string Body body required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 125
Produces • application/json POST /host/{id}/attach Description Attach host to volume. Parameters Type Path Name id required Description Unique identifier of the host. Body body required Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 126
Type Path Body Name id required body required Description Unique identifier of the host. Schema string host_detach Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Produces - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 127
HTTP Code Description 206 Partial content of host group instance objects Schema < host_group_instan ce > array Produces • application/json POST /host_group Description Create a host group. Parameters Type Body Name body required Schema host_group_create Responses HTTP Code 201 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 128
Parameters Type Path Name id required Description Unique identifier of the host group. Responses HTTP Code Description 200 Success 404 Not Found Produces • application/json DELETE /host_group/{id} Description Delete a host group. Delete fails if host group is attached to a volume. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 129
Produces • application/json PATCH /host_group/{id} Description Modify a host group. Modify does not support rename and add/modify at the same time. Parameters Type Path Name id required Description Unique identifier of the host group. Schema string Body body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 130
Type Path Body Name id required body required Description Unique identifier of the host group. Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Produces • application/json POST /host_group/{id}/detach Description Detach host group from - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 131
HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Produces • application/json host_virtual_volume_mapping Virtual volume mapping details. GET /host_virtual_volume_mapping Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 132
Parameters Type Path Name id required Description Schema Unique identifier of the virtual volume string mapping. Responses HTTP Code Description 200 Success 404 Not Found Schema host_virtual_volu me_mapping_inst ance error_response host_volume_mapping Storage cluster REST API - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 133
Description Query a specific host volume mapping. Parameters Type Path Name id required Description Schema Unique identifier of the host volume mapping. string Responses HTTP Code 200 Description Success 404 Not Found Schema host_volume_map ping_instance error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 134
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 REST API Reference Guide - Page 135
HTTP Code Description 200 Success 206 Partial content of import host system instance objects Schema < import_host_syste m_instance > array < import_host_syste m_instance > array POST /import_host_system Description Add an import host system so that it can be mapped to a volume. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 136
Parameters Type Path Name id required Description Schema Unique identifier of the import host system to string query. Responses HTTP Code Description 200 Success 404 Not Found Schema import_host_syste m_instance error_response DELETE /import_host_system/{id} Description Delete an - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 137
import host or import host volumes. Parameters Type Path Name id required Description Schema Unique identifier of the import host system for string which to refresh details. Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 138
Not Found Schema import_host_volu me_instance error_response import_psgroup Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. GET /import_psgroup Description Query PS Group storage arrays. Responses 137 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 139
HTTP Code Description 200 Success 206 Partial content of import psgroup instance objects Schema < import_psgroup_i nstance > array < import_psgroup_i nstance > array GET /import_psgroup/{id} Description Query a specific PS Group storage array. Parameters Type Path Name id required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 140
Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. GET /import_psgroup_volume Description Query PS Group volumes. Responses HTTP Code Description 200 Success Schema < import_psgroup_v olume_instance > array 206 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 141
Parameters Type Path Name id required Description Unique identifier of the PS Group volume. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema import_psgroup_v olume_instance error_response POST /import_psgroup_volume/{id}/import_snapshot_schedules - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 142
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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 143
Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /import_session/{id} Description Query a specific session. Parameters Type Path Name id required Description Unique identifier of the import - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 144
Type Path Name id required Description Unique identifier of the import session Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed PATCH /import_session/{id} Description Modify the scheduled date and time of the specified import session. Parameters Type Path - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 145
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 REST API Reference Guide - Page 146
Description 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. Parameters Type Path Name id required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 147
HTTP Code 422 Description Operation Failed Schema error_response POST /import_session/{id}/resume Description Resumes the paused import session. The background data copy continues from where it was stopped. Resume is only applicable when the import in a Paused state. Parameters Type Path Name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 148
Type Path Name id required Body body optional Description Unique identifier of the import session. Schema string Parameters to enable destination volume of an import_session_enab le_destination_volu agentless import session. me Responses HTTP Code 204 Description Success 400 Invalid - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 149
No Content error_response error_response error_response import_storage_center Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore. GET /import_storage_center Description Query SC arrays. 148 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 150
Responses HTTP Code Description 200 Success 206 Partial content of import storage center instance objects Schema < import_storage_ce nter_instance > array < import_storage_ce nter_instance > array GET /import_storage_center/{id} Description Query a specific SC array. Parameters Type Path - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 151
resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore. GET /import_storage_center_consistency_group Description Query SC consistency groups. Responses HTTP Code Description 200 Success Schema < import_storage_ce nter_consistency_ - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 152
GET /import_storage_center_consistency_group/{id} Description Query a specific SC consistency group. Parameters Type Path Name id required Description Unique identifier of the SC consistency group. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 153
import_storage_center_volume Use these resource types to discover the Storage Center (SC) volumes that can be imported to PowerStore. GET /import_storage_center_volume Description Query SC volumes. Responses HTTP Code Description 200 Success Schema < import_storage_ce nter_volume_insta nce - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 154
Description Query a specific SC volume. Parameters Type Path Name id required Description Unique identifier of the SC volume. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema import_storage_ce nter_volume_insta nce error_response POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 155
HTTP Code 400 Description Invalid request 404 Not Found 422 Operation Failed. Schema error_response error_response error_response import_unity Use this resource type to discover the Unity system that is a source storage system for import GET /import_unity Description Query Unity storage - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 156
Operation Failed Schema No Content error_response error_response error_response import_unity_consistency_group Use this resource type to discover the Unity consistency groups that can be imported to PowerStore. GET /import_unity_consistency_group Description Query Unity consistency groups. 155 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 157
Responses HTTP Code Description 200 Success Schema < import_unity_cons istency_group_inst ance > array < 206 Partial content of import unity consistency group instance objects import_unity_cons istency_group_inst ance > array GET /import_unity_consistency_group/{id} Description Query a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 158
error_response error_response import_unity_volume Use this resource type to discover the Unity volumes that can be imported to PowerStore. GET /import_unity_volume Description Query Unity volumes. Responses HTTP Code Description 200 Success Schema < import_unity_volu me_instance > array - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 159
HTTP Code Description 206 Partial content of import unity volume instance objects Schema < import_unity_volu me_instance > array GET /import_unity_volume/{id} Description Query a specific Unity volume. Parameters Type Path Name id required Description Unique identifier of the Unity volume. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 160
error_response error_response import_vnx_array Use these resource types to discover the VNX storage system that can be imported to PowerStore. GET /import_vnx_array Description Query VNX storage systems. Responses HTTP Code Description 200 Success Schema < import_vnx_array _instance > array - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 161
422 Operation Failed Schema No Content error_response error_response error_response import_vnx_consistency_group Use this resource type to show the VNX consistency groups that can be imported to PowerStore. 160 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 162
GET /import_vnx_consistency_group Description Query VNX consistency groups. Responses HTTP Code Description 200 Success 206 Partial content of import vnx consistency group instance objects Schema < import_vnx_consis tency_group_insta nce > array < import_vnx_consis tency_group_insta nce > - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 163
import_vnx_volume Use this resource type to show the VNX volumes and that can be imported to PowerStore. GET /import_vnx_volume Description Query VNX volumes. Responses HTTP Code Description 200 Success Schema < import_vnx_volu me_instance > array 206 Partial content of import vnx volume - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 164
import_xtremio Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. GET /import_xtremio Description Query XtremIO storage systems X1 and X2. Was added in version 1.0.2. Responses HTTP Code Description 200 Success Schema < - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 165
Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. GET /import_xtremio_consistency_group Description Query XtremIO consistency groups. Was added in version 1.0.2. Responses HTTP Code Description 200 Success - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 166
HTTP Code 206 Description Schema < Partial content of import xtremio consistency group instance objects import_xtremio_c onsistency_group_ instance > array GET /import_xtremio_consistency_group/{id} Description Query a specific XtremIO consistency group. Was added in version 1.0.2. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 167
import_xtremio_volume Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. GET /import_xtremio_volume Description Query XtremIO volumes. Was added in version 1.0.2. Responses HTTP Code Description 200 Success Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 168
GET /import_xtremio_volume/{id} Description Query a specific XtremIO volume. Was added in version 1.0.2. Parameters Type Path Name id required Description Unique identifier of the XtremIO volume. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 169
HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response ip_pool_address Use these resource types to scale and reconfigure the IP networks in a cluster. GET /ip_pool_address Description Query - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 170
Responses HTTP Code 200 Description Success 404 Not Found Schema ip_pool_address_i nstance error_response Consumes • application/json Produces • application/json ip_port Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 171
Parameters Type Path Name id required Description Unique identifier of the IP port. Responses HTTP Code 200 Description Success 404 Not Found Consumes • application/json Produces • application/json PATCH /ip_port/{id} Description Modify IP port parameters. Parameters Type Path Name id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 172
HTTP Code 400 Description Invalid Request 404 Not Found 422 Operation Failed Consumes • application/json Produces • application/json job Use this resource type for tracking an operation's progress and status. GET /job Description Query jobs. Responses HTTP Code 200 Description Success - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 173
file. This request is valid only on systems where Data at Rest Encryption is enabled and is applicable only on systems that support Data at Rest Encryption. Responses HTTP Code Description 200 Success Schema keystore_archive_ regenerate_respon se 204 Success No Content 400 Invalid request - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 174
POST command. This resource type collection query does not support filtering, sorting or pagination. Parameters Type Path Name filename LDAP users or groups in LDAP server to administrative roles on the PowerStore array. GET /ldap_account Description Query LDAP account instances. Was added in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 175
not support filtering, sorting or pagination. Responses HTTP Code Description 200 Success 206 Partial content of ldap account instance objects Schema < ldap_account_inst ance > array < ldap_account_inst ance > array - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 176
Parameters Type Path Name id required Description Unique identifier of the LDAP account. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema ldap_account_inst ance error_response DELETE /ldap_account/{id} Description Delete an LDAP account. Was added in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 177
. GET /ldap_domain Description Query list of LDAP domain. Was added in version 1.0.3. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description 200 Success Schema < ldap_domain_inst ance > array 206 Partial content of ldap - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 178
POST /ldap_domain Description Create a new LDAP domain. Was added in version 1.0.3. Parameters Type Body Name body required Schema ldap_domain_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 179
DELETE /ldap_domain/{id} Description Delete an LDAP domain. Was added in version 1.0.3. Parameters Type Path Name id required Description Schema Unique identifier deleted. of the LDAP domain to be string Responses HTTP Code 204 Description Success 404 Not Found 422 Operation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 180
HTTP Code 400 Description Invalid Request 404 Not Found 422 Operation Failed Schema error_response error_response error_response POST /ldap_domain/{id}/verify Description verifying the connectivity to the LDAP domain server. Was added in version 1.0.3. Parameters Type Path Name id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 181
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 REST API Reference Guide - Page 182
DellEMC Software Licensing Central. 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. Responses 181 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 183
local user accounts. GET /local_user Description Query all local user account instances. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description 200 Success Schema < local_user_instanc e > array 206 Partial content of local user - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 184
Type Body Name body required Schema local_user_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /local_user/{id} Description Query a specific local user account instance using an unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 185
Parameters Type Path Name id required Description Schema Unique identifier of the local user account to be string deleted. Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /local_user/{id} Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 186
configurations. GET /login_session Description Obtain the login session for the current user. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description 200 Success Schema < login_session_inst ance > array 206 Partial content of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 187
HTTP Code 201 Description Success 204 Success 400 Invalid request 422 Operation Failed Schema create_response No Content error_response error_response Produces • application/json maintenance_window Use this resource type to manage the maintenance window configuration for each appliance. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 188
GET /maintenance_window/{id} Description Query one appliance maintenance window configuration. Parameters Type Path Name id required Description Schema Unique identifier configuration. of the maintenance window string Responses HTTP Code 200 Description Success 404 Not Found Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 189
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response metrics REST APIs Use these resource types to query historical metric data. POST /metrics/generate Description Retrieves metrics for specified type. Parameters Type Body Name body required Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 190
usage and recent performance. A recommendation can then be implemented using the create_migration_sessions action, performing any necessary rescans on attached hosts, and then using start_migration_sessions. GET /migration_recommendation Description Get migration recommendations. Responses HTTP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 191
HTTP Code 422 Description Invalid Request Schema error_response GET /migration_recommendation/{id} Description Get a single migration recommendation. Parameters Type Path Name id required Description Unique ID of the migration recommendation. Schema string Responses HTTP Code Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 192
HTTP Code 204 Description Success 404 Not Found 422 Invalid Request Schema No Content error_response error_response PATCH /migration_recommendation/{id} Description Modify migration actions by applying specified dst appliance id and active flag to the migration actions specified by resource - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 193
Description 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 migration completes. Parameters Type Path Name id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 194
created in this phase and no background copy is performed until either the sync or cutover operation is invoked. There are no interruptions to any services during this phase. Parameters 193 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 195
Type Body Name body required Description Parameters to create a migration session. Schema migration_session_c reate Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema migration_session _create_response error_response error_response Produces • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 196
Description Delete a migration session. With the force option, a migration session can be deleted regardless of its state. All background activity is canceled before deleting the session. Parameters Type Path Name id required Description Unique identifier of the migration session. Schema string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 197
/{id}/sync Description Synchronize a migration session. During this phase, 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 be copied during the cutover. Parameters 196 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 198
Type Path Body Name id required body required Description Unique identifier of the migration session. Schema string Parameters for synchronizing a migration migration_session_s session. ync Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 199
HTTP Code 422 Description Operation Failed Schema error_response nas_server Use these resource types to manage NAS servers. NAS servers are software components used to transfer data and provide the connection ports for hosts to access file-based storage resources. NAS servers are independent from - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 200
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed GET /nas_server/{id} Description Query a specific NAS server. Parameters Type Path Name id required Description Unique identifier of the NAS server. Responses HTTP Code 200 Description Success 404 Not Found - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 201
Type Body Name body optional Description Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed PATCH /nas_server/{id} Description Modify the settings of a NAS server. Parameters Type Path Name id required Description Unique identifier of the NAS server. Body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 202
POST /nas_server/{id}/ping Description Ping destination from NAS server. Parameters Type Path Name id required Description Unique identifier of the NAS server. Body body required Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 203
Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Consumes • multipart/form-data GET /nas_server/{id}/download/passwd Description Download a NAS server passwd file containing - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 204
POST /nas_server/{id}/upload/hosts Description Upload NAS server host file. Parameters Type Path Name id required Description Unique identifier of the NAS server. FormDat body a optional Upload NAS server host file. Schema string file Responses HTTP Code 204 Description Success 400 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 205
Responses HTTP Code 200 Description Success 404 Not Found 422 Operation Failed Produces • document/text POST /nas_server/{id}/upload/group Description Upload NAS server group file. Parameters Type Path Name id required Description Unique identifier of the NAS server. FormDat body a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 206
GET /nas_server/{id}/download/group Description Download a NAS server group file containing the template or the actual (if already uploaded) group details. Parameters Type Path Name id required Description Unique identifier of the NAS server. Schema string Responses HTTP Code 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 207
HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Consumes • multipart/form-data GET /nas_server/{id}/download/netgroup Description Download an NAS server netgroup file containing the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 208
Description Upload the NAS server nsswitch file. Parameters Type Path Name id required Description Unique identifier of the NAS server. FormDat body a optional Upload the NAS server nsswitch file. Schema string file Responses HTTP Code 204 Description Success 400 Invalid request 404 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 209
HTTP Code 200 Description Success 404 Not Found 422 Operation Failed Produces • document/text POST /nas_server/{id}/upload/homedir Description Upload the NAS server homedir file. Parameters Type Path Name id required Description Unique identifier of the NAS server. FormDat body a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 210
GET /nas_server/{id}/download/homedir Description Download a NAS server homedir file containing the template or the actual (if already uploaded) homedir configuration settings. Parameters Type Path Name id required Description Unique identifier of the NAS server. Schema string Responses HTTP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 211
HTTP Code 400 Description Invalid request 404 Not Found 422 Operation Failed Schema error_response error_response error_response Consumes • multipart/form-data GET /nas_server/{id}/download/ntxmap Description Download an NAS server ntxmap file containing the template or the actual (if - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 212
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 the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 213
HTTP Code 422 Description Operation Failed Schema error_response Produces • document/text network Use these resource types to scale and reconfigure the IP networks in a cluster. GET /network Description Query the IP network configurations of the cluster. Responses HTTP Code Description 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 214
Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed GET /network/{id} Description Query a specific IP network configuration. Parameters Type Path Name id required Description Unique identifier of the IP network. Responses HTTP Code 200 Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 215
Parameters Type Path Name id required Description Unique identifier of the network. Schema string Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /network/{id} Description Modify IP network parameters, - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 216
Consumes • application/json Produces • application/json POST /network/{id}/replace Description Reconfigure cluster management network settings from IPv4 to IPv6 or vice versa. Parameters Type Path Name id required Description Unique identifier of the IP network. Schema string Body body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 217
Description • Add IP ports for use by the storage network, or remove IP ports so they can no longer be used. • At least one IP port must be configured for use by the storage network. Parameters Type Path Name id required Description Unique identifier of the IP network. Schema string Body body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 218
Responses HTTP Code Description 200 Success 206 Partial content of nfs export instance objects Schema < nfs_export_instan ce > array < nfs_export_instan ce > array POST /nfs_export Description Create an NFS Export for a Snapshot. Parameters Type Body Name body required Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 219
Type Path Name id required Description NFS Export object id. Responses HTTP Code 200 Description Success 404 Not Found DELETE /nfs_export/{id} Description Delete NFS Export. Parameters Type Path Name id required Description NFS Export object id. Responses HTTP Code 204 Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 220
. 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 REST API Reference Guide - Page 221
HTTP Code Description 206 Partial content of nfs server instance objects Schema < nfs_server_instanc e > array POST /nfs_server Description Create an NFS server. Parameters Type Body Name body required Schema nfs_server_create Responses HTTP Code 201 Description Created 400 Invalid - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 222
HTTP Code 200 Description Success 404 Not Found DELETE /nfs_server/{id} Description Delete an NFS server. Parameters Type Path Name id required Description Unique identifier of the NFS server. Body body optional Responses HTTP Code 204 Description Success 404 Not Found 422 Operation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 223
Type Path Body Name id required body required Description Unique identifier of the NFS server. Schema string nfs_server_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 224
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response POST /nfs_server/{id}/unjoin Description Unjoin the secure NFS server from the NAS server's Active Directory domain. If you unjoin with secure NFS exports active, exports will be unavailable to the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 225
Responses HTTP Code 200 Description Success 206 Partial content of node instance objects GET /node/{id} Description Query a specific node in a cluster. Parameters Type Path Name id required Description Unique identifier of the node. Responses HTTP Code 200 Description Success 404 Not - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 226
GET /ntp Description Query NTP settings for a cluster. Responses HTTP Code 200 Description Success 206 Partial content of ntp instance objects GET /ntp/{id} Description Query a specific NTP setting. Parameters Type Path Name id required Description Unique identifier of the NTP setting. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 227
Type Path Body Name id required body required Description Unique identifier of the NTP setting. Schema string ntp_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 228
HTTP Code Description 200 OK 206 Partial content of performance rule instance objects Produces • application/json GET /performance_rule/{id} Description Get a performance rule by id. Parameters Type Path Name id required Description Performance Rule id. Responses HTTP Code 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 229
GET /physical_switch Description Query physical switches settings for a cluster. Responses HTTP Code Description 200 Success 206 Partial content of physical switch instance objects Schema < physical_switch_i nstance > array < physical_switch_i nstance > array POST /physical_switch - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 230
Description Query a specific physical switch settings. Parameters Type Path Name id required Description Schema Unique identifier of the physical switch settings. string Responses HTTP Code 200 Description Success 404 Not Found Schema physical_switch_i nstance error_response DELETE / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 231
PATCH /physical_switch/{id} Description Modify a physical switch settings. Parameters Type Path Name id required Description Schema Unique identifier of the physical switch settings. string Body body optional physical_switch_mo dify Responses HTTP Code 204 Description Success 400 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 232
snapshot_rules(id,name,interval,time_of_day,days_of_week),volume(id,name),volume_group(id,na me)&type=eq.Protection The following REST query is an example of how to retrieve performance policies along with their associated resources: https://{{cluster_ip}}/api/rest/policy?select=name,id,type,volume( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 233
HTTP Code 422 Description Operation Failed Schema error_response GET /policy/{id} Description Query a specific policy. Parameters Type Path Name id required Description Unique identifier of the policy. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 234
policy_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response remote_support_contact Manage remote support contact. GET /remote_support_contact 233 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 235
pagination. Responses HTTP Code Description 200 Success Schema < remote_support_c ontact_instance > array 206 Partial content of remote support contact instance objects < remote_support_c ontact_instance > array GET /remote_support_contact/{id} Description Query to get the current remote - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 236
Description Schema The unique id of the remote_support_contact string instance. Was added in version 2.0.0.0. Body body required Remote support contact modify parameters. remote_support_con tact_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 237
HTTP Code Description 206 Partial content of remote syslog server instance objects Schema < remote_syslog_ser ver_instance > array POST /remote_syslog_server Description Create a remote_syslog_server object. Was added in version 2.0.0.0. Parameters Type Body Name body required Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 238
Responses HTTP Code 200 Description Success 404 Not Found Schema remote_syslog_ser ver_instance error_response DELETE /remote_syslog_server/{id} Description Delete a remote_syslog_server object. Was added in version 2.0.0.0. Parameters Type Path Name id required Description Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 239
Type Body Name body required Description Schema remote_syslog_serve r_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response POST /remote_syslog_server/{id}/test - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 240
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 REST API Reference Guide - Page 241
systems. For non-PowerStore remote system relationships, include the following parameters: • Management address - Either an IPv4 or IPv6 address. FQDN is not supported. • Type of remote system • Name • Description • Remote administrator credentials • iSCSI address - IPv4 address • CHAP mode - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 242
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. Parameters Type Path Name id required Description Unique identifier of the remote system. Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 243
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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 244
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response POST /remote_system/{id}/verify Description Verify and update the remote system instance. Detects changes in the local and remote systems and reestablishes data connections, also taking the Challenge - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 245
Description Query all replication rules. Responses HTTP Code Description 200 Success 206 Partial content of replication rule instance objects Schema < replication_rule_i nstance > array < replication_rule_i nstance > array POST /replication_rule Description Create a new replication rule. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 246
Parameters Type Path Name id required Description Unique identifier of the replication rule. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema replication_rule_i nstance error_response DELETE /replication_rule/{id} Description Delete a replication rule. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 247
Description Modify a replication rule. If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to the associated storage resource. Changing the remote_system_id is not permitted, if the rule is part of a policy that is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 248
In addition to copying data, the replication session synchronizes configuration changes on source resource and replicates user and scheduled snapshots to destination system. Replication sessions provide disaster recovery failover, reprotect and failback capabilities. As a result: • The downtime- - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 249
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 REST API Reference Guide - Page 250
Parameters Type Path Name id required Description Unique identifier of the replication session. Schema string Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 251
• Planned Failover The following operations are allowed while only the replication session on the local system is 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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 252
• 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 following system operations may also pause, and subsequently resume, a replication session. • - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 253
planned failover: • Unplanned failover • Delete the replication session by removing the protection policy on the storage resource After a planned failover, the replication session is in an inactive state. You can use the reprotect action to synchronize the destination storage resource, and then - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 254
POST /replication_session/{id}/reprotect Description Reprotect a replication session instance. Activates the replication session and starts synchronization. This can only be used when the session is in the has been failed over. Parameters Type Path Name id required Description Unique identifier - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 255
This operation is not allowed when a test failover is already in progress on the replication session or if the session is in the following states: • Planned_Failover_In_Progress • DR_Failover_In_Progress • Failed_Over • Paused_For_NDU • Paused_For_Migration During the test, the following - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 256
role Use these resource types to manage sessions, roles, and system security configurations. GET /role Description Query roles. This resource type collection query does not support filtering, sorting or pagination. Responses 255 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 257
HTTP Code 200 Description Success 206 Partial content of role instance objects Produces • application/json GET /role/{id} Description Query a specific role. Parameters Type Path Name id required Description Unique identifier of the role. Responses HTTP Code 200 Description Success 404 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 258
Description Query the SAS port configuration for all cluster nodes. Responses HTTP Code Description 200 Success 206 Partial content of sas port instance objects GET /sas_port/{id} Description Query a specific SAS port configuration. Parameters Type Path Name id required Description - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 259
Description Query system security configurations. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description 200 Success Schema < security_config_in stance > array 206 Partial content of security config instance objects < - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 260
' - Manage the ability for the service user to remotely connect to the nodes in an appliance using SSH. GET /service_config Description Query the service configuration instances for the cluster. This resource type collection query does not support filtering, sorting or pagination. Responses 259 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 261
of the instance. Responses HTTP Code 200 Description Success 404 Not Found PATCH /service_config/{id} Description Modify the service configuration for an appliance. Parameters Type Path Name id required Description Unique identifier of the instance. 260 Schema < service_config_ins - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 262
enabled or disabled using the service_config modify operation. GET /service_user Description Query the service user account instance. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description 200 Success Schema < service_user_insta - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 263
. Responses HTTP Code 200 Description Success 404 Not Found Produces • application/json PATCH /service_user/{id} Description Modify the properties of the service user account. Parameters Schema < service_user_insta nce > array Schema string Schema service_user_insta nce error_response 262 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 264
required body required Description Unique identifier of the service user account. Schema string service_user_modify Responses HTTP Code Most usage of SMB involves computers running Microsoft Windows, but it is commonly supported on other types of systems as well. SMB was formerly known as Common - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 265
HTTP Code Description 200 Success 206 Partial content of smb server instance objects Schema < smb_server_insta nce > array < smb_server_insta nce > array POST /smb_server Description Create an SMB server. Parameters Type Body Name body required Schema smb_server_create Responses HTTP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 266
Responses HTTP Code 200 Description Success 404 Not Found Schema smb_server_insta nce error_response DELETE /smb_server/{id} Description Delete a SMB server. The SMB server must not be joined to a domain to be deleted. Parameters Type Path Name id required Description Unique identifier of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 267
Type Path Body Name id required body required Description Unique identifier of the SMB server. Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed POST /smb_server/{id}/join Description Join the SMB server to an Active Directory domain. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 268
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response POST /smb_server/{id}/unjoin Description Unjoin the SMB server from an Active Directory domain. Parameters Type Path Name id required Description Unique identifier of the SMB server. Body body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 269
Description List SMB shares. Responses HTTP Code Description 200 Success 206 Partial content of smb share instance objects Schema < smb_share_instan ce > array < smb_share_instan ce > array POST /smb_share Description Create an SMB share. Parameters Type Body Name body required Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 270
Parameters Type Path Name id required Description SMB Share object id. Responses HTTP Code Description 200 Success 404 Not Found DELETE /smb_share/{id} Description Delete an SMB Share. Parameters Type Path Name id required Description SMB Share object id. Responses HTTP Code 204 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 271
Parameters Type Path Name id required Body body optional Description SMB share object id. Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema string smb_share_modify Schema No Content error_response error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 272
GET /smtp_config/{id} Description Query the specific SMTP configuration. Parameters Type Path Name id required Description Schema Unique identifier of the This value is always '0'. SMTP configuration. string Responses HTTP Code 200 Description Success 404 Not Found Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 273
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response POST /smtp_config/{id}/test Description Test the SMTP configuration. Parameters Type Path Name id required Description Schema Unique identifier of the This value is always '0'. SMTP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 274
Responses HTTP Code Description 200 Success 206 Partial content of snapshot rule instance objects Schema < snapshot_rule_inst ance > array < snapshot_rule_inst ance > array POST /snapshot_rule Description Create a new snapshot rule. Parameters Type Body Name body required Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 275
Type Path Name id required Description Unique identifier of the snapshot rule. Responses HTTP Code 200 Description Success 404 Not Found DELETE /snapshot_rule/{id} Description Delete a snapshot rule Parameters Type Path Name id required Description Unique identifier of the snapshot rule. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 276
Description Modify a snapshot rule. If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to that associated storage resource. Parameters Type Path Name id required Description Unique identifier of the snapshot rule. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 277
HTTP Code Description 200 Success 206 Partial content of snmp server instance objects POST /snmp_server Description Create an SNMP server. Was added in version 2.0.0.0. Parameters Type Body Name body required Description Parameters to create an SNMP server. Responses HTTP Code 201 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 278
Responses HTTP Code 200 Description Success 404 Not Found DELETE /snmp_server/{id} Description Delete an SNMP Server. Was added in version 2.0.0.0. Parameters Type Path Name id required Description Unique identifier of the SNMP server. Responses HTTP Code 204 Description Success 404 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 279
Type Body Name body required Description Schema New values of the properties of the SNMP snmp_server_modif server. y Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response POST - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 280
representing the software that is installed on each appliance and one entry representing the common software installed version that is supported for all appliances in the cluster. Responses HTTP Code Description 200 Success Schema < software_installed _instance > array 206 Partial content of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 281
software_package Software upgrade functionality. Only one upgrade can be active at a time. GET /software_package Description Query the software packages that are known by the cluster. The output returns a list of JSON objects representing the packages. Responses HTTP Code Description 200 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 282
HTTP Code 422 Description Operation Failed Schema error_response Consumes • multipart/form-data Produces • application/json GET /software_package/{id} Description Query a specific software package. Parameters Type Path Name id required Description Schema Unique identifier of the software - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 283
Type Path Name id required Description Schema Unique delete. identifier of the software package to string Responses HTTP Code 202 Description Accepted 204 Success 404 Not Found 422 Operation Failed Schema job_response No Content error_response error_response POST / - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 284
Type Body Name body optional Description Schema software_package_in stall Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response POST /software_package/{id}/puhc Description Run - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 285
HTTP Code 422 Description Operation Failed Schema error_response storage_container Manage storage containers. A storage container is a logical grouping of related storage objects in a cluster. A storage container corresponds to a vVol datastore in vCenter and is used to group related vVols and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 286
Responses HTTP Code 201 Description Success 400 Invalid Request 422 Operation Failed Produces • application/json GET /storage_container/{id} Description Query a specific instance of storage container. Parameters Type Path Name id required Description Storage container ID. Responses - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 287
Parameters Type Path Name id required Body body optional Description Storage container ID. Options to delete storage_container. Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Produces • application/json PATCH /storage_container/{id} - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 288
HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Produces • application/json POST /storage_container/{id}/mount Description Mount a storage container as a vVol datastore in vCenter. Parameters Type Path Name id required Description Storage - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 289
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 REST API Reference Guide - Page 290
HTTP Code 200 Description Success 206 Partial content of vcenter instance objects Schema < vcenter_instance > array < vcenter_instance > array POST /vcenter Description Add a vCenter. Not allowed in Unified+ deployments. Parameters Type Body Name body optional Schema vcenter_create - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 291
Responses HTTP Code 200 Description Success 404 Not Found Schema vcenter_instance error_response DELETE /vcenter/{id} Description Delete a registered vCenter. Deletion of vCenter disables functionality that requires communication with vCenter. Not allowed in Unified+ deployments. Parameters - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 292
Type Path Body Name id required body optional Description Unique identifier of the vCenter to modify. Schema string vcenter_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 293
GET /veth_port/{id} Description Query a specific virtual Ethernet port configuration. Parameters Type Path Name id required Description Unique identifier of the virtual Ethernet port. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema veth_port_instanc e - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 294
HTTP Code Description 200 Success 206 Partial content of virtual machine instance objects Schema < virtual_machine_i nstance > array < virtual_machine_i nstance > array GET /virtual_machine/{id} Description Query a specific virtual machine instance. Parameters Type Path Name id required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 295
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /virtual_machine/{id} Description Modify a virtual machine. This operation cannot be used on virtual machine snapshots or templates. Parameters Type Path - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 296
Parameters Type Path Name id required Body body optional Description Schema Unique identifier of the virtual machine to string create a snapshot of. virtual_machine_sna pshot Responses HTTP Code 200 Description Success 204 Success 400 Invalid request 404 Not Found 422 Operation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 297
HTTP Code Description 206 Partial content of virtual volume instance objects Schema < virtual_volume_in stance > array GET /virtual_volume/{id} Description Get a specific virtual volume. Parameters Type Path Name id required Description Id of the virtual volume. Schema string Responses - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 298
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response volume Use these resource types to manage volumes, including snapshots and clones of volumes. GET /volume Description Query volumes that are provisioned on the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 299
Responses HTTP Code 201 Description Created 400 Invalid request 422 Operation Failed Schema create_response error_response error_response GET /volume/{id} Description Query a specific volume instance. Parameters Type Path Name id required Description Unique identifier of the volume to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 300
Parameters Type Path Name id required Description Unique identifier of the volume to delete. Schema string Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /volume/{id} Description Modify the parameters - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 301
POST /volume/{id}/snapshot Description Create a snapshot of a volume or a clone. A snapshot is a point-in-time copy of a volume or clone. Parameters Type Path Name id required Description Schema Unique identifier of the volume the source of the snapshot. or clone that is string Body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 302
Responses HTTP Code 200 Description Success 204 Success 400 Invalid request 404 Not Found 422 Operation Failed Schema volume_clone_res ponse No Content error_response error_response error_response POST /volume/{id}/refresh Description Refresh the contents of the target volume from - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 303
HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response POST /volume/{id}/restore Description Restore a primary volume or clone from a snapshot. A primary or clone volume can only be restored - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 304
HTTP Code 422 Description Operation Failed POST /volume/{id}/attach Description Attach a volume to a host or host group. Parameters Type Path Name id required Description Unique identifier of volume to attach. Body body required Responses HTTP Code 204 Description Success 400 Invalid - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 305
Type Body Name body required Description Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema volume_detach Schema No Content error_response error_response error_response volume_group Use this resource type for storage cluster REST - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 306
Parameters Type Body Name body required Schema volume_group_create Responses HTTP Code 201 Description Created 400 Invalid request 422 Operation Failed Schema create_response error_response error_response GET /volume_group/{id} Description Query a specific volume group, snapshot set, or - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 307
• When a volume group or clone is deleted, all related snapshot sets will also be deleted. • When a snapshot set is deleted, all of its constituent snapshots will also be deleted. Parameters Type Path Name id required Description Unique identifier of the volume group. Schema string Body body - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 308
HTTP Code 400 Description Invalid request 404 Not Found 422 Operation Failed Schema error_response error_response error_response POST /volume_group/{id}/add_members Description Add member volumes to an existing primary or clone volume group. This cannot be used to add members to a snapshot - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 309
the destination in a replication session. Parameters Type Path Name id required Description Unique identifier of the volume group. Body body required Schema string volume_group_remo ve_members Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 310
Type Path Body Name id required body required Description Unique identifier of the volume group. Schema string volume_group_snap shot Responses HTTP Code 200 Description Success 204 Success 400 Invalid request 404 Not Found 422 Operation Failed Schema volume_group_sn apshot_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 311
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 REST API Reference Guide - Page 312
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 REST API Reference Guide - Page 313
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 Certificates instances. This resource type collection query does not support filtering, sorting or pagination. Responses 312 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 314
HTTP Code Description 200 Success 206 Partial content of x 509 certificate instance objects Schema < x509_certificate_i nstance > array < x509_certificate_i nstance > array Produces • application/json POST /x509_certificate Description Add/import a new X509 Certificate. When certificate - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 315
GET /x509_certificate/{id} Description Query a specific X509 Certificate instance. Parameters Type Path Name id required Description Unique identifier of the X509 Certificate. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema x509_certificate_i nstance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 316
the private key and passphrase, whose is_current and is_valid attributes will both be false. Only Syslog_HTTP and VASA_HTTP are supported service types. Was added in version 2.0.0.0. Parameters Type Body Name body required Description Request body. Schema x509_certificate_csr Responses HTTP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 317
to a new self-signed certificate, so that VASA Provider can be re-registered with vCenter. This is valid only for the VASA_HTTP service and requires either the Administrator, Security Administrator, or VASA administrator role. Was added in version 2.0.0.0. Parameters Type Body Name body required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 318
with values - Active and Cleared. Type : enum (ACTIVE, CLEARED) ArrayTypeEnum Product type of the storage system. Valid values are: Unknown Product type is unknown to PowerStore. SC Storage Center. PS Peer Storage Group. Schema No Content error_response error_response 317 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 319
interface. If the receiving interface fails, another interface takes over the MAC address of the failed interface. This mode does not require any special switch support. 318 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 320
mode includes Transmit Load Balancing (TLB) and Receive Load Balancing (RLB) for IPv4 traffic and does not require any special switch support. Receive load balancing is achieved by ARP negotiation. Type : enum (LACP) BondingTypeEnum Bond type: System_Bond Immutable default system bond. User_Bond - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 321
Undetermined 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. Type : enum (Ready, Ready_For_Agentless_Import, In_Progress, Members_Not_Ready, No_Members, Max_Members, Not_In_Sync, Imported, - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 322
Tuesday Tuesday Wednesday Wednesday Thursday Thursday Friday Friday Saturday Saturday Sunday Sunday Unknown Day of week is unknown to PowerStore. Type : enum (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Unknown) DaysOfWeekEnum Days of the week. Type : enum (Monday - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 323
Layer Security. None Do not enforce security when transmitting audit logs. Was added in version 2.0.0.0. Type : enum (TLS, None) EthPortSpeedEnum Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on the port - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 324
Type : enum (Auto, 10_Mbps, 100_Mbps, 1_Gbps, 10_Gbps, 25_Gbps, 40_Gbps) FcPortProtocolEnum Protocols supported over FC port. Types of protocol: SCSI SCSI protocol. NVMe NVMe protocol. Was added in version 2.0.0.0. Type : enum (SCSI, NVMe) FcPortSpeedEnum Possible Fibre Channel port - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 325
FileInterfaceRoleEnum Production This type of network interface is used for all file protocols and services of a NAS server. This type of interface is inactive while a NAS server is in destination mode. Backup This type of network interface is used only - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 326
FileLDAPProtocolEnum Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the network and provides message and server authentication. LDAP LDAP protocol without SSL. LDAPS (Default) LDAP protocol with SSL. When you enable LDAPS, make sure to specify - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 327
Native Native Security. UNIX UNIX Security. Windows Windows Security. Type : enum (Native, UNIX, Windows) FileSystemFolderRenamePolicyEnum File system folder rename policies for the file system with multiprotocol access enabled. These policies control whether the directory can be renamed from - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 328
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 REST API Reference Guide - Page 329
, but available data cannot guarantee OK status. Type : enum (OK, Minor, Major, None) FrontEndPortConnectionTypeEnum Type of connector supported by the port. Current values are: Unknown Unknown Connector SC Subscriber Connector FC_Style1_Copper Fibre Channel Style 1 Copper Connector - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 330
Operating system of the host system is unknown to PowerStore. Type : enum (Windows, Linux, ESXi, Unknown support encryption. Supported_Unlocked Drive supports encryption but is not configured. Supported_Locked Drive supports encryption and is locked. Supported_Locked_Cluster_PIN Drive supports - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 331
encryption and is locked with an unknown PIN. Drive supports encryption and is being processed. Drive encryption is disabled. Type : enum (Not_Supported, Supported_Unlocked, Supported_Locked, Supported_Locked_Cluster_PIN, Supported_Locked_Out, Supported_Locked_Foreign, Supported_Processing - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 332
Uninitialized System is starting up. Healthy Hardware is healthy. Initializing System is starting up. Failed Hardware has failed. Disconnected Hardware was removed from the system. Prepare_Failed Transient state used during startup. Trigger_Update Transient state used during startup. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 333
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. Type : enum (Unknown, Multi_Mode, Single_Mode) HardwareSFPSpeedEnum Supported speed. Available on the SFP hardware type. Current - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 334
. Current protocols are: Unknown This SFP has unknown protocol support. FC This SFP supports Fibre Channel. Ethernet This SFP supports Ethernet. FC_Ethernet This SFP supports Fibre Channel or Ethernet. SAS This SFP supports SAS for connections to Expansion Enclosures. Type : enum (Unknown - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 335
HardwareStatusLEDStateEnum State of the status LED of the hardware. The LED is On when there is a hardware fault. Current values are: Off Hardware Status LED is turned off. On Hardware Status LED is turned on. Type : enum (Off, On) HardwareTypeEnum The type of hardware component. Current types - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 336
is 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 REST API Reference Guide - Page 337
host that is not part of the PowerStore hardware. * Internal - ESXi host running on the PowerStore+ hardware. Not applicable for SAN only server cannot satisfy the Accept: header in the request. Only application/json is supported. * 415 - Invalid request Content-Type. * 416 - Range Not Satisfiable. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 338
cancel operation. Cancel_Forced Aborted the ongoing cancel operation. None Migration state is not known to PowerStore. Type : enum (Import_Completed, Cancel_Completed, Import_Aborted, Cancel_Aborted, Cancel_Forced, None) ImportPsgroupScheduleStatusEnum Snapshot schedule status. Valid values are - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 339
FIFO) order. This occurs when there are more active import sessions than supported. In_Progress Indicates that a queued import session is now in progress. estimated time left for the copy. Host IOs are pointed to PowerStore in this state. The import process keeps the source and destination - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 340
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 REST API Reference Guide - Page 341
progress. Completed Volume is migrated. Aborted Volume migration is aborted Unknown Volume migration state is unknown to PowerStore. Type : enum (None, Normal, Prepared, Disabled_For_IO, In_Progress, Aborted, Completed, Unknown) InitiatorProtocolTypeEnum Protocol type of the host initiator - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 342
enum (iSCSI, FC, NVMe) IoPriorityEnum The I/O priority for quality of service rules. Type : enum (Low, Medium, High) IpPortUsageEnum IP port usages. storage discovery address, and is the default port for replication on PowerStore X appliances. IP ports tagged with ISCSI_Default may not be removed - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 343
management within the cluster. SDNAS_Node IP address for SDNAS node management within the cluster. SDNAS_Node_Serviceability IP address for SDNAS node serviceability access within the cluster. VMotion vMotion IP address. Unused Unused IP address. Storage_Global This value is no longer used - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 344
maps to an LDAP group in LDAP server. Was added in version 1.0.3. Type : enum (User, Group) LDAPProtocolEnum 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. Type : enum (LDAP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 345
system recommended migration. Type : enum (Initial, Manual, Recommended) MessageSeverityEnum Message severity. Type : enum (Info, Warning, Error) MetricsEntityEnum An enum describing the various entities supported by metrics. performance_metrics_by_appliance Appliance performance metrics - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 346
performance_metrics_by_fe_fc_port performance_metrics_by_fe_eth_port performance_metrics_by_fe_eth_node performance_metrics_by_fe_fc_node wear_metrics_by_drive wear_metrics_by_drive_daily space_metrics_by_cluster space_metrics_by_appliance space_metrics_by_volume space_metrics_by_volume_family - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 347
performance_metrics_smb_builtinclient_b y_node Performance metrics for the SMB protocol built-in client performance_metrics_smb_branch_cache_ by_node Performance metrics for the SMB protocol Branch-Cache performance_metrics_smb1_by_node Performance metrics for the SMB1 protocol basic - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 348
performance_metrics_smb_by_node, performance_metrics_smb_builtinclient_by_node, performance_metrics_smb_branch_cache_by_node, performance_metrics_smb1_by_node, performance_metrics_smb1_builtinclient_by_node, performance_metrics_smb2_by_node, performance_metrics_smb2_builtinclient_by_node, - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 349
MigrationRecommendationPrimaryResourceTypeEnu m Specifies grouping mechanism for migration actions in a recommendation that identifies logically related migration actions. If a volume/virtual volume is attached to a host/virtual machine and the system selects all volumes/virtual volumes attached to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 350
operation. Migration_Paused At least one migration session for this recommendation is paused. Paused migration sessions can be resumed manually. Migration_Error At least one migration session for this recommendation has failed. Migration_Successful All migration sessions have been successfully - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 351
recommendation to evacuate space by auto selecting storage objects from an appliance using specified size. Evacuate_Objects - A recommendation to evacuate appliance by using specified objects. Values was added in 2.0.0.0: Evacuate_Objects. Type : enum (Evacuate_Appliance, Evacuate_Objects) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 352
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. Type : enum (Legacy, Preparing, Disabled_For_IO, In_Progress, Done, Aborted, Not_Applicable, Unknown) MonthOfYearEnum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 353
December Unknown Month of year is unknown to PowerStore. Type : enum (January, February, March, April, May, June, July, August, September, October, November, December, Unknown) NASServerCurrentUnixDirectoryServiceEnum Define the Unix directory service used for looking up identity information for - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 354
Unknown NAS server state is unknown. Type : enum (Stopped, Starting, Started, Stopping, Failover, Degraded, Unknown) NFSExportDefaultAccessEnum 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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 355
Was added in version 2.0.0.0. Type : enum (ISCSI) NetworkTypeEnum 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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 356
data and management networks. Management_Only Physical switch for management network only. Type : enum (Data_and_Management, Management_Only) PolicyTypeEnum Supported policy types. Protection A protection policy, consisting of snapshot and replication rules. Performance A performance policy - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 357
Was added in version 2.0.0.0. Type : enum (Not_Stale, Disconnected) ProtocolTypeEnum Available protocol types. TCP Use the Transmission Control Protocol. UDP Use the User Datagram Protocol. Was added in version 2.0.0.0. Type : enum (TCP, UDP) RPOEnum Recovery point objective (RPO), which is the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 358
tuned for higher efficiency depending on the expected network latency. This will only be used when the remote system type is PowerStore. Low Less than 5 milliseconds. High More than 5 milliseconds. Type : enum (Low, High) RemoteSystemStateEnum Possible remote system states: OK Normal conditions - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 359
. OK No other operation. The replication session is operating normally. Synchronizing The replication session has started either a manual or automatic synchronization. System_Paused Replication session operation has failed or was cancelled. User intervention required. Paused User paused - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 360
Failing_Over A planned failover is in progress. The status changes to Failed_Over after the replication session has failed over. Failing_Over_For_DR An unplanned failover is in progress. The status changes to Failed_Over after the replication session has failed over. Failed_Over The replication - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 361
to PowerStore. Type : enum (Up, Down, Degraded, Unknown) SMBShareOfflineAvailabilityEnum Defines valid states of Offline Availability, Manual default). Type : enum (Manual, Documents, Programs, None) SNMPAuthProtocolEnum Relevant only for SNMPv3. Supported SNMP authentication protocols: 360 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 362
implements the Secure Hash Authentication Was added in version 2.0.0.0. Type : enum (None, MD5, SHA256) SNMPPrivacyProtocolEnum 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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 363
Weekly Take snapshot on a weekly basis. Monthly Take snapshot on a monthly basis. Unknown SC schedule type is unknown to PowerStore. Type : enum (Once, Daily, Weekly, Monthly, Unknown) ScSnapshotProfileTypeEnum Available SC snapshot profile types. Valid values are: Standard Takes snapshots - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 364
SeverityEnum Possible severities. Type : enum (None, Info, Minor, Major, Critical) SnapRuleIntervalEnum Interval between snapshots. Either the interval parameter or the time_of_day parameter may be set. Setting one clears the other parameter. Type : enum (Five_Minutes, Fifteen_Minutes, - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 365
Debug Provides additional diagnostics for development. Retail An optimized compiler option. Was added in version 2.0.0.0. Type : enum (Retail) SoftwarePackageBuildTypeEnum Type of the build. Valid values are: Internal An internal (developer) build. Hotfix A build containing 1 or more specific - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 366
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 REST API Reference Guide - Page 367
Not_Supported The source array does not support import. Was added in version 1.0.2. Type : enum (Agentless, Non_Disruptive_And_Agentless, Not_Supported) ThumbprintAlgorithmEnum The thumbprint algorithm: - SHA-256 : SHA-256 algorithm Type : enum (SHA-256) TimeZoneEnum Time - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 368
Connection_Refused Connection was refused. Login_Timeout Login to target IP timed out. Network_Error Network error General_Failure Other failure not listed. Login_Success_No_Ports Login successful after discovery failure. Used only for PS EqualLogic systems. Discovery_Success Discovery of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 369
), minutes (optional, default 0). Day_At_HHMM Specify a list of {hour[,...]} when to create a snapshot each day at {minutes} past the hour. Supported parameters: hours (at least one required), minutes (optional). N_Days_At_HHMM Create a snapshot every {interval} days at the time {hours}:{minutes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 370
{daysOfMonth}, at the time {hours}:{minutes}. Supported parameters: daysOfMonth (at least one required), hours (optional, default 0), minutes (optional, default 0). Unsupported Unsupported. Unknown Schedule type is unknown to PowerStore. Type : enum (N_Hours_At_MM, Day_At_HHMM, N_Days_At_HHMM - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 371
Volume migration state is not applicable if the system only supports agentless import. Unknown The volume migration state is unknown to PowerStore. Type : enum (Normal, Prepare_For_Migration, Source_Migration_In_Progress, Source_Migration_Completed, Unknown) Source_Disabled_For_IO - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 372
Offline Online vCenter cannot connect with the provider. vCenter is communicating with the provider. Was added in version 2.0.0.0. Type : enum (Not_Registered, Offline, Online) VirtualMachineStatusEnum General health status of the VM in vCenter. Not applicable to VM snapshots. Green VM is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 373
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. Type : enum (None, Prepared, Disabled_For_IO, In_Progress, Completed, Aborted - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 374
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 REST API Reference Guide - Page 375
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 import. XtremIO_Severity_Inappropriate The severity level of the XtremIO system is not suitable for import. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 376
Third Third week of the month Fourth Fourth week of the month Last Last week of the month Unknown Week of month is unknown to PowerStore. Type : enum (First, Second, Third, Fourth, Last, Unknown) 375 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 377
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. Type : enum (Management_HTTP, Replication_HTTP, VASA_HTTP, Import_HTTP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 378
. Values are: Minutes Duration in minutes. Hours Duration in hours. Days Duration in days. Unknown Duration unit is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Minutes, Hours, Days, Unknown) XtremIOObjectSeverityEnum Severity level of current alerts for this entity and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 379
Snapshots are created at specified time. Interval Snapshots are created in constant time intervals. Unknown Schedule type is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Explicit, Interval, Unknown) XtremIOStateEnum State of XtremIO storage system. Active XtremIO system is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 380
failed on the XtremIO system. Attempting_To_Start XtremIO is in attempting to start sate. Unknown XtremIO state is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Active, Start, Configured, Initializing, Stopping, Stopped, Starting, Failed, Down, Stop_Failed, Attempting_To_Start - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 381
optional Timestamp when the event resulted in a notification support (via Secured Remote Services), if any. to string (date-time) cleared_times the < event_instance > fields of this embedded resource is not supported. array generated_tim estamp Timestamp of the latest event for this alert - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 382
generated string this alert. resource_nam Name of the resource instance which generated this alert. e optional This property supports case-insensitive filtering. string resource_type optional Type of the resource instance which generated this alert. ResourceTypeEnum resource_type _l10n - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 383
true to ignore warnings about unreachable external network services discovered while adding an appliance. This can be IPv4 address. It is unique to this appliance and is set by Zeroconf. Use the PowerStore Discovery Tool to get the link local address. string (ip-address) name optional The name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 384
Name messages optional Schema < error_message > array appliance_delete Appliance resource delete operation request body. Was added in version 2.0.0.0. Type : object appliance_forecast Name metric_type required Schema ForecastMetricTypeEnum appliance_forecast_response Name high_value optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 385
association. < eth_port_instance > array express_servi ce_code Express Service Code. optional string fc_ports optional < fc_port_instance > This . string name optional Name of the appliance. This property supports casestring insensitive filtering. nodes optional This is the inverse of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 386
Description Schema This is the inverse of the resource type sas_port association. < sas_port_instance > array service_tag optional Dell Service Tag. string software_inst alled optional < This is the inverse of the resource type software_installed software_installed_i association. nstance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 387
el optional Schema DriveFailureToleran ceLevelEnum ignore_netwo rk_warnings optional Set to true to ignore warnings about unreachable external network services discovered while adding an appliance. This can be useful for configuring a system before delivery into the intended deployment - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 388
is a dynamically set local IP address. ress It is unique to this appliance and is set by Zeroconf. Use the string (ip-address) required PowerStore Discovery Tool to get the link local address. name optional The name of the new appliance. By default, the name is the cluster name followed - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 389
Name Description message_code optional Unique identifier of the message for this audit_event. Schema string message_l10n Localized message string corresponding to message_code. string optional resource_acti on optional ResourceActionEnu m resource_acti on_l10n optional Localized message - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 390
Name appliance_id optional Description Unique identifier of the appliance. Schema string data_remaini ng optional Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 data_transfer red optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 391
Name write_time optional Description Schema Time (in milliseconds) spent doing writes during this sampling period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 base_copy_metrics_by_cluster Copy metrics for the cluster. Name Description Schema data_remaini ng - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 392
Name Description Schema transfer_time optional The time (in milliseconds) spent in copy activity during this sampling period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 write_time optional Time (in milliseconds) spent doing writes during this sampling period. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 393
Name Description session_type_l 10n Localized message string corresponding to session_type optional Schema string timestamp optional End of sampling period. string (date-time) transfer_rate Data transfer rate (in bytes/second) computed using number (float) optional data_transferred and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 394
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 session_type - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 395
Name Description data_transfer red optional Number of bytes transferred during this sampling period. Minimum value : 0 Maximum value : 9223372036854775807 Schema integer (int64) read_time optional Time (in milliseconds) spent doing reads during this sampling period. Minimum value : 0 integer - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 396
size in bytes. optional number (float) io_workload_c pu_utilization optional The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests. number (float) read_bandwid th Read rate in bytes per second. optional number (float) read_iops optional Total read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 397
and write operations in bytes. number (float) avg_io_worklo The average percentage of CPU Utilization on the cores ad_cpu_utiliza dedicated to servicing storage I/O requests. Calculated over number (float) tion time interval across appliance. Derived from an average of optional utilization - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 398
Name Description avg_read_iops optional Average reads per second. Schema number (float) avg_read_late ncy Weighted average read latency in microseconds. optional number (float) avg_read_size Weighted average read size in bytes. optional number (float) avg_total_ban dwidth Weighted - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 399
size in bytes. optional number (float) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests. Calculated over number (float) ation time interval across appliance. Derived from an average of optional utilization across - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 400
Name timestamp optional Description End of sample period. Schema string (date-time) base_performance_metrics_by_cluster Performance metrics for the cluster collected at twenty second interval. Name avg_io_size optional Description Average size of read and write operations in bytes. avg_latency - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 401
Name timestamp optional Description End of sample period. total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations per second. write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 402
Name Description avg_total_ban dwidth Weighted average total bandwidth in bytes per second. optional Schema number (float) avg_total_iops Average total input and output operations per second. optional number avg_write_ban dwidth Weighted average write bandwidth in bytes per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 403
Name Description max_avg_writ e_latency Maximum of average write latency in microseconds. optional max_avg_writ e_size Maximum of average write size in bytes. optional max_read_ba ndwidth optional Maximum read bandwidth in bytes per second. max_read_iop s Maximum reads per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 404
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string bytes_rx_ps optional The total bytes received per second. number (float) bytes_tx_ps optional The total bytes transmitted per second. number (float) node_id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 405
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string avg_bytes_rx_ ps The average total bytes received per second. optional number (float) avg_bytes_tx_ ps optional The average total bytes transmitted per - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 406
Name Description Schema max_pkt_rx_n o_buffer_erro r_ps The maximum number of due to lack of buffer space. packets discarded per second number (float) optional max_pkt_rx_p s The maximum number of packets received per second. optional number (float) max_pkt_tx_e rror_ps optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 407
Name fe_port_id optional Description Schema Reference to the associated frontend ethernet (eth_port) on which these metrics were recorded. port string node_id optional Reference to the node the port belongs to. string pkt_rx_crc_er The number of packets received with CRC error (and thus - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 408
Name Description avg_bytes_tx_ ps optional The average total bytes transmitted per second. Schema number (float) avg_pkt_rx_cr The average number of packets received with CRC error c_error_ps number (float) (and thus dropped) per second. optional avg_pkt_rx_no _buffer_error_ ps The - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 409
Name Description max_pkt_rx_p s The maximum number of packets received per second. optional Schema number (float) max_pkt_tx_e The maximum number of packets that failed to be rror_ps number (float) transmitted per second due to error. optional max_pkt_tx_p s The maximum number of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 410
Name Description avg_write_late ncy Average write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) current_login The number of logins to the target from initiators. s Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 411
Name Description read_bandwid th Read rate in bytes per second. optional read_iops optional Total number of read operations by the node. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 412
Name Description unaligned_wri te_iops Unaligned write input/output per second. optional write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations per second. Schema number (float) number (float) number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 413
Name Description avg_loss_of_si gnal_count_ps Average loss of signal count per second. optional Schema number (float) avg_loss_of_sy nc_count_ps Average loss of sync count per second. optional number (float) avg_prim_seq_ prot_err_coun t_ps Average second. primitive sequence protocol - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 414
Name Description avg_unaligned _read_bandwi dth Average unaligned read rate in bytes per second. optional Schema number (float) avg_unaligned _read_iops Average unaligned read input/output per second. optional number (float) avg_unaligned _write_bandw idth Average unaligned write rate - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 415
Name Description max_avg_read _size Maximum of average read size in bytes. optional Schema number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional number (float) max_avg_writ e_size Maximum of average write size in bytes. optional number ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 416
Name Description Schema max_prim_se q_prot_err_co unt_ps optional The maximum primitive sequence protocol error count per second. number (float) max_read_ba ndwidth optional Maximum read bandwidth in bytes per second. number (float) max_read_iop s Maximum reads per second. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 417
Name Description max_unaligne d_write_iops Maximum unaligned write input/output per second. optional Schema number (float) max_write_ba ndwidth Maximum write bandwidth in bytes per second. optional number (float) max_write_io ps optional Maximum writes per second. number (float) node_id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 418
Name Description avg_write_late ncy Average write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) current_login The number of logins to the target from initiators. s Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 419
Name Description prim_seq_prot _err_count_ps Primitive sequence protocol error count per second. optional read_bandwid th Read rate in bytes per second. optional read_iops optional Total number of read operations by the node. repeat_count optional Number of times the metrics are repeated. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 420
Name Description unaligned_wri te_bandwidth Unaligned write rate in bytes per second. optional unaligned_wri te_iops Unaligned write input/output per second. optional write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations per second. Schema number ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 421
Name avg_latency optional Description Weighted average latency in microseconds. Schema number (float) avg_link_failu re_count_ps Average link failure count per second. optional number (float) avg_loss_of_si gnal_count_ps Average loss of signal count per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 422
Name Description avg_unaligned _bandwidth Average unaligned read/write rate in bytes per second. optional Schema number (float) avg_unaligned _iops Average unaligned total input/output per second. optional number (float) avg_unaligned _read_bandwi dth Average unaligned read rate in bytes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 423
Name Description Schema max_avg_io_si ze optional Maximum bytes. average size of input and output operations in number (float) max_avg_late ncy optional Maximum of average latency in microseconds. number (float) max_avg_read _latency Maximum read latency in microseconds. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 424
Name Description max_loss_of_s ignal_count_p s The maximum loss of signal count per second. optional Schema number (float) max_loss_of_s ync_count_ps The maximum loss of sync count per second. optional number (float) max_prim_se q_prot_err_co unt_ps optional The maximum primitive sequence - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 425
Name Description max_unaligne d_read_iops Maximum unaligned read input/output per second. optional max_unaligne d_write_band Maximum unaligned write rate in bytes per second. width optional max_unaligne d_write_iops Maximum unaligned write input/output per second. optional max_write_ba ndwidth - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 426
Name Description avg_read_size optional Average read size in bytes. Schema number (float) avg_size optional Average read and write size in bytes. number (float) avg_write_late ncy Average write latency in microseconds. optional number (float) avg_write_size optional Average write size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 427
Name write_iops optional Description Total write operations per second. Schema number (float) base_performance_metrics_by_file_system_rollup Summary of file system level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 428
Name Description avg_write_iop s Average write operations per second. optional Schema number (float) avg_write_late ncy Maximum of average write latency in microseconds. optional number (float) avg_write_size optional Average write size in bytes. number (float) file_system_id optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 429
Name Description max_read_iop s Maximum read operations per second. optional Schema number (float) max_total_ba ndwidth optional Maximum data transfer rate in bytes per second. number (float) max_write_ba ndwidth Maximum write rate in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 430
Name Description avg_read_size optional Average read size in bytes. avg_write_late ncy Average write latency in microseconds. optional avg_write_size Average write size in bytes. optional ip_port_id optional Unique identifier representing a specific port. read_bandwid th Read rate in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 431
base_performance_metrics_by_ip_port_rollup Summary of ip port (total) performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Was added in version 2.0.0.0. Name avg_io_size optional Description Average size of read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 432
Name Description avg_write_size optional Weighted average write size in bytes. Schema number (float) ip_port_id optional Unique identifier representing a specific port. string max_avg_io_si Maximum average size of input and output operations in ze number (float) bytes. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 433
Name Description max_total_iop s Maximum totals per second. optional max_write_ba ndwidth Maximum write bandwith in bytes per second. optional max_write_io ps optional Maximum writes per second. repeat_count optional Number of times the metrics is repeated. Minimum value : 0 Maximum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 434
Name Description avg_write_size optional Average write size in bytes. Schema number (float) node_id optional Unique identifier of the node. string read_bandwid th Read rate in bytes per second. Was added in version 2.0.0.0. number (float) optional read_iops optional Total read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 435
Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Maximum read and write latency in microseconds. number (float) avg_read_ban Average read rate in bytes per second. Was added in dwidth number (float) version 2.0.0.0. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 436
Name Description max_avg_io_si ze Maximum of average read and write size in bytes. optional Schema number (float) max_avg_late Maximum of average read and write latency in ncy number (float) microseconds. optional max_avg_read _latency Maximum of average read latency in microseconds. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 437
optional Total md operations per second. number (float) node_id optional Unique identifier of the nfs. string read_iops optional Total read iops in microseconds. number (float) repeat_count optional Number of consecutive sampling periods during which there were no changes in the metrics - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 438
Name timestamp optional Description End of sample period. total_iops optional Total read and write iops in microseconds. write_iops optional Total write iops in microseconds. Schema string (date-time) number (float) number (float) base_performance_metrics_by_nfsv3_rollup Summary of nfs level - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 439
Name Description max_failed_m d_ops Max failed operations per second. optional Schema number (float) max_read_iop s Maximum read operations per second. optional number (float) max_total_iop s Maximum read and write operations per second. optional number (float) max_write_io ps - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 440
optional End of sample period. string (date-time) total_iops optional Total read and write iops in microseconds. number (float) write_iops optional Total write iops in microseconds. number (float) base_performance_metrics_by_nfsv4_rollup Summary of nfs level performance metric data for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 441
Name Description avg_total_iops optional Average read and write operations per second. Schema number (float) avg_write_iop s Average write operations per second. optional number (float) max_avg_md_ latency Maximum average md latency per second. optional number (float) max_failed_m - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 442
9223372036854775807 integer (int64) io_workload_c pu_utilization The percentage of CPU Utilization on the cores dedicated to number (float) servicing storage I/O requests. optional node_id optional Unique identifier representing a specific node. string read_bandwid th Read rate in bytes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 443
Name repeat_count optional Description Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 444
operations in bytes. number (float) avg_io_worklo The average percentage of CPU Utilization on the cores ad_cpu_utiliza tion dedicated to servicing storage I/O requests. Calculated over time across appliance. Derived from an average of number (float) optional utilization across all nodes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 445
Name Description avg_total_ban dwidth Weighted average total bandwidth in bytes per second. optional Schema number (float) avg_total_iops Average total input and output operations per second. optional number avg_unaligned _bandwidth Average unaligned read/write rate in bytes per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 446
Maximum value : 9223372036854775807 integer (int64) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests. Calculated over number (float) ation time across appliance. Derived from an average of optional utilization - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 447
Name Description max_total_ba ndwidth optional Maximum total bandwidth in bytes per second. Schema number (float) max_total_iop s Maximum totals per second. optional number max_unaligne d_bandwidth Maximum unaligned read/write rate in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 448
Name repeat_count optional Description Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. Schema integer (int32) string (date-time) base_performance_metrics_by_smb_cache Performance metrics for the smb cache collected - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 449
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 450
Name Description hash_max_siz e Max hash size. optional Schema number (float) hash_min_late ncy Min hash latency. optional number (float) hash_min_size optional Max hash size. number (float) max_used_thr eads Max used threads optional number (float) node_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 451
Name avg_latency optional Description Average read and write latency in microseconds. Schema number (float) avg_read_late ncy Average read latency in microseconds. optional number (float) avg_read_size Average read size in bytes. optional number (float) avg_write_late ncy Average write - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 452
base_performance_metrics_by_smb_client_rollup Summary of smb client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional Description Average calls. Schema number (float) avg_io_size optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 453
Name Description max_avg_read _latency Maximum of average read latency in microseconds. optional Schema number (float) max_avg_read _size Maximum of average read size in bytes. optional number (float) max_avg_size optional Maximum of average read and write size in bytes. number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 454
Name timestamp optional Description Time at the beginning of sample period. Schema string (date-time) base_performance_metrics_by_smb_node Performance metrics for the smb node collected at twenty second interval. Name avg_io_size optional Description Average read and write size in bytes. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 455
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 456
Name avg_latency optional Description Maximum read and write latency in microseconds. Schema number (float) avg_read_ban Average read rate in bytes per second. Was added in dwidth number (float) version 2.0.0.0. optional avg_read_iops Average read operations per second. optional number ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 457
Name Description max_avg_read _size Maximum of average read size in bytes. optional Schema number (float) max_avg_size Maximum of average read and write size in bytes. optional number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional number (float - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 458
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 459
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 460
Name Description avg_read_late ncy Maximum read latency in microseconds. optional Schema number (float) avg_read_size Average read size in bytes. optional number (float) avg_write_iop s Average write operations per second. optional number (float) avg_write_late ncy Maximum write - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 461
Name max_iops optional Description Maximum read and write operations per second. Schema number (float) max_read_iop s Maximum read operations per second. optional number (float) max_write_io ps optional Maximum write operations per second. number (float) node_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 462
Name Description avg_write_late ncy Average write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) node_id optional Unique identifier of the node. string read_iops optional Total read operations per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 463
Name avg_iops optional Description Average read and write operations per second. Schema number (float) avg_latency optional Maximum read and write latency in microseconds. number (float) avg_read_iops Average read operations per second. optional number (float) avg_read_late ncy Maximum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 464
Name Description max_avg_writ e_latency Maximum of average write latency in microseconds. optional Schema number (float) max_avg_writ e_size Maximum of average write size in bytes. optional number (float) max_calls optional Maximum calls. number (float) max_iops optional Maximum read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 465
Name avg_latency optional Description Average read and write latency in microseconds. Schema number (float) avg_read_late ncy Average read latency in microseconds. optional number (float) avg_read_size Average read size in bytes. optional number (float) avg_write_late ncy Average write - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 466
base_performance_metrics_by_smb_v2_builtin_client_ rollup Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional Description Average calls. Schema number (float) avg_io_size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 467
Name Description max_avg_read _latency Maximum of average read latency in microseconds. optional Schema number (float) max_avg_read _size Maximum of average read size in bytes. optional number (float) max_avg_size optional Maximum of average read and write size in bytes. number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 468
Name timestamp optional Description Time at the beginning of sample period. Schema string (date-time) base_performance_metrics_by_smb_v2_node Performance metrics for the smb v1 node collected at twenty second interval. Name avg_io_size optional Description Average read and write size in bytes. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 469
Name total_calls optional total_iops optional write_iops optional Description Total calls. Total read and write operations per second. Total write operations per second. Schema number (float) number (float) number (float) base_performance_metrics_by_smb_v2_node_rollup Summary of smb v1 node level - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 470
Name Description avg_write_late ncy Maximum write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) max_avg_late Maximum of average read and write latency in ncy optional microseconds. number (float) max_avg_read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 471
Name node_id optional Description Unique identifier of the node. Schema string repeat_count optional Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 472
Name read_iops optional Description Total read operations per second. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. total_bandwid th Total data transfer rate in bytes per second. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 473
Name Description avg_read_size optional Average read size in bytes. Schema number (float) avg_write_late ncy Average write latency in microseconds. optional number (float) avg_write_size Average write size in bytes. optional number (float) read_bandwid th Read rate in bytes per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 474
base_performance_metrics_by_vm_rollup Summary of virtual machine level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Name avg_io_size optional Description Average size of read and write operations in bytes. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 475
Name Description avg_write_size optional Weighted average write size in bytes. Schema number (float) max_avg_io_si Maximum average size of input and output operations in ze number (float) bytes. optional max_avg_late ncy optional Maximum of average latency in microseconds. number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 476
Name Description max_write_ba ndwidth Maximum write bandwidth in bytes per second. optional Schema number (float) max_write_io ps optional Maximum writes per second. number (float) repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 477
Name Description avg_write_size optional Average write size in bytes. read_bandwid th Read rate in bytes per second. optional read_iops optional Total read operations per second. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 478
Name avg_io_size optional Description Average size of read and write operations in bytes. Schema number (float) avg_latency optional Weighted average latency in microseconds. number (float) avg_read_ban dwidth Weighted average read bandwidth in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 479
Name Description Schema max_avg_io_si ze optional Maximum bytes. average size of input and output operations in number (float) max_avg_late ncy optional Maximum of average latency in microseconds. number (float) max_avg_read _latency Maximum read latency in microseconds. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 480
Name Description max_write_io ps optional Maximum writes per second. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. volume_id optional Unique identifier representing a specific volume. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 481
Name Description read_bandwid th Read rate in bytes per second. optional Schema number (float) read_iops optional Total read operations per second. number (float) repeat_count optional Number of consecutive sampling periods during which there were no changes in the metrics values. If the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 482
Name avg_latency optional Description Schema Maximum of microseconds. average read and write latency in number (float) avg_read_ban dwidth Average read rate in bytes per second. optional number (float) avg_read_iops Average read operations per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 483
Name Description Schema max_avg_late ncy optional Maximum of microseconds. average read and write latency in number (float) max_avg_read _latency Maximum of average read latency in microseconds. optional number (float) max_avg_read _size Maximum of average read size in bytes. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 484
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 485
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 486
Name Description avg_read_late ncy Maximum of average read latency in microseconds. optional Schema number (float) avg_read_size Average read size in bytes. optional number (float) avg_total_ban dwidth Average data transfer rate in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 487
Name Description max_avg_read _size Maximum of average read size in bytes. optional Schema number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional number (float) max_avg_writ e_size Maximum of average write size in bytes. optional number ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 488
base_performance_metrics_file_by_node Performance metrics for file per node collected at twenty second interval. Was added in version 2.0.0.0. Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Average read and write latency in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 489
Name Description total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations per second. write_bandwi dth Write rate in bytes per second. optional write_iops optional Total write operations per second. Schema number (float - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 490
Name Description avg_total_ban dwidth Average data transfer rate in bytes per second. optional Schema number (float) avg_total_iops Average read and write operations per second. optional number (float) avg_write_ban dwidth Average write rate in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 491
optional Time at the beginning of sample period. string (date-time) base_response Base response object Filtering on the fields of this embedded resource is not supported. 490 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 492
Name response_type required Schema string base_space_metrics_by_appliance Space metrics for the appliance collected at five minute interval. Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string data_physical _used - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 493
Name Description Schema Amount of data in bytes written to all file systems on an logical_used_f ile_system optional appliance, without any deduplication and/or compression. This metric includes all added in version 2.0.0.0. primaries, snaps and clones. Was integer (int64) Minimum value - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 494
of appliance level space metric data for a specific period of time, beginning with timestamp and including the maximum and final values for that period. Current support is for a time period of one hour and one day. 493 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 495
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 496
Name Description last_physical_ Last physical used space during the period. used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_shared_lo Last shared logical used during the period. gical_used Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 497
Name Description max_logical_p Maxiumum logical total space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_logical_u Maxiumum logical used space during the period. sed Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 498
Name Description Schema max_shared_l ogical_used_v vol optional Maximum shared logical used space for virtual volumes during the period. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 max_snapshot _savings Maximum snapshot savings space - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 499
Name Description Schema The overall efficiency is computed as a ratio of the total space provisioned to physical used space. For example, ten 2 GB volumes were provisioned and 1 GB of data is written efficiency_rati to each of them. Each of the volumes has one snapshot as o well, for another - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 500
Name Description Schema physical_total optional The total combined space on the physical drives of the cluster available for data. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 physical_used optional The total physical space consumed in the cluster, accounting for - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 501
level space metric data for a specific period of time, beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day. Name cluster_id optional Description Identifier of the cluster. Schema string last_data_phy Last - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 502
Name Description last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) Last logical used space for file systems during the period. last_logical_us Was added in version 2.0.0.0. ed_file_system - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 503
Name Description Schema last_shared_lo Last shared logical used space for virtual volumes during gical_used_vv the period. Was added in version 2.0.0.0. ol Minimum value : 0 integer (int64) optional Maximum value : 9223372036854775807 last_snapshot_ savings Last snapshot savings space - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 504
Name Description Schema max_logical_u sed_vvol optional Maximum logical used space for virtual volumes during the period. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 max_physical Maximum physical total space during the period. _total - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 505
Name timestamp optional Description End of sample period. Schema string (date-time) base_space_metrics_by_storage_container Space metrics of storage container aggregated from all appliances collected at five minute interval. Name Description Schema logical_provis ioned optional Total - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 506
level space metric data for a specific period of time beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day. Name Description last_logical_pr Last logical provisioned space during the period. ovisioned - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 507
Name Description storage_conta iner_id Internal ID of the storage container. optional timestamp optional End of sample period. Schema string string (date-time) base_space_metrics_by_vg Space metrics for a volume group collected at a five minute interval. Name Description Schema Total - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 508
Name thin_savings optional Description Schema Ratio of all the volumes provisioned to data being written to them. For example, a volume group has two 2 GB volumes and have written 500 MB of data to them. The thin number (float) savings would be (2 * 2 GB) / (2 * 0.5 GB) or 4:1, so the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 509
Name Description max_logical_u Maximum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_snap_clo Max snap and clone logical used space during the period. ne_logical_use Minimum value : 0 d Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 510
Name repeat_count optional Description Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 Schema integer (int32) snap_clone_lo gical_used optional Total Amount of data in bytes host has written to all volumes used by virtual machine without any deduplication, - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 511
Name Description last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 512
Name Description max_unique_ Max unique physical used space during the period. physical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 513
Name thin_savings optional Description Schema Ratio of all the volumes provisioned to data being written to them. For example, an appliance has two 2 GB volumes and have written 500 MB of data to them. The thin savings number (float) would be (2 GB * 2) / (0.5 GB * 2) or 4:1, so the thin_savings - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 514
Name Description Schema Amount of space the volume family needs to hold the data shared_logical written by host and shared by snaps and fast-clones in the _used family. This does not include deduplication or compression. integer (int64) optional Minimum value : 0 Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 515
Name Description last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 516
Name Description max_unique_ Max unique physical used space during the period. physical_used Minimum value : 0 optional Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 517
Name Description max_thin_savi ngs Max thin savings ratio during the period. optional repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. volume_id optional ID of the volume. Schema number ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 518
Name Description percent_endu rance_remain ing optional The percentage of drive wear remaining. repeat_count optional Number of times the metrics is repeated. Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. Schema number (float) integer (int32) string ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 519
(int32) Maximum value : 2147483647 name optional Bond name. The bond name may not exceed 15 characters. string This property supports case-insensitive filtering. partner optional This is the embeddable reference form of partner_id bond_instance attribute. partner_id optional Identifier of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 520
chap_credentials_instance Information about the initiator, target session, or discovery CHAP secrets. Name Description Schema initiator_disco very_passwor d Password used by the initiator to authenticate the target during discovery authentication. Mutual CHAP mode only. string (password) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 521
settings when creating cluster. Parameters are required when creating PowerStore X < cluster and optional for PowerStore cluster. cluster_create_vcent Note Currently only single element is supported. ers > array cluster_create_appliances Appliance configuration setting during cluster creation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 522
version 2.0.0.0. Name Description Schema ignore_netwo rk_warnings optional Set to true to ignore network warnings about unreachable external network services discovered while cluster creation. This can be useful for configuring a system before delivery into the intended deployment environment - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 523
Name addresses required Description IP addresses in IPv4 or IPv6 format. Schema < string (ip-address) > array cluster_mgmt _address optional New cluster management IP address in IPv4 or IPv6 format, corresponding to the network's IP version. This can only be string (ip-address) specified only - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 524
added in version 2.0.0.0. Name Description connections required Supported connections for a physical switch. Schema < 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. Name password - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 525
cluster. optional esx_cluster_n ame optional ESXi cluster name. The default name is "Cluster-" followed by the PowerStore cluster name. This when creating PowerStore X cluster. should be specified string Default : "name" is_verify_serv er_cert Added for next release backward compatibility - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 526
cluster_forecast_response Name high_value optional Description Schema Estimate of the upper bound of the 95% confidence interval for the forecast value at the given timestamp. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 low_value optional Estimate of the lower - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 527
Name Description Schema is_encryption_ enabled optional Whether or not Data at Rest Encryption is enabled on the cluster. boolean management_ The floating management IP address for the cluster in IPv4 address string (ip-address) or IPv6 format. optional master_applia nce_id optional The - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 528
cluster_modify Cluster modify parameters. Name name optional Description Schema The new name for the cluster. The name can be up to 64 UTF-8 characters and cannot be an empty string. string Length : 1 - 64 physical_mtu optional The physical ethernet port (eth_port resource) MTU setting is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 529
Name Description Schema time_to_full_p essimistic optional Pessimistic date-time for time to full based on bound of the forecast 95% confidence interval. the upper string (date-time) time_to_full_s tatus optional ForecastTimeToFull StatusEnum time_to_full_s tatus_l10n optional Localized - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 530
settings when creating cluster. Parameters are required when creating PowerStore X < cluster and optional for PowerStore cluster. cluster_create_vcent Note currently only single element is supported. ers > array cluster_validate_create_response Response for a validate create request. It - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 531
Name volume_wwn optional Description WWN of the source consistency group member volume. Schema string copy_metrics_by_appliance Copy metrics for the appliance. Polymorphism : Inheritance Discriminator : response_definition Name appliance_id optional Description Unique identifier of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 532
Name session_type optional Description Schema CopySessionTypeEn um session_type_l 10n Localized message string corresponding to session_type optional string timestamp optional End of sampling period. string (date-time) transfer_rate optional Data transfer rate (in bytes/second) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 533
Name entity_l10n optional Description Localized message string corresponding to entity Schema string read_time optional Time (in milliseconds) spent doing reads during this sampling period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 534
copy_metrics_by_remote_system Cluster wide copy metrics for the remote system. Polymorphism : Inheritance Discriminator : response_definition Name Description Schema data_remaini ng optional Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 integer ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 535
Name Description session_type_l 10n Localized message string corresponding to session_type optional Schema string timestamp optional End of sampling period. string (date-time) transfer_rate Data transfer rate (in bytes/second) computed using number (float) optional data_transferred and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 536
Name read_time optional Description Schema Time (in milliseconds) spent doing reads during this sampling period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of consecutive sampling periods during which there were no changes in the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 537
copy_metrics_by_volume Cluster wide copy metrics for the volume. Polymorphism : Inheritance Discriminator : response_definition Name Description Schema data_remaini ng optional Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 integer (int64) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 538
Name timestamp optional Description End of sampling period. Schema string (date-time) transfer_rate Data transfer rate (in bytes/second) computed using number (float) optional data_transferred and transfer_time. transfer_time optional The time (in milliseconds) spent in copy activity during - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 539
Name status_l10n optional Description Localized message string corresponding to status target_addres s Target address from the remote system. optional Schema string string (ip-address) discovered_initiator_instance An initiator currently connected to the cluster, but not associated with any - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 540
Name addresses required Description DNS server addresses in IPv4 or IPv6 format. Schema < string (ip-address) > array email_notify_destination_create Name Description email_address required Email address to receive notifications. notify_critical Whether to send notifications for critical - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 541
minor alerts. optional Schema string boolean boolean boolean boolean error_instance Filtering on the fields of this embedded resource is not supported. Name arguments optional Description Arguments (if applicable) for the error message. code optional Hexadecimal error code for an import error - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 542
only when ESXi host addresses or management network VLAN / prefix / gateway are changed during the reconfiguration of the PowerStore X model appliances. Type : < esxi_credentials > array esxi_credentials Name node_id optional Description Node identifier corresponding to the ESXi host. Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 543
switch port associated with the hypervisor port. Minimum value : 0 Maximum value : 2147483647 integer (int32) hypervisor_po Hypervisor front-end port name capabilities. This property rt_name string supports case-insensitive filtering. optional 542 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 544
Link is down. boolean mac_address Ethernet port MAC address. optional string name optional Ethernet port name. This property supports case- insensitive filtering. string node optional This is the embeddable reference form of node_id attribute. hardware_instance node_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 545
port. Was added in version 2.0.0.0. PortStaleStateEnum stale_state_l10 n optional Localized message string corresponding to stale_state Was added in version 2.0.0.0. string supported_sp eeds optional < The list of supported transmission speeds for Ethernet port. EthPortSpeedEnum > array 544 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 546
alert as well. So, although they may be interesting for troubleshooting, it is not necessary to monitor events. Name Description description_l1 0n string repair_flow_l1 0n optional Suggestions for how to resolve any problems that may arise from this event. string resource_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 547
Name Description resource_type optional The type of the object which generated this event. Schema ResourceTypeEnum resource_type _l10n Localized message string corresponding to resource_type optional string severity optional The severity of the event. SeverityEnum severity_l10n optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 548
is up. Values are: true Link is up. false Link is down. boolean name optional Name of filtering. the port. This property supports case-insensitive string node optional This is the embeddable reference form of node_id attribute. hardware_instance node_id optional Unique identifier of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 549
Index of the port in the IO module. Minimum value : 0 Maximum value : 2147483647 Schema integer (int32) protocols optional < List of supported protocols for the port. Was added in FcPortProtocolEnum version 2.0.0.0. > array protocols_l10 n optional Localized message array added in version - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 550
of the associated NAS Server instance that uses this DNS object. Only one DNS object per NAS Server is string supported. transport optional FileDNSTransportEn um file_dns_instance This resource type has queriable association from nas_server Name domain optional Description Schema Name of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 551
NAS Server instance that nas_server_id uses this DNS object. Only one DNS object per NAS Server is string optional supported. transport optional FileDNSTransportEn um transport_l10 n optional Localized message string corresponding to transport string file_dns_modify Name Description Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 552
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 REST API Reference Guide - Page 553
Name Description Schema is_allowed_gr oups optional Indicates whether the groups attribute contains allowed or denied user groups. Values are: - true - Groups contains allowed user groups. - false - Groups contains denied user boolean groups. Default : true Indicates whether the hosts attribute - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 554
Name Description Schema is_smb_authe ntication_ena bled optional Indicates whether FTP and SFTP clients can be authenticated using an SMB user name. These user names are defined in a Windows domain controller, and their formats are user@domain or domain\user. Values are: - boolean true - SMB - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 555
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 REST API Reference Guide - Page 556
Name id optional Description Unique identifier of the FTP server. Schema string is_allowed_gr oups optional Indicates whether the groups attribute contains allowed or denied user groups. Values are: - true - Groups contains allowed user groups. - false - Groups contains denied user boolean - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 557
Name Description Schema Indicates whether the SFTP server is enabled on the NAS is_sftp_enable server. Values are: - true - SFTP server is enabled on the d specified NAS server. - false - SFTP server is disabled on the boolean optional specified NAS server. Default : false is_smb_authe - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 558
Name Description Schema welcome_mes sage optional Welcome message displayed on the console of FTP and SFTP clients before their authentication. The length of this message is limited to 511 bytes of UTF-8 characters, and the string length of each line is limited to 80 bytes. Length : 0 - 511 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 559
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 < string (ip-address) connect to the NAS server through FTP or SFTP. - If - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 560
Name Description Schema is_anonymous Indicates whether FTP clients can be authenticated _authenticatio n_enabled anonymously. Values are: - true - Anonymous user name is accepted. - false - Anonymous user name is not accepted. boolean optional Default : true Indicates whether the activity - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 561
0 - 511 file_interface_create Attributes for the create operation. Name gateway optional Description Schema Gateway address for the network interface. IPv4 and IPv6 are supported. string (ip-address) Length : 1 - 45 ip_address required IP address of the network interface. IPv4 and IPv6 are - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 562
, as defined by the nas_server resource string required type. prefix_length required Prefix length for the interface. IPv4 and IPv6 are supported. Minimum value : 1 integer (int32) Maximum value : 128 role optional FileInterfaceRoleEn um vlan_id optional Virtual Local Area Network (VLAN - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 563
identifier of the NAS server. optional string prefix_length optional Prefix length for the interface. IPv4 and IPv6 are supported. Minimum value : 0 integer (int32) Maximum value : 2147483647 role optional FileInterfaceRoleEn um role_l10n optional Localized message string corresponding to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 564
Name Description Schema prefix_length optional Prefix length for the interface. IPv4 and IPv6 are supported. Minimum value : 1 integer (int32) Maximum value : 128 vlan_id optional Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 565
file_interface_route_instance Properties of the file interface route. This resource type has queriable association from file_interface Name destination optional Description Schema IPv4 or IPv6 address of the target network node based on the specific route type. Values are: • For a default route - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 566
Center (KDC) servers. IPv4 and IPv6 addresses are not supported. < string > array Unique identifier of the associated NAS Server this Kerberos object. Only one Kerberos object per NAS string required Server is supported. port_number optional KDC servers TCP port. Default : 88 Minimum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 567
optional Description Schema Unique identifier of the Kerberos service settings instance. string Fully Qualified domain names of this Kerberos object. Only one Kerberos object per NAS string optional Server is supported. port_number optional KDC servers TCP port. Default : 88 Minimum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 568
combined with kdc_addresses. IPv4 and IPv6 addresses are not supported. file_ldap_create Arguments for the create operation. Name addresses optional 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. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 569
associated NAS Server instance that nas_server_id will use this LDAP object. Only one LDAP object per NAS string required Server is supported. password optional The associated password for Kerberos authentication. Length : 0 - 1023 string (password) port_number optional The TCP/IP port used by - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 570
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 string id optional read-only Unique identifier of the LDAP service object. string is_certificate_ Indicates whether an LDAP certificate - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 571
Unique identifier of the associated NAS Server instance that nas_server_id uses this LDAP object. Only one LDAP object per NAS string optional Server is supported. port_number optional The TCP/IP port used by the NAS Server to connect to the LDAP servers. The default port number for LDAP is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 572
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 string or - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 573
Name Description Schema Indicates whether SMB authentication is used to authenticate to the LDAP server. Values are: is_smb_accou nt_used optional true Indicates that the SMB settings are used for Kerberos authentication. boolean false Indicates that Kerberos uses its own settings. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 574
. This resource type has queriable association from nas_server Name id optional read-only Description Unique identifier of the NDMP service object. Schema string nas_server optional This is the attribute. embeddable reference form of nas_server_id nas_server_instance nas_server_id Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 575
> array nas_server_id required Unique identifier of the associated NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS string Server is supported. file_nis_instance This resource type has queriable association from nas_server Name domain optional Description Name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 576
Name domain optional Description Name of the NIS domain. Length : 1 - 255 Schema string ip_addresses A new list of NIS server IP addresses to replace the existing < string (ip-address) optional list. The addresses may be IPv4 or IPv6. > array remove_ip_ad IP addresses to remove from the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 577
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en abled optional true false File system notifications are enabled on the file system. boolean File system notifications are disabled on the file system. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 578
Name Description Schema smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any. epth Minimum value : 1 integer (int32) optional Maximum value : 512 file_system_clone_response File system clone created. Name id optional Description The unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 579
Name Description Schema Indicates whether notifications of changes to directory file structure are enabled. is_smb_no_not ify_enabled optional true false Change directory notifications are disabled. Change directory notifications are enabled. Default : false boolean Indicates whether file - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 580
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable d optional true false Synchronous writes option is enabled on the file system. boolean Synchronous writes option is disabled on the file system. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 581
Name Description access_policy_ l10n Localized message string corresponding to access_policy optional Schema string access_type optional FileSystemSnapshot AccessTypeEnum access_type_l1 0n Localized message string corresponding to access_type optional string creation_time stamp Time, - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 582
Name Description Schema file_user_quot as optional This is the inverse association. of the resource type file_user_quota < file_user_quota_inst ance > array filesystem_typ e optional FileSystemTypeEnu m filesystem_typ e_l10n Localized message string corresponding to filesystem_type - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 583
Name Description Schema Indicates whether asynchronous MTIME is enabled on the file system. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system. Indicates whether the snapshot - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 584
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en abled optional true false File access notifications are enabled on the file system. boolean File access notifications are disabled on the file system. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 585
of the file system. insensitive filtering. This property supports case- string nas_server optional This is the embeddable a clone has been deleted the object_id will contain the string null GUID 00000000-0000-0000-0000-000000000000. protection_po This is the embeddable licy - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 586
Name size_used optional Description Schema Size used, in bytes, for the data and metadata of the file system. Value is always rounded up to next MB. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 smb_notify_on Lowest directory level to which the enabled notifications - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 587
on the file system. boolean false Asynchronous MTIME is disabled on the file system. Indicates whether quota is enabled. Quotas are not supported for read-only file systems. Default value for the grace period is set to infinite=-1 to match Windows' quota policy Values are: is_quota_enab - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 588
Name Description Schema Indicates whether notifications of changes to a directory file structure are enabled. Values are: is_smb_no_not ify_enabled true Change directory notifications are disabled. boolean optional false Change directory notifications are enabled. Indicates whether file - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 589
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable d optional true false Synchronous writes option is enabled on the file system. boolean Synchronous writes option is disabled on the file system. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 590
Name id optional Description The unique identifier of the created snapshot. Schema string file_system_snapshot Parameters for the file system snapshot operation. Name Description access_policy optional Schema FileSystemAccessPol icyEnum access_type optional FileSystemSnapshot AccessTypeEnum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 591
Name Description Schema Indicates whether notifications of changes to a directory file structure are enabled. is_smb_no_not ify_enabled true Change directory notifications are disabled. boolean optional false Change directory notifications are enabled. Indicates whether file access - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 592
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable d optional true false Synchronous writes option is enabled on the file system. boolean Synchronous writes option is disabled on the file system. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 593
Name Description Schema Grace period of soft limit (seconds). This will override the default grace period set at filesystem level. -1 Infinite grace period (Windows policy). grace_period optional 0 Positive Use default grace period of 1 week (default). Grace period after which the soft limit - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 594
file_tree_quota_instance Properties of a file tree quota. Values was added in 2.0.0.0: grace_period. This resource type has queriable associations from file_system, file_user_quota Name description optional Description Description of the tree quota. Length : 0 - 256 Schema string file_system - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 595
Name Description Schema is_user_quota s_enforced optional Whether user quota are enabled on this tree quota. The tree quota itself is enforced regardless of this parameter. boolean path optional Path relative to the root of the associated filesystem. Length : 1 - 1024 string Remaining grace - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 596
Name Description Schema Grace period of soft limit (seconds). This will override the default grace period set at filesystem level. -1 Infinite grace period (Windows policy). grace_period optional 0 Positive Use default grace period of 1 week (default). Grace period after which the soft limit - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 597
Name Description Schema file_system_id required Unique identifier of the quota will be created. filesystem in which the new user string hard_limit optional Hard limit of the user quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space that is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 598
Name file_system optional Description Schema This is the attribute. embeddable reference form of file_system_id file_system_instance file_system_id Unique identifier of the associated filesystem. optional string hard_limit optional Hard limit of the user quota, in bytes. No hard limit - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 599
Name Description Schema tree_quota_id optional Unique identifier of the associated tree quota. Values are: - null - if the user tree_quota instance quota is id - if the not within a quota tree. user quota is within a quota string tree. uid optional Unix user identifier (UID) of the user. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 600
one virus string checker configuration per NAS Server is supported. file_virus_checker_instance This resource type has queriable association from is denied to prevent potential viruses propagation. - false - Anti-virus service is disabled. File systems of the NAS servers are available for access - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 601
is denied to prevent potential viruses propagation. - false - Anti-virus service is disabled. File systems of the NAS servers are available for access Filtering on the fields of this embedded resource is not supported. Name bus_number optional Description Schema Bus number of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 602
number of physical sockets. Available on the Node hardware type. Minimum value : 0 integer (int32) Maximum value : 2147483647 dell_service_t Dell service tag of the hardware. Available on the ag string Base_Enclosure and Expansion_Enclosure hardware types. optional drive_type optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 603
Name Description fips_status_l10 n Localized message string corresponding to fips_status optional Schema string firmware_ver Firmware version of the hardware. Available on the Drive sion string hardware type. optional mode optional HardwareSFPModeE num mode_l10n optional Localized - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 604
hardware_instance Hardware component information. This resource type has queriable associations from fc_port, sas_port, eth_port, hardware, appliance Name appliance optional Description Schema This is the attribute. embeddable reference form of appliance_id appliance_instance appliance_id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 605
message string corresponding to lifecycle_state optional string name optional The name of the component. insensitive filtering. This property supports case- string node_eth_port < eth_port_instance s This is the inverse of the resource type eth_port association. > array optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 606
Name Description Schema sfp_sas_ports optional This is the inverse of the resource type sas_port association. < sas_port_instance > array slot optional The slot or location of the component. Minimum value : 0 Maximum value : 2147483647 integer (int32) stale_state optional Indicator of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 607
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 Expansion_Enclosure apply to their children (Nodes and and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 608
Name name required os_type required Description Schema The host name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters. string Maximal length : 128 OSTypeEnum host_delete Delete arguments. Type : object host_detach Unique identifier - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 609
Name description optional Description Schema An optional description for the host group. The description should not have any unprintable characters. string Maximal length : 256 host_ids required < string > array name required The host group name. The name should not be more than 128 UTF-8 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 610
association. the resource Schema type < host_volume_mappi ng_instance > array name optional The host group name. This property supports casestring insensitive filtering. host_group_modify Modify host group parameters. Name add_host_ids optional Description Schema List of hosts to be - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 611
embeddable reference form of host_group_id host_group_instance host_group_id Associated host group, if host is part of host group. optional string host_initiator s optional Filtering on supported. the fields of this embedded resource is not < host_initiator_instan ce > array 610 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 612
optional host_volume_mapping association. resource type < host_volume_mappi ng_instance > array name optional The host name. This property supports case-insensitive string filtering. os_type optional OSTypeEnum os_type_l10n Localized message string corresponding to os_type optional string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 613
Name description optional Description Schema An optional description for the host. The description should not be more than 256 UTF-8 characters long and should not have any unprintable characters. string Maximal length : 256 modify_initiat < Update list of existing initiators, identified by - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 614
Name Description Schema virtual_volum e_id optional Unique identifier of the virtual volume to which the host is attached. string host_volume_mapping_instance Details about a configured host or host group attached to a volume. The host or host group may not necessarily be connected. This - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 615
Name id optional Description Unique identifier of the import host initiator. Schema string import_host_s ystem_id Unique identifier of the import host system. optional string iqn_or_wwn optional iSCSI Qualified Name (IQN) or World Wide Name (WWN) of string the host initiator. protocol - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 616
Name Description Schema chap_single_u Username for single CHAP authentication. This username is sername required when the cluster is using single authentication string optional CHAP mode. os_type required HAOSTypeEnum password required Password for the specified username. string ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 617
Name Description agent_version optional Version of the import host system. hosts optional This is the inverse of the resource type host association. id optional Unique identifier of the import host system. last_update_ti me Time when the import host system was last updated. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 618
identifier of a volume that is presented to the string import host. name optional Name of the import host case-insensitive filtering. volume. This property supports string protocols optional Supported protocols for the import host volume. < HostInitiatorProtoco lTypeEnum > array 617 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 619
Name Description protocols_l10 n optional Localized message array corresponding to protocols size optional Size of the import host volume, in bytes. Minimum value : 0 Maximum value : 9223372036854775807 status optional Status of the import host volume. status_l10n optional Localized message - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 620
Name name optional Description Schema Name of the PS Group. insensitive filtering. This property supports case- string serial_numbe r Serial number of the PS Group. optional string supported_im port_type Was added in version 1.0.2. optional SupportedImportTy peEnum supported_im - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 621
Name keep_count optional Description Number of snapshots to retain. Minimum value : 0 Maximum value : 2147483647 Schema integer (int32) name optional Name of the snapshot schedule. string repetition_int erval optional Repeat interval of the snapshot schedule, in days. The value is 1 for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 622
Name block_size optional Description Schema VolumeBlockSizeEn um block_size_l10 n Localized message string corresponding to block_size optional string host_volume_i Unique identifiers of the host volumes associated with the ds optional volume. < string > array id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 623
wwn optional Description Schema Name of the volume. insensitive filtering. This property supports case- string Size of the volume, in bytes. Minimum value : Schema automatic_cut Indicates whether the import session cutover is manual over (true) or automatic (false). boolean optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 624
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 group after protection_po the import completes. Only snapshot policies are supported licy_id string in an import. Once the import completes, you - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 625
This resource type has queriable association from remote_system Name Description Schema automatic_cut Indicates whether the import session cutover is manual over (true) or automatic (false). boolean optional Default : false Average transfer rate of a data import operation in average_trans - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 626
each time the import job updates. string (date-time) name optional User-specified name of the import session. This property string supports case-insensitive filtering. parent_sessio n_id optional For a volume that is part of a consistency group import, this value is the session identifier - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 627
identifier of the local protection policy in the protection_po licy_id optional 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. string Once the import completes, you can add - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 628
volume is not importable. aEnum importable_cr iteria_l10n optional Localized message importable_criteria string corresponding to string name optional Name of the SC consistency group. This property supports string case-insensitive filtering. 627 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 629
Qualified Domain Name). model optional Model name of the SC array. string name optional Name of the SC array. This property supports casestring insensitive filtering. serial_numbe Serial number of the SC array. r Minimum value : 0 optional Maximum value : 2147483647 integer (int32) 628 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 630
Name status optional Description Schema SCStatusEnum status_l10n optional Localized message string corresponding to status string supported_im port_type Was added in version 1.0.2. optional SupportedImportTy peEnum supported_im port_type_l10 n optional Localized message string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 631
import_storage_center_volume_import_snapshot_profi les_response Type : < import_storage_center_snapshot_profile_instance > array import_storage_center_volume_instance This resource type has queriable import_storage_center_consistency_group associations from import_storage_center, Name health - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 632
Localized message string corresponding to migration_state optional string name optional Name of the SC volume. insensitive filtering. This property supports case- string size optional Size of the SC volume, in bytes. Minimum value : 0 Maximum value : 9223372036854775807 integer (int64 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 633
message importable_criteria string corresponding to string name optional Name of the consistency group. This property supports string case-insensitive filtering. import_unity_instance This resource type has import_unity_consistency_group queriable associations from import_unity_volume - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 634
name of the Unity storage system. string name optional Name of the Unity storage case-insensitive filtering. system. This property supports string serial_numbe r Serial number of the system optional string software_vers ion Software version of the Unity storage system. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 635
Name Description supported_im port_type Was added in version 1.0.2. optional Schema SupportedImportTy peEnum supported_im port_type_l10 n optional Localized message string corresponding supported_import_type Was added in version 1.0.2. to string user_name optional User account name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 636
Name Description Schema days_of_mont h optional Days of the month applies. [1..31]. for which the snapshot schedule rule < integer > array days_of_week optional < Days of the week for which the snapshot schedule rule UnityDayofWeekEn applies. um > array days_of_week_ l10n Localized - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 637
import_unity_volume_import_snapshot_schedules_res ponse Type : < import_unity_snapshot_schedule_instance > array import_unity_volume_instance This resource type has queriable associations from import_unity, import_unity_consistency_group Name health optional Description Schema UnityHealthEnum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 638
message string corresponding to migration_state optional string name optional Name of the Unity insensitive filtering. volume. This property supports case- string size optional Size of the Unity volume, in bytes. Minimum value : 0 Maximum value : 9223372036854775807 integer (int64 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 639
FQDN (Fully Qualified Domain Name). model optional Model name of the VNX storage system. string name optional Name of the VNX storage system. This property supports case-insensitive filtering. string serial_numbe r Serial number of the VNX storage system. optional string 638 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 640
Name Description Schema software_vers ion optional The software version of the block operating environment of the VNX storage system. string supported_im port_type Was added in version 1.0.2. optional SupportedImportTy peEnum supported_im port_type_l10 n optional Localized message string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 641
importable_criteria string corresponding Schema to string name optional Name of the consistency group. This property supports string case-insensitive filtering. import_vnx_volume_instance This resource type has import_vnx_consistency_group queriable associations from import_vnx_array - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 642
Localized message string corresponding to migration_state optional string name optional Name of the VNX volume. insensitive filtering. This property supports case- string size optional Size of the VNX volume in bytes. Minimum value : 0 Maximum value : 9223372036854775807 integer (int64 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 643
optional Name of the consistency group. This property supports string case-insensitive filtering. import_xtremio_instance An instance of an import_xtremio_volume, import_xtremio_consistency_group Name cluster_guid optional Description Cluster GUID of the XtremIO storage system. Schema string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 644
(ip-address) address, IPv6 address, or FQDN (Fully Qualified Domain optional Name). name optional Name of the XtremIO storage supports case-insensitive filtering. system. This property string platform optional XtremIOPlatformEn um platform_l10n optional Localized message string added in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 645
Name Description software_vers ion Software version of the XtremIO storage system. optional Schema string state optional XtremIOStateEnum state_l10n optional Localized message string corresponding to state Was added string in version 1.0.2. supported_im port_type optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 646
Name schedule optional Description Schema For schedule_type of interval, a triplet in the form of '[hours : minutes : seconds'], where a schedule using hours and minutes must have a seconds value of 0 and a schedule in seconds must have hours and minutes of 0. For example, '[1:30:0'] takes a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 647
Name id optional Description Schema Unique identifier of the snapshot schedule retention policy. string long_period_d The duration of the long term period ranging from 1 to 500. uration Minimum value : 1 integer (int32) optional Maximum value : 500 long_period_u nit optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 648
Name Description Schema short_period_ duration optional The duration of the short term period ranging from 1 to 500. Minimum value : 0 integer (int32) Maximum value : 2147483647 short_period_ unit optional XtremIODurationUn itEnum short_period_ unit_l10n optional Localized message string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 649
Name Description import_xtrem io optional This is the embeddable import_xtremio_id attribute. reference form Schema of import_xtremio_inst ance import_xtrem io_consistency This is the embeddable reference form _group import_xtremio_consistency_group_id attribute. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 650
Name name optional Description Schema Name of the XtremIO volume. This insensitive filtering. property supports case- string severity optional XtremIOObjectSever ityEnum severity_l10n Localized message string corresponding to severity Was string optional added in version 1.0.2. size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 651
the port that uses this IP address to provide access to storage network services, such as iSCSI. string This attribute can be set only for of type Storage. name optional Name of the IP address. This property supports case- insensitive filtering. Was added in version 2.0.0.0. string Length : 1 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 652
Name node optional Description Schema This is the embeddable reference form of node_id attribute. node_instance node_id optional Unique identifier of the cluster node to which the IP string address belongs. purposes optional IP address purposes. < IpPurposeTypeEnu m > array purposes_l10n - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 653
Name eth_port optional Description Schema This is the attribute. embeddable reference form of eth_port_id eth_port_instance eth_port_id optional Unique identifier of the physical Ethernet front-end port on top of which the IP port is configured. This attribute can be set when the IP port - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 654
Name Description Schema Usages to add to the current usages of an IP port. The current usages of an IP port can be extended with external replication if this usage is in the port's list of available usages. The same settings will be applied to the partner IP port. add_current_ usages optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 655
Name high_value optional Description Schema Estimate for the upper bound forecasted value on that particular time. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 low_value optional Estimate for the lower bound forecasted value on that particular time. Minimum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 656
Name Description Schema time_to_full_o ptimistic optional Optimistic date-time for time to full based on bound of the forecast 95% confidence interval. the lower string (date-time) time_to_full_p Pessimistic date-time for time to full based on the upper essimistic string (date-time) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 657
Name issues optional messages optional response_type required Schema < validate_create_issue > array < error_message > array string job_cluster_forecast_response Polymorphism : Inheritance Discriminator : response_type Name high_value optional Description Schema Estimate of the upper bound of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 658
Name cluster_id optional Description Unique ID of the cluster. Schema string end_of_foreca Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full st string (date-time) capacity before it ends. In this case the end of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 659
Name response_type required Schema string job_create_response Create response for an operation. Polymorphism : Inheritance Discriminator : response_type Name id optional Description Unique identifier of the new instance created. response_type required Schema string string job_error_response - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 660
Name Description response_type required Schema string job_file_system_restore_response Backup snapshot of the file system created. Polymorphism : Inheritance Discriminator : response_type Name id optional Description The unique identifier of the created snapshot. response_type required - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 661
Name Description description_l1 0n Description of the job. optional Schema string end_time optional Date and time when the job execution completed. string (date-time) estimated_co mpletion_tim e optional Estimated completion date and time. string (date-time) id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 662
the job is string resource_nam Name of the resource on which the job is operating. This e string property supports case-insensitive filtering. optional resource_type optional ResourceTypeEnum resource_type _l10n Localized message string corresponding to resource_type optional string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 663
Name step_order optional Description Schema Order of a given job step with respect to its siblings within the job hierarchy. Minimum value : 0 integer (int32) Maximum value : 2147483647 user optional Name of the user associated with the job. string job_job_response Job response for an - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 664
job_migration_recommendation_create_migration_ses sions_response Polymorphism : Inheritance Discriminator : response_type Name Description migration_ses sion_ids ID of migration sessions created for the recommendation. optional Schema < string > array rescan_host_li IDs of attached hosts - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 665
Name Description response_type required Schema string snapshot_id optional Identifier of the optional snapshot instance created at the string end of the test. job_response Job response for an asynchronous request. The response to any asynchronous request that does not fail immediately. Name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 666
Name Description response_type required Schema string job_volume_group_clone_response Response for volume group clone action Polymorphism : Inheritance Discriminator : response_type Name id optional Description Unique identifier of the new instance created. response_type required Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 667
Name Description Schema backup_snaps Unique identifier of the backup snapshot set. This hot_id parameter will not be available if the create_backup_snap string optional was set to false. response_type required string job_volume_group_snapshot_response Unique identifier of the new snapshot - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 668
Name Description Schema backup_snaps hot_id optional Unique identifier of the backup snapshot of the target volume, if one is created prior to the restore operation. string response_type required string job_volume_snapshot_response Volume snapshot response definition. Polymorphism : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 669
be used in the future. When is_current is false for a X509 Certificate, boolean 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. is_valid optional Indicate whether this is a valid X509 Certificate - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 670
. For example, in Replication_HTTP, CA type certificates will use scope to indicate the origin of these certificates. Service, type and scope mapping are listed as below. - Certificate with Service Management_HTTP and Type of Server, scope value can be null(unused and optional). - Certificate with - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 671
keystore_archive_regenerate_response Success response body. Name Description Schema download_uri optional A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup string archive file. ldap_account_create Parameters for creating an LDAP account - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 672
Name id optional name optional role_id optional type optional type_l10n optional Description Unique identifier of the LDAP account. Schema string Name of the LDAP account. string Unique identifier of the role to which the LDAP account is string mapped. LDAPAccountTypeE num Localized message - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 673
Name Description Schema group_membe r_attribute optional Name of the LDAP attribute whose value contains the names of group members within a group. Default value is member. Length : 1 - 1023 string group_name_a Name of the LDAP attribute whose value indicates the ttribute group name. Default - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 674
Name port optional Description Schema Port number used to connect to the LDAP Server. Default values are LDAP(389), LDAPs(636), GlobalCatalog LDAP(3268), Global Catalog LDAPs(3269). integer (int32) Minimum value : 0 Maximum value : 65535 protocol optional LDAPProtocolEnum user_id_attrib - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 675
Name Description Schema group_object_ class optional LDAP object class for groups. Default value is group. In Active Directory, groups and users are stored in the same directory path, and are in a class called group. Default string value is group. Nested search level for performing group - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 676
Name protocol optional Description Schema LDAPProtocolEnum protocol_l10n Localized message string corresponding to protocol Was string optional added in version 1.0.3. user_id_attrib Name of the LDAP attribute whose value indicates the ute unique identifier of the user. Default value is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 677
Name Description Schema LDAP object class for groups. Default value is group. In group_object_ Active Directory, groups and users are stored in the same class directory path, and are in a class called group. Default string optional value is group. Length : 1 - 1023 Nested search level for - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 678
Name Description Schema user_id_attrib ute optional Name of the LDAP attribute whose value indicates the unique identifier sAMAccountName. of the user. Default value is string Length : 1 - 1023 user_object_cl LDAP object class for users. Default value is user. ass Length : 1 - 1023 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 679
Name name required password required role_id required Description Schema Name of the new local user account to be created. The name value can be 1 to 64 UTF-8 characters long, and may only use alphanumeric characters. Dot(.) is the only special string character allowed. Length : 1 - 64 Password - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 680
local_user_modify Name current_pass word optional Description Schema Current password of the local user. Any local user can change his own password by providing current_password string (password) along with the new password. is_locked optional Lock or unlock the local user account. Local user - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 681
Name reason_l10n optional Description Localized message string corresponding to reason Schema string to_appliance_i Unique identifier of the appliance to which the volume was d string relocated. optional login_session_instance Name id optional Description Unique identifier of the login - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 682
Name appliance_id optional Description Schema Appliance id configured. on which this maintenance window is string end_time optional Time when the maintenance window will close (or did string (date-time) close). id optional Unique identifier of the maintenance window. string is_enabled - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 683
Name issuer optional Description Distinguished name of the certificate issuer. Schema string key_length optional Private key length. Minimum value : 0 Maximum value : 2147483647 integer (int32) public_key_al gorithm optional Public key algorithm used to generate the key pair. string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 684
metrics_generate Metrics for specified entity Name entity required Description entity_id required Identifier for specific entity. interval optional Schema MetricsEntityEnum string MetricsIntervalEnu m metrics_generate_response Response will be just an array of one of the child of this - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 685
Name active optional Description Schema Whether this migration action in active or not. New recommendations will consist entirely of active recommendations but this may be changed with the modify boolean operation. Was added in version 2.0.0.0. connected_ap List of appliance ids to which the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 686
Name Description primary_nam e Name of the primary object. required Schema string resource_id required ID of storage resource migrated by this action. string resource_type required MigrationResourceT ypeEnum resource_type _l10n Localized message string corresponding to resource_type - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 687
Set evacuate_appliance parameters to evacuate space Filtering on the fields of this embedded resource is not supported. Name Description evacuate_appl iance Evacuate appliance by specifying optional space_to_free optional Schema evacuate_appliance evacuate_appl Evacuate all - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 688
evacuate_appliance_all Name appliance_id required Description Schema ID of appliance on which all selected storage objects are located string Example : "evac_from_appliance" target_applia nce_ids optional Optional IDs of appliances to which used storage can be migrated for this request. If - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 689
recommendation. string migration_act ions optional < Filtering on the fields of this embedded resource is not migration_recomme supported. ndation_action > array request_para meters optional migration_recomme ndation_create rescan_host_li IDs of hosts that must be rescanned after migration - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 690
or automatic. Default for virtual_volume resource type over boolean migrations is automatic, otherwise the default is manual. optional Default : false destination_a ppliance_id required Unique identifier of the destination appliance instance. string family_id required Family identifier - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 691
Name name optional Description Schema User-specified friendly name of the migration session instance. The name can contain a characters. It cannot contain maximum of unprintable 32 Unicode characters, string special HTTP characters, or whitespace. resource_type required MigrationResourceT - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 692
. optional string (date-time) name optional User-specified friendly name of the migration session string instance. This property supports case-insensitive filtering. progress_perc Progress percentage of the current sync operation. entage Minimum value : 0 optional Maximum value : 2147483647 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 693
< volume_instance > array migration_session_sync Name Description Schema automatic_cut Indicates whether the migration session cutover is manual over or automatic. Default is manual. boolean optional Default : false rescan_compl ete optional Indicates whether a rescan will be performed - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 694
enables you to automatically generates this Unix user (uid), if that Windows user does not have any in the configured Unix boolean directory service (UDS). In a pure SMB or non multiprotocol environment, this should be set to true. Default : false is_username_t Enable the possibility to match - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 695
Name domain_pass word optional Description Schema 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 string (password) the skipDomainUnjoin parameter is false or not set, and the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 696
Name Description Schema current_prefe rred_IPv6_int erface_id Unique identifier interface. of the current active preferred IPv6 string optional current_unix_ directory_ser vice optional NASServerCurrentU nixDirectoryService Enum current_unix_ directory_ser Localized message string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 697
), if that Windows user does not have any in the configured Unix boolean directory service (UDS). In a pure SMB or non multiprotocol environment, this should be set Name of the NAS server. insensitive filtering. This property supports case- string nfs_servers optional < This is the inverse of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 698
Name Description operational_st atus_l10n optional Localized message operational_status string corresponding Schema to string preferred_no de_id optional Unique identifier of the preferred node for the NAS server The initial value (on NAS server creation) is taken from the string current - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 699
enables you to automatically generate this Unix user (uid), if that Windows user does not have any in the configured Unix boolean directory service (UDS). In a pure SMB or non multiprotocol environment, this should be set to true. Default : false is_username_t Enable the possibility to match - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 700
Name Description Schema production_IP v6_interface_i Unique identifier d interface. of the preferred IPv6 production string optional nas_server_ping Request body for ping arguments. Name Description Schema destination_a ddress optional Destination to ping, can be either an IP - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 701
1 Maximum value : 127 integer (int32) purposes required 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 NetworkPurposeEnu purposed networks, like management, vMotion - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 702
value : 1 Maximum value : 127 integer (int32) purposes optional 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 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 703
Name Description add_addresse s IP addresses to add in IPv4 or IPv6 format. optional Schema < string (ip-address) > array cluster_mgmt _address optional • New cluster management IP address in IPv4 or IPv6 format, corresponding to the network's IP version. • This can only be specified when - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 704
Name mtu optional Description Schema Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes. Minimum value : 1280 integer (int32) Maximum value : 9000 name optional Name of the network. Was added in version 2.0.0.0. Length : 1 - 128 string prefix_length optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 705
network_replace Name Description Schema cluster_mgmt New cluster management IP address in IPv4 or IPv6 format, _address corresponding to the network's IP version. string (ip-address) required Minimum length : 1 dns_addresses < string (ip-address) List of new DNS server IP addresses in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 706
Name Description Schema ntp_addresses List of new NTP server FQDNs or IP addresses in IPv4 or < string (ip-address) required IPv6 format. > array physical_switc List of new physical switches settings. If this property is < hes omitted, physical switches configuration will not be - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 707
Name Description connections optional Supported connections for a physical switch. name optional purpose optional Name of a physical switch. Schema < network_replace_ph ysical_switch_conne ction > array string PhysicalSwitchPurp oseEnum network_replace_physical_switch_connection Name address - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 708
Name port required Description Port used for sending SMTP messages. Minimum value : 0 Maximum value : 65535 source_email Source email address used for sending SMTP messages. required Schema integer (int32) string network_scale Parameters for the network scale operation. Name add_port_ids - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 709
Name Description anonymous_G ID optional Specifies the group ID of the anonymous account. Default : -2 Minimum value : -2147483648 Maximum value : 2147483647 Schema integer (int32) Specifies the user ID of the anonymous account. anonymous_U Default : -2 ID Minimum value : -2147483648 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 710
Name Description Schema read_only_hos ts optional 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 @. < string > array Hosts with - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 711
ityEnum min_security_ l10n Localized message string corresponding to min_security optional string name optional NFS Export name. This property supports case-insensitive string filtering. nfs_owner_us ername optional (Applies to NFS shares of VMware NFS storage resources.) Default owner - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 712
Name path optional Description Schema Local path to a location within the file system. With NFS, each export must have a unique local path. By default, the system exports the root of the file system (top-most directory) at the time the file system is created. This path specifies the unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 713
Name Description Schema add_read_onl y_hosts optional Hosts to add to the current read_only_hosts list. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), < string > array or Netgroups prefixed with @. Error if the host already - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 714
Name min_security optional Description Schema NFSExportMinSecur ityEnum no_access_hos Hosts with no access to the NFS export or its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, ts < string > array IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or optional IPv4/subnetmask), - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 715
Name Description Schema Hosts to remove from the current read_only_root_hosts list. remove_read_ Hosts can be entered by Hostname, IP addresses (IPv4, only_root_hos ts IPv6, IPv4/PrefixLength, IPv4/subnetmask), or Netgroups IPv6/PrefixLenght, or prefixed with @. Error if < string > array - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 716
more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. - false - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to boolean Unix Directory - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 717
nfs_server_delete Arguments for the NFS server delete operation. Name Description Schema Allow to bypass NFS server unjoin. If false delete will fail if is_skip_unjoin optional secure is enabled and current kdc_type is MS Windows. If secure is enabled either unjoin NFS server before doing - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 718
more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. - false - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to boolean Unix Directory - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 719
Name Description Schema nas_server_id optional The unique share. identifier of the NAS server that serves this string service_princi The Service Principal Name (SPN) for the NFS server. This pal_name name is updated automatically when the NFS server string optional configuration - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 720
groups in a Unix boolean 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. Indicates whether NFSv3 is enabled - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 721
nfs_server_unjoin Request arguments for the NFS server unjoin operation. Name domain_pass word required Description Schema Password of the domain-user Active Directory domain. specified to unjoin from the string (password) domain_user_ Name of a domain-user with privileges to unjoin from - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 722
Name addresses optional id optional Description Schema NTP server addresses. This list may contain IPv4 addresses, IPv6 addresses, and host names. < string > array Unique identifier of the NTP setting. string ntp_modify Name addresses required Description Schema NTP server addresses. This - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 723
message string corresponding to entity string io_workload_c pu_utilization optional The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests. number (float) read_bandwid th Read rate in bytes per second. optional number (float) read_iops optional Total - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 724
write operations in bytes. number (float) avg_io_worklo The average percentage of CPU Utilization on the cores ad_cpu_utiliza dedicated to servicing storage I/O requests. Calculated over tion time interval across appliance. Derived from an average of number (float) optional utilization across - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 725
Name Description avg_total_iops optional Average total input and output operations per second. Schema number avg_write_ban dwidth Weighted average write bandwidth in bytes per second. optional number (float) avg_write_iop s Average writes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 726
size in bytes. optional Schema number (float) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests. Calculated over number (float) ation time interval across appliance. Derived from an average of optional utilization - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 727
performance_metrics_by_cluster Performance metrics for the cluster collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional Description Average size of read and write operations in bytes. avg_latency optional Average read and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 728
Name repeat_count optional Description Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity. required timestamp optional End of sample period. total_bandwid th Total data transfer rate in bytes per - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 729
Name Description avg_read_iops optional Average reads per second. Schema number (float) avg_read_late ncy Weighted average read latency in microseconds. optional number (float) avg_read_size Weighted average read size in bytes. optional number (float) avg_total_ban dwidth Weighted - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 730
Name Description Schema max_avg_io_si ze optional Maximum bytes. average size of input and output operations in number (float) max_avg_late ncy optional Maximum of average latency in microseconds. number (float) max_avg_read _latency Maximum read latency in microseconds. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 731
Name Description max_write_io ps optional Maximum writes per second. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity. required timestamp optional End of sample period. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 732
Name Description Schema pkt_rx_crc_er ror_ps optional The number of packets dropped) per second. received with CRC error (and thus number (float) pkt_rx_no_buf The number of packets discarded per second due to lack of fer_error_ps number (float) buffer space. optional pkt_rx_ps - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 733
Name Description avg_bytes_tx_ ps optional The average total bytes transmitted per second. Schema number (float) avg_pkt_rx_cr The average number of packets received with CRC error c_error_ps number (float) (and thus dropped) per second. optional avg_pkt_rx_no _buffer_error_ ps The - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 734
Name Description Schema max_pkt_rx_n o_buffer_erro r_ps The maximum number of due to lack of buffer space. packets discarded per second number (float) optional max_pkt_rx_p s The maximum number of packets received per second. optional number (float) max_pkt_tx_e rror_ps optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 735
Name bytes_rx_ps optional Description The total bytes received per second. Schema number (float) bytes_tx_ps optional The total bytes transmitted per second. number (float) entity required Localized message string corresponding to entity. MetricsEntityEnum entity_l10n optional Localized - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 736
Name timestamp optional Description End of sample period. Schema string (date-time) performance_metrics_by_fe_eth_port_rollup Performance metrics for the frontend ethernet port rolled up at various rollup intervals. Polymorphism : Inheritance Discriminator : response_definition Name appliance_id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 737
Name entity_l10n optional Description Localized message string corresponding to entity Schema string fe_port_id optional Reference to the associated frontend ethernet port string (eth_port) on which these metrics were recorded. max_bytes_rx _ps The maximum total bytes received per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 738
Name Description response_defi nition Response definition for the entity. required timestamp optional End of sample period. Schema string string (date-time) performance_metrics_by_fe_fc_node Fibre channel performance metrics for the node collected at twenty second interval. Polymorphism : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 739
Name entity required Description Localized message string corresponding to entity. Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string invalid_crc_co unt_ps Invalid crc count per second. optional number (float) invalid_tx_wo rd_count_ps - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 740
Name Description response_defi nition Response definition for the entity. required timestamp optional End of sample period. total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations per second. unaligned_ba ndwidth - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 741
Name write_iops optional Description Total write operations per second. Schema number (float) performance_metrics_by_fe_fc_node_rollup Fibre channel performance metrics for the node rolled up at various rollup intervals. Polymorphism : Inheritance Discriminator : response_definition Name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 742
Name Description avg_loss_of_sy nc_count_ps Average loss of sync count per second. optional Schema number (float) avg_prim_seq_ prot_err_coun Average primitive sequence protocol error count per number (float) t_ps second. optional avg_read_ban dwidth Weighted average read bandwidth in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 743
Name Description avg_unaligned _read_iops Average unaligned read input/output per second. optional Schema number (float) avg_unaligned _write_bandw Average unaligned write rate in bytes per second. idth optional number (float) avg_unaligned _write_iops Average unaligned write input/output - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 744
Name Description max_avg_read _latency Maximum read latency in microseconds. optional Schema number (float) max_avg_read _size Maximum of average read size in bytes. optional number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional number ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 745
Name Description max_loss_of_s ync_count_ps The maximum loss of sync count per second. optional Schema number (float) max_prim_se q_prot_err_co unt_ps optional The maximum primitive sequence protocol error count per number (float) second. max_read_ba ndwidth optional Maximum read bandwidth in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 746
Name Description max_unaligne d_write_band width Maximum unaligned write rate in bytes per second. optional Schema number (float) max_unaligne d_write_iops Maximum unaligned write input/output per second. optional number (float) max_write_ba ndwidth Maximum write bandwidth in bytes per - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 747
Name avg_io_size optional Description Average size of read and write operations in bytes. Schema number (float) avg_latency optional Average read and write latency in microseconds. number (float) avg_read_late ncy Average read latency in microseconds. optional number (float) avg_read_size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 748
Name Description invalid_tx_wo rd_count_ps Invalid transmission word count per second. optional link_failure_c ount_ps Link failure count per second. optional loss_of_signal _count_ps Loss of signal count per second. optional loss_of_sync_c ount_ps Loss of sync count per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 749
Name Description total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations per second. unaligned_ba ndwidth optional Unaligned read/write rate in bytes per second. unaligned_iop s Unaligned total input/output per second. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 750
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 751
Name Description avg_read_ban dwidth Weighted average read bandwidth in bytes per second. optional avg_read_iops Average reads per second. optional avg_read_late ncy Weighted average read latency in microseconds. optional avg_read_size optional Weighted average read size in bytes. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 752
Name Description avg_unaligned _write_iops Average unaligned write input/output per second. optional Schema number (float) avg_write_ban dwidth Weighted average write bandwidth in bytes per second. optional number (float) avg_write_iop s Average writes per second. optional number (float - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 753
Name Description max_avg_writ e_latency Maximum of average write latency in microseconds. optional Schema number (float) max_avg_writ e_size Maximum of average write size in bytes. optional number (float) max_current_ Maximum number of logins to the target from initiators. logins - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 754
Name Description max_read_ba ndwidth optional Maximum read bandwidth in bytes per second. Schema number (float) max_read_iop s Maximum reads per second. optional number (float) max_total_ba ndwidth optional Maximum total bandwidth in bytes per second. number (float) max_total_iop s - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 755
Name Description max_write_ba ndwidth Maximum write bandwidth in bytes per second. optional max_write_io ps optional Maximum writes per second. node_id optional Reference to the node the port belongs to. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 756
Name Description avg_write_late ncy Average write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) entity required Localized message string corresponding to entity. MetricsEntityEnum entity_l10n optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 757
Name Description write_bandwi dth Write rate in bytes per second. optional write_iops optional Total write operations per second. Schema number (float) number (float) sdnas_file_system_metrics_rollup Summary of file system level performance metric data for the period beginning with - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 758
Name Description avg_write_ban dwidth Average write rate in bytes per second. optional Schema number (float) avg_write_iop s Average write operations per second. optional number (float) avg_write_late ncy Maximum of average write latency in microseconds. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 759
Name Description max_avg_writ e_size Maximum of average write size in bytes. optional Schema number (float) max_iops optional Maximum read and write operations per second. number (float) max_read_ba ndwidth optional Maximum read rate in bytes per second. number (float) max_read_iop s - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 760
version 2.0.0.0. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional Description Average size of read and write operations in bytes. avg_latency optional Average read and write latency in microseconds. avg_read_late ncy Average read latency in microseconds - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 761
Name Description response_defi nition Response definition for the entity. required timestamp optional End of sample period. total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations per second. write_bandwi dth Write - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 762
Name Description avg_read_late ncy Weighted average read latency in microseconds. optional Schema number (float) avg_read_size Weighted average read size in bytes. optional number (float) avg_total_ban dwidth Weighted average total bandwidth in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 763
Name Description max_avg_late ncy optional Maximum of average latency in microseconds. max_avg_read _latency Maximum read latency in microseconds. optional max_avg_read _size Maximum of average read size in bytes. optional max_avg_writ e_latency Maximum of average write latency in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 764
Name repeat_count optional Description Number of times the metrics is repeated. Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity. required timestamp optional End of sample period. Schema integer (int32) string string (date-time) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 765
string corresponding to entity string io_workload_c pu_utilization optional The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests. number (float) node_id optional Unique identifier representing a specific node. string read_bandwid th Read rate in bytes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 766
Name Description unaligned_ba ndwidth optional Unaligned read/write rate in bytes per second. unaligned_iop s Unaligned total input/output per second. optional unaligned_rea d_bandwidth Unaligned read rate in bytes per second. optional unaligned_rea d_iops Unaligned read input/output per - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 767
operations in bytes. number (float) avg_io_worklo The average percentage of CPU Utilization on the cores ad_cpu_utiliza tion dedicated to servicing storage I/O requests. Calculated over time across appliance. Derived from an average of number (float) optional utilization across all nodes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 768
Name Description avg_unaligned _read_bandwi dth Average unaligned read rate in bytes per second. optional Schema number (float) avg_unaligned _read_iops Average unaligned read input/output per second. optional number (float) avg_unaligned _write_bandw idth Average unaligned write rate - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 769
Maximum value : 9223372036854775807 integer (int64) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests. Calculated over number (float) ation time across appliance. Derived from an average of optional utilization - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 770
Name Description max_unaligne d_bandwidth Maximum unaligned read/write rate in bytes per second. optional Schema number (float) max_unaligne d_iops Maximum unaligned total input/output per second. optional number (float) max_unaligne d_read_bandw idth Maximum unaligned read rate in bytes - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 771
Name timestamp optional Description End of sample period. Schema string (date-time) performance_metrics_by_vg Performance metrics for the volumes in a volume group collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 772
Name read_iops optional Description Total read operations per second. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity. required timestamp optional End of sample period. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 773
Name avg_latency optional Description Average read and write latency in microseconds. avg_read_late ncy Average read latency in microseconds. optional avg_read_size Average read size in bytes. optional avg_write_late ncy Average write latency in microseconds. optional avg_write_size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 774
Name Description total_bandwid th Total data transfer rate in bytes per second. optional Schema number (float) total_iops optional Total read and write operations per second. number (float) vm_id optional Unique identifier representing a specific virtual machine. string write_bandwi dth - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 775
Name Description avg_read_size optional Weighted average read size in bytes. Schema number (float) avg_total_ban dwidth Weighted average total bandwidth in bytes per second. optional number (float) avg_total_iops Average total input and output operations per second. optional number (float - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 776
Name Description max_avg_read _size Maximum of average read size in bytes. optional max_avg_writ e_latency Maximum of average write latency in microseconds. optional max_avg_writ e_size Maximum of average write size in bytes. optional max_read_ba ndwidth optional Maximum read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 777
Name timestamp optional Description End of sample period. Schema string (date-time) vm_id optional Unique identifier representing a specific virtual machine. string performance_metrics_by_volume Performance metrics for the volume collected at twenty second interval. Polymorphism : Inheritance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 778
Name Description read_bandwid th Read rate in bytes per second. optional read_iops optional Total read operations per second. repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 779
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string avg_io_size optional Average size of read and write operations in bytes. number (float) avg_latency optional Weighted average latency in microseconds. number - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 780
Name Description avg_write_size optional Weighted average write size in bytes. Schema number (float) entity required Localized message string corresponding to entity. MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string max_avg_io_si ze optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 781
Name Description max_total_ba ndwidth optional Maximum total bandwidth in bytes per second. max_total_iop s Maximum totals per second. optional max_write_ba ndwidth Maximum write bandwidth in bytes per second. optional max_write_io ps optional Maximum writes per second. repeat_count - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 782
Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Average read and write latency in microseconds. number (float) avg_read_late ncy Average read latency in microseconds. optional number (float) avg_read_size optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 783
Name timestamp optional Description End of sample period. total_bandwid th Total data transfer rate in bytes per second. optional total_iops optional Total read and write operations per second. write_bandwi dth Write rate in bytes per second. optional write_iops optional Total write - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 784
Name Description avg_read_late ncy Maximum of average read latency in microseconds. optional Schema number (float) avg_read_size Average read size in bytes. optional number (float) avg_total_ban dwidth Average data transfer rate in bytes per second. optional number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 785
Name Description max_avg_read _latency Maximum of average read latency in microseconds. optional Schema number (float) max_avg_read _size Maximum of average read size in bytes. optional number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 786
Name Description response_defi nition Response definition for the entity. required timestamp optional Time at the beginning of sample period. Schema string string (date-time) sdnas_file_by_cluster_instance Performance metrics cluster for the file collected at twenty second interval. Was - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 787
Name Description read_bandwid th Read rate in bytes per second. optional Schema number (float) read_iops optional Total read operations per second. number (float) repeat_count optional Number of consecutive sampling periods during which there were no changes in the metrics values. If the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 788
Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Maximum of average read and write latency in number (float) microseconds. avg_read_ban dwidth Average read rate in bytes per second. optional number (float) avg_read_iops - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 789
Name entity required Description Localized message string corresponding to entity. Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string max_avg_io_si ze Maximum of average read and write size in bytes. optional number (float) max_avg_late - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 790
Name Description max_total_ba ndwidth optional Maximum data transfer rate in bytes per second. Schema number (float) max_write_ba ndwidth Maximum write rate in bytes per second. optional number (float) max_write_io ps optional Maximum write operations per second. number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 791
Name Description avg_read_size optional Average read size in bytes. Schema number (float) avg_write_late ncy Average write latency in microseconds. optional number (float) avg_write_size Average write size in bytes. optional number (float) entity required Localized message string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 792
Name total_iops optional Description Total read and write operations per second. write_bandwi dth Write rate in bytes per second. optional write_iops optional Total write operations per second. Schema number (float) number (float) number (float) sdnas_file_by_node_rollup Summary of file - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 793
Name Description avg_total_iops optional Average read and write operations per second. Schema number (float) avg_write_ban dwidth Average write rate in bytes per second. optional number (float) avg_write_iop s Average write operations per second. optional number (float) avg_write_late - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 794
Name Description max_avg_writ e_size Maximum of average write size in bytes. optional Schema number (float) max_iops optional Maximum read and write operations per second. number (float) max_read_ba ndwidth optional Maximum read rate in bytes per second. number (float) max_read_iop s - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 795
sdnas_nfs_metrics_instance Performance metrics for the nfs collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Average read and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 796
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 response_defi - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 797
Name Description Schema avg_read_ban dwidth optional Average read rate version 2.0.0.0. in bytes per second. Was added in number (float) avg_read_iops Average read operations per second. optional number (float) avg_read_late ncy Maximum read latency in microseconds. optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 798
Name Description max_avg_io_si ze Maximum of average read and write size in bytes. optional Schema number (float) max_avg_late Maximum of average read and write latency in ncy number (float) microseconds. optional max_avg_read _latency Maximum of average read latency in microseconds. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 799
Name Description max_write_io ps optional Maximum write operations per second. Schema number (float) node_id optional Unique identifier of the node. string repeat_count optional Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 800
identifier of the nfs. Schema string read_iops optional Total read iops in microseconds. number (float) repeat_count optional Number of consecutive optional Total read and write iops in microseconds. number (float) write_iops optional Total write iops in microseconds. number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 801
Name avg_md_ops optional Description Average md operations per second. avg_read_iops Average read operations per second. optional avg_total_iops Average read and write operations per second. optional avg_write_iop s Average write operations per second. optional entity required Localized - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 802
Total failed md operations per second. md_ops optional Total md operations per second. node_id optional Unique identifier of the nfs. read_iops optional Total read iops in microseconds. Schema number (float) MetricsEntityEnum string number (float) number (float) string number (float) 801 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 803
timestamp optional End of sample period. string (date-time) total_iops optional Total read and write iops in microseconds. number (float) write_iops optional Total write iops in microseconds. number (float) sdnas_nfs3_metrics_rollup Summary of nfs level performance metric data for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 804
Name Description avg_total_iops optional Average read and write operations per second. Schema number (float) avg_write_iop s Average write operations per second. optional number (float) entity required Localized message string corresponding to entity. MetricsEntityEnum entity_l10n - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 805
Name Description response_defi nition Response definition for the entity. required timestamp optional Time at the beginning of sample period. Schema string string (date-time) sdnas_smb_v1_client_metrics_instance Performance metrics for the smb v1 client collected at twenty second interval. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 806
Name node_id optional Description Unique identifier of the node. Schema string read_iops optional Total read operations per second. number (float) repeat_count optional Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 807
Name avg_iops optional Description Average read and write operations per second. Schema number (float) avg_latency optional Maximum read and write latency in microseconds. number (float) avg_read_iops Average read operations per second. optional number (float) avg_read_late ncy Maximum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 808
Name Description max_avg_read _size Maximum of average read size in bytes. optional Schema number (float) max_avg_size Maximum of average read and write size in bytes. optional number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional number (float - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 809
Name timestamp optional Description Time at the beginning of sample period. Schema string (date-time) sdnas_smb_v1_node_metrics_instance Performance metrics for the smb v1 node collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 810
Name repeat_count optional Description Schema Number of consecutive sampling periods during which there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 response_defi - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 811
Name Description avg_read_iops optional Average read operations per second. Schema number (float) avg_read_late ncy Maximum read latency in microseconds. optional number (float) avg_read_size Average read size in bytes. optional number (float) avg_write_iop s Average write operations - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 812
Name Description max_avg_writ e_latency Maximum of average write latency in microseconds. optional Schema number (float) max_avg_writ e_size Maximum of average write size in bytes. optional number (float) max_calls optional Maximum calls. number (float) max_iops optional Maximum read - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 813
Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Average read and write latency in microseconds. number (float) avg_read_late ncy Average read latency in microseconds. optional number (float) avg_read_size optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 814
Name timestamp optional Description End of sample period. total_calls optional Total calls. total_iops optional Total read and write operations per second. write_iops optional Total write operations per second. Schema string (date-time) number (float) number (float) number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 815
Name Description avg_write_iop s Average write operations per second. optional Schema number (float) avg_write_late ncy Maximum write latency in microseconds. optional number (float) avg_write_size optional Average write size in bytes. number (float) entity required Localized message - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 816
Name max_iops optional Description Maximum read and write operations per second. Schema number (float) max_read_iop s Maximum read operations per second. optional number (float) max_write_io ps optional Maximum write operations per second. number (float) node_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 817
Name Description avg_read_late ncy Average read latency in microseconds. optional Schema number (float) avg_read_size Average read size in bytes. optional number (float) avg_write_late ncy Average write latency in microseconds. optional number (float) avg_write_size optional Average - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 818
Name total_iops optional write_iops optional Description Total read and write operations per second. Total write operations per second. Schema number (float) number (float) sdnas_smb_v2_node_metrics_rollup Summary of smb v1 node level performance metric data for the period beginning with - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 819
Name Description avg_write_late ncy Maximum write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) entity required Localized message string corresponding to entity. MetricsEntityEnum entity_l10n optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 820
Name Description max_read_iop s Maximum read operations per second. optional Schema number (float) max_write_io ps optional Maximum write operations per second. number (float) node_id optional Unique identifier of the node. string repeat_count optional Number of consecutive sampling - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 821
Name Description hash_avg_size optional Average hash size. Schema number (float) hash_max_lat ency Max hash latency. optional number (float) hash_max_siz e Max hash size. optional number (float) hash_min_late ncy Min hash latency. optional number (float) hash_min_size Max hash - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 822
Name total_tasks optional Description Total tasks. Schema number (float) sdnas_smb_cache_metrics_rollup Performance metrics nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 823
Name Description hash_min_late ncy Min hash latency. optional Schema number (float) hash_min_size Max hash size. optional number (float) max_used_thr eads Max used threads optional number (float) node_id optional Unique identifier of the node. string repeat_count optional Number of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 824
Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Average read and write latency in microseconds. number (float) avg_read_late ncy Average read latency in microseconds. optional number (float) avg_read_size optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 825
Name timestamp optional Description End of sample period. total_calls optional Total calls. total_iops optional Total read and write operations per second. write_iops optional Total write operations per second. Schema string (date-time) number (float) number (float) number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 826
Name Description avg_write_iop s Average write operations per second. optional Schema number (float) avg_write_late ncy Maximum write latency in microseconds. optional number (float) avg_write_size optional Average write size in bytes. number (float) entity required Localized message - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 827
Name max_iops optional Description Maximum read and write operations per second. Schema number (float) max_read_iop s Maximum read operations per second. optional number (float) max_write_io ps optional Maximum write operations per second. number (float) node_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 828
Name Description avg_read_late ncy Average read latency in microseconds. optional Schema number (float) avg_read_size Average read size in bytes. optional number (float) avg_write_late ncy Average write latency in microseconds. optional number (float) avg_write_size optional Average - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 829
Name Description Schema total_bandwid th optional Total data transfer rate in bytes per second. Was added in version 2.0.0.0. number (float) total_calls optional Total calls. number (float) total_iops optional Total read and write operations per second. number (float) write_bandwi dth - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 830
Name Description avg_read_iops optional Average read operations per second. Schema number (float) avg_read_late ncy Maximum read latency in microseconds. optional number (float) avg_read_size Average read size in bytes. optional number (float) avg_total_ban dwidth optional Average data - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 831
Name Description max_avg_read _size Maximum of average read size in bytes. optional Schema number (float) max_avg_size Maximum of average read and write size in bytes. optional number (float) max_avg_writ e_latency Maximum of average write latency in microseconds. optional number (float - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 832
beginning of sample period. string (date-time) performance_rule_instance Quality of service rule in a performance policy for policy based management of storage resources performance case-insensitive filtering. rule. This property supports string policies optional List of the policies that - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 833
Name Description connect_meth od required Schema PhysicalSwitchConn ectMethodEnum port optional Port used for connection to switch. Minimum value : 0 Maximum value : 65535 integer (int32) snmp_commu SNMPv2 community string, if SNMPv2c connect method is nity_string specified. string ( - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 834
Name Description physical_switc h_id optional Id of physical switch to which connection belongs. Maximal length : 128 Schema string port optional Port used for connection to switch. Minimum value : 0 Maximum value : 65535 integer (int32) username optional Username to connect a physical - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 835
identifier of the physical switch setting. Length : 1 - 32 string name optional Name of physical switch. This property supports case- insensitive filtering. string Length : 1 - 128 purpose optional PhysicalSwitchPurp oseEnum purpose_l10n Localized message string corresponding to purpose - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 836
Name name optional purpose optional Description Name of physical switch. Length : 1 - 128 Schema string PhysicalSwitchPurp oseEnum policy_create Policy create request. Name description optional Description Policy description. Schema string name required Policy name. string replication_ru - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 837
. A policy of this type is restricted from many operations. boolean Default : false name optional Policy name. This property supports case-insensitive string filtering. performance_ rules optional List of policy. the performance_rules that are associated with this < performance_rule_i - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 838
policy. the current < string > array protection_data_instance Protection data associated with a resource. Filtering on the fields of this embedded resource is not supported. Name Description copy_signatur e Used for tracking replicated copies of a snapshot set. optional Schema string 837 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 839
Name Description Schema created_by_ru le_id optional Unique identifier snapshot. of the snapshot rule that created the string created_by_ru The name of the rule that created the snapshot. This value le_name will not change if the name of the rule changes after string optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 840
contact for this system. Was added in version 2.0.0.0. string Maximal length : 256 first_name optional The first name of the support contact for this system. Was added in version 2.0.0.0. string Maximal length : 128 id optional The unique id of the remote_support_contact instance. Maximal - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 841
contact for this system. Was added in version 2.0.0.0. string Maximal length : 128 The phone number of this support contact for this system. Was added in version 2.0.0.0. string Maximal length : 64 remote_syslog_server_create Create a remote syslog server configuration. Was added in version - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 842
Name audit_types optional Description Schema Audit type selections. If empty, all types will be sent to the < remote log server. Otherwise, only audit events of the AuditEventTypeEnu specified type(s) will be sent. m > array audit_types_l1 Localized message array corresponding to audit_types - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 843
as part of the remote syslog server test operation. string Maximal length : 256 remote_system_create Create a remote system. For a PowerStore remote system, an x509 Replication HTTP Certificate is a prerequisite. Refer to the x509_certificate resource type's exchange operation API documentation - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 844
system. management_ address required Management IP address of the remote system instance. Only IPv4 is supported for non-PowerStore remote systems. Both IPv4 and IPv6 are supported for PowerStore remote string (ip-address) systems. name optional User-specified name of the remote system. Used - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 845
fields of this embedded resource is not tance > array supported. data_network _latency Network latency for the remote system. optional string discovery_cha Discovery chap mode for the non-PowerStore remote RemoteSystemChap p_mode system. ModeEnum optional discovery_cha p_mode_l10n - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 846
User-specified name of the remote system instance. This property supports case-insensitive filtering. string replication_se ssions optional This is the session_chap_ mode Session chap mode for the non-PowerStore remote system. optional RemoteSystemChap ModeEnum session_chap_ Localized - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 847
address of the remote system. optional string (ip-address) name optional User-specified name of the remote system. Used only for non-PowerStore type remote systems. This value contain 128 or fewer printable Unicode characters. must string Maximal length : 128 remote_passw Password used to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 848
Type : object replication_element_pair Replication session element pair which maps the local storage element to the remote storage element. Name Description local_storage_ element_id Unique identifier of a local storage element. required Schema string remote_storag e_element_id Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 849
a resource to the local system. boolean Default : false name optional Name of the replication rule. This property supports casestring insensitive filtering. policies optional List of the policies that are associated with this < policy_instance > replication_rule. array remote_syste - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 850
of an unplanned failover. If a failover_snapshot_id is not specified, the destination will be restored to the last common base string snapshot. This identifier is not supported when a failover test is in progress. Was added in version 2.0.0.0. 849 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 851
Name force optional Description Schema Indicates whether an unplanned failover needs to be performed state. for a session that is already in a failed over boolean Default : false is_planned optional Indicates whether the replication session failover is planned or unplanned. For - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 852
Name id optional Description Unique identifier of the replication session instance. Schema string last_sync_dur ation optional Elapsed time of the last synchronization operation in milliseconds. Was added in version 2.0.0.0. Minimum value : 0 Maximum value : 2147483647 integer (int32) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 853
pair > array volume/virtual volume replication session, there will be only one storage element pair. Filtering on the fields of this embedded resource is not supported. replication_session_stop_failover_test_response Stop disaster recovery (DR) test response. Was added in version 2.0.0.0. 852 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 854
Name snapshot_id optional Description Schema Identifier of the end of the test. optional snapshot instance created at the string replication_start_failover_test Parameter(s) to start a disaster recovery (DR) failover simulation test at the destination site of a replication session. Was - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 855
role_instance Name description optional Description Description of the role. id optional Unique identifier of the role. is_built_in optional Indicates whether the role is built-in. name optional Name of the role. Schema string string boolean string sas_port_instance This resource type has - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 856
are: true Link is up. false Link is down. Schema boolean name optional Name of the SAS port. This property supports casestring insensitive filtering. node optional This is the embeddable reference form of node_id attribute. hardware_instance node_id optional Unique identifier of containing - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 857
sc_profile_rule_instance Snapshot profile rule. Name Description date_of_mont h optional Dates of the month in which a snapshot will be taken. Schema < integer > array day_of_week Days of the week in which a snapshot will be taken. optional < DayOfWeekEnum > array day_of_week_l 10n - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 858
Name name optional Description Name of the snapshot profile rule. Schema string start_date_tim Date and time when the snapshot will be created. This e string (date-time) applies to the value Once in the ScScheduleTypeEnum. optional start_time optional Time when snapshot creation will start. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 859
state. is_ssh_enable d required true false Enables SSH access Disables SSH access Schema boolean service_user_instance Name id optional Description Unique identifier of the service user account. is_built_in optional Whether the user account is built-in or not. Schema string boolean 858 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 860
not. optional boolean name optional Name of the service user account. Always 'service' in this string release. service_user_modify Name password required white space (blank) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/909264/) Length : 1 - 63 859 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 861
quotation mark ("") - less than sign () - vertical bar (|) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/ 909264/) Length : 1 - 15 workgroup optional Applies to standalone SMB servers only. Windows network workgroup for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 862
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/) description optional Description of the SMB server. string domain optional Domain name where SMB - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 863
mark (?) quotation mark ("") - less than sign () - vertical bar (|) as definied by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/ 909264/) workgroup optional Applies to stand-alone SMB servers only. Windows network workgroup for the SMB - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 864
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/) Length : 1 - 63 description optional Description of the SMB server in UTF-8 characters. Length : 0 - 48 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 865
quotation mark ("") - less than sign () - vertical bar (|) as defined by the Microsoft naming convention (see https://support.microsoft.com/en-us/help/ 909264/) Length : 1 - 15 workgroup optional Applies to standalone SMB servers only. Windows network workgroup for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 866
Name description optional Description SMB share description. Length : 0 - 511 Schema string file_system_id Unique identifier of the file system on which the SMB Share string required will be created. Indicates whether Access-based Enumeration (ABE) is enabled. ABE filters the list of - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 867
Name path required umask optional Description Schema Local path to the file system or any existing sub-folder of the file system that is shared over the network. This path is relative to the NAS Server and must start with the filesystem's mountpoint path, which is the filesystem name. For example - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 868
is enabled. - false - Encryption for SMB 3.0 is disabled. boolean name optional SMB share name. This property supports case-insensitive string filtering. offline_availa bility optional SMBShareOfflineAv ailabilityEnum offline_availa Localized message bility_l10n offline_availability optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 869
smb_share_modify Name description optional Description NFS Share description. Length : 0 - 511 Schema string Indicates whether Access-based Enumeration (ABE) is is_ABE_enable enabled. ABE filters the list of available files and folders on d a server to include only those, that the requesting - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 870
Name id optional Description Schema Unique identifier always '0'. of the SMTP configuration. This value is string port optional Port used for sending SMTP messages. Minimum value : 0 Maximum value : 65535 integer (int32) source_email Source email address used for sending SMTP messages - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 871
Name Description Schema desired_reten tion required Desired snapshot retention period in hours. The system will retain snapshots for this time period. Minimum value : 1 integer (int32) Maximum value : 8760 interval optional SnapRuleIntervalEn um name required Snapshot rule name. string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 872
boolean a resource to the local system. Default : false name optional Snapshot rule name. insensitive filtering. This property supports case- string policies optional List of the policies that are associated with this < policy_instance > snapshot_rule. array time_of_day optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 873
Name Description Schema days_of_week Days of the week when the rule should be applied. Applies < DaysOfWeekEnum optional only for rules where the time_of_day parameter is set. > array desired_reten tion optional Desired snapshot retention period in hours. The system will retain snapshots - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 874
Name port required Description Schema Port number to use with the address of the SNMP server: 162, [1024-49151] Minimum value : 162 integer (int32) Maximum value : 49151 privacy_proto col optional SNMPPrivacyProtoc olEnum trap_commun Trap Community string. Usually describes the security - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 875
Name ip_address optional Description IPv4 address, IPv6 address, or FQDN of the SNMP server. Schema string (ip-address) port optional Port number to use with the address of the SNMP server. Minimum value : 0 Maximum value : 2147483647 integer (int32) privacy_proto col optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 876
Name ip_address optional Description IPv4 address, IPv6 address, or FQDN of the SNMP server. Schema string (ip-address) port optional Port number to use with the address of the SNMP server: 162, [1024-49151] Minimum value : 162 integer (int32) Maximum value : 49151 privacy_proto col optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 877
(date-time) not been commited, this value is null. is_cluster optional Whether this information represents the common software release version that is supported on all appliances in the boolean cluster. The value is true for the instance representing the cluster. The value is false for appliance - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 878
of why for this cluster. this software release is recommended string name optional Name of the software package. This property supports caseinsensitive filtering. string release_timest amp Date and time when this software package was produced. optional string (date-time) 877 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 879
Name Description release_versio n Version number of the software package. optional Schema string size optional File size of the software package in bytes. Minimum value : 0 Maximum value : 9223372036854775807 integer (int64) software_pack age_state optional SoftwarePackageStat eEnum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 880
Name Description Schema The overall efficiency is computed as a ratio of the total space provisioned to physical used space. For example, ten 2 GB volumes were provisioned and 1 GB of data is written efficiency_rati to each of them. Each of the volumes has one snapshot as o well, for another - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 881
Name Description Schema Amount of data in bytes written to all virtual volumes on logical_used_v vol optional an appliance, without any deduplication and/or compression. This metric includes all primaries, snaps and clones. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 882
data for a specific period of time, beginning with timestamp and including the maximum and final values for that period. Current support is for a time period of one hour and one day. Polymorphism : Inheritance Discriminator : response_definition Name appliance_id optional Description Schema - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 883
Name Description last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_data_red uction optional Last data reduction space during the period. number (float) last_efficiency - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 884
Name Description last_shared_lo Last shared logical used during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_shared_lo Last shared logical used space for file systems during the gical_used_fil period. Was added in version - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 885
Name Description max_logical_u Maxiumum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_logical_u Maximum logical used space for file systems during the sed_file_syste period. Was added in version 2.0.0.0. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 886
Name Description Schema max_shared_l ogical_used_v vol optional Maximum shared logical used space for virtual volumes during the period. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 max_snapshot _savings Maximum snapshot savings space - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 887
Name Description Schema The overall efficiency is computed as a ratio of the total space provisioned to physical used space. For example, ten 2 GB volumes were provisioned and 1 GB of data is written efficiency_rati to each of them. Each of the volumes has one snapshot as o well, for another - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 888
Name Description Schema Amount of data in bytes written to all virtual volumes logical_used_v vol optional within the cluster, without any deduplication and/or compression. This metric includes all primaries, snaps and clones. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 889
metric data for a specific period of time, beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day. Polymorphism : Inheritance Discriminator : response_definition Name cluster_id optional Description Identifier - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 890
Name Description last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_data_red uction optional Last data reduction space during the period. number (float) last_efficiency - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 891
Name Description last_shared_lo Last shared logical used during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_shared_lo Last shared logical used space for file systems during the gical_used_fil period. Was added in version - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 892
Name Description max_logical_u Maximum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_logical_u Maximum logical used space for file systems during the sed_file_syste period. Was added in version 2.0.0.0. m - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 893
Name Description Schema max_shared_l ogical_used_v vol optional Maximum shared logical used space for virtual volumes during the period. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 max_snapshot _savings Maximum snapshot savings space - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 894
of storage container level space metric data for a specific period of time beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day. Polymorphism : Inheritance Discriminator : response_definition 893 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 895
Name entity required Description Localized message string corresponding to entity. Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 896
Name Description response_defi nition Response definition for the entity. required storage_conta iner_id Internal ID of the storage container. optional timestamp optional End of sample period. Schema string string string (date-time) space_metrics_by_vg Space metrics for a volume group - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 897
Name Description Schema snap_clone_lo gical_used optional Total amount of data in bytes host has written to all volumes in the volume group without any deduplication, compression or sharing. This metric and clones in the volume group. includes used snaps integer (int64) Minimum value : 0 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 898
Name Description last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 899
Name Description response_defi nition Response definition for the entity. required timestamp optional End of sample period. vg_id optional Unique identifier representing a specific volume group. Schema string string (date-time) string space_metrics_by_vm Space metrics for the VM collected - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 900
Name Description Schema snap_clone_lo gical_used optional Total Amount of data in bytes host has written to all volumes used by virtual machine without any deduplication, compression or sharing. This metric includes snaps and clones in the volume family used by integer (int64) virtual machine. - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 901
Name entity required Description Localized message string corresponding to entity. Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 902
Name Description max_snapshot _savings Max snapshot savings space during the period. optional Schema number (float) max_thin_savi ngs Max thin savings ratio during the period. optional number (float) max_unique_ Max unique physical used space during the period. physical_used Minimum - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 903
Name Description Schema Configured size in bytes of a volume which amount of data logical_provis can be written to. This metric includes primaries, snaps ioned and clones. integer (int64) optional Minimum value : 0 Maximum value : 9223372036854775807 logical_used optional Amount of data - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 904
Name entity required Description Localized message string corresponding to entity. Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string family_id optional ID of the family. string Configured size in bytes of a volume which amount of data - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 905
Name Description Schema Ratio of the amount of space that would have been used by snapshots if space efficiency was not applied to logical snapshot_savi space used solely by snapshots. For example, a volume is ngs provisioned as 1 GB bytes and it has two snapshots. Each number (float) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 906
Name Description last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_shared_lo Last shared logical used space during the period. gical_used Minimum value : 0 optional Maximum value : - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 907
Name repeat_count optional Description Number of times the metrics are repeated. Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity. required timestamp optional End of sample period. Schema integer (int32) string string (date-time) - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 908
Name Description max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 max_logical_u Max logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 909
all storage containers in the cluster. Name can be from 1 to 64 UTF-8 characters, and not more than 127 bytes. string This property supports case-insensitive filtering. Length : 1 - 64 quota optional The total number of bytes that can be provisioned/reserved against this storage container. A value - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 910
Name Description Schema virtual_volum es optional This is the association. inverse of the resource type virtual_volume < virtual_volume_inst ance > array storage_container_modify Parameters for storage container modify. Name name optional Description Schema New name for the storage - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 911
Name Description Schema chap_mutual_ username optional Username for CHAP authentication. This value must be 1 to 64 printable UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication. string Length : 1 - 64 chap_single_p assword optional Password for - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 912
the VASA vendor provider from the vCenter. This will only happen if the provider is not boolean connected to any other PowerStore systems. optional Default : false vcenter_instance Properties of a vCenter. This resource type has queriable association from virtual_machine Name address optional - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 913
Name Description instance_uuid optional UUID instance of the vCenter. Schema string username optional User name to login to vCenter. string vendor_provi der_status optional General status of the VASA vendor provider in vCenter. A VASA vendor provider is required for HCI deployments, and - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 914
Link is down. mac_address optional Virtual Ethernet port MAC address. string name optional Virtual Ethernet port name. This property supports casestring insensitive filtering. node optional This is the embeddable reference form of node_id attribute. node_instance node_id optional Unique - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 915
value : 2147483647 vswitch_port_ Name of the virtual switch port associated with the virtual name Ethernet port. This property supports case-insensitive string optional filtering. virtual_machine_instance Properties of a virtual machine. This resource type has queriable associations from - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 916
to VM snapshots. Minimum value : 0 integer (int32) Maximum value : 2147483647 name optional User-assigned name of the VM in supports case-insensitive filtering. vCenter. This property string parent optional This is the embeddable reference form of parent_id virtual_machine_ins attribute - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 917
Name type optional Description Schema VirtualMachineType Enum type_l10n optional Localized message string corresponding to type string vcenter optional This is the embeddable reference form of vcenter_id vcenter_instance attribute. vcenter_id optional The unique identifier of the vCenter VM - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 918
virtual_machine_snapshot_response The response to a virtual_machine snapshot request. Name id optional Description Unique id of the new snapshot. Schema string virtual_volume_delete Parameters for virtual volume delete. Name force optional Description Schema Normally, attempting to delete a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 919
io_priority optional string is_readonly optional Indicates whether the virtual volume is read-only. boolean location_histo ry optional Filtering on supported. the fields of this embedded resource is not < location_history_inst ance > array migration_ses This is the embeddable sion - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 920
Name parent optional Description Schema This is the embeddable reference form of parent_id virtual_volume_inst attribute. ance parent_id optional For snapshots and clones, the ID of the parent virtual volume. The parent_id is set when an virtual volume is string created and will only change - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 921
vm_protection_data_instance Protection data associated with the VM snapshot. Filtering on the fields of this embedded resource is not supported. Name Description Schema created_by_ru Unique identifier of the protection rule that created the VM le_id string optional snapshot. created_by_ru - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 922
Name parent_id optional Description VM from which the snapshot was created. source_id optional For VM snapshots, this value is the same as parent_id. source_timest amp Time when the snapshot was created. optional Schema string string string (date-time) volume_attach Parameters for the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 923
Name Description Schema Optional logical unit number when creating a mapped logical_unit_n volume. If no host_id or host_group_id is specified, this umber property is ignored. integer (int32) optional Minimum value : 0 Maximum value : 16383 name optional Name of the clone. This value - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 924
assigned to the licy_id string volume. optional sector_size optional Optional sector size, in bytes. Only 512-byte and 4096-byte sectors are supported. Minimum value : 512 integer (int32) Maximum value : 4096 size required Size of the volume to be created, in bytes. Minimum volume size - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 925
volume_detach Name Description Schema host_group_id optional Unique identifier of the host group to be detached from this volume. Only one of host_id or host_group_id can be string supplied. host_id optional Unique identifier of the host to be detached from this volume. Only one of host_id or - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 926
volume_group_clone_response Response for volume group clone action Name id optional Description Unique identifier of the new instance created. Schema string volume_group_create Create volume group request. Name description optional Description Schema Description for the volume group. The - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 927
Name volume_ids optional Description Schema A list of identifiers of existing volumes that should be added to the volume group. All the volumes must be on the same Cyclone appliance and should not be part of another volume group. < string > array If a list of volumes is not specified or if - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 928
Whether group. a protection_policy can be applied to the boolean • Whether manual snapshots can be taken. • Whether clones of the group can the fields of this location_history_inst optional embedded resource is not supported. ance > array migration_ses sion This is the embeddable - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 929
Name name optional Description Schema Name of the volume insensitive filtering. group. This property supports case- string placement_rul e optional VGPlacementRule protection_da ta optional protection_data_inst ance protection_po licy optional This is the embeddable - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 930
Name expiration_ti mestamp optional Description Schema Time after which the snapshot set can be auto-purged. This parameter is only valid for a snapshot set. Time must be specified in Zulu time zone. Expiration time cannot be prior to current time. Use a maximum timestamp value to set an - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 931
Name name optional Description Schema New name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case uniqueness check is of the name provided is reserved, case-insensitive, so the same name in string two different cases is - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 932
volume_group_remove_members Request to remove members from a volume group. Name volume_ids required Description Schema A list of volumes that need to be removed from the volume group. This list cannot be empty. < string > array volume_group_restore Restore volume group request. Name - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 933
Name description optional Description Schema Optional description for the snapshot set. If description is not specified, the description for the snapshot set will not string be set. expiration_ti mestamp optional Time after which the snapshot set can be auto-purged. Time must be specified in - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 934
a time-consuming full sync. This property is only valid for primary and clone volumes. Default : false location_histo ry optional Filtering on supported. the fields of this embedded resource is not < location_history_inst ance > array mapped_volu mes optional This is the inverse of the - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 935
Name nguid optional Description Schema NVMe Namespace globally unique identifier. Used for volumes attached to NVMEoF hosts. Was added in version string 2.0.0.0. node_affinity Node affinity. Node which offers optimized IO for volume, NodeAffinityEnum optional values are: node_affinity_ l10n - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 936
string Maximal length : 128 expiration_ti mestamp optional New expiration time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never string (date-time) expires. Use a maximum timestamp value to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 937
Name Description Schema is_replication _destination optional New value for is_replication_destination property. The modification is only supported for primary and clone volume, only when the current value is true and there is no boolean longer a replication session using this volume as a - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 938
Name Description Schema from_object_i d required Unique identifier of the source volume that will be used for the refresh operation. string volume_refresh_response Volume refresh response definition. Name Description Schema backup_snaps hot_id optional Unique identifier of the backup - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 939
Maximal length : 128 expiration_ti mestamp optional 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 string (date-time) snapshot never expires. Use a maximum timestamp value to - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 940
Name error_code optional Description Minimum value : 0 Maximum value : 2147483647 Schema integer (int32) wear_metrics_by_drive_daily_instance Wear metrics for the drives collected daily. Was added in version 2.0.0.0. Polymorphism : Inheritance Discriminator : response_definition Name drive_id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 941
Name drive_id optional Description Schema Reference to the associated drive which these metrics were recorded. string entity required Localized message string corresponding to entity. MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 942
will be used in the future. When is_current is false for this X509 Certificate will not be picked a X509 Certificate, up by the service. boolean Potential usage of this attribute is to prepare for the certificate roll-over/rotation. passphrase optional Passphrase used to encrypt private key - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 943
: 2048 Maximum value : 4096 locality optional Part of distinguished name. e.g., Hopkinton. organization Part of distinguished name. e.g., Dell-EMC. optional organizationa l_unit Part of distinguished name. e.g., Security Department. optional Schema string string < string > array < string - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 944
types. For example, in Replication_HTTP, CA type certificates will use scope to indicate the origin of these certificates. Service, type and scope mapping are listed as here - Certificate with Service Management_HTTP and Type of Server, Scope value can be null(unused and optional); Certificate with - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 945
will be used in the future. When is_current is false for this X509 Certificate will not be picked a X509 Certificate, up by the service. boolean Potential usage of this attribute is to prepare for the certificate roll-over/rotation. is_valid optional Indicate whether this is a valid X509 - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 946
required Peer's port number. Minimum value : 0 Maximum value : 65535 integer (int32) service required X509CertificateServi ceEnum username required Username used in PowerStore cluster. basic authentication to remote string x509_certificate_instance Properties of x509 certificate. Name id - Dell PowerStore 500T | EMC PowerStore REST API Reference Guide - Page 947
on the fields of this embedded resource instance > array is not supported. service optional X509CertificateServi ceEnum service_l10n Localized message string corresponding to service optional string type optional X509CertificateUsag eTypeEnum type_l10n optional Localized message string
Dell EMC PowerStore
REST API
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.