Dell PowerStore 9000T EMC PowerStore REST API Developers Guide
Dell PowerStore 9000T Manual
View all Dell PowerStore 9000T manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell PowerStore 9000T manual content summary:
- Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 1
Dell EMC PowerStore REST API Developers Guide - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 2
use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 3
Contents Additional Resources...5 1 Overview...6 The PowerStore Management REST API...6 Resource-oriented architecture and REST...6 JSON data exchange format...7 2 REST request components...8 HTTP request headers...8 URI patterns...8 Request parameters...9 REST requests...12 3 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 4
Modifying a resource instance...33 Deleting a resource instance...34 Performing an instance-level resource-specific action 35 Performing a class-level action...36 Working with asynchronous requests...37 8 Reference content...40 4 Contents - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 5
to the PowerStore Documentation page at www.dell.com/ powerstoredocs. • Troubleshooting For information about products, software updates, licensing, and service, go to www.dell.com/support and locate the appropriate product support page. • Technical support For technical support and service requests - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 6
attributes that provide interactive, scripted, and programmatic management control of the PowerStore cluster. Here are some examples of what you can do with the information. Instead, client requests contain all the necessary information to service the request. • Resources in a REST API are self- - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 7
JSON data exchange format JavaScript Object Notation (JSON) is a text-based, platform-independent data-exchange format that is easy for humans and machines to read and write. It consists of two structures: • A set of name:value pairs enclosed by curly brackets. • A list of values enclosed by square - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 8
Request parameters REST requests URI patterns Basic URI patterns The following table describes the basic URI patterns that the PowerStore Management REST API supports: Table 1. Basic patterns in the REST API URI pattern Collection type resource URI /api/rest/ HTTP Operations GET - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 9
rest/x509_certificate/exchange Related reference HTTP request headers Request parameters REST requests Request parameters The PowerStore Management REST API supports the following request parameters: Request parameter Applicable request types select Collection and instance queries Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 10
to true (?async=true) runs the request in the background. Most active management requests (ones that attempt to change the configuration) support this option. By default, requests are run synchronously. For more information, see Working with asynchronous requests. To use request parameters, append - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 11
Using a filter expression The following request uses a filter expression to return the values for alert instances that have the severity attribute set to Info: Request GET https://1.2.3.4/api/rest/alert?select=id,severity&severity=eq.Info Response [ { "id":"37583ff1-b0fe-41f2-9b3d-e5e5d2e5e525", - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 12
Related reference HTTP request headers URI patterns REST requests REST requests A JSON request body for the REST API consists of a collection of name:value pairs for a single resource type. The request body has the following syntax: • For number or boolean values: { :, < - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 13
and a 503 status code indicates that the REST service is temporarily unavailable. • The JSON response body uses cookie-based authentication, the HTTP client must support cookies in order to use the API. For entity that describes the problem. The following table describes the HTTP status codes - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 14
response. 400 Bad Request All requests Problem with request intercepted before execution. The system detected a problem with the request and did not URI. 405 Method Not Allowed All requests Specified resource does not support the request's operation. For example, requesting a DELETE on a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 15
• The system is out of space. • A range error occurred. • There are inconsistent properties on a POST or PATCH Internal error. The REST service is temporarily unavailable. Wait and try the request again. JSON collection response body A JSON collection response body occurs in response to a GET - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 16
Example GET instance response for an event The following example illustrates an instance resource. It shows an instance resource returned in response to a GET instance request for the event resource type with an identifier of 299a2f56-fea7-4e85-af0d-992294526911. Spaces outside the quoted strings - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 17
Example Deletion response for a local_user The following example returns a job resource instance in response to a successful asynchronous DELETE request. Request DELETE https://1.2.3.4/api/rest/local_user/4?is_async=true Response { "id": "476c903a-1bc2-4370-9a4b-426594ed9604" } Error response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 18
JSON base value encodings 4 JSON encodings The following table shows the JSON encodings for each base type: NOTE: A property that has no value appears as the type null. Type name short integer long float double string byte binary boolean date timestamp date-time password JSON definition type: - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 19
"id":"123" Notes server (for example, the values are not logged). In this API, some attributes support IPv4 only, while others support both IPv4 and IPv6. Some attributes also support DNS names. The help topics for individual resource types in the Reference content indicate which IP address options - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 20
5 Managing a REST API session Connecting and authenticating All requests to the REST API must be authenticated. The REST API uses the standard HTTP Basic access authentication mechanism to authenticate REST requests. The same users are valid for REST or GUI access. To log in to the REST API server - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 21
Example login session information [ { "id":"85d0dbfc-d364-47b9-ad90-0fe03efdf860", "user"1", "role_ids":["1"], "idle_timeout":36000, "is_password_change_required":false, "is_built_in_user":true } ] Logging out of the REST API session Use the following request components to log out of an existing - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 22
6 Querying a resource Pagination When you query a resource, the server limits the size of the returned collection by default. This collection is limited to the number of instances up to a specified pagination limit, which defaults to 100. If the requested collection has fewer instances than this - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 23
URI pattern /api/rest/ Body where is the resource type for the collection you want to return. For additional functionality, such as filtering instances, you can append one or more request parameters to the URI. Empty. If the request succeeds, the server returns a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 24
Headers Accept: application/json Authorization: Operation GET URI pattern /api/rest// Body where: • is the resource type of the desired instance. • is the unique identifier of the desired instance. For additional functionality, such as - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 25
You can use nested notation syntax (( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 26
of the target resource type or embedded in the target resource type. Supported operators Comparator eq gt gte lt lte neq ilike in is cs the comma-separated list on the right. ?role_id=in. (operator,administrator,service) True if the value of role_id is Operator, Administrator, or VM Administrator - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 27
Comparator cd not and or Description Contained in. Negates the operator that follows. Applicable data types List of any type All All the conditions in the parentheses that follow All must be true in order for the request to evaluate as true. NOTE: The default for multiple filters is to AND them, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 28
Request Response body GET https://1.2.3.4/api/rest/alert?select=id,description_l10n,state&order=state [ { "id": "1bf5e114-b476-492b-a37e-7d9c1b38e7b9", "description_l10n": "Firmware version of the rights DAE PSU is no_errors. Current firmware version is 09.16s.", "state": "Active" }, { "id": " - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 29
Request Response body https://1.2.3.4/api/rest/node?select=id,name,appliance(id,name) [ { "id":"N1", "name":"H0112-appliance-1-node-A", "appliance": { "id":"A1", "name":"H0112-appliance-1" } }, { "id":"N2", "name":"H0112-appliance-1-node-B", "appliance": { "id":"A1", "name":"H0112-appliance-1" } } - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 30
embedded resource type: ...,, NOTE: Extending the scope of a collection query is not supported for all resources. Resources that do not support this functionality include a note in their description stating: Filtering on the fields of this embedded resource - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 31
Example Querying the protection data information for a volume Headers Accept: application/json Authorization: Request https://1.2.3.4/api/rest/volume?select=id,protection_data Response body [ { "id":"3f6208d1-b325-4901-9fc1-9e82d943b857", "protection_data": { "family_id": " - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 32
7 Creating other types of requests Creating a resource instance To create a resource instance, use the following request components: Headers Accept: application/json Content-Type: application/json Authorization: Operation POST URI pattern /api/rest/ Body where < - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 33
list-type attributes, and removes the specified values from an existing list of values. The Reference content documents which varieties of PATCH are supported for each resource type. For additional functionality, such as making the request an asynchronous request, you can append one or more request - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 34
Response Empty. body Adding additional volumes to a volume group The following request adds two volumes to thevolume_group resource instance that has an id of ad09bfa8-f8d8-41b5-96a9c15c9ebdf214: Headers Accept: application/json Content-Type: application/json Authorization: Request - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 35
Body • is the resource type of the instance you want to delete. • is the unique identifier of the instance you want to delete. For additional functionality, such as making the request an asynchronous request, you can append one or more request parameters to the URI. For most - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 36
Some resource types have operations that let you perform class-level actions. For example, exchanging SSL certificates with another PowerStore appliance. To perform a class-level action, use the following request components: Headers For operations without request arguments: Accept: application - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 37
certificates The following request exchanges SSL certificates with another PowerStore appliance: Headers Accept: application/json Content-Type: : Request POST /api/rest/x509_certificate/exchange Request body { "service": "Management_HTTP", "address": "10.244.53.108", "port": 8080 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 38
Alternatively, you can make any active management request (one that changes the system rather than just querying it) into an asynchronous request by adding URL parameter is_async=true to the request URL. Asynchronous requests can be more reliable than synchronous requests. With an asynchronous - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 39
Request body Response body Empty. { "id": "1b6df699-7083-4440-912c-22e2ed89c530", "description_l10n": "Modify a volume group.", "state": "COMPLETED", "response_body": null } Creating other types of requests 39 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 40
8 Reference content This section describes the resource types, methods, and attributes in the PowerStore Management REST API, along with other API information such as data types and enumerations. Reference materials are also available on the appliance in several formats: • - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 41
Storage cluster API - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 42
Table of Contents Resources 1 alert 1 GET /alert 1 GET /alert/{id 1 PATCH /alert/{id 2 appliance 2 GET /appliance 2 GET /appliance/{id 3 PATCH /appliance/{id 3 POST /appliance/{id}/forecast 4 POST /appliance/{id}/time_to_full 5 audit_event 6 GET /audit_event 6 bond 6 GET /bond 6 GET / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 43
POST /email_notify_destination/{id}/test 18 eth_port 19 GET /eth_port 19 GET /eth_port/{id 19 PATCH /eth_port/{id 20 event 20 GET /event 20 GET /event/{id 21 fc_port 21 GET /fc_port 21 GET /fc_port/{id 22 PATCH /fc_port/{id 22 file_dns 23 GET /file_dns 23 POST /file_dns 24 GET / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 44
PATCH /file_kerberos/{id 37 POST /file_kerberos/{id}/upload_keytab 37 GET /file_kerberos/{id}/download_keytab 38 file_ldap 39 GET /file_ldap 39 POST /file_ldap 39 GET /file_ldap/{id 40 DELETE /file_ldap/{id 40 PATCH /file_ldap/{id 41 POST /file_ldap/{id}/upload_config 41 GET /file_ldap/{id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 45
PATCH /file_tree_quota/{id 57 POST /file_tree_quota/{id}/refresh 58 file_user_quota 59 GET /file_user_quota 59 POST /file_user_quota 59 GET /file_user_quota/{id 60 PATCH /file_user_quota/{id 60 POST /file_user_quota/{id}/refresh 61 file_virus_checker 61 GET /file_virus_checker 62 POST / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 46
GET /host_volume_mapping 79 GET /host_volume_mapping/{id 79 import_host_initiator 80 GET /import_host_initiator 80 GET /import_host_initiator/{id 80 import_host_system 81 GET /import_host_system 81 POST /import_host_system 81 GET /import_host_system/{id 82 DELETE /import_host_system/{id 82 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 47
import_storage_center_volume 98 GET /import_storage_center_volume 98 GET /import_storage_center_volume/{id 98 POST /import_storage_center_volume/{id}/import_snapshot_profiles 99 import_unity 100 GET /import_unity 100 GET /import_unity/{id 100 POST /import_unity/{id}/discover 101 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 48
GET /license/{id 114 POST /license/upload 115 POST /license/retrieve 115 local_user 116 GET /local_user 116 POST /local_user 116 GET /local_user/{id 117 DELETE /local_user/{id 117 PATCH /local_user/{id 118 login_session 119 GET /login_session 119 logout 119 POST /logout 119 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 49
POST /nas_server/{id}/ping 133 POST /nas_server/{id}/upload/passwd 134 GET /nas_server/{id}/download/passwd 135 POST /nas_server/{id}/upload/hosts 135 GET /nas_server/{id}/download/hosts 136 POST /nas_server/{id}/upload/group 137 GET /nas_server/{id}/download/group 137 POST /nas_server/{id}/ - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 50
GET /ntp 156 GET /ntp/{id 156 PATCH /ntp/{id 157 performance_rule 158 GET /performance_rule 158 GET /performance_rule/{id 158 physical_switch 159 GET /physical_switch 159 POST /physical_switch 159 GET /physical_switch/{id 160 DELETE /physical_switch/{id 160 PATCH /physical_switch/{id 161 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 51
GET /role/{id 180 sas_port 180 GET /sas_port 180 GET /sas_port/{id 181 security_config 181 GET /security_config 181 GET /security_config/{id 182 service_config 182 GET /service_config 182 GET /service_config/{id 183 PATCH /service_config/{id 183 service_user 184 GET /service_user 184 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 52
GET /software_installed 198 GET /software_installed/{id 199 software_package 199 GET /software_package 199 POST /software_package 200 GET /software_package/{id 200 DELETE /software_package/{id 201 POST /software_package/{id}/install 202 POST /software_package/{id}/puhc 203 storage_container - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 53
PATCH /volume/{id 218 POST /volume/{id}/snapshot 219 POST /volume/{id}/clone 219 POST /volume/{id}/refresh 220 POST /volume/{id}/restore 221 POST /volume/{id}/attach 222 POST /volume/{id}/detach 223 volume_group 223 GET /volume_group 223 POST /volume_group 224 GET /volume_group/{id 224 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 54
FileInterfaceRouteOperationalStatusEnum 240 FileLDAPAuthenticationTypeEnum 240 FileLDAPProtocolEnum 241 FileLDAPSchemaTypeEnum 241 FileQuotaStateEnum 241 FileSystemAccessPolicyEnum 242 FileSystemFolderRenamePolicyEnum 242 FileSystemLockingPolicyEnum 242 FileSystemSnapshotAccessTypeEnum 243 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 55
MessageSeverityEnum 259 MetricsEntityEnum 259 MetricsIntervalEnum 261 MigrationRecommendationActionStateEnum 262 MigrationRecommendationPrimaryResourceTypeEnum 262 MigrationRecommendationReasonEnum 263 MigrationRecommendationStateEnum 263 MigrationRecommendationTypeEnum 264 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 56
StorageCreatorTypeEnum 277 StorageElementTypeEnum 278 ThumbprintAlgorithmEnum 278 TransitConnectionStatusEnum 278 UnityDayofWeekEnum 279 UnityHealthEnum 279 UnityScheduleTypeEnum 280 UnityScheduleVersionEnum 281 UnityVolumeMigrationStateEnum 281 UnityVolumeTypeEnum 282 VGPlacementRule 282 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 57
base_performance_metrics_by_appliance_rollup 303 base_performance_metrics_by_cluster 306 base_performance_metrics_by_cluster_rollup 307 base_performance_metrics_by_fe_eth_node 309 base_performance_metrics_by_fe_eth_node_rollup 310 base_performance_metrics_by_fe_eth_port 312 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 58
base_space_metrics_by_appliance 380 base_space_metrics_by_appliance_rollup 381 base_space_metrics_by_cluster 384 base_space_metrics_by_cluster_rollup 385 base_space_metrics_by_storage_container 388 base_space_metrics_by_storage_container_rollup 388 base_space_metrics_by_vg 389 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 59
esxi_credentials 416 eth_port_instance 417 eth_port_modify 419 event_instance 420 fc_port_instance 421 fc_port_modify 423 file_dns_create 423 file_dns_instance 423 file_dns_modify 424 file_ftp_create 425 file_ftp_instance 427 file_ftp_modify 430 file_interface_create 434 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 60
file_tree_quota_instance 464 file_tree_quota_modify 466 file_user_quota_create 466 file_user_quota_instance 467 file_user_quota_modify 469 file_virus_checker_create 469 file_virus_checker_instance 470 file_virus_checker_modify 470 hardware_drive_repurpose 471 hardware_extra_details_instance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 61
import_storage_center_snapshot_profile_instance 497 import_storage_center_volume_import_snapshot_profiles_response 498 import_storage_center_volume_instance 498 import_unity_consistency_group_import_snapshot_schedules_response 500 import_unity_consistency_group_instance 500 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 62
job_vvol_error_response 524 keystore_archive_instance 524 keystore_archive_regenerate_response 524 license_instance 525 local_user_create 525 local_user_instance 526 local_user_modify 526 location_history_instance 527 login_session_instance 527 maintenance_window_instance 528 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 63
nfs_server_join 561 nfs_server_modify 562 nfs_server_unjoin 563 node_instance 563 ntp_instance 564 ntp_modify 564 performance_metrics_by_appliance 564 performance_metrics_by_appliance_rollup 566 performance_metrics_by_cluster 569 performance_metrics_by_cluster_rollup 570 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 64
performance_metrics_by_smb_v2_node_rollup 637 performance_metrics_by_vg 640 performance_metrics_by_vm 641 performance_metrics_by_vm_rollup 643 performance_metrics_by_volume 645 performance_metrics_by_volume_rollup 647 performance_rule_instance 649 physical_switch_connection_create 650 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 65
smb_server_unjoin 677 smb_share_create 677 smb_share_instance 679 smb_share_modify 680 smtp_config_instance 681 smtp_config_modify 681 smtp_config_test 682 snapshot_rule_create 682 snapshot_rule_delete 682 snapshot_rule_instance 683 snapshot_rule_modify 684 software_installed_instance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 66
virtual_machine_snapshot_response 716 virtual_volume_delete 717 virtual_volume_instance 717 vm_protection_data_instance 720 volume_attach 720 volume_clone 721 volume_clone_response 721 volume_create 722 volume_detach 723 volume_group_add_members 723 volume_group_clone 723 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 67
Resources alert Use these resource types to manage events and alerts in the system. GET /alert Description Query all alerts. Responses HTTP Code 200 Description Success 206 Partial content of alert instance objects GET /alert/{id} Description Query a specific alert. Parameters Type Path - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 68
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 parameter value. acknowledged_severity is ignored when is_acknowledged is set to false. Parameters Type - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 69
Responses HTTP Code Description 200 Success 206 Partial content of appliance instance objects 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 70
Parameters Type Path Name id required Body body required Description Unique identifier of the appliance. Responses HTTP Code 204 Description Success 400 Invalid Argument 404 Not Found 422 Operation Failed Consumes • application/json Produces • application/json POST /appliance/{id}/ - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 71
Responses HTTP Code Description 200 Success 204 Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema < appliance_forecast _response > array No Content error_response error_response error_response Produces • application/json POST /appliance/{id}/time_to_full Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 72
HTTP Code 400 Description Invalid Request 404 Not Found 422 Operation Failed Schema error_response error_response error_response Produces • application/json audit_event Use this resource type to query audit log information. GET /audit_event Description Query audit log entries. Responses - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 73
Description Query bond configurations. Responses HTTP Code 200 Description Success 206 Partial content of bond instance objects Schema < bond_instance > array < bond_instance > array GET /bond/{id} Description Query a specific bond configuration. Parameters Type Path Name id required - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 74
. 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 HTTP Code Description 200 Success Schema < chap_config_insta nce > array 206 Partial content of chap - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 75
Failed Schema No Content error_response error_response error_response cluster Manage clusters GET /cluster Description Get details about the cluster. This resource type collection query does not support filtering, sorting or pagination Responses 9 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 76
> array < cluster_instance > array Produces • application/json GET /cluster/{id} Description Get details about the cluster. This does not support the following standard query functionality: property selection, and nested query embedding. Parameters Type Path Name id required Description ID of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 77
Type Path Body Name id required body optional Description Unique identifier of the cluster. Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Consumes • application/json Produces • application/json POST /cluster/{id}/forecast Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 78
HTTP Code Description 200 Success 204 Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema < cluster_forecast_r esponse > array No Content error_response error_response error_response Produces • application/json POST /cluster/{id}/time_to_full Description Returns - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 79
Description Returns connected initiators that are not associated with a host. This resource type collection query does not support filtering, sorting or pagination Responses HTTP Code Description 200 Success Schema < discovered_initiat or_instance > array 206 Partial content - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 80
GET /dns Description Query DNS settings for a cluster. Responses HTTP Code 200 Description Success 206 Partial content of dns instance objects GET /dns/{id} Description Query a specific DNS setting. Parameters Type Path Name id required Description Unique identifier of the DNS setting. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 81
PATCH /dns/{id} Description Modify a DNS setting. Parameters Type Path Name id required Body body required Description Unique identifier of the DNS setting. Schema string dns_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 82
Responses HTTP Code Description 200 Success 206 Partial content of email notify destination instance objects POST /email_notify_destination Description Add an email address to receive notifications. Parameters Type Body Name body required Description Email address to receive - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 83
Type Path Name id required Description Schema Unique identifier destination. of the email notification string Responses HTTP Code 200 Description Success 404 Not Found Schema email_notify_desti nation_instance error_response DELETE /email_notify_destination/{id} Description Delete an - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 84
Parameters Type Path Name id required Body body required Description Schema Unique identifier destination. of the email notification string Email address to receive notifications. email_notify_destina tion_modify Responses HTTP Code 204 Description Success 400 Invalid Request 404 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 85
HTTP Code 422 Description Operation Failed Schema error_response eth_port This is the REST API for cluster-wide retrieval and configuration of Ethernet front-end ports. GET /eth_port Description Get Ethernet front-end port configuration for all cluster nodes. Responses HTTP Code Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 86
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 Body body - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 87
Description Returns all events in the database. Responses HTTP Code 200 Description An array of events 206 Partial content of event instance objects Schema < event_instance > array < event_instance > array GET /event/{id} Description Get event by Event Id. Parameters Type Path Name id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 88
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 22 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 89
Type Path Body Name id required body required Description Unique identifier of the FC front-end port. Schema string fc_port_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 9000T | EMC PowerStore REST API Developers Guide - Page 90
HTTP Code Description 206 Partial content of file dns instance objects Schema < file_dns_instance > array POST /file_dns Description Create a new DNS Server configuration for a NAS Server. Only one object can be created per NAS Server. Parameters Type Body Name body required Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 91
Responses HTTP Code 200 Description Success 404 Not Found DELETE /file_dns/{id} Description Delete DNS settings of a NAS Server. Parameters Type Path Name id required Description Unique identifier of the DNS object. Responses HTTP Code 204 Description Success 404 Not Found 422 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 92
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 9000T | EMC PowerStore REST API Developers Guide - Page 93
HTTP Code 206 Description Partial content of file ftp instance objects Schema < file_ftp_instance > array POST /file_ftp Description Create an FTP/SFTP server. Parameters Type Body Name body required Schema file_ftp_create Responses HTTP Code 201 Description Created 400 Invalid Request - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 94
HTTP Code 200 Description Success 404 Not Found Schema file_ftp_instance error_response DELETE /file_ftp/{id} Description Delete an FTP/SFTP Server. Parameters Type Path Name id required Description Schema Unique identifier of the FTP/SFTP Server object. string Responses HTTP Code 204 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 95
Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response file_interface Information about File network interfaces in the storage system. These interfaces control access to Windows (CIFS - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 96
Type Body Name body required Schema file_interface_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /file_interface/{id} Parameters Type Path Name id required Description Unique - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 97
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /file_interface/{id} Description Modify the settings of a file interface. Parameters Type Path Name id required Description Unique identifier of the file - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 98
defined by an interface, destination IP address range and an IP address of a corresponding gateway. Note: IP routes connect an interface (IP address) to the larger network through gateways. Without routes and gateway specified, the interface is no longer accessible outside of its immediate subnet. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 99
Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /file_interface_route/{id} Description Query a specific file interface route for details. Parameters Type Path Name id required Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 100
error_response error_response file_kerberos Use these resources to manage the Kerberos service for a NAS server. One Kerberos service object may be configured per NAS Server. Kerberos is a distributed authentication service designed to provide strong authentication with secret-key cryptography. It - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 101
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 on Kerberos principal names. GET / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 102
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 9000T | EMC PowerStore REST API Developers Guide - Page 103
Operation Failed Schema No Content error_response error_response error_response POST /file_kerberos/{id}/upload_keytab Description A keytab file is required for secure NFS service with a Linux or Unix Kerberos Key Distribution Center (KDC). The keytab file can be generated using the KDC server - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 104
GET /file_kerberos/{id}/download_keytab Description Download previously uploaded keytab file for secure NFS service. Parameters Type Path Name id required Description Schema Unique identifier of the Kerberos service object. string Responses HTTP Code 200 Description Ok 404 Not Found 422 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 105
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 9000T | EMC PowerStore REST API Developers Guide - Page 106
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 107
HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 108
Type Name FormDat body a required Description Schema file 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_ldap/{id}/ - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 109
POST /file_ldap/{id}/upload_certificate Parameters Type Path Name id required Description Unique identifier of the LDAP settings object. Schema string FormDat body file a required Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 110
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 List configured NDMP service instances. Responses HTTP Code Description 200 Success Schema < - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 111
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /file_ndmp/{id} Description Query an NDMP service configuration instance. Parameters Type Path Name id required Description Unique identifier of the NDMP - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 112
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /file_ndmp/{id} Description Modify an NDMP service configuration instance. Parameters Type Path Name id required Description Unique identifier of the NDMP - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 113
for maintaining and distributing system configuration information, such as user and group information, hostnames, and such. The port for NIS Service is 111. GET /file_nis Description Query the NIS settings of NAS Servers. Responses HTTP Code 200 Description Success. Schema < file_nis_instance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 114
HTTP Code 422 Description Operation Failed GET /file_nis/{id} Description Query a specific NIS settings object of a NAS Server. Parameters Type Path Name id required Description Unique identifier of the NIS object. Responses HTTP Code 200 Description Success 404 Not Found DELETE / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 115
HTTP Code 404 Description Not Found 422 Operation Failed PATCH /file_nis/{id} Description Modify the NIS settings of a NAS Server. Parameters Type Path Name id required Description Unique identifier of the NIS object. Body body required Responses HTTP Code 204 Description Success. 400 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 116
Responses HTTP Code Description 200 Success 206 Partial content of file system instance objects Schema < file_system_instan ce > array < file_system_instan ce > array POST /file_system Description Create a file system. Parameters Type Body Name body required Schema file_system_create - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 117
Type Path Name id required Description File system id. Responses HTTP Code 200 Description Success 404 Not Found DELETE /file_system/{id} Description Delete a file system. Parameters Type Path Name id required Description File system id. Responses HTTP Code 204 Description Success - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 118
Parameters Type Path Name id required Body body required Description File system id. Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed POST /file_system/{id}/clone Description Create a clone of a file system. Parameters Type Path - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 119
HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed POST /file_system/{id}/snapshot Description Create a snapshot of a file system. Parameters Type Path Name id required Description File system id. Body body optional Responses HTTP Code 200 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 120
Description Refresh a snapshot of a file system. The content of the snapshot is replaced with the current content of the parent file system. Parameters Type Path Name id required Description File system snapshot id. Schema string Responses HTTP Code 204 Description Success 400 Invalid - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 121
HTTP Code 200 Description Success (with backup snapshot) 204 Success (without backup snapshot) 400 Invalid request 404 Not Found 422 Operation Failed Schema file_system_restor e_response No Content error_response error_response error_response POST /file_system/{id}/refresh_quota - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 122
GET /file_tree_quota Description List tree quota instances. Responses HTTP Code Description 200 Success 206 Partial content of file tree quota instance objects Schema < file_tree_quota_in stance > array < file_tree_quota_in stance > array POST /file_tree_quota Description Create a tree - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 123
Parameters Type Path Name id required Description Unique identifier of the tree quota. Responses 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 124
Parameters Type Path Name id required Body body required Description Unique identifier of the tree quota. 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 125
HTTP Code 422 Description Operation Failed Schema error_response 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 126
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 127
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 9000T | EMC PowerStore REST API Developers Guide - Page 128
is infected, corrective action (fixed, removed or placed in quarantine) is taken as defined by the anti-virus server. You can optionally set up the service to scan the file on read access based on last access of the file compared to last update of the third-party anti-virus date - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 129
HTTP Code 400 Description Invalid Request 422 Operation Failed Schema error_response error_response 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 130
HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 131
Type Path Name id required FormDat body a optional Description Schema Unique identifier of the virus checker instance. string Upload virus checker configuration file. file Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 132
HTTP Code 422 Description Operation Failed Produces • document/text hardware This provides the hardware component inventory of the system. GET /hardware Description List hardware components. Responses HTTP Code Description 200 Success 206 Partial content of hardware instance objects - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 133
Responses HTTP Code 200 Description Success 404 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 134
Produces • application/json 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 135
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 Input 422 Operation Failed Consumes - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 136
GET /host/{id} Description Get details about a specific host by id. Parameters Type Path Name id required Description Unique id of the host. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema host_instance error_response Produces • application/json DELETE / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 137
, modify description, remove initiator(s) from host, add initiator(s) to host, update existing initiator(s) with chap username/password. This will only support one of add, remove and update initiator operations in a single request. Parameters Type Path Name id required Description Unique id of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 138
POST /host/{id}/attach Description Attach host to volume. Parameters Type Path Name id required Description Unique id of the host. Body body required Responses HTTP Code 204 Description Success 400 Invalid Input 404 Not Found 422 Operation Failed Produces • application/json POST / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 139
Responses HTTP Code 204 Description Success 400 Invalid Input 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Produces • application/json host_group Manage host groups. A host group is a mechanism to provision hosts and volumes to be - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 140
POST /host_group Description Create a host group. Parameters Type Body Name body required Schema host_group_create Responses HTTP Code 201 Description Created 400 Operation Failed 422 Operation Failed Schema create_response error_response error_response Consumes • application/json - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 141
/host_group/{id} Description Operations that can be performed are modify name, remove host(s) from host group, add host(s) to host group. Modify request will only support either a add_host(s) or remove_host(s) at a time along with modifying host name 75 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 142
Parameters Type Path Name id required Body body required Description Unique id of the host group. Responses HTTP Code 204 Description Success 400 Operation Failed 404 Not Found 422 Operation Failed Produces • application/json POST /host_group/{id}/attach Description Attach host group - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 143
HTTP Code 204 Description Success 400 Invalid Input 404 Not Found 422 Operation Failed Produces • application/json POST /host_group/{id}/detach Description Detach host group from volume. Parameters Type Path Name id required Description Unique id of the host group. Body body required - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 144
host_virtual_volume_mapping Virtual volume mapping details. GET /host_virtual_volume_mapping Description Query associations between a virtual volume and the host(s) it is attached to. Responses HTTP Code Description 200 Success Schema < host_virtual_volu me_mapping_inst ance > array < 206 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 145
HTTP Code 404 Description Not Found Schema error_response host_volume_mapping Storage cluster REST API definition. GET /host_volume_mapping Description Query associations between a volume and the host or host group it is attached to. Responses HTTP Code Description 200 Success Schema < - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 146
HTTP Code 200 Description Success 404 Not Found Schema host_volume_map ping_instance error_response import_host_initiator Use these resource types to manage import host initiators. Once import host is configured, host initiators can be queried and corresponding mapped volumes can be imported. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 147
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 9000T | EMC PowerStore REST API Developers Guide - Page 148
created. If Host is already present, the same Host will be updated with the import_host_system details. Parameters Type Body Name request required Description Request parameters. Schema import_host_system_ create Responses HTTP Code 201 Description Created 400 Invalid Request 422 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 149
Description Delete an import host system. You cannot delete an import host system if there are import sessions active in the system referencing the import host system instance. Parameters Type Path Name id required Description Unique identifier of the import host system Schema string Responses - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 150
HTTP Code 422 Description Operation Failed Schema error_response import_host_volume Use these resource types to manage import host volumes. Host volumes are source storage volumes that are mapped to the host systems for application access. Once import host is configured, host volumes can be - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 151
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 HTTP Code Description 200 Success Schema < import_psgroup_i nstance > array 206 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 152
Schema No Content error_response error_response error_response import_psgroup_volume 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. 86 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 153
Responses HTTP Code Description 200 Success 206 Partial content of import psgroup volume instance objects Schema < import_psgroup_v olume_instance > array < import_psgroup_v olume_instance > array GET /import_psgroup_volume/{id} Description Query a specific PS Group volume. Parameters - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 154
Use the import_session resource type to initiate and manage the migration of volumes and consistency groups from a heritage Dell EMC storage system to a PowerStore storage system. The import is non-disruptive to hosts that access the volume during the import. The import process runs as a background - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 155
HTTP Code Description 206 Partial content of import session instance objects Schema < import_session_in stance > array POST /import_session Description Create a new import session. The source storage system and hosts that access the volumes or consistency groups must be added prior to creating - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 156
Responses HTTP Code 200 Description Success 404 Not Found Schema import_session_in stance error_response DELETE /import_session/{id} Description Delete an import session that is in a Completed, Failed, or Cancelled state. Delete removes the historical record of the import. To stop active - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 157
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 9000T | EMC PowerStore REST API Developers Guide - Page 158
}/pause 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. 92 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 159
You can resume or cancel the paused import. Parameters Type Path Name id required Description Unique identifier of the import session Schema string Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 160
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. Responses 94 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 161
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 Name id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 162
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 9000T | EMC PowerStore REST API Developers Guide - Page 163
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 9000T | EMC PowerStore REST API Developers Guide - Page 164
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 9000T | EMC PowerStore REST API Developers Guide - Page 165
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 /import_storage_center_volume/{id}/import_snapshot_profiles Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 166
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 systems. Responses HTTP Code Description 200 Success Schema < import_unity_inst ance > array 206 Partial content of import unity - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 167
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. Responses HTTP Code Description 200 Success Schema < import_unity_cons - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 168
HTTP Code 206 Description Partial content of import unity consistency group instance objects Schema < import_unity_cons istency_group_inst ance > array GET /import_unity_consistency_group/{id} Description Query a specific Unity consistency group. Parameters Type Path Name id required - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 169
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 206 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 170
Parameters Type Path Name id required Description Unique identifier of the Unity volume. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema import_unity_volu me_instance error_response POST /import_unity_volume/{id}/import_snapshot_schedules Description Return - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 171
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 206 Partial content of import - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 172
import_vnx_consistency_group Use this resource type to show the VNX consistency groups that can be imported to PowerStore. GET /import_vnx_consistency_group Description Query VNX consistency groups. Responses HTTP Code Description 200 Success Schema < import_vnx_consis tency_group_insta - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 173
Success 404 Not Found Schema import_vnx_consis tency_group_insta nce error_response 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 107 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 174
HTTP Code Description 200 Success 206 Partial content of import vnx volume instance objects Schema < import_vnx_volu me_instance > array < import_vnx_volu me_instance > array GET /import_vnx_volume/{id} Description Query a specific VNX volume. Parameters Type Path Name id required - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 175
Responses HTTP Code Description 200 Success 206 Partial content of ip pool address instance objects Schema < ip_pool_address_i nstance > array < ip_pool_address_i nstance > array GET /ip_pool_address/{id} Description Query a specific IP address. Parameters Type Path Name id required - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 176
GET /ip_port Description Query IP port configurations. Responses HTTP Code 200 Description Success 206 Partial content of ip port instance objects GET /ip_port/{id} Description Query a specific IP port configuration. Parameters Type Path Name id required Description Unique identifier of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 177
PATCH /ip_port/{id} Description Modify IP port parameters. Parameters Type Path Name id required Description Unique identifier of the IP port. Body body optional Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Consumes • application/ - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 178
keystore backup archive 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. 112 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 179
file that was previously generated by a successful /api/rest/keystore_archive/regenerate POST command. This resource type collection query does not support filtering, sorting or pagination Parameters Type Path Name filename required Description Schema Filename is the last component in the URI - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 180
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 9000T | EMC PowerStore REST API Developers Guide - Page 181
Parameters Type Path Name id required Description Schema Unique identifier instance. of the license information string Responses HTTP Code 200 Description Success 404 Not Found Schema license_instance error_response POST /license/upload Description Upload a software license to - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 182
, once per day during the trial period. This allows a manual attempt, normally after attempting to correct the network connectivity issue preventing user account instances. This resource type collection query does not support filtering, sorting or pagination Responses HTTP Code Description 200 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 183
locked. Parameters 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 184
Description Delete a local user account instance using the unique identifier. You cannot delete the default "admin" account or the account you are currently logged into. Any local user account with Administrator or Security Administrator role can delete any other local user account except the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 185
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 9000T | EMC PowerStore REST API Developers Guide - Page 186
Responses 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 187
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 9000T | EMC PowerStore REST API Developers Guide - Page 188
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 9000T | EMC PowerStore REST API Developers Guide - Page 189
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 Code Description 200 Migration recommendation objects Schema < migration_recom - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 190
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 200 Success 404 Not found Schema migration_recom - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 191
POST /migration_recommendation/{id}/create_migration_sessions 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 192
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 126 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 193
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 9000T | EMC PowerStore REST API Developers Guide - Page 194
DELETE /migration_session/{id} 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 195
/migration_session/{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. 129 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 196
Parameters Type Path Name id required Body 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 197
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 9000T | EMC PowerStore REST API Developers Guide - Page 198
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 9000T | EMC PowerStore REST API Developers Guide - Page 199
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 body required Responses HTTP Code 204 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 200
Parameters Type Path Name id required Body body required Description Unique identifier of the NAS server. Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed POST /nas_server/{id}/upload/passwd Description Upload NAS server passwd file. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 201
HTTP Code 404 Description Not Found 422 Operation Failed Schema error_response error_response Consumes • multipart/form-data GET /nas_server/{id}/download/passwd Description Download a NAS server passwd file containing template or the actual (if already uploaded) passwd details. Parameters - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 202
Type Path Name id required FormDat body a optional Description Unique identifier of the NAS server. Upload NAS server host file. Schema string file Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 203
HTTP Code 422 Description Operation Failed Schema error_response 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 optional Upload NAS - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 204
Parameters Type Path Name id required Description Unique identifier of the NAS server. Responses HTTP Code 200 Description Success 404 Not Found 422 Operation Failed Produces • document/text POST /nas_server/{id}/upload/netgroup Description Upload the NAS server netgroup file. Parameters - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 205
HTTP Code 422 Description Operation Failed Schema error_response Consumes • multipart/form-data GET /nas_server/{id}/download/netgroup Description Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details. Parameters Type Path Name id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 206
Type Path Name id required FormDat body a optional Description Unique identifier of the NAS server. Upload the NAS server nsswitch file. Schema string file Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 207
HTTP Code 422 Description Operation Failed Schema error_response 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 optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 208
Parameters Type Path Name id required Description Unique identifier of the NAS server. Responses HTTP Code 200 Description Success 404 Not Found 422 Operation Failed Produces • document/text POST /nas_server/{id}/upload/ntxmap Parameters Type Path Name id required Description Unique - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 209
updates file ownership on the NAS server's file systems to reflect changes to users' SIDs. A new UID/GID will be obtained from a Unix Directory Service for the user name of the object owner. A user mapping report is also generated. This operation can take a significant amount of time, depending of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 210
Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response GET /nas_server/{id}/download/user_mapping_report Description Download the report generated by the update_user_mappings action. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 211
GET /network Description Query the IP network configurations of the cluster. Responses HTTP Code Description 200 Success 206 Partial content of network instance objects GET /network/{id} Description Query a specific IP network configuration. Parameters Type Path Name id required - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 212
PATCH /network/{id} Description Modify IP network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses. Parameters Type Path Name id required Description Unique identifier of the IP network. Schema string Body body optional network_modify Responses HTTP Code 204 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 213
Type Body Name body required Description Schema network_replace 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 • application/json Produces • application/json POST - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 214
HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response error_response Consumes • application/json Produces • application/json nfs_export NFS Exports use the NFS protocol to provide an access point for - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 215
Parameters Type Body Name body required Schema nfs_export_create Responses HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /nfs_export/{id} Description Get NFS Export properties. Parameters Type Path - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 216
Parameters Type Path Name id required Description NFS Export object id. Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed PATCH /nfs_export/{id} Description Modify NFS Export Properties. Parameters Type Path Name id required Description NFS Export object - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 217
. 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 9000T | EMC PowerStore REST API Developers Guide - Page 218
HTTP Code 400 Description Invalid Request 422 Operation Failed GET /nfs_server/{id} Description Query settings of an NFS server. Parameters Type Path Name id required Description Unique identifier of the NFS server. Responses HTTP Code 200 Description Success 404 Not Found DELETE / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 219
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /nfs_server/{id} Description Modify NFS server settings. Parameters Type Path Name id required Description Unique identifier of the NFS server. Body body - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 220
Parameters Type Path Name id required Body body required Description Unique identifier of the NFS server. Schema string nfs_server_join Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Operation Failed Schema No Content error_response error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 221
HTTP Code 400 Description Invalid request 404 Not Found 422 Operation Failed Schema error_response error_response error_response node Use this resource type to retrieve information about nodes in a cluster. GET /node Description Query the nodes in a cluster. Responses HTTP Code 200 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 222
HTTP Code 200 Description Success 404 Not found Consumes • application/json Produces • application/json ntp Manage DNS and NTP settings for the cluster. GET /ntp Description Query NTP settings for a cluster. Responses HTTP Code 200 Description Success 206 Partial content of ntp instance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 223
Responses HTTP Code 200 Description Success 404 Not Found PATCH /ntp/{id} Description Modify NTP settings. Parameters Type Path Name id required Body body required Description Unique identifier of the NTP setting. Responses HTTP Code 204 Description Success 400 Invalid Request 404 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 224
performance_rule Information about performance rules that can be use in performance policies applied to volumes and volume groups. GET /performance_rule Description Get performance rules. Responses HTTP Code Description 200 OK Schema < performance_rule _instance > array 206 Partial content - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 225
HTTP Code 404 Description The performance_rule does not exist. Schema error_response Produces • application/json physical_switch Manage physical switches settings for the cluster. GET /physical_switch Description Query physical switches settings for a cluster. Responses HTTP Code Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 226
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /physical_switch/{id} Description Query a specific physical switch settings. Parameters Type Path Name id required Description Schema Unique identifier of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 227
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /physical_switch/{id} Description Modify a physical switch settings. Parameters Type Path Name id required Description Schema Unique identifier of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 228
GET /policy Description Query protection and performance policies. The following REST query is an example of how to retrieve protection policies along with their rules and associated resources: https://{{cluster_ip}}/api/rest/policy? select=name,id,type,replication_rules(id,name,rpo,remote_system(id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 229
Responses HTTP Code 201 Description Success 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /policy/{id} Description Query a specific policy. Parameters Type Path Name id required Description Unique identifier of the policy. Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 230
Operation Failed Schema No Content error_response error_response error_response remote_system Information about remote storage systems that connect to the local PowerStore system. The system uses the configuration to access and communicate with the remote system for management and data transfer - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 231
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 9000T | EMC PowerStore REST API Developers Guide - Page 232
• Name • Description • Remote administrator credentials • iSCSI address - IPv4 address • CHAP mode for discovery or session • CHAP secrets details After the remote system relationship is created, the local system can communicate with the remote system, and open data connections for data transfer. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 233
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 9000T | EMC PowerStore REST API Developers Guide - Page 234
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 9000T | EMC PowerStore REST API Developers Guide - Page 235
Description Verify and update the remote system instance. Detects changes in the local and remote systems and reestablishes data connections, also taking the Challenge Handshake Authentication Protocol (CHAP) settings into account. Parameters Type Path Name id required Description Unique - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 236
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. Parameters Type Body Name body required Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 237
Responses HTTP Code 200 Description Success 404 Not Found Schema replication_rule_i nstance error_response DELETE /replication_rule/{id} Description Delete a replication rule. Deleting a rule is not permitted, if the rule is associated with a protection policy that is currently applied to a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 238
either of the following: Remove the protection policy association from the relevant storage resources, modify the replication rule, and then associate the storage resources with the relevant protection policies. Remove the replication rule from the protection policies that use it, modify the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 239
Replication sessions also provides pause and resume capabilities, to allow for production or disaster recovery-side maintenance requirements. Destination storage resources are in replication destination mode, which disables any write access to the destination resource. Any operations such as - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 240
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 9000T | EMC PowerStore REST API Developers Guide - Page 241
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 /replication_session/{id}/pause Description Pause a replication session instance. You can pause a replication session when - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 242
Failover Use to get production access from the disaster recovery site • Delete the replication session by removing the protection policy on the storage resource The following system operations may also pause, and subsequently resume, a replication session: • Non-disruptive upgrade • Intra-cluster - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 243
also pause, and subsequently resume, a replication session. • Paused_for_NDU • Paused_for_Migration 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 244
parameter, which activates the session in the reverse direction. Unplanned failures are events such as source system failure or an event on the source system that leads to downtime for production access. Unplanned failovers are issued from the destination system, and are indicated by setting the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 245
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 HTTP Code 200 Description Success Schema < role_instance > array 206 Partial content of role instance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 246
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 Not Found Produces • application/json sas_port Use this resource type to retrieve information about SAS ports - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 247
system security configuration GET /security_config 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 248
' - 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 182 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 249
identifier 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. Schema < service_config_ins - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 250
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 9000T | EMC PowerStore REST API Developers Guide - Page 251
. 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 185 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 252
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 9000T | EMC PowerStore REST API Developers Guide - Page 253
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 9000T | EMC PowerStore REST API Developers Guide - Page 254
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 9000T | EMC PowerStore REST API Developers Guide - Page 255
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 9000T | EMC PowerStore REST API Developers Guide - Page 256
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 9000T | EMC PowerStore REST API Developers Guide - Page 257
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 9000T | EMC PowerStore REST API Developers Guide - Page 258
Parameters Type Path Name id required Description SMB Share object id. Responses HTTP Code 200 Description 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 9000T | EMC PowerStore REST API Developers Guide - Page 259
Parameters Type Path Name id required Body body optional Description SMB share object id. Schema string smb_share_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 9000T | EMC PowerStore REST API Developers Guide - Page 260
GET /smtp_config/{id} Description Query the specific SMTP configuration. Parameters Type Path Name id required Description Unique identifier of the SMTP configuration. Schema string Responses HTTP Code 200 Description Success 404 Not Found Schema smtp_config_insta nce error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 261
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 Unique identifier of the SMTP configuration. Body body required Test - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 262
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 9000T | EMC PowerStore REST API Developers Guide - Page 263
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 9000T | EMC PowerStore REST API Developers Guide - Page 264
of JSON objects 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 198 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 265
HTTP Code Description 206 Partial content of software installed instance objects Schema < software_installed _instance > array GET /software_installed/{id} Description Query a specific item from the list of installed software. Parameters Type Path Name id required Description Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 266
HTTP Code Description 200 Success. 206 Partial content of software package instance objects Schema < software_package _instance > array < software_package _instance > array POST /software_package Description Push a software package file from the client to the cluster. When successfully - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 267
Description Query a specific software package. Parameters Type Path Name id required Description Schema Unique identifier of the software package to string query. Responses HTTP Code 200 Description Success 404 Not Found Schema software_package _instance error_response DELETE / - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 268
POST /software_package/{id}/install Description Start a software upgrade background job for the specified appliance within the cluster. If an appliance is not specified, the upgrade is performed on all appliances in the cluster. Only specify a subset of appliances to upgrade if the time required to - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 269
POST /software_package/{id}/puhc Description Run the pre-upgrade health check for a software package. This operation may take some time to respond. Parameters Type Path Name id required Description Unique identifier of the software package. Schema string Body body optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 270
HTTP Code Description 200 Success 206 Partial content of storage container instance objects Schema < storage_container _instance > array < storage_container _instance > array Produces • application/json POST /storage_container Description Create a virtual volume (vVol) storage container. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 271
Parameters Type Path Name id required Description Storage container ID. Responses HTTP Code 200 Description Success 404 Not Found Produces • application/json DELETE /storage_container/{id} Description Delete a storage container. Parameters Type Path Name id required Description Storage - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 272
HTTP Code 422 Description Operation Failed Produces • application/json PATCH /storage_container/{id} Description Modify a storage container. Parameters Type Path Name id required Description Storage container ID. Body body required Fields to update. Responses HTTP Code 204 Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 273
Parameters Type Path Name id required Body body optional Description Storage container ID. Schema string storage_container_m ount Responses HTTP Code 204 Description Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema No Content error_response error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 274
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 9000T | EMC PowerStore REST API Developers Guide - Page 275
HTTP Code 201 Description Created 400 Invalid Request 422 Operation Failed Schema create_response error_response error_response GET /vcenter/{id} Description Query a specific vCenter instance. Parameters Type Path Name id required Description Unique identifier of the vCenter to query. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 276
Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No Content error_response error_response PATCH /vcenter/{id} Description Modify a vCenter settings. Parameters Type Path Name id required Description Unique identifier of the vCenter to modify. Body - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 277
GET /veth_port Description Query virtual Ethernet port configurations. Responses HTTP Code Description 200 Success 206 Partial content of veth port instance objects Schema < veth_port_instanc e > array < veth_port_instanc e > array GET /veth_port/{id} Description Query a specific virtual - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 278
virtual_machine Use this resource type to retrieve cached information from vCenter about virtual machines (VMs) that use storage from the cluster or to create a snapshot of a VM. GET /virtual_machine Description Query virtual machines that use storage from the cluster. Responses HTTP Code - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 279
DELETE /virtual_machine/{id} Description Delete a virtual machine snapshot. This operation cannot be used on a base virtual machine or virtual machine template. Parameters Type Path Name id required Description Schema Unique identifier snapshot to delete. of the virtual machine string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 280
HTTP Code 400 Description Invalid Request 404 Not Found 422 Operation Failed Schema error_response error_response error_response POST /virtual_machine/{id}/snapshot Description Create a snapshot of a virtual machine. This operation cannot be used on a virtual machine snapshot or template. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 281
GET /virtual_volume Description Get virtual volumes. Responses HTTP Code Description 200 Success 206 Partial content of virtual volume instance objects GET /virtual_volume/{id} Description Get a specific virtual volume. Parameters Type Path Name id required Description Id of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 282
Parameters Type Path Name id required Body body optional Description Schema Unique identifier of the virtual volume to delete. string Options to delete a virtual volume. virtual_volume_dele te Responses HTTP Code 204 Description Success 404 Not Found 422 Operation Failed Schema No - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 283
Parameters Type Body Name body required Schema volume_create 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 284
• A volume which has protection policies attached to it cannot be deleted. • A volume which has snapshots that are part of a snapset cannot be deleted. • Clones of a deleted production volume or a clone are not deleted. • Snapshots of the volume are deleted along with the volume being deleted. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 285
HTTP Code 400 Description Invalid Request 404 Not Found 422 Operation Failed Schema error_response error_response error_response POST /volume/{id}/snapshot Description Create a snapshot of a volume or a clone. The source id of the snapshot is the id of source volume or clone. The source time - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 286
Description Create a clone of a volume or snapshot. Parameters Type Path Name id required Description Schema Unique identifier of the volume or snapshot to string create a clone of. Body body optional volume_clone Responses HTTP Code 200 Description Success 204 Success 400 Invalid - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 287
Type Path Body Name id required body required Description Schema Unique identifier of volume for which to refresh contents. string volume_refresh Responses HTTP Code 200 Description Success 204 Success 400 Invalid Request 404 Not Found 422 Operation Failed Schema volume_refresh_r - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 288
Responses HTTP Code 200 Description Success 204 Success 400 Invalid Request 404 Not Found 422 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 289
POST /volume/{id}/detach Description Detach a volume from a host or host group. Parameters Type Path Name id required Description Unique identifier of volume to detach. Body body required Schema string volume_detach Responses HTTP Code 204 Description Success 400 Invalid Request 404 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 290
HTTP Code Description 200 Success 206 Partial content of volume group instance objects Schema < volume_group_ins tance > array < volume_group_ins tance > array POST /volume_group Description Create a new volume group. The resulting volume group will have a type of Primary. Parameters Type - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 291
Responses HTTP Code 200 Description Success 404 Not Found Schema volume_group_ins tance error_response DELETE /volume_group/{id} Description Delete a volume group, snapshot set, or clone. Before you try deleting a volume group, snapshot set, or clone, ensure that you first detach it from all - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 292
Parameters Type Path Name id required Body body optional Description Unique identifier of the volume group. Schema string volume_group_modi fy Responses HTTP Code 204 Description Success 400 Invalid request 404 Not Found 422 Invalid Request Schema No Content error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 293
HTTP Code 400 Description Invalid request 404 Not Found 422 Invalid Request Schema error_response error_response error_response POST /volume_group/{id}/remove_members Description Remove members from an existing primary or clone volume group. This cannot be used to remove members from a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 294
as the source volume group. A snapshot of a volume group will result in a new volume group of Snapshot type. The snapshot set will belong to the same family as the source volume group. When the source of a snapshot operation is a primary or clone volume group, • source_id of the snapshot set will be - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 295
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 9000T | EMC PowerStore REST API Developers Guide - Page 296
only initializes the name to an auto-generated, unique value. Other optional parameters are not specified. The table below outlines supported modes of operation and resulting updates to source_id and source_time attributes of protection_data. |Target volume group|Source volume group|New source_id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 297
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 X509 Certificate service is part of the credential store services. An X509 Certificate in this service represents a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 298
Description Query to list X509 Certificates instances. This resource type collection query does not support filtering, sorting or pagination Responses HTTP Code Description 200 Success Schema < x509_certificate_i nstance > array 206 Partial content of x 509 certificate instance objects < - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 299
clusters. This exchange REST API can only be triggered with service Replication_HTTP. Parameters Type Body Name body required Description Request body Description Decommission x509 certificates for one service type (currently only Replication_HTTP is supported) of one scope (for example - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 300
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. 234 Schema No Content error_response error_response - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 301
PS Peer Storage Group. VNX VNX. Unity Unity. Type : enum (Unknown, SC, PS, VNX, Unity) AuditEventTypeEnum Type of audit event. Authentication All the authentication events on the system. Authorization All the authorization events on the system. Config All the set operations on the system. Example: - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 302
is not compatible. Undetermined The import status cannot be determined due to an internal error. Contact technical support. Type : enum (Ready, In_Progress, Members_Not_Ready, No_Members, Max_Members, Not_In_Sync, Imported, Incompatible_Firmware, Undetermined) CHAPModeEnum Available CHAP modes that - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 303
ClusterStateEnum Possible cluster states. * Unconfigured_Faulted - This is single appliance that is not in a cluster and Hardware is in faulted state. * Unconfigured - This is a single appliance that is not in a cluster. * Configured - Cluster is configured and operational. * Configuring - Cluster - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 304
Saturday Saturday Sunday Sunday Unknown Day of week is unknown to PowerStore. Type : enum (Monday, Tuesday, Wednesday, Thursday, Friday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday) EthPortSpeedEnum Supported Ethernet front-end port transmission speeds. For the current_speed attribute, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 305
1_Gbps 1 Gigabits per second 10_Gbps 10 Gigabits per second 25_Gbps 25 Gigabits per second 40_Gbps 40 Gigabits per second Type : enum (Auto, 10_Mbps, 100_Mbps, 1_Gbps, 10_Gbps, 25_Gbps, 40_Gbps) FcPortSpeedEnum Possible Fibre Channel port speeds. For the current_speed attribute, these values show - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 306
Type : enum (UDP, TCP) 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 9000T | EMC PowerStore REST API Developers Guide - Page 307
Kerberos Kerberos authentication means the NAS Server uses a KDC to confirm the identity when accessing the Active Directory. Type : enum (Anonymous, Simple, Kerberos) FileLDAPProtocolEnum Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 308
Hard_Reached Hard limit is reached. Type : enum (Ok, Soft_Exceeded, Soft_Exceeded_And_Expired, Hard_Reached) FileSystemAccessPolicyEnum File system security access policies. Each file system uses its access policy to determine how to reconcile the differences between NFS and SMB access control. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 309
snapshot 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 9000T | EMC PowerStore REST API Developers Guide - Page 310
to at least 28 days. No alert indicated, 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 244 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 311
Subscriber Connector FC_Style1_Copper Fibre Channel Style 1 Copper Connector FC_Style2_Copper Fibre Channel Style 1 Copper Connector BNC_TNC Bayonet/Threaded Neill-Concelman Connector FC_Coaxial_Headers Fibre Channel Coaxial Headers Connector FiberJack Fiber Jack Connector LC Lucent Connector MT_RJ - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 312
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 9000T | EMC PowerStore REST API Developers Guide - Page 313
Type : enum (Not_Supported, Supported_Unlocked, Supported_Locked, Supported_Locked_Cluster_PIN, Supported_Locked_Out, Supported_Locked_Foreign, Supported_Processing, Disabled) HardwareDriveFIPSStatusEnum FIPS compliance level. Available on the Drive hardware type. Current compliance levels - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 314
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. Empty No - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 315
, MU, SG, Optical_Pigtail, HSSDC_II, Copper_Pigtail, RJ45, No_Separable, MXC_2x16) HardwareSFPModeEnum SFP mode. Available on the SFP hardware type. Current modes are: Unknown This SFP has unknown support. Multi_Mode This SFP supports multi-mode fiber. Single_Mode 249 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 316
single-mode fiber. Type : enum (Unknown, Multi_Mode, Single_Mode) HardwareSFPSpeedEnum Supported speed. Available on the SFP hardware type. Current supported speeds are: Auto Automatically selected link speed 4_Gbps 4 Gigabits per second 8_Gbps 8 Gigabits per second 16_Gbps 16 Gigabits per second - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 317
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, FC, Ethernet, FC_Ethernet, SAS) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 318
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 or - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 319
values are: EQL EQL MPIO. Native_MPIO Native MPIO. Power_Path POWER PATH MPIO. Unknown Type of host agent is unknown to PowerStore. Type : enum (EQL, Native_MPIO, Power_Path, Unknown) HostInitiatorProtocolTypeEnum Protocol type of the import host initiator. Valid values are: Other Protocol type - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 320
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 9000T | EMC PowerStore REST API Developers Guide - Page 321
) order. This occurs when there are more active import sessions than supported. In_Progress Indicates that a queued import session is now in progress. and estimated time left for the copy. Host IOs are pointed to PowerStore in this state. The import process keeps the source and destination volumes - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 322
Ready_For_Cutover Indicates that you can commit the import. The import process moves to this state after it successfully copies data from the source volume or consistency group. Cutover_In_Progress Indicates that the cutover of volumes that are part of a consistency group is in progress. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 323
in 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. iSCSI - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 324
IoPriorityEnum The I/O priority for quality of service rules. Type : enum (Low, Medium, High) IpPortUsageEnum IP port usages. Management Can be used for the public management network. ISCSI Can be used for the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 325
Storage 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 9000T | EMC PowerStore REST API Developers Guide - Page 326
performance_metrics_by_fe_eth_node Frontend ethernet performance metrics for node. performance_metrics_by_fe_fc_node Frontend fibre channel performance metrics for node. wear_metrics_by_drive Drive wear metrics. space_metrics_by_cluster Cluster space metrics space_metrics_by_appliance Appliance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 327
performance_metrics_smb_by_node Performance metrics for the SMB protocol global performance_metrics_smb_builtinclient_by_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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 328
Type : enum (Twenty_Sec, Five_Mins, One_Hour, One_Day) MigrationRecommendationActionStateEnum State of a recommended migration action. Recommendation_Created This action has been recommended, but no other action has been taken. Migration_Session_Created A migration session was successfully - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 329
Valid scopes for migrations are: volume Standalone attached/unattached volume family. virtual_volume Standalone attached/unattached virtual volume family. host Logical group of all volume families attached to a host. virtual_machine Logical group of all virtual volume families attached to a virtual - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 330
sync 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 9000T | EMC PowerStore REST API Developers Guide - Page 331
MigrationResourceTypeEnum Storage resource types eligible for migration. Type : enum (volume, virtual_volume, volume_group) MigrationSessionStateEnum Migration session states. Initializing Migration session starts and stays in this state until the session initialization completes. Initialized - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 332
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 Months - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 333
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 9000T | EMC PowerStore REST API Developers Guide - Page 334
Starting NAS server is starting. Started NAS server is started. Stopping NAS server is stopping. Failover NAS server has failed over. Degraded NAS server is degraded (running without backup). Unknown NAS server state is unknown. Type : enum (Stopped, Starting, Started, Stopping, Failover, Degraded, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 335
Kerberos Allow only Kerberos security for user authentication. Kerberos_With_Integrity Allow only Kerberos with integrity and Kerberos with encryption security for user authentication. Kerberos_With_Encryption Allow only Kerberos with encryption security for user authentication. Type : enum (Sys, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 336
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, consisting - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 337
be 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 9000T | EMC PowerStore REST API Developers Guide - Page 338
PS_Equallogic PS EqualLogic import system Storage_Center Storage Center import system XtremIO XtremIO import system Type : enum (PowerStore, Unity, VNX, PS_Equallogic, Storage_Center, XtremIO) ReplicatedResourceTypeEnum Storage resource types eligible for replication protection: volume Replication - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 339
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 the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 340
ResourceActionEnum User-specified action to be performed on the given resource. Type : enum (add_members, attach, bind, cancel, cleanup, clone, create, create_migration_sessions, cutover, decommission, delete, detach, discover, download, drive_repurpose, exchange, failover, forecast, generate, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 341
Volume migration state is unknown to PowerStore. Type : enum (Up, Down, Degraded, Unknown) SMBShareOfflineAvailabilityEnum Defines valid states of Offline Availability, Manual Only specified files will be available offline. Documents All files that users open will be available offline. Programs - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 342
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 in series - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 343
containing 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. Type : enum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 344
StorageElementTypeEnum Storage element type being replicated: volume Replicating storage element type for a volume. virtual_volume Replicating storage element type for a virtual volume. Type : enum (volume, virtual_volume) ThumbprintAlgorithmEnum The thumbprint algorithm: - SHA-256 : SHA-256 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 345
Discovery_Connection_Refused Connection was refused during discovery of target IP. Discovery_Timeout Discovery of target IP timed out. Type : enum (Login_Success, Authentication_Failure, Connection_Refused, Login_Timeout, Network_Error, General_Failure, Login_Success_No_Ports, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 346
), 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 9000T | EMC PowerStore REST API Developers Guide - Page 347
{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 9000T | EMC PowerStore REST API Developers Guide - Page 348
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 9000T | EMC PowerStore REST API Developers Guide - Page 349
Green VM is operating normally. Yellow VM is operating normally, but there are potential issues. Red VM is experiencing issues and is not operating normally. Grey Status of the VM cannot be determined. Type : enum (Green, Yellow, Red, Gray) VirtualMachineTypeEnum Type of VM: Primary A base VM. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 350
system only supports agentless import. * Unknown - The volume migration state cannot be determined. Type : enum (None, Prepared, Disabled_For_IO, In_Progress, Completed, Aborted, Not_Applicable, Unknown) VnxVolumeStateEnum State of the VNX - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 351
agent version on the host is not compatible. Undetermined The import status cannot be determined due to an internal error. Contact technical support. Host_Volume_Offline The host volume is offline. Cluster_Node_Count_MisMatch The host or hosts added to the appliance are not part of the host cluster - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 352
VNX_Internal_Volume The VNX volume is an internal volume. Unity_System_Health_Inappropriate The health of the Unity system is not suitable for import. Unity_Volume_Health_Inappropriate The health of the Unity volume is not suitable for import. XtremIO_Severity_Inappropriate The severity level of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 353
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. 287 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 354
is used: • Management HTTP - Management Web server • Replication HTTP - Remote Replication service • VASA HTTP - VASA provider service • Import HTTP - External web service Type : enum (Management_HTTP, Replication_HTTP, VASA_HTTP, Import_HTTP) X509CertificateUsageTypeEnum Usage of the certificate - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 355
was acknowledged, if any. optional Schema string (date-time) called_home_t imestamp Timestamp when the event resulted in a notification support (via Secured Remote Services), if any. to string (date-time) optional cleared_times tamp Timestamp of the event that cleared this alert. optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 356
events optional List of events associated with this alert. Filtering on the < event_instance > fields of this embedded resource is not supported. array generated_tim estamp Timestamp of the latest event for this alert. optional string (date-time) id optional Unique identifier of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 357
Name state_l10n optional Description Localized message string corresponding to state Schema string alert_modify Alert modify request body. Name Description acknowledged _severity optional is_acknowledg ed Indicates whether the alert has been acknowledged. required Schema SeverityEnum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 358
resource type eth_port association. < eth_port_instance > array express_servi ce_code Express Service Code. optional string fc_ports optional This is the inverse of the the appliance. string name optional Name of the appliance. This property supports casestring insensitive filtering 292 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 359
optional < sas_port_instance This is the inverse of the resource type sas_port association. > array service_tag optional Dell Service Tag. string software_inst alled optional This is the inverse association. of the resource type software_installed < software_installed_i nstance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 360
Name appliance_id optional Description Unique ID of appliance. Schema string Timestamp of the end of the capacity forecast. If time to full end_of_foreca 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 9000T | EMC PowerStore REST API Developers Guide - Page 361
Name job_id optional Description Schema Unique identifier of the (if any). job associated with the audit event string message_argu ments Arguments (if applicable) for the audit_event message. optional < string > array message_code optional Unique identifier of the message for this - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 362
base_copy_metrics_by_appliance Copy metrics for the appliance. 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) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 363
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 data_remaini ng optional Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 364
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 9000T | EMC PowerStore REST API Developers Guide - Page 365
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 optional Data transfer rate (in bytes/second) data_transferred and transfer_time. computed using - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 366
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 9000T | EMC PowerStore REST API Developers Guide - Page 367
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 9000T | EMC PowerStore REST API Developers Guide - Page 368
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 9000T | EMC PowerStore REST API Developers Guide - Page 369
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 9000T | EMC PowerStore REST API Developers Guide - Page 370
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 9000T | EMC PowerStore REST API Developers Guide - Page 371
in bytes. optional number (float) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz ation dedicated to servicing storage I/O requests. Calculated over time interval across appliance. Derived from an average of number (float) optional utilization across all - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 372
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 optional Average read and write latency in microseconds. avg_read_late ncy Average - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 373
Name total_iops optional Description Total read and write operations per second. write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations per second. Schema number (float) number (float) number (float) base_performance_metrics_by_cluster_rollup Summary of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 374
Name Description avg_write_ban dwidth Weighted average write bandwidth in bytes per second. optional Schema number (float) avg_write_iop s Average writes per second. optional number (float) avg_write_late ncy Weighted average write latency in microseconds. optional number (float) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 375
Name max_read_ba ndwidth optional Description Maximum read bandwidth in bytes per second. max_read_iop s Maximum reads per second. optional 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 376
Name bytes_tx_ps optional Description The total bytes transmitted per second. Schema number (float) node_id optional Reference to the associated node on which these metrics string were recorded. pkt_rx_crc_er ror_ps optional The number of packets dropped) per second. received with CRC - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 377
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 9000T | EMC PowerStore REST API Developers Guide - Page 378
Name Description Schema max_pkt_tx_e rror_ps optional The maximum number of packets transmitted per second due to error. that failed to be number (float) max_pkt_tx_p s The maximum number of packets transmitted per second. optional number (float) node_id optional Reference to the were - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 379
Name Description Schema pkt_rx_no_buf fer_error_ps optional The number of packets discarded per second due to lack of buffer space. number (float) pkt_rx_ps optional The number of packets received per second. number (float) pkt_tx_error_ ps optional The number of packets second due to - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 380
Name Description Schema avg_pkt_rx_no _buffer_error_ ps The average number of to lack of buffer space. packets discarded per second due number (float) optional avg_pkt_rx_ps The average number of packets received per second. optional number (float) avg_pkt_tx_er ror_ps optional The - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 381
Name Description max_pkt_tx_p s The maximum number of packets transmitted per second. optional Schema number (float) node_id optional Reference to the node the port belongs to. string repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 382
Name Description dumped_fram es_ps Dumped frames per second. optional Schema number (float) invalid_crc_co unt_ps Invalid crc count per second. optional number (float) invalid_tx_wo rd_count_ps Invalid transmission word count per second. optional number (float) link_failure_c ount_ps - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 383
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 9000T | EMC PowerStore REST API Developers Guide - Page 384
Name Description avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) avg_dumped_f rames_ps Average dumped frames per second. optional number (float) avg_invalid_cr c_count_ps - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 385
Name Description avg_read_iops optional Average reads per second. avg_read_late ncy Weighted average read latency in microseconds. optional avg_read_size optional Weighted average read size in bytes. avg_total_ban dwidth Weighted average total bandwidth in bytes per second. optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 386
Name Description avg_write_ban dwidth Weighted average write bandwidth in bytes per second. optional Schema number (float) avg_write_iop s Average writes per second. optional number (float) avg_write_late ncy Weighted average write latency in microseconds. optional number (float) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 387
Name Description max_dumped_ frames_ps The maximum dumped frames per second. optional Schema number (float) max_invalid_c rc_count_ps The maximum invalid crc count per second. optional number (float) max_invalid_t x_word_count _ps The maximum invalid transmission word count per second. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 388
Name Description max_total_iop s Maximum totals per second. optional Schema number max_unaligne d_bandwidth Maximum unaligned read/write rate in bytes per second. optional number (float) max_unaligne d_iops Maximum unaligned total input/output per second. optional number (float) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 389
Name timestamp optional Description End of sample period. Schema string (date-time) base_performance_metrics_by_fe_fc_port Performance metrics for the frontend fibre channel port collected at twenty second interval. Name appliance_id optional Description Schema Reference to the associated - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 390
Name Description invalid_crc_co unt_ps Invalid crc count per second. optional 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 391
Name total_iops optional Description 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. optional unaligned_rea d_bandwidth Unaligned read rate in bytes per second. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 392
Name Description avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) avg_dumped_f rames_ps Average dumped frames per second. optional number (float) avg_invalid_cr c_count_ps - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 393
Name Description avg_read_iops optional Average reads per second. avg_read_late ncy Weighted average read latency in microseconds. optional avg_read_size optional Weighted average read size in bytes. avg_total_ban dwidth Weighted average total bandwidth in bytes per second. optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 394
Name Description avg_write_ban dwidth Weighted average write bandwidth in bytes per second. optional Schema number (float) avg_write_iop s Average writes per second. optional number (float) avg_write_late ncy Weighted average write latency in microseconds. optional number (float) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 395
Name Description max_current_ Maximum number of logins to the target from initiators. logins Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_dumped_ frames_ps The maximum dumped frames per second. optional number (float) max_invalid_c - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 396
Name max_total_ba ndwidth optional Description 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) max_unaligne - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 397
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_file_system Performance metrics for the file system - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 398
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 9000T | EMC PowerStore REST API Developers Guide - Page 399
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_total_ban dwidth Average data transfer rate in bytes per second. optional number (float) avg_total_iops Average read and - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 400
Name Description max_avg_size optional Maximum of average read and write size in bytes. 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 9000T | EMC PowerStore REST API Developers Guide - Page 401
base_performance_metrics_by_nfs Performance metrics for the nfs collected at twenty second interval. 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) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 402
base_performance_metrics_by_nfs_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 403
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 9000T | EMC PowerStore REST API Developers Guide - Page 404
Name Description avg_md_laten cy Average md latency operations per second. optional Schema number (float) failed_md_ops Total failed md operations per second. optional number (float) md_ops optional Total md operations per second. number (float) node_id optional Unique identifier of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 405
Name Description avg_md_laten cy Average md latency per second. optional avg_md_ops optional Average md operations per second. avg_read_iops optional Average read operations per second. avg_total_iops Average read and write operations per second. optional avg_write_iop s Average write - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 406
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 9000T | EMC PowerStore REST API Developers Guide - Page 407
Name write_iops optional Description Total write iops in microseconds. Schema number (float) base_performance_metrics_by_nfsv4_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 408
Name Description max_total_iop s Maximum read and write 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 409
9223372036854775807 integer (int64) io_workload_c The percentage of CPU Utilization on the cores dedicated to pu_utilization 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 9000T | EMC PowerStore REST API Developers Guide - Page 410
Name Description 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 second. optional unaligned_wri te_bandwidth Unaligned write rate in bytes per - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 411
Name Description Schema 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 within the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 412
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 9000T | EMC PowerStore REST API Developers Guide - Page 413
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 9000T | EMC PowerStore REST API Developers Guide - Page 414
Name Description max_unaligne d_read_bandw idth Maximum unaligned read rate in bytes per second. optional max_unaligne d_read_iops Maximum unaligned read input/output per second. optional max_unaligne d_write_band width Maximum unaligned write rate in bytes per second. optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 415
Name Description hash_avg_late ncy Average hash latency. optional Schema number (float) hash_avg_size Average hash size. optional 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 416
base_performance_metrics_by_smb_cache_rollup Performance metrics nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name Description hash_avg_late ncy Average hash latency. optional Schema number (float) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 417
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 9000T | EMC PowerStore REST API Developers Guide - Page 418
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 9000T | EMC PowerStore REST API Developers Guide - Page 419
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 optional Average read size in bytes. number (float) avg_write_iop s Average write operations - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 420
Name max_calls optional Description Maximum calls. Schema number (float) max_iops optional Maximum read and write operations per second. number (float) max_read_iop s Maximum read operations per second. optional number (float) max_write_io ps optional Maximum write operations per second. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 421
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 optional Average write size in bytes. number (float) node_id optional Unique identifier of the node - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 422
Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_iops optional Average read and write operations per second. number (float) avg_latency optional Maximum read and write latency in microseconds. number (float) avg_read_iops optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 423
Name Description max_avg_size optional Maximum of average read and write size in bytes. 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 9000T | EMC PowerStore REST API Developers Guide - Page 424
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 Average read - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 425
base_performance_metrics_by_smb_v1_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 9000T | EMC PowerStore REST API Developers Guide - Page 426
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 9000T | EMC PowerStore REST API Developers Guide - Page 427
base_performance_metrics_by_smb_v1_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. Schema number (float) avg_latency optional Average read and write latency in microseconds. number ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 428
Name write_iops optional Description Total write operations per second. Schema number (float) base_performance_metrics_by_smb_v1_node_rollup Summary of smb v1 node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 429
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 9000T | EMC PowerStore REST API Developers Guide - Page 430
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 9000T | EMC PowerStore REST API Developers Guide - Page 431
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 9000T | EMC PowerStore REST API Developers Guide - Page 432
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 9000T | EMC PowerStore REST API Developers Guide - Page 433
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 9000T | EMC PowerStore REST API Developers Guide - Page 434
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 9000T | EMC PowerStore REST API Developers Guide - Page 435
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 optional Average read operations per second. number (float) avg_read_late ncy Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 436
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 9000T | EMC PowerStore REST API Developers Guide - Page 437
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 optional Average read size in bytes. avg_write_late ncy Average write latency in microseconds. optional avg_write_size - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 438
Name Description write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations per second. Schema number (float) number (float) base_performance_metrics_by_vm Performance metrics for the virtual machine collected at twenty second interval. Name avg_io_size - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 439
Name timestamp optional Description End of sample period. Schema string (date-time) total_bandwid th Total data transfer rate in bytes per second. optional number (float) total_iops optional Total read and write operations per second. number (float) vm_id optional Unique identifier - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 440
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 optional Average total input and output operations per second. number ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 441
Name Description max_avg_writ e_size Maximum of average write size in bytes. optional Schema 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 number (float) max_total_ba ndwidth - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 442
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 Average read and write latency in microseconds. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 443
Name volume_id optional Description Unique identifier representing a specific volume. write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations per second. Schema string number (float) number (float) base_performance_metrics_by_volume_rollup Summary of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 444
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 9000T | EMC PowerStore REST API Developers Guide - Page 445
) number number (float) number (float) integer (int32) string (date-time) string base_response Base response object Filtering on the fields of this embedded resource is not supported. Name response_type required Schema string 379 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 446
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 optional This metric represents amount of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 447
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. Name appliance_id optional Description Schema Reference to the associated metrics were recorded - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 448
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 9000T | EMC PowerStore REST API Developers Guide - Page 449
Name Description max_data_red uction Maximum data reduction space during the period. optional max_efficienc y_ratio Maximum efficiency ratio during the period. optional max_logical_p Maxiumum logical total space during the period. rovisioned Minimum value : 0 optional Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 450
base_space_metrics_by_cluster Space metrics for the cluster collected at five minute interval. Name cluster_id optional Description Identifier of the cluster. Schema string data_physical _used optional This metric represents total amount of physical space user data occupies after deduplication - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 451
of cluster 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 385 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 452
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 9000T | EMC PowerStore REST API Developers Guide - Page 453
Name Description max_data_red uction Maximum data reduction space during the period. optional max_efficienc y_ratio Maximum efficiency ratio during the period. optional max_logical_p Maximum logical total space during the period. rovisioned Minimum value : 0 optional Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 454
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 9000T | EMC PowerStore REST API Developers Guide - Page 455
Name Description last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 last_snapshot_ savings Last snapshot savings during the period. optional max_logical_p Maximum logical provisioned space during the period. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 456
Name logical_used optional Description Schema Total amount of data in bytes written to all member volumes in a volume group. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated. Minimum value : 0 Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 457
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 9000T | EMC PowerStore REST API Developers Guide - Page 458
Name timestamp optional vg_id optional Description End of sample period. Unique identifier representing a specific volume group. Schema string (date-time) string base_space_metrics_by_vm Space metrics for the VM collected at five minute interval. Name Description Schema Total configured size - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 459
Name thin_savings optional Description Schema Ratio of all the vVol provisioned to data they contain. This is the ratio of logical_provisioned to logical_used. For example, a VM has two 2 GB vVol's and have written 500 number (float) MB of data to them. The thin savings would be (2 * 2GB) / (2 * - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 460
Name Description last_unique_p Last unique physical used space during the period. hysical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 461
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string 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 ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 462
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 9000T | EMC PowerStore REST API Developers Guide - Page 463
Name Description Schema Amount of physical space volume family used after unique_physic compression and deduplication. This is the space to be al_used freed up if a volume family is removed from the appliance. integer (int64) optional Minimum value : 0 Maximum value : 9223372036854775807 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 464
Name Description max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_logical_u Max logical used space during the period. sed Minimum value : 0 optional Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 465
Name Description last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 466
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 9000T | EMC PowerStore REST API Developers Guide - Page 467
packet size that the bond can transmit, in bytes. Minimum value : 0 integer (int32) Maximum value : 2147483647 Bond name. This property supports case-insensitive string filtering chap_config_instance Name id optional Description Schema Unique id of the CHAP config settings instance (always - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 468
Name Description Schema initiator_sessi on_password optional Password used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only. string (password) initiator_sessi Username used by the initiator to authenticate the target on_username string during - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 469
Name low_value optional Description Schema Estimate of the lower bound of the 95% confidence interval for the forecast value at the given timestamp. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 mean_value optional Estimate for the mean forecast value at the given - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 470
Name Description master_applia nce_id The id of the appliance acting as master. optional Schema string name optional The name of the cluster. string physical_mtu optional The physical ethernet port (eth_port resource) MTU setting, global for all ports in the cluster. This is the default - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 471
cluster_time_to_full Name metric_type required Schema ForecastMetricTypeEnum cluster_time_to_full_response Name cluster_id optional Description Unique ID of the cluster. Schema string end_of_foreca st optional Timestamp of the end of the capacity forecast. If time to full estimates are null, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 472
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 9000T | EMC PowerStore REST API Developers Guide - Page 473
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 9000T | EMC PowerStore REST API Developers Guide - Page 474
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 Data transfer rate (in bytes/second) computed using - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 475
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 remote_syste m_id optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 476
copy_metrics_by_vg Cluster wide copy metrics for the volume group. Polymorphism : Inheritance Discriminator : entity Name data_remaini ng optional Description Schema Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 integer (int64) Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 477
Name transfer_rate optional Description Schema Data transfer rate (in bytes/second) data_transferred and transfer_time. computed using number (float) transfer_time optional The time (in milliseconds) spent in copy activity during this sampling period. Minimum value : 0 integer (int64) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 478
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 9000T | EMC PowerStore REST API Developers Guide - Page 479
data_connection_instance Data connection status between the local node and a remote target. Name Description initiator_addr ess Initiating address from the local node. optional node_id optional Unique identifier of the local, initiating node. status optional Status of the data connection. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 480
Name id optional Description Unique identifier of the DNS setting. Schema string dns_modify 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 Email address to - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 481
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 9000T | EMC PowerStore REST API Developers Guide - Page 482
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 9000T | EMC PowerStore REST API Developers Guide - Page 483
integer (int32) optional Maximum value : 2147483647 hypervisor_po rt_name optional Hypervisor front-end port name capabilities. This property supports case-insensitive filtering string hypervisor_vs witch_id Unique identifier of the virtual switch associated with the string hypervisor port - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 484
false Link is down. mac_address optional Ethernet port MAC address. string name optional Ethernet port name. 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 485
of type (Small Form-factor Pluggable) inserted into the port. 'SFP' string supported_sp eeds optional < The list of supported transmission speeds for Ethernet port. EthPortSpeedEnum > array supported_sp eeds_l10n optional Localized message supported_speeds array corresponding to < string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 486
well. So, although they may be interesting for troubleshooting, it is not necessary to monitor events. Name optional Suggestions for how to resolve any problems that may arise from this event. string generated this event. This property supports case-insensitive filtering string resource_type The - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 487
the port's link 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 421 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 488
sfp_id optional Unique identifier of the hardware instance of type 'SFP' string (Small Form-factor Pluggable) inserted into the port. supported_sp eeds optional List of supported transmission speeds for the port. < FcPortSpeedEnum > array 422 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 489
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 9000T | EMC PowerStore REST API Developers Guide - Page 490
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 transport_l10 n optional Localized message string corresponding to transport string file_dns_modify Name Description Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 491
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 9000T | EMC PowerStore REST API Developers Guide - Page 492
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 9000T | EMC PowerStore REST API Developers Guide - Page 493
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 9000T | EMC PowerStore REST API Developers Guide - Page 494
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 9000T | EMC PowerStore REST API Developers Guide - Page 495
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 9000T | EMC PowerStore REST API Developers Guide - Page 496
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 9000T | EMC PowerStore REST API Developers Guide - Page 497
Name add_groups optional Description Schema Groups to add to the current groups. Error occurs if group already exists. Cannot be combined with groups. the < string > array add_hosts optional Host IP addresses to add to the current hosts. The addresses < string (ip-address) may be IPv4 or IPv6 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 498
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 9000T | EMC PowerStore REST API Developers Guide - Page 499
Name Description Schema is_homedir_li mit_enabled optional Indicates whether an FTP or SFTP user access is limited to the home directory of the user. Values are: - true - An FTP or SFTP user can access only the home directory of the boolean user. - false - FTP and SFTP users can access any NAS - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 500
bytes. 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 9000T | EMC PowerStore REST API Developers Guide - Page 501
of the file interface. string ip_address optional IP address of the network interface. IPv4 and IPv6 are string (ip-address) supported. is_disabled optional Indicates whether the network interface is disabled. Default : false boolean name optional Name of the network interface. This - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 502
whether the network interface is disabled. Default : false boolean 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 503
file_interface_route_create 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, there is no value because the system will use the specified gateway IP address. string (ip-address) • - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 504
Name gateway optional Description IP address of the gateway associated with the route. Schema string (ip-address) id optional read-only Unique identifier of the file interface route. string operational_st atus optional FileInterfaceRouteO perationalStatusEnu m operational_st Localized - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 505
object. Only one Kerberos object per NAS string required Server is supported. port_number optional KDC servers TCP port. Default : 88 Minimum value 65535 integer (int32) realm required Realm name of the Kerberos Service. Length : 1 - 255 string file_kerberos_instance This resource type - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 506
: 65535 integer (int32) realm optional Realm name of the Kerberos Service. Length : 1 - 255 string Fully Qualified domain names of the be combined with kdc_addresses. IPv4 and IPv6 addresses are not supported. file_ldap_create Arguments for the create operation. Name addresses optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 507
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 will use this LDAP object. Only one LDAP object per NAS string Server is supported. 441 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 508
Name password optional Description The associated password for Kerberos authentication. Length : 0 - 1023 Schema string (password) 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 389 and LDAPS is 636. integer ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 509
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 id optional read-only Unique identifier of the LDAP service object. string is_certificate_ Indicates whether an LDAP certificate - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 510
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 9000T | EMC PowerStore REST API Developers Guide - Page 511
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 9000T | EMC PowerStore REST API Developers Guide - Page 512
these NDMP settings. NAS server to be configured with string password required Password for the NDMP service user. string (password) user_name required User name for accessing the NDMP service. string file_ndmp_instance This resource type has queriable association from nas_server 446 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 513
. required < string (ip-address) > 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 447 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 514
nas_server_instance Unique identifier of the associated NAS Server instance that nas_server_id uses this NIS Service object. Only one NIS Service per NAS string optional Server is supported. file_nis_modify Name Description Schema add_ip_addres ses optional IP addresses to add to the current - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 515
Name Description folder_renam e_policy optional Schema FileSystemFolderRe namePolicyEnum 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. false Asynchronous MTIME is disabled - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 516
Name Description Schema Indicates if opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled optional Opportunistic file locking is enabled on the file system. false Opportunistic file locking is disabled on the file system. boolean Indicates - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 517
Name description optional Description File system description. (255 UTF-8 characters). Length : 0 - 255 Schema string folder_renam e_policy optional FileSystemFolderRe namePolicyEnum Indicates whether asynchronous MTIME is enabled on the file system or protocol snaps that are mounted writeable. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 518
Name Description Schema Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify true _on_write_ena bled File writes notifications are enabled on the file system. optional false File writes notifications are disabled on the file system. Default : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 519
Name size_total required Description Schema Size that the file system presents to the host or end user. (Bytes) Minimum value : 3221225472 integer (int64) Maximum value : 281474976710656 smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 520
Name Description Schema default_hard_ limit optional Default hard limit of user quotas and tree quotas (bytes). (0 means 'No limitation'. This value can be used to compute the amount of space consumed without limiting the space). integer (int64) Minimum value : 0 Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 521
Name grace_period optional Description Schema Grace period of soft limit (seconds): -1: Infinite grace period (Windows policy). 0: Use default grace period of 1 week (default). positive: Grace period after which the soft limit is treated as a hard limit (seconds). integer (int32) Default : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 522
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en true abled File access notifications are enabled on the file system. boolean optional false File access notifications are disabled on the file system - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 523
Localized message string corresponding to locking_policy optional string name optional File system filtering name. This property supports case-insensitive string nas_server optional This is the embeddable reference form of nas_server_id nas_server_instance attribute. nas_server_id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 524
Name Description Schema smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any. epth Minimum value : 0 integer (int32) optional Maximum value : 2147483647 smb_shares optional < This is the inverse of the resource type smb_share - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 525
enabled 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 9000T | EMC PowerStore REST API Developers Guide - Page 526
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify true _on_access_en abled File access notifications are enabled on the file system. optional false boolean File access notifications on file access are disabled on - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 527
Name size_total optional Description Schema Size, in bytes, presented to the host or end user. This can be used for both expand and shrink on a file system. Minimum value : 3221225472 integer (int64) Maximum value : 281474976710656 smb_notify_on Lowest directory level to which the enabled - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 528
Name expiration_ti mestamp optional Description Time, when the snapshot will expire. Schema string (date-time) folder_renam e_policy optional FileSystemFolderRe namePolicyEnum Indicates whether asynchronous MTIME is enabled on the protocol snaps that are mounted writeable. Values are: - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 529
Name Description Schema Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena true bled File writes notifications are enabled on the file system. boolean optional false File writes notifications are disabled on the file system. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 530
Name id optional Description The id of the created snapshot. Schema string file_tree_quota_create Name description optional Description Description of the tree quota. Schema string file_system_id Unique identifier of the associated file system. required string hard_limit optional Hard - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 531
Name description optional Description Description of the tree quota. Schema string file_system optional This is the embeddable reference form of file_system_id file_system_instance attribute. file_system_id optional Unique identifier of the associated file system. string file_user_tree - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 532
Name soft_limit optional state optional state_l10n optional Description Schema Soft limit of the tree quota, in bytes. No hard limit when set to 0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 FileQuotaStateEnum Localized message string corresponding to state string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 533
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 9000T | EMC PowerStore REST API Developers Guide - Page 534
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 9000T | EMC PowerStore REST API Developers Guide - Page 535
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 9000T | EMC PowerStore REST API Developers Guide - Page 536
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 9000T | EMC PowerStore REST API Developers Guide - Page 537
denied to prevent potential viruses propagation. - false - Anti-virus service is disabled. File systems of the NAS servers are available for type. Filtering on the fields of this embedded resource is not supported. Name bus_number optional Description Schema Bus number of the Expansion_Shelf. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 538
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 9000T | EMC PowerStore REST API Developers Guide - Page 539
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 9000T | EMC PowerStore REST API Developers Guide - Page 540
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 9000T | EMC PowerStore REST API Developers Guide - Page 541
Name name optional Description Schema 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 node_fc_ports optional This is the inverse of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 542
that the state returned in the hardware component may not actually change for up to 60 seconds. This operation is currently supported for Base_Enclosure, Expansion_Enclosure, Node and Drive. Note that operations at the Base_Enclosure and boolean Expansion_Enclosure apply to their children (Nodes and - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 543
host_create 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 string have any unprintable characters. Maximal length : 256 initiators required < initiator_create_mod ify > array - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 544
host_group_create Create host group parameters. 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 545
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 9000T | EMC PowerStore REST API Developers Guide - Page 546
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 host_virtual_v olume_mappi This is the inverse of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 547
host_volume_mapping association. resource < type host_volume_mappi ng_instance > array name optional The host filtering name. This property supports case-insensitive string os_type optional OSTypeEnum os_type_l10n Localized message string corresponding to os_type optional string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 548
host_virtual_volume_mapping_instance Virtual volume mapping details. This resource type has queriable associations from host, host_group, virtual_volume Name host optional Description Schema This is the embeddable reference form of host_id attribute. host_instance host_group optional This is - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 549
Name Description Schema host_group_id optional Unique identifier of a host group attached to a volume. The host_id and host_group_id cannot both be set. string host_id optional Unique identifier of a host attached to a volume. The string host_id and host_group_id cannot both be set. id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 550
import_host_system_create Required parameters for adding an import host system. Name Description agent_address required Hostname or IPv4 address of the import host system. Schema string agent_port required TCP port of the import host system. Minimum value : 0 Maximum value : 65535 integer ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 551
Name Description agent_address optional Hostname or IPv4 address of the import host system. agent_api_ver sion API version of the import host system. optional agent_port optional TCP port on the import host system. Minimum value : 0 Maximum value : 2147483647 agent_status optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 552
Name os_version optional Description Operating system version of the import host system. user_name optional Username for the import host system. Schema string string import_host_volume_instance Details about an import host volume. Name active_path optional Description Active path of the host - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 553
to the string import host. name optional Name of the import host volume. This property supports string case-insensitive filtering protocols optional Supported protocols for the import host volume. < HostInitiatorProtoco lTypeEnum > array protocols_l10 n optional Localized message array - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 554
, IPv6 address, or FQDN (Fully Qualified Domain string (ip-address) optional Name). name optional Name of the PS Group. This property supports casestring insensitive filtering serial_numbe r Serial number of the PS Group. optional string user_name optional Name used to log in to the PS - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 555
Name end_time optional Description Time when snapshot creation ends each day, in minutes. Minimum value : 0 Maximum value : 2147483647 Schema integer (int32) frequency optional Frequency at which snapshots are created, in minutes. Minimum value : 0 Maximum value : 2147483647 integer (int32) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 556
import_psgroup_volume_import_snapshot_schedules_ response Type : < import_psgroup_schedule_instance > array import_psgroup_volume_instance PS Group volume instance details. This resource type has queriable association from import_psgroup Name block_size optional Description Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 557
string name optional Name of the volume. This property supports casestring insensitive filtering size optional Size of the volume, Description Schema automatic_cut Indicates whether the import session cutover is manual over (true) or automatic (false). boolean optional Default - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 558
of the import session. The name must be unique in the PowerStore cluster and can contain a maximum of 128 unicode characters. It consistency group after protection_po the import completes. Only snapshot policies are supported licy_id string in an import. Once the import completes, you can - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 559
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 bytes/sec over the whole copy period. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 560
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 9000T | EMC PowerStore REST API Developers Guide - Page 561
Name state_l10n optional Description Localized message string corresponding to state Schema string volume_group Unique identifier of the volume group to which the _id string destination volume will be added, if any. optional import_session_modify Name Description Schema scheduled_tim - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 562
string name optional Name of the SC consistency case-insensitive filtering group. This property supports string import_storage_center_instance This resource type has queriable associations from import_storage_center_volume, import_storage_center_consistency_group Name api_version optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 563
Name). model optional Model name of the SC array. string name optional Name of the SC array. insensitive filtering This property supports case- string serial_numbe Serial number of the SC array. r Minimum value : 0 optional Maximum value : 2147483647 integer (int32) status optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 564
Name type optional type_l10n optional Description Type of the snapshot profile. Localized message string corresponding to type Schema ScSnapshotProfileTy peEnum string import_storage_center_volume_import_snapshot_profi les_response Type : < import_storage_center_snapshot_profile_instance > array - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 565
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 9000T | EMC PowerStore REST API Developers Guide - Page 566
optional 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, 500 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 567
Name api_version optional Description Schema Version of the API that the Unity storage system supports. string health optional UnityHealthEnum health_l10n optional Localized message string corresponding to health string id optional Unique identifier of the Unity storage system that is a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 568
Name Description software_vers ion Software version of the Unity storage system. optional Schema string user_name optional User account name used to communicate with the Unity string storage system. import_unity_snapshot_schedule_instance Name id optional Description Unique identifier of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 569
Name Description Schema days_of_week optional Days of applies. the week for which the snapshot schedule rule < UnityDayofWeekEn um > array days_of_week_ l10n Localized message array corresponding to days_of_week optional < string > array hours optional Hourly frequency for the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 570
import_unity_volume_instance This resource type has queriable associations from import_unity, import_unity_consistency_group Name health optional Description Schema UnityHealthEnum health_l10n optional Localized message string corresponding to health string host_volume_i ds optional List of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 571
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 9000T | EMC PowerStore REST API Developers Guide - Page 572
). model optional Model name of the VNX storage system. string name optional Name of the VNX storage system. This property supports string case-insensitive filtering serial_numbe r Serial number of the VNX storage system. optional string software_vers ion optional The software version - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 573
corresponding to string name optional Name of the consistency case-insensitive filtering group. This property supports string import_vnx_volume_instance This resource type has import_vnx_consistency_group queriable associations from import_vnx_array, Name health optional Description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 574
string migration_sta te optional VnxVolumeMigratio nStateEnum migration_sta te_l10n Localized message string corresponding to migration_state optional string name optional Name of the VNX volume. This property supports casestring insensitive filtering 508 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 575
Name size optional wwn optional Description Size of the VNX volume in bytes. Minimum value : 0 Maximum value : 9223372036854775807 World wide name of the VNX volume. Schema integer (int64) string initiator_create_modify Name Description Schema Password for CHAP authentication. This value must - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 576
optional Unique identifier of the port that uses this IP address to provide access to storage This attribute can be set network only for services, such as iSCSI. an IP address used by string networks of type Storage. network optional This is the embeddable reference form of network_id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 577
Name Description available_usa ges Available IP port usages. optional Schema < IpPortUsageEnum > array available_usa ges_l10n Localized message array corresponding to available_usages < string > array optional bond optional This is the embeddable reference form of bond_id attribute. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 578
Name partner_id optional Description Schema Identifier of the IP port that is configured on top of physical Ethernet port or virtual Ethernet port or bond with the same physical location on the other node of the appliance. string Partner ports are configured symmetrically for HA and load - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 579
job_appliance_forecast_response Polymorphism : Inheritance Discriminator : response_type 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 580
Name time_to_full optional Description Schema Estimated date-time full capacity. at which the forecast value will reach string (date-time) time_to_full_o Optimistic date-time for time to full based on the lower ptimistic string (date-time) bound of the forecast 95% confidence - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 581
Name timestamp optional Description Timestamp when the forecast was performed. Schema string (date-time) job_cluster_time_to_full_response Polymorphism : Inheritance Discriminator : response_type Name cluster_id optional Description Unique ID of the cluster. Schema string Timestamp of the end - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 582
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 Error response for an operation. Contains an array of localized messages. Polymorphism : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 583
Discriminator : response_type Name id optional Description The id of the created snapshot. response_type required Schema string string job_file_system_snapshot_response Snapshot file system created. Polymorphism : Inheritance Discriminator : response_type Name id optional Description The id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 584
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 9000T | EMC PowerStore REST API Developers Guide - Page 585
Name root optional Description Schema This is the embeddable reference form of root_id attribute. job_instance root_id optional Unique identifier of the root job, if applicable. The root job string is the job at the top of the parent hierarchy. start_time optional Date and time when the job - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 586
Discriminator : response_type Name Description Schema A Uniform Resource Identifier which can be used in a download_uri subsequent GET request to download the keystore backup string optional archive file. response_type required string job_migration_recommendation_create_migration_ses - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 587
Name Description response_type required Schema string job_response Job response for an asynchronous request. The response to any asynchronous request that does not fail immediately. Name id optional Description The id of the job created by the request. Schema string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 588
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 string string job_volume_group_refresh_response volume group - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 589
job_volume_group_snapshot_response Unique identifier of the new snapshot volume. Polymorphism : Inheritance Discriminator : response_type Name id optional Schema string response_type required string job_volume_refresh_response Unique identifier of the backup snapshot if one is created. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 590
job_volume_snapshot_response Unique identifier of the new snapshot volume. Polymorphism : Inheritance Discriminator : response_type Name id optional Schema string response_type required string job_vvol_error_response Polymorphism : Inheritance Discriminator : response_type Name description - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 591
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. license_instance Software license information for the cluster. Name Description Schema activation_file The content - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 592
Name role_id required Description Schema The unique identifier of the role to which the new local user will be mapped. Where role_id "1" is for Administrator, "2" is for Storage Administrator, "3" is for string Operator, "4" is for VM Administrator and "5" is for Security Administrator roles. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 593
Name password optional role_id optional Description Schema New password of the local user. Local user with administrator or security administrator role can reset the password of other local user accounts without providing string (password) the current password. You cannot reset the password of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 594
Name id optional Description Unique identifier of the login session. Schema string idle_timeout optional Remaining idle time until the session will expire, in seconds. Minimum value : 0 integer (int32) Maximum value : 2147483647 is_built_in_us er optional Indicates whether the logged-in - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 595
maintenance_window_modify Name end_offset optional Description Schema Number of seconds from the current timestamp the maintenance window will expire. This value is required if is_enabled is passed as true, and may not be more than integer (int32) 172800 (48 hours). Minimum value : 0 Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 596
Name Description signature_alg orithm optional Certificate signature algorithm. Schema string subject optional Certificate subject or so called distinguished name. string subject_altern ative_names optional Additional DNS x509_certificate. names or IP addresses in the < string > array - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 597
metrics_generate_response Response will be just an array of one of the child of this definition Name entity required Description entity_l10n optional Localized message string corresponding to entity Schema MetricsEntityEnum string migration_recommendation_action A recommended migration action. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 598
the source for this migration action. required string migration_recommendation_create Set evacuate_appliance parameters to evacuate space Filtering on the fields of this embedded resource is not supported. 532 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 599
Name Description evacuate_appl iance Evacuate appliance by specifying optional space_to_free required Schema evacuate_appliance evacuate_appliance Name appliance_id required Description ID of appliance on which available space is desired. Example : "evac_from_appliance" Schema string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 600
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 9000T | EMC PowerStore REST API Developers Guide - Page 601
automatic_cut over optional or automatic. Default for virtual_volume resource type migrations is automatic, otherwise the default is manual. Default : false boolean destination_a ppliance_id required Unique identifier of the destination appliance instance. string family_id required Family - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 602
Name id optional Description Identifier of the migration_session object. Schema string rescan_host_i ds optional List of hosts that be rescanned before a migration session < string > array can proceed. migration_session_delete Name force optional Description Schema Indicates whether all - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 603
. 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 9000T | EMC PowerStore REST API Developers Guide - Page 604
< 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 9000T | EMC PowerStore REST API Developers Guide - Page 605
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 9000T | EMC PowerStore REST API Developers Guide - Page 606
Name Description Schema Indicates whether to keep the associated SMB servers joined to the Active Directory when the NAS server is is_skip_domai n_unjoin optional deleted. Values are:\n - true - Keep the associated SMB servers joined to the Active Directory when the NAS server is deleted. - - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 607
Name Description current_unix_ directory_ser Localized message string vice_l10n current_unix_directory_service optional corresponding Schema to string default_unix_ Default Unix user name used for granting access in case of user Windows to Unix user mapping failure. When empty, string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 608
), 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 insensitive filtering server. This property supports case- string nfs_servers optional < This is the inverse - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 609
Name Description Schema production_IP v6_interface_i Unique identifier d interface. of the preferred IPv6 production string optional smb_servers optional < This is the inverse of the resource type smb_server smb_server_instance association. > array nas_server_modify Arguments for the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 610
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 9000T | EMC PowerStore REST API Developers Guide - Page 611
network_instance This resource type has queriable association from ip_pool_address Name gateway optional Description Schema Network gateway in IPv4 the network's IP version. or IPv6 format, corresponding to string (ip-address) id optional Unique identifier of the network. string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 612
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 9000T | EMC PowerStore REST API Developers Guide - Page 613
Name Description prefix_length optional Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 Maximum value : 127 Schema integer (int32) remove_addre sses IP addresses to remove in IPv4 or IPv6 format. optional < string (ip-address) > array storage_disco very_address - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 614
Name esxi_credenti als optional Description Schema esxi_credentials force optional Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints. Normally the command will fail with an error when: - some of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 615
optional VASA vendor provider user name. Schema string (password) string network_replace_physical_switch Name Description connections optional Supported connections for a physical switch. name optional Name of a physical switch. Schema < network_replace_ph ysical_switch_conne ction > array - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 616
Name purpose optional Description Schema PhysicalSwitchPurp oseEnum network_replace_physical_switch_connection Name address required Description Schema Physical format. switch address in IPv4 or IPv6 or DNS hostname string (ip-address) connect_meth od required PhysicalSwitchConn - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 617
network_scale Name add_port_ids optional Description Schema Unique identifiers network. of available IP ports to be used in the < string > array force optional Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 618
Name Description default_access optional Schema NFSExportDefaultAc cessEnum description optional User defined NFS Export description. Length : 0 - 511 string file_system_id required Unique identifier of the Export will be created. file system on which the NFS string is_no_SUID optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 619
Name Description Schema Hosts with read-only and ready-only for root user access to read_only_roo the NFS Export and its snapshots. Hosts can be entered by t_hosts Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, < string > array optional IPv6/PrefixLenght, or IPv4/subnetmask), or - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 620
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 9000T | EMC PowerStore REST API Developers Guide - Page 621
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 9000T | EMC PowerStore REST API Developers Guide - Page 622
Name Description Schema Hosts to add to the current read_write_hosts list. Hosts can add_read_writ be entered by Hostname, IP addresses (IPv4, IPv6, e_hosts IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), < string > array optional or Netgroups prefixed with @. Error if Host is - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 623
Name Description Schema Hosts with read-only and ready-only for root user access to read_only_roo the NFS Export and its snapshots. Hosts can be entered by t_hosts Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, < string > array optional IPv6/PrefixLenght, or IPv4/subnetmask), - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 624
more than 16 Unix 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 performance. Default : false 558 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 625
Name Description Schema Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3. is_nfsv3_enabl When disabled, NFS shares can not be accessed with NFSv3 ed protocol. - true - NFSv3 is enabled on the specified NAS boolean optional server. - - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 626
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 performance. Default : false is_joined optional Indicates - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 627
nas_server_instance attribute. 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 628
16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. Note - The NFS server builds its own Unix credential when it supports more than 16 groups. This process can slow performance. Indicates whether NFSv3 is enabled on the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 629
Name Description Schema is_secure_ena Indicates whether secure NFS is enabled on the NFS server. bled - true - Secure NFS is Enabled. - false - Secure NFS is boolean optional disabled. Allow to bypass NFS server unjoin. If false modification will is_skip_unjoin fail if secure is enabled and - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 630
Name id optional Description Unique identifier of the node. Schema string ip_pool_addre < This is the inverse of the resource type ip_pool_address sses ip_pool_address_inst association. optional ance > array slot optional Slot number of the node. Minimum value : 0 Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 631
string corresponding to entity string io_workload_c The percentage of CPU Utilization on the cores dedicated to pu_utilization number (float) servicing storage I/O requests. optional read_bandwid th Read rate in bytes per second. optional number (float) read_iops optional Total read - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 632
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 9000T | EMC PowerStore REST API Developers Guide - Page 633
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 9000T | EMC PowerStore REST API Developers Guide - Page 634
in bytes. optional number (float) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz ation dedicated to servicing storage I/O requests. Calculated over time interval across appliance. Derived from an average of number (float) optional utilization across all - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 635
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) performance_metrics_by_cluster Performance metrics for the cluster collected at twenty - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 636
Name Description read_bandwid th Read rate in bytes per second. optional read_iops optional Total number of 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. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 637
Name Description avg_read_ban dwidth Weighted average read bandwidth in bytes per second. optional Schema number (float) avg_read_iops Average reads per second. optional number (float) avg_read_late ncy Weighted average read latency in microseconds. optional number (float) - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 638
Name entity_l10n optional Description Localized message string corresponding to entity Schema string 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 9000T | EMC PowerStore REST API Developers Guide - Page 639
Name Description max_write_ba ndwidth Maximum write bandwidth in bytes per second. optional 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 640
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 9000T | EMC PowerStore REST API Developers Guide - Page 641
Name Description Schema avg_pkt_rx_cr c_error_ps optional The average number of packets (and thus dropped) per second. received with CRC error number (float) avg_pkt_rx_no _buffer_error_ The average number of packets discarded per second due number (float) ps to lack of buffer space. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 642
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 9000T | EMC PowerStore REST API Developers Guide - Page 643
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. node_id optional Reference to the node the port belongs to. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 644
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 9000T | EMC PowerStore REST API Developers Guide - Page 645
Name Description max_bytes_tx_ ps The maximum total bytes transmitted per second. optional Schema number (float) max_pkt_rx_c The maximum number of packets received with CRC error rc_error_ps number (float) (and thus dropped) per second. optional max_pkt_rx_n o_buffer_erro r_ps The - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 646
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. optional avg_read_size Average read size in bytes. optional avg_write_late - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 647
Name Description link_failure_c ount_ps Link failure count per second. optional Schema number (float) loss_of_signal _count_ps Loss of signal count per second. optional number (float) loss_of_sync_c ount_ps Loss of sync count per second. optional number (float) node_id optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 648
Name Description 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 second. optional unaligned_wri te_bandwidth Unaligned write rate in bytes per - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 649
Name Description avg_invalid_cr c_count_ps Average invalid crc count per second. optional Schema number (float) avg_invalid_tx _word_count_ Average invalid transmission word count per second. ps optional number (float) avg_io_size optional Average size of read and write operations in bytes. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 650
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 optional Average total input and output operations per second. number - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 651
Name Description avg_write_late ncy Weighted average write latency in microseconds. optional Schema number (float) avg_write_size Weighted average write size in bytes. optional number (float) entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 652
Name Description max_invalid_c rc_count_ps The maximum invalid crc count per second. optional Schema number (float) max_invalid_t x_word_count The maximum invalid transmission word count per second. number (float) _ps optional max_link_fail ure_count_ps optional The maximum link failure count - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 653
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 9000T | EMC PowerStore REST API Developers Guide - Page 654
performance_metrics_by_fe_fc_port Performance metrics for the frontend fibre channel port collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 655
Name fe_port_id optional Description Schema Reference to the associated frontend fibre channel (fc_port) on which these metrics were recorded. port string invalid_crc_co unt_ps Invalid crc count per second. optional number (float) invalid_tx_wo rd_count_ps Invalid transmission word count - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 656
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 9000T | EMC PowerStore REST API Developers Guide - Page 657
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 9000T | EMC PowerStore REST API Developers Guide - Page 658
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 Weighted average read size in bytes. optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 659
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 9000T | EMC PowerStore REST API Developers Guide - Page 660
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 9000T | EMC PowerStore REST API Developers Guide - Page 661
Name max_read_ba ndwidth optional Description 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 9000T | EMC PowerStore REST API Developers Guide - Page 662
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 9000T | EMC PowerStore REST API Developers Guide - Page 663
Name Description avg_write_size optional Average write size in bytes. Schema number (float) entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string file_system_id optional Unique identifier of the file system. string read_bandwid - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 664
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. Polymorphism : Inheritance Discriminator : entity Name avg_latency optional Description Schema Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 665
Name Description avg_write_late ncy Maximum of average write latency in microseconds. optional Schema number (float) avg_write_size Average write size in bytes. optional number (float) entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 666
Name max_read_ba ndwidth optional Description Maximum read rate in bytes per second. Schema number (float) max_read_iop s Maximum read operations per second. optional number (float) max_total_ba ndwidth optional Maximum data transfer rate in bytes per second. number (float) max_write_ba - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 667
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 Average write size - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 668
performance_metrics_by_nfs_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional Description Average read and write size in - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 669
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 9000T | EMC PowerStore REST API Developers Guide - Page 670
Name timestamp optional Description Time at the beginning of sample period. Schema string (date-time) performance_metrics_by_nfsv3 Performance metrics for the nfs collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description avg_md_laten cy Average - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 671
Name total_iops optional write_iops optional Description Total read and write iops in microseconds. Total write iops in microseconds. Schema number (float) number (float) performance_metrics_by_nfsv3_rollup Summary of nfs level performance metric data for the period beginning with timestamp, - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 672
Name Description max_avg_md_ latency Maximum average md latency per second. optional Schema number (float) max_failed_m d_ops Max failed operations per second. optional number (float) max_read_iop s Maximum read operations per second. optional number (float) max_total_iop s - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 673
Name entity required Description Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string failed_md_ops optional Total failed md operations per second. number (float) md_ops optional Total md operations per second. number (float) node_id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 674
Name Description avg_failed_md _ops Average failed operations per second. optional avg_md_laten cy Average md latency per second. optional avg_md_ops optional Average md operations per second. avg_read_iops Average read operations per second. optional avg_total_iops Average read and - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 675
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 9000T | EMC PowerStore REST API Developers Guide - Page 676
corresponding to entity string io_workload_c The percentage of CPU Utilization on the cores dedicated to pu_utilization 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 per - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 677
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 9000T | EMC PowerStore REST API Developers Guide - Page 678
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 9000T | EMC PowerStore REST API Developers Guide - Page 679
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 9000T | EMC PowerStore REST API Developers Guide - Page 680
value : 9223372036854775807 integer (int64) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz ation dedicated to servicing storage I/O requests. Calculated over time across appliance. Derived from an average of number (float) optional utilization across all - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 681
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 9000T | EMC PowerStore REST API Developers Guide - Page 682
performance_metrics_by_smb_cache Performance metrics for the smb cache collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name entity required Description Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 683
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 9000T | EMC PowerStore REST API Developers Guide - Page 684
Name Description hash_max_avg _size Average max hash size. optional 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 685
performance_metrics_by_smb_client Performance metrics for the smb client collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional Average read and - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 686
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 9000T | EMC PowerStore REST API Developers Guide - Page 687
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 MetricsEntityEnum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 688
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 9000T | EMC PowerStore REST API Developers Guide - Page 689
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 MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 690
Name avg_calls optional Description Average calls. Schema number (float) avg_io_size optional Average read and write size in bytes. number (float) avg_iops optional Average read and write operations per second. number (float) avg_latency optional Maximum read and write latency in - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 691
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 9000T | EMC PowerStore REST API Developers Guide - Page 692
performance_metrics_by_smb_v1_builtin_client Performance metrics for the smb v1 client collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 693
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 9000T | EMC PowerStore REST API Developers Guide - Page 694
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 MetricsEntityEnum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 695
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 9000T | EMC PowerStore REST API Developers Guide - Page 696
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 MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 697
Name avg_calls optional Description Average calls. Schema number (float) avg_io_size optional Average read and write size in bytes. number (float) avg_iops optional Average read and write operations per second. number (float) avg_latency optional Maximum read and write latency in - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 698
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 9000T | EMC PowerStore REST API Developers Guide - Page 699
performance_metrics_by_smb_v2_builtin_client Performance metrics for the smb v1 client collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional Description Average read and write size in bytes. Schema number (float) avg_latency optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 700
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 9000T | EMC PowerStore REST API Developers Guide - Page 701
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 MetricsEntityEnum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 702
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 9000T | EMC PowerStore REST API Developers Guide - Page 703
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 MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 704
Name avg_calls optional Description Average calls. Schema number (float) avg_io_size optional Average read and write size in bytes. number (float) avg_iops optional Average read and write operations per second. number (float) avg_latency optional Maximum read and write latency in - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 705
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 9000T | EMC PowerStore REST API Developers Guide - Page 706
performance_metrics_by_vg Performance metrics for the volumes in a volume group collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional Description Average size of read and write operations in bytes. Schema number (float) avg_latency - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 707
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. vg_id optional Unique identifier representing a volume group. write_bandwi dth Write rate in - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 708
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 MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 709
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. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional Description Average - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 710
Name Description avg_write_late ncy Weighted average write latency in microseconds. optional Schema number (float) avg_write_size Weighted average write size in bytes. optional number (float) entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 711
Name max_total_ba ndwidth optional Description Maximum total bandwidth in bytes per second. Schema number (float) max_total_iop s Maximum totals per second. optional number max_write_ba ndwidth Maximum write bandwidth in bytes per second. optional number (float) max_write_io ps optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 712
Name Description 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 Average write size in bytes. optional entity required entity_l10n - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 713
Name Description write_bandwi dth Write rate in byte/sec. optional write_iops optional Total write operations per second. Schema number (float) number (float) performance_metrics_by_volume_rollup Summary of volume level performance metric data for various rollup intervals beginning with - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 714
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 9000T | EMC PowerStore REST API Developers Guide - Page 715
(float) number (float) number (float) number number (float) number (float) integer (int32) string (date-time) string performance_rule_instance Quality of service rule in a performance policy for policy based management of storage resources. This resource type has queriable association from policy - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 716
n Localized message string corresponding to io_priority optional string name optional Name of the performance rule. This property supports string case-insensitive filtering policies optional List of the policies that are associated with this < policy_instance > performance_rule - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 717
physical_switch_connection_instance This resource type has queriable association from physical_switch Name address optional Description Schema Physical switch address in IPv4 or IPv6 or DNS hostname format. string (ip-address) Length : 1 - 255 connect_meth od optional PhysicalSwitchConn - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 718
Username to connect a physical switch for SSH connection method. string Maximal length : 128 physical_switch_create Name Description connections required Supported connections for a physical switch. name required purpose required Name of a physical switch. Length : 1 - 128 Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 719
of the physical switch setting. Length : 1 - 32 Schema 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 9000T | EMC PowerStore REST API Developers Guide - Page 720
of this boolean type is restricted from many operations. Default : false name optional Policy name. filtering This property supports case-insensitive string performance_ < List of the performance_rules that are associated with this rules performance_rule_i policy. optional nstance - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 721
Name type_l10n optional Description Localized message string corresponding to type Schema string virtual_machi < This is the inverse of the resource type virtual_machine nes virtual_machine_ins association. optional tance > array volume_group s optional This is the association. inverse - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 722
. optional 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 created_by_ru le_id optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 723
which the resource resource identified by source_id. was sourced from the string (date-time) 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 724
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 9000T | EMC PowerStore REST API Developers Guide - Page 725
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 9000T | EMC PowerStore REST API Developers Guide - Page 726
User-specified name of the remote system instance. This property supports case-insensitive filtering string replication_se < This is the inverse session_chap_ mode Session chap mode for the non-PowerStore remote system. optional RemoteSystemChap ModeEnum session_chap_ mode_l10n optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 727
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 must string contain 128 or fewer printable Unicode characters. Maximal length : 128 remote_passw ord optional Password - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 728
Name Description Schema replication_sh adow_id optional Unique identifier of the internal snap used for replicating data. string storage_eleme nt_type Storage element type. optional StorageElementType Enum replication_rule_create Replication rule create request. Name Description Schema - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 729
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 9000T | EMC PowerStore REST API Developers Guide - Page 730
Name Description Schema Acceptable delay in minutes between the expected and alert_threshol d optional actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold. Minimum value : 0 integer (int32) Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 731
Name Description Schema estimated_co mpletion_tim estamp optional Estimated operation. completion time of the current replication string (date-time) id optional Unique identifier of the replication session instance. string last_sync_time stamp Time of last successful synchronization. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 732
volume replication session, there will be only one storage element pair. Filtering on the fields of this embedded resource is not supported. role_instance Name description optional Description Description of the role. id optional Unique identifier of the role. Schema string string 666 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 733
link is up. Values are: true Link is up. false Link is down. boolean name optional Name of the SAS port. This property supports case- string insensitive filtering node optional This is the embeddable reference form of node_id attribute. hardware_instance node_id optional Unique identifier of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 734
Name partner optional Description Schema This is the attribute. embeddable reference form of partner_id sas_port_instance partner_id optional Unique identifier of the SAS partner port. string port_index optional Index of the SAS port in IO module. Minimum value : 0 Maximum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 735
Name expiration optional Description Schema Length of time to keep snapshots before deleting them, in minutes. Minimum value : 0 integer (int32) Maximum value : 2147483647 frequency optional Frequency at which the snapshot will be taken. ScScheduleTypeEnu m frequency_l10 n Localized - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 736
appliance_id optional Description Unique identifier of the appliance. Schema string id optional Unique identifier for the service configuration instance. string The current ssh service access state. is_ssh_enable d optional true SSH access is enabled false SSH access is disabled boolean - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 737
-in or not. boolean is_default_pas sword Whether the user account has the default password or not. optional boolean name optional Name of the service user account. Always 'service' in this string release. service_user_modify Name password required Description Schema New password for the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 738
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 9000T | EMC PowerStore REST API Developers Guide - Page 739
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 9000T | EMC PowerStore REST API Developers Guide - Page 740
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/) description optional Description of the SMB server. string domain optional Domain name where SMB - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 741
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 9000T | EMC PowerStore REST API Developers Guide - Page 742
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 9000T | EMC PowerStore REST API Developers Guide - Page 743
Name workgroup optional Description Schema Applies to standalone SMB servers only. Windows network workgroup for the SMB server. Workgroup limited to 15 alphanumeric ASCII characters. names are string Length : 1 - 15 smb_server_unjoin Argument to ujoin the SMB server from an Active - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 744
Name Description Schema is_branch_cac he_enabled optional Indicates whether BranchCace optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content client computers at at branch office branch offices - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 745
. Values are: - enabled boolean true - Encryption for SMB 3.0 is enabled. - false - Encryption optional for SMB 3.0 is disabled. name optional SMB share filtering name. This property supports case-insensitive string 679 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 746
Name Description offline_availa bility optional Schema SMBShareOfflineAv ailabilityEnum offline_availa Localized message bility_l10n offline_availability optional string corresponding to string path optional Local path to the file system or any existing sub-folder of the file system that is - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 747
Name Description Schema is_continuous _availability_e nabled optional Indicates whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share. Values are: - true - Continuous availability for SMB 3.0 is enabled for the SMB Share. - false - Continuous - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 748
Name port optional Description Port used for sending SMTP messages. Minimum value : 0 Maximum value : 65535 source_email Source email address used for sending SMTP messages. optional Schema integer (int32) string smtp_config_test Name Description email_address Destination email address for - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 749
replication session replicating a resource to the local system. boolean Default : false name optional Snapshot rule name. This property supports casestring insensitive filtering policies optional List of the policies that are associated with this < policy_instance > snapshot_rule. array 683 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 750
Name time_of_day optional Description Schema Time of the day to take a daily snapshot, with format "hh:mm" in 24 hour time format. Either the interval parameter or the time_of_day parameter will be set, but not string (timestamp) both. snapshot_rule_modify Snapshot rule modify request. Name - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 751
(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 9000T | EMC PowerStore REST API Developers Guide - Page 752
of why for this cluster. this software release is recommended string name optional Name of the software package. This property supports casestring insensitive filtering release_timest amp Date and time when this software package was produced. optional string (date-time) release_versio - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 753
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string data_physical _used optional This metric represents amount of physical space user data occupies after deduplication and compression. Minimum value : 0 integer ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 754
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. Polymorphism : Inheritance Discriminator : entity 688 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 755
Name appliance_id optional Description Schema Reference to the associated metrics were recorded. appliance on which these string entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string last_data_phy Last physical used space for data - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 756
Name Description last_thin_savi ngs Last thin savings ratio during the period. optional Schema number (float) max_data_phy Maximum physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_data_red - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 757
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) space_metrics_by_cluster Space metrics for the cluster collected at five minute - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 758
Name Description Schema logical_provis ioned optional Total configured size of all storage ojects within the cluster. This metric includes all primaries, snaps and clones. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 logical_used optional Amount of data in bytes - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 759
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 : entity Name cluster_id optional Description Identifier of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 760
Name Description last_logical_pr Last logical total 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 9000T | EMC PowerStore REST API Developers Guide - Page 761
Name Description max_logical_u Maximum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 max_physical Maximum physical total space during the period. _total Minimum value : 0 optional Maximum value : 9223372036854775807 max_physical - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 762
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 : entity 696 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 763
Name entity required Description entity_l10n optional Localized message string corresponding to entity last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 last_logical_us Last logical used space during - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 764
space_metrics_by_vg Space metrics for a volume group collected at a five minute interval. Polymorphism : Inheritance Discriminator : entity Name entity required Description Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string logical_provis - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 765
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 9000T | EMC PowerStore REST API Developers Guide - Page 766
Name Description last_thin_savi ngs Last thin savings ratio during the period. optional Schema number (float) max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 767
Name entity required Description Schema MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string logical_provis ioned optional Total configured size in bytes of all virtual volumes used by virtual machine. Minimum value : 0 integer (int64) Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 768
Name Description Schema Amount of physical space virtual machine used after unique_physic compression and deduplication. This is the space to be al_used freed up if a virtual machine is removed. integer (int64) optional Minimum value : 0 Maximum value : 9223372036854775807 vm_id optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 769
Name Description last_unique_p Last unique physical used space during the period. hysical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 770
Discriminator : entity Name appliance_id optional Description Schema Reference to the associated appliance on which these string metrics were recorded. entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string Configured size in bytes of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 771
Discriminator : entity Name appliance_id optional Description Schema Reference to the associated appliance on which these string metrics were recorded. entity required MetricsEntityEnum entity_l10n optional Localized message string corresponding to entity string family_id optional ID of - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 772
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 9000T | EMC PowerStore REST API Developers Guide - Page 773
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 9000T | EMC PowerStore REST API Developers Guide - Page 774
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) space_metrics_by_volume_rollup Summary of volume level space metric data for one hour - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 775
Name Description max_logical_u Max logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 max_thin_savi ngs Max thin savings ratio during the period. optional repeat_count optional Number of times the metrics are repeated. Minimum value : - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 776
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 9000T | EMC PowerStore REST API Developers Guide - Page 777
Name quota optional Description Schema The number of bytes that can be provisioned against this storage container. It cannot be set lower than the current used space or 10Gb. A value of 0 means unlimited. integer (int64) Minimum value : 0 Maximum value : 4611686018427387904 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 778
Name port_name optional Description Initiator name Schema string vcenter_create Name address optional Description Schema IP address format. of vCenter host, in IPv4, IPv6, or hostname string (ip-address) password optional Password to login to vCenter. string (password) username - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 779
Name password optional username optional Description Password to login to vCenter. Schema string (password) User name to login to vCenter. Password needs to be string provided to modify the user name. veth_port_instance This resource type has queriable associations from ip_port, appliance, node - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 780
integer (int32) 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 policy - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 781
VM snapshots. is_consistent Indicates whether the VM snapshot is crash-consistent. optional boolean is_consistent_ snaps_support Indicates whether the VM supports creating crash- boolean ed consistent snapshots. Not applicable to snapshot VMs. optional memory_mb optional Memory size of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 782
Name status_l10n optional Description Localized message string corresponding to status type optional type_l10n optional Localized message string corresponding to type vcenter_insta nce_uuid optional UUID instance of the vCenter that hosts the VM. Schema string VirtualMachineType Enum string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 783
virtual_volume_delete Parameters for virtual volume delete. Name force optional Description Schema Normally, attempting to delete a bound virtual volume is not permitted. This option overrides that error and allows boolean the delete to continue. virtual_volume_instance A virtual volume. This - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 784
activity, the string name optional The name of the virtual volume, based on metadata provided by vSphere. This property supports case- string insensitive filtering parent optional This is the embeddable reference form of parent_id virtual_volume_inst attribute. ance parent_id optional - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 785
Name size optional Description The size of the virtual volume in bytes. Minimum value : 0 Maximum value : 9223372036854775807 Schema integer (int64) source optional This is the embeddable reference form of source_id virtual_volume_inst attribute. ance source_id optional Id of the virtual - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 786
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 le_id optional Unique identifier of the protection rule that created the VM snapshot. string created_by_ru - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 787
Name host_id optional Description Schema Unique identifier of the host to be attached to the volume. Only one of host_id or host_group_id can be supplied. string logical_unit_n Logical unit number for the host volume access. umber Minimum value : 0 optional Maximum value : 16383 integer ( - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 788
Name id optional Schema string volume_create Name appliance_id optional Description Schema Identifier of provisioned. the appliance on which the volume is string description optional Description of the volume. This value must contain 128 or fewer printable Unicode characters. string - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 789
Name sector_size optional Description Schema 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 is 1MB. Maximum - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 790
Name description optional Description Schema Description for the clone volume group. If description is not specified, the description for the snapshot set will not be string set. is_replication _destination optional A boolean flag to indicate whether the clone volume group is a destination of a - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 791
Name name required Description Schema Unique name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case of the name provided is reserved, uniqueness check is case-insensitive, so the same string name in two different cases is - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 792
• Whether group. a protection_policy can be applied to the boolean • Whether manual snapshots can be taken. • Whether clones of the group can be created. appliance. Filtering on the fields of this location_history_inst optional embedded resource is not supported. ance > array 726 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 793
when it is part of a migration activity. optional name optional 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 This is the embeddable - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 794
Name description optional Description Schema New description for the volume group. The description should not have any unprintable characters. If an string is specified, the description will be cleared. empty string Maximal length : 256 force optional Normally a replication destination - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 795
Name Description Schema protection_po licy_id optional Unique identifier of the protection policy to assign to a primary or clone volume group. If specified, protection policy will be an empty string is removed from the string volume group. volume_group_refresh Refresh volume group request. - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 796
volume_group_restore Restore volume group request. Name Description backup_snap_ profile optional Schema volume_group_snap shot create_backu p_snap optional This parameter specifies whether a backup snapshot set of the target volume group needs to be created before attempting restore. This - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 797
Name id optional Schema string volume_instance Details about a volume, including snapshots and clones of volumes. This resource type has queriable associations from appliance, policy, migration_session, host_volume_mapping, volume_group Name appliance optional Description Schema This is the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 798
name optional Name of the volume. This value must contain 128 or fewer printable Unicode characters. insensitive filtering This property supports case- string Maximal length : 128 node_affinity Node affinity. Node which offers optimized IO for volume, NodeAffinityEnum optional values are - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 799
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 9000T | EMC PowerStore REST API Developers Guide - Page 800
defaults to false, if not specified. Default : false 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 801
Name Description backup_snap_ profile Profile for the backup snapshot. optional Schema volume_snapshot create_backu p_snap optional Indicates whether to create a backup snapshot of the volume before refreshing. boolean Default : false from_object_i d required Unique identifier of the - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 802
. string Maximal length : 128 expiration_ti mestamp optional 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 - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 803
Name description optional Description error_code optional Minimum value : 0 Maximum value : 2147483647 Schema string integer (int32) wear_metrics_by_drive_instance Wear metrics for the drives collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name drive_id - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 804
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 Name id optional Description Unique - Dell PowerStore 9000T | EMC PowerStore REST API Developers Guide - Page 805
the fields of this embedded resource is not supported. < member_certificate_ instance > array service optional X509CertificateServi ceEnum service_l10n optional Localized message string corresponding to service string type optional X509CertificateUsag eTypeEnum type_l10n optional Localized
Dell EMC PowerStore
REST API Developers Guide