Dell EMC PowerStore REST API Reference Guide © 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. December 2020 Rev.
Table of Contents Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 GET /alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POST /email_notify_destination/{id}/test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 eth_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 GET /eth_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 GET /eth_port/{id} . . . . . . . .
PATCH /file_kerberos/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 POST /file_kerberos/{id}/upload_keytab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 GET /file_kerberos/{id}/download_keytab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 file_ldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PATCH /file_tree_quota/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 POST /file_tree_quota/{id}/refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 file_user_quota . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 GET /file_user_quota . . . . . . . . . . . . .
GET /host_volume_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 GET /host_volume_mapping/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 import_host_initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 GET /import_host_initiator . . . . . . . . . . . . . . . .
GET /import_storage_center_consistency_group/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 POST /import_storage_center_consistency_group/{id}/import_snapshot_profiles . . . . . . . . . . . . 98 import_storage_center_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 GET /import_storage_center_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET /ip_pool_address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 GET /ip_pool_address/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 ip_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 GET /ip_port . . . . . . . . . .
GET /maintenance_window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 GET /maintenance_window/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 PATCH /maintenance_window/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET /nas_server/{id}/download/ntxmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 POST /nas_server/{id}/update_user_mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 GET /nas_server/{id}/download/user_mapping_report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POST /policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 GET /policy/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 DELETE /policy/{id}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 PATCH /policy/{id} . . . . . .
PATCH /service_user/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 smb_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 GET /smb_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 POST /smb_server . . . . . . . . .
PATCH /storage_container/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 POST /storage_container/{id}/mount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 POST /storage_container/{id}/unmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 vcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POST /volume_group/{id}/remove_members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 POST /volume_group/{id}/snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 POST /volume_group/{id}/clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 POST /volume_group/{id}/restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HardwareDriveEncryptionStatusEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 HardwareDriveFIPSStatusEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 HardwareDriveTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 HardwareLifecycleStateEnum . . . . . . . . . . . . . . . . . . . . . . . . .
MigrationStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 MonthOfYearEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 NASServerCurrentUnixDirectoryServiceEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 NASServerOperationalStatusEnum. . . . . . . . . . . . . . . .
UnityVolumeTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 VGPlacementRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 VirtualMachineStatusEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298 VirtualMachineTypeEnum . . . . . . . . . . . .
base_performance_metrics_by_cluster_rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325 base_performance_metrics_by_fe_eth_node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328 base_performance_metrics_by_fe_eth_node_rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 base_performance_metrics_by_fe_eth_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
base_space_metrics_by_cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 base_space_metrics_by_cluster_rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403 base_space_metrics_by_storage_container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406 base_space_metrics_by_storage_container_rollup . . . . . . . . . . . . . . .
eth_port_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435 eth_port_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 event_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438 fc_port_instance . .
file_user_quota_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 file_user_quota_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 file_user_quota_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487 file_virus_checker_create . . . . . . .
import_storage_center_volume_import_snapshot_profiles_response . . . . . . . . . . . . . . . . . . . . . . . . 516 import_storage_center_volume_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 import_unity_consistency_group_import_snapshot_schedules_response. . . . . . . . . . . . . . . . . . . . . 518 import_unity_consistency_group_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
job_volume_group_refresh_response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 job_volume_group_restore_response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 job_volume_group_snapshot_response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550 job_volume_refresh_response . . . . . . . . . . . . . . . . . . . . . . . . . . . .
network_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579 network_replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581 network_replace_physical_switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
performance_metrics_nfsv3_by_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652 performance_metrics_nfsv3_by_node_rollup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653 performance_metrics_nfsv4_by_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655 performance_metrics_nfsv4_by_node_rollup. . . . . . . . . . . . . . . . . . . . . . . . . .
sas_port_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699 sc_profile_rule_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700 security_config_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701 service_config_instance . . . . .
storage_container_delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740 storage_container_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740 storage_container_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741 storage_container_mount . . . . . . . . . . .
volume_snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767 volume_snapshot_response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767 vvol_error_response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767 wear_metrics_by_drive_instance . . . .
Resources alert Use these resource types to manage events and alerts in the system. GET /alert Description Query all alerts. Responses HTTP Code Description 200 Success 206 Partial content of alert instance objects Schema < alert_instance > array < alert_instance > array GET /alert/{id} Description Query a specific alert. Parameters Type Name id Path required Description Schema Unique identifier of the alert.
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 Name id Path required Description Schema Unique identifier of the specific alert.
Responses HTTP Code Description Schema < 200 appliance_instanc Success e > array < 206 Partial content of appliance instance objects appliance_instanc e > array GET /appliance/{id} Description Query a specific appliance in a cluster. Parameters Type Name id Path required Description Schema Unique identifier of the appliance.
Parameters Type Name id Path required Description Schema Unique identifier of the appliance. string body Body appliance_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Argument error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /appliance/{id}/forecast Description Forecast capacity usage for an appliance.
Responses HTTP Code Description Schema < 200 appliance_forecast Success _response > array 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /appliance/{id}/time_to_full Description Returns information about when an appliance is forecast to reach 100% capacity usage. Parameters Type Name id Path required Body Description Schema Unique id of the appliance.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json audit_event Use this resource type to query audit log information. GET /audit_event Description Query audit log entries.
Description Query bond configurations. Responses HTTP Code Description 200 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 Name id Path required Description Schema Unique identifier of the bond configuration.
set here. For mutual mode, each initiator also has a CHAP username and password set. Changing the cluster CHAP mode disrupts all iSCSI connections, and will disable connections that are not completely and correctly configured. For example, an initiator without a valid CHAP username and password will lose connectivity to the target if mutual model is enable here. Both the settings here, and the settings on the initiators can be modified while CHAP mode is in disabled mode.
PATCH /chap_config/{id} Description Modify the CHAP configuration settings object. To enable either Single or Mutual CHAP modes, the username and password must already be set, or included in the same request as the new mode. Parameters Type Path Name Description id The id of the CHAP configuration object (always required "0").
HTTP Code Description 200 Success 206 Partial content of cluster instance objects Schema < cluster_instance > 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 Name id Path required Description Schema ID of the cluster.
Type Name id Path required Description Schema Unique identifier of the cluster. string body Body cluster_modify optional Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /cluster/{id}/forecast Description Forecast capacity usage for the cluster.
HTTP Code Description Schema < 200 Success cluster_forecast_r esponse > array 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /cluster/{id}/time_to_full Description Returns information about when the cluster is forecast to reach 100% capacity usage.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response Produces • application/json discovered_initiator List initiators currently connected to the cluster that are not associated with an initiator group or host. GET /discovered_initiator Description Returns connected initiators that are not associated with a host.
GET /dns Description Query DNS settings for a cluster. Responses HTTP Code Description 200 Success 206 Partial content of dns instance objects Schema < dns_instance > array < dns_instance > array GET /dns/{id} Description Query a specific DNS setting. Parameters Type Name id Path required Description Schema Unique identifier of the DNS setting.
PATCH /dns/{id} Description Modify a DNS setting. Parameters Type Name id Path required Description Schema Unique identifier of the DNS setting.
Responses HTTP Code Description Schema < 200 email_notify_desti Success nation_instance > array < 206 Partial content of email notify destination instance objects email_notify_desti nation_instance > array POST /email_notify_destination Description Add an email address to receive notifications. Parameters Type Name body Body required Description Schema Email address to receive notifications.
Type Path Name Description id Unique identifier of the email notification required destination. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema email_notify_desti nation_instance error_response DELETE /email_notify_destination/{id} Description Delete an email notification destination. Parameters Type Path Name Description id Unique identifier of the email notification required destination.
Parameters Type Path Name Description id Unique identifier of the email notification required destination. body Body required Schema Email address to receive notifications. string email_notify_destina tion_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /email_notify_destination/{id}/test Description Send a test email to an email address.
HTTP Code Description Schema 422 Operation Failed 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.
HTTP Code Description Schema 404 Not Found error_response PATCH /eth_port/{id} Description Change the properties of the front-end port. Note that setting the port’s requested speed may not cause the port speed to change immediately. In cases where the SFP is not inserted or the port is down the requested speed will be set but the current_speed will still show the old value until the SFP is able to change speed.
Description Returns all events in the database. Responses HTTP Code Description 200 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.
Responses HTTP Code Description 200 Success 206 Partial content of fc port instance objects Schema < fc_port_instance > array < fc_port_instance > array GET /fc_port/{id} Description Query a specific FC front-end port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the FC front-end port.
Type Name id Path required Description Schema Unique identifier of the FC front-end port. string body Body required fc_port_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request. error_response 404 Not Found error_response 422 Operation Failed error_response file_dns Use these resources to configure the Domain Name System (DNS) settings for a NAS server. One DNS settings object may be configured per NAS server.
HTTP Code Description Schema < 206 Partial content of file dns instance objects 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.
Responses HTTP Code Description Schema 200 Success file_dns_instance 404 Not Found error_response DELETE /file_dns/{id} Description Delete DNS settings of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the DNS object. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_dns/{id} Description Modify the DNS settings of a NAS Server.
Type Name Description body Body required Schema file_dns_modify Responses HTTP Code Description Schema 204 Success. No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response file_ftp Use these resources to configure one File Transfer Protocol (FTP) server per NAS server. One FTP server can be configured per NAS server to have both secure and unsecure services running.
HTTP Code Description 206 Partial content of file ftp instance objects Schema < file_ftp_instance > array POST /file_ftp Description Create an FTP/SFTP server. Parameters Type Name body Body required Schema file_ftp_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_ftp/{id} Description Query a specific FTP/SFTP server for its settings.
HTTP Code Description Schema 200 Success file_ftp_instance 404 Not Found error_response DELETE /file_ftp/{id} Description Delete an FTP/SFTP Server. Parameters Type Name id Path required Description Schema Unique identifier of the FTP/SFTP Server object. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_ftp/{id} Description Modify an FTP/SFTP server settings.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response file_interface Information about File network interfaces in the storage system. These interfaces control access to Windows (CIFS) and UNIX/Linux (NFS) file storage. GET /file_interface Description Query file interfaces.
Type Name body Body required Schema file_interface_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_interface/{id} Parameters Type Name id Path required Description Schema Unique identifier of the file interface.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_interface/{id} Description Modify the settings of a file interface. Parameters Type Name id Path required Body Description Schema Unique identifier of the file interface.
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. As a result, network shares and exports associated with the interface are no longer available to clients outside their immediate subnet. GET /file_interface_route Description Query file interface routes.
Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_interface_route/{id} Description Query a specific file interface route for details. Parameters Type Path Name Description id Unique identifier of the file interface route required object.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_interface_route/{id} Description Modify file interface route settings. Parameters Type Path Body Name Description Schema id Unique identifier of the file interface route required object.
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 /file_kerberos Description Query of the Kerberos service settings of NAS Servers. Responses HTTP Code Description Schema < 200 Success.
GET /file_kerberos/{id} Description Query a specific Kerberos service settings of a NAS Server. Parameters Type Name id Path required Description Schema Kerberos service object. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_kerberos_inst ance error_response DELETE /file_kerberos/{id} Description Delete Kerberos configuration of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the Kerberos service object.
PATCH /file_kerberos/{id} Description Modify the Kerberos service settings of a NAS Server. Parameters Type Name id Path required Body Description Schema Unique identifier of the Kerberos service object. string body file_kerberos_modif required y Responses HTTP Code Description Schema 204 Success.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /file_kerberos/{id}/download_keytab Description Download previously uploaded keytab file for secure NFS service. Parameters Type Name id Path required Description Schema Unique identifier of the Kerberos service object.
NAS Server. You can configure one LDAP settings object per NAS Server. LDAP is an application protocol for querying and modifying directory services running on TCP/IP networks. LDAP provides central management for network authentication 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.
HTTP Code Description Schema 400 Invalid Request error_response 422 Operation Failed error_response GET /file_ldap/{id} Description Query a specific NAS Server’s LDAP settings object. Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object. string Responses HTTP Code Description Schema 200 Success file_ldap_instance 404 Not Found error_response DELETE /file_ldap/{id} Description Delete a NAS Server’s LDAP settings.
HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_ldap/{id} Description Modify a NAS Server’s LDAP settings object. Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object id.
Type Name Description Schema FormDat body a file required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /file_ldap/{id}/download_config Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object.
POST /file_ldap/{id}/upload_certificate Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object.
HTTP Code Description Schema 422 Operation Failed error_response Produces • document/text file_ndmp The Network Data Management Protocol (NDMP) provides a standard for backing up file servers on a network. NDMP allows centralized applications to back up file servers that run on various platforms and platform versions. NDMP reduces network congestion by isolating control path traffic from data path traffic, which permits centrally managed and monitored local backup operations.
Parameters Type Name body Body required Schema file_ndmp_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_ndmp/{id} Description Query an NDMP service configuration instance. Parameters Type Name id Path required Description Schema Unique identifier of the NDMP service object.
Parameters Type Name id Path required Description Schema Unique identifier of the NDMP service object. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_ndmp/{id} Description Modify an NDMP service configuration instance. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the NDMP service object.
file_nis Use these resources to manage the Network Information Service (NIS) settings object for a NAS Server. One NIS settings object may be configured per NAS server. NIS consists of a directory service protocol 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 Description 200 Success.
HTTP Code Description Schema 422 Operation Failed error_response GET /file_nis/{id} Description Query a specific NIS settings object of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the NIS object. string Responses HTTP Code Description Schema 200 Success file_nis_instance 404 Not Found error_response DELETE /file_nis/{id} Description Delete NIS settings of a NAS Server.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response PATCH /file_nis/{id} Description Modify the NIS settings of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the NIS object. string body Body required file_nis_modify Responses HTTP Code Description Schema 204 Success.
Responses HTTP Code Description Schema < 200 file_system_instan Success ce > array < 206 Partial content of file system instance objects file_system_instan ce > array POST /file_system Description Create a file system. Parameters Type Name body Body required Schema file_system_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_system/{id} Description Query a specific file system.
Type Name id Path required Description Schema File system id. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_system_instan ce error_response DELETE /file_system/{id} Description Delete a file system. Parameters Type Name id Path required Description Schema File system id.
Parameters Type Name id Path required Description Schema File system id. string body Body file_system_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_system/{id}/clone Description Create a clone of a file system. Parameters Type Name id Path required body Body required Description Schema File system id.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_system/{id}/snapshot Description Create a snapshot of a file system. Parameters Type Name id Path required Body Description Schema File system id.
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 Name id Path required Description Schema File system snapshot id. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_system/{id}/restore Description Restore from a snapshot of a file system.
HTTP Code Description 200 Success (with backup snapshot) 204 Success (without backup snapshot) No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Schema file_system_restor e_response POST /file_system/{id}/refresh_quota Description Refresh the actual content of tree and user quotas objects. Parameters Type Name id Path required Description Schema File system id.
GET /file_tree_quota Description List tree quota instances. Responses HTTP Code Description Schema < 200 Success file_tree_quota_in stance > array < 206 Partial content of file tree quota instance objects file_tree_quota_in stance > array POST /file_tree_quota Description Create a tree quota instance.
Parameters Type Name id Path required Description Schema Unique identifier of the tree quota. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_tree_quota_in stance error_response DELETE /file_tree_quota/{id} Description Delete a tree quota instance. Parameters Type Name id Path required Description Schema Unique identifier of the tree quota.
Parameters Type Name id Path required Body Description Schema Unique identifier of the tree quota. string body file_tree_quota_mod required ify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_tree_quota/{id}/refresh Description Refresh the cache with the actual value of the tree quota.
HTTP Code Description Schema 422 Operation Failed 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.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_user_quota/{id} Description Query a user quota instance. Parameters Type Name id Path required Description Schema Unique identifier of the file user quota. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_user_quota_in stance error_response PATCH /file_user_quota/{id} Description Modify a user quota instance.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_user_quota/{id}/refresh Description Refresh the cache with the actual value of the user quota. Parameters Type Name id Path required Description Schema Unique identifier of the file user quota.
blocked. If the file does not contain a virus, it is written to the file system. If the file 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. GET /file_virus_checker Description Query all virus checker settings of the NAS Servers.
HTTP Code Description Schema 400 Invalid Request error_response 422 Operation Failed error_response GET /file_virus_checker/{id} Description Query a specific virus checker setting of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the virus checker instance.
HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_virus_checker/{id} Description Modify the virus checker settings of a NAS Server. Parameters Type Name id Path required Body Description Schema Unique identifier of the virus checker instance.
Type Name id Path required FormDat body a optional Description Schema Unique identifier of the virus checker instance. string Upload virus checker configuration file.
HTTP Code Description Schema 422 Operation Failed error_response Produces • document/text hardware This provides the hardware component inventory of the system. GET /hardware Description List hardware components. Responses HTTP Code Description Schema < 200 Success hardware_instanc e > array < 206 Partial content of hardware instance objects hardware_instanc e > array Produces • application/json GET /hardware/{id} Description Get a specific hardware component instance.
Responses HTTP Code Description 200 Success 404 Not Found Schema hardware_instanc e error_response Produces • application/json PATCH /hardware/{id} Description Modify a hardware instance. Parameters Type Name id Path required Description Schema The hardware component to modify.
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. It will fail if the drive is not locked to a different appliance. Parameters Type Name id Path required body Body required Description Schema Identifier of the drive to repurpose.
Responses HTTP Code Description 200 Success 206 Partial content of host instance objects Schema < host_instance > array < host_instance > array Produces • application/json POST /host Description Add a host.
GET /host/{id} Description Get details about a specific host by id. Parameters Type Name id Path required Description Schema Unique id of the host. string Responses HTTP Code Description Schema 200 Success host_instance 404 Not Found error_response Produces • application/json DELETE /host/{id} Description Delete a host. Delete fails if host is attached to a volume or consistency group.
HTTP Code Description Schema 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json PATCH /host/{id} Description Operation that can be performed are modify name, modify description, remove initiator(s) from host, add initiator(s) to host, update existing initiator(s) with chap username/password. This will only support one of add, remove and update initiator operations in a single request.
POST /host/{id}/attach Description Attach host to volume. Parameters Type Name id Path required Description Schema Unique id of the host. string body Body host_attach required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /host/{id}/detach Description Detach host from volume.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json host_group Manage host groups. A host group is a mechanism to provision hosts and volumes to be consistent across the Cyclone cluster. Operations that can be performed include, creating or deleting a host group, modifying host group(i.e. adding or removing hosts from a host group).
POST /host_group Description Create a host group. Parameters Type Name body Body required Schema host_group_create Responses HTTP Code Description Schema 201 Created create_response 400 Operation Failed error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json GET /host_group/{id} Description Get details about a specific host group. Parameters Type Path Name id required Description Schema Unique id of the host group.
HTTP Code Description 200 Success 404 Not Found Schema host_group_instan ce error_response Produces • application/json DELETE /host_group/{id} Description Delete a host group. Delete fails if host group is attached to a volume. Parameters Type Name id Path required Description Schema Unique id of the host group.
Parameters Type Name id Path required Description Schema Unique id of the host group. string body Body host_group_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Operation Failed error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /host_group/{id}/attach Description Attach host group to volume.
HTTP Code Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /host_group/{id}/detach Description Detach host group from volume. Parameters Type Name id Path required Description Schema Unique id of the host group.
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 Schema < 200 host_virtual_volu Success me_mapping_inst ance > array < 206 Partial content of host virtual volume mapping instance objects host_virtual_volu me_mapping_inst ance > array GET /host_virtual_volume_mapping/{id} Description Query a specific virtual volume mapping.
HTTP Code Description Schema 404 Not Found 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.
HTTP Code Description 200 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. GET /import_host_initiator Description Query import host initiators.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_host_initia tor_instance error_response import_host_system Use these resource types to manage import host systems. Import host enables communication with multipathing software on the host system to perform import operations. While configuring the import_host_system if the host is not present a new Host will be created. If Host is already present, the same Host will be updated with the import_host_system details.
created. If Host is already present, the same Host will be updated with the import_host_system details. Parameters Type Name request Body required Description Schema import_host_system_ Request parameters. create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /import_host_system/{id} Description Query a specific import host system instance.
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.
HTTP Code Description Schema 422 Operation Failed 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 queried and then corresponding volumes can be imported. GET /import_host_volume Description Query import host volumes.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_host_volu me_instance error_response import_psgroup Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. GET /import_psgroup Description Query PS Group storage arrays.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_psgroup_i nstance error_response POST /import_psgroup/{id}/discover Description Discover the importable volumes and snapshot schedules in the PS Group. Parameters Type Name id Path required Description Schema Unique identifier of the PS Group.
Responses HTTP Code Description Schema < 200 import_psgroup_v Success olume_instance > array < 206 Partial content of import psgroup volume instance objects import_psgroup_v olume_instance > array GET /import_psgroup_volume/{id} Description Query a specific PS Group volume. Parameters Type Name id Path required Description Schema Unique identifier of the PS Group volume.
Type Name id Path required Description Schema Unique identifier of the PS Group volume.
HTTP Code Description Schema < 206 Partial content of import session instance objects 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 an import session. The volumes or consistency groups must be in a migration-ready state.
Responses HTTP Code Description 200 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 import sessions, use the Cancel operation. You can delete the import session after cancelling it.
Type Name Body Description Schema body import_session_mod required ify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /import_session/{id}/cutover Description Commit an import session that is in a Ready_For_Cutover state. When the import session is created with the automatic_cutover attribute set to false, you must use the Cutover operation to complete the import.
HTTP Code Description Schema 422 Operation Failed error_response POST /import_session/{id}/cancel Description Cancel an active import session. Cancel is allowed when the import is in a Scheduled, Queued, Copy_In_Progress, or Ready_For_Cutover state. After a successful cancellation, the host is mapped to original source volume, all paths are cleaned up, and the import state is Cancelled. The import can be attempted again in the future.
You can resume or cancel the paused import. Parameters Type Name id Path required Description Schema Unique identifier of the import session string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /import_session/{id}/resume Description Resumes the paused import session. The background data copy continues from where it was stopped.
HTTP Code Description Schema 422 Operation Failed error_response POST /import_session/{id}/enable_destination_volume Description Enable the destination volume of an import session. This action can only be used on an agentless import session that is in the 'Mirror_Enabled' state after the host application using the source volume is brought offline. The host application can be reconfigured to use the destination volume of the import session after enabling the destination volume.
Parameters Type Name id Path required Description Schema Unique identifier of the import session.
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 HTTP Code Description Schema < 200 import_storage_ce Success nter_instance > array < 206 Partial content of import storage center instance objects import_storage_ce nter_instance > array GET /import_storage_center/{id} Description Query a specific SC array.
HTTP Code Description Schema 404 Not Found error_response POST /import_storage_center/{id}/discover Description Discover the importable volumes and snapshot profiles in the SC array. Parameters Type Name id Path required Description Schema Unique identifier of the SC array.
HTTP Code Description Schema < import_storage_ce 200 Success nter_consistency_ group_instance > array < 206 Partial content of import storage center consistency group instance objects import_storage_ce nter_consistency_ group_instance > array GET /import_storage_center_consistency_group/{id} Description Query a specific SC consistency group. Parameters Type Name id Path required Description Schema Unique identifier of the SC consistency group.
Parameters Type Name id Path required Description Schema Unique identifier of the SC consistency group. string Responses HTTP Code Description Schema import_storage_ce nter_consistency_ 200 Success group_import_sna pshot_profiles_res ponse 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed.
HTTP Code Description Schema < 206 Partial content of import storage center volume instance objects import_storage_ce nter_volume_insta nce > array GET /import_storage_center_volume/{id} Description Query a specific SC volume. Parameters Type Name id Path required Description Schema Unique identifier of the SC volume.
HTTP Code Description Schema import_storage_ce 200 Success nter_volume_imp ort_snapshot_prof iles_response 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed. error_response import_unity Use this resource type to discover the Unity system that is a source storage system for import GET /import_unity Description Query Unity storage systems.
Parameters Type Name id Path required Description Schema Unique identifier of the Unity storage system. string Responses HTTP Code Description 200 Success 404 Not Found Schema import_unity_inst ance error_response POST /import_unity/{id}/discover Description Discover the importable volumes and consistency groups in the Unity storage system. Parameters Type Name id Path required Description Schema Unique identifier of the Unity storage system.
GET /import_unity_consistency_group Description Query Unity consistency groups. Responses HTTP Code Description Schema < 200 import_unity_cons Success istency_group_inst ance > array < 206 Partial content of import unity consistency group instance objects import_unity_cons istency_group_inst ance > array GET /import_unity_consistency_group/{id} Description Query a specific Unity consistency group.
Description Return the snapshot schedules associated with the specified Unity consistency group. Parameters Type Name id Path required Description Schema Unique identifier of the Unity consistency group.
HTTP Code Description Schema < 200 import_unity_volu Success me_instance > array < 206 import_unity_volu Partial content of import unity volume instance objects me_instance > array GET /import_unity_volume/{id} Description Query a specific Unity volume. Parameters Type Name id Path required Description Schema Unique identifier of the Unity volume.
Type Name id Path required Description Schema Unique identifier of the Unity volume. string Responses HTTP Code Description Schema import_unity_volu 200 Success me_import_snaps hot_schedules_res ponse 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response import_vnx_array Use these resource types to discover the VNX storage system that can be imported to PowerStore.
GET /import_vnx_array/{id} Description Query a specific VNX storage system. Parameters Type Name id Path required Description Schema Unique identifier of a VNX storage system. string Responses HTTP Code Description 200 Success 404 Not Found Schema import_vnx_array _instance error_response POST /import_vnx_array/{id}/discover Description Discover the importable volumes and consistency groups in a VNX storage system.
HTTP Code Description Schema 422 Operation Failed error_response 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.
HTTP Code Description Schema import_vnx_consis 200 Success tency_group_insta nce 404 Not Found 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 HTTP Code Description 200 Success 404 Not Found Schema import_vnx_volu me_instance error_response import_xtremio Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. GET /import_xtremio Description Query XtremIO storage systems X1 and X2.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_xtremio_i nstance error_response POST /import_xtremio/{id}/discover Description Discover the importable volumes and consistency groups in the XtremIO storage system. Parameters Type Name id Path required Description Schema Unique identifier of the XtremIO storage system.
Responses HTTP Code Description Schema < 200 import_xtremio_c Success onsistency_group_ instance > array < 206 Partial content of import xtremio consistency group instance objects import_xtremio_c onsistency_group_ instance > array GET /import_xtremio_consistency_group/{id} Description Query a specific XtremIO consistency group. Parameters Type Path Name Description Schema id Unique identifier of the XtremIO consistency required group.
Type Path Name Description id Unique identifier of the XtremIO consistency required group.
HTTP Code Description Schema < 206 Partial content of import xtremio volume instance objects import_xtremio_v olume_instance > array GET /import_xtremio_volume/{id} Description Query a specific XtremIO volume. Parameters Type Name id Path required Description Schema Unique identifier of the XtremIO volume.
HTTP Code Description Schema import_xtremio_v 200 Success olume_import_sna pshot_schedules_r esponse 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response ip_pool_address Use these resource types to scale and reconfigure the IP networks in a cluster. GET /ip_pool_address Description Query configured IP addresses.
Parameters Type Name id Path required Description Schema Unique identifier of a configured IP address. string Responses HTTP Code Description 200 Success 404 Not Found Schema ip_pool_address_i nstance error_response Consumes • application/json Produces • application/json ip_port Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports. GET /ip_port Description Query IP port configurations.
GET /ip_port/{id} Description Query a specific IP port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the IP port. string Responses HTTP Code Description Schema 200 Success ip_port_instance 404 Not Found error_response Consumes • application/json Produces • application/json PATCH /ip_port/{id} Description Modify IP port parameters. Parameters Type Path Body Name id required Description Schema Unique identifier of the IP port.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json job Use this resource type for tracking an operation’s progress and status. GET /job Description Query jobs.
Parameters Type Name id Path required Description Schema Unique id of the job. string Responses HTTP Code Description Schema 200 Success job_instance 404 Not Found error_response keystore_archive Use this resource to generate and download an encryption keystore archive file. POST /keystore_archive/regenerate Description Creates a new encryption keystore archive file to replace the existing archive file, which includes the individual keystore backup files from each appliance in the cluster.
Produces • application/json GET /keystore_archive/{filename} Description Download a keystore backup archive 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 Name filename Path required Description Schema Filename is the last component in the URI path and becomes the filename of the downloaded string file.
Responses HTTP Code Description Schema < 200 ldap_account_inst Success ance > array < 206 Partial content of ldap account instance objects ldap_account_inst ance > array POST /ldap_account Description Create a new LDAP account.
Type Name id Path required Description Schema Unique identifier of the LDAP account. string Responses HTTP Code Description 200 Success 404 Not Found Schema ldap_account_inst ance error_response DELETE /ldap_account/{id} Description Delete an LDAP account. Parameters Type Path Name Description Schema id Unique identifier of the LDAP account to be required deleted.
Parameters Type Path Body Name Description id Unique identifier of the LDAP account to be required modified. Schema string body ldap_account_modif required y Responses HTTP Code Description Schema 204 No Content No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response ldap_domain Use this resource type to manage ldap configuration. GET /ldap_domain Description Query list of ldap domain.
POST /ldap_domain Description Create a new ldap domain. Parameters Type Name body Body required Schema ldap_domain_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /ldap_domain/{id} Description Query a specific LDAP domain. Parameters Type Name id Path required Description Schema Unique identifier of the LDAP domain.
DELETE /ldap_domain/{id} Description Delete an LDAP domain. Parameters Type Path Name Description id Unique identifier of the LDAP domain to be required deleted. Schema string Responses HTTP Code Description Schema 204 No Content No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /ldap_domain/{id} Description Modify the properties of an LDAP domain.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /ldap_domain/{id}/verify Description verifying the connectivity to the LDAP domain server. Parameters Type Name id Path required Description Schema Unique identifier of the instance.
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, an alert will be raised that indicates when the trial period will expire. For sites that do not allow connection to the Software Licensing Central, there is an alternate mechanism to license the cluster: 1. Get the license activation file from the system. 2.
POST /license/upload Description Upload a software license to install the license on the cluster. Parameters Type Name Description Schema FormDat license_file The file to upload containing the software a license to install the license on the cluster.
local_user Use this resource type to manage local user accounts. GET /local_user Description Query all local user account instances. This resource type collection query does not support filtering, sorting or pagination Responses HTTP Code Description Schema < 200 local_user_instanc Success e > array < 206 local_user_instanc Partial content of local user instance objects e > array POST /local_user Description Create a new local user account.
HTTP Code Description Schema 422 Operation Failed error_response GET /local_user/{id} Description Query a specific local user account instance using an unique identifier. Parameters Type Name id Path required Description Schema Unique identifier of the local user account. string Responses HTTP Code Description 200 Success 404 Not Found Schema local_user_instanc e error_response DELETE /local_user/{id} Description Delete a local user account instance using the unique identifier.
HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /local_user/{id} Description Modify a property of a local user account using the unique identifier. You cannot modify the default "admin" user account. Parameters Type Path Name Description id Unique identifier of the local user account to be required modified.
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 login session instance objects login_session_inst ance > array Produces • application/json logout Use these resource types to manage sessions, roles, and system security configurations. POST /logout Description Log out the current user.
maintenance_window Use this resource type to manage the maintenance window configuration for each appliance. The maintenance window allows you to set a time period during which alerts do not generate any notifications. After the specified interval (1-48 hours), the maintenance window will get automatically disabled and any alerts that are still outstanding will generate notifications.
HTTP Code Description 200 Success 404 Not Found Schema maintenance_win dow_instance error_response PATCH /maintenance_window/{id} Description Configure maintenance window. Parameters Type Path Body Name Description Schema id Unique identifier of the maintenance window required configuration.
Parameters Type Name body Body required Schema metrics_generate Responses HTTP Code Description Schema < 200 Success metrics_generate_ response > array 204 Success No Content 400 Invalid Request error_response 422 Operation Failed error_response Produces • application/json migration_recommendation The system produces migration recommendations periodically or upon request, based on capacity usage and recent performance.
HTTP Code Description Schema < 206 Partial content of migration recommendation instance objects migration_recom mendation_instan ce > array POST /migration_recommendation Description Generate a recommendation for redistributing storage utilization between appliances.
Responses HTTP Code Description Schema migration_recom 200 mendation_instan Success ce 404 Not found error_response DELETE /migration_recommendation/{id} Description Delete a migration recommendation. Parameters Type Name id Path required Description Schema Unique ID of the migration recommendation.
Type Name id Path required Description Schema Unique ID of the migration recommendation. string Responses HTTP Code Description Schema migration_recom 200 mendation_create Success _migration_sessio ns_response 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request error_response POST /migration_recommendation/{id}/start_migration_sessions Description Start previously created migration sessions for recommendation.
HTTP Code Description Schema 404 Not Found error_response 422 Invalid Request error_response migration_session Manage migration sessions. GET /migration_session Description Query migration sessions. Responses HTTP Code Description Schema < 200 migration_session Success _instance > array POST /migration_session Description Create a new migration session.
HTTP Code Description 201 Created 400 Invalid Request error_response 422 Operation Failed error_response Schema migration_session _create_response Produces • application/json GET /migration_session/{id} Description Query a specific migration session. Parameters Type Name id Path required Description Schema Unique identifier of the migration session.
Type Name id Path required body Body optional Description Schema Unique identifier of the migration session. string Parameters for a deletion. migration_session_d elete Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /migration_session/{id}/pause Description Pause a migration session. Only migration sessions in the synchronizing state can be paused.
POST /migration_session/{id}/resume Description Resume a paused migration session. You cannot resume a migration session in the failed state. Parameters Type Name id Path required Description Schema Unique identifier of the migration session.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /migration_session/{id}/cutover Description Final phase of the migration, when ownership of the volume, vVol, or volume group is transferred to the new appliance. Parameters Type Name id Path required Description Schema Unique identifier of the migration session.
GET /nas_server Description Query all NAS servers. Responses HTTP Code Description Schema < 200 Success nas_server_instan ce > array < 206 Partial content of nas server instance objects nas_server_instan ce > array POST /nas_server Description Create a NAS server.
Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description 200 Success 404 Not Found Schema nas_server_instan ce error_response DELETE /nas_server/{id} Description Delete a NAS server. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Description Modify the settings of a NAS server. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string body Body nas_server_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /nas_server/{id}/ping Description Ping destination from NAS server.
HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /nas_server/{id}/upload/passwd Description Upload NAS server passwd file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload NAS server passwd file.
Description Download a NAS server passwd file containing template or the actual (if already uploaded) passwd details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/hosts Description Upload NAS server host file.
HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /nas_server/{id}/download/hosts Description Download an NAS server host file containing template/actual(if already uploaded) host details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload NAS server group file.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/netgroup Description Upload the NAS server netgroup file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server netgroup file.
Description Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/nsswitch Description Upload the NAS server nsswitch file.
HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /nas_server/{id}/download/nsswitch Description Download a NAS server nsswitch file containing the template or the actual (if already uploaded) nsswitch configuration settings. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Description Upload the NAS server homedir file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server homedir file.
HTTP Code Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/ntxmap Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server ntxmap file.
Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/update_user_mappings Description Fix the user mappings for all file systems associated with the NAS server. This process updates file ownership on the NAS server’s file systems to reflect changes to users' SIDs.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response GET /nas_server/{id}/download/user_mapping_report Description Download the report generated by the update_user_mappings action. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
HTTP Code Description Schema < 200 Success network_instance > array < 206 Partial content of network instance objects network_instance > array GET /network/{id} Description Query a specific IP network configuration. Parameters Type Name id Path required Description Schema Unique identifier of the IP network.
Parameters Type Name id Path required Description Schema Unique identifier of the IP network. string body Body network_modify optional Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /network/{id}/replace Description Reconfigure cluster management network settings from IPv4 to IPv6 or vice versa.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /network/{id}/scale Description Add IP ports for use by the storage network, or remove IP ports so they can no longer be used. At least one IP port must be configured for use by the storage network.
HTTP Code Description Schema 422 Operation Failed error_response Consumes • application/json Produces • application/json nfs_export NFS Exports use the NFS protocol to provide an access point for configured Linux/Unix hosts or IP subnets to access file_systems or file_snapshots. GET /nfs_export Description List NFS Exports.
Type Name body Body required Schema nfs_export_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /nfs_export/{id} Description Get NFS Export properties. Parameters Type Name id Path required Description Schema NFS Export object id.
Parameters Type Name id Path required Description Schema NFS Export object id. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /nfs_export/{id} Description Modify NFS Export Properties. Parameters Type Name id Path required Description Schema NFS Export object id.
nfs_server Use these resource types to manage NFS servers. One NFS server may be configured per NAS server. 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 server is deleted. GET /nfs_server Description Query all NFS Servers.
HTTP Code Description Schema 400 Invalid Request error_response 422 Operation Failed error_response GET /nfs_server/{id} Description Query settings of an NFS server. Parameters Type Name id Path required Description Schema Unique identifier of the NFS server. string Responses HTTP Code Description 200 Success 404 Not Found Schema nfs_server_instanc e error_response DELETE /nfs_server/{id} Description Delete an NFS server.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /nfs_server/{id} Description Modify NFS server settings. Parameters Type Name id Path required Description Schema Unique identifier of the NFS server.
Parameters Type Name id Path required Description Schema Unique identifier of the NFS server. string body Body nfs_server_join required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /nfs_server/{id}/unjoin Description Unjoin the secure NFS server from the NAS server’s Active Directory domain.
HTTP Code Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed 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 Description 200 Success 206 Partial content of node instance objects Schema < node_instance > array < node_instance > array GET /node/{id} Description Query a specific node in a cluster.
HTTP Code Description Schema 200 Success node_instance 404 Not found error_response 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 Description 200 Success 206 Partial content of ntp instance objects Schema < ntp_instance > array < ntp_instance > array GET /ntp/{id} Description Query a specific NTP setting.
Responses HTTP Code Description Schema 200 Success ntp_instance 404 Not Found error_response PATCH /ntp/{id} Description Modify NTP settings. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the NTP setting.
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 Schema < 200 performance_rule OK _instance > array < 206 Partial content of performance rule instance objects performance_rule _instance > array Produces • application/json GET /performance_rule/{id} Description Get a performance rule by id.
HTTP Code Description Schema 404 The performance_rule does not exist. 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.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /physical_switch/{id} Description Query a specific physical switch settings. Parameters Type Name id Path required Description Schema Unique identifier of the physical switch settings.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /physical_switch/{id} Description Modify a physical switch settings. Parameters Type Name id Path required Body Description Schema Unique identifier of the physical switch settings.
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,name,management_address)), snapshot_rules(id,name,interval,time_of_day,days_of_week),volume(id,name),volume_group(id,na me)&type=eq.
Responses HTTP Code Description Schema 201 Success create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /policy/{id} Description Query a specific policy. Parameters Type Name id Path required Description Schema Unique identifier of the policy. string Responses HTTP Code Description Schema 200 Success policy_instance 404 Not Found error_response DELETE /policy/{id} Description Delete a protection policy.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /policy/{id} Description Modify a protection policy. Parameters Type Name id Path required Description Schema Unique identifier of the policy to be modified.
The PowerStore local system can establish a remote system relationship with different types of remote storage systems for replication remote protection and import use-cases. Refer to the RemoteSystemTypeEnum specification for a list of system types supported. NOTE Before creating a remote system relationship with PowerStore remote systems, first establish a Certificate Based Trust between the local and remote PowerStore systems using the verify and exchange operations on the x509_certificate resource type.
• 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. Parameters Type Name body Body required Description Parameters to create a remote system.
HTTP Code Description 200 Success 404 Not Found Schema remote_system_in stance error_response DELETE /remote_system/{id} Description Delete a remote system. Deleting the remote system deletes the management and data connections established with the remote system. You cannot delete a remote system if there are active import sessions, or if there are remote protection policies active in the system referencing the remote system instance.
Description Modify a remote system instance. The list of valid parameters depends on the type of remote system. For PowerStore remote system relationships: • Description • Management address - An IPv4 or IPv6 address. FQDN is not supported. For non-PowerStore remote system relationships: • Name • Description • Management address - An IPv4 address. FQDN is not supported. • Remote administrator credentials • iSCSI address - An IPv4 address.
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 Name id Path required body Body optional Description Schema Unique identifier of the remote system. string Parameters to verify a remote system.
HTTP Code Description Schema < 200 Success replication_rule_i nstance > array < 206 Partial content of replication rule instance objects replication_rule_i nstance > array POST /replication_rule Description Create a new replication rule.
Responses HTTP Code Description 200 Success 404 Not Found Schema replication_rule_i nstance error_response DELETE /replication_rule/{id} Description Delete a replication rule. Deleting a rule is not permitted, if the rule is associated with a protection policy that is currently applied to a storage resource. Parameters Type Name id Path required Description Schema Unique identifier of the replication rule.
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 replication rule, and then associate it back with the relevant protection policies. Parameters Type Name id Path required Body Description Schema Unique identifier of the replication rule.
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 resizing the volume, restoring the snapshot, or changing membership for a volume group on the resource are not allowed.
HTTP Code Description 200 Success 404 Not Found Schema replication_sessio n_instance error_response POST /replication_session/{id}/sync Description Synchronize the destination resource 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 efficiency.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /replication_session/{id}/pause Description Pause a replication session instance. You can pause a replication session when you need to modify the source or destination system. For example, you can pause the replication session to take the source or destination system down for maintenance.
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 migration Leaving replication session in a paused state results in change accumulations on the source system, and consume more storage on the source system.
also pause, and subsequently resume, a replication session. • Paused_for_NDU • Paused_for_Migration Parameters Type Name id Path required Description Schema Unique identifier of the replication session. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /replication_session/{id}/failover Description Fail over a replication session instance.
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 is_planned parameter to false. Unplanned failovers provide production access to the original destination resource from a preview synchronized point-in-time snapshot referred to as replication common-base.
Parameters Type Name id Path required Description Schema Unique identifier of the replication session. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response role Use these resource types to manage sessions, roles, and system security configurations. GET /role Description Query roles.
GET /role/{id} Description Query a specific role. Parameters Type Name id Path required Description Schema Unique identifier of the role. string Responses HTTP Code Description Schema 200 Success role_instance 404 Not Found error_response Produces • application/json sas_port Use this resource type to retrieve information about SAS ports. GET /sas_port Description Query the SAS port configuration for all cluster nodes.
GET /sas_port/{id} Description Query a specific SAS port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the SAS port. string Responses HTTP Code Description Schema 200 Success sas_port_instance 404 Not Found error_response security_config system security configuration GET /security_config Description Query system security configurations.
Produces • application/json GET /security_config/{id} Description Query a specific system security configuration. Parameters Type Path Name Description id Unique required configuration. identifier Schema of the system security string Responses HTTP Code Description 200 Success 404 Not Found Schema security_config_in stance error_response Produces • application/json service_config Manage the service configuration for each appliance.
HTTP Code Description Schema < 200 Success service_config_ins tance > array < 206 Partial content of service config instance objects service_config_ins tance > array GET /service_config/{id} Description Query the service configuration instances for an appliance. Parameters Type Name id Path required Description Schema Unique identifier of the instance.
Type Name Body Description Schema body service_config_modi required fy Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response service_user Use this resource type to manage the service user account. The system includes the default service_user account with the username 'service'. The service user account cannot authenticate through the REST, CLI, or graphical user interfaces.
HTTP Code Description Schema < 206 Partial content of service user instance objects service_user_insta nce > array Produces • application/json GET /service_user/{id} Description Query the service user account using the unique identifier. Parameters Type Name id Path required Description Schema Unique identifier of the service user.
Type Name id Path required Description Schema Unique identifier of the service user account. string body Body required service_user_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json smb_server Use these resource types to manage Server Message Block (SMB) servers.
HTTP Code Description Schema < 200 Success smb_server_insta nce > array < 206 Partial content of smb server instance objects smb_server_insta nce > array POST /smb_server Description Create an SMB server. Parameters Type Name body Body required Schema smb_server_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /smb_server/{id} Description Query settings of a specific SMB server.
Responses HTTP Code Description 200 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 Name id Path required Description Schema Unique identifier of the SMB server.
Type Name id Path required Description Schema Unique identifier of the SMB server. string body Body smb_server_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /smb_server/{id}/join Description Join the SMB server to an Active Directory domain.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response POST /smb_server/{id}/unjoin Description Unjoin the SMB server from an Active Directory domain. Parameters Type Name id Path required Description Schema Unique identifier of the SMB server.
Description List SMB shares. Responses HTTP Code Description Schema < 200 smb_share_instan Success ce > array < 206 smb_share_instan Partial content of smb share instance objects ce > array POST /smb_share Description Create an SMB share.
Parameters Type Name id Path required Description Schema SMB Share object id. string Responses HTTP Code Description 200 Success 404 Not Found Schema smb_share_instan ce error_response DELETE /smb_share/{id} Description Delete an SMB Share. Parameters Type Name id Path required Description Schema SMB Share object id.
Parameters Type Name id Path required Description Schema SMB share object id. string body Body smb_share_modify optional Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response smtp_config Use these resource types to configure outgoing SMTP and email notifications. GET /smtp_config Description Query the SMTP configuration. There is always exactly one smtp_config instance.
GET /smtp_config/{id} Description Query the specific SMTP configuration. Parameters Type Name id Path required Description Schema Unique identifier of the SMTP configuration. string Responses HTTP Code Description 200 Success 404 Not Found Schema smtp_config_insta nce error_response PATCH /smtp_config/{id} Description Configure the outgoing SMTP information. Parameters Type Name id Path required Description Schema Unique identifier of the SMTP configuration.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response POST /smtp_config/{id}/test Description Test the SMTP configuration. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the SMTP configuration. string Test operation request body.
Responses HTTP Code Description Schema < 200 snapshot_rule_inst Success ance > array < 206 Partial content of snapshot rule instance objects snapshot_rule_inst ance > array POST /snapshot_rule Description Create a new snapshot rule.
Type Name id Path required Description Schema Unique identifier of the snapshot rule. string Responses HTTP Code Description 200 Success 404 Not Found Schema snapshot_rule_inst ance error_response DELETE /snapshot_rule/{id} Description Delete a snapshot rule Parameters Type Name id Path required Body Description Schema Unique identifier of the snapshot rule.
If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to that associated storage resource. Parameters Type Name id Path required Body Description Schema Unique identifier of the snapshot rule.
HTTP Code Description Schema < 206 Partial content of software installed instance objects software_installed _instance > array GET /software_installed/{id} Description Query a specific item from the list of installed software. Parameters Type Path Name Description Schema id Unique identifier of the installed software to required query.
HTTP Code Description Schema < 200 Success. software_package _instance > array < 206 Partial content of software package instance objects software_package _instance > array POST /software_package Description Push a software package file from the client to the cluster. When successfully uploaded and verified, the result is a software_package in the downloaded state, ready to install.
Description Query a specific software package. Parameters Type Path Name Description Schema id Unique identifier of the software package to required query. string Responses HTTP Code Description 200 Success 404 Not Found Schema software_package _instance error_response DELETE /software_package/{id} Description Delete the specified software package from the cluster. This operation may take some time to complete.
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 upgrade the entire cluster does not fit within a desired maintenance window.
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 Name id Path required Body Description Schema Unique identifier of the software package.
HTTP Code Description Schema < 200 Success storage_container _instance > array < 206 Partial content of storage container instance objects storage_container _instance > array Produces • application/json POST /storage_container Description Create a virtual volume (vVol) storage container.
Parameters Type Name id Path required Description Schema Storage container ID. string Responses HTTP Code Description 200 Success 404 Not Found Schema storage_container _instance error_response Produces • application/json DELETE /storage_container/{id} Description Delete a storage container. Parameters Type Name id Path required body Body optional Description Schema Storage container ID. string Options to delete storage_container.
HTTP Code Description Schema 422 Operation Failed error_response Produces • application/json PATCH /storage_container/{id} Description Modify a storage container. Parameters Type Name id Path required body Body required Description Schema Storage container ID. string Fields to update.
Parameters Type Name id Path required Body Description Schema Storage container ID. string body storage_container_m optional ount Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /storage_container/{id}/unmount Description Unmount a storage container, which removes the vVol datastore from vCenter.
HTTP Code Description Schema 422 Operation Failed error_response vcenter Use this resource type to manage vCenter instances. Registered vCenter enables discovering of virtual machines, managing virtual machine snapshots, automatic mounting 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.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /vcenter/{id} Description Query a specific vCenter instance. Parameters Type Name id Path required Description Schema Unique identifier of the vCenter to query. string Responses HTTP Code Description Schema 200 Success vcenter_instance 404 Not Found error_response DELETE /vcenter/{id} Description Delete a registered vCenter.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /vcenter/{id} Description Modify a vCenter settings. Parameters Type Name id Path required Description Schema Unique identifier of the vCenter to modify.
GET /veth_port Description Query virtual Ethernet port configurations. Responses HTTP Code Description Schema < 200 Success veth_port_instanc e > array < 206 Partial content of veth port instance objects veth_port_instanc e > array GET /veth_port/{id} Description Query a specific virtual Ethernet port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the virtual Ethernet port.
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.
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 Description id Unique required snapshot to delete. identifier Schema of the virtual machine string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /virtual_machine/{id} Description Modify a virtual machine.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed 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. Parameters Type Path Body Name Description id Unique identifier of the virtual machine to required create a snapshot of.
GET /virtual_volume Description Get virtual volumes. Responses HTTP Code Description Schema < 200 Success virtual_volume_in stance > array < 206 Partial content of virtual volume instance objects virtual_volume_in stance > array GET /virtual_volume/{id} Description Get a specific virtual volume. Parameters Type Name id Path required Description Schema Id of the virtual volume.
Parameters Type Name id Path 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 Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response volume Manage volumes, including snapshots and clones of volumes. GET /volume Description Query volumes that are provisioned on the appliance.
Parameters Type Name body Body required Schema volume_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /volume/{id} Description Query a specific volume instance. Parameters Type Name id Path required Description Schema Unique identifier of the volume to query.
• 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. Parameters Type Name id Path required Description Schema Unique identifier of the volume to delete.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed 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 is the time when the snapshot is created. Parameters Type Path Name Description id Unique identifier of the volume or clone to required create a snapshot of.
Description Create a clone of a volume or snapshot. Parameters Type Path Name Description id Unique identifier of the volume or snapshot to required create a clone of.
Type Path Name Description Schema id Unique identifier of volume for which to refresh required contents. body Body string volume_refresh required Responses HTTP Code Description 200 Success 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Schema volume_refresh_r esponse POST /volume/{id}/restore Description Restore a volume from a snapshot.
Responses HTTP Code Description 200 Success 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Schema volume_restore_re sponse POST /volume/{id}/attach Description Attach a volume to a host or host group. Parameters Type Name id Path required Description Schema Unique identifier of volume to attach.
POST /volume/{id}/detach Description Detach a volume from a host or host group. Parameters Type Name id Path required Description Schema Unique identifier of volume to detach. string body Body required volume_detach Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response volume_group Manage volume_groups. A volume_group is a group of related volumes treated as a single unit.
HTTP Code Description Schema < 200 Success volume_group_ins tance > array < 206 Partial content of volume group instance objects volume_group_ins tance > array POST /volume_group Description Create a new volume group. The resulting volume group will have a type of Primary.
Responses HTTP Code Description 200 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 hosts. Note the following: • When a volume group or clone is deleted, all related snapshot sets will also be deleted. • When a snapshot set is deleted, all of its constituent snapshots will also be deleted.
Parameters Type Name id Path required Body Description Schema Unique identifier of the volume group. string body volume_group_modi optional fy Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request error_response POST /volume_group/{id}/add_members Description Add member volumes to an existing primary or clone volume group. This cannot be used to add members to a snapshot set.
HTTP Code Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request 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 snapshot set. Members cannot be removed from a volume group that is a acting as the destination in a replication session.
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 set to the identifier of the source volume group. • source_time of the snapshot set will be set to the time at which the snapshot set will be created.
When the source of a clone operation is a snapshot set, • source_id will be set to the source_id of the source snapshot set. • source_time will be set to the source_time of the source snapshot set. The clone volume group will inherit the value of the is_write_order_consistent property from the source volume group. A clone of a snapshot set is modeled as a clone of the snapshot set’s source, created at the same time instant as when the source snapshot set was created.
volume group have changed. This represents a case where the target volumes have been modified over time, but you want to revert them back to their old state captured in the source snapshot set. When a volume group is restored, • source_time is set to the source_time of the snapshot set it is being restored from. A volume group that is acting as the destination in a replication session cannot be restored.
primary (P1)|Current time| |Clone (C1) |snapshot set (S1) of primary (P1)|id of source snapshot set (S1)|source_time of source snapshot set (S1)| |Clone (C1) |Clone (C2)|id of source clone(C2)|Current time| |Clone (C1) |snapshot set (C2S1) of clone (C2)|id of source snapshot set (C2S1)|source_time of source snapshot set (C2S1)| Refresh operation is only supported if there are no membership changes between the source and target volume groups of the refresh operation.
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 x509_certificate_i nstance > array Produces • application/json GET /x509_certificate/{id} Description Query a specific X509 Certificate instance.
POST /x509_certificate/exchange Description Exchange certificates between two clusters. Add CA certificates to the trust store of each cluster and assign roles to the client certificates. After this process, certificate-based authentication can be used for communication between clusters. This exchange REST API can only be triggered with service Replication_HTTP. Parameters Type Name body Body required Description Request body.
AlertStateEnum Alert State Enum with values - Active and Cleared. Type : enum (ACTIVE, CLEARED) ArrayTypeEnum Product type of the storage system. Valid values are: Unknown Product type is unknown to PowerStore. SC Storage Center. PS Peer Storage Group. 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.
BondingModeEnum Bond mode. LACP Uses an IEEE 802.3ad dynamic link aggregation policy. Aggregation groups share the same speed and duplex settings. This mode transmits and receives network traffic on all slaves in the active aggregator. Type : enum (LACP) CGImportableCriteriaEnum Consistency group import criteria. Values are: Ready The consistency group is ready for nondisruptive import. Ready_For_Agentless_Import The consistency group is ready for agentless import. In_Progress Import is in progress.
CHAPModeEnum Available CHAP modes that describe or set the iSCSI CHAP mode for the entire cluster. Disabled CHAP is not used in the cluster Single CHAP is being used to authenticate the initiator Mutual CHAP is used to authenticate both the initiator and target Type : enum (Disabled, Single, Mutual) ClusterStateEnum Possible cluster states. * Unconfigured_Faulted - This is single appliance that is not in a cluster and Hardware is in faulted state.
Status not available. No_Targets_Discovered No targets discovered. Initializing Initializing Type : enum (OK, Partial_Data_Connection_Loss, Complete_Data_Connection_Loss, Status_Not_Available, No_Targets_Discovered, Initializing) DayOfWeekEnum Days of the week. Valid values are: Monday Monday Tuesday Tuesday Wednesday Wednesday Thursday Thursday Friday Friday Saturday Saturday Sunday Sunday Unknown Day of week is unknown to PowerStore.
EthPortSpeedEnum Supported Ethernet front-end port transmission speeds. For the current_speed attribute, these values show the current transmission speed on the port. For the requested_speed attribute, these values show the transmission speed set by the user. A requested speed of Auto means that the current speed value will be automatically detected. If this file is updated, also update FrontEndPortSpeedEnum.
16_Gbps 16 Gigabits per second 32_Gbps 32 Gigabits per second Type : enum (Auto, 4_Gbps, 8_Gbps, 16_Gbps, 32_Gbps) FileDNSTransportEnum Transport used when connecting to the DNS Server: UDP DNS uses the UDP protocol (default) TCP DNS uses the TCP protocol 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.
Not_Operational the route is not operational. Type : enum (Ok, Invalid_IP_Version, Invalid_Source_Interface, Invalid_Gateway, Not_Operational) FileLDAPAuthenticationTypeEnum Authentication type for the LDAP server. Anonymous Anonymous authentication means no authentication occurs and the NAS Server uses an anonymous login to access the LDAP-based directory server. Simple Simple authentication means the NAS Server must provide a bind distinguished name and password to access the LDAP-based directory server.
Unknown Unknown protocol. Type : enum (RFC2307, Microsoft, Unknown) FileQuotaStateEnum State of the user quota or tree quota record period. OK No quota limits are exceeded. Soft_Exceeded Soft limit is exceeded, and grace period is not expired. Soft_Exceeded_And_Expired Soft limit is exceeded, and grace period is expired. Hard_Reached Hard limit is reached. Type : enum (Ok, Soft_Exceeded, Soft_Exceeded_And_Expired, Hard_Reached) FileSystemAccessPolicyEnum File system security access policies.
SMB_Forbidden A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. All_Forbidden Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. Type : enum (All_Allowed, SMB_Forbidden, All_Forbidden) FileSystemLockingPolicyEnum File system locking policies.
External_VSS Created by Windows Volume Shadow Copy Service (VSS) to obtain an application consistent snapshot. External_NDMP Created by an NDMP backup operation. External_Restore Created as a backup snapshot before a snapshot restore. External_Replication_Manager Created by Replication Manager. Snap_CLI Created inband by SnapCLI. AppSync Created by AppSync. Type : enum (Scheduler, User) FileSystemTypeEnum Primary Normal file system or clone. Snapshot Snapshot of a file system.
Time to full value is less than or equal to 14 days. Major alert indicated. None There is insufficient forecast data to project time to full to at least 28 days. No alert indicated, but available data cannot guarantee OK status. Type : enum (OK, Minor, Major, None) FrontEndPortConnectionTypeEnum Type of connector supported by the port.
HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable No Separable Connector MXC_2x16 MXC 2x16 Connector Type : enum (Unknown, SC, FC_Style1_Copper, FC_Style2_Copper, BNC_TNC, FC_Coaxial_Headers, FiberJack, LC, MT_RJ, MU, SG, Optical_Pigtail, HSSDC_II, Copper_Pigtail, RJ45, No_Separable, MXC_2x16) HAOSTypeEnum Operating system of the import host system. Valid values are: Windows Windows. Linux Linux. ESXi ESXi.
Supported_Locked Drive supports encryption and is locked. Supported_Locked_Cluster_PIN Drive supports encryption and is configured. Supported_Locked_Out Drive supports encryption and is locked out. Supported_Locked_Foreign Drive supports encryption and is locked with an unknown PIN. Supported_Processing Drive supports encryption and is being processed. Disabled Drive encryption is disabled.
SAS-connected SSD in an Expansion Enclosure. NVMe_SCM NVME-Connected Storage Class Memory. NVMe_NVRAM NVME-Connected Non-volatile RAM. NVMe_SSD NVME-Connected SSD. Type : enum (Unknown, SAS_SSD, NVMe_SCM, NVMe_NVRAM, NVMe_SSD) HardwareLifecycleStateEnum Lifecycle state of the Hardware. Current values are: 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.
Unknown Unknown Connector SC 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 Mechanical Transfer - Registered Jack Connector MU Multiple Optical Connector SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Coppe
MXC_2x16 MXC 2x16 Connector Type : enum (Unknown, SC, FC_Style1_Copper, FC_Style2_Copper, BNC_TNC, FC_Coaxial_Headers, FiberJack, LC, MT_RJ, 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 This SFP supports single-mode fiber.
1_Gbps 1 Gigabit per second 10_Gbps 10 Gigabits per second 25_Gbps 25 Gigabits per second 40_Gbps 40 Gigabits per second Type : enum (Auto, 4_Gbps, 8_Gbps, 16_Gbps, 32_Gbps, 10_Mbps, 100_Mbps, 1_Gbps, 10_Gbps, 25_Gbps, 40_Gbps) HardwareSFPSupportedProtocolEnum Supported protocol. Available on the SFP hardware type. Current protocols are: Unknown This SFP has unknown protocol support. FC This SFP supports Fibre Channel. Ethernet This SFP supports Ethernet.
HardwareTypeEnum The type of hardware component. Current types are: Appliance The System including the Base Enclosure and optional Expansion Enclosures. Base_Enclosure The enclosure containing 2 Nodes and 25 NVME drive slots. Node The component that contains the processors and DIMMs. Expansion_Enclosure The enclosures that contain additional SAS storage. Power_Supply The AC Power Supply that powers each Node. IO_Module The component that provides front-end I/O connectivity to each Node.
HostAgentStatusEnum Status of the import host system. Valid values are: Unknown Agent status 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 any other dependent component does not satisfy the version as expected by the it.
FC Protocol type is Fibre Channel. FCoE Protocol type is Fibre Channel over Ethernet. Unknown Protocol type is unknown to PowerStore. Type : enum (Other, iSCSI, FC, FCoE, Unknown) ImportDestinationResourceTypeEnum Storage resource type of the import destination. Values are: * volume - The destination resource of the import session is a volume. * volume_group - The destination resource of the import session is a volume group.
Enabled Snapshot schedule is enabled. Disabled Snapshot schedule is disabled. Expired Snapshot schedule is expired. Type : enum (Enabled, Disabled, Expired) ImportPsgroupScheduleTypeEnum Snapshot schedule frequency. Valid values are: Once Take snapshot only once. Hourly Take snapshot hourly. Daily Take snapshot on a daily basis. Weekly Take snapshot on a weekly basis. Monthly Take snapshot on a monthly basis.
In_Progress Indicates that a queued import session is now in progress. Mirror_Enabled Indicates that an import session has completed setting up the entities required to import data from the source resource. Ready_To_Start_Copy Indicates that an import session is ready to start the data copy operation from the source resource. Copy_In_Progress Indicates that the data copy between the source and destination storage systems has started.
Indicates that there was an error while cleaning up the consistency group. Invalid Indicates that an import session is in an unexpected state. Cleanup_Required Indicates that there was an error while cleaning up the import or consistency group that requires user intervention to bring back host applications. Import_Completed_With_Errors Indicates that there was a mirror failure for one or more members while committing a consistency group due to which members were partially committed.
Prepared Volume is prepared for migration. Disabled_For_IO Volume is disabled for IO from host. In_Progress Volume migration is 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 An iSCSI initiator. FC A Fibre Channel initiator.
ISCSI_Default Is used for default storage connections and cannot be uscaled. External_Replication Can be used for the external data mobility traffic. Type : enum (Management, ISCSI, ISCSI_Default, External_Replication) IpPurposeTypeEnum Network IP address purpose. Mgmt_Cluster_Floating Floating IP address for external cluster management. Mgmt_Appliance_Floating Floating IP address for external appliance management. Mgmt_Node_CoreOS IP address for external system node management.
SDNAS_Node IP address for SDNAS node management within the cluster. SDNAS_Node_Serviceability IP address for SDNAS node serviceability access within the cluster. VMotion vMotion IP address. Unused Unused IP address. Storage_Global This value is no longer used.
Type : enum (PENDING, QUEUED, IN_PROGRESS, COMPLETED, SKIPPED, FAILING, UNRECOVERABLE_FAILED, FAILED) LDAPAccountTypeEnum Type of LDAP account:\n - User : LDAP account that maps to an LDAP user in LDAP server.\n - Group : LDAP account that maps to an LDAP group in LDAP server. Type : enum (User, Group) LDAPProtocolEnum Type of directory service protocol:\n - LDAP : Lightweight directory access protocol\n - LDAPS : Secure lightweight directory access protocol Type : enum (LDAP, LDAPS) LDAPServerT
performance_metrics_by_appliance Appliance performance metrics. performance_metrics_by_node Node performance metrics. performance_metrics_by_volume Volume performance metrics. performance_metrics_by_cluster Cluster performance metrics. performance_metrics_by_vm Virtual Machine performance metrics. performance_metrics_by_vg Storage performance metrics for all volumes in a volume group performance_metrics_by_fe_fc_port Frontend fibre channel port performance metrics.
space_metrics_by_storage_container Storage Container space metrics space_metrics_by_vg Volume space metrics in a volume group copy_metrics_by_appliance Appliance copy metrics copy_metrics_by_cluster Cluster copy metrics copy_metrics_by_vg Copy metrics for each volume group copy_metrics_by_remote_system Copy metrics for each remote system copy_metrics_by_volume Copy metrics for each volume performance_metrics_by_file_system Performance metrics for the file system.
performance_metrics_nfsv3_by_node Performance metrics for the NFSv3 protocol performance_metrics_nfsv4_by_node Performance metrics for the NFSv4 protocol Type : enum (performance_metrics_by_appliance, performance_metrics_by_node, performance_metrics_by_volume, performance_metrics_by_cluster, performance_metrics_by_vm, performance_metrics_by_vg, performance_metrics_by_fe_fc_port, performance_metrics_by_fe_eth_port, performance_metrics_by_fe_eth_node, performance_metrics_by_fe_fc_node, space_metrics_
Migration_Error The migration session for this recommended action has failed. Migration_Successful The migration session for this recommended action has been successfully completed.
Resource is not attached to any host. No_Virtual_Machine_Attached Resource is not attached to any virtual machine. Attached_To_Host Resource is attached to host. Attached_To_Virtual_Machine Resource is attached to virtual machine. Volume_Group_Member Resource is a member of volume group. Unspecified Unspecified.
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 completed.
Deleting Migration session is being deleted. Completed Migration session is complete and it is safe to delete the session. Pausing Migration session transitions to this state when the pause command is issued. Paused Migration session is paused. User intervention is required to resume the session. System_Paused Migration session transitions to this state if it encounters any error. User may resume or delete the migration session after resolving the error.
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 of the year.
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 Unix such as UIDs, GIDs, net groups, and so on. Type : enum (None, NIS, LDAP, Local_Files, Local_Then_NIS, Local_Then_LDAP) NASServerOperationalStatusEnum NAS server operational status: Stopped NAS server is stopped.
Read_Only Allow read only access to the Export for the hosts. Read_Write Allow read write access to the Export for the hosts. Root Allow read write access to the Export for the hosts. Allow access to the Export for root user. Read_Only_Root Allow read only root access to the Export for the hosts. Type : enum (No_Access, Read_Only, Read_Write, Root, Read_Only_Root) NFSExportMinSecurityEnum NFS enforced security type for users accessing an NFS Export.
Storage External data transfer. VMotion Data movement controlled by VMotion. Type : enum (Management, Intra_Cluster_Management, Intra_Cluster_Data, Storage, VMotion) NodeAffinityEnum This attribute shows which node will be advertised as the optimized IO path to the volume. It is initially set to System_Select_At_Attach and can be modified to other values.
SSH Secure shell. SNMPv2c SNMPv2 community string. Type : enum (SSH, SNMPv2c) PhysicalSwitchPurposeEnum Physical switch purpose in network. Possible purposes are: Data_and_Management Physical switch for all data and management networks. Management_Only Physical switch for management network only. Type : enum (Data_and_Management, Management_Only) PolicyTypeEnum Supported policy types. Protection A protection policy, consisting of snapshot and replication rules.
Mutual Enabled for initiator and target authentication. Type : enum (Disabled, Single, Mutual) RemoteSystemLatencyEnum Network latency choices for a remote system. Replication traffic can 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.
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 session created on a volume. * volume_group - Replication session created on a volume group.
Paused User paused the replication session. Paused_For_Migration Migration paused the replication session. Paused_For_NDU A non-disruptive upgrade paused the replication session. Resuming The replication session is resuming operation. The status changes to OK after the replication session is resumed. Failing_Over A planned failover is in progress. The status changes to Failed_Over after the replication session has failed over. Failing_Over_For_DR An unplanned failover is in progress.
ResourceTypeEnum Resource Type for the given resource.
Programs Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None Prevents clients from storing documents and programs in offline cache (default). Type : enum (Manual, Documents, Programs, None) SasPortSpeedEnum SAS port transmission speed.
ScSnapshotProfileTypeEnum Available SC snapshot profile types. Valid values are: Standard Takes snapshots in series for all volumes associated with the snapshot. Parallel Takes snapshots simultaneously for all volumes associated with the snapshot. Consistent Halts IO and takes snapshots for all volumes associated with the snapshot. Unknown SC snapshot profile type is unknown to PowerStore. Type : enum (Standard, Parallel, Consistent, Unknown) SeverityEnum Possible severities.
Install_Failed Installing the package failed. Download_Failed Downloading the package failed. Type : enum (Available, Downloaded, Installing, Installed, Install_Failed, Download_Failed) SoftwarePackageTypeEnum Software package type. Valid values are: Software_Release A package 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.
SupportedImportTypeEnum Supported import types for the source storage system. Values are: Agentless The source array supports only agentless import. Non_Disruptive_And_Agentless The source array supports both nondisruptive and agentless import. Not_Supported The source array does not support import.
Discovery_Authentication_Failure Authentication failure during discovery of target IP. Discovery_Connection_Refused Connection was refused during discovery of target IP. Discovery_Timeout Discovery of target IP timed out.
Unknown The status of the system cannot be determined. Ok The system is operating normally. Ok_But The system is operating normally but there are potential issues. Degraded The system is working, but performance may not be optimum. Minor The system is working, but it has experienced one or more minor failures. Major The system is failing; some or all of its functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately.
default 0) Nth_Day_Of_Month_AT_HHMM Create a snapshot on the selected {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, SelDays_At_HHMM, Nth_Day_Of_Month_AT_HHMM, Unsupported, Unknown) UnityScheduleVersionEnum Type of snapshot schedule.
The volume is migrated. Aborted Volume migration is cancelled. Not_Applicable Volume migration state is not applicable if the system only supports agentless import. Unknown The volume migration state is unknown to PowerStore. Type : enum (Normal, Source_Migration_In_Progress, Prepare_For_Migration, Source_Migration_Completed, Source_Disabled_For_IO, Source_Migration_Aborted, Unknown) UnityVolumeTypeEnum Type of the Unity volume. Values are: Unknown Volume type cannot be determined.
VirtualMachineStatusEnum General health status of the VM in vCenter. Not applicable to VM snapshots. 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. Template A VM template. Snapshot A snapshot of a VM.
VnxVolumeMigrationStateEnum Migration state of the VNX volume. Values are: * None - The volume is not migrated. * Prepared The volume is ready for migration. * Disabled_For_IO - Host I/O is disabled on the volume. * In_Progress - Volume migration is in progress. * Completed - The volume is migrated. * Aborted Volume migration is cancelled. * Not_Applicable - Volume migration state is not applicable if the system only supports agentless import. * Unknown - The volume migration state cannot be determined.
The volume is ready for agentless import. In_Progress Import is in progress. Host_Not_Added The host or hosts accessing the volume have not been added to the appliance. Imported Import is complete. Incompatible_Firmware The software version on the source array is not compatible. Incompatible_Host_Agent The 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.
SC_Portable_Volume The Storage Center volume is a destination of a portable volume. VNX_Faulted The VNX volume is in a faulted state. VNX_Not_Ready The VNX volume is not in a ready state. VNX_Internal_Volume The VNX volume is an internal volume. Unity_System_Health_Inappropriate The health of the Unity system is not suitable for import. Unity_Volume_Health_Inappropriate The health of the Unity volume is not suitable for import.
Offline Volume is not available. Destroying Volume is being deleted. No new operations are allowed. Type : enum (Ready, Initializing, Offline, Destroying) VolumeStatusEnum Status of the import host volume. Valid values are: Unknown Volume status is unknown. Online Volume is online. Offline Volume is offline. Type : enum (Unknown, Online, Offline) VolumeTypeEnum Type of volume. Primary A base object. Clone A read-write object that shares storage with the object from which it is sourced.
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.
There is certainty that the XMS is synchronized. Add_Pending XMS is uncertain whether an add request was executed on XtremIO storage system. Modify_Pending XMS is uncertain whether a modify request was executed on XtremIO storage system. Remove_Peding XMS is uncertain whether a remove request was executed on XtremIO storage system. Unknown The certainty is unknown to PowerStore. Type : enum (Ok, Add_Pending, Modify_Pending, Remove_Pending, Unknown) XtremIODurationUnitEnum Duration unit.
The highest severity for this entity and all contained/members is Major. Critical The highest severity for this entity and all contained/members is Critical. * Unknown - The severity is unknown to PowerStore Type : enum (Clear, Information, Minor, Major, Critical, Unknown) XtremIOPlatformEnum XtremIO hardware platform. Values are: X1 X1 hardware platform. X2 X2 hardware platform. Type : enum (X1, X2) XtremIOScheduleStateEnum Indicates whether the Schedule is currently enabled or disabled, by the user.
Type : enum (Explicit, Interval, Unknown) XtremIOStateEnum State of XtremIO storage system. Active XtremIO system is in active state. Start XtremIO system is in start state. Configured XtremIO system is configured but not yet active. Initializing XtremIO system is initializing. Stopping XtremIO system is executing a stop command. Stopped XtremIO system is in stopped state. Starting XtremeIO system is starting. Failed XtremIO system is in failed state. Down XtremIO system is down.
Name appliance_id optional bond_id optional eth_port_id optional fc_port_id optional Description Schema Unique identifier of the appliance containing the session. string Unique identifier of the bond the initiator is logged into. Null if one of the following is non-null: veth_id, eth_port_id string or fc_port_id. Unique identifier of the Ethernet port the initiator is logged into. Null if one of the following is non-null: bond_id, string veth_id or fc_port_id.
Name Description Schema Timestamp of the event that cleared this alert. string (date-time) Latest event’s description text for this alert. string cleared_times tamp optional description_l1 0n optional email_sent_ti mestamp optional event_code optional Timestamp when the email was sent for the raised alert, if any. The event code of the latest event for this alert. string (date-time) string events List of events associated with this alert.
Name Description Schema Localized message string corresponding to resource_type string Severity of the latest event for this alert. SeverityEnum Localized message string corresponding to severity string resource_type _l10n optional severity optional severity_l10n optional state AlertStateEnum optional state_l10n optional Localized message string corresponding to state string alert_modify Alert modify request body.
Name Description Schema Estimate for the upper bound forecasted value on that high_value particular time. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the lower bound forecasted value on that low_value particular time. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the mean forecasted value on that particular mean_value time.
Name ip_pool_addre sses optional maintenance_ windows optional model optional Description Schema This is the inverse of the resource type ip_pool_address association. This is the inverse of the resource type maintenance_window association. Model of the appliance. Name of the appliance.
Name name required Description Schema New name of the appliance. string appliance_time_to_full Name Schema metric_type ForecastMetricTypeEnum required appliance_time_to_full_response Name appliance_id optional end_of_foreca st optional Description Schema Unique ID of appliance. string Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends.
audit_event_instance Name Description appliance_id Unique identifier of the appliance where the event optional occurred. client_address FQDN/IP Address of the client from where the event was optional id optional is_successful optional initiated. Schema string string (ip-address) Unique identifier of the audit log entry. string Whether the event was successful or not. boolean job_id Unique identifier of the job associated with the audit event optional (if any).
Name Description Schema IP Address on which the request was targeted. string (ip-address) Time the event occurred to one second precision. string (date-time) server_addres s optional timestamp optional type AuditEventTypeEnu optional m type_l10n optional Localized message string corresponding to type username Fully qualified name of the user who initiated the event to optional be audited. For example, domain_name/name.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional 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 CopySessionTypeEn optional um session_type_l 10n Localized message string corresponding to session_type string End of sampling period.
Name Description Schema Time (in milliseconds) spent doing reads during this read_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name Description data_transfer Number of bytes transferred during this sampling period. red Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) Time (in milliseconds) spent doing reads during this read_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 remote_syste m_id Unique identifier of the remote system.
base_copy_metrics_by_vg Cluster wide copy metrics for the volume group. Name data_remaini ng optional Description Schema Number of bytes remaining to be copied at the end of this sampling period. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 data_transfer Number of bytes transferred during this sampling period.
Name Description Schema Time (in milliseconds) spent doing writes during this write_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 base_copy_metrics_by_volume Cluster wide copy metrics for the volume. Name data_remaini ng optional Description Schema Number of bytes remaining to be copied at the end of this sampling period.
Name Description Schema The time (in milliseconds) spent in copy activity during this transfer_time sampling period. optional integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 volume_id optional Unique identifier of the volume. string Time (in milliseconds) spent doing writes during this write_time sampling period.
Name io_workload_c pu_utilization optional Description The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests. Schema number (float) read_bandwid th Read rate in bytes per second. number (float) Total read operations per second. number (float) optional read_iops optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
Name avg_io_size optional Description Schema Average size of read 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 tion time interval across appliance. Derived from an average of optional utilization across all nodes within the appliance. avg_latency optional number (float) Weighted average latency in microseconds.
Name avg_write_size optional max_avg_io_si ze optional Description Schema Weighted average write size in bytes. number (float) Maximum average size of input and output operations in bytes. number (float) max_avg_late ncy Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name Description Schema Maximum totals per second. number Maximum write bandwith in bytes per second. number (float) Maximum writes per second. number (float) max_total_iop s optional max_write_ba ndwidth optional max_write_io ps optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
Name avg_write_size optional cluster_id optional Description Schema Average write size in bytes. number (float) Identifier of the cluster. string Read rate in bytes per second. number (float) Total number of read operations per second. number (float) read_bandwid th optional read_iops optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
Name avg_latency optional Description Schema Weighted average latency in microseconds. number (float) Weighted average read bandwidth in bytes per second. number (float) Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second.
Name max_avg_io_si ze optional Description Maximum average size of input and output operations in bytes. Schema number (float) max_avg_late ncy Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum read bandwidth in bytes per second.
Name Description Schema Maximum writes per second. number (float) max_write_io ps optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) base_performance_metrics_by_fe_eth_node Ethernet performance metrics for the node collected at twenty second interval.
Name pkt_tx_ps optional repeat_count optional timestamp optional Description Schema The number of packets transmitted per second. number (float) Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) base_performance_metrics_by_fe_eth_node_rollup Ethernet performance metrics for the node rolled up at various rollup intervals.
Name avg_pkt_tx_ps optional Description Schema The average number of packets transmitted per second. number (float) The maximum total bytes received per second. number (float) The maximum total bytes transmitted per second. number (float) max_bytes_rx _ps optional max_bytes_tx_ ps optional max_pkt_rx_c rc_error_ps optional The maximum number of packets received with CRC error (and thus dropped) per second.
base_performance_metrics_by_fe_eth_port Performance metrics for the frontend ethernet port collected at twenty second interval. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. bytes_rx_ps optional bytes_tx_ps optional Schema The total bytes received per second. number (float) The total bytes transmitted per second. number (float) fe_port_id Reference optional (eth_port) on which these metrics were recorded.
base_performance_metrics_by_fe_eth_port_rollup Performance metrics for the frontend ethernet port rolled up at various rollup intervals. Name Description Schema appliance_id Reference to the associated appliance on which these optional metrics were recorded. string avg_bytes_rx_ ps The average total bytes received per second. number (float) The average total bytes transmitted per second.
Name max_pkt_rx_c rc_error_ps optional Description The maximum number of packets received with CRC error (and thus dropped) per second. Schema number (float) max_pkt_rx_n o_buffer_erro The maximum number of packets discarded per second r_ps due to lack of buffer space. number (float) optional max_pkt_rx_p s The maximum number of packets received per second. number (float) optional max_pkt_tx_e rror_ps optional The maximum number of packets that failed to be transmitted per second due to error.
Name Description Schema Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_write_late ncy optional avg_write_size optional current_login The number of logins to the target from initiators.
Name Description Schema prim_seq_prot _err_count_ps Primitive sequence protocol error count per second. number (float) optional read_bandwid th Read rate in bytes per second. number (float) Total number of read operations by the node. number (float) optional read_iops optional repeat_count optional timestamp Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
Name Description Schema Unaligned write input/output per second. number (float) Write rate in byte/sec. number (float) Total write operations per second. number (float) unaligned_wri te_iops optional write_bandwi dth optional write_iops optional base_performance_metrics_by_fe_fc_node_rollup Fibre channel performance metrics for the node rolled up at various rollup intervals. Name Description Schema avg_current_l Average number of logins to the target from initiators.
Name Description Schema avg_loss_of_si gnal_count_ps Average loss of signal count per second. number (float) optional avg_loss_of_sy nc_count_ps Average loss of sync count per second. number (float) optional avg_prim_seq_ prot_err_coun Average primitive sequence protocol error count per t_ps second. number (float) optional avg_read_ban dwidth Weighted average read bandwidth in bytes per second. number (float) Average reads per second.
Name Description Schema Average unaligned read rate in bytes per second. number (float) Average unaligned read input/output per second. number (float) Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_read _size optional max_avg_writ e_latency optional max_avg_writ e_size optional max_current_ Maximum number of logins to the target from initiators.
Name Description Schema max_prim_se q_prot_err_co The maximum primitive sequence protocol error count per unt_ps second. number (float) optional max_read_ba ndwidth Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second.
Name Description Schema Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) max_unaligne d_write_iops optional max_write_ba ndwidth optional max_write_io ps optional node_id Reference to the associated node on which these metrics optional were recorded. repeat_count optional timestamp optional string Number of times the metrics are repeated.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional current_login The number of logins to the target from initiators. s Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) dumped_fram es_ps Dumped frames per second.
Name Description Schema Read rate in bytes per second. number (float) Total number of read operations by the node. number (float) read_bandwid th optional read_iops optional repeat_count optional timestamp Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second.
Name Description Schema Write rate in byte/sec. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional base_performance_metrics_by_fe_fc_port_rollup Performance metrics for the frontend fibre channel port rolled up at various intervals. Name Description Schema appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_current_l Average number of logins to the target from initiators.
Name Description Schema avg_loss_of_si gnal_count_ps Average loss of signal count per second. number (float) optional avg_loss_of_sy nc_count_ps Average loss of sync count per second. number (float) optional avg_prim_seq_ prot_err_coun Average primitive sequence protocol error count per t_ps second. number (float) optional avg_read_ban dwidth Weighted average read bandwidth in bytes per second. number (float) Average reads per second.
Name Description Schema Average unaligned read rate in bytes per second. number (float) Average unaligned read input/output per second. number (float) Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_read _latency optional max_avg_read _size optional max_avg_writ e_latency optional max_avg_writ e_size optional max_current_ Maximum number of logins to the target from initiators.
Name Description Schema The maximum loss of sync count per second. number (float) max_loss_of_s ync_count_ps optional max_prim_se q_prot_err_co The maximum primitive sequence protocol error count per unt_ps second. number (float) optional max_read_ba ndwidth Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second.
Name Description Schema Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) Reference to the node the port belongs to.
Name avg_size optional Description Schema Average read and write size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the file system. string Read rate in bytes per second. number (float) Total read operations per second.
base_performance_metrics_by_file_system_rollup Summary of file system level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name Description Schema avg_latency Maximum optional microseconds. of average read and write latency in number (float) avg_read_ban dwidth Average read rate in bytes per second. number (float) Average read operations per second. number (float) Maximum of average read latency in microseconds.
Name avg_write_size optional file_system_id optional max_avg_late ncy optional Description Schema Average write size in bytes. number (float) Unique identifier of the file system. string Maximum of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes.
Name Description Schema Maximum write rate in bytes per second. number (float) Maximum write operations per second. number (float) max_write_ba ndwidth optional max_write_io ps optional Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period.
Name node_id optional read_iops optional Description Schema Unique identifier of the node. string Total read operations per second. number (float) Number of consecutive sampling periods during which repeat_count optional 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 optional total_iops optional write_iops optional End of sample period.
Name avg_total_iops optional Description Schema Average read and write operations per second. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) Maximum of average read and write size in bytes.
Name Description Schema Maximum write operations per second. number (float) Unique identifier of the node. string max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period.
Name timestamp optional total_iops optional write_iops optional Description Schema End of sample period. string (date-time) Total read and write iops in microseconds. number (float) Total write iops in microseconds. number (float) base_performance_metrics_by_nfsv3_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 Schema Average failed operations per second.
Name Description Schema Max failed operations per second. number (float) Maximum read operations per second. number (float) Maximum read and write operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name node_id optional read_iops optional Description Schema Unique identifier of the nfs. string Total read iops in microseconds. number (float) Number of consecutive sampling periods during which repeat_count optional 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 optional total_iops optional write_iops optional End of sample period.
Name avg_total_iops optional Description Schema Average read and write operations per second. number (float) Average write operations per second. number (float) Maximum average md latency per second. number (float) Max failed operations per second. number (float) Maximum read operations per second. number (float) Maximum read and write operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_io_size optional avg_latency optional Schema string Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name repeat_count optional timestamp Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second.
base_performance_metrics_by_node_rollup Summary of node level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_current_l Average number of logins to the target from initiators.
Name Description Schema Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second. number (float) Average unaligned read rate in bytes per second. number (float) Average unaligned read input/output per second. number (float) Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second.
Name Description Schema Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name Description Schema Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second.
base_performance_metrics_by_smb_cache Performance metrics for the smb cache collected at twenty second interval. Name Description Schema Average hash latency. number (float) Average hash size. number (float) Max hash latency. number (float) Max hash size. number (float) Min hash latency. number (float) Max hash size. number (float) Max used threads number (float) Unique identifier of the node.
Name Description Schema Total rejected task. number (float) Total tasks. number (float) total_rejected _tasks optional total_tasks optional 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 Schema Average hash latency. number (float) Average hash size. number (float) Average max hash latency.
Name Description Schema Max used threads number (float) Unique identifier of the node. string max_used_thr eads optional node_id optional Number of consecutive sampling periods during which repeat_count optional 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 optional End of sample period. string (date-time) Total rejected task.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second. number (float) avg_write_late ncy optional avg_write_size optional node_id optional read_iops optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name avg_latency optional Description Schema Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second.
base_performance_metrics_by_smb_node_rollup Summary of smb node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second.
base_performance_metrics_by_smb_v1_builtin_client Performance metrics for the smb v1 client collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name write_iops optional Description Schema Total write operations per second. number (float) 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 avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes.
Name max_avg_late ncy optional Description Maximum Schema of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period. string (date-time) base_performance_metrics_by_smb_v1_node Performance metrics for the smb v1 node collected at twenty second interval.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional 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 optional total_calls optional total_iops optional write_iops optional End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second.
Name avg_read_size optional Description Schema Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_iop s optional avg_write_late ncy optional avg_write_size optional max_avg_late ncy optional Maximum of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds.
Name Description Schema Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_read_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_write_size optional node_id optional read_iops optional Description Schema Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second. number (float) Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_latency optional avg_read_iops optional Description Schema Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name Description Schema Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second.
Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes.
Name Description Schema Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
base_performance_metrics_by_vg Performance metrics for the volumes in a volume group collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name vg_id optional Description Schema Unique identifier representing a volume group. string Write rate in byte/sec. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional base_performance_metrics_by_vm Performance metrics for the virtual machine collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unique identifier representing a specific virtual machine. string Write rate in byte/sec. number (float) Total write operations per second.
Name Description Schema Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second.
base_performance_metrics_by_volume Performance metrics for the volume collected at twenty second interval. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_io_size optional avg_latency optional Schema string Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes.
Name total_iops optional volume_id optional Description Schema Total read and write operations per second. number (float) Unique identifier representing a specific volume. string Write rate in byte/sec. number (float) Total write operations per second.
Name Description Schema Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write size in bytes. number (float) Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second.
Name Schema response_type string required base_space_metrics_by_appliance Space metrics for the appliance collected at five minute interval. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. data_physical _used optional data_reductio n optional Schema string This metric represents amount of physical space user data occupies after deduplication and compression.
Name Description Schema Total combined space on the physical drives of the physical_total appliance available for data. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Total physical space consumed in the appliance, accounting physical_used for all efficiency mechanisms, as well as all data protection. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
Name Description Schema appliance_id Reference to the associated appliance on which these optional metrics were recorded. last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 string integer (int64) last_data_red uction Last data reduction space during the period. number (float) Last efficiency ratio during the period.
Name Description Schema 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 uction Maximum data reduction space during the period. number (float) Maximum efficiency ratio during the period. number (float) optional max_efficienc y_ratio optional max_logical_p Maxiumum logical total space during the period.
Name timestamp optional Description Schema End of sample period. string (date-time) base_space_metrics_by_cluster Space metrics for the cluster collected at five minute interval. Name cluster_id optional data_physical _used optional data_reductio n optional Description Schema Identifier of the cluster. string This metric represents total amount of physical space user data occupies after deduplication and compression.
Name Description Schema The total combined space on the physical drives of the physical_total cluster available for data. optional integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 The physical_used optional total physical space consumed in the cluster, accounting for all efficiency mechanisms, as well as all data protection.
Name cluster_id optional Description Schema Identifier of the cluster. string last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_data_red uction Last data reduction space during the period. number (float) Last efficiency ratio during the period. number (float) optional last_efficiency _ratio optional last_logical_pr Last logical total space during the period.
Name Description Schema 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 uction Maximum data reduction space during the period. number (float) Maximum efficiency ratio during the period. number (float) optional max_efficienc y_ratio optional max_logical_p Maximum logical total space during the period.
Name timestamp optional Description Schema End of sample period. string (date-time) base_space_metrics_by_storage_container Space metrics of storage container aggregated from all appliances collected at five minute interval. Name logical_provis ioned optional Description Schema Total configured size in bytes of the primary and clone virtual volumes within the storage container.
Name Description Schema last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snapshot_ savings Last snapshot savings during the period. number (float) optional max_logical_p Maximum logical provisioned space during the period.
Name logical_provis ioned optional Description Schema Total configured size in bytes of all member volumes in a volume group. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 Total amount of data in bytes written to all member logical_used volumes in a volume group. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
base_space_metrics_by_vg_rollup Summary of volume group level space metric data for one hour or one day period beginning with timestamp, including the maximum and final values for that period. Name Description Schema last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period.
Name Description Schema Max thin savings ratio during the period. number (float) max_thin_savi ngs optional repeat_count optional timestamp optional vg_id optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Unique identifier representing a specific volume group. string base_space_metrics_by_vm Space metrics for the VM collected at five minute interval.
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 of vVols used by virtual ngs machine. For example, a vVol is provisioned as 1 GB and it number (float) optional has two snapshots. Each snapshot has 200 MB of data. Snapshot savings will be (1 GB + 1 GB) / (0.2 GB + 0.2 GB) or 5:1. The snapshot_savings value will be 5 in this case.
Name Description Schema Last snapshot savings space during the period. number (float) Last thin savings ratio during the period. number (float) last_snapshot_ savings optional last_thin_savi ngs optional last_unique_p Last unique physical used space during the period. hysical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_p Max logical provisioned space during the period.
Name vm_id optional Description Schema Unique identifier representing a specific virtual machine. string base_space_metrics_by_volume Space metrics for the volume collected at five minute interval. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. Schema 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.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. family_id optional Schema ID of the family. string 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.
Name timestamp optional Description Schema End of sample period. string (date-time) 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.
Name Description Schema last_unique_p Last unique physical used space during the period. hysical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Max logical used space during the period.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. Schema string last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_thin_savi ngs Last thin savings ratio during the period.
Name Description Schema drive_id Reference to the associated drive which these metrics were optional recorded. string percent_endu rance_remain ing The percentage of drive wear remaining. number (float) optional repeat_count optional timestamp optional Number of times the metrics is repeated. integer (int32) Minimum value : 0 Maximum value : 2147483647 End of sample period.
Name Description Schema Maximum Transmission Unit (MTU) packet size that the mtu bond can transmit, in bytes. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 name Bond name. optional filtering This property supports case-insensitive string chap_config_instance Name id optional Description Schema Unique id of the CHAP config settings instance (always "0").
Name initiator_sessi on_password optional initiator_sessi on_username optional target_discove ry_password optional target_discove ry_username optional target_session _password optional target_session _username optional Description Schema Password used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only. Username used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only.
Name Description Schema Estimate of the lower bound of the 95% confidence interval low_value for the forecast value at the given timestamp. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the mean forecast value at the given mean_value timestamp. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 timestamp optional Timestamp when the forecast was performed.
Name Description Schema The id of the appliance acting as master. string The name of the cluster. string master_applia nce_id optional name optional The physical ethernet port (eth_port resource) MTU setting, global for all ports in the cluster.
cluster_time_to_full Name Schema metric_type ForecastMetricTypeEnum required cluster_time_to_full_response Name cluster_id optional end_of_foreca st optional Description Schema Unique ID of the cluster. string Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends. In this case the end of the forecast can be used as a minimum for time to full.
Name Description host_ids Hosts to be mapped to the destination volume group optional member volume for an agentless import session. volume_wwn optional Schema WWN of the source consistency group member volume. < string > array string copy_metrics_by_appliance Copy metrics for the appliance. Polymorphism : Inheritance Discriminator : entity Name appliance_id optional data_remaini ng optional Description Schema Unique identifier of the appliance.
Name Description Schema Localized message string corresponding to session_type string End of sampling period. string (date-time) session_type_l 10n optional timestamp optional transfer_rate Data transfer rate (in bytes/second) computed using optional data_transferred and transfer_time. number (float) The time (in milliseconds) spent in copy activity during this transfer_time sampling period.
Name Description Schema Time (in milliseconds) spent doing reads during this read_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
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 : 9223372036854775807 data_transfer Number of bytes transferred during this sampling period. red Minimum value : 0 optional Maximum value : 9223372036854775807 entity integer (int64) string required Time (in milliseconds) spent doing reads during this read_time sampling period.
Name Description Schema Time (in milliseconds) spent doing writes during this write_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 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.
Name timestamp optional Description Schema End of sampling period. string (date-time) transfer_rate Data transfer rate (in bytes/second) computed using optional data_transferred and transfer_time. number (float) The time (in milliseconds) spent in copy activity during this transfer_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 vg_id optional Unique identifier of the volume group.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional 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 CopySessionTypeEn optional um session_type_l 10n Localized message string corresponding to session_type string End of sampling period.
data_connection_instance Data connection status between the local node and a remote target. Name Description Schema Initiating address from the local node. string (ip-address) Unique identifier of the local, initiating node. string initiator_addr ess optional node_id optional status optional status_l10n optional Status of the data connection. TransitConnectionSt atusEnum Localized message string corresponding to status string Target address from the remote system.
Name id optional Description Schema Unique identifier of the DNS setting. string dns_modify Name addresses required Description Schema < string (ip-address) DNS server addresses in IPv4 or IPv6 format. > array email_notify_destination_create Name email_address required notify_critical optional notify_info optional notify_major optional notify_minor optional Description Schema Email address to receive notifications. string Whether to send notifications for critical alerts.
Name notify_info optional notify_major optional notify_minor optional Description Schema Whether to send notifications for informational alerts. boolean Whether to send notifications for major alerts. boolean Whether to send notifications for minor alerts. boolean email_notify_destination_modify Name email_address optional notify_critical optional notify_info optional notify_major optional notify_minor optional Description Schema Email address to receive notifications.
error_message Error message for an operation. Name arguments optional code optional Description Schema Arguments (if applicable) for the error message. < string > array Hexadecimal error code of the message. string message_l10n The message description in the specified locale with optional arguments substituted. string severity MessageSeverityEnu optional m error_response Error response for an operation. Contains an array of localized messages.
eth_port_instance This resource type has queriable associations from ip_port, appliance, hardware, bond, eth_port Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional bond optional The id of the appliance containing the port. Schema appliance_instance string This is the embeddable reference form of bond_id attribute.
Name hypervisor_vs witch_name optional id optional Description Schema Name of the virtual switch associated with the hypervisor port. This property supports case-insensitive filtering Ethernet port instance identifier. string io_module This is the embeddable reference form of io_module_id optional attribute. io_module_id Unique identifier of the hardware instance of type optional 'IO_Module' handling the port.
Name partner_id optional Description Schema Unique identifier of the partner port instance. string port_connecto FrontEndPortConne r_type ctionTypeEnum optional port_connecto r_type_l10n optional port_index optional Localized message string corresponding to port_connector_type string The index of the Ethernet port in IO module.
event_instance An event indicates that something of interest happened in the system. Normally, an event that requires attention will generate an alert as well. So, although they may be interesting for troubleshooting, it is not necessary to monitor events. Name Description Schema Description of this event. string Identifies the specific kind of event that has occurred. string Timestamp at which this event occured. string (date-time) Unique identifier of this occurrence of an event.
Name Description Schema Describes the possible effect on the system of this event. string system_impac t_l10n optional fc_port_instance This resource type has queriable associations from appliance, hardware, fc_port Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional Unique identifier of the appliance containing the port.
Name node optional Description Schema This is the embeddable reference form of node_id attribute. hardware_instance node_id Unique identifier of the hardware instance of type 'Node' optional containing the port. partner This is the embeddable reference form of partner_id optional attribute. partner_id optional Unique identifier of the partner port.
Name supported_sp eeds_l10n optional wwn optional Description Localized Schema message array corresponding to supported_speeds World Wide Name (WWN) of the port. < string > array string fc_port_modify Name Schema requested_speed required FcPortSpeedEnum file_dns_create Name Description Schema Name of the DNS domain, where the NAS Server does host domain names lookup when an FQDN is not specified in the required request.
Name id optional Description Schema Unique identifier of the DNS server. string ip_addresses The list of DNS server IP addresses. The addresses may be < string (ip-address) optional IPv4 or IPv6. nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional > array nas_server_instance Unique identifier of the associated NAS Server instance that uses this DNS object. Only one DNS object per NAS Server is string supported.
file_ftp_create Name Description Schema (Applies when the value of is_audit_enabled is true.) audit_dir optional Directory of FTP/SFTP audit files. Logs are saved in '/' directory (default) or in a mounted file system (Absolute string path of the File system directory which should already exist). (Applies when the value of is_audit_enabled is true.) Maximum size of all (current plus archived) FTP/SFTP audit files, in bytes. There is a maximum of 5 audit files, 1 current audit file (ftp.
Name Description Schema Indicates whether the groups attribute contains allowed or is_allowed_gr denied user groups. Values are: - true - groups contains oups allowed user groups. - false - groups contains denied user boolean optional groups. Default : true is_allowed_ho sts optional is_allowed_us ers optional Indicates whether the hosts attribute contains allowed or denied hosts. Values are: true - hosts contains allowed hosts. false - hosts contains denied hosts.
Name Description Indicates is_smb_authe ntication_ena bled optional Schema 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 user names are accepted for authentication. false - SMB user names are not accepted for authentication.
Name Description Schema (Applies when the value of is_audit_enabled is true.) audit_dir optional Directory of FTP/SFTP audit files. Logs are saved in '/' directory (default) or in a mounted file system (Absolute string path of the File system directory which should already exist). (Applies when the value of is_audit_enabled is true.) Maximum size of all (current plus archived) FTP/SFTP audit files, in bytes. There is a maximum of 5 audit files, 1 current audit file (ftp.log) and 4 archived audit files.
Name Description Schema Indicates whether the groups attribute contains allowed or is_allowed_gr denied user groups. Values are: - true - groups contains oups allowed user groups. - false - groups contains denied user boolean optional groups. Default : true is_allowed_ho sts optional is_allowed_us ers optional Indicates whether the hosts attribute contains allowed or denied hosts. Values are: true - hosts contains allowed hosts. false - hosts contains denied hosts.
Name Description Indicates is_smb_authe ntication_ena bled optional Schema 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 user names are accepted for authentication. false - SMB user names are not accepted for authentication.
Name Description add_groups Groups to add to the current groups. Error occurs if the optional group already exists. Cannot be combined with groups. add_hosts optional Host IP addresses to add to the current hosts. The addresses may be IPv4 or IPv6. Error occurs if the IP address already exists. Cannot be combined with hosts. add_users Users to add to the current users. Error occurs if the user optional already exist. Cannot be combined with users.
Name Description Schema Allowed or denied hosts, depending on the value of the is_allowed_hosts attribute. A host is defined using its IP address. Subnets using CIDR notation are also supported. hosts optional If allowed hosts exist, only those hosts and no others can connect to the NAS server through FTP or SFTP. - If denied hosts exist, they always have access denied to the NAS < string (ip-address) > array server through FTP or SFTP.
Name Description Schema Indicates whether an FTP or SFTP user access is limited to is_homedir_li the home directory of the user. Values are: - true - An FTP mit_enabled or SFTP user can access only the home directory of the boolean optional user. - false - FTP and SFTP users can access any NAS server directory, according to NAS server permissions. Indicates whether the SFTP server is enabled on the NAS is_sftp_enable server specified in the nasServer attribute.
Name Description Schema Allowed or denied users, depending on the value of the is_allowed_users attribute. - If allowed users exist, only users optional those users and no others can connect to the NAS server through FTP or SFTP. - If denied users exist, they always < string > array have access denied to the NAS server through FTP or SFTP. If the list is empty, there is no restriction to the NAS server access through FTP or SFTP based on the user name.
Name Description Schema Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets vlan_id that have matching VLAN tags. optional Default : 0 integer (int32) Minimum value : 0 Maximum value : 4094 file_interface_instance This resource type has queriable associations from nas_server, file_interface_route Name file_interface_ routes optional Description This is the inverse of the resource type file_interface_route association.
Name Description Schema role FileInterfaceRoleEn optional um role_l10n optional Localized message string corresponding to role string Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets vlan_id that have matching VLAN tags. optional Default : 0 integer (int32) Minimum value : 0 Maximum value : 4094 file_interface_modify Attributes for the modify operation.
file_interface_route_create Name Description Schema IPv4 or IPv6 address of the target network node based on the specific route type. Values are: destination optional • For a default route, there is no value because the system will use the specified gateway IP address. string (ip-address) • For a host route, the value is the host IP address. • For a subnet route, the value is a subnet IP address. file_interface_ id Unique identifier of the associated file interface.
Name gateway optional Description Schema IP address of the gateway associated with the route. string (ip-address) Unique identifier of the file interface route. string id optional read-only operational_st FileInterfaceRouteO atus perationalStatusEnu optional m operational_st atus_l10n optional prefix_length optional Localized message string corresponding to operational_status string IPv4 or IPv6 prefix length for the route.
Name kdc_addresses required nas_server_id required Description Schema Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses < string > array are not supported. Unique identifier of the associated NAS Server instance that uses this Kerberos object. Only one Kerberos object per NAS string Server is supported. KDC servers TCP port.
file_kerberos_modify Name Description Schema Fully Qualified domain names of the Kerberos Key add_kdc_addr Distribution Center (KDC) servers to add to the current list. esses Error occurs if name already exists. Cannot be combined < string > array optional with kdc_addresses. IPv4 and IPv6 addresses are not supported. kdc_addresses optional Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses < string > array are not supported.
Name Description Schema Name of the LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the base_DN required LDAP directory tree to begin a search for information. The base DN can be expressed as a fully-qualified domain name string or in X.509 format by using the attribute dc=. For example, if the fully-qualified domain name is mycompany.com, the base DN is expressed as dc=mycompany,dc=com.
Name Description Schema The TCP/IP port used by the NAS Server to connect to the port_number optional LDAP servers. The default port number for LDAP is 389 and LDAPS is 636. integer (int32) Minimum value : 0 Maximum value : 65536 principal Specifies the principal name for Kerberos authentication. optional Length : 0 - 1023 profile_DN optional string For an iPlanet LDAP server, specifies the DN of the entry with the configuration profile.
Name bind_DN optional Description Schema Bind Distinguished Name (DN) to be used when binding. string Unique identifier of the LDAP service object. string id optional read-only is_certificate_ Indicates whether an LDAP certificate file has been uploaded uploaded. optional Default : false boolean is_config_file_ Indicates whether an LDAP configuration file has been uploaded uploaded.
Name Description Schema The TCP/IP port used by the NAS Server to connect to the port_number optional LDAP servers. The default port number for LDAP is 389 and LDAPS is 636. integer (int32) Minimum value : 0 Maximum value : 65535 principal optional Specifies the principal name for Kerberos authentication. profile_DN For an iPlanet LDAP server, specifies the DN of the entry optional with the configuration profile.
Name Description Schema Name of the LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the base_DN optional LDAP directory tree to begin a search for information. The base DN can be expressed as a fully-qualified domain name string or in X.509 format by using the attribute dc=. For example, if the fully-qualified domain name is mycompany.com, the base DN is expressed as dc=mycompany,dc=com.
Name Description principal Specifies the principal name for Kerberos authentication. optional Length : 0 - 1023 profile_DN optional Schema string For an iPlanet LDAP server, specifies the DN of the entry with the configuration profile. string Length : 0 - 255 protocol FileLDAPProtocolEn optional um realm Specifies the realm name for Kerberos authentication. optional Length : 0 - 255 remove_addre sses optional string IP addresses to remove from the current server IP addresses list.
Name Description nas_server_id Unique identifier of the NAS server to be configured with optional user_name optional these NDMP settings. User name for accessing the NDMP service. Schema string string file_ndmp_modify Name password optional user_name optional Description Schema Password for the NDMP service user. string (password) User name for accessing the NDMP service. string file_nis_create Name Description domain Name of the NIS domain.
Name ip_addresses optional Description Schema < string (ip-address) The list of NIS server IP addresses. > array nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional nas_server_instance 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_modify Name Description Schema add_ip_addres IP addresses to add to the current list.
Name Description Schema Indicates whether asynchronous MTIME is enabled on the file system. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system. Indicates whether notifications of changes to directory file structure are enabled. is_smb_no_not true ify_enabled Change directory notifications are disabled. optional boolean false Change directory notifications are enabled.
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable true d optional Synchronous writes option is enabled on the file system. boolean false Synchronous writes option is disabled on the file system. locking_policy FileSystemLockingP optional olicyEnum name Name of the clone.
Name Description Schema Indicates whether asynchronous MTIME is enabled on the file system or protocol snaps that are mounted writeable. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system. Default : false Indicates whether notifications of changes to directory file structure are enabled. is_smb_no_not true ify_enabled optional Change directory notifications are disabled.
Name Description Schema Indicates whether 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. boolean false Opportunistic file locking is disabled on the file system. Default : true Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable d optional true Synchronous writes option is enabled on the file system.
file_system_instance This resource type has queriable associations from nas_server, policy, file_tree_quota, file_user_quota, nfs_export, smb_share Name Description Schema access_policy FileSystemAccessPol optional icyEnum access_policy_ l10n Localized message string corresponding to access_policy string optional access_type FileSystemSnapshot optional AccessTypeEnum access_type_l1 0n Localized message string corresponding to access_type string Time, in seconds, when the snapshot
Name Description Schema Time, in seconds, when the snapshot will expire. string (date-time) expiration_ti mestamp optional file_tree_quot as optional file_user_quot as optional This is the inverse of the resource type file_tree_quota association. < file_tree_quota_insta nce > array This is the inverse of the resource type file_user_quota association.
Name Description Schema Indicates whether asynchronous MTIME is enabled on the file system. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system. is_modified optional Indicates whether the snapshot may have changed since it was created. Values are: true - Snapshot is or was shared boolean with read/write access. false - Snapshot was never shared. Indicates whether quota is enabled.
Name Description Schema Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena true bled optional File writes notification are enabled on the file system. boolean false File writes notifications are disabled on the file system. Indicates whether opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled Opportunistic file locking is enabled on the file system.
Name Description nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional Schema Id of the NAS Server on which the file system is mounted. string nfs_exports This is the inverse of the resource type nfs_export optional association. parent_id optional protection_po licy optional nas_server_instance < nfs_export_instance > array The object id of the parent of this file system (only applies to clones and snapshots).
Name Description Schema access_policy FileSystemAccessPol optional icyEnum Default hard limit of user quotas and tree quotas (bytes). The hard limit value is always rounded up to match the file default_hard_ system’s physical block size. (0 means 'No limitation'. This limit value can be used to compute the amount of space integer (int64) optional consumed without limiting the space). Minimum value : 0 Maximum value : 9223372036854775807 Default soft limit of user quotas and tree quotas (bytes).
Name Description Schema Indicates whether asynchronous MTIME is enabled on the file system or protocol snaps that are mounted writeable. Values are: is_async_MTi me_enabled optional true boolean Asynchronous MTIME is enabled on the file system. false Asynchronous MTIME is disabled on the file system. Indicates whether quota is enabled. Quotas are not supported for read-only file systems.
Name Description Schema Indicates whether notifications on file writes are enabled on the file system. Values are: is_smb_notify _on_write_ena true bled optional File writes notifications are enabled on the file system. boolean false File writes notifications are disabled on the file system. Indicates whether opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled Opportunistic file locking is enabled on the file system.
file_system_restore Name Description Schema Name of the backup snap to be created before the Restore copy_name operation occurs. If no name is specified no backup copy optional will be made. string Length : 1 - 255 file_system_restore_response File system backup snapshot created. Name id optional Description Schema The id of the created snapshot.
Name Description Schema Indicates whether asynchronous MTIME is enabled on the protocol snaps that are mounted writeable. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system. Indicates whether the snapshot can be automatically deleted per threshold settings. Values are: is_auto_delete true _enabled Snapshot can be automatically deleted per threshold boolean optional settings.
Name Description Schema Indicates whether opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled Opportunistic file locking is enabled on the file system. optional boolean false Opportunistic file locking is disabled on the file system. Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable true d optional Synchronous writes option is enabled on the file system.
Name description optional file_system_id required Description Schema Description of the tree quota. string Unique identifier of the associated file system. string Hard limit of the tree quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space hard_limit optional that is consumed without limiting the space. Value is always rounded up to match the physical block size of the integer (int64) filesystem.
Name file_user_tree _quotas optional Description This is the inverse of the resource type file_user_quota association. Schema < file_user_quota_inst ance > array Hard limit of the tree quota, in bytes. No hard limit when hard_limit optional set to 0. This value can be used to compute amount of space that is consumed without limiting the space. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 id optional Unique identifier of the tree quota.
file_tree_quota_modify Name description optional Description Schema Description of the tree quota. string Hard limit of the tree quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space hard_limit optional that is consumed without limiting the space. Value is always rounded up to match the physical block size of the integer (int64) filesystem.
Name Description Schema Soft limit of the user quota, in bytes. No hard limit when set soft_limit optional to 0. Value is rounded up to match the physical block size of the filesystem. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 tree_quota_id Unique identifier of the tree quota in which the new user optional quota will be created. uid optional unix_name optional windows_nam e optional string Unix user identifier (UID) of the user. Preferred identifier.
Name Description Schema Unique identifier of the user quota. string id optional read-only Remaining grace period, in seconds, after the soft limit is exceeded: - 0 - Grace period has already expired - -1 - No remaining_gr grace period in-progress, or infinite grace period set The ace_period grace period of user quotas is set in the file system quota integer (int32) optional configuration.
Name windows_nam e optional windows_sid optional Description Windows username. The format is domain\user for the domain user. Windows Security Identifier of the user. Schema string string file_user_quota_modify Name Description Schema 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 hard_limit optional that is consumed without limiting the space.
Name Description Schema is_config_file_ Indicates whether a virus checker configuration file has uploaded been uploaded. optional Default : false boolean Indicates whether the anti-virus service is enabled on this NAS server. Value are: - true - Anti-virus service is enabled. Each file created or modified by an SMB client is scanned by the third-party anti-virus servers. If a virus is detected, is_enabled the access to the file system is denied.
Name Description Schema An alpha-numeric string that can be found on the physical psid label of the drive to repurpose. This is needed to validate required that the user has physical control of the drive before string performing the operation. hardware_extra_details_instance Additional hardware details that are specific to each hardware type. Filtering on the fields of this embedded resource is not supported. Name Description Schema Bus number of the Expansion_Shelf.
Name Description Schema Localized message string corresponding to drive_type string drive_type_l10 n optional enclosure_nu mber optional Enclosure number of the Expansion_Shelf. Available on the Expansion_Shelf hardware type.
Name physical_mem ory_size_gb optional Description Schema Total amount of physical memory in gigabytes. Available on the Node hardware type. integer (int32) Minimum value : 0 Maximum value : 2147483647 Size of the drive in bytes. Available on the Drive hardware size type.
Name Description extra_details Additional hardware details. Contents are specific to each hardware_extra_det optional component type. ails_instance The unique id of the component. string id optional Schema io_module_et h_ports This is the inverse of the resource type eth_port association. optional io_module_fc_ ports This is the inverse of the resource type fc_port association. optional io_module_sas _ports This is the inverse of the resource type sas_port association.
Name Description parent This is the embeddable reference form of parent_id optional attribute. parent_id The id of the component’s parent, or null if this component optional is at the top of the parent hierarchy. part_number optional Schema hardware_instance string The part number of the component. string The serial number of the component.
Name Description Schema New state for the hardware component location marker LED. Setting it to true will put the LED in a blinking state until set to false. Note that the state returned in the hardware component may not actually change for up to 60 seconds. This operation is currently supported for Base_Enclosure, Expansion_Enclosure, Node and Drive.
Name Description Schema The host name. The name should not be more than 128 name UTF-8 characters long and should not have any unprintable required characters. string Maximal length : 128 os_type OSTypeEnum required host_delete Type : object host_detach Name volume_id required Description Schema Volume to detach. string host_group_attach Volume id and optional logical unit number for attaching to host group.
Name Description Schema host_ids < string > array required The host group name. The name should not be more than name 128 UTF-8 characters long and should not have any required unprintable characters. string Maximal length : 128 host_group_detach Name volume_id required Description Schema Volume to detach.
host_group_modify Modify host group parameters. Name Description add_host_ids List of hosts to be added to host group. The operation fails if optional the host(s) to be added are attached to volume. Schema < string > array An optional description for the host group. The description description should not be more than 256 UTF-8 characters long and optional should not have any unprintable characters. string Maximal length : 256 A new host group name.
Name Description Schema port_type InitiatorProtocolTyp optional eEnum port_type_l10 n Localized message string corresponding to port_type string optional host_instance This resource type has queriable associations from host_group, import_host_system, host_volume_mapping, host_virtual_volume_mapping Name description optional Description Schema A description for the host. string host_group This is the embeddable reference form of host_group_id optional attribute.
Name Description name The host name. This property supports case-insensitive optional filtering os_type optional string OSTypeEnum optional os_type_l10n Schema Localized message string corresponding to os_type string host_modify Name Description add_initiators The list of initiators to be added. CHAP username and optional password are optional. Schema < initiator_create_mod ify > array An optional description for the host.
Name host optional Description Schema This is the embeddable reference form of host_id attribute. host_instance host_group This is the embeddable reference form of host_group_id optional attribute. host_group_id Unique identifier of a host group attached to a virtual optional volume. The host_id and host_group_id cannot both be set. host_id Unique identifier of a host attached to a virtual volume. optional The host_id and host_group_id cannot both be set.
Name Description id Unique identifier of a mapping between a host and a optional volume. Schema string logical_unit_n Logical unit number for the host volume access. umber Minimum value : 0 optional Maximum value : 2147483647 volume This is the embeddable reference form of volume_id optional attribute. volume_id Unique identifier of the volume to which the host is optional attached.
Name agent_port required Description Schema TCP port of the import host system. Minimum value : 0 integer (int32) Maximum value : 65535 chap_mutual_ Password for mutual CHAP authentication. This password password is required when the cluster is using mutual authentication string (password) optional CHAP mode. chap_mutual_ Username for mutual CHAP authentication. This username username is required when the cluster is using mutual authentication string optional CHAP mode.
Name agent_port optional Description Schema TCP port on the import host system. Minimum value : 0 integer (int32) Maximum value : 2147483647 agent_status HostAgentStatusEnu optional m agent_status_l 10n Localized message string corresponding to agent_status string optional agent_type HostAgentTypeEnu optional m agent_type_l1 0n Localized message string corresponding to agent_type string Version of the import host system.
import_host_volume_instance Details about an import host volume. Name active_path optional Description Schema Active path of the host volume. ActivePathEnum Localized message string corresponding to active_path string Unique identifier of the storage system. string Product type of the storage system. ArrayTypeEnum Localized message string corresponding to array_type string Unique identifier of the import host system. string Unique identifier of the import host volume.
Name mount_paths optional Description Schema Mount paths on the import host system. < string > array naa_id Unique identifier of a volume that is presented to the optional import host. name Name of the import host volume. This property supports optional case-insensitive filtering protocols optional string string < Supported protocols for the import host volume.
Name import_psgro up_volumes optional Description Schema < This is the inverse of the resource type import_psgroup_vol ume_instance import_psgroup_volume association. > array last_update_ti me Time when the PS Group was last updated. string (date-time) optional management_ Management address of the PS Group. This can be an IPv4 address address, IPv6 address, or FQDN (Fully Qualified Domain string (ip-address) optional Name). name Name of the PS Group.
Name end_time optional frequency optional Description Schema Time when snapshot creation ends each day, in minutes. Minimum value : 0 integer (int32) Maximum value : 2147483647 Frequency at which snapshots are created, in minutes. Minimum value : 0 integer (int32) Maximum value : 2147483647 Number of days for which the snapshot schedule has been inactive_date inactive.
import_psgroup_volume_import_snapshot_schedules_ response Type : < import_psgroup_schedule_instance > array import_psgroup_volume_instance PS Group volume instance details.
Name is_read_only optional Description Schema Indicates whether the volume is read-only. boolean migration_sta te ImportStatusEnum optional migration_sta te_l10n Localized message string corresponding to migration_state string optional name Name of the volume. This property supports case- optional insensitive filtering size optional wwn optional string Size of the volume, in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Unique WWN of the volume.
Name Description Schema Description of the import session. The name can contain a description maximum of 128 unicode characters. It cannot contain optional unprintable characters. string Maximal length : 128 host_ids Hosts to be mapped to the destination resource for an optional agentless import session. < string > array Name of the import session. The name must be unique in name required the PowerStore cluster and can contain a maximum of 128 unicode characters.
Name volume_group _id optional Description Schema Unique identifier of the volume group to which the imported volume will belong, if any. string import_session_enable_destination_volume Parameters for enabling the destination volume of an agentless import session. Type : object import_session_instance This resource type has queriable association from remote_system Name Description Schema automatic_cut Indicates whether the import session cutover is manual over (true) or automatic (false).
Name Description Schema destination_re source_type_l Localized 10n destination_resource_type message string corresponding to string optional error error_instance optional estimated_co When the import is in the Copy_In_Progress state, this mpletion_tim value indicates the estimated time at which the data copy estamp will complete. Before the import is in the Copy_In_Progress optional state, the value is null.
Name remote_syste m optional remote_syste m_id optional Description Schema This is the embeddable reference form of remote_system_id remote_system_insta attribute. Unique identifier of the storage system that contains the source volume or consistency group to be imported. nce string scheduled_tim Date and time at which the import session is scheduled to estamp run. The date is specified in ISO 8601 format with the time string (date-time) optional expressed in UTC format.
import_storage_center_consistency_group_import_sna pshot_profiles_response Type : < import_storage_center_snapshot_profile_instance > array import_storage_center_consistency_group_instance This resource type has queriable associations from import_storage_center_volume, import_storage_center Name id optional import_storag e_center optional Description Schema Unique identifier of the SC consistency group.
Name api_version optional Description Schema API version of the SC OS (SCOS). string id Unique identifier of the SC array that is a source storage optional system for import. import_storag e_center_cons istency_group s < This is the inverse of the resource type import_storage_cent er_consistency_grou import_storage_center_consistency_group association.
Name Description Schema supported_im SupportedImportTy port_type peEnum optional supported_im port_type_l10 Localized message n supported_import_type string corresponding to string optional user_name optional User account name used to communicate with the SC array. string import_storage_center_snapshot_profile_instance Snapshot profile. Name description optional id optional name optional Description Schema Description of the snapshot profile.
import_storage_center_volume_instance This resource type has queriable associations from import_storage_center, import_storage_center_consistency_group Name Description Schema health SCStatusEnum optional health_l10n optional host_volume_i ds optional id optional import_storag e_center optional Localized message string corresponding to health string List of host volume identifiers that correspond to SC volumes. Unique identifier of the SC volume.
Name importable_cr iteria optional importable_cr iteria_l10n optional Description Schema Volume import criteria. If the value is not Ready, the VolumeImportableC volume is not importable. Localized message riteriaEnum string corresponding to importable_criteria is_active Indicates whether the SC volume is active on any optional controller. Only volumes that are active are importable. is_read_only optional Indicates whether the volume is read-only.
Name id optional Description Schema Unique identifier of the Unity consistency group. string import_unity This is the embeddable reference form of import_unity_id import_unity_instan optional attribute. import_unity_ id optional import_unity_ volumes optional ce Unique identifier of the Unity storage system where the consistency group resides. This is the inverse of the resource type import_unity_volume association.
Name id optional Description Schema Unique identifier of the Unity storage system that is a source storage system for import. This is the serial number string of the storage system. import_unity_ < consistency_g This is the inverse of the resource roups import_unity_consistency_group association. type import_unity_consis tency_group_instanc optional import_unity_ volumes optional e > array This is the inverse of the resource type import_unity_volume association.
Name Description Schema supported_im port_type_l10 Localized n supported_import_type message string corresponding to string optional user_name User account name used to communicate with the Unity optional storage system. string import_unity_snapshot_schedule_instance Name id optional Description Schema Unique identifier of the Unity snapshot schedule. string is_default Indicates whether the Unity snapshot schedule is the optional default snapshot schedule.
Name Description Schema days_of_week Days of the week for which the snapshot schedule rule optional applies. < UnityDayofWeekEn um > array days_of_week_ l10n Localized message array corresponding to days_of_week < string > array Hourly frequency for the snapshot schedule rule.[0..23]. < integer > array Unique identifier of the snapshot schedule rule . string optional hours optional id optional Number of days or hours between snaps, depending on the interval rule type. [1..31].
import_unity_volume_instance This resource type has queriable associations from import_unity, import_unity_consistency_group Name Description Schema health UnityHealthEnum optional health_l10n optional host_volume_i ds optional id optional Localized message string corresponding to health string List of host volume identifiers that correspond to Unity volumes. Unique identifier of the Unity volume.
Name Description is_replication _destination optional is_thin_clone optional Schema Indicates whether the Unity volume is a replication destination. Indicates whether the Unity volume is a thin clone. boolean boolean migration_sta UnityVolumeMigrati te onStateEnum optional migration_sta te_l10n Localized message string corresponding to migration_state string optional name Name of the Unity volume.
Name id optional Description Schema Unique identifier of the VNX storage system. string import_vnx_c < onsistency_gr This oups import_vnx_consistency_group association. is the inverse of the resource type import_vnx_consiste optional import_vnx_v olumes optional is_faulted optional ncy_group_instance > array This is the inverse of the resource type import_vnx_volume association. Indicates whether the VNX storage system is faulted.
Name Description Schema supported_im port_type_l10 Localized n supported_import_type message string corresponding to string optional user_name User account name used to communicate with the VNX optional storage system. string import_vnx_consistency_group_instance This resource type has queriable associations from import_vnx_volume, import_vnx_array Name id optional import_vnx_a rray Description Schema Unique identifier of the VNX consistency group.
import_vnx_consistency_group Name Description Schema health VnxVolumeStateEnu optional m health_l10n optional host_volume_i ds optional id optional import_vnx_a rray optional import_vnx_a rray_id optional Localized message string corresponding to health string List of host volume identifiers associated with the VNX volume. Unique identifier of the VNX volume. This is the embeddable < string > array string reference form of import_vnx_array_i import_vnx_array_id attribute.
Name Description Schema Localized message string corresponding to migration_state string migration_sta te_l10n optional name Name of the VNX volume. This property supports case- optional insensitive filtering size optional wwn optional string Size of the VNX volume in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 World wide name of the VNX volume.
Name importable_cr iteria optional importable_cr iteria_l10n optional Description Schema Consistency group import criteria. If the value is not Ready, CGImportableCriteri the consistency group is not importable. Localized message string aEnum corresponding to importable_criteria name Name of the consistency group.
Name management_ address optional Description Schema Management address to use for communicating with the XtremIO storage system. The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain string (ip-address) Name). name Name of the XtremIO storage system.
Name Description user_name User account name used to communicate with the XtremIO optional storage system. xms_version Version of the XMS instance that manages the XtremIO optional storage system. Schema string string import_xtremio_snapshot_schedule_instance An instance of a snapshot schedule. Name id optional name optional Description Schema Unique identifier of the XtremIO snapshot schedule. string Name of the XtremIO snapshot schedule.
Name snapshots_to_ keep_number optional Description Schema Defines the number of Snapshots to be saved. This value is present if the retention_policy is not present. integer (int32) Minimum value : 0 Maximum value : 2147483647 The time period, in seconds, for which a Snapshot is retained. When the defined time has passed, the snapshot snapshots_to_ is automatically removed. ⢠Minimum value is 60 (1 keep_time minute). ⢠Maximum value is 15768000 (5 Years).
Name long_retentio n_copies optional middle_perio d_duration optional Description Schema The long term retention number of copies ranging from 1 to 500. The value of 0 indicates that this period is not in use. Minimum value : 0 Maximum value : 500 The duration of the middle term period ranging from 1 to 500.
import_xtremio_volume_import_snapshot_schedules_ response Response object for snapshot schedules of a volume.
Name import_xtrem io_id optional importable_cr iteria optional importable_cr iteria_l10n optional Description Schema Unique identifier of the XtremIO storage system to which the XtremIO volume belongs. Indicates the reason when the volume is not importable. If VolumeImportableC the value is not Ready, the volume is not importable. Localized message string corresponding riteriaEnum to importable_criteria is_read_only Indicates whether the XtremIO volume is a read only optional volume.
Name Description Schema Password for CHAP authentication. This value must be 12 chap_mutual_ to 64 UTF-8 characters. This password is not queriable. password CHAP password is required when the cluster CHAP mode is string (password) optional mutual authentication. Length : 12 - 64 chap_mutual_ username optional Username for CHAP authentication. This value must be 1 to 64 UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication.
Name id optional Description Schema Unique identifier of the IP address. string ip_port This is the embeddable reference form of ip_port_id optional attribute. ip_port_instance Unique identifier of the port that uses this IP address to ip_port_id provide access to storage network services, such as iSCSI. optional This attribute can be set only for an IP address used by string networks of type Storage. network This is the embeddable reference form of network_id optional attribute.
Name Description Schema available_usa ges_l10n Localized message array corresponding to available_usages < string > array optional bond optional bond_id optional This is the embeddable reference form of bond_id attribute. bond_instance Unique identifier of the bond on top of which the IP port is configured. If the IP port is configured on top of an string Ethernet front-end port, this attribute should be empty. current_usage s < IpPortUsageEnum Current IP port usages.
Name Description Schema iSCSI qualified name used by the target configured on top target_iqn of the IP port initially or as a result of network scaling. If optional the IP port is not used by an iSCSI connection, this attribute string should be empty. veth_port This is the embeddable reference form of veth_port_id optional attribute. veth_port_instance Unique identifier of the virtual Ethernet front-end port on veth_port_id optional top of which the IP port is configured.
Name Description Schema Estimate for the upper bound forecasted value on that high_value particular time. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the lower bound forecasted value on that low_value particular time. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the mean forecasted value on that particular mean_value time.
Name time_to_full_o ptimistic optional time_to_full_p essimistic optional Description Schema Optimistic date-time for time to full based on the lower bound of the forecast 95% confidence interval. Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval.
job_cluster_time_to_full_response Polymorphism : Inheritance Discriminator : response_type Name cluster_id optional end_of_foreca st optional Description Schema Unique ID of the cluster. string Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends. In this case the end of the forecast can be used as a minimum for time to full.
Name id optional Description Schema Unique identifier of the new instance created. string response_type string required job_error_response Error response for an operation. Contains an array of localized messages. Polymorphism : Inheritance Discriminator : response_type Name Schema messages < error_message > array optional response_type string required job_file_system_clone_response File system clone created.
Name id optional Description Schema The id of the created snapshot. string response_type string required job_file_system_snapshot_response Snapshot file system created. Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema The id of the created snapshot. string response_type string required job_instance Information about the job.
Name leafs optional Description This is the inverse of the resource type job association. parent This is the embeddable reference form of parent_id optional attribute. parent_id optional Unique identifier of the parent job, if applicable. phase optional < job_instance > array job_instance string JobPhaseEnum optional phase_l10n Schema Localized message string corresponding to phase string progress_perc Percent complete of the job.
Name Description Schema response_bod y base_response optional root optional This is the embeddable reference form of root_id attribute. root_id Unique identifier of the root job, if applicable. The root job optional is the job at the top of the parent hierarchy. start_time optional Date and time when the job execution started.
job_keystore_archive_regenerate_response Success response body. Polymorphism : Inheritance Discriminator : response_type Name download_uri optional Description Schema A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup string archive file.
Name rescan_host_i ds optional Description Schema List of hosts that be rescanned before a migration session can proceed. response_type < string > array string required job_response Job response for an asynchronous request. The response to any asynchronous request that does not fail immediately. Name id optional Description Schema The id of the job created by the request. string job_virtual_machine_snapshot_response The response to a virtual_machine snapshot request.
Name Schema response_type string required job_volume_group_clone_response Response for volume group clone action Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema Unique identifier of the new instance created. string response_type string required job_volume_group_refresh_response volume group refresh response. Polymorphism : Inheritance Discriminator : response_type Name Description Schema backup_snaps Unique identifier of the backup snapshot set.
Name Description Schema backup_snaps Unique identifier of the backup snapshot set. This hot_id parameter will not be available if the create_backup_snap string optional was set to false. response_type string required job_volume_group_snapshot_response Unique identifier of the new snapshot volume.
Name Schema backup_snapshot_id optional response_type string string required job_volume_snapshot_response Unique identifier of the new snapshot volume.
Name Description Schema data A keystore archive file which includes the individual optional keystore backup files from each appliance in the cluster. string (binary) keystore_archive_regenerate_response Success response body. Name download_uri optional Description Schema A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup string archive file. ldap_account_create Parameters for creating an LDAP account.
Name Description domain_id Unique identifier of the LDAP domain to which the LDAP optional account belongs. id optional name optional Schema string Unique identifier of the LDAP account. string Name of the LDAP account. string role_id Unique identifier of the role to which the LDAP account is optional mapped. string type LDAPAccountTypeE optional num type_l10n optional Localized message string corresponding to type string ldap_account_modify Parameters for modifying an LDAP account.
Name Description Schema domain_name Name of the LDAP authority to construct the LDAP server required configuration. string group_membe Name of the LDAP attribute whose value contains the r_attribute names of group members within a group. Default value is string optional member. group_name_a ttribute optional group_object_ class optional group_search_ level optional Name of the LDAP attribute whose value indicates the group name. Default value is cn. string LDAP object class for groups.
Name Description Schema Port number used to connect to the LDAP Server. Default port value is 389. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 protocol LDAPProtocolEnum optional user_id_attrib ute optional Name of the LDAP attribute whose value indicates the user ID. Default value is sAMAccountName. string user_object_cl ass LDAP object class for users. Default value is user string Path used to search for users on the directory server.
Name group_object_ class optional group_search_ level optional Description Schema LDAP object class for groups. Default value is group. In Active Directory, groups and users are stored in the same directory path, and are in a class called group. Default string value is group. Nested search level for performing group search.
Name Description protocol LDAPProtocolEnum optional protocol_l10n optional user_id_attrib ute optional Schema Localized message string corresponding to protocol Name of the LDAP attribute whose value indicates the user ID. Default value is sAMAccountName string string user_object_cl ass LDAP object class for users. Default value is user. string Path used to search for users on the directory server.
Name group_object_ class optional group_search_ level optional Description Schema LDAP object class for groups. Default value is group. In Active Directory, groups and users are stored in the same directory path, and are in a class called group. Default string value is group. Nested search level for performing group search.
Name Description Schema LDAP object class for users. Default value is user string Path used to search for users on the directory server. string user_object_cl ass optional user_search_p ath optional license_instance Software license information for the cluster. Name Description Schema activation_file The content of the license activation file to send to the _content DellEMC Software Licensing Central to retrieve the string optional software license for the cluster.
Name Description Schema Password for the new local user account to be created. The password required password value can be 8 to 40 UTF-8 characters long, and include as a minimum one uppercase character, one string (password) lowercase character, one numeric character, and one special character from this list [!,@#$%^*>_~]. The unique identifier of the role to which the new local role_id required user will be mapped.
Name Description Schema current_pass Current password of the local user. Any local user can word change his own password by providing current_password string (password) optional along with the new password. Lock or unlock the local user account. Local user with is_locked administration/security administration role can lock or optional unlock any other local user account. You cannot lock an boolean account you are currently logged-in to. New password of the local user.
Name to_appliance_i d optional Description Schema Unique identifier of the appliance to which the volume was relocated. string login_session_instance Name id optional Description Schema Unique identifier of the login session. string Remaining idle time until the session will expire, in idle_timeout seconds. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 is_built_in_us er Indicates whether the logged-in user is predefined.
Name Description end_time Time when the maintenance window will close (or did optional close). id optional is_enabled optional Schema string (date-time) Unique identifier of the maintenance window. string Whether the maintenance window is active. boolean maintenance_window_modify Name Description Schema Number of seconds from the current timestamp the maintenance window will expire.
Name key_length optional Description Schema Private key length. Minimum value : 0 integer (int32) Maximum value : 2147483647 public_key_al gorithm Public key algorithm used to generate the key pair. string Certificate serial number. string Certificate signature algorithm. string Certificate subject or so called distinguished name.
Name Description Schema entity MetricsEntityEnum required entity_id required Identifier for specific entity. string interval MetricsIntervalEnu optional m metrics_generate_response Response will be just an array of one of the child of this definition Name Schema entity string required migration_recommendation_action A recommended migration action.
Name Description Schema host_connecti vity_to_destin Whether all hosts for the migrating resource have ation connectivity to the destination appliance.
migration_recommendation_create Set evacuate_appliance parameters to evacuate space Filtering on the fields of this embedded resource is not supported. Name Description Schema Evacuate appliance by specifying optional space_to_free evacuate_appliance evacuate_appl iance required evacuate_appliance Name Description Schema appliance_id ID of appliance on which available space is desired.
Name Description Schema rescan_host_li IDs of attached hosts that require a rescan to ensure st accessibility of migrated storage objects after migrations < string > array optional complete. migration_recommendation_instance Name Description Schema Time at which recommendation was created. string (date-time) created_times tamp optional Unitless value describing estimated cost to migrate all estimated_cos volumes for this recommendation relative to other t recommendations.
Name Description Schema state MigrationRecomme optional ndationStateEnum state_l10n optional Localized message string corresponding to state Type of request that generated a string migration type recommendation. Evacuate_Appliance - A recommendation MigrationRecomme optional to evacuate space by auto selecting storage objects from an ndationTypeEnum appliance using specified size.
migration_session_create_response The response for the create migration operation. Name id optional rescan_host_i ds optional Description Schema Identifier of the migration_session object. string List of hosts that be rescanned before a migration session can proceed. < string > array migration_session_delete Name force optional Description Schema Indicates whether all migration activities will be canceled boolean before deleting the session.
Name Description Schema Family identifier designating the storage resource or resources being migrated. For volume or virtual_volume family_id optional migrations, the family is moved together because they share data among the primary object, snapshots, and string clones. For volume_group migration, the family of each volume in the group is moved because it is a grouping of volumes. id optional Unique identifier of the migration session instance. string Time of the last successful sync operation.
Name virtual_volum es optional volume_group s optional volumes optional Description Schema This is the inverse of the resource type virtual_volume association. < virtual_volume_inst ance > array This is the inverse of the resource type volume_group association. < volume_group_insta nce > array This is the inverse of the resource type volume association.
Name default_windo ws_user optional Description Schema Default Windows user name used for granting access in case of Unix to Windows user mapping failure. When empty, access in such case is denied. string Length : 0 - 1023 description Description of the NAS server. optional Length : 0 - 255 string A Windows user must have a corresponding matching Unix is_auto_user_ mapping_ena bled optional user (uid) in order to connect.
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. - false - (Default) Try to unjoin the associated boolean SMB servers from the Active Directory before deleting the NAS server.
Name Description Schema current_unix_ directory_ser Localized vice_l10n current_unix_directory_service message string corresponding to string optional default_unix_ Default Unix user name used for granting access in case of user Windows to Unix user mapping failure. When empty, string optional access in such case is denied. default_windo Default Windows user name used for granting access in ws_user case of Unix to Windows user mapping failure.
Name file_virus_che ckers optional id optional Description Schema This is the inverse of the resource type file_virus_checker association. < file_virus_checker_i nstance > array Unique identifier of the NAS server. string A Windows user must have a corresponding matching Unix is_auto_user_ mapping_ena bled optional user (uid) in order to connect.
Name Description Schema production_IP v6_interface_i Unique d identifier of the preferred IPv6 production interface. string optional smb_servers This is the inverse of the resource type smb_server optional association. < smb_server_instance > array nas_server_modify Arguments for the modify operation. Name Description Schema Unique identifier of the preferred IPv4 backup interface. string Unique identifier of the preferred IPv6 backup interface.
Name Description Schema A Windows user must have a corresponding matching Unix is_auto_user_ mapping_ena bled optional user (uid) in order to connect. This attribute 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.
network_instance This resource type has queriable association from ip_pool_address Name Description gateway Network gateway in IPv4 or IPv6 format, corresponding to optional the network’s IP version. id optional ip_pool_addre sses optional Unique identifier of the network. This is the inverse of the resource type ip_pool_address association.
Name Description Schema add_addresse s < string (ip-address) IP addresses to add in IPv4 or IPv6 format. > array optional New cluster management IP address in IPv4 or IPv6 format, cluster_mgmt _address optional corresponding to the network’s IP version. This can only be specified when reconfiguring the management network. string (ip-address) Caution: Changing the cluster management IP address will lead to losing management sessions through this address.
Name prefix_length optional Description Schema Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 integer (int32) Maximum value : 127 remove_addre sses < string (ip-address) IP addresses to remove in IPv4 or IPv6 format. > array optional storage_disco very_address optional vasa_provider _credentials optional vlan_id optional New storage discovery IP address in IPv4 or IPv6 format, corresponding to the network’s IP version.
Name Description Schema esxi_credenti als esxi_credentials optional Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints.
Name prefix_length required Description Schema Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 integer (int32) Maximum value : 127 smtp_config network_replace_sm optional tp_config vasa_provider _credentials optional Credentials required for re-registering the VASA vendor provider during the replacement of the cluster vasa_provider_crede management IP address. Should be passed only when ntials reconfiguring PowerStoreX cluster.
Name Description Schema purpose PhysicalSwitchPurp optional oseEnum network_replace_physical_switch_connection Name Description Schema address Physical switch address in IPv4 or IPv6 or DNS hostname required format. connect_meth PhysicalSwitchConn od ectMethodEnum required port optional snmp_commu nity_string optional string (ip-address) Port used for connection to switch.
network_scale Name Description add_port_ids Unique identifiers of available IP ports to be used in the optional network. Schema < string > array Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints.
Name Description Schema default_access NFSExportDefaultAc optional cessEnum description User defined NFS Export description. optional Length : 0 - 511 string file_system_id Unique identifier of the file system on which the NFS required is_no_SUID optional Export will be created. string If set, do not allow access to set SUID. Otherwise, allow boolean access. Default : false min_security NFSExportMinSecur optional ityEnum name NFS Export name.
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 Netgroups prefixed with @. read_write_ho sts optional Hosts with read and write access to the NFS export and its snapshots.
Name Description Schema file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id Unique identifier of the file system on which the NFS optional id optional Export was created. Unique id of the NFS Export. file_system_instance string string is_no_SUID If set, do not allow access to set SUID. Otherwise, allow optional access.
Name read_only_hos ts optional Description Schema 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 < string > array IPv4/subnetmask), or Netgroups prefixed with @. Hosts with read-only and ready-only for root user access to read_only_roo the NFS Export and its snapshots.
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 already exists. Cannot combine with read_write_hosts. Hosts to add to the current read_write_root_hosts list.
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), Netgroups prefixed with @. read_write_ho sts optional Hosts with read and write access to the NFS export and its snapshots.
Name Description Schema Hosts to remove from the current read_write_root_hosts remove_read_ list. Hosts can be entered by Hostname, IP addresses (IPv4, write_root_ho IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or sts IPv4/subnetmask), or Netgroups prefixed with @. Error if optional the host is not present. Cannot combine < string > array with read_write_root_hosts. nfs_server_create Argument for the NFS server create operation.
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. - false - NFSv3 is disabled on the specified NAS server. Default : true Indicates whether NFSv4 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv4.
nfs_server_instance This resource type has queriable association from nas_server Name Description Schema Sets the Time-To-Live (in minutes) expiration timestamp for a Windows entry in the credentials cache. When failed credentials_ca mapping entries expire, the system retries mapping the UID che_TTL to the SID. optional Default : 5 integer (int32) Minimum value : 0 Maximum value : 2147483647 The name that will be used by NFS clients to connect to this host_name optional NFS server.
Name Description Schema Indicates whether NFSv4 is enabled on the NAS server. is_nfsv4_enabl ed optional When enabled, NFS shares can be accessed with NFSv4. When disabled, NFS shares cannot be accessed with NFSv4 protocol. - true - NFSv4 is enabled on the specified NAS boolean server. - false - NFSv4 is disabled on the specified NAS server. is_secure_ena Indicates whether secure NFS is enabled on the NFS server. bled - true - Secure NFS is Enabled.
nfs_server_modify Arguments for the NFS server modify operation. Name Description Schema Sets the Time-To-Live (in minutes) expiration stamp for a Windows entry in the credentials cache. When failed credentials_ca mapping entries expire, the system retries mapping the UID che_TTL to the SID. optional Default : 5 integer (int32) Minimum value : 0 Maximum value : 2147483647 The name that will be used by NFS clients to connect to this NFS server.
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 current kdc_type is MS optional Windows. If secure is enabled either unjoin NFS server boolean before deleting or set value to true.
Name id optional ip_pool_addre sses optional slot optional Description Schema Unique identifier of the node. string This is the inverse of the resource type ip_pool_address association. < ip_pool_address_inst ance > array Slot number of the node. Minimum value : 0 integer (int32) Maximum value : 2147483647 veth_ports This is the inverse of the resource type veth_port < veth_port_instance optional association. > array ntp_instance Name Description addresses NTP server addresses.
Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number Write rate in bytes per second. number (float) Total write operations per second.
Name Description Schema Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_read _size optional max_avg_writ e_latency optional max_avg_writ e_size optional max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests. Calculated over ation time interval across appliance.
Name timestamp optional Description Schema End of sample period. string (date-time) performance_metrics_by_cluster Performance metrics for the cluster collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Write rate in byte/sec. number (float) Total write operations per second.
Name Description Schema Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second.
Name timestamp optional Description Schema End of sample period. string (date-time) performance_metrics_by_fe_eth_node Ethernet performance metrics for the node collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. bytes_rx_ps optional bytes_tx_ps optional number (float) The total bytes transmitted per second.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) performance_metrics_by_fe_eth_node_rollup Ethernet performance metrics for the node rolled up at various rollup intervals.
Name avg_pkt_tx_ps optional Description Schema The average number of packets transmitted per second. number (float) entity string required max_bytes_rx _ps The maximum total bytes received per second. number (float) The maximum total bytes transmitted per second. number (float) optional max_bytes_tx_ ps optional max_pkt_rx_c rc_error_ps optional The maximum number of packets received with CRC error (and thus dropped) per second.
performance_metrics_by_fe_eth_port Performance metrics for the frontend ethernet port collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. bytes_rx_ps optional bytes_tx_ps optional Schema The total bytes received per second. number (float) The total bytes transmitted per second.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) performance_metrics_by_fe_eth_port_rollup Performance metrics for the frontend ethernet port rolled up at various rollup intervals.
Name avg_pkt_tx_ps optional Description Schema The average number of packets transmitted per second. number (float) entity string required fe_port_id Reference to the associated frontend ethernet optional (eth_port) on which these metrics were recorded. port string max_bytes_rx _ps The maximum total bytes received per second. number (float) The maximum total bytes transmitted per second.
Name timestamp optional Description Schema End of sample period. string (date-time) performance_metrics_by_fe_fc_node Fibre channel performance metrics for the node collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds.
Name Description Schema Invalid crc count per second. number (float) Invalid transmission word count per second. number (float) Link failure count per second. number (float) Loss of signal count per second. number (float) Loss of sync count per second.
Name Description Schema Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second.
Name Description Schema avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) avg_dumped_f rames_ps Average dumped frames per second. number (float) Average invalid crc count per second. number (float) Average invalid transmission word count per second. number (float) Average size of read and write operations in bytes. number (float) Weighted average latency in microseconds.
Name avg_read_iops optional Description Schema Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second.
Name Description Schema Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) avg_write_ban dwidth optional avg_write_iop s optional avg_write_late ncy optional avg_write_size optional entity string required max_avg_io_si ze optional Maximum average size of input and output operations in bytes.
Name Description Schema max_current_ Maximum number of logins to the target from initiators. logins Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_dumped_ frames_ps The maximum dumped frames per second. number (float) The maximum invalid crc count per second. number (float) optional max_invalid_c rc_count_ps optional max_invalid_t x_word_count _ps The maximum invalid transmission word count per second.
Name Description Schema Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) performance_metrics_by_fe_fc_port Performance metrics for the frontend fibre channel port collected at twenty second interval.
Name Description Schema Dumped frames per second. number (float) dumped_fram es_ps optional entity string required fe_port_id Reference to the associated frontend fibre channel port optional (fc_port) on which these metrics were recorded. string invalid_crc_co unt_ps Invalid crc count per second. number (float) Invalid transmission word count per second. number (float) Link failure count per second. number (float) Loss of signal count per second.
Name repeat_count optional timestamp Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second.
performance_metrics_by_fe_fc_port_rollup Performance metrics for the frontend fibre channel port rolled up at various intervals. Polymorphism : Inheritance Discriminator : entity Name Description Schema appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_current_l Average number of logins to the target from initiators.
Name Description Schema avg_prim_seq_ prot_err_coun Average primitive sequence protocol error count per t_ps second. number (float) optional avg_read_ban dwidth Weighted average read bandwidth in bytes per second. number (float) Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second.
Name Description Schema Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_read _size optional max_avg_writ e_latency optional max_avg_writ e_size optional max_current_ Maximum number of logins to the target from initiators.
Name Description Schema max_prim_se q_prot_err_co The maximum primitive sequence protocol error count per unt_ps second. number (float) optional max_read_ba ndwidth Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second.
Name Description Schema Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) Reference to the node the port belongs to. string max_unaligne d_write_iops optional max_write_ba ndwidth optional max_write_io ps optional node_id optional repeat_count optional timestamp optional Number of times the metrics are repeated.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity string required file_system_id optional Unique identifier of the file system. string Read rate in bytes per second. number (float) Total read operations per second.
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 Description Schema avg_latency Maximum optional microseconds. of average read and write latency in number (float) avg_read_ban dwidth Average read rate in bytes per second. number (float) Average read operations per second.
Name Description Schema Maximum of average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity string required file_system_id optional max_avg_late ncy optional Unique identifier of the file system. Maximum of average read and string write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds.
Name Description Schema Maximum read operations per second. number (float) Maximum data transfer rate in bytes per second. number (float) Maximum write rate in bytes per second. number (float) Maximum write operations per second. number (float) max_read_iop s optional max_total_ba ndwidth optional max_write_ba ndwidth optional max_write_io ps optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name Description Schema Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_write_late ncy optional avg_write_size optional current_login The number of logins to the target from initiators.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second.
Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 avg_io_size optional Schema string integer (int64) Average size of read and write operations in bytes.
Name Description Schema Average unaligned total input/output per second. number (float) Average unaligned read rate in bytes per second. number (float) Average unaligned read input/output per second. number (float) Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second.
Name Description Schema Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name Description Schema Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second.
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 avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unique identifier representing a volume group. string Write rate in byte/sec. number (float) Total write operations per second.
Name avg_write_size optional Description Schema Average write size in bytes. number (float) entity string required read_bandwid th Read rate in bytes per second. number (float) Total read operations per second. number (float) optional read_iops optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second.
Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Weighted average latency in microseconds. number (float) Weighted average read bandwidth in bytes per second. number (float) Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second.
Name Description Schema entity string required max_avg_io_si ze optional Maximum average size of input and output operations in bytes. number (float) max_avg_late ncy Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name Description Schema Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) max_write_ba ndwidth optional max_write_io ps optional repeat_count optional timestamp optional vm_id optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Unique identifier representing a specific virtual machine.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity string required read_bandwid th Read rate in bytes per second. number (float) Total read operations per second. number (float) optional read_iops optional repeat_count optional timestamp optional Number of times the metrics are repeated.
performance_metrics_by_volume_rollup Summary of volume 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 Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_io_size optional avg_latency optional Schema string Average size of read and write operations in bytes.
Name Description Schema Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) avg_write_iop s optional avg_write_late ncy optional avg_write_size optional entity string required max_avg_io_si ze optional Maximum average size of input and output operations in bytes. number (float) max_avg_late ncy Maximum of average latency in microseconds.
Name Description Schema Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) max_read_iop s optional max_total_ba ndwidth optional max_total_iop s optional max_write_ba ndwidth optional max_write_io ps optional repeat_count optional timestamp optional volume_id optional Number of times the metrics are repeated.
Name Description Schema Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_write_late ncy optional avg_write_size optional entity string required node_id optional read_iops optional Unique identifier of the node. string Total read operations per second.
Discriminator : entity Name avg_io_size optional avg_latency optional avg_read_iops optional Description Schema Average read and write size in bytes. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average read and write operations per second. number (float) Average write operations per second.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Discriminator : entity Name Description Schema Average md latency operations per second. number (float) avg_md_laten cy optional entity string required failed_md_ops optional md_ops optional node_id optional read_iops optional Total failed md operations per second. number (float) Total md operations per second. number (float) Unique identifier of the nfs. string Total read iops in microseconds.
Name Description Schema Average failed operations per second. number (float) Average md latency per second. number (float) Average md operations per second. number (float) Average read operations per second. number (float) Average read and write operations per second. number (float) Average write operations per second.
Name node_id optional Description Schema Unique identifier of the node. string Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional 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 optional total_iops optional write_iops optional End of sample period. string (date-time) Total read and write iops in microseconds. number (float) Total write iops in microseconds.
Name Description Schema Average write operations per second. number (float) avg_write_iop s optional entity string required max_avg_md_ latency Maximum average md latency per second. number (float) Max failed operations per second. number (float) Maximum read operations per second. number (float) Maximum read and write operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name total_iops optional write_iops optional Description Schema Total read and write operations per second. number (float) Total write operations per second. number (float) performance_metrics_smb1_builtinclient_by_node_rol lup 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 Description Schema Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity string required max_avg_late ncy optional Maximum of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes.
Name Description Schema Maximum write operations per second. number (float) Unique identifier of the node. string max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period.
Name Description Schema entity string required node_id optional read_iops optional Unique identifier of the node. string Total read operations per second. number (float) Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes.
Name max_avg_size optional Description Schema Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name write_iops optional Description Schema Total write operations per second. number (float) performance_metrics_smb2_builtinclient_by_node_rol lup Summary of smb v1 client 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_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls.
Name avg_write_size optional Description Schema Average write size in bytes. number (float) entity string required max_avg_late ncy optional Maximum of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds.
Name node_id optional Description Schema Unique identifier of the node. string Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period.
Name node_id optional read_iops optional Description Schema Unique identifier of the node. string Total read operations per second. number (float) Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_latency optional avg_read_iops optional Description Schema Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name Description Schema entity string required hash_avg_late ncy Average hash latency. number (float) Average hash size. number (float) Max hash latency. number (float) Max hash size. number (float) Min hash latency. number (float) Max hash size. number (float) Max used threads number (float) Unique identifier of the node.
Name total_tasks optional Description Schema Total tasks. number (float) performance_metrics_smb_branch_cache_by_node_rol lup Performance metrics nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : entity Name Description entity Schema string required hash_avg_late ncy Average hash latency. number (float) Average hash size. number (float) Average max hash latency.
Name hash_min_size optional Description Schema Max hash size. number (float) Max used threads number (float) Unique identifier of the node. string max_used_thr eads optional node_id optional Number of consecutive sampling periods during which repeat_count optional 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 optional End of sample period.
Name avg_read_size optional Description Schema Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity string required node_id optional read_iops optional Unique identifier of the node. string Total read operations per second.
Polymorphism : Inheritance Discriminator : entity Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second.
performance_metrics_smb_by_node Performance metrics for the smb node collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds.
Name total_calls optional total_iops optional write_iops optional Description Schema Total calls. number (float) Total read and write operations per second. number (float) Total write operations per second. number (float) performance_metrics_smb_by_node_rollup Summary of smb node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
Name Description Schema Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity string required max_avg_late ncy optional Maximum of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes.
Name Description Schema Maximum write operations per second. number (float) Unique identifier of the node. string max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional 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 optional Time at the beginning of sample period.
Name address required Description Schema Physical switch address in IPv4 or IPv6 or DNS hostname format. string (ip-address) Length : 1 - 255 connect_meth PhysicalSwitchConn od ectMethodEnum required port optional Port used for connection to switch. integer (int32) Minimum value : 0 Maximum value : 65535 snmp_commu SNMPv2 community string, if SNMPv2c connect method is nity_string specified.
Name physical_switc h optional physical_switc h_id optional port optional username optional Description This is Schema the embeddable reference form of physical_switch_inst physical_switch_id attribute. Id of physical switch to which connection belongs. Maximal length : 128 ance string Port used for connection to switch. Minimum value : 0 integer (int32) Maximum value : 65535 Username to connect a physical switch for SSH connection method.
physical_switch_create Name Description Schema < connections required physical_switch_con Supported connections for a physical switch. nection_create > array name Name of a physical switch. required Length : 1 - 128 string purpose PhysicalSwitchPurp required oseEnum physical_switch_instance This resource type has queriable association from physical_switch_connection Name Description Schema < connections This is the inverse of the optional physical_switch_connection association.
Name Description Schema < connections optional Supported connections for a physical switch. physical_switch_con nection_modify > array name Name of physical switch. optional Length : 1 - 128 string purpose PhysicalSwitchPurp optional oseEnum policy_create Policy create request. Name description optional name required Description Schema Policy description. string Policy name. string replication_ru Replication rule identifiers included in this policy.
Name Description file_systems This is the inverse of the resource type file_system optional association. id optional Schema < file_system_instance > array Unique identifier of the policy. string Indicates whether this is a replica policy, which is applied is_replica to replication destination storage resources. A policy of this optional type is restricted from many operations. boolean Default : false name Policy name.
policy_modify Policy modify request. Name Description Schema Replication rule identifiers to be added to this policy. < string > array Snapshot rule identifiers to be added to this policy. < string > array Policy description. string Policy name. string add_replicatio n_rule_ids optional add_snapshot _rule_ids optional description optional name optional remove_replic ation_rule_ids Replication rule identifiers to be removed from this policy.
Name created_by_ru le_id optional Description Schema Unique identifier of the snapshot rule that created the snapshot. string created_by_ru The name of the rule that created the snapshot. This value le_name will not change if the name of the rule changes after string optional creating the snapshot.
Name Description Schema Unique identifier of the resource from which a snapshot or clone resource is created. The parent_id is set when a source_id optional resource is created and will only change if its parent resource is deleted. When a resource is deleted, its children string get reparented to the parent of the deleted resource. If the deleted parent is of type Primary, the parent_id of the child resources will be set to null.
Name Description Schema User-specified name of the remote system. Used only for name non-PowerStore systems. This value must contain 128 or optional fewer printable Unicode characters. string Maximal length : 128 remote_passw ord optional remote_usern ame optional session_chap_ mode optional type optional Password used to access the remote system. Used only for non-PowerStore systems. Username used to access the remote system. Used only for non-PowerStore systems.
Name Description Schema List of data connections from each appliance in the local data_connecti cluster to iSCSI target IP address. < ons data_connection_ins Filtering on the fields of this embedded resource is not optional tance > array supported. data_network _latency RemoteSystemLaten Network latency for the remote system.
Name replication_se ssions optional Description Schema This is the inverse of the resource type replication_session association. < replication_session_i nstance > array serial_numbe r Serial number of the remote system instance. string optional session_chap_ mode Session chap mode for the non-PowerStore remote system.
Name Description Schema Management IP address of the remote system. string (ip-address) management_ address optional User-specified name of the remote system. Used only for name non-PowerStore type remote systems. This value must optional contain 128 or fewer printable Unicode characters. string Maximal length : 128 remote_passw ord optional remote_usern ame optional Password used to access the remote system. Used only for non-PowerStore systems. Username used to access the remote system.
Name Description Schema storage_eleme nt_type StorageElementType Storage element type. Enum optional replication_rule_create Replication rule create request. Name Description Schema Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert_threshol alert if the delay between the expected and actual sync d exceeds this threshold. Alert threshold has the default integer (int32) optional value of one RPO in minutes.
Name id optional Description Schema Unique identifier of the replication rule. string Indicates if this is a replica of a rule or policy on a remote is_replica system that is the source of a replication session replicating optional a resource to the local system. boolean Default : false name Name of the replication rule. This property supports case- optional insensitive filtering policies List optional replication_rule.
Name remote_syste m_id optional Description Schema Unique identifier of the remote system to which this rule will replicate the associated resources. rpo string RPOEnum optional replication_session_failover Parameters to fail over a replication session.
Name Description Schema Time of last successful synchronization. string (date-time) last_sync_time stamp optional local_resourc e_id optional migration_ses sion optional Unique identifier of the local storage resource for the replication session. This is the embeddable reference form string of migration_session_i migration_session_id attribute. nstance progress_perc Progress of the current replication operation.
Name role optional role_l10n optional state optional state_l10n optional Description Schema ReplicationRoleEnu Role of the replication session. m Localized message string corresponding to role string ReplicationStateEnu Current state of the replication session. m Localized message string corresponding to state string List of storage element pairs for a replication session. For a volume or volume group replication session, the replicating storage elements are of type 'volume’.
sas_port_instance This resource type has queriable associations from appliance, hardware, sas_port Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional id optional Schema appliance_instance Unique identifier of the appliance containing the port. string Unique identifier of the SAS port. string io_module This is the embeddable reference form of io_module_id optional attribute.
Name port_index optional sfp optional Description Schema Index of the SAS port in IO module. Minimum value : 0 integer (int32) Maximum value : 2147483647 This is the embeddable reference form of sfp_id attribute. sfp_id Unique identifier of the hardware instance of type 'SFP' optional (Small Form-factor Pluggable) inserted into the port.
Name Description Schema Localized message string corresponding to frequency string frequency_l10 n optional Time interval between any two snapshot creations, in interval minutes. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 month_of_yea r < Months of the year in which a snapshot will be taken. optional MonthOfYearEnum > array month_of_yea r_l10n Localized message array corresponding to month_of_year < string > array Name of the snapshot profile rule.
Name Description Schema Idle time (in seconds) after which login sessions will expire idle_timeout and require re-authentication. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 service_config_instance Name appliance_id optional id optional Description Schema Unique identifier of the appliance. string Unique identifier for the service configuration instance. string The current ssh service access state.
Name is_built_in optional Description Schema Whether the user account is built-in or not. boolean Whether the user account has the default password or not. boolean is_default_pas sword optional name Name of the service user account. Always 'service' in this optional release. string service_user_modify Name Description Schema New password for the service user account.
Name Description description Description of the SMB server in UTF-8 characters. optional Length : 0 - 48 domain optional is_standalone required local_admin_p assword optional nas_server_id required Schema string Domain name where SMB server is registered in Active Directory, if applicable. string Length : 1 - 255 Indicates whether the SMB server is standalone. Values are: - true - SMB server is standalone. - false - SMB server is boolean joined to the Active Directory.
Name force optional Description Schema If false, the delete will fail if the SMB server is still joined, else the SMB server is deleted but AD account is not boolean removed. smb_server_instance This resource type has queriable association from nas_server Name Description Schema DNS name of the associated computer account when the SMB server is joined to an Active Directory domain.
Name Description Schema NetBIOS name is the network name of the standalone SMB server. SMB server joined to Active Directory also have NetBIOS Name, defaulted to the 15 first characters of the computerName attribute. Administrators can specify a custom NetBIOS Name for a SMB server using this netbios_name attribute.
Name Description Schema DNS Name of the associated Computer Account when the SMB server is joined to an Active Directory domain. This name is limited to 63 bytes and must not contain the following characters - - comma (.) - tilde (~) - colon (:) computer_na me optional exclamation point (!) - at sign (@) - number sign (#) - dollar sign ($) - percent (%) - caret (^) - ampersand (&) apostrophe (') - period (.
Name Description Schema Applies to standalone SMB servers only. Windows network workgroup workgroup for the SMB server. Workgroup names are optional limited to 15 alphanumeric ASCII characters. string Length : 1 - 15 smb_server_unjoin Argument to ujoin the SMB server from an Active Directory domain.
Name Description Schema Indicates whether BranchCace optimization is enabled. BranchCache optimization technology copies content from is_branch_cac he_enabled optional your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content boolean locally rather than over the WAN. Values are: - true BranchCache is enabled. - false - BranchCache is disabled.
smb_share_instance This resource type has queriable association from file_system Name description optional Description Schema User defined SMB share description. string file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id optional id optional file_system_instance The file system from which the share was created. string Id of the SMB Share. string Indicates whether Access-based Enumeration (ABE) is is_ABE_enable enabled.
Name Description Schema offline_availa SMBShareOfflineAv bility ailabilityEnum optional offline_availa bility_l10n optional Localized message string corresponding to offline_availability string Local path to the file system or any existing sub-folder of the file system that is shared over the network. This path is relative to the NAS Server and must start with the path optional filesystem’s mountpoint path, which is the filesystem name.
Name is_continuous _availability_e nabled optional is_encryption_ enabled optional Description Schema 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 boolean enabled for the SMB Share. - false - Continuous availability for SMB 3.0 is disabled for the SMB Share. Indicates whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
Name port optional source_email optional Description Schema Port used for sending SMTP messages. Minimum value : 0 integer (int32) Maximum value : 65535 Source email address used for sending SMTP messages. string smtp_config_test Name email_address optional Description Schema Destination email address for the test. string snapshot_rule_create Snapshot rule create request. Name Description days_of_week Days of the week when the rule should be applied.
Name delete_snaps optional Description Schema Specify whether all snapshots previously created by this rule should also be deleted when this rule is removed. boolean Default : false snapshot_rule_instance Snapshot rule instance. This resource type has queriable association from policy Name Description Schema days_of_week Days of the week when the rule should be applied. Applies < DaysOfWeekEnum optional only for rules where the time_of_day parameter is set.
Name Description Schema Time of the day to take a daily snapshot, with format time_of_day "hh:mm" in 24 hour time format. Either the interval optional parameter or the time_of_day parameter will be set, but not string both. snapshot_rule_modify Snapshot rule modify request. Name Description days_of_week Days of the week when the rule should be applied. Applies < DaysOfWeekEnum optional only for rules where the time_of_day parameter is set.
Name installed_date optional Description Schema Date and time when the software was successfully installed and committed on the cluster. If the software package has string (date-time) not been commited, this value is null. Whether this information represents the common software is_cluster release version that is supported on all appliances in the optional cluster. The value is true for the instance representing the boolean cluster. The value is false for appliance software instances.
Name Description Schema Whether a reboot is required during the upgrade process. boolean is_reboot_req uired optional justification_l 10n optional Explanation of why this software release is recommended for this cluster. name Name of the software package. This property supports case- optional insensitive filtering release_id Release ID of software package used to determine if an optional appliance should be upgraded.
space_metrics_by_appliance Space metrics for the appliance collected at five minute interval. Polymorphism : Inheritance Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. data_physical _used optional data_reductio n optional Schema string This metric represents amount of physical space user data occupies after deduplication and compression.
Name Description Schema Total combined space on the physical drives of the physical_total appliance available for data. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Total physical space consumed in the appliance, accounting physical_used for all efficiency mechanisms, as well as all data protection. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
Polymorphism : Inheritance Discriminator : entity Name Description Schema appliance_id Reference to the associated appliance on which these optional metrics were recorded. entity string string required last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_data_red uction Last data reduction space during the period. number (float) Last efficiency ratio during the period.
Name Description Schema Last thin savings ratio during the period. number (float) last_thin_savi ngs optional 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 uction Maximum data reduction space during the period. number (float) Maximum efficiency ratio during the period.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) space_metrics_by_cluster Space metrics for the cluster collected at five minute interval. Polymorphism : Inheritance Discriminator : entity Name cluster_id optional data_physical _used optional data_reductio n optional Description Schema Identifier of the cluster.
Name logical_provis ioned optional Description Schema Total configured size of all storage ojects within the cluster. This metric includes all primaries, snaps and clones. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 Amount of data in bytes written to all storage objects within the cluster, without any deduplication and/or logical_used compression. This metric includes all primaries, snaps and optional clones.
Name Description Schema Ratio of all the vVol provisioned to data they contain. This is the ratio of logical_provisioned to logical_used. For thin_savings example, a cluster has two 2 GB objects and have written optional 500 MB bytes of data to them. The thin savings would be (2 number (float) * 2 GB) / (2 * 0.5 GB) or 4:1, so the thin_savings value would be 4.0. timestamp optional End of sample period.
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_physical_ Last physical total space during the period. total Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_physical_ Last physical used space during the period.
Name Description Schema max_physical Maximum physical total space during the period. _total Minimum value : 0 optional Maximum value : 9223372036854775807 max_physical Maximum physical used space during the period. _used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) integer (int64) max_shared_l Maximum shared logical used during the period.
Name Description Schema Amount of data in bytes written to primary and clone logical_used virtual volumes within the storage container. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snapshot_ savings Last snapshot savings during the period. number (float) optional max_logical_p Maximum logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space during the period.
Name logical_provis ioned optional Description Schema Total configured size in bytes of all member volumes in a volume group. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Total amount of data in bytes written to all member logical_used volumes in a volume group. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
space_metrics_by_vg_rollup Summary of volume group level space metric data for one hour or one day period beginning with timestamp, including the maximum and final values for that period. Polymorphism : Inheritance Discriminator : entity Name Description Schema entity string required last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period.
Name Description Schema Max snapshot savings space during the period. number (float) Max thin savings ratio during the period. number (float) max_snapshot _savings optional max_thin_savi ngs optional repeat_count optional timestamp optional vg_id optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Unique identifier representing a specific volume group.
Name Description Schema Total Amount of data in bytes host has written to all volumes used snap_clone_lo deduplication, by virtual compression machine or sharing. without This any metric gical_used includes snaps and clones in the volume family used by integer (int64) optional virtual machine.
Name Description entity Schema string required last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snap_clon Last snap and clone logical used space during the period.
Name Description Schema Max thin savings ratio during the period. number (float) max_thin_savi ngs optional max_unique_ Max unique physical used space during the period. physical_used Minimum value : 0 optional repeat_count optional timestamp optional vm_id optional integer (int64) Maximum value : 9223372036854775807 Number of times the metrics are repeated. integer (int32) Minimum value : 0 Maximum value : 2147483647 End of sample period.
Name repeat_count optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 Ratio of all the volumes provisioned to data being written thin_savings optional to them. For example, an appliance has two 2 GB volumes and have written 500 MB of data to them. The thin savings number (float) would be (2 GB * 2) / (0.5 GB * 2) or 4:1, so the thin_savings value would be 4.0. timestamp optional volume_id optional End of sample period.
Name Description Schema Amount of data in bytes host has written to a volume logical_used optional family without any deduplication, compression or sharing. This metric includes primaries, snaps and clones. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
Polymorphism : Inheritance Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. entity optional string string required family_id Schema ID of the family. string last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period.
Name Description Schema max_shared_l Max shared logical used space during the period. ogical_used Minimum value : 0 optional Maximum value : 9223372036854775807 max_snap_clo ne_logical_use d optional integer (int64) Max snap and clone logical used space during the period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 max_snapshot _savings Max snapshot savings space during the period. number (float) optional max_unique_ Max unique physical used space during the period.
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_thin_savi ngs Last thin savings ratio during the period. number (float) optional max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Max logical used space during the period.
Name Description Schema The number of bytes that can be provisioned against this storage container. This must be a value greater than 10Gb quota and the default is 0 which means no limit. optional Default : 0 integer (int64) Minimum value : 0 Maximum value : 4611686018427387904 storage_container_delete Parameters for storage container delete. Name Description Schema Normally, deletion of a storage container that is mounted force or still contains virtual volumes will be rejected.
Name virtual_volum es optional Description Schema This is the inverse of the resource type virtual_volume association. < virtual_volume_inst ance > array storage_container_modify Parameters for storage container modify. Name Description Schema New name for the storage container that is unique across name optional all storage containers in the cluster. The name must be between 1 and 64 UTF-8 characters (inclusive), and not string more than 127 bytes.
Name chap_mutual_ username optional Description Schema Username for CHAP authentication. This value must be 1 to 64 printable UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication. string Length : 1 - 64 Password for CHAP authentication. This value must be 12 chap_single_p to 64 printable UTF-8 characters. CHAP password is assword required when optional authentication.
Name instance_uuid optional username optional Description Schema UUID instance of the vCenter. string User name to login to vCenter. string vcenter_modify Name Description address IP address of vCenter host, in IPv4, IPv6, or hostname optional format. Must be a new address of the same vCenter. password optional Password to login to vCenter. username User name to login to vCenter. Password needs to be optional provided to modify the user name.
Name ip_ports optional Description Schema This is the inverse of the resource type ip_port association. < ip_port_instance > array Indicates whether the virtual Ethernet port’s link is up. Values are: is_link_up optional true boolean Link is up. false Link is down. mac_address optional Virtual Ethernet port MAC address. string name Virtual Ethernet port name.
Name Description children This is the inverse of the resource type virtual_machine optional association. Schema < virtual_machine_ins tance > array Number of virtual CPUs in the VM. Not applicable to VM cpu_count snapshots. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 description optional Description of the VM in vCenter. guest_os Guest operating system of the VM. Not applicable to VM optional snapshots. id Unique identifier of the VM instance.
Name protection_po licy optional protection_po licy_id optional Description This is Schema the embeddable reference form of protection_policy_id attribute. Unique identifier of the protection policy assigned to the VM. Not applicable to template and snapshot VMs.
virtual_machine_snapshot_response The response to a virtual_machine snapshot request. Name id optional Description Schema Unique id of the new snapshot. string 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.
Name Description Schema Localized message string corresponding to creator_type string creator_type_l 10n optional Family id of the virtual volume. This is the id of the family_id optional primary object at the root of the family tree. For a primary virtual volume this will be the same as the id of the object. string For snap-sets and clone vVols it will be set to the source objects family ID.
Name Description Schema parent This is the embeddable reference form of parent_id virtual_volume_inst optional attribute. ance For snapshots and clones, the ID of the parent virtual parent_id volume. The parent_id is set when an virtual volume is optional created and will only change if its parent virtual volume is string deleted. profile_id optional size optional The ID of the storage profile governing this virtual volume. string The size of the virtual volume in bytes.
Name Description Schema usage_type VirtualVolumeUsage optional TypeEnum usage_type_l1 0n Localized message string corresponding to usage_type string UUID of the virtual machine that owns this virtual volume. string optional virtual_machi ne_uuid optional 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 Time when the snapshot was created. string (date-time) source_timest amp optional volume_attach Name host_group_id optional Description Schema Unique identifier of the host group to be attached to the volume. Only one of host_id or host_group_id can be string supplied. host_id Unique identifier of the host to be attached to the volume. optional Only one of host_id or host_group_id can be supplied. string logical_unit_n Logical unit number for the host volume access.
Name Description Schema Unique identifier of the performance policy. string Unique identifier of the protection policy. string performance_ policy_id optional protection_po licy_id optional volume_clone_response Unique identifier of the new clone volume. Name Schema id string optional volume_create Name Description appliance_id Identifier of the appliance on which the volume is optional provisioned.
Name min_size optional name required performance_ policy_id optional protection_po licy_id optional Description Schema Optional minimum size for the volume, in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Unique name for the volume to be created. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 Unique identifier of the performance policy assigned to the volume.
volume_group_add_members Request to add members to a volume group. Name Description Schema A list of primary or clone volumes to be added to the volume_ids required volume group. Snapshots cannot be added to a volume group. All the volumes should be on the same appliance as < string > array the current members of the volume group. This list cannot be empty. volume_group_clone Clone volume group request.
volume_group_create Create volume group request. Name Description Schema Description for the volume group. The description should not be more than 256 characters long and should not have description optional any unprintable characters. If description is not specified, the description for the string volume group will not be set. Maximal length : 256 A boolean flag to indicate whether snapshot sets of the is_write_order volume group will be write-order consistent.
Name Description Schema By default, the members of a volume group being deleted delete_membe rs optional are only removed. Set this optional parameter to true to override this behavior and also delete the members after they are removed from the volume group. This parameter boolean defaults to false, if not specified. Default : false volume_group_instance Information about a volume group.
Name Description Schema Indicates whether this volume group is a replication destination. A replication destination will be created by the system when a replication session is created. When there is an active replication session, all the user operations are restricted including modification, deletion, host operation, snapshot, clone, etc.
Name Description Schema protection_da protection_data_inst ta ance optional protection_po licy optional This is the embeddable reference form of protection_policy_id attribute. policy_instance protection_po Unique identifier of the protection policy assigned to the licy_id volume group. This attribute is only applicable to primary string optional and clone volume groups.
Name Description New value Schema for is_replication_destination property. is_replication_destination property of all the volumes in the volume group will be modified to the specified value. Modification of is_replication will not be transactional in nature. If the command only succeeds in modifying the is_replication _destination optional is_replication_destination property of a subset of volumes, is_replication_destination property for the volume group will be set to true.
Name Description Schema This parameter specifies whether a backup snapshot set of create_backu the target volume group needs to be created before p_snap refreshing it. This parameter defaults to true, if not boolean optional specified. Default : true from_object_i d required Unique identifier of the volume group to refresh from. This is referred to as the source volume group. string volume_group_refresh_response volume group refresh response.
Name Description Schema This parameter specifies whether a backup snapshot set of create_backu the target volume group needs to be created before p_snap attempting restore. This parameter defaults to true, if not boolean optional specified. Default : true from_snap_id Unique identifier of the snapshot set to restore from. This is required referred to as the source volume group. string volume_group_restore_response volume group restore response.
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 Description Schema appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id Unique identifier of the appliance on which the volume is optional provisioned. appliance_instance string creation_time stamp Time when the volume was created.
Name mapped_volu mes optional migration_ses sion optional migration_ses sion_id optional Description This is Schema the inverse of the resource type host_volume_mapping association. This is the embeddable < host_volume_mappi ng_instance > array reference form of migration_session_i migration_session_id attribute. nstance Unique identifier of the migration session assigned to the volume if it is part of a migration activity. string Name of the volume.
Name Description Schema Size of the volume in bytes. Minimum volume size is 1MB. size optional Maximum volume size is 256TB. Size must be a multiple of 8192.
Name Description Schema Normally a replication destination volume cannot be modified since it is controlled by replication. However, there can be cases where replication has failed or is no longer active and the replication destination volume needs force optional to be cleaned up.
Name Description Schema Profile for the backup snapshot. volume_snapshot backup_snap_ profile optional create_backu Indicates whether to create a backup snapshot of the p_snap volume before refreshing. optional Default : false from_object_i d required boolean Unique identifier of the source object of the refresh operation. The refresh operation only refreshes the data. string volume_refresh_response Unique identifier of the backup snapshot if one is created.
Name Schema backup_snapshot_id optional string volume_snapshot Name Description Schema creator_type StorageCreatorType optional Enum description optional Description of the snapshot. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 Expiration time of the snapshot. Expired snapshots are expiration_ti deleted by the snapshot aging service that runs periodically mestamp in the background.
Name Description Schema description string optional error_code Minimum value : 0 optional Maximum value : 2147483647 integer (int32) wear_metrics_by_drive_instance Wear metrics for the drives collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description Schema drive_id Reference to the associated drive which these metrics were optional recorded. entity string string required percent_endu rance_remain ing The percentage of drive wear remaining.
Name port required Description Schema Peer’s port number. Minimum value : 0 integer (int32) Maximum value : 65535 service X509CertificateServi required ceEnum username Username used required PowerStore cluster. in basic authentication to remote string x509_certificate_instance Name id optional Description Schema Unique identifier of X509 Certificate instance.
Name type_l10n optional 770 Description Schema Localized message string corresponding to type string Dell EMC PowerStore REST API Reference Guide