Reference Guide

ManualsBrandsDell ManualsCompellent (SCPowerStore 9000T

Table Of Contents

Dell EMC PowerStore

REST API Reference Guide

June 2021

Rev. A03

trademarks may be trademarks of their respective owners.

Summary of content (947 pages)

PAGE 1
Dell EMC PowerStore REST API Reference Guide © 2021 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. June 2021 Rev.
PAGE 2
Storage cluster API Table of Contents Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Version 2.0.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 3
chap_config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 GET /chap_config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 GET /chap_config/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 PATCH /chap_config/{id} .
PAGE 4
PATCH /file_dns/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 file_ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 GET /file_ftp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 5
DELETE /file_ndmp/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 PATCH /file_ndmp/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 file_nis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 GET /file_nis . . . . . . .
PAGE 6
GET /hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 GET /hardware/{id}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 PATCH /hardware/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 POST /hardware/{id}/drive_repurpose. . . .
PAGE 7
POST /import_psgroup/{id}/discover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 import_psgroup_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 GET /import_psgroup_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 GET /import_psgroup_volume/{id} . . . . . . . . . . . . . . . . . . . .
PAGE 8
POST /import_unity_volume/{id}/import_snapshot_schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 import_vnx_array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 GET /import_vnx_array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 GET /import_vnx_array/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 9
PATCH /ldap_account/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 ldap_domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 GET /ldap_domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 POST /ldap_domain . . . . . . . . . .
PAGE 10
DELETE /migration_session/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 POST /migration_session/{id}/pause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 POST /migration_session/{id}/resume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 POST /migration_session/{id}/sync . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 11
PATCH /nfs_export/{id}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 nfs_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 GET /nfs_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 POST /nfs_server . . . . . .
PAGE 12
POST /remote_syslog_server/{id}/test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 remote_system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 GET /remote_system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 POST /remote_system . . . . . . . . . . . . . . .
PAGE 13
PATCH /service_user/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 smb_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 GET /smb_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 POST /smb_server . . . . . . . . .
PAGE 14
POST /software_package/{id}/install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 POST /software_package/{id}/puhc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 storage_container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 GET /storage_container . . . . . . . . . . . . . . . . . . . .
PAGE 15
volume_group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 GET /volume_group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 POST /volume_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 GET /volume_group/{id} . . . . . . . . .
PAGE 16
FileInterfaceRouteOperationalStatusEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324 FileLDAPAuthenticationTypeEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324 FileLDAPProtocolEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325 FileLDAPSchemaTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 17
IpPurposeTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 IpVersionTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 JobPhaseEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 JobStateEnum . . . . . . . . . . .
PAGE 18
ReplicationStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 ResourceActionEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 ResourceTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 SCStatusEnum. . . . . . . . . . . . . . .
PAGE 19
VolumeBlockSizeEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 VolumeImportableCriteriaEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 VolumeStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 VolumeStatusEnum . . . . . . . . . . . . . . . . .
PAGE 20
base_performance_metrics_by_fe_eth_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 base_performance_metrics_by_fe_eth_port_rollup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406 base_performance_metrics_by_fe_fc_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408 base_performance_metrics_by_fe_fc_node_rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 21
base_performance_metrics_file_by_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487 base_performance_metrics_file_by_node_rollup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488 base_response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490 base_space_metrics_by_appliance. . . . . . . . . . . . . . . . . . . . .
PAGE 22
consistency_group_member_host_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529 copy_metrics_by_appliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 copy_metrics_by_cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531 copy_metrics_by_remote_system . . . . . . . . . . . . . . . . . . .
PAGE 23
file_ldap_modify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571 file_ndmp_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573 file_ndmp_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573 file_ndmp_modify . . . .
PAGE 24
host_virtual_volume_mapping_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612 host_volume_mapping_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613 import_host_initiator_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613 import_host_system_create . . . . . . . . . . . . . . . . . . . . . . .
PAGE 25
ip_port_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652 job_appliance_create_error_response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653 job_appliance_forecast_response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653 job_appliance_time_to_full_response . . . . . . . . .
PAGE 26
local_user_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677 local_user_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678 local_user_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 27
nfs_server_unjoin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720 node_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720 ntp_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720 ntp_modify . . .
PAGE 28
sdnas_smb_v1_node_metrics_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808 sdnas_smb_v1_node_metrics_rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809 sdnas_smb_v2_client_metrics_instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811 sdnas_smb_v2_client_metrics_rollup . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 29
replication_start_failover_test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853 replication_stop_failover_test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853 role_instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854 sas_port_instance. . . . . . . . . .
PAGE 30
space_metrics_by_vm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898 space_metrics_by_vm_rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899 space_metrics_by_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901 space_metrics_by_volume_family . . . . . . . . .
PAGE 31
volume_group_restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931 volume_group_restore_response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931 volume_group_snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931 volume_group_snapshot_response . . . . . . . . . . .
PAGE 32
• GET /remote_support_contact/{id} • PATCH /remote_support_contact/{id} • GET /remote_syslog_server • POST /remote_syslog_server • DELETE /remote_syslog_server/{id} • GET /remote_syslog_server/{id} • PATCH /remote_syslog_server/{id} • POST /remote_syslog_server/{id}/test • POST /replication_session/{id}/start_failover_test • POST /replication_session/{id}/stop_failover_test • PATCH /security_config/{id} • GET /snmp_server • POST /snmp_server • DELETE /snmp_server/{id} • GET /snmp_server/{id} • PATCH /snmp_s
PAGE 33
• External_Replication_Iscsi in IpPurposeTypeEnum • performance_metrics_by_ip_port, performance_metrics_file_by_appliance, performance_metrics_file_by_node, performance_metrics_file_by_cluster, wear_metrics_by_drive_daily in MetricsEntityEnum • Migration_Start_Failed in MigrationRecommendationStateEnum • Evacuate_Objects in MigrationRecommendationTypeEnum • start_failover_test, stop_failover_test in ResourceActionEnum • Pre_Upgrade_HCI in SoftwarePackageTypeEnum Definitions Deprecated • VGPlacementRule •
PAGE 34
• SNMPSeverityEnum • SNMPVersionEnum • SecurityProtocolModeEnum • SoftwareInstalledBuildFlavorEnum • SoftwareInstalledBuildTypeEnum • SoftwarePackageBuildFlavorEnum • SoftwarePackageBuildTypeEnum • TimeZoneEnum • VendorProviderStatusEnum • alert_instance::snmp_sent_timestamp • appliance_create • appliance_create_error_response • appliance_delete • appliance_instance::drive_failure_tolerance_level_l10n • appliance_validate_create • appliance_validate_create_response • base_performance_metrics_by_ip_port • ba
PAGE 35
• base_performance_metrics_by_smb_node_rollup::max_total_bandwidth • base_performance_metrics_file_by_appliance • base_performance_metrics_file_by_appliance_rollup • base_performance_metrics_file_by_cluster • base_performance_metrics_file_by_cluster_rollup • base_performance_metrics_file_by_node • base_performance_metrics_file_by_node_rollup • base_space_metrics_by_appliance::logical_used_volume • base_space_metrics_by_appliance::logical_used_file_system • base_space_metrics_by_appliance::logical_used_vvol
PAGE 36
• base_space_metrics_by_cluster_rollup::last_shared_logical_used_file_system • base_space_metrics_by_cluster_rollup::last_shared_logical_used_vvol • base_space_metrics_by_cluster_rollup::max_logical_used_volume • base_space_metrics_by_cluster_rollup::max_logical_used_file_system • base_space_metrics_by_cluster_rollup::max_logical_used_vvol • base_space_metrics_by_cluster_rollup::max_shared_logical_used_volume • base_space_metrics_by_cluster_rollup::max_shared_logical_used_file_system • base_space_metrics_by
PAGE 37
• file_tree_quota_modify::grace_period • hardware_instance::stale_state_l10n • host_instance::type_l10n • ip_pool_address_instance::name • job_appliance_create_error_response • job_appliance_validate_create_response • job_cluster_create_error_response • job_cluster_validate_create_response • job_instance::response_status_l10n • job_replication_session_stop_failover_test_response • job_x509_certificate_csr_response • migration_recommendation_action::active • migration_recommendation_action_modify • migration
PAGE 38
• remote_support_contact_modify::phone • remote_syslog_server_create • remote_syslog_server_instance • remote_syslog_server_instance::protocol_type_l10n • remote_syslog_server_instance::encryption_l10n • remote_syslog_server_instance::status_l10n • remote_syslog_server_modify • remote_syslog_server_test • remote_system_instance::version • replication_session_failover::use_test_copy • replication_session_failover::failover_snapshot_id • replication_session_instance::last_sync_duration • replication_session_i
PAGE 39
• software_package_instance::build_flavor_l10n • software_package_instance::build_type_l10n • validate_create_issue • vasa_provider_credentials • vcenter_delete • vcenter_instance::vendor_provider_status_l10n • veth_port_instance::partner_id • virtual_machine_instance::vcenter_id • volume_group_modify::expiration_timestamp • volume_group_snapshot::expiration_timestamp • volume_instance::nsid • volume_instance::nguid • wear_metrics_by_drive_daily_instance • x509_certificate_create • x509_certificate_csr • x5
PAGE 40
• vcenter_instance_uuid in virtual_machine_instance Added • snmp_sent_timestamp in alert_instance • drive_failure_tolerance_level in appliance_instance • drive_failure_tolerance_level_l10n in appliance_instance • read_bandwidth in base_performance_metrics_by_nfs • write_bandwidth in base_performance_metrics_by_nfs • total_bandwidth in base_performance_metrics_by_nfs • avg_read_bandwidth in base_performance_metrics_by_nfs_rollup • avg_write_bandwidth in base_performance_metrics_by_nfs_rollup • avg_total_band
PAGE 41
• last_shared_logical_used_vvol in base_space_metrics_by_appliance_rollup • max_logical_used_volume in base_space_metrics_by_appliance_rollup • max_logical_used_file_system in base_space_metrics_by_appliance_rollup • max_logical_used_vvol in base_space_metrics_by_appliance_rollup • max_shared_logical_used_volume in base_space_metrics_by_appliance_rollup • max_shared_logical_used_file_system in base_space_metrics_by_appliance_rollup • max_shared_logical_used_vvol in base_space_metrics_by_appliance_rollup • l
PAGE 42
• hardware_parent_id in eth_port_instance • stale_state in eth_port_instance • stale_state_l10n in eth_port_instance • hardware_parent in eth_port_instance • wwn_nvme in fc_port_instance • hardware_parent_id in fc_port_instance • protocols in fc_port_instance • stale_state in fc_port_instance • protocols_l10n in fc_port_instance • stale_state_l10n in fc_port_instance • hardware_parent in fc_port_instance • grace_period in file_tree_quota_create • grace_period in file_tree_quota_instance • grace_period in fi
PAGE 43
• first_name in remote_support_contact_instance • last_name in remote_support_contact_instance • email in remote_support_contact_instance • phone in remote_support_contact_instance • last_name in remote_support_contact_modify • first_name in remote_support_contact_modify • email in remote_support_contact_modify • phone in remote_support_contact_modify • protocol_type_l10n in remote_syslog_server_instance • encryption_l10n in remote_syslog_server_instance • audit_types_l10n in remote_syslog_server_instance •
PAGE 44
• build_id in software_installed_instance • build_flavor_l10n in software_installed_instance • build_type_l10n in software_installed_instance • build_version in software_package_instance • build_flavor in software_package_instance • build_type in software_package_instance • build_id in software_package_instance • build_flavor_l10n in software_package_instance • build_type_l10n in software_package_instance • vasa_provider_credentials in vcenter_create • vendor_provider_status in vcenter_instance • vendor_pro
PAGE 45
• PATCH /ldap_account/{id} • GET /ldap_domain • POST /ldap_domain • DELETE /ldap_domain/{id} • GET /ldap_domain/{id} • PATCH /ldap_domain/{id} • POST /ldap_domain/{id}/verify Enumeration values Added • LDAP_HTTP, Syslog_HTTP in X509CertificateServiceEnum Definitions Added • LDAPAccountTypeEnum • LDAPProtocolEnum • LDAPServerTypeEnum • ldap_account_create • ldap_account_instance • ldap_account_instance::type_l10n • ldap_account_modify • ldap_domain_create • ldap_domain_instance • ldap_domain_instance::ldap
PAGE 46
Paths Added • POST /import_session/{id}/enable_destination_volume • POST /import_session/{id}/start_copy • GET /import_xtremio • GET /import_xtremio/{id} • POST /import_xtremio/{id}/discover • GET /import_xtremio_consistency_group • GET /import_xtremio_consistency_group/{id} • POST /import_xtremio_consistency_group/{id}/import_snapshot_schedules • GET /import_xtremio_volume • GET /import_xtremio_volume/{id} • POST /import_xtremio_volume/{id}/import_snapshot_schedules Enumeration values Added • Ready_For_Ag
PAGE 47
• XtremIOObjectSeverityEnum • XtremIOPlatformEnum • XtremIOScheduleStateEnum • XtremIOScheduleTypeEnum • XtremIOStateEnum • consistency_group_member_host_mapping • import_psgroup_instance::supported_import_type_l10n • import_session_enable_destination_volume • import_session_instance::type_l10n • import_storage_center_instance::supported_import_type_l10n • import_unity_instance::supported_import_type_l10n • import_vnx_array_instance::supported_import_type_l10n • import_xtremio_consistency_group_import_snaps
PAGE 48
Definition members Deprecated • state in job_instance • state_l10n in job_instance Added • supported_import_type in import_psgroup_instance • supported_import_type_l10n in import_psgroup_instance • type in import_session_create • host_ids in import_session_create • consistency_group_member_host_ids in import_session_create • type in import_session_instance • type_l10n in import_session_instance • supported_import_type in import_storage_center_instance • supported_import_type_l10n in import_storage_center_in
PAGE 49
• certainty_l10n in import_xtremio_volume_instance • importable_criteria_l10n in import_xtremio_volume_instance • import_xtremio in import_xtremio_volume_instance • import_xtremio_consistency_group in import_xtremio_volume_instance • phase in job_instance • phase_l10n in job_instance Resources alert Use these resource types to manage events and alerts in the system. GET /alert Description Query all alerts.
PAGE 50
Responses HTTP Description Schema 200 Success alert_instance 404 Not Found error_response Code 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.
PAGE 51
appliance Manage appliances GET /appliance Description Query the appliances in a cluster. Responses HTTP Code Description Schema < 200 Success appliance_instanc e > array < 206 Partial content of appliance instance objects appliance_instanc e > array POST /appliance Description Add an appliance to an existing cluster. The cluster consisting of a single appliance without a 4-Port Card installed cannot be extended.
PAGE 52
Type Name body Body required Schema appliance_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request 422 Operation Failed Code appliance_create_ error_response error_response POST /appliance/validate_create Description Validate the add appliance configuration. Success is returned when all the validations have been run. The response includes any detected issues. Was added in version 2.0.0.0.
PAGE 53
GET /appliance/{id} Description Query a specific appliance in a cluster. Parameters Type Name id Path required Description Schema Unique identifier of the appliance. string Responses HTTP Code Description 200 Success 404 Not found Schema appliance_instanc e error_response Consumes • application/json Produces • application/json DELETE /appliance/{id} Description Remove an appliance from a cluster. Was added in version 2.0.0.0.
PAGE 54
Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • application/json Produces • application/json PATCH /appliance/{id} Description Modify an appliance. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the appliance.
PAGE 55
HTTP Code 422 Description Schema Operation Failed error_response Consumes • application/json Produces • application/json POST /appliance/{id}/forecast Description Forecast capacity usage for an appliance. Parameters Type Name id Path required body Body required Description Schema Unique id of the appliance.
PAGE 56
Produces • application/json POST /appliance/{id}/time_to_full Description Returns information about when an appliance is forecast to reach 100% capacity usage. Parameters Type Name id Path required Body Description Schema Unique id of the appliance.
PAGE 57
Description Query audit log entries. Responses HTTP Code Description Schema < 200 OK audit_event_insta nce > array < 206 Partial content of audit event instance objects audit_event_insta nce > array Produces • application/json bond Use this resource types to manage the configuration of bonds. Bonds are implemented in pairs on each storage processor of the appliance. GET /bond Description Query bonds.
PAGE 58
Parameters Type Name id Path required Description Schema Unique identifier of the bond. string Responses HTTP Description Schema 200 Success bond_instance 404 Not Found error_response Code Consumes • application/json Produces • application/json chap_config CHAP is enabled (or not) identically cluster-wide for all iSCSI targets. For both single and mutual CHAP authentication modes, the common username and password for all targets on the cluster are set here.
PAGE 59
HTTP Code Description Schema < 200 Success chap_config_insta nce > array < 206 Partial content of chap config instance objects chap_config_insta nce > array GET /chap_config/{id} Description Query the CHAP configuration settings object. Parameters Type Path Name Description id The id of the CHAP configuration object (always required "0").
PAGE 60
Type Name Description body Body required Schema chap_config_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code cluster Manage clusters GET /cluster Description Query the details about the cluster. This resource type collection query does not support filtering, sorting or pagination.
PAGE 61
POST /cluster Description Create a Power Store or Power Store X Cluster of one or more appliances. • You can create a cluster of up to 4 appliances. • All parameters in vcenters object are mandatory when creating a Power Store X cluster. • When creating a multi-appliance cluster, the most capable appliance is chosen as the Primary appliance based on the appliance configuration type. • All of the appliances must have the 4-Port Card installed to be added into a multi-appliance cluster.
PAGE 62
Description Validate the create cluster configuration for a PowerStore or PowerStore X Cluster of one or more appliances. Success is returned when all the validations have been run. The response shows whether any of the validations detected any issues. Was added in version 2.0.0.0.
PAGE 63
HTTP Code 404 Description Schema Not Found error_response Produces • application/json PATCH /cluster/{id} Description Update properties of the cluster. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the cluster.
PAGE 64
POST /cluster/{id}/forecast Description Forecast capacity usage for the cluster. Parameters Type Name id Path required Description Schema Unique id of the cluster.
PAGE 65
Type Name id Path required Description Schema Unique id of the cluster string body Body required cluster_time_to_full Responses HTTP Code Description Schema cluster_time_to_fu 200 Successful operation.
PAGE 66
HTTP Code Description Schema < 200 Success discovered_initiat or_instance > array < 206 Partial content of discovered initiator instance objects discovered_initiat or_instance > array Produces • application/json dns Manage DNS and NTP settings for the cluster. GET /dns Description Query DNS settings for a cluster.
PAGE 67
Type Name id Path required Description Schema Unique identifier of the DNS setting. string Responses HTTP Description Schema 200 Success dns_instance 404 Not Found error_response Code Consumes • application/json Produces • application/json PATCH /dns/{id} Description Modify a DNS setting. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the DNS setting.
PAGE 68
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code Consumes • application/json Produces • application/json email_notify_destination Use these resource types to configure outgoing SMTP and email notifications. GET /email_notify_destination Description Query all email notification destinations.
PAGE 69
Parameters Type Name body Body required Description Email address to receive notifications. Schema email_notify_destina tion_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /email_notify_destination/{id} Description Query a specific email notification destination. Parameters Type Path Name Description id Unique identifier of the email notification required destination.
PAGE 70
Parameters Type Path Name Description id Unique identifier of the email notification required destination. Schema string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /email_notify_destination/{id} Description Modify an email notification destination. Parameters Type Path Name Description id Unique identifier of the email notification required destination.
PAGE 71
POST /email_notify_destination/{id}/test Description Send a test email to an email address. Parameters Type Path Name Description id Unique identifier of the email notification required destination. Schema string Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code eth_port This is the REST API for cluster-wide retrieval and configuration of Ethernet front-end ports.
PAGE 72
HTTP Code Description Schema < 206 Partial content of eth port instance objects eth_port_instance > array GET /eth_port/{id} Description Get Ethernet front-end port configuration by instance identifier. Parameters Type Name id Path required Description Schema Ethernet front-end port instance identifier. string Responses HTTP Description Schema 200 Success eth_port_instance 404 Not Found error_response Code PATCH /eth_port/{id} Description Change the properties of the front-end port.
PAGE 73
Type Name Description body Body required Schema eth_port_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code event Use these resource types to manage events and alerts in the system. GET /event Description Returns all events in the database.
PAGE 74
Parameters Type Name id Path required Description Schema Event Id string Responses HTTP Description Schema 200 Event Object event_instance 404 Not Found error_response Code fc_port Use this resource type to retrieve information about Fibre Channel (FC) front-end ports and to set their connection speeds. GET /fc_port Description Query the FC front-end port configurations for all cluster nodes.
PAGE 75
Type Name id Path required Description Schema Unique identifier of the FC front-end port. string Responses HTTP Description Schema 200 Success fc_port_instance 404 Not Found error_response Code PATCH /fc_port/{id} Description Modify an FC front-end port’s speed. Setting the port’s requested speed might not cause the port speed to change immediately.
PAGE 76
HTTP Code 422 Description Schema 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. A DNS is a hierarchical system responsible for converting domain names to their corresponding IP addresses.
PAGE 77
Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /file_dns/{id} Description Query a specific DNS settings object of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the DNS object.
PAGE 78
Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /file_dns/{id} Description Modify the DNS settings of a NAS Server. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the DNS object. string file_dns_modify Responses HTTP Description Schema 204 Success.
PAGE 79
such as the Internet. For secure transmission that encrypts the username, password, and content, FTP is secured with SSH (SFTP). SFTP listens on port 22. You can activate an FTP server and SFTP server independently on each NAS server. The FTP and SFTP clients are authenticated using credentials defined on a Unix name server (such as an NIS server or an LDAP server) or a Windows domain. Windows user names need to be entered using the 'username@domain' or 'domain\\username' formats.
PAGE 80
HTTP Code 422 Description Schema Operation Failed error_response GET /file_ftp/{id} Description Query a specific FTP/SFTP server for its settings. Parameters Type Name id Path required Description Schema Unique identifier of the FTP/SFTP Server object. string Responses HTTP Description Schema 200 Success file_ftp_instance 404 Not Found error_response Code DELETE /file_ftp/{id} Description Delete an FTP/SFTP Server.
PAGE 81
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code PATCH /file_ftp/{id} Description Modify an FTP/SFTP server settings. Parameters Type Name id Path required Description Schema Unique identifier of the FTP/SFTP Server object.
PAGE 82
Responses HTTP Code Description Schema < 200 file_interface_inst Success ance > array < 206 Partial content of file interface instance objects file_interface_inst ance > array POST /file_interface Description Create a file interface.
PAGE 83
Responses HTTP Code Description 200 Success 404 Not Found Schema file_interface_inst ance error_response DELETE /file_interface/{id} Description Delete a file interface. Parameters Type Name id Path required Description Schema Unique identifier of the file interface. string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /file_interface/{id} Description Modify the settings of a file interface.
PAGE 84
Type Name Body Description Schema body file_interface_modif required y Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code file_interface_route Use this resource type to manage static IP routes, including creating, modifying, and deleting these routes. A route determines where to send a packet, next so it can reach its final destination.
PAGE 85
HTTP Code Description Schema < 206 Partial content of file interface route instance objects file_interface_rout e_instance > array POST /file_interface_route Description Create and configure a new file interface route. There are three types of routes - Subnet, Default, and Host. • A default route establishes a static route to a default gateway. To create a default route, specify gateway value for the related file interface. • A host route establishes a static route to a specific host.
PAGE 86
Parameters Type Path Name Description id Unique identifier of the file interface route required object. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema file_interface_rout e_instance error_response DELETE /file_interface_route/{id} Description Delete file interface route. Parameters Type Path Name Description id Unique identifier of the file interface route required object.
PAGE 87
Parameters Type Path Body Name Description id Unique identifier of the file interface route required object. Schema string body file_interface_route_ required modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code file_kerberos Use these resources to manage the Kerberos service for a NAS server. One Kerberos service object may be configured per NAS Server.
PAGE 88
HTTP Code Description Schema < 200 Success. file_kerberos_inst ance > array < 206 Partial content of file kerberos instance objects file_kerberos_inst ance > array POST /file_kerberos Description Create a Kerberos configuration. The operation will fail if a Kerberos configuration already exists.
PAGE 89
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.
PAGE 90
Type Name Body Description Schema body file_kerberos_modif required y Responses HTTP Description Schema 204 Success. No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /file_kerberos/{id}/upload_keytab Description A keytab file is required for secure NFS service with a Linux or Unix Kerberos Key Distribution Center (KDC). The keytab file can be generated using the KDC server.
PAGE 91
HTTP Code 422 Description Schema 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.
PAGE 92
Directory schema or an RFC 2307 schema. GET /file_ldap Description List LDAP Service instances. Responses HTTP Code Description Schema < 200 Success file_ldap_instance > array < 206 Partial content of file ldap instance objects file_ldap_instance > array POST /file_ldap Description Create an LDAP service on a NAS Server. Only one LDAP Service object can be created per NAS Server. Parameters Type Name body Body required Description Schema Name of the LDAP service to create.
PAGE 93
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 Description Schema 200 Success file_ldap_instance 404 Not Found error_response Code DELETE /file_ldap/{id} Description Delete a NAS Server’s LDAP settings. Parameters Type Name id Path required Description Schema LDAP settings object Id.
PAGE 94
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.
PAGE 95
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 96
Type Name id Path required Description Schema Unique identifier of the LDAP settings object. string FormDat body a file required Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • multipart/form-data GET /file_ldap/{id}/download_certificate Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object.
PAGE 97
Produces • document/text file_ndmp Use this resource type to manage NDMP services. NDMP is 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. Storage systems support NDMP v2-v4 over the network. Direct-attach NDMP is not supported.
PAGE 98
Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code 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.
PAGE 99
Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /file_ndmp/{id} Description Modify an NDMP service configuration instance. Parameters Type Name id Path required Description Schema Unique identifier of the NDMP service object.
PAGE 100
GET /file_nis Description Query the NIS settings of NAS Servers. Responses HTTP Code Description Schema < file_nis_instance 200 Success. 206 Partial content of file nis instance objects > array < file_nis_instance > array POST /file_nis Description Create a new NIS Service on a NAS Server. Only one NIS Setting object can be created per NAS Server.
PAGE 101
Parameters Type Name id Path required Description Schema Unique identifier of the NIS object. string Responses HTTP Description Schema 200 Success file_nis_instance 404 Not Found error_response Code DELETE /file_nis/{id} Description Delete NIS settings of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the NIS object.
PAGE 102
Parameters Type Name id Path required Description Schema Unique identifier of the NIS object. string body Body required file_nis_modify Responses HTTP Description Schema 204 Success. No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code file_system Use this resource type to manage NAS file systems. GET /file_system Description Query file systems.
PAGE 103
POST /file_system Description Create a file system. Parameters Type Name body Body required Schema file_system_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /file_system/{id} Description Query a specific file system. Parameters Type Name id Path required Description Schema Unique identifier of the file system.
PAGE 104
DELETE /file_system/{id} Description Delete a file system. Parameters Type Name id Path required Description Schema Unique identifier of the file system. string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /file_system/{id} Description Modify a file system. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the file system.
PAGE 105
HTTP Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /file_system/{id}/clone Description Create a clone of a file system. Parameters Type Name id Path required Description Schema Unique identifier of the file system.
PAGE 106
Parameters Type Name id Path required Body Description Schema Unique identifier of the file system. string body file_system_snapsho optional t Responses HTTP Code Description Schema file_system_snaps 200 Success 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response hot_response POST /file_system/{id}/refresh Description Refresh a snapshot of a file system.
PAGE 107
HTTP Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /file_system/{id}/restore Description Restore from a snapshot of a file system. Success responses indicates the following: 200 Success with backup snapshot. 204 Success without backup snapshot. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the file system snapshot.
PAGE 108
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 Unique identifier of the file system. string Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code file_tree_quota Use this resource type to manage tree quota settings in the storage system.
PAGE 109
HTTP Code Description Schema < 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 body Body required Schema file_tree_quota_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /file_tree_quota/{id} Description Query a tree quota instance.
PAGE 110
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. string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /file_tree_quota/{id} Description Modify a tree quota instance.
PAGE 111
Type Name Body Description Schema body file_tree_quota_mod required ify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /file_tree_quota/{id}/refresh Description Refresh the cache with the actual value of the tree quota. Parameters Type Name id Path required Description Schema Unique identifier of the tree quota.
PAGE 112
file_user_quota User quota settings in the storage system. A user quota instance represents a quota limit applied to a user within a quota tree or a filesystem. GET /file_user_quota Description List user quota instances. Responses HTTP Code Description Schema < 200 file_user_quota_in Success stance > array < 206 Partial content of file user quota instance objects file_user_quota_in stance > array POST /file_user_quota Description Create a user quota instance.
PAGE 113
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. Parameters Type Name id Path required Body Description Schema Unique identifier of the file user quota.
PAGE 114
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 115
GET /file_virus_checker Description Query all virus checker settings of the NAS Servers. Responses HTTP Code Description Schema < 200 Success file_virus_checker _instance > array < 206 Partial content of file virus checker instance objects file_virus_checker _instance > array POST /file_virus_checker Description Add a new virus checker setting to a NAS Server. Only one instance can be created per NAS Server. Workflow to enable the virus checker settings on the NAS Server is as follows: \n 1.
PAGE 116
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. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_virus_checker _instance error_response DELETE /file_virus_checker/{id} Description Delete virus checker settings of a NAS Server.
PAGE 117
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.
PAGE 118
Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • multipart/form-data GET /file_virus_checker/{id}/download_config Description Download a virus checker configuration file containing the template or the actual (if already uploaded) virus checker configuration settings.
PAGE 119
hardware This provides the hardware component inventory of the system. GET /hardware Description Query 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. Parameters Type Name id Path required Description Schema Unique id of hardware component to get.
PAGE 120
HTTP Code 404 Description Schema Not Found error_response Produces • application/json PATCH /hardware/{id} Description Modify a hardware instance. Parameters Type Name id Path required body Body required Description Schema The hardware component to modify.
PAGE 121
POST /hardware/{id}/drive_repurpose Description A drive that has been used in a different appliance will be locked for use only in that appliance. This operation will allow a locked drive to be used in the current appliance. All data on the drive will become unrecoverable. It will fail if the drive is not locked to a different appliance. Parameters Type Name id Path required body Body required Description Schema Identifier of the drive to repurpose.
PAGE 122
Responses HTTP Code Description Schema < host_instance > 200 Success 206 Partial content of host instance objects array < host_instance > array Produces • application/json POST /host Description Add a host.
PAGE 123
GET /host/{id} Description Query details about a specific host. Parameters Type Name id Path required Description Schema Unique identifier of the host. string Responses HTTP Description Schema 200 Success host_instance 404 Not Found error_response Code Produces • application/json DELETE /host/{id} Description Delete a host. Delete fails if host is attached to a volume or consistency group.
PAGE 124
HTTP Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json PATCH /host/{id} Description Modify a host. Only one of add, remove and update initiator operations are supported in a single request. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the host.
PAGE 125
Produces • application/json POST /host/{id}/attach Description Attach host to volume. Parameters Type Name id Path required Description Schema Unique identifier of the host. string body Body required host_attach Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json POST /host/{id}/detach Description Detach host from volume.
PAGE 126
Type Name id Path required body Body required Description Schema Unique identifier of the host. string host_detach Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json host_group Use this resource type to manage host groups. A host group is a mechanism to provision hosts and volumes to be consistent across the Cyclone cluster.
PAGE 127
HTTP Code Description Schema < 206 Partial content of host group instance objects host_group_instan ce > array Produces • application/json POST /host_group Description Create a host group.
PAGE 128
Parameters Type Name id Path required Description Schema Unique identifier of the host group. string Responses 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 identifier of the host group.
PAGE 129
Produces • application/json PATCH /host_group/{id} Description Modify a host group. Modify does not support rename and add/modify at the same time. Parameters Type Name id Path required Description Schema Unique identifier of the host group.
PAGE 130
Type Name id Path required Description Schema Unique identifier of the host group. string body Body host_group_attach required Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json POST /host_group/{id}/detach Description Detach host group from volume.
PAGE 131
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json 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.
PAGE 132
Parameters Type Path Name Description id Unique required mapping. identifier Schema of the virtual volume string Responses HTTP Code Description Schema host_virtual_volu 200 Success me_mapping_inst ance 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.
PAGE 133
Description Query a specific host volume mapping. Parameters Type Name id Path required Description Schema Unique identifier of the host volume mapping. string Responses 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.
PAGE 134
GET /import_host_initiator/{id} Description Query a specific import host initiator instance. Parameters Type Path Name Description id Unique identifier of the import host initiator to required query. Schema string 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.
PAGE 135
HTTP Code Description Schema < 200 import_host_syste Success m_instance > array < 206 Partial content of import host system instance objects import_host_syste m_instance > array POST /import_host_system Description Add an import host system so that it can be mapped to a volume. Before mapping an import host system, ensure that a host agent is installed. Host agents can be installed on Linux, Windows, and ESXi host systems only.
PAGE 136
Parameters Type Path Name Description id Unique identifier of the import host system to required query. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema import_host_syste m_instance error_response DELETE /import_host_system/{id} Description Delete an 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.
PAGE 137
import host or import host volumes. Parameters Type Path Name Description id Unique identifier of the import host system for required which to refresh details. Schema string Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code import_host_volume Use these resource types to manage import host volumes.
PAGE 138
HTTP Code Description Schema < 206 Partial content of import host volume instance objects import_host_volu me_instance > array GET /import_host_volume/{id} Description Query a specific import host volume instance. Parameters Type Path Name Description id Unique identifier of the import host volume to required query.
PAGE 139
HTTP Code Description Schema < 200 Success import_psgroup_i nstance > array < 206 Partial content of import psgroup instance objects import_psgroup_i nstance > array GET /import_psgroup/{id} Description Query a specific PS Group storage array. Parameters Type Name id Path required Description Schema Unique identifier of the PS Group.
PAGE 140
Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code import_psgroup_volume Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. GET /import_psgroup_volume Description Query PS Group volumes.
PAGE 141
Parameters Type Name id Path required Description Schema Unique identifier of the PS Group volume. string Responses HTTP Code Description 200 Success 404 Not Found Schema import_psgroup_v olume_instance error_response POST /import_psgroup_volume/{id}/import_snapshot_schedules Description Return the snapshot schedules for a PS Group volume. Parameters Type Name id Path required Description Schema Unique identifier of the PS Group volume.
PAGE 142
HTTP Code 422 Description Schema Operation Failed error_response import_session Use the import_session resource type to initiate and manage the migration of volumes and consistency groups from a heritage Dell EMC storage system to a PowerStore storage system. The import is non-disruptive to hosts that access the volume during the import. The import process runs as a background job. Clients should poll the job status until the import completes.
PAGE 143
Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /import_session/{id} Description Query a specific session.
PAGE 144
Type Name id Path required Description Schema Unique identifier of the import session string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /import_session/{id} Description Modify the scheduled date and time of the specified import session. Parameters Type Name id Path required Body Description Schema Unique identifier of the import session.
PAGE 145
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. Until the cutover is complete, PowerStore forwards IO to the source volume to keep it in sync with all host IOs. You can cancel the import during this state if you want to continue using the source volume.
PAGE 146
Type Name id Path required Body Description Schema Unique identifier of the import session string body import_session_canc optional el Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /import_session/{id}/pause Description Pauses an ongoing import session. When this occurs, the background data copy stops, but IO to the source still occurs.
PAGE 147
HTTP Code 422 Description Schema 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. Resume is only applicable when the import in a Paused state.
PAGE 148
Type Name id Path required Body Description Schema Unique identifier of the import session. string body Parameters to enable destination volume of an optional agentless import session.
PAGE 149
HTTP Description Schema 404 Not found error_response 422 Operation Failed error_response Code POST /import_session/{id}/cleanup Description Clean up an import session that is in Cleanup_Required state and requires user intervention to revert the source volume to its pre-import state as part of the recovery procedure to restore host IO operations. Parameters Type Name id Path required Description Schema Unique identifier of the import session.
PAGE 150
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. Parameters Type Name id Path required Description Schema Unique identifier of the SC array.
PAGE 151
Type Name id Path required Description Schema Unique identifier of the SC array. string Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code import_storage_center_consistency_group Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore.
PAGE 152
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. string Responses HTTP Code Description Schema import_storage_ce 200 Success nter_consistency_ group_instance 404 Not Found error_response POST /import_storage_center_consistency_group/{id}/import_snapshot_profiles Description Return the snapshot profiles of an SC consistency group.
PAGE 153
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. error_response import_storage_center_volume Use these resource types to discover the Storage Center (SC) volumes that can be imported to PowerStore. GET /import_storage_center_volume Description Query SC volumes.
PAGE 154
Description Query a specific SC volume. Parameters Type Name id Path required Description Schema Unique identifier of the SC volume. string Responses HTTP Code Description Schema import_storage_ce 200 Success nter_volume_insta nce 404 Not Found error_response POST /import_storage_center_volume/{id}/import_snapshot_profiles Description Return the snapshot profiles of an SC volume. Parameters Type Name id Path required Description Schema Unique identifier of the SC volume.
PAGE 155
HTTP Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed. error_response Code 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.
PAGE 156
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.
PAGE 157
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. Parameters Type Name id Path required Description Schema Unique identifier of the Unity consistency group.
PAGE 158
Parameters Type Name id Path required Description Schema Unique identifier of the Unity consistency group. string Responses HTTP Code Description Schema import_unity_cons 200 Success istency_group_im port_snapshot_sch edules_response 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response import_unity_volume Use this resource type to discover the Unity volumes that can be imported to PowerStore.
PAGE 159
HTTP Code Description Schema < 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.
PAGE 160
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 Description Query VNX storage systems.
PAGE 161
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. Parameters Type Name id Path required Description Schema Unique identifier of the VNX storage system.
PAGE 162
GET /import_vnx_consistency_group Description Query VNX consistency groups. Responses HTTP Code Description Schema < 200 import_vnx_consis Success tency_group_insta nce > array < 206 Partial content of import vnx consistency group instance objects import_vnx_consis tency_group_insta nce > array GET /import_vnx_consistency_group/{id} Description Query a specific VNX consistency group. Parameters Type Name id Path required Description Schema Unique identifier of a VNX consistency group.
PAGE 163
import_vnx_volume Use this resource type to show the VNX volumes and that can be imported to PowerStore. GET /import_vnx_volume Description Query VNX volumes. Responses HTTP Code Description Schema < 200 import_vnx_volu Success me_instance > array < 206 Partial content of import vnx volume instance objects import_vnx_volu me_instance array GET /import_vnx_volume/{id} Description Query a specific VNX volume.
PAGE 164
import_xtremio Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. GET /import_xtremio Description Query XtremIO storage systems X1 and X2. Was added in version 1.0.2. Responses HTTP Code Description Schema < 200 import_xtremio_i Success nstance > array < 206 Partial content of import xtremio instance objects import_xtremio_i nstance > array GET /import_xtremio/{id} Description Query a specific XtremIO storage system.
PAGE 165
POST /import_xtremio/{id}/discover Description Discover the importable volumes and consistency groups in the XtremIO storage system. Was added in version 1.0.2. Parameters Type Name id Path required Description Schema Unique identifier of the XtremIO storage system.
PAGE 166
HTTP Code Description Schema < 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. Was added in version 1.0.2. Parameters Type Path Name Description id Unique identifier of the XtremIO consistency required group.
PAGE 167
Responses HTTP Code Description Schema import_xtremio_c onsistency_group_ 200 Success import_snapshot_s chedules_respons e 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response import_xtremio_volume Use these resource types to discover the XtremIO volumes and consistency groups that can be imported to PowerStore. GET /import_xtremio_volume Description Query XtremIO volumes. Was added in version 1.0.2.
PAGE 168
GET /import_xtremio_volume/{id} Description Query a specific XtremIO volume. Was added in version 1.0.2. Parameters Type Name id Path required Description Schema Unique identifier of the XtremIO volume. string Responses HTTP Code Description 200 Success 404 Not Found Schema import_xtremio_v olume_instance error_response POST /import_xtremio_volume/{id}/import_snapshot_schedules Description Return the snapshot schedules associated with the specified XtremIO volume. Was added in version 1.0.2.
PAGE 169
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 170
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.
PAGE 171
Parameters Type Name id Path required Description Schema Unique identifier of the IP port. string Responses HTTP Description Schema 200 Success ip_port_instance 404 Not Found error_response Code Consumes • application/json Produces • application/json PATCH /ip_port/{id} Description Modify IP port parameters. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the IP port.
PAGE 172
HTTP Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • application/json Produces • application/json job Use this resource type for tracking an operation’s progress and status. GET /job Description Query jobs. Responses HTTP Code Description 200 Success 206 Partial content of job instance objects Schema < job_instance > array < job_instance > array GET /job/{id} Description Query a specific job.
PAGE 173
Type Name id Path required Description Schema Unique id of the job. string Responses HTTP Description Schema 200 Success job_instance 404 Not Found error_response Code 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.
PAGE 174
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.
PAGE 175
not support filtering, sorting or pagination. Responses HTTP Code Description Schema < 200 Success ldap_account_inst ance > array < 206 Partial content of ldap account instance objects ldap_account_inst ance > array POST /ldap_account Description Create a new LDAP account. Was added in version 1.0.3.
PAGE 176
Parameters 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. Was added in version 1.0.3. Parameters Type Path Name Description id Unique identifier of the LDAP account to be required deleted.
PAGE 177
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 Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code ldap_domain Use this resource type to manage ldap configuration. GET /ldap_domain Description Query list of LDAP domain. Was added in version 1.0.3.
PAGE 178
POST /ldap_domain Description Create a new LDAP domain. Was added in version 1.0.3. Parameters Type Name body Body required Schema ldap_domain_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /ldap_domain/{id} Description Query a specific LDAP domain. Was added in version 1.0.3. Parameters Type Name id Path required Description Schema Unique identifier of the LDAP domain.
PAGE 179
DELETE /ldap_domain/{id} Description Delete an LDAP domain. Was added in version 1.0.3. Parameters Type Path Name Description id Unique identifier of the LDAP domain to be required deleted. Schema string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /ldap_domain/{id} Description Modify the properties of an LDAP domain. Was added in version 1.0.3.
PAGE 180
HTTP Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /ldap_domain/{id}/verify Description verifying the connectivity to the LDAP domain server. Was added in version 1.0.3. Parameters Type Name id Path required Description Schema Unique identifier of the instance.
PAGE 181
When an appliance is added to the cluster, the process starts over, and the cluster license will need to be updated, either automatically, or manually if network connectivity to the Software Licensing Central is not available. If the system lacks network connectivity to reach the Software Licensing Central, an alert will be raised that indicates when the trial period will expire.
PAGE 182
HTTP Code 404 Description Schema Not Found error_response POST /license/upload Description Upload a software license to install the license on the cluster. Parameters Type Name Description FormDat license_file The file to upload containing the software a license to install the license on the cluster.
PAGE 183
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 422 Operation Failed error_response Code 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.
PAGE 184
Type Name body Body required Schema local_user_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code 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.
PAGE 185
Parameters Type Path Name Description id Unique identifier of the local user account to be required deleted. Schema string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 186
HTTP Code 422 Description Schema Operation Failed error_response login_session Use these resource types to manage sessions, roles, and system security configurations. GET /login_session Description Obtain the login session for the current user. This resource type collection query does not support filtering, sorting or pagination.
PAGE 187
HTTP Description Schema 201 Success create_response 204 Success No Content 400 Invalid request error_response 422 Operation Failed error_response Code Produces • application/json 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.
PAGE 188
GET /maintenance_window/{id} Description Query one appliance maintenance window configuration. Parameters Type Path Name Description id Unique identifier of the maintenance window required configuration. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema maintenance_win dow_instance error_response PATCH /maintenance_window/{id} Description Configure maintenance window.
PAGE 189
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code metrics REST APIs Use these resource types to query historical metric data. POST /metrics/generate Description Retrieves metrics for specified type.
PAGE 190
usage and recent performance. A recommendation can then be implemented using the create_migration_sessions action, performing any necessary rescans on attached hosts, and then using start_migration_sessions. GET /migration_recommendation Description Get migration recommendations.
PAGE 191
HTTP Code 422 Description Schema Invalid Request error_response GET /migration_recommendation/{id} Description Get a single migration recommendation. Parameters Type Name id Path required Description Schema Unique ID of the migration recommendation. string Responses HTTP Code Description Schema migration_recom 200 Success mendation_instan ce 404 Not found error_response DELETE /migration_recommendation/{id} Description Delete a migration recommendation.
PAGE 192
HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Invalid Request error_response Code PATCH /migration_recommendation/{id} Description Modify migration actions by applying specified dst appliance id and active flag to the migration actions specified by resource id. All specified modifications must be successful for the request to be successful. Partially successful modifications will be rejected and the recommendation object will be unchanged.
PAGE 193
Description Create the migration sessions to implement a migration recommendation. If the response contains a list of hosts to rescan, those hosts must be rescanned before starting the sessions or the host(s) may lose access to the data when the migration completes. Parameters Type Name id Path required Description Schema Unique ID of the migration recommendation.
PAGE 194
Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request error_response Code migration_session Manage migration sessions. GET /migration_session Description Query migration sessions. Responses HTTP Code Description Schema < 200 Success migration_session _instance > array POST /migration_session Description Create a new migration session.
PAGE 195
Type Name body Body required Description Parameters to create a migration session. Schema migration_session_c reate Responses HTTP Code Description Schema migration_session 201 Created 400 Invalid Request error_response 422 Operation Failed error_response _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.
PAGE 196
Description Delete a migration session. With the force option, a migration session can be deleted regardless of its state. All background activity is canceled before deleting the session. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the migration session. string Parameters for a deletion.
PAGE 197
HTTP Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 198
Type Name id Path required Body Description Schema Unique identifier of the migration session. string body Parameters required session.
PAGE 199
HTTP Code 422 Description Schema Operation Failed error_response nas_server Use these resource types to manage NAS servers. NAS servers are software components used to transfer data and provide the connection ports for hosts to access file-based storage resources. NAS servers are independent from each other. GET /nas_server Description Query all NAS servers.
PAGE 200
HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /nas_server/{id} Description Query a specific 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.
PAGE 201
Type Name Description body Body Schema nas_server_delete optional Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /nas_server/{id} Description Modify the settings of a NAS server. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the NAS server.
PAGE 202
POST /nas_server/{id}/ping Description Ping destination from NAS server. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string body Body nas_server_ping required Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /nas_server/{id}/upload/passwd Description Upload NAS server passwd file.
PAGE 203
Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • multipart/form-data GET /nas_server/{id}/download/passwd Description Download a NAS server passwd file containing template or the actual (if already uploaded) passwd details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
PAGE 204
POST /nas_server/{id}/upload/hosts Description Upload NAS server host file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload NAS server host file.
PAGE 205
Responses HTTP Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code Produces • document/text POST /nas_server/{id}/upload/group Description Upload NAS server group file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload NAS server group file.
PAGE 206
GET /nas_server/{id}/download/group Description Download a NAS server group file containing the template or the actual (if already uploaded) group details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
PAGE 207
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • multipart/form-data GET /nas_server/{id}/download/netgroup Description Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
PAGE 208
Description Upload the NAS server nsswitch file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server nsswitch file.
PAGE 209
HTTP Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code Produces • document/text POST /nas_server/{id}/upload/homedir 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.
PAGE 210
GET /nas_server/{id}/download/homedir Description Download a NAS server homedir file containing the template or the actual (if already uploaded) homedir configuration settings. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
PAGE 211
HTTP Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • multipart/form-data GET /nas_server/{id}/download/ntxmap Description Download an NAS server ntxmap file containing the template or the actual (if already uploaded) ntxmap configuration settings. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
PAGE 212
ownership on the NAS server’s file systems to reflect changes to users' SIDs. A new UID/GID will be obtained from a Unix Directory Service for the user name of the object owner. A user mapping report is also generated. This operation can take a significant amount of time, depending of the size of the file systems. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
PAGE 213
HTTP Code 422 Description Schema Operation Failed error_response Produces • document/text network Use these resource types to scale and reconfigure the IP networks in a cluster. GET /network Description Query the IP network configurations of the cluster. Responses HTTP Code Description Schema < 200 network_instance Success > array < 206 network_instance Partial content of network instance objects > array POST /network Description Create a network. Was added in version 2.0.0.0.
PAGE 214
Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /network/{id} Description Query a specific IP network configuration. Parameters Type Name id Path required Description Schema Unique identifier of the IP network.
PAGE 215
Parameters Type Name id Path required Description Schema Unique identifier of the network. string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /network/{id} Description Modify IP network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the IP network.
PAGE 216
Consumes • application/json Produces • application/json POST /network/{id}/replace Description Reconfigure cluster management network settings from IPv4 to IPv6 or vice versa. Parameters Type Name id Path required Description Schema Unique identifier of the IP network.
PAGE 217
Description • Add IP ports for use by the storage network, or remove IP ports so they can no longer be used. • At least one IP port must be configured for use by the storage network. Parameters Type Name id Path required Description Schema Unique identifier of the IP network.
PAGE 218
Responses HTTP Code Description Schema < 200 nfs_export_instan Success ce > array < 206 Partial content of nfs export instance objects nfs_export_instan ce > array POST /nfs_export Description Create an NFS Export for a Snapshot.
PAGE 219
Type Name id Path required Description Schema NFS Export object id. string Responses HTTP Code Description 200 Success 404 Not Found Schema nfs_export_instan ce error_response DELETE /nfs_export/{id} Description Delete NFS Export. Parameters Type Name id Path required Description Schema NFS Export object id.
PAGE 220
Parameters Type Name id Path required body Body required Description Schema NFS Export object id. string nfs_export_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code nfs_server Use this resource type to manage NFS servers. One NFS server may be configured per NAS server.
PAGE 221
HTTP Code Description Schema < 206 Partial content of nfs server instance objects nfs_server_instanc e > array POST /nfs_server Description Create an NFS server. Parameters Type Name body Body required Schema nfs_server_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /nfs_server/{id} Description Query a specific NFS server setings instance.
PAGE 222
HTTP Code Description 200 Success 404 Not Found Schema nfs_server_instanc e error_response DELETE /nfs_server/{id} Description Delete an NFS server. Parameters Type Name id Path required Description Schema Unique identifier of the NFS server. string body Body optional nfs_server_delete Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /nfs_server/{id} Description Modify NFS server settings.
PAGE 223
Type Name id Path required Description Schema Unique identifier of the NFS server. string body Body nfs_server_modify required Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /nfs_server/{id}/join Description Join the secure NFS server to the NAS server’s AD domain, which is necessary for Secure NFS.
PAGE 224
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code POST /nfs_server/{id}/unjoin Description Unjoin the secure NFS server from the NAS server’s Active Directory domain. If you unjoin with secure NFS exports active, exports will be unavailable to the clients. Parameters Type Name id Path required Description Schema Unique identifier of the NFS server.
PAGE 225
Responses HTTP Code Description Schema < node_instance > 200 Success 206 Partial content of node instance objects array < node_instance > array GET /node/{id} Description Query a specific node in a cluster. Parameters Type Name id Path required Description Schema Unique identifier of the node.
PAGE 226
GET /ntp Description Query NTP settings for a cluster. Responses HTTP Code Description Schema < ntp_instance > 200 Success 206 Partial content of ntp instance objects array < ntp_instance > array GET /ntp/{id} Description Query a specific NTP setting. Parameters Type Name id Path required Description Schema Unique identifier of the NTP setting.
PAGE 227
Type Name id Path required Description Schema Unique identifier of the NTP setting. string body Body required ntp_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Consumes • application/json Produces • application/json performance_rule Information about performance rules that can be use in performance policies applied to volumes and volume groups.
PAGE 228
HTTP Code Description Schema < 200 OK performance_rule _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. Parameters Type Name id Path required Description Schema Performance Rule id. string Responses HTTP Code Description 200 OK 404 The performance_rule does not exist.
PAGE 229
GET /physical_switch Description Query physical switches settings for a cluster. Responses HTTP Code Description Schema < 200 Success physical_switch_i nstance > array < 206 Partial content of physical switch instance objects physical_switch_i nstance > array POST /physical_switch Description Create a physical switch settings.
PAGE 230
Description Query a specific physical switch settings. Parameters Type Name id Path required Description Schema Unique identifier of the physical switch settings. string Responses HTTP Code Description 200 Success 404 Not Found Schema physical_switch_i nstance error_response DELETE /physical_switch/{id} Description Delete the physical switch settings. Parameters Type Name id Path required Description Schema Unique identifier of the physical switch settings.
PAGE 231
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.
PAGE 232
snapshot_rules(id,name,interval,time_of_day,days_of_week),volume(id,name),volume_group(id,na me)&type=eq.Protection The following REST query is an example of how to retrieve performance policies along with their associated resources: https://{{cluster_ip}}/api/rest/policy?select=name,id,type,volume(id,name),volume_group(id,name)& type=eq.
PAGE 233
HTTP Code 422 Description Schema 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 Description Schema 200 Success policy_instance 404 Not Found error_response Code DELETE /policy/{id} Description Delete a protection policy. Protection policies that are used by any storage resources can not be deleted.
PAGE 234
HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /policy/{id} Description Modify a protection policy. Parameters Type Name id Path required Description Schema Unique identifier of the policy to be modified.
PAGE 235
Description List the current remote support contact information. Was added in version 2.0.0.0. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description Schema < 200 remote_support_c Success ontact_instance > array < 206 Partial content of remote support contact instance objects remote_support_c ontact_instance > array GET /remote_support_contact/{id} Description Query to get the current remote support contact for the cluster.
PAGE 236
Description Modify the remote support contact information. Was added in version 2.0.0.0. Parameters Type Path Name Description id The unique id of the remote_support_contact required instance. Was added in version 2.0.0.0. body Body required Remote support contact modify parameters.
PAGE 237
HTTP Code Description Schema < 206 remote_syslog_ser Partial content of remote syslog server instance objects ver_instance > array POST /remote_syslog_server Description Create a remote_syslog_server object. Was added in version 2.0.0.0. Parameters Type Body Name Description body Remote required information.
PAGE 238
Responses HTTP Code Description 200 Success 404 Not Found Schema remote_syslog_ser ver_instance error_response DELETE /remote_syslog_server/{id} Description Delete a remote_syslog_server object. Was added in version 2.0.0.0. Parameters Type Path Name Description id Unique identifier of the remote syslog server required object.
PAGE 239
Type Name Body Description Schema body remote_syslog_serve required r_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /remote_syslog_server/{id}/test Description Test the specific remote_syslog_server configuration. Was added in version 2.0.0.0.
PAGE 240
remote_system Information about remote storage systems that connect to the local PowerStore system. The system uses the configuration to access and communicate with the remote system for management and data transfer communications. For example, to use remote replication, create a configuration that specifies the remote system to use as the destination for the replication session.
PAGE 241
systems. This enables remote replication for storage resources in either direction. The data connections take into account whether Challenge Handshake Authentication Protocol (CHAP) is enabled on local and remote PowerStore systems. For non-PowerStore remote system relationships, include the following parameters: • Management address - Either an IPv4 or IPv6 address. FQDN is not supported.
PAGE 242
Type Name id Path required Description Schema Unique identifier of the remote system. string Responses 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.
PAGE 243
HTTP Code 422 Description Schema Operation Failed error_response PATCH /remote_system/{id} 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.
PAGE 244
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code POST /remote_system/{id}/verify Description Verify and update the remote system instance. Detects changes in the local and remote systems and reestablishes data connections, also taking the Challenge Handshake Authentication Protocol (CHAP) settings into account. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the remote system.
PAGE 245
Description Query all replication rules. Responses HTTP Code Description Schema < 200 replication_rule_i Success nstance > array < 206 Partial content of replication rule instance objects replication_rule_i nstance > array POST /replication_rule Description Create a new replication rule.
PAGE 246
Parameters Type Name id Path required Description Schema Unique identifier of the replication rule. string Responses HTTP Code Description 200 Success 404 Not Found Schema replication_rule_i nstance error_response DELETE /replication_rule/{id} Description Delete a replication rule. Deleting a rule is not permitted, if the rule is associated with a protection policy that is currently applied to a storage resource.
PAGE 247
Description Modify a replication rule. If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to the associated storage resource. Changing the remote_system_id is not permitted, if the rule is part of a policy that is currently applied to a storage resource.
PAGE 248
In addition to copying data, the replication session synchronizes configuration changes on source resource and replicates user and scheduled snapshots to destination system. Replication sessions provide disaster recovery failover, reprotect and failback capabilities. As a result: • The downtime-associated cost of a system failure is minimized. • The recovery process from a disaster is facilitated.
PAGE 249
Type Name id Path required Description Schema Unique identifier of the replication session. string Responses 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.
PAGE 250
Parameters Type Name id Path required Description Schema Unique identifier of the replication session. string Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 251
• Planned Failover The following operations are allowed while only the replication session on the local system is paused: Pause Use to place both sites into the Paused state Failover Use to get production access from the disaster recovery site • Delete the replication session by removing the 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 sessio
PAGE 252
• Synchronizing • System_Paused When only the replication session on the local system is paused, resuming the session pauses both sites. You cannot resume replication sessions paused by the system. The following system operations may also pause, and subsequently resume, a replication session. • Paused_for_NDU • Paused_for_Migration Parameters Type Name id Path required Description Schema Unique identifier of the replication session.
PAGE 253
planned failover: • Unplanned failover • Delete the replication session by removing the protection policy on the storage resource After a planned failover, the replication session is in an inactive state. You can use the reprotect action to synchronize the destination storage resource, and then resume the replication session. The auto-reprotect feature can also be used after a planned failover by using the reverse parameter, which activates the session in the reverse direction.
PAGE 254
POST /replication_session/{id}/reprotect Description Reprotect a replication session instance. Activates the replication session and starts synchronization. This can only be used when the session is in the has been failed over. Parameters Type Name id Path required Description Schema Unique identifier of the replication session.
PAGE 255
This operation is not allowed when a test failover is already in progress on the replication session or if the session is in the following states: • Planned_Failover_In_Progress • DR_Failover_In_Progress • Failed_Over • Paused_For_NDU • Paused_For_Migration During the test, the following restrictions apply: • Membership changes are not allowed for destination resources that belong to a volume group. • The session cannot be failed over (planned or unplanned). Was added in version 2.0.0.0.
PAGE 256
Stopping of a DR failover simulation test is allowed only at the destination site of a replication session and only when a test failover is in progress on the replication session. Was added in version 2.0.0.0. Parameters Type Name id Path required Body Description Unique identifier of the replication session. Was added in version 2.0.0.0. Schema string body Parameters to stop a DR failover simulation test replication_stop_fail optional on a replication session.
PAGE 257
HTTP Code Description Schema < role_instance > 200 Success 206 Partial content of role instance objects array < role_instance > array Produces • application/json GET /role/{id} Description Query a specific role. Parameters Type Name id Path required Description Schema Unique identifier of the role.
PAGE 258
Description Query the SAS port configuration for all cluster nodes. Responses HTTP Code Description Schema < 200 sas_port_instance Success > array < 206 Partial content of sas port instance objects sas_port_instance > array 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.
PAGE 259
Description Query system security configurations. This resource type collection query does not support filtering, sorting or pagination. Responses HTTP Code Description Schema < 200 Success security_config_in stance > array < 206 Partial content of security config instance objects security_config_in stance > array Produces • application/json GET /security_config/{id} Description Query a specific system security configuration.
PAGE 260
PATCH /security_config/{id} Description Modify the security configuration for the cluster. Was added in version 2.0.0.0. Parameters Type Name id Path required Body Description Schema Unique identifier of the instance.
PAGE 261
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.
PAGE 262
Type Name Body Description Schema body service_config_modi required fy Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 263
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.
PAGE 264
Type Name id Path required body Body required Description Schema Unique identifier of the service user account. string service_user_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json smb_server Use these resource types to manage Server Message Block (SMB) servers.
PAGE 265
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 Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /smb_server/{id} Description Query settings of a specific SMB server.
PAGE 266
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.
PAGE 267
Type Name id Path required Description Schema Unique identifier of the SMB server. string body Body smb_server_modify required Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /smb_server/{id}/join Description Join the SMB server to an Active Directory domain.
PAGE 268
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code POST /smb_server/{id}/unjoin Description Unjoin the SMB server from an Active Directory domain. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the SMB server.
PAGE 269
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.
PAGE 270
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.
PAGE 271
Parameters Type Name id Path required Description Schema SMB share object id. string body Body optional smb_share_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 272
GET /smtp_config/{id} Description Query the specific SMTP configuration. Parameters Type Path Name Description id Unique identifier of the SMTP configuration. required This value is always '0'. Schema 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 Path Name Description id Unique identifier of the SMTP configuration.
PAGE 273
HTTP Description Schema 404 Not Found error_response 422 Operation Failed error_response Code POST /smtp_config/{id}/test Description Test the SMTP configuration. Parameters Type Path Name Description id Unique identifier of the SMTP configuration. required This value is always '0'. body Body required Test operation request body.
PAGE 274
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.
PAGE 275
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.
PAGE 276
Description Modify a snapshot rule. If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to that associated storage resource. Parameters Type Name id Path required Body Description Schema Unique identifier of the snapshot rule.
PAGE 277
HTTP Code Description Schema < 200 Success snmp_server_inst ance > array < 206 Partial content of snmp server instance objects snmp_server_inst ance > array POST /snmp_server Description Create an SNMP server. Was added in version 2.0.0.0. Parameters Type Name body Body required Description Schema Parameters to create an SNMP server.
PAGE 278
Responses HTTP Code Description 200 Success 404 Not Found Schema snmp_server_inst ance error_response DELETE /snmp_server/{id} Description Delete an SNMP Server. Was added in version 2.0.0.0. Parameters Type Name id Path required Description Schema Unique identifier of the SNMP server. string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /snmp_server/{id} Description Modify an SNMP server.
PAGE 279
Type Body Name Description Schema body New values of the properties of the SNMP snmp_server_modif required server. y Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /snmp_server/{id}/test Description Send a test notification to a specified SNMP server to verify connectivity. Was added in version 2.0.0.0.
PAGE 280
software_installed Software upgrade functionality. Only one upgrade can be active at a time. GET /software_installed Description Query the software that is installed on each appliance. The output returns a list of JSON objects representing the software that is installed on each appliance and one entry representing the common software installed version that is supported for all appliances in the cluster.
PAGE 281
software_package Software upgrade functionality. Only one upgrade can be active at a time. GET /software_package Description Query the software packages that are known by the cluster. The output returns a list of JSON objects representing the packages. Responses HTTP Code Description Schema < 200 software_package Success.
PAGE 282
HTTP Code 422 Description Schema Operation Failed error_response Consumes • multipart/form-data Produces • application/json GET /software_package/{id} Description Query a specific software package. Parameters Type Path Name Description id Unique identifier of the software package to required query.
PAGE 283
Type Path Name Description id Unique identifier of the software package to required delete. Schema string Responses HTTP Description Schema 202 Accepted job_response 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code 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.
PAGE 284
Type Name Body Description Schema body software_package_in optional stall Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /software_package/{id}/puhc Description Run the pre-upgrade health check for a software package. This operation may take some time to respond.
PAGE 285
HTTP Code 422 Description Schema Operation Failed error_response storage_container Manage storage containers. A storage container is a logical grouping of related storage objects in a cluster. A storage container corresponds to a vVol datastore in vCenter and is used to group related vVols and track the amount of space that is used/free. GET /storage_container Description List storage containers.
PAGE 286
Responses HTTP Description Schema 201 Success create_response 400 Invalid Request error_response 422 Operation Failed error_response Code Produces • application/json GET /storage_container/{id} Description Query a specific instance of storage container. Parameters Type Name id Path required Description Schema Storage container ID.
PAGE 287
Parameters Type Name id Path required body Body optional Description Schema Storage container ID. string Options to delete storage_container. storage_container_d elete Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json PATCH /storage_container/{id} Description Modify a storage container.
PAGE 288
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json POST /storage_container/{id}/mount Description Mount a storage container as a vVol datastore in vCenter. Parameters Type Name id Path required Body Description Schema Storage container ID.
PAGE 289
POST /storage_container/{id}/unmount Description Unmount a storage container, which removes the vVol datastore from vCenter. Parameters Type Name id Path required Description Schema Storage container ID. string Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code vcenter Use this resource type to manage vCenter instances.
PAGE 290
HTTP Code Description Schema < vcenter_instance 200 Success 206 Partial content of vcenter instance objects > array < vcenter_instance > array POST /vcenter Description Add a vCenter. Not allowed in Unified+ deployments. Parameters Type Name body Body optional Schema vcenter_create Responses HTTP Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response Code GET /vcenter/{id} Description Query a specific vCenter instance.
PAGE 291
Responses HTTP Description Schema 200 Success vcenter_instance 404 Not Found error_response Code DELETE /vcenter/{id} Description Delete a registered vCenter. Deletion of vCenter disables functionality that requires communication with vCenter. Not allowed in Unified+ deployments. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the vCenter to delete. string Was added in version 2.0.0.0.
PAGE 292
Type Name id Path required Description Schema Unique identifier of the vCenter to modify. string body Body optional vcenter_modify Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code veth_port Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports.
PAGE 293
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.
PAGE 294
HTTP Code Description Schema < 200 Success virtual_machine_i nstance > array < 206 Partial content of virtual machine instance objects virtual_machine_i nstance > array GET /virtual_machine/{id} Description Query a specific virtual machine instance. Parameters Type Path Name Description Schema id Unique identifier of the virtual machine to required query.
PAGE 295
Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /virtual_machine/{id} Description Modify a virtual machine. This operation cannot be used on virtual machine snapshots or templates. Parameters Type Path Body Name Description id Unique identifier of the virtual machine to required modify.
PAGE 296
Parameters Type Path Body Name Description id Unique identifier of the virtual machine to required create a snapshot of. Schema string body virtual_machine_sna optional pshot Responses HTTP Code Description Schema virtual_machine_s 200 Success 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response napshot_response virtual_volume Information about virtual volumes, which are managed through vCenter.
PAGE 297
HTTP Code Description Schema < 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. string Responses HTTP Code Description 200 Success 404 Not Found Schema virtual_volume_in stance vvol_error_respon se DELETE /virtual_volume/{id} Description Delete a virtual volume.
PAGE 298
Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code volume Use these resource types to manage volumes, including snapshots and clones of volumes. GET /volume Description Query volumes that are provisioned on the appliance.
PAGE 299
Responses HTTP Description Schema 201 Created create_response 400 Invalid request error_response 422 Operation Failed error_response Code GET /volume/{id} Description Query a specific volume instance. Parameters Type Name id Path required Description Schema Unique identifier of the volume to query. string Responses HTTP Description Schema 200 Success volume_instance 404 Not Found error_response Code DELETE /volume/{id} Description Delete a volume.
PAGE 300
Parameters Type Name id Path required Description Schema Unique identifier of the volume to delete. string Responses HTTP Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response Code PATCH /volume/{id} Description Modify the parameters of a volume. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the volume to modify.
PAGE 301
POST /volume/{id}/snapshot Description Create a snapshot of a volume or a clone. A snapshot is a point-in-time copy of a volume or clone. Parameters Type Path Name Description id Unique identifier of the volume or clone that is required the source of the snapshot.
PAGE 302
Responses HTTP Code Description Schema volume_clone_res 200 Success 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response ponse POST /volume/{id}/refresh Description Refresh the contents of the target volume from another volume in the same family. By default, a backup snapshot of the target volume is created before the target volume is refreshed.
PAGE 303
HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /volume/{id}/restore Description Restore a primary volume or clone from a snapshot. A primary or clone volume can only be restored from one of its immediate snapshots. By default, a backup snapshot of the target volume is created before the target volume is restored.
PAGE 304
HTTP Code 422 Description Schema Operation Failed error_response 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.
PAGE 305
Type Name Description body Body required Schema volume_detach Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code volume_group Use this resource type for storage cluster REST API definition. GET /volume_group Description Query volume groups, including snapshot sets and clones of volume groups.
PAGE 306
Parameters Type Name body Body required Schema volume_group_create Responses HTTP Description Schema 201 Created create_response 400 Invalid request error_response 422 Operation Failed error_response Code GET /volume_group/{id} Description Query a specific volume group, snapshot set, or clone. Parameters Type Name id Path required Description Schema Unique identifier of the volume group.
PAGE 307
• When a volume group or clone is deleted, all related snapshot sets will also be deleted. • When a snapshot set is deleted, all of its constituent snapshots will also be deleted. Parameters Type Name id Path required Body Description Schema Unique identifier of the volume group.
PAGE 308
HTTP Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code 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. Members cannot be added to a volume group that is acting as the destination in a replication session.
PAGE 309
the destination in a replication session. Parameters Type Name id Path required Body Description Schema Unique identifier of the volume group. string body volume_group_remo required ve_members Responses HTTP Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Code POST /volume_group/{id}/snapshot Description Create a new snapshot set for a volume group.
PAGE 310
Type Name id Path required Body Description Schema Unique identifier of the volume group. string body volume_group_snap required shot Responses HTTP Code Description Schema volume_group_sn 200 Success 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response apshot_response POST /volume_group/{id}/clone Description Clone a volume group.
PAGE 311
Parameters Type Name id Path required Description Schema Unique identifier of the volume group. string body Body required volume_group_clone Responses HTTP Code Description Schema volume_group_clo 200 Success 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response ne_response POST /volume_group/{id}/restore Description Restore a volume group from a snapshot set.
PAGE 312
Parameters Type Name id Path required Body Description Schema Unique identifier of the volume group.
PAGE 313
you want to refresh the target to the new state of the source volume group. A volume group that is acting as the destination in a replication session cannot be refreshed. Parameters Type Name id Path required Body Description Schema Unique identifier of the volume group.
PAGE 314
HTTP Code Description Schema < 200 Success x509_certificate_i nstance > array < 206 Partial content of x 509 certificate instance objects x509_certificate_i nstance > array Produces • application/json POST /x509_certificate Description Add/import a new X509 Certificate. When certificate usage type in the request is server or client, private key and passphrase are required. Private key presented in the request should be encrypted in PKCS8 format.
PAGE 315
GET /x509_certificate/{id} Description Query a specific X509 Certificate instance. Parameters Type Name id Path required Description Schema Unique identifier of the X509 Certificate. string Responses HTTP Code Description 200 Success 404 Not Found Schema x509_certificate_i nstance error_response Produces • application/json PATCH /x509_certificate/{id} Description Update/modify a X509 Certificate instance by unique identifier.
PAGE 316
HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Code Produces • application/json POST /x509_certificate/csr Description Generate a new certificate signing request. A new X509 Certificate instance will be created to hold the private key and passphrase, whose is_current and is_valid attributes will both be false. Only Syslog_HTTP and VASA_HTTP are supported service types. Was added in version 2.
PAGE 317
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.
PAGE 318
Responses HTTP Description Schema 204 Success No Content 400 Invalid Request error_response 422 Operation Failed error_response Code Produces • application/json Definitions ActivePathEnum Active path of the import host volume. Valid values are: None No active path available. Source Current IO path is set to source. Destination Current IO path is set to destination. Type : enum (None, Source, Destination) AlertStateEnum Alert State Enum with values - Active and Cleared.
PAGE 319
VNX VNX. Unity Unity. Type : enum (Unknown, SC, PS, VNX, Unity) AuditEventTypeEnum Type of audit event. Authentication All the authentication events on the system. Authorization All the authorization events on the system. Config All the set operations on the system. Example: POST, PATCH, DELETE. System All the system level operations. Logout All the logging out events on the system.
PAGE 320
Adaptive_Load_Balancing This mode includes Transmit Load Balancing (TLB) and Receive Load Balancing (RLB) for IPv4 traffic and does not require any special switch support. Receive load balancing is achieved by ARP negotiation. Type : enum (LACP) BondingTypeEnum Bond type: System_Bond Immutable default system bond. User_Bond User created LACP based link aggregation group. Was added in version 2.0.0.0. Type : enum (System_Bond, User_Bond) CGImportableCriteriaEnum Consistency group import criteria.
PAGE 321
Undetermined The import status cannot be determined due to an internal error. Contact technical support. Values was added in 1.0.2: Ready_For_Agentless_Import. Type : enum (Ready, Ready_For_Agentless_Import, In_Progress, Members_Not_Ready, No_Members, Max_Members, Not_In_Sync, Imported, Incompatible_Firmware, Undetermined) CHAPModeEnum Available CHAP modes that describe or set the iSCSI CHAP mode for the entire cluster.
PAGE 322
OK Normal conditions. Partial_Data_Connection_Loss Partial data connection loss. Complete_Data_Connection_Loss Complete data connection loss. Status_Not_Available 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.
PAGE 323
DriveFailureToleranceLevelEnum Possible drive failure tolerance levels. Single A single drive failure can be tolerated without data loss. Double Two drive failure can be tolerated without data loss. Was added in version 2.0.0.0. Type : enum (Single, Double) EncryptionTypeEnum Available encryption types. TLS Create a private connection via Transport Layer Security. None Do not enforce security when transmitting audit logs. Was added in version 2.0.0.0.
PAGE 324
Type : enum (Auto, 10_Mbps, 100_Mbps, 1_Gbps, 10_Gbps, 25_Gbps, 40_Gbps) FcPortProtocolEnum Protocols supported over FC port. Types of protocol: SCSI SCSI protocol. NVMe NVMe protocol. Was added in version 2.0.0.0. Type : enum (SCSI, NVMe) FcPortSpeedEnum Possible Fibre Channel port 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.
PAGE 325
FileInterfaceRoleEnum Production This type of network interface is used for all file protocols and services of a NAS server. This type of interface is inactive while a NAS server is in destination mode. Backup This type of network interface is used only for NDMP/NFS backup or disaster recovery testing. This type of interface is always active in all NAS server modes.
PAGE 326
FileLDAPProtocolEnum Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the network and provides message and server authentication. LDAP LDAP protocol without SSL. LDAPS (Default) LDAP protocol with SSL. When you enable LDAPS, make sure to specify the appropriate LDAPS port (usually port 636) and to upload an LDAPS trust certificate to the LDAP server. Type : enum (LDAP, LDAPS) FileLDAPSchemaTypeEnum LDAP server schema type.
PAGE 327
Native Native Security. UNIX UNIX Security. Windows Windows Security. Type : enum (Native, UNIX, Windows) FileSystemFolderRenamePolicyEnum File system folder rename policies for the file system with multiprotocol access enabled. These policies control whether the directory can be renamed from NFS or SMB clients when at least one file is opened in the directory, or in one of its child directories. All_Allowed All protocols are allowed to rename directories without any restrictions.
PAGE 328
Protocol Protocol access is via normal file shares. Protocol access is not provided by default - the NFS and/or SMB share must be created explicitly for the snapshot. Type : enum (Snapshot, Protocol) FileSystemSnapshotCreatorTypeEnum Enumeration of possible snapshot creator types. Scheduler Created by a snapshot schedule. User Created by a user. External_VSS Created by Windows Volume Shadow Copy Service (VSS) to obtain an application consistent snapshot.
PAGE 329
ForecastTimeToFullStatusEnum Type of alert indicated for object based on projected time to full. OK Time to full value is greater than 28 days. No alert indicated. Minor Time to full value is less than or equal to 28 days but greater than 14 days. Minor alert indicated. Major Time to full value is less than or equal to 14 days. Major alert indicated. None There is insufficient forecast data to project time to full to at least 28 days. No alert indicated, but available data cannot guarantee OK status.
PAGE 330
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.
PAGE 331
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. Type : enum (Not_Supported, Supported_Locked_Cluster_PIN, Supported_Unlocked, Supported_Locked_Out, Supported_Locked, Supported_Locked_Foreign, Supported_Processing, Disabled) HardwareDriveFIPSStatusEnum FIPS compliance level. Available on the Drive hardware type.
PAGE 332
Uninitialized System is starting up. Healthy Hardware is healthy. Initializing System is starting up. Failed Hardware has failed. Disconnected Hardware was removed from the system. Prepare_Failed Transient state used during startup. Trigger_Update Transient state used during startup. Empty No hardware present in this location. Type : enum (Uninitialized, Healthy, Initializing, Failed, Disconnected, Prepare_Failed, Trigger_Update, Empty) HardwareSFPConnectorTypeEnum Connector type.
PAGE 333
SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable Non-seperable 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) HardwareSFPModeEnum SFP mode. Available on the SFP hardware type.
PAGE 334
10_Mbps 10 Megabits per second 100_Mbps 100 Megabits per second 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.
PAGE 335
HardwareStatusLEDStateEnum State of the status LED of the hardware. The LED is On when there is a hardware fault. Current values are: Off Hardware Status LED is turned off. On Hardware Status LED is turned on. Type : enum (Off, On) HardwareTypeEnum The type of hardware component. Current types are: Appliance The System including the Base Enclosure and optional Expansion Enclosures. Base_Enclosure The enclosure containing 2 Nodes and 25 NVME drive slots.
PAGE 336
Type : enum (Appliance, Node, Base_Enclosure, Expansion_Enclosure, Power_Supply, IO_Module, Link_Control_Card, SFP, Battery, DIMM, M2_Drive, Fan, Drive) 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.
PAGE 337
FCoE Protocol type is Fibre Channel over Ethernet. Unknown Protocol type is unknown to PowerStore. Type : enum (Other, iSCSI, FC, FCoE, Unknown) HostTypeEnum Type of host. Defaults to external, so normal clients can only create external hosts. * External - A host that is not part of the PowerStore hardware. * Internal - ESXi host running on the PowerStore+ hardware. Not applicable for SAN only deployments. Internal hosts are read-only and managed automatically by the system. Was added in version 2.0.0.
PAGE 338
ImportOperationStatusEnum Migration state of the import host volume. Valid values are: Import_Completed Import operation was successful. Cancel_Completed Cancel operation was successful. Import_Aborted Aborted the ongoing import. Cancel_Aborted Aborted the ongoing cancel operation. Cancel_Forced Aborted the ongoing cancel operation. None Migration state is not known to PowerStore.
PAGE 339
Type : enum (Once, Hourly, Daily, Weekly, Monthly) ImportSessionStateEnum Import session states Scheduled Indicates that a user scheduled the import to run at a later time. The import remains in this state and waits until the schedule expires. Paused Indicates that the data copy between the source and destination volumes is paused. Queued Indicates that all imports are queued and run in a First In First Out (FIFO) order. This occurs when there are more active import sessions than supported.
PAGE 340
Import_Completed Indicates that all operations completed successfully for a given import after a commit. In this state, the source volume is no longer mapped to the host and all stale paths are cleaned up. Cancelled Indicates that a user forcefully cancelled the import. Failed Indicates that there was an error during import. The appropriate error message is returned in the error_response object.
PAGE 341
Copy_In_Progress, Ready_For_Cutover, Cutover_In_Progress, Import_Completed, Cancelled, Failed, Cancel_Failed, Cancel_In_Progress, Cleanup_In_Progress, Cleanup_Failed, Invalid, Cleanup_Required, Import_Completed_With_Errors, Import_Cutover_Incomplete, Cancel_Required) ImportSessionTypeEnum The type of the import session. Values are: * Non_Disruptive - This type of import session requires an Import Host Agent to be running on any host accessing the import source resources.
PAGE 342
NVMe A NVMe host initiator. Single type for all NVMe Fabrics types (NVMe/FC, NVMe/TCP, NVMe/RoCEv2). Values was added in 2.0.0.0: NVMe. Type : enum (iSCSI, FC, NVMe) IoPriorityEnum The I/O priority for quality of service rules. Type : enum (Low, Medium, High) IpPortUsageEnum IP port usages. Management Can be used for the public management network. ISCSI Can be used for the public storage network.
PAGE 343
ICM_Appliance_Floating Floating IP address for appliance management within the cluster. ICM_Node_CoreOS IP address for system node management within the cluster. Storage_Cluster_Floating Floating IP address for external iSCSI discovery. Storage_Iscsi_Initiator IP address for ESXi iSCSI initiators. Storage_Iscsi_Target IP address for system iSCSI targets. External_Replication_Iscsi IP address for External Replication over iSCSI. ICD_Node IP address of a node for data within the cluster.
PAGE 344
JobPhaseEnum Current status of the job. * Pending - Job has not started executing yet * Queued - Job has been queued * In_Progress - Job is currently executing * Completed - Job has completed successfully * Skipped - Job will not be executed. This state is defined upfront and it is related to NDU. * Failing Job will not complete successfully, and hasn’t finished its clean up steps. Will transition to 'Failed' or 'Unrecoverable_Failed' depending on whether or not the clean up steps succeed.
PAGE 345
LDAPServerTypeEnum Types of LDAP server:\n - AD : Active directory\n - OpenLDAP : Open source implementation of LDAP Was added in version 1.0.3. Type : enum (AD, OpenLDAP) LocationHistoryReasonEnum Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration. Type : enum (Initial, Manual, Recommended) MessageSeverityEnum Message severity.
PAGE 346
performance_metrics_by_fe_fc_port Frontend fibre channel port performance metrics. performance_metrics_by_fe_eth_port Frontend ethernet port performance metrics. performance_metrics_by_fe_eth_node Frontend ethernet performance metrics for node. performance_metrics_by_fe_fc_node Frontend fibre channel performance metrics for node. wear_metrics_by_drive Drive wear metrics. wear_metrics_by_drive_daily Drive wear metrics.
PAGE 347
performance_metrics_smb_builtinclient_b Performance metrics for the SMB protocol y_node built-in client performance_metrics_smb_branch_cache_ Performance metrics for the SMB protocol by_node Branch-Cache performance_metrics_smb1_by_node Performance metrics for the SMB1 protocol basic performance_metrics_smb1_builtinclient_b Performance metrics for the SMB1 protocol y_node built-in client performance_metrics_smb2_by_node Performance metrics for the SMB2 protocol basic performance_metrics_smb2
PAGE 348
performance_metrics_smb_by_node, performance_metrics_smb_builtinclient_by_node, performance_metrics_smb_branch_cache_by_node, performance_metrics_smb1_by_node, performance_metrics_smb1_builtinclient_by_node, performance_metrics_smb2_by_node, performance_metrics_smb2_builtinclient_by_node, performance_metrics_nfs_by_node, performance_metrics_nfsv3_by_node, performance_metrics_nfsv4_by_node, performance_metrics_file_by_node, performance_metrics_file_by_appliance, performance_metrics_file_by_cluste
PAGE 349
MigrationRecommendationPrimaryResourceTypeEnu m Specifies grouping mechanism for migration actions in a recommendation that identifies logically related migration actions. If a volume/virtual volume is attached to a host/virtual machine and the system selects all volumes/virtual volumes attached to the same host/virtual machine for migration, the type is set to host/virtual_machine.
PAGE 350
MigrationRecommendationStateEnum State of a migration recommendation. Recommendation_Created Recommended actions meet all request parameters. Some_Actions_Recommended Recommendation generated, but not all request parameters satisfied. Migration_Session_Created Migration sessions were successfully created for each recommended migration action. Migration_Session_Create_Failed A migration session could not be created for at least one recommended recommended actions.
PAGE 351
recommendation to evacuate space by auto selecting storage objects from an appliance using specified size. Evacuate_Objects - A recommendation to evacuate appliance by using specified objects. Values was added in 2.0.0.0: Evacuate_Objects. Type : enum (Evacuate_Appliance, Evacuate_Objects) MigrationResourceTypeEnum Storage resource types eligible for migration. Type : enum (volume, virtual_volume, volume_group) MigrationSessionStateEnum Migration session states.
PAGE 352
Resuming Migration session background copy being resumed. Failed Migration session encountered an error. Type : enum (Initializing, Initialized, Synchronizing, Idle, Cutting_Over, Deleting, Completed, Pausing, Paused, System_Paused, Resuming, Failed) MigrationStateEnum Migration status of a volume. Valid values are: Legacy Volume state is normal. Preparing Volume is prepared for migration. Disabled_For_IO Volume is disabled for IO from host. In_Progress Volume migration is in progress.
PAGE 353
May May June June July July August August September September October October November November December December Unknown Month of year is unknown to PowerStore. Type : enum (January, February, March, April, May, June, July, August, September, October, November, December, Unknown) NASServerCurrentUnixDirectoryServiceEnum Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on.
PAGE 354
Unknown NAS server state is unknown. Type : enum (Stopped, Starting, Started, Stopping, Failover, Degraded, Unknown) NFSExportDefaultAccessEnum Default access level for all hosts that can access the Export. No_Access Deny access to the Export for the hosts. Read_Only Allow read only access to 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.
PAGE 355
Was added in version 2.0.0.0. Type : enum (ISCSI) NetworkTypeEnum Network type. Management External cluster and appliance management. Intra_Cluster_Management Management within the cluster. Intra_Cluster_Data Data within the cluster. Storage External data transfer. VMotion Data movement controlled by VMotion.
PAGE 356
OSTypeEnum Operating system of the host. Type : enum (Windows, Linux, ESXi, AIX, HP-UX, Solaris) PhysicalSwitchConnectMethodEnum Physical switch connect method type. Valid values are: 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.
PAGE 357
Was added in version 2.0.0.0. Type : enum (Not_Stale, Disconnected) ProtocolTypeEnum Available protocol types. TCP Use the Transmission Control Protocol. UDP Use the User Datagram Protocol. Was added in version 2.0.0.0. Type : enum (TCP, UDP) RPOEnum Recovery point objective (RPO), which is the acceptable amount of data, measured in units of time, that may be lost in case of a failure.
PAGE 358
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.
PAGE 359
ReplicatedResourceTypeEnum Storage resource types eligible for replication protection: volume Replication session created on a volume. * volume_group - Replication session created on a volume group. Type : enum (volume, volume_group) ReplicationRoleEnum Role of the replication session: Source The local resource is the source of the remote replication session. * Destination - The local resource is the destination of the remote replication session.
PAGE 360
Failing_Over A planned failover is in progress. The status changes to Failed_Over after the replication session has failed over. Failing_Over_For_DR An unplanned failover is in progress. The status changes to Failed_Over after the replication session has failed over. Failed_Over The replication session underwent a planned or unplanned failover. User intervention required. Reprotecting The replication session is being reprotected.
PAGE 361
import_vnx_consistency_group, import_vnx_volume, keystore_archive, local_user, license, initiator, ldap_domain, ip_pool_address, ip_port, job, ldap_account, login_session, maintenance_window, metrics, migration_recommendation, migration_session, nas_server, ndu, network, nfs_export, remote_syslog_server, nfs_server, node, remote_system, ntp, performance_rule, replication_rule, physical_switch, replication_session, role, policy, sas_port, scheduler, security_config, service_config, s
PAGE 362
None No authorization. MD5 The AuthMD5 class implements the MD5 authentication protocol. SHA256 The HMAC192SHA256AuthProtocol class implements the Secure Hash Authentication Was added in version 2.0.0.0. Type : enum (None, MD5, SHA256) SNMPPrivacyProtocolEnum Relevant only for SNMPv3. Supported SNMP privacy protocol: None No encryption on the wire. AES256 Encryption class for AES 256. TDES Privacy protocol class for Triple DES (DESEDE). Was added in version 2.0.0.0.
PAGE 363
12_Gbps 12 Gigabits per second Type : enum (3_Gbps, 6_Gbps, 12_Gbps) ScScheduleTypeEnum Available SC snapshot schedule types. Valid values are: Once Take snapshot only once. Daily Take snapshot hourly. Weekly Take snapshot on a weekly basis. Monthly Take snapshot on a monthly basis. Unknown SC schedule type is unknown to PowerStore. Type : enum (Once, Daily, Weekly, Monthly, Unknown) ScSnapshotProfileTypeEnum Available SC snapshot profile types.
PAGE 364
SeverityEnum Possible severities. Type : enum (None, Info, Minor, Major, Critical) SnapRuleIntervalEnum Interval between snapshots. Either the interval parameter or the time_of_day parameter may be set. Setting one clears the other parameter. Type : enum (Five_Minutes, Fifteen_Minutes, Thirty_Minutes, One_Hour, Two_Hours, Three_Hours, Four_Hours, Six_Hours, Eight_Hours, Twelve_Hours, One_Day) SoftwareInstalledBuildFlavorEnum A specific config, determined at build time.
PAGE 365
Debug Provides additional diagnostics for development. Retail An optimized compiler option. Was added in version 2.0.0.0. Type : enum (Retail) SoftwarePackageBuildTypeEnum Type of the build. Valid values are: Internal An internal (developer) build. Hotfix A build containing 1 or more specific fixes. Generally limited in availability to a few customers. Beta Pre-production build, used for evaluation purposes. Release A build for General Availability (GA). Was added in version 2.0.0.0.
PAGE 366
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. Language_Pack A package containing additional language definitions. Pre_Upgrade_HCI A package containing a pre-upgrade software for HCI system. Values was added in 2.0.0.0: Pre_Upgrade_HCI.
PAGE 367
Not_Supported The source array does not support import. Was added in version 1.0.2. Type : enum (Agentless, Non_Disruptive_And_Agentless, Not_Supported) ThumbprintAlgorithmEnum The thumbprint algorithm: - SHA-256 : SHA-256 algorithm Type : enum (SHA-256) TimeZoneEnum Time zone identifier for applying the time zone to the time_of_day for a snapshot rule, including any DST effects if applicable. Applies only when a time_of_day is specified in the snapshot rule. Defaults to UTC if not specified.
PAGE 368
Connection_Refused Connection was refused. Login_Timeout Login to target IP timed out. Network_Error Network error General_Failure Other failure not listed. Login_Success_No_Ports Login successful after discovery failure. Used only for PS EqualLogic systems. Discovery_Success Discovery of target IP successful. Discovery_Authentication_Failure Authentication failure during discovery of target IP. Discovery_Connection_Refused Connection was refused during discovery of target IP.
PAGE 369
UnityHealthEnum Health status of the Unity storage system. Values are: Unknown The status of the system cannot be determined. Ok The system is operating normally. Ok_But The system is 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.
PAGE 370
SelDays_At_HHMM Create a snapshot on the selected {daysOfWeek}, at the time {hours}:{minutes}. Supported parameters: daysOfWeek (at least one required), hours (optional, default 0), minutes (optional, 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.
PAGE 371
Aborted Volume migration is cancelled. Not_Applicable Volume migration state is not applicable if the system only supports agentless import. Unknown Type : The volume migration state is unknown to PowerStore. 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.
PAGE 372
Offline vCenter cannot connect with the provider. Online vCenter is communicating with the provider. Was added in version 2.0.0.0. Type : enum (Not_Registered, Offline, Online) VirtualMachineStatusEnum General health status of the VM in vCenter. Not applicable to VM snapshots. Green VM is 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.
PAGE 373
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.
PAGE 374
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.
PAGE 375
Unity_System_Health_Inappropriate The health of the Unity system is not suitable for import. Unity_Volume_Health_Inappropriate The health of the Unity volume is not suitable for import. XtremIO_Severity_Inappropriate The severity level of the XtremIO system is not suitable for import. XtremIO_State_Inappropriate The state of the XtremIO system is not suitable for import. XtremIO_Volume_Severity_Inappropriate The severity level XtremIO volume is not suitable for import.
PAGE 376
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. Snapshot A read-only object created from a volume or clone. Type : enum (Primary, Clone, Snapshot) WeekOfMonthEnum Weeks of the month.
PAGE 377
X509CertificateServiceEnum Type of the service for which the certificate is used: • Management HTTP - Management Web server • Replication HTTP - Remote Replication service • VASA HTTP - VASA provider service • Import HTTP - External web service Values was added in 1.0.3: LDAP_HTTP, Syslog_HTTP.
PAGE 378
Unknown The certainty is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Ok, Add_Pending, Modify_Pending, Remove_Pending, Unknown) XtremIODurationUnitEnum Duration unit. Values are: Minutes Duration in minutes. Hours Duration in hours. Days Duration in days. Unknown Duration unit is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Minutes, Hours, Days, Unknown) XtremIOObjectSeverityEnum Severity level of current alerts for this entity and its contained objects.
PAGE 379
XtremIOScheduleStateEnum Indicates whether the Schedule is currently enabled or disabled, by the user. Values are: Enabled Schedule is enabled. Disabled Schedule is disabled. Unknown Schedule state is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Enabled, Disabled, Unknown) XtremIOScheduleTypeEnum Indicates the scheduling for snapshot creation. Values are: Explicit Snapshots are created at specified time. Interval Snapshots are created in constant time intervals.
PAGE 380
Down XtremIO system is down. Stop_Failed Stop command failed on the XtremIO system. Attempting_To_Start XtremIO is in attempting to start sate. Unknown XtremIO state is unknown to PowerStore. Was added in version 1.0.2. Type : enum (Active, Start, Configured, Initializing, Stopping, Stopped, Starting, Failed, Down, Stop_Failed, Attempting_To_Start, Unknown) active_session_instance Properties of an active session.
PAGE 381
attention and result in an alert being generated. Other events can update or clear an alert when the system detects a change in the condition that needs attention. To deal with an alert, look at the information about the most recent event included in the alert. In particular, examine the resource that the alert was generated about (using resource_type and resource_id or resource_name) as well as the system_impact_l10n and suggested repair_flow_l10n parameters.
PAGE 382
Name Description Schema Timestamp of the first event for this alert. string (date-time) raised_timest amp optional resource_id Unique identifier of the resource instance which generated optional this alert. resource_nam e optional resource_type optional Name of the resource instance which generated this alert. This property supports case-insensitive filtering. string string Type of the resource instance which generated this alert.
PAGE 383
Name Description Schema Indicates whether the alert has been acknowledged. boolean is_acknowledg ed required appliance_create Parameters for the appliance create (add) operation. Was added in version 2.0.0.0. Name Description Schema drive_failure_ tolerance_lev DriveFailureToleran el ceLevelEnum optional Set to true to ignore warnings about unreachable external ignore_netwo rk_warnings optional network services discovered while adding an appliance.
PAGE 384
Name Schema messages < error_message > array optional appliance_delete Appliance resource delete operation request body. Was added in version 2.0.0.0. Type : object appliance_forecast Name Schema metric_type ForecastMetricTypeEnum required appliance_forecast_response Name Description Schema Estimate for the upper bound forecasted value on that high_value particular time.
PAGE 385
Name Description Schema drive_failure_ tolerance_lev el DriveFailureToleran Was added in version 2.0.0.0. ceLevelEnum optional drive_failure_ tolerance_lev Localized message string corresponding to el_l10n drive_failure_tolerance_level Was added in version 2.0.0.0. string optional eth_ports optional This is the inverse of the resource type eth_port association. < eth_port_instance > array express_servi ce_code Express Service Code.
PAGE 386
Name sas_ports optional service_tag optional software_inst alled optional Description Schema This is the inverse of the resource type sas_port association. Dell Service Tag. < sas_port_instance > array string This is the inverse of the resource type software_installed association. < software_installed_i nstance > array veth_ports This is the inverse of the resource type veth_port < veth_port_instance optional association.
PAGE 387
Name end_of_foreca st optional Description Schema 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. time_to_full Estimated date-time at which the forecast value will reach optional full capacity.
PAGE 388
Name Description Schema link_local_add The link local address is a dynamically set local IP address. ress It is unique to this appliance and is set by Zeroconf. Use the string (ip-address) required PowerStore Discovery Tool to get the link local address. The name of the new appliance. By default, the name is the name cluster name followed by "-appliance-" and a unique optional number. The maximum size is 64 characters.
PAGE 389
Name message_code optional message_l10n optional Description Schema Unique identifier of the message for this audit_event. string Localized message string corresponding to message_code.
PAGE 390
Name appliance_id optional data_remaini ng optional Description Schema Unique identifier of the appliance. string 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 integer (int64) Time (in milliseconds) spent doing reads during this read_time sampling period.
PAGE 391
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_cluster Copy metrics for the cluster. Name data_remaini ng optional Description Schema Number of bytes remaining to be copied at the end of this sampling period.
PAGE 392
Name Description Schema The time (in milliseconds) spent in copy activity during this transfer_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 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_remote_system Cluster wide copy metrics for the remote system.
PAGE 393
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.
PAGE 394
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.
PAGE 395
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 Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
PAGE 396
base_performance_metrics_by_appliance Performance metrics for the appliance collected at twenty second interval. Name appliance_id optional avg_io_size optional avg_latency optional Description Schema Unique identifier representing a specific appliance. 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.
PAGE 397
Name timestamp optional Description Schema 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 Write rate in bytes per second. number (float) Total write operations per second.
PAGE 398
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 Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds.
PAGE 399
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.
PAGE 400
Name timestamp optional Description Schema End of sample period. string (date-time) base_performance_metrics_by_cluster Performance metrics for the cluster 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.
PAGE 401
Name timestamp optional Description Schema 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.
PAGE 402
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. number (float) Identifier of the cluster.
PAGE 403
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.
PAGE 404
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. number (float) Reference to the associated node on which these metrics optional were recorded.
PAGE 405
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. Schema string avg_bytes_rx_ ps The average total bytes received per second. number (float) The average total bytes transmitted per second. number (float) optional avg_bytes_tx_ ps optional avg_pkt_rx_cr c_error_ps optional The average number of packets received with CRC error (and thus dropped) per second.
PAGE 406
Name Description Schema 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. number (float) max_pkt_tx_p s The maximum number of packets transmitted per second.
PAGE 407
Name Description fe_port_id Reference optional (eth_port) on which these metrics were recorded. node_id optional pkt_rx_crc_er ror_ps optional pkt_rx_no_buf fer_error_ps optional pkt_rx_ps optional pkt_tx_error_ ps optional pkt_tx_ps optional repeat_count optional timestamp optional to Schema the associated frontend ethernet port Reference to the node the port belongs to. The number of packets received with CRC error (and thus dropped) per second.
PAGE 408
Name Description Schema The average total bytes transmitted per second. number (float) avg_bytes_tx_ ps optional avg_pkt_rx_cr c_error_ps optional The average number of packets received with CRC error (and thus dropped) per second. number (float) avg_pkt_rx_no _buffer_error_ The average number of packets discarded per second due ps to lack of buffer space.
PAGE 409
Name Description Schema The maximum number of packets received per second. number (float) max_pkt_rx_p s optional max_pkt_tx_e rror_ps optional The maximum number of packets that failed to be transmitted per second due to error. number (float) max_pkt_tx_p s The maximum number of packets transmitted per second. number (float) Reference to the node the port belongs to. string optional node_id optional repeat_count optional timestamp optional Number of times the metrics are repeated.
PAGE 410
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. number (float) Invalid crc count per second. number (float) Invalid transmission word count per second.
PAGE 411
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.
PAGE 412
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 avg_current_l Average number of logins to the target from initiators.
PAGE 413
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.
PAGE 414
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.
PAGE 415
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.
PAGE 416
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.
PAGE 417
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.
PAGE 418
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.
PAGE 419
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 optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
PAGE 420
Name Description Schema unaligned_wri te_bandwidth Unaligned write rate in bytes per second. number (float) optional unaligned_wri te_iops Unaligned write input/output per second. number (float) Write rate in byte/sec. number (float) Total write operations per second. number (float) optional 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.
PAGE 421
Name avg_latency optional Description Schema Weighted average latency in microseconds. number (float) Average link failure count per second. number (float) avg_link_failu re_count_ps optional 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.
PAGE 422
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.
PAGE 423
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.
PAGE 424
Name Description Schema The maximum loss of signal count per second. number (float) The maximum loss of sync count per second. number (float) max_loss_of_s ignal_count_p s optional 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.
PAGE 425
Name Description Schema 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. number (float) Maximum writes per second. number (float) Reference to the node the port belongs to.
PAGE 426
Name avg_read_size optional avg_size optional Description Schema Average read size in bytes. number (float) 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.
PAGE 427
Name write_iops optional Description Schema Total write operations per second. number (float) base_performance_metrics_by_file_system_rollup Summary of file system level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. 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.
PAGE 428
Name Description Schema Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the file system. string avg_write_iop s optional avg_write_late ncy optional avg_write_size optional file_system_id optional max_avg_late ncy optional Maximum of average read and write latency microseconds.
PAGE 429
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.
PAGE 430
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) Unique identifier representing a specific port. string Read rate in bytes per second. number (float) Total read operations per second.
PAGE 431
base_performance_metrics_by_ip_port_rollup Summary of ip port (total) performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Was added in version 2.0.0.0. Name avg_io_size optional 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.
PAGE 432
Name avg_write_size optional ip_port_id optional max_avg_io_si ze optional Description Schema Weighted average write size in bytes. number (float) Unique identifier representing a specific port. string 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.
PAGE 433
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 is repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
PAGE 434
Name avg_write_size optional node_id optional Description Schema Average write size in bytes. number (float) Unique identifier of the node. string read_bandwid th Read rate in bytes per second. Was added in version 2.0.0.0. number (float) optional read_iops optional Total read operations per second. number (float) Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
PAGE 435
Name avg_io_size optional avg_latency optional avg_read_ban dwidth 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 rate in bytes per second. Was added in version 2.0.0.0. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes.
PAGE 436
Name Description Schema Maximum of average read and write size in bytes. number (float) max_avg_io_si ze optional max_avg_late ncy optional Maximum of average read and write latency in microseconds. 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 write latency in microseconds. number (float) Maximum of average write size in bytes.
PAGE 437
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.
PAGE 438
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.
PAGE 439
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.
PAGE 440
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.
PAGE 441
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.
PAGE 442
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.
PAGE 443
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.
PAGE 444
Name write_iops optional Description Schema Total write operations per second. number (float) 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.
PAGE 445
Name Description Schema 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. 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.
PAGE 446
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.
PAGE 447
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.
PAGE 448
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) 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.
PAGE 449
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 End of sample period. string (date-time) Total rejected task. number (float) Total tasks.
PAGE 450
Name Description Schema 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. string hash_max_siz e optional hash_min_late ncy optional hash_min_size optional 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.
PAGE 451
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.
PAGE 452
base_performance_metrics_by_smb_client_rollup Summary of smb client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional 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.
PAGE 453
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.
PAGE 454
Name timestamp optional Description Schema Time at the beginning of sample period. string (date-time) base_performance_metrics_by_smb_node Performance metrics for the smb node collected at twenty second interval. Name avg_io_size optional 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.
PAGE 455
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_bandwid th optional total_calls optional total_iops optional write_bandwi dth optional write_iops optional End of sample period. Total data transfer rate in bytes per second. Was added in version 2.
PAGE 456
Name avg_latency optional avg_read_ban dwidth optional avg_read_iops optional Description Schema Maximum read and write latency in microseconds. number (float) Average read rate in bytes per second. Was added in version 2.0.0.0. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes.
PAGE 457
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.
PAGE 458
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_builtin_client Performance metrics for the smb v1 client collected at twenty second interval.
PAGE 459
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.
PAGE 460
Name Description Schema 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. number (float) avg_read_late ncy optional avg_read_size optional 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.
PAGE 461
Name max_iops optional Description Schema 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. 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.
PAGE 462
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).
PAGE 463
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.
PAGE 464
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.
PAGE 465
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.
PAGE 466
base_performance_metrics_by_smb_v2_builtin_client_ rollup Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional 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.
PAGE 467
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.
PAGE 468
Name timestamp optional Description Schema Time at the beginning of sample period. string (date-time) base_performance_metrics_by_smb_v2_node Performance metrics for the smb v1 node collected at twenty second interval. Name avg_io_size optional 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.
PAGE 469
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) base_performance_metrics_by_smb_v2_node_rollup Summary of smb v1 node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
PAGE 470
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 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.
PAGE 471
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.
PAGE 472
Name read_iops optional repeat_count optional timestamp optional Description Schema Total read operations 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) 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.
PAGE 473
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) Read rate in bytes per second. number (float) Total read operations per second. number (float) avg_write_late ncy optional avg_write_size optional read_bandwid th optional read_iops optional repeat_count optional timestamp optional Number of times the metrics are repeated.
PAGE 474
base_performance_metrics_by_vm_rollup Summary of virtual machine level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Name avg_io_size optional 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.
PAGE 475
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.
PAGE 476
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.
PAGE 477
Name avg_write_size optional Description Schema Average write size in bytes. number (float) Read rate in bytes per second. number (float) Total 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. string (date-time) Total data transfer rate in bytes per second.
PAGE 478
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.
PAGE 479
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.
PAGE 480
Name Description Schema Maximum writes per second. number (float) max_write_io ps optional repeat_count optional timestamp optional volume_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. string base_performance_metrics_file_by_appliance Performance metrics for file per appliance collected at twenty second interval.
PAGE 481
Name Description Schema Read rate in bytes per second. number (float) Total read operations per second. number (float) read_bandwid th 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). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period.
PAGE 482
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. number (float) Average read size in bytes. number (float) Average data transfer rate in bytes per second. number (float) Average read and write operations per second.
PAGE 483
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 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 rate in bytes per second.
PAGE 484
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_file_by_cluster Performance metrics cluster level for file collected at twenty second interval. Was added in version 2.
PAGE 485
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 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 bytes per second.
PAGE 486
Name Description Schema Maximum of average read latency in microseconds. number (float) Average read size in bytes. number (float) Average data transfer rate in bytes per second. number (float) Average read and write operations per second. number (float) Average write rate in bytes per second. number (float) Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes.
PAGE 487
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) Maximum read and write operations per second. number (float) Maximum read rate in bytes per second. number (float) Maximum read operations per second. number (float) Maximum data transfer rate in bytes per second. number (float) Maximum write rate in bytes per second.
PAGE 488
base_performance_metrics_file_by_node Performance metrics for file per node collected at twenty second interval. Was added in version 2.0.0.0. Name avg_io_size optional 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.
PAGE 489
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Write rate in bytes per second. number (float) Total write operations per second.
PAGE 490
Name Description Schema Average data transfer rate in bytes per second. number (float) Average read and write operations per second. number (float) Average write rate in bytes per second. number (float) Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes. number (float) Maximum of average read and write size in bytes.
PAGE 491
Name Description Schema Maximum of average write size in bytes. number (float) Maximum read and write operations per second. number (float) Maximum read rate in bytes per second. number (float) 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) Unique identifier of the node.
PAGE 492
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.
PAGE 493
Name Description Schema Amount of data in bytes written to all file systems on an logical_used_f ile_system optional appliance, without any deduplication and/or compression. This metric includes all primaries, snaps and clones. Was added in version 2.0.0.0. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 Amount of data in bytes written to all block volumes on an logical_used_v olume optional appliance, without any deduplication and/or compression.
PAGE 494
Name Description Schema Amount of data in bytes written to all file systems on an shared_logical appliance, without any deduplication and/or compression. _used_file_sys This metric includes all primaries and clones. Was added in tem version 2.0.0.0. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Amount of data in bytes written to all block volumes on an shared_logical _used_volume optional appliance, without any deduplication and/or compression.
PAGE 495
Name Description 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 Schema string integer (int64) last_data_red uction Last data reduction space during the period. number (float) Last efficiency ratio during the period.
PAGE 496
Name Description Schema last_physical_ Last physical used space during the period. used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space for file systems during the gical_used_fil period. Was added in version 2.0.0.0.
PAGE 497
Name Description Schema max_logical_p Maxiumum logical total space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maxiumum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space for file systems during the sed_file_syste period. Was added in version 2.0.0.0.
PAGE 498
Name Description Schema max_shared_l Maximum shared logical used space for virtual volumes ogical_used_v during the period. Was added in version 2.0.0.0. vol Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_snapshot _savings Maximum snapshot savings space during the period. number (float) Maximum thin savings ratio during the period.
PAGE 499
Name Description Schema The overall efficiency is computed as a ratio of the total space provisioned to physical used space. For example, ten 2 GB volumes were provisioned and 1 GB of data is written efficiency_rati to each of them. Each of the volumes has one snapshot as o well, for another ten 2 GB volumes. All volumes are thinly number (float) optional provisioned with deduplication and compression applied, there is 4 GB of physical space used.
PAGE 500
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.
PAGE 501
Name Description Schema Ratio of the amount of space that would have been used by snapshots if space efficiency was not applied to logical snapshot_savi space used solely by snapshots. For example, an object is ngs provisioned as 1 GB and it has two snapshots. Each number (float) optional 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. Ratio of all the vVol provisioned to data they contain.
PAGE 502
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 last_logical_us ed_file_system optional last_logical_us ed_volume optional last_logical_us ed_vvol optional integer (int64) Last logical used space for file systems during the period. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Last logical used space for block volumes during the period.
PAGE 503
Name Description Schema last_shared_lo Last shared logical used space for virtual volumes during gical_used_vv the period. Was added in version 2.0.0.0. ol Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snapshot_ savings Last snapshot savings space during the period. number (float) Last thin savings ratio during the period. number (float) optional last_thin_savi ngs optional max_data_phy Maximum physical used space for data during the period.
PAGE 504
Name max_logical_u sed_vvol optional Description Schema Maximum logical used space for virtual volumes during the period. Was added in version 2.0.0.0. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 max_physical Maximum physical total space during the period. _total Minimum value : 0 optional Maximum value : 9223372036854775807 max_physical Maximum physical used space during the period.
PAGE 505
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.
PAGE 506
base_space_metrics_by_storage_container_rollup Summary of storage container level space metric data for a specific period of time beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day. Name Description Schema last_logical_pr Last logical provisioned space during the period.
PAGE 507
Name Description Schema Internal ID of the storage container. string End of sample period. string (date-time) storage_conta iner_id optional timestamp optional base_space_metrics_by_vg Space metrics for a volume group collected at a five minute interval. Name logical_provis ioned optional Description Schema Total configured size in bytes of all member volumes in a volume group.
PAGE 508
Name Description Schema Ratio of all the volumes provisioned to data being written thin_savings optional to them. For example, a volume group has two 2 GB volumes and have written 500 MB of data to them. The thin number (float) savings would be (2 * 2 GB) / (2 * 0.5 GB) or 4:1, so the thin_savings value would be 4.0. timestamp optional vg_id optional End of sample period. string (date-time) Unique identifier representing a volume group.
PAGE 509
Name Description Schema max_logical_u Maximum logical used space during the period. sed 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) Max thin savings ratio during the period.
PAGE 510
Name repeat_count optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 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.
PAGE 511
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_snap_clon Last snap and clone logical used space during the period.
PAGE 512
Name Description max_unique_ Max unique physical used space during the period. physical_used Minimum value : 0 optional repeat_count optional timestamp optional vm_id optional Schema integer (int64) Maximum value : 9223372036854775807 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.
PAGE 513
Name Description Schema 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. string (date-time) ID of the volume.
PAGE 514
Name Description Schema Amount of space the volume family needs to hold the data shared_logical written by host and shared by snaps and fast-clones in the _used family. This does not include deduplication or compression. integer (int64) optional Minimum value : 0 Maximum value : 9223372036854775807 Total Amount of data in bytes host has written to all snap_clone_lo gical_used optional volumes in the volume family without any deduplication, compression or sharing.
PAGE 515
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_shared_lo Last shared logical used space during the period.
PAGE 516
Name Description max_unique_ Max unique physical used space during the period. physical_used Minimum value : 0 optional repeat_count optional timestamp optional Schema integer (int64) Maximum value : 9223372036854775807 Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
PAGE 517
Name Description Schema Max thin savings ratio during the period. number (float) max_thin_savi ngs optional repeat_count optional timestamp optional volume_id optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) ID of the volume. string base_wear_metrics_by_drive_daily_instance Wear metrics for the drives collected daily. Was added in version 2.0.0.0.
PAGE 518
Name Description Schema The percentage of drive wear remaining. number (float) percent_endu rance_remain ing optional repeat_count optional timestamp optional Number of times the metrics is repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) bond_instance Properties of a bond. Values was added in 2.0.0.0: type, description, partner_id.
PAGE 519
Name Description Schema Maximum Transmission Unit (MTU) packet size of the mtu bond, in bytes. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 name optional Bond name. The bond name may not exceed 15 characters. This property supports case-insensitive filtering. partner This is the embeddable reference form of partner_id optional attribute.
PAGE 520
chap_credentials_instance Information about the initiator, target session, or discovery CHAP secrets. Name Description Schema initiator_disco very_passwor Password used by the initiator to authenticate the target d during discovery authentication. Mutual CHAP mode only. string (password) optional initiator_disco very_usernam Username used by the initiator to authenticate the target e during discovery authentication. Mutual CHAP mode only.
PAGE 521
Name Description Schema appliances The configuration settings for adding appliances during required cluster creation. At least one appliance is required. < cluster_create_appli ances > array cluster cluster_create_cluste required r dns_servers < string (ip-address) required > array networks Configuration of one or more network(s) based on network required type.
PAGE 522
Name Description Schema The name of the new appliance. By default, the name is name "[cluster name]-appliance-[index number]". The maximum optional size is 64 characters. string Length : 1 - 64 cluster_create_cluster The configuration settings of cluster during cluster creation. Was added in version 2.0.0.0. Name Description Schema Set to true to ignore network warnings about unreachable external network services discovered while cluster ignore_netwo creation.
PAGE 523
Name addresses required cluster_mgmt _address optional gateway optional prefix_length required Description IP addresses in IPv4 or IPv6 format. Schema < string (ip-address) > array New cluster management IP address in IPv4 or IPv6 format, corresponding to the network’s IP version. This can only be specified only when configuring the management type string (ip-address) network. Network gateway in IPv4 or IPv6 format, corresponding to the network’s IP version.
PAGE 524
Name port optional snmp_commu nity_string optional Description Schema Port used for connection to switch. Minimum value : 0 integer (int32) Maximum value : 65535 SNMPv2 community string, if SNMPv2c connect method is specified. ssh_password SSH password to connect a physical switch if SSH connect optional method is specified. username Username to connect a physical switch for SSH connection optional method.
PAGE 525
Name Description Schema username Username of the local user account which will be used by required vSphere to register VASA provider. string cluster_create_vcenters vCenter configuration setting during cluster creation. Was added in version 2.0.0.0. Name address required data_center_n ame optional esx_cluster_n ame optional is_verify_serv er_cert required password required username required Description Schema IP address of vCenter in IPv4 or IPv6 or hostname format.
PAGE 526
cluster_forecast_response Name Description Schema Estimate of the upper bound of the 95% confidence interval high_value for the forecast value at the given timestamp. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate of the lower bound of the 95% confidence interval low_value for the forecast value at the given timestamp.
PAGE 527
Name is_encryption_ enabled optional management_ address optional master_applia nce_id optional name optional Description Whether or not Data at Rest Encryption is enabled on the cluster. The floating management IP address for the cluster in IPv4 or IPv6 format. The unique identifier of the appliance acting as primary. Was deprecated in version 2.0.0.0. The name of the cluster.
PAGE 528
cluster_modify Cluster modify parameters. Name name optional Description Schema The new name for the cluster. The name can be up to 64 UTF-8 characters and cannot be an empty string. string Length : 1 - 64 The physical ethernet port (eth_port resource) MTU setting is global for all ports in the cluster.
PAGE 529
Name time_to_full_p essimistic optional Description Schema Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval. time_to_full_s ForecastTimeToFull tatus StatusEnum optional time_to_full_s tatus_l10n optional string (date-time) Localized message string corresponding to time_to_full_status string cluster_validate_create Validate create cluster parameters. Was added in version 2.0.0.0.
PAGE 530
Name Description Configure vcenters optional Schema vCenter settings when creating cluster. Parameters are required when creating PowerStore X < cluster and optional for PowerStore cluster. cluster_create_vcent Note currently only single element is supported. ers > array cluster_validate_create_response Response for a validate create request. It returns configuration warnings and errors detected during validation, as well as suggested resolutions. Was added in version 2.0.0.0.
PAGE 531
Name volume_wwn optional Description Schema WWN of the source consistency group member volume. string copy_metrics_by_appliance Copy metrics for the appliance. Polymorphism : Inheritance Discriminator : response_definition Name appliance_id optional data_remaini ng optional Description Schema Unique identifier of the appliance. string Number of bytes remaining to be copied at the end of this sampling period.
PAGE 532
Name Description Schema session_type CopySessionTypeEn optional um session_type_l 10n Localized message string corresponding to session_type string End of sampling period. string (date-time) 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.
PAGE 533
Name entity_l10n optional Description Schema Localized message string corresponding to entity string 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).
PAGE 534
copy_metrics_by_remote_system Cluster wide copy metrics for the remote system. Polymorphism : Inheritance Discriminator : response_definition Name data_remaini ng optional Description Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 Number of bytes transferred during this sampling period.
PAGE 535
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.
PAGE 536
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). integer (int32) Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity.
PAGE 537
copy_metrics_by_volume Cluster wide copy metrics for the volume. Polymorphism : Inheritance Discriminator : response_definition Name data_remaini ng optional Description Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 Number of bytes transferred during this sampling period.
PAGE 538
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 volume_id optional Unique identifier of the volume.
PAGE 539
Name status_l10n optional Description Schema Localized message string corresponding to status string Target address from the remote system. string (ip-address) target_addres s optional discovered_initiator_instance An initiator currently connected to the cluster, but not associated with any host. Name Description name IQN - for iSCSi Initiators; WWN - for SCSI over FC initiators; optional NQN - for NVMe initiators. Schema string List of discovered NVMe Initiators' addresses.
PAGE 540
Name addresses required Description DNS server addresses in IPv4 or IPv6 format. Schema < string (ip-address) > 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. boolean Whether send notifications for informational alerts.
PAGE 541
Name notify_minor optional Description Schema 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. string Whether to send notifications for critical alerts. boolean Whether to send notifications for informational alerts. boolean Whether to send notifications for major alerts.
PAGE 542
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.
PAGE 543
Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional bond optional Schema The id of the appliance containing the port. appliance_instance string This is the embeddable reference form of bond_id attribute. bond_instance bond_id Unique identifier of the bond containing the port, or null if optional the port is not in a bond. string The Maximum transmission unit (MTU) packet size that the Ethernet port can transmit.
PAGE 544
Name hypervisor_vs witch_id optional hypervisor_vs witch_name optional id optional Description Schema Unique identifier of the virtual switch associated with the hypervisor port. Name of the virtual switch associated with the hypervisor port. This property supports case-insensitive filtering. Ethernet port instance identifier. This is the embeddable reference form of io_module_id optional attribute.
PAGE 545
Name Description partner This is the embeddable reference form of partner_id optional attribute. partner_id optional 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 eth_port_instance Localized message string corresponding to port_connector_type string The index of the Ethernet port in IO module.
PAGE 546
Name supported_sp eeds_l10n optional Description Localized Schema message array corresponding to supported_speeds < string > array eth_port_modify Name Schema requested_speed required EthPortSpeedEnum 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.
PAGE 547
Name resource_type optional Description Schema The type of the object which generated this event. ResourceTypeEnum Localized message string corresponding to resource_type string The severity of the event. SeverityEnum Localized message string corresponding to severity string Describes the possible effect on the system of this event. string resource_type _l10n optional severity optional severity_l10n optional system_impac t_l10n optional fc_port_instance Properties of the FC front-end port.
PAGE 548
Name hardware_par ent_id optional id optional Description Schema Unique identifier of the parent hardware instance handling the port. @added(Foothills) Was added in version 2.0.0.0. Unique identifier of the port. string io_module This is the embeddable reference form of io_module_id optional attribute. io_module_id optional string hardware_instance Unique identifier of the hardware instance of type 'IO_Module' handling the port. Was deprecated in version string 2.0.0.0.
PAGE 549
Name port_index optional Description Schema Index of the port in the IO module. Minimum value : 0 integer (int32) Maximum value : 2147483647 protocols List of supported protocols for the port. Was added in optional version 2.0.0.0. protocols_l10 n optional < FcPortProtocolEnum > array Localized message array corresponding to protocols Was added in version 2.0.0.0.
PAGE 550
Name Description Schema wwn_nvme World Wide Name (WWN) of NVME port. Was added in optional version 2.0.0.0. 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. string Length : 1 - 255 ip_addresses The list of DNS server IP addresses.
PAGE 551
Name Description 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 Schema > 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.
PAGE 552
Name Description Schema (Applies when the value of is_audit_enabled is true.) Directory of FTP/SFTP audit files. Logs are saved in '/' audit_dir directory (default) or in a mounted file system (Absolute optional path of the File system directory which should already string exist). Length : 0 - 511 (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.
PAGE 553
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.
PAGE 554
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.
PAGE 555
Name Description Schema (Applies when the value of is_audit_enabled is true.) Directory of FTP/SFTP audit files. Logs are saved in '/' audit_dir directory (default) or in a mounted file system (Absolute optional path of the File system directory which should already string exist). Length : 0 - 511 (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.
PAGE 556
Name id optional Description Schema Unique identifier of the FTP server. string 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.
PAGE 557
Name Description Schema Indicates whether the SFTP server is enabled on the NAS is_sftp_enable server. Values are: - true - SFTP server is enabled on the d specified NAS server. - false - SFTP server is disabled on the boolean optional specified NAS server. Default : false Indicates is_smb_authe ntication_ena bled optional whether FTP and SFTP clients can be authenticated using an SMB user name.
PAGE 558
Name Description Schema Welcome message displayed on the console of FTP and welcome_mes SFTP clients before their authentication. The length of this sage message is limited to 511 bytes of UTF-8 characters, and the string optional length of each line is limited to 80 bytes. Length : 0 - 511 file_ftp_modify Parameters for file FTP modify operation. Name Description add_groups Groups to add to the current groups. Error occurs if the optional group already exists. Cannot be combined with groups.
PAGE 559
Name default_home dir optional Description Schema (Applies when the value of is_homedir_limit_enabled is false.) Default directory of FTP and SFTP clients that have a home directory which is not defined or accessible. string Length : 0 - 511 Allowed or denied user groups, depending on the value of the is_allowed_groups attribute. - If allowed groups exist, only users who are members of these groups and no others groups optional can connect to the NAS server through FTP or SFTP.
PAGE 560
Name Description Schema is_anonymous Indicates whether FTP clients can be authenticated _authenticatio anonymously. Values are: - true - Anonymous user name is n_enabled accepted. - false - Anonymous user name is not accepted. optional Default : true is_audit_enabl ed optional boolean Indicates whether the activity of FTP and SFTP clients is tracked in audit files. Values are: - true - FTP/SFTP activity is tracked. - false - FTP/SFTP activity is not tracked.
PAGE 561
Name Description Schema Message of the day displayed on the console of FTP clients message_of_th after their authentication. The length of this message is e_day limited to 511 bytes of UTF-8 characters, and the length of string optional each line is limited to 80 bytes. Length : 0 - 511 remove_group s optional remove_hosts optional Groups to remove from the current groups. Error occurs if the group is not present. Cannot be combined with groups. Host IP addresses to remove from the current hosts.
PAGE 562
Name Description is_disabled Indicates whether the network interface is disabled. optional Default : false nas_server_id required prefix_length required Schema boolean Unique identifier of the NAS server to which the network interface belongs, as defined by the nas_server resource string type. Prefix length for the interface. IPv4 and IPv6 are supported.
PAGE 563
Name Description name Name of the network interface. This property supports optional case-insensitive filtering. nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional prefix_length optional Unique identifier of the NAS server. Schema string nas_server_instance string Prefix length for the interface. IPv4 and IPv6 are supported.
PAGE 564
Name prefix_length optional Description Schema Prefix length for the interface. IPv4 and IPv6 are supported. Minimum value : 1 integer (int32) Maximum value : 128 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_route_create Parameters for the file interface route create operation.
PAGE 565
file_interface_route_instance Properties of the file interface route. This resource type has queriable association from file_interface Name Description Schema IPv4 or IPv6 address of the target network node based on the specific route type. Values are: • For a default route, the route is specified in the gateway value for the related file interface. destination optional • For a host route, the destination value is a host IP address.
PAGE 566
file_interface_route_modify Parameters for the file interface route modify operation. Name Description Schema IPv4 or IPv6 address of the target network node based on the specific route type. Values are: • For a default route, the route is specified in the gateway value for the related file interface. destination required • For a host route, the destination value is a host IP address.
PAGE 567
file_kerberos_instance This resource type has queriable association from nas_server Name id optional kdc_addresses optional Description Schema Unique identifier of the Kerberos service settings instance. string Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses < string > array are not supported. nas_server This is the embeddable reference form of nas_server_id optional attribute.
PAGE 568
Name kdc_addresses optional Description Schema Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses < string > array are not supported. KDC servers TCP port. port_number Default : 88 optional Minimum value : 0 integer (int32) Maximum value : 65535 realm Realm name of the Kerberos Service.
PAGE 569
Name Description Schema bind_passwor The associated password to be used when binding to the d server. optional Length : 0 - 1023 Indicates string (password) whether SMB authentication is used to authenticate to the LDAP server. Values are: is_smb_accou nt_used true Indicates that the SMB settings are used for Kerberos authentication. optional false boolean Indicates that Kerberos uses its own settings.
PAGE 570
Name Description Schema realm Specifies the realm name for Kerberos authentication. optional Length : 0 - 255 string file_ldap_instance This resource type has queriable association from nas_server Name Description Schema addresses The list of LDAP server IP addresses. The addresses may be < string (ip-address) optional IPv4 or IPv6.
PAGE 571
Name Description Indicates whether Schema SMB authentication is used to authenticate to the LDAP server. Values are: is_smb_accou nt_used true Indicates that the SMB settings are used for Kerberos authentication. optional false boolean Indicates that Kerberos uses its own settings. Indicates whether a Certification Authority certificate is used to verify the LDAP server certificate for secure SSL is_verify_serv connections.
PAGE 572
Name realm optional Description Schema Specifies the realm name for Kerberos authentication. string schema_type FileLDAPSchemaTyp optional eEnum schema_type_l 10n Localized message string corresponding to schema_type string optional file_ldap_modify Name add_addresse s optional Description Schema IP addresses to add to the current server IP addresses list. The addresses may be IPv4 or IPv6. Error occurs if an IP < string (ip-address) address already exists in the addresses list.
PAGE 573
Name Description Indicates whether Schema SMB authentication is used to authenticate to the LDAP server. Values are: is_smb_accou nt_used true Indicates that the SMB settings are used for Kerberos authentication. optional false boolean Indicates that Kerberos uses its own settings. Indicates whether Certification Authority certificate is used to verify the LDAP server certificate for secure SSL is_verify_serv connections.
PAGE 574
file_ndmp_create Parameters for the file NDMP create operation. Name Description nas_server_id Unique identifier of the NAS server to be configured with required these NDMP settings. password Password for the NDMP service user. required Length : 1 - 15 user_name User name for accessing the NDMP service. required Length : 1 - 64 Schema string string (password) string file_ndmp_instance Properties of the file NDMP.
PAGE 575
file_nis_create Name Description domain Name of the NIS domain. required Length : 1 - 255 ip_addresses required nas_server_id required The list of NIS server IP addresses. Schema string < string (ip-address) > array Unique identifier of the associated NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS string Server is supported.
PAGE 576
Name Description domain Name of the NIS domain. optional Length : 1 - 255 ip_addresses A new list of NIS server IP addresses to replace the existing < string (ip-address) optional list. The addresses may be IPv4 or IPv6. remove_ip_ad IP addresses to remove from the current list. The addresses dresses may be IPv4 or IPv6. Error occurs if the IP address is not optional present. Cannot be combined with ip_addresses.
PAGE 577
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en true file system. abled optional File system notifications are enabled on the false boolean File system notifications are disabled on the file system. Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena true system.
PAGE 578
Name Description Schema smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any. epth Minimum value : 1 optional Maximum value : 512 integer (int32) file_system_clone_response File system clone created. Name id optional Description Schema The unique identifier of the created clone. string file_system_create Parameters for the file system create operation.
PAGE 579
Name Description Schema Indicates whether notifications of changes to directory file structure are enabled. is_smb_no_not ify_enabled optional true Change directory notifications are disabled. false Change directory notifications are enabled. boolean Default : false Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify true File access notifications are enabled on the file system.
PAGE 580
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ true Synchronous writes option is enabled on the file system. writes_enable d optional false boolean Synchronous writes option is disabled on the file system. Default : false locking_policy FileSystemLockingP optional olicyEnum name Name of the file system. (255 UTF-8 characters).
PAGE 581
Name Description Schema Localized message string corresponding to access_policy string access_policy_ l10n optional access_type FileSystemSnapshot optional AccessTypeEnum access_type_l1 0n Localized message string corresponding to access_type string Time, in seconds, when the snapshot was created.
PAGE 582
Name file_user_quot as optional Description Schema This is the inverse of the resource type file_user_quota association.
PAGE 583
Name Description Schema Indicates whether asynchronous MTIME is enabled on the file system. Values are: is_async_MTi true Asynchronous MTIME is enabled on the file system. me_enabled boolean optional false Asynchronous MTIME is disabled on the file system. Indicates whether the snapshot may have changed since it was created. Values are: is_modified true Snapshot is or was shared with read/write access. optional false boolean Snapshot was never shared. Indicates whether quota is enabled.
PAGE 584
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en true system. abled optional File access notifications are enabled on the file false boolean File access notifications are disabled on the file system. Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena true system.
PAGE 585
Name Description Schema last_writable_ If not mounted, and was previously mounted, the time (in timestamp seconds) of last mount. If never mounted, the value will be string (date-time) optional zero. locking_policy FileSystemLockingP optional olicyEnum locking_policy _l10n Localized message string corresponding to locking_policy string optional name Name of the file system. This property supports case- optional insensitive filtering.
PAGE 586
Name Description Schema Size used, in bytes, for the data and metadata of the file size_used system. Value is always rounded up to next MB. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any. epth Minimum value : 0 optional Maximum value : 2147483647 smb_shares This is the inverse of the resource type smb_share optional association.
PAGE 587
Name Description Schema folder_renam FileSystemFolderRe e_policy namePolicyEnum optional Grace period of soft limits (seconds): -1 default: Infinite grace (Windows policy). 0 Use system default of 1 week. Positive Grace period after which the soft limit is grace_period optional integer (int32) treated as a hard limit (seconds).
PAGE 588
Name Description Schema Indicates whether notifications of changes to a directory is_smb_no_not ify_enabled file structure are enabled. Values are: true Change directory notifications are disabled. false Change directory notifications are enabled. boolean optional Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en true system.
PAGE 589
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable true file system. d optional Synchronous writes option is enabled on the false boolean Synchronous writes option is disabled on the file system. locking_policy FileSystemLockingP optional olicyEnum protection_po licy_id optional Unique identifier of the protection policy applied to the file system.
PAGE 590
Name id optional Description Schema The unique identifier of the created snapshot. string file_system_snapshot Parameters for the file system snapshot operation. Name Description Schema access_policy FileSystemAccessPol optional icyEnum access_type FileSystemSnapshot optional AccessTypeEnum description Description of the snapshot. optional Length : 0 - 255 string expiration_ti mestamp Time, when the snapshot will expire.
PAGE 591
Name Description Schema Indicates whether notifications of changes to a directory is_smb_no_not ify_enabled file structure are enabled. true Change directory notifications are disabled. false Change directory notifications are enabled. boolean optional Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en true system.
PAGE 592
Name Description Schema Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable true file system. d optional Synchronous writes option is enabled on the false boolean Synchronous writes option is disabled on the file system. locking_policy FileSystemLockingP optional olicyEnum name optional Name of the snapshot. The default name of the snapshot is the date and time when the snapshot is taken.
PAGE 593
Name Description Schema Grace period of soft limit (seconds). This will override the default grace period set at filesystem level. -1 Infinite grace period (Windows policy). 0 Use default grace period of 1 week (default). grace_period optional Positive Grace period after which the soft limit is integer (int32) treated as a hard limit (seconds). Was added in version 2.0.0.0. Default : 0 Minimum value : -1 Maximum value : 2147483647 Hard limit of the tree quota, in bytes.
PAGE 594
file_tree_quota_instance Properties of a file tree quota. Values was added in 2.0.0.0: grace_period. This resource type has queriable associations from file_system, file_user_quota Name Description description Description of the tree quota. optional Length : 0 - 256 file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id optional file_user_tree _quotas optional Schema Unique identifier of the associated file system.
PAGE 595
Name is_user_quota s_enforced optional Description Whether user quota are enabled on this tree quota. The tree quota itself is enforced regardless of this parameter. path Path relative to the root of the associated filesystem.
PAGE 596
Name Description Schema Grace period of soft limit (seconds). This will override the default grace period set at filesystem level. -1 Infinite grace period (Windows policy). 0 Use default grace period of 1 week (default). grace_period optional Positive Grace period after which the soft limit is integer (int32) treated as a hard limit (seconds). Was added in version 2.0.0.0. Default : 0 Minimum value : -1 Maximum value : 2147483647 Hard limit of the tree quota, in bytes.
PAGE 597
Name Description file_system_id Unique identifier of the filesystem in which the new user required quota will be created. Schema string 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. Value is rounded up to match the physical block size of the integer (int64) filesystem. Minimum value : 0 Maximum value : 9223372036854775807 Soft limit of the user quota, in bytes.
PAGE 598
Name Description file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id optional Unique identifier of the associated filesystem. Schema file_system_instance string Hard limit of the user 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.
PAGE 599
Name Description Schema Unique identifier of the associated tree quota. Values are: tree_quota_id null - if the user quota is not within a quota tree. - optional tree_quota instance id - if the user quota is within a quota string tree. uid optional unix_name optional windows_nam e optional windows_sid optional Unix user identifier (UID) of the user. Minimum value : 1 integer (int64) Maximum value : 4294967294 Unix username. Windows username. The format is domain\user for the domain user.
PAGE 600
Name nas_server_id required Description Schema Unique identifier of an associated NAS Server instance that uses this virus checker configuration. Only one virus string checker configuration per NAS Server is supported. file_virus_checker_instance This resource type has queriable association from nas_server Name id optional Description Schema Unique identifier of the virus checker instance. string is_config_file_ Indicates whether a virus checker configuration file has uploaded been uploaded.
PAGE 601
Name Description Schema 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. If third-party anti- required virus servers are not available, according the policy, the boolean access to the file systems is denied to prevent potential viruses propagation.
PAGE 602
Name Description Schema Total number of physical cores. Available on the Node cpu_cores hardware type. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 cpu_model optional CPU model name. Available on Node hardware type. string Total number of physical sockets. Available on the Node cpu_sockets hardware type. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 dell_service_t ag optional Dell service tag of the hardware.
PAGE 603
Name Description Schema Localized message string corresponding to fips_status string fips_status_l10 n optional firmware_ver sion optional Firmware version of the hardware. Available on the Drive hardware type. string mode HardwareSFPModeE optional num mode_l10n optional Localized message string corresponding to mode string model_name Model name of the hardware. Available on the IO_Module optional and M2_Drive hardware types.
PAGE 604
hardware_instance Hardware component information. This resource type has queriable associations from fc_port, sas_port, eth_port, hardware, appliance Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional The id of the component’s associated appliance. Schema appliance_instance string < children This is the inverse of the resource type hardware optional association. extra_details Additional hardware details.
PAGE 605
Name Description is_marked Indicator of whether a component is location marked or optional not. lifecycle_state optional Life cycle state of the component. Schema boolean HardwareLifecycleS tateEnum lifecycle_state _l10n Localized message string corresponding to lifecycle_state string optional name The name of the component. This property supports case- optional insensitive filtering. node_eth_port s This is the inverse of the resource type eth_port association.
PAGE 606
Name sfp_sas_ports optional slot optional Description This is the inverse of the resource type sas_port association. Schema < sas_port_instance > array The slot or location of the component. Minimum value : 0 integer (int32) Maximum value : 2147483647 stale_state Indicator of the stale state of component. Was added in HardwareStaleState optional version 2.0.0.0. stale_state_l10 n optional Localized message string corresponding to stale_state Was added in version 2.0.0.0.
PAGE 607
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.
PAGE 608
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 Delete arguments. Type : object host_detach Unique identifier of the volume to detach from host. Name volume_id required Description Schema Volume to detach.
PAGE 609
Name description optional Description Schema An optional description for the host group. The description should not have any unprintable characters. string Maximal length : 256 host_ids < 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 Unique identifier of volume to detach from host.
PAGE 610
Name mapped_host_ groups optional Description This is Schema the inverse of the resource type host_volume_mapping association. name The host group name. This property supports case- optional insensitive filtering. < host_volume_mappi ng_instance > array string 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.
PAGE 611
Name chap_mutual_ username optional chap_single_u sername optional Description Schema 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. string Length : 1 - 64 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.
PAGE 612
Name Description Schema host_virtual_v < olume_mappi This ngs host_virtual_volume_mapping association. is the inverse of the resource type host_virtual_volume _mapping_instance > optional id optional import_host_s ystem optional array Unique identifier of the host. This is the string embeddable reference form of import_host_system_ import_host_system_id attribute. mapped_hosts This is the inverse of instance the resource type optional host_volume_mapping association.
PAGE 613
Name Description Schema An optional description for the host. The description should description not be more than 256 UTF-8 characters long and should not optional have any unprintable characters. string Maximal length : 256 modify_initiat ors optional Update list of existing initiators, identified by port_name, with new CHAP usernames and/or passwords. < update_initiator_in_ host > array The host name.
PAGE 614
Name virtual_volum e_id optional Description Unique identifier of the virtual volume to which the host is attached. Schema string host_volume_mapping_instance Details about a configured host or host group attached to a volume. The host or host group may not necessarily be connected. This resource type has queriable associations from host, host_group, volume Name host optional Description Schema This is the embeddable reference form of host_id attribute.
PAGE 615
Name id optional Description Schema Unique identifier of the import host initiator. string Unique identifier of the import host system. string import_host_s ystem_id optional iqn_or_wwn iSCSI Qualified Name (IQN) or World Wide Name (WWN) of optional the host initiator. string protocol HostInitiatorProtoco optional lTypeEnum protocol_l10n optional Localized message string corresponding to protocol string import_host_system_create Required parameters for adding an import host system.
PAGE 616
Name Description Schema chap_single_u Username for single CHAP authentication. This username is sername required when the cluster is using single authentication string optional CHAP mode. os_type HAOSTypeEnum required password required user_name required Password for the specified username. string (password) Username for the import host system. string import_host_system_instance Details about an import host system.
PAGE 617
Name agent_version optional hosts optional id optional Description Schema Version of the import host system. string This is the inverse of the resource type host association. < host_instance array Unique identifier of the import host system. string Time when the import host system was last updated.
PAGE 618
Name array_type optional Description Schema 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.
PAGE 619
Name Description Schema Localized message array corresponding to protocols < string > array protocols_l10 n optional size optional status optional status_l10n optional Size of the import host volume, in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Status of the import host volume. VolumeStatusEnum Localized message string corresponding to status string import_psgroup_instance PS Group details.
PAGE 620
Name Description Schema name Name of the PS Group. This property supports case- optional insensitive filtering. string serial_numbe r Serial number of the PS Group. string optional supported_im port_type SupportedImportTy Was added in version 1.0.2. peEnum optional supported_im port_type_l10 Localized message string corresponding n supported_import_type Was added in version 1.0.2. to string optional user_name optional Name used to log in to the PS Group.
PAGE 621
Name keep_count optional name optional Description Schema Number of snapshots to retain. Minimum value : 0 integer (int32) Maximum value : 2147483647 Name of the snapshot schedule. string Repeat interval of the snapshot schedule, in days. The value repetition_int erval optional is 1 for the schedule frequencies Once and Hourly. It can be greater than 1 for the schedule frequencies Daily and Weekly.
PAGE 622
Name Description Schema block_size VolumeBlockSizeEn optional um block_size_l10 n Localized message string corresponding to block_size string optional host_volume_i ds optional id optional import_psgro up optional import_psgro up_id optional importable_cr iteria optional importable_cr iteria_l10n optional is_online optional is_read_only optional Unique identifiers of the host volumes associated with the volume. Unique identifier of the volume.
PAGE 623
Name Description name Name of the volume. This property supports case- optional insensitive filtering. size optional wwn optional Schema string Size of the volume, in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Unique WWN of the volume. string import_session_cancel Name Description Schema Indicates whether the cancel import session operation is a force optional normal cancel (true) or a forced stop (false).
PAGE 624
Name Description Schema Unique identifiers of the host groups that map to the host_group_id s optional destination resource for an agentless import session. In case of a consistency group, if all the member volumes have the same host group mapping, then use this property, < string > array otherwise use consistency_group_member_host_group_ids. Was added in version 2.0.0.0. host_ids Hosts to be mapped to the destination resource for an optional agentless import session. Was added in version 1.0.2.
PAGE 625
Name type optional volume_group _id optional Description Schema ImportSessionTypeE Was added in version 1.0.2. num 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. Was added in version 1.0.2.
PAGE 626
Name Description Schema destination_re ImportDestinationR source_type esourceTypeEnum optional destination_re source_type_l Localized message 10n destination_resource_type 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.
PAGE 627
Name Description Schema Unique identifier of the local protection policy in the protection_po licy_id optional PowerStore storage system that will be applied on an imported destination volume or consistency group after cutover. Only snapshot policies are supported in an import. string Once the import completes, you can add a replication policy. remote_syste m optional remote_syste m_id optional This is the embeddable reference form of remote_system_id remote_system_insta attribute.
PAGE 628
Name Description Schema scheduled_tim Indicates the new date and time at which the import estamp session is scheduled to run. The date is specified in ISO string (date-time) optional 8601 format with time expressed in UTC format.
PAGE 629
import_storage_center_instance This resource type has queriable associations from import_storage_center_volume, import_storage_center_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.
PAGE 630
Name Description Schema status SCStatusEnum optional status_l10n optional Localized message string corresponding to status string supported_im port_type SupportedImportTy Was added in version 1.0.2. peEnum optional supported_im port_type_l10 Localized n supported_import_type Was added in version 1.0.2. message string corresponding to string optional user_name optional User account name used to communicate with the SC array. string sc_snapshot_profile Snapshot profile.
PAGE 631
import_storage_center_volume_import_snapshot_profi les_response Type : < import_storage_center_snapshot_profile_instance > array import_storage_center_volume_instance This resource type has queriable 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 v
PAGE 632
Name Description Schema import_storag e_center_id Unique identifier of the SC array where the volume resides. string optional importable_cr iteria optional importable_cr iteria_l10n optional 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.
PAGE 633
import_unity_consistency_group_instance This resource type has queriable associations from import_unity_volume, import_unity 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.
PAGE 634
Name health_l10n optional id optional Description Schema Localized message string corresponding to health string 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 roups import_unity_consistency_group association.
PAGE 635
Name Description Schema supported_im port_type SupportedImportTy Was added in version 1.0.2. peEnum optional supported_im port_type_l10 Localized message string corresponding n supported_import_type Was added in version 1.0.2. 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.
PAGE 636
Name days_of_mont h optional Description Days of the month for which the snapshot schedule rule applies. [1..31]. days_of_week Days of the week for which the snapshot schedule rule optional applies. Schema < integer > array < 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 .
PAGE 637
import_unity_volume_import_snapshot_schedules_res ponse Type : < import_unity_snapshot_schedule_instance > array import_unity_volume_instance This resource type has queriable associations from import_unity, import_unity_consistency_group Name 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.
PAGE 638
Name Description importable_cr iteria_l10n optional is_replication _destination optional is_thin_clone optional Schema Localized message string corresponding to importable_criteria Indicates whether the Unity volume is a replication destination. Indicates whether the Unity volume is a thin clone.
PAGE 639
Name alternate_ma nagement_ad dress optional id optional Description Schema Alternate management address for communicating with the VNX storage system. This is usually the address of Storage Processor B (SPB). The address can be an IPv4 string (ip-address) address, IPv6 address, or FQDN (Fully Qualified Domain Name). Unique identifier of the VNX storage system. string import_vnx_c < onsistency_gr This oups import_vnx_consistency_group association.
PAGE 640
Name software_vers ion optional Description Schema The software version of the block operating environment of the VNX storage system. supported_im port_type string SupportedImportTy Was added in version 1.0.2. peEnum optional supported_im port_type_l10 Localized message string corresponding n supported_import_type Was added in version 1.0.2. to string optional user_name User account name used to communicate with the VNX optional storage system.
PAGE 641
Name Description importable_cr iteria_l10n optional Schema Localized message string corresponding to importable_criteria name Name of the consistency group. This property supports optional case-insensitive filtering.
PAGE 642
Name Description Schema import_vnx_c onsistency_gr Unique identifier of the VNX consistency group, if the oup_id volume is in a consistency group.
PAGE 643
Name id optional import_xtrem io optional import_xtrem io_id optional import_xtrem io_volumes optional importable_cr iteria optional importable_cr iteria_l10n optional Description Schema Unique identifier of the XtremIO consistency group. string This is the embeddable reference form of import_xtremio_inst import_xtremio_id attribute. ance Unique identifier of the XtremIO storage system where the consistency group resides.
PAGE 644
Name Description Schema import_xtrem < io_consistency This _groups is the inverse of the resource type import_xtremio_con sistency_group_insta import_xtremio_consistency_group association. optional import_xtrem io_volumes optional nce > array < This is the inverse of the resource type import_xtremio_vol import_xtremio_volume association. ume_instance > array Date and time when the XtremIO storage system details were last updated.
PAGE 645
Name Description Schema Software version of the XtremIO storage system. string software_vers ion optional state XtremIOStateEnum optional state_l10n Localized message string corresponding to state Was added optional in version 1.0.2. supported_im string SupportedImportTy port_type peEnum optional supported_im port_type_l10 Localized message string corresponding n supported_import_type Was added in version 1.0.2.
PAGE 646
Name Description Schema For schedule_type of interval, a triplet in the form of '[hours : minutes : seconds'], where a schedule using hours and minutes must have a seconds value of 0 and a schedule in seconds must have hours and minutes of 0. For example, '[1:30:0'] takes a snapshot every 1.5 hours and '[0:0:15'] schedule takes a snapshot every 15 seconds.
PAGE 647
Name id optional Description Schema Unique identifier of the snapshot schedule retention policy. string long_period_d The duration of the long term period ranging from 1 to 500. uration Minimum value : 1 optional Maximum value : 500 integer (int32) long_period_u XtremIODurationUn nit itEnum optional long_period_u nit_l10n optional long_retentio n_copies optional middle_perio d_duration optional Localized message string corresponding to long_period_unit Was added in version 1.0.2.
PAGE 648
Name short_period_ duration optional Description Schema The duration of the short term period ranging from 1 to 500. integer (int32) Minimum value : 0 Maximum value : 2147483647 short_period_ XtremIODurationUn unit itEnum optional short_period_ unit_l10n optional short_retentio n_copies optional Localized message string corresponding to short_period_unit Was added in version 1.0.2. string The short term retention number of copies ranging from 1 to 500.
PAGE 649
Name import_xtrem io optional Description This is Schema the embeddable reference form of import_xtremio_inst import_xtremio_id attribute. ance import_xtrem io_consistency This _group is the embeddable reference form of import_xtremio_consistency_group_id attribute. import_xtremio_con sistency_group_insta nce optional Unique identifier of the consistency group to which the XtremIO volume belongs.
PAGE 650
Name Description name Name of the XtremIO volume. This property supports case- optional insensitive filtering. Schema string severity XtremIOObjectSever optional ityEnum severity_l10n Localized message string corresponding to severity Was optional added in version 1.0.2. size optional wwn optional string Size of the XtremIO volume, in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 World Wide Name (WWN) of the XtremIO volume.
PAGE 651
Name Description port_name IQN name aka address or NQN name for NVMEoF port required types. Schema string port_type InitiatorProtocolTyp required eEnum ip_pool_address_instance Properties of the IP pool address. This resource type has queriable associations from network, ip_port, appliance, node Name address optional Description Schema IP address value, in IPv4 or IPv6 format. string (ip-address) appliance This is the embeddable reference form of appliance_id optional attribute.
PAGE 652
Name node optional Description This is the embeddable reference form of node_id attribute. node_instance node_id Unique identifier of the cluster node to which the IP optional address belongs. purposes optional purposes_l10n optional Schema string < IP address purposes.
PAGE 653
Name Description eth_port This is the embeddable reference form of eth_port_id optional attribute. Schema eth_port_instance Unique identifier of the physical Ethernet front-end port on top of which the IP port is configured. This attribute can be eth_port_id set when the IP port is used by a Unified appliance. It optional should be empty if the IP port is used by a Unified+ string appliance or if the IP port is configured on top of a bond on a Unified appliance.
PAGE 654
Name Description Schema Usages to add to the current usages of an IP port. The current usages of an IP port can be extended with external replication if this usage is in the port’s list of available usages. The same settings will be applied to the partner IP port. Only one IP port on each node can be add_current_ assigned to the External_Replication usages usage.
PAGE 655
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.
PAGE 656
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.
PAGE 657
Name Schema issues < validate_create_issue > array optional messages < error_message > array optional response_type string required job_cluster_forecast_response Polymorphism : Inheritance Discriminator : response_type Name Description Schema Estimate of the upper bound of the 95% confidence interval high_value for the forecast value at the given timestamp.
PAGE 658
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. response_type string required time_to_full Estimated date-time at which the forecast value will reach optional full capacity.
PAGE 659
Name Schema response_type string required job_create_response Create response for an operation. Polymorphism : Inheritance Discriminator : response_type 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.
PAGE 660
Name Description response_type Schema string required job_file_system_restore_response Backup snapshot of the file system created. Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema The unique identifier of the created snapshot. string response_type string required job_file_system_snapshot_response Snapshot file system created.
PAGE 661
Name Description Schema Description of the job. string Date and time when the job execution completed. string (date-time) Estimated completion date and time. string (date-time) Unique identifier of the job. string description_l1 0n optional end_time optional estimated_co mpletion_tim e optional id optional leafs optional This is the inverse of the resource type job association. parent This is the embeddable reference form of parent_id optional attribute.
PAGE 662
Name Description resource_id Unique identifier of the resource on which the job is optional operating. resource_nam e optional Name of the resource on which the job is operating. This property supports case-insensitive filtering. resource_type Schema string string ResourceTypeEnum optional resource_type _l10n Localized message string corresponding to resource_type string optional response_bod y base_response optional response_stat us Was added in version 2.0.0.0.
PAGE 663
Name Description Schema Order of a given job step with respect to its siblings within step_order the job hierarchy. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 user optional Name of the user associated with the job. string job_job_response Job response for an asynchronous request. The response to any asynchronous request that does not fail immediately.
PAGE 664
job_migration_recommendation_create_migration_ses sions_response Polymorphism : Inheritance Discriminator : response_type Name Description Schema ID of migration sessions created for the recommendation. < string > array migration_ses sion_ids optional 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.
PAGE 665
Name Description response_type Schema string required snapshot_id Identifier of the optional snapshot instance created at the optional end of the test. string 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.
PAGE 666
Name Description response_type Schema 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.
PAGE 667
Name Description Schema backup_snaps Unique identifier of the backup snapshot set. This hot_id parameter will not be available if the create_backup_snap string optional was set to false. response_type string required job_volume_group_snapshot_response Unique identifier of the new snapshot volume. Polymorphism : Inheritance Discriminator : response_type Name Schema id string optional response_type string required job_volume_refresh_response Volume refresh response definition.
PAGE 668
Name backup_snaps hot_id optional Description Unique identifier of the backup snapshot of the target volume, if one is created prior to the restore operation. response_type Schema string string required job_volume_snapshot_response Volume snapshot response definition. Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema Unique identifier of the new snapshot.
PAGE 669
Discriminator : response_type Name Description Schema PEM encoded certificate signing request. string Unique ID of x509_certificate. string certificate_re quest optional id optional Indicates whether this is the current X509 certificate to be used by the service or this X509 certificate will be used in is_current the future. When is_current is false for a X509 Certificate, optional this X509 Certificate will not be picked up by the service.
PAGE 670
Name Description Schema Scope defines a subset of certificates belonging to one service. Scope has different meanings from different Services and types. For example, in Replication_HTTP, CA type certificates will use scope to indicate the origin of these certificates. Service, type and scope mapping are listed as below. - Certificate with Service Management_HTTP and Type of Server, scope value can be null(unused and optional).
PAGE 671
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. Was added in version 1.0.3. Name Description domain_id Unique identifier of the LDAP domain to which LDAP user required or group belongs. Schema string Name of the new LDAP account to be created.
PAGE 672
Name id optional name optional Description Schema 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 Localized message string corresponding to type Was added optional in version 1.0.3. string ldap_account_modify Parameters for modifying an LDAP account. Was added in version 1.0.3.
PAGE 673
Name group_membe r_attribute optional Description Schema Name of the LDAP attribute whose value contains the names of group members within a group. Default value is member. string Length : 1 - 1023 group_name_a Name of the LDAP attribute whose value indicates the ttribute group name. Default value is cn. optional Length : 1 - 1023 string LDAP object class for groups. Default value is group.
PAGE 674
Name Description Schema Port number used to connect to the LDAP Server. Default port optional values are LDAP(389), LDAPs(636), GlobalCatalog LDAP(3268), Global Catalog LDAPs(3269). integer (int32) Minimum value : 0 Maximum value : 65535 protocol LDAPProtocolEnum optional user_id_attrib ute optional user_object_cl ass optional Name of the LDAP attribute whose value indicates the unique identifier of the user. Default value is sAMAccountName.
PAGE 675
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. Default value is 0 (no nested search level limitation).
PAGE 676
Name Description Schema protocol LDAPProtocolEnum optional protocol_l10n Localized message string corresponding to protocol Was optional added in version 1.0.3. string user_id_attrib Name of the LDAP attribute whose value indicates the ute unique identifier optional sAMAccountName. of the user. Default value is 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.
PAGE 677
Name Description Schema LDAP object class for groups. Default value is group. In group_object_ Active Directory, groups and users are stored in the same class directory path, and are in a class called group. Default string optional value is group. Length : 1 - 1023 group_search_ level optional Nested search level for performing group search.
PAGE 678
Name user_id_attrib ute optional user_object_cl ass optional Description Schema Name of the LDAP attribute whose value indicates the unique identifier of the user. Default value is sAMAccountName. string Length : 1 - 1023 LDAP object class for users. Default value is user. Length : 1 - 1023 string user_search_p Path used to search for users on the directory server. ath Search path is empty, if global catalog is enabled.
PAGE 679
Name Description Schema Name of the new local user account to be created. The name required name value can be 1 to 64 UTF-8 characters long, and may only use alphanumeric characters. Dot(.) is the only special string character allowed. Length : 1 - 64 Password for the new local user account to be created.
PAGE 680
local_user_modify 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.
PAGE 681
Name reason_l10n optional to_appliance_i d optional Description Schema Localized message string corresponding to reason string 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.
PAGE 682
Name Description appliance_id Appliance id on which this maintenance window is optional configured. end_time Time when the maintenance window will close (or did optional close). id optional is_enabled optional Schema string 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.
PAGE 683
Name issuer optional key_length optional Description Schema Distinguished name of the certificate issuer. string 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.
PAGE 684
metrics_generate Metrics for specified entity Name Description entity MetricsEntityEnum required entity_id required Schema 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 entity required entity_l10n optional Description Schema Localized message string corresponding to entity.
PAGE 685
Name Description Schema Whether this migration action in active or not. New active recommendations will consist entirely of active optional recommendations but this may be changed with the modify boolean operation. Was added in version 2.0.0.0. connected_ap pliance_ids optional List of appliance ids to which the host attached to this resource has connectivity. Was added in version 2.0.0.0.
PAGE 686
Name Description Schema Name of the primary object. string ID of storage resource migrated by this action. string primary_nam e required resource_id required resource_type MigrationResourceT required ypeEnum resource_type _l10n Localized message string corresponding to resource_type string ID of appliance that is the source for this migration action. string optional src_appliance _id required migration_recommendation_action_modify Migration actions to be modified. Was added in version 2.0.
PAGE 687
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 optional evacuate_appl iance_all optional evacuate_obje cts optional Evacuate all storage objects from an appliance specified by evacuate_appliance_ appliance_id. Was added in version 2.0.0.0.
PAGE 688
evacuate_appliance_all Name appliance_id required Description Schema ID of appliance on which all selected storage objects are located string Example : "evac_from_appliance" Optional IDs of appliances to which used storage can be target_applia nce_ids optional migrated for this request. If no target appliances are specified, the evacuated objects can be placed on any appliance in the cluster.
PAGE 689
migration_recommendation_create_migration_session s_response Name Description Schema ID of migration sessions created for the recommendation. < string > array migration_ses sion_ids optional 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.
PAGE 690
Name Description sessions_com Time pleted_timest recommendation were complete. Null if migration sessions amp have not been created/started or if any migration pursuant optional to the recommendation is still ongoing. at Schema which all migration sessions for the string (date-time) sessions_creat Time at which migration sessions were created for the ed_timestamp recommendation. Null if migration sessions have not been string (date-time) optional created.
PAGE 691
Name Description Schema User-specified friendly name of the migration session name instance. The name can contain a maximum of 32 Unicode optional characters. It cannot contain unprintable characters, string special HTTP characters, or whitespace. resource_type MigrationResourceT required ypeEnum 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.
PAGE 692
Name Description Schema Unique identifier of the destination appliance instance. string Estimated completion time of the current sync operation. string (date-time) destination_a ppliance_id optional estimated_co mpletion_tim estamp optional 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.
PAGE 693
Name Description Schema Unique identifier of the source appliance instance. string source_applia nce_id optional state MigrationSessionSta optional teEnum state_l10n optional virtual_volum es optional volume_group s optional volumes optional Localized message string corresponding to state This is the inverse of the resource type virtual_volume association. This is the inverse of the resource type volume_group association. This is the inverse of the resource type volume association.
PAGE 694
Name Description current_unix_ NASServerCurrentU directory_ser nixDirectoryService vice Enum optional default_unix_ user optional default_windo ws_user optional Schema Default Unix user name used for granting access in case of Windows to Unix user mapping failure. When empty, access in such case is denied. string Length : 0 - 63 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.
PAGE 695
Name Description Schema Administrator password used to unjoin the associated SMB domain_pass servers from the Active Directory (AD) domain before word deleting the NAS server. This parameter is required when string (password) optional the skipDomainUnjoin parameter is false or not set, and the NAS server has SMB servers joined to an AD domain. Administrator login used to unjoin the associated SMB domain_user_ servers from the Active Directory (AD) domain before name deleting the NAS server.
PAGE 696
Name Description Schema current_prefe rred_IPv6_int Unique identifier of the current active preferred IPv6 erface_id interface. string optional current_unix_ NASServerCurrentU directory_ser nixDirectoryService vice Enum optional current_unix_ directory_ser Localized message string vice_l10n current_unix_directory_service corresponding to string optional default_unix_ Default Unix user name used for granting access in case of user Windows to Unix user mapping failure.
PAGE 697
Name Description file_ndmps This is the inverse of the resource type file_ndmp optional association. file_nises optional This is the inverse of the resource type file_nis association. file_systems This is the inverse of the resource type file_system optional association. file_virus_che ckers optional id optional This is the inverse of the resource type file_virus_checker association. Unique identifier of the NAS server.
PAGE 698
Name operational_st atus_l10n optional Description Localized Schema message string corresponding to operational_status string preferred_no Unique identifier of the preferred node for the NAS server de_id The initial value (on NAS server creation) is taken from the string optional current node. production_IP v4_interface_i Unique d identifier of the preferred IPv4 production of the preferred IPv6 production interface.
PAGE 699
Name Description Schema current_unix_ NASServerCurrentU directory_ser nixDirectoryService vice Enum optional default_unix_ user optional default_windo ws_user optional Default Unix user name used for granting access in case of Windows to Unix user mapping failure. When empty, access in such case is denied. string Length : 0 - 63 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.
PAGE 700
Name Description Schema production_IP v6_interface_i Unique d identifier of the preferred IPv6 production interface. string optional nas_server_ping Request body for ping arguments. Name Description Schema destination_a Destination to ping, can be either an IP address (IPv4 or ddress IPv6) or a hostname being resolved by the NAS server string (ip-address) optional name resolvers. When true, and the destination is a hostname, it will be is_ipv6 resolved to IPv6.
PAGE 701
Name Description name Name of the network. required Length : 1 - 128 prefix_length required Schema string Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 integer (int32) Maximum value : 127 Purposes of the network. This returns a list of purposes for purposes required the networks that support multiple purposes per network, < like storage network. Returns an empty list for the single NetworkPurposeEnu purposed networks, like management, vMotion, ICD and m > array ICM.
PAGE 702
Name Description ip_version Schema IpVersionTypeEnum optional ip_version_l10 n Localized message string corresponding to ip_version string optional Maximum Transmission Unit (MTU) packet size set on mtu network interfaces, in bytes. optional Minimum value : 1280 integer (int32) Maximum value : 9000 name optional prefix_length optional Name of the network. This property supports caseinsensitive filtering. Was added in version 2.0.0.0.
PAGE 703
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, corresponding to the network’s IP version. cluster_mgmt _address optional • This can only be specified when reconfiguring the management network. Caution Changing string (ip-address) the cluster management IP address will lead to losing management sessions through this address.
PAGE 704
Name Description Schema Maximum Transmission Unit (MTU) packet size set on mtu network interfaces, in bytes. optional Minimum value : 1280 integer (int32) Maximum value : 9000 name Name of the network. Was added in version 2.0.0.0. optional Length : 1 - 128 prefix_length optional Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 integer (int32) Maximum value : 127 remove_addre sses string IP addresses to remove in IPv4 or IPv6 format.
PAGE 705
network_replace Name Description Schema cluster_mgmt New cluster management IP address in IPv4 or IPv6 format, _address corresponding to the network’s IP version. required Minimum length : 1 dns_addresses required string (ip-address) List of new DNS server IP addresses in IPv4 or IPv6 format. < string (ip-address) > array esxi_credenti esxi_credentials als optional Indicates whether to suppress network validation errors.
PAGE 706
Name Description Schema ntp_addresses List of new NTP server FQDNs or IP addresses in IPv4 or < string (ip-address) required IPv6 format. > array physical_switc List of new physical switches settings. If this property is < hes omitted, physical switches configuration will not be network_replace_ph optional modified. prefix_length required ysical_switch > array Network prefix length. (Used for both IPv4 and IPv6).
PAGE 707
Name Description Schema < connections optional Supported connections for a physical switch. network_replace_ph ysical_switch_conne ction > array name optional Name of a physical switch. string purpose PhysicalSwitchPurp optional oseEnum network_replace_physical_switch_connection Name Description address Physical switch address in IPv4 or IPv6 or DNS hostname required format.
PAGE 708
Name port required source_email required 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 network_scale Parameters for the network scale operation. 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.
PAGE 709
Name anonymous_G ID optional anonymous_U ID optional Description Schema Specifies the group ID of the anonymous account. Default : -2 integer (int32) Minimum value : -2147483648 Maximum value : 2147483647 Specifies the user ID of the anonymous account. Default : -2 integer (int32) Minimum value : -2147483648 Maximum value : 2147483647 default_access NFSExportDefaultAc optional cessEnum description User defined NFS Export description.
PAGE 710
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.
PAGE 711
Name description optional Description Schema NFS Export description. string 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.
PAGE 712
Name Description Schema Local path to a location within the file system. With NFS, each export must have a unique local path. By default, the system exports the root of the file system (top-most directory) at the time the file system is created. This path path optional specifies the unique location of the file system on the storage system.
PAGE 713
Name Description Schema Hosts to add to the current read_only_hosts list. Hosts can add_read_onl be entered by Hostname, IP addresses (IPv4, IPv6, y_hosts IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), < string > array optional or Netgroups prefixed with @. Error if the host already exists. Cannot combine with read_only_hosts. Hosts to add to the current read_only_root_hosts list.
PAGE 714
Name Description Schema min_security NFSExportMinSecur optional ityEnum no_access_hos ts optional read_only_hos ts optional Hosts with no access to the NFS export or its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or < string > array IPv4/subnetmask), or Netgroups prefixed with @. Hosts with read-only access to the NFS export and its snapshots.
PAGE 715
Name Description Schema Hosts to remove from the current read_only_root_hosts list. remove_read_ Hosts can be entered by Hostname, IP addresses (IPv4, only_root_hos IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or ts IPv4/subnetmask), or Netgroups prefixed with @. Error if optional The host is not present. Cannot combine < string > array with read_only_root_hosts. Hosts to remove from the current read_write_hosts list.
PAGE 716
Name Description Schema Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are: - true NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to is_extended_c Unix Directory service to identify Unix groups. - false - NFS redentials_en server supports more than 16 Unix groups in a Unix abled credential.
PAGE 717
nfs_server_delete Arguments for the NFS server delete operation. Name Description Schema Allow to bypass NFS server unjoin. If false delete will fail if is_skip_unjoin optional secure is enabled and current kdc_type is MS Windows. If secure is enabled either unjoin NFS server before doing boolean delete or set value to true. Default : false nfs_server_instance Properties of an NFS server.
PAGE 718
Name Description Schema Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are: - true NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to is_extended_c Unix Directory service to identify Unix groups. - false - NFS redentials_en server supports more than 16 Unix groups in a Unix abled credential.
PAGE 719
Name Description nas_server_id The unique identifier of the NAS server that serves this optional share. Schema string service_princi The Service Principal Name (SPN) for the NFS server. This pal_name name is updated automatically when the NFS server string optional configuration changes. nfs_server_join Request arguments for the NFS server join operation. Name domain_pass word required domain_user_ name required Description Password of the domain-user specified to join the Active Directory domain.
PAGE 720
Name Description Schema Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are: - true NFS server supports more than 16 Unix groups in a Unix is_extended_c redentials_en abled optional credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. - false - NFS server supports more than 16 Unix groups in a Unix boolean credential.
PAGE 721
nfs_server_unjoin Request arguments for the NFS server unjoin operation. Name domain_pass word required domain_user_ name required Description Password of the domain-user specified to unjoin from the Active Directory domain. Name of a domain-user with privileges to unjoin from the Active Directory domain.
PAGE 722
Name Description addresses NTP server addresses. This list may contain IPv4 addresses, optional IPv6 addresses, and host names. id optional Unique identifier of the NTP setting. Schema < string > array string ntp_modify Name Description addresses NTP server addresses. This list may contain IPv4 addresses, required IPv6 addresses, and host names. Schema < string > array performance_metrics_by_appliance Performance metrics for the appliance collected at twenty second interval.
PAGE 723
Name avg_write_size optional entity required entity_l10n optional io_workload_c pu_utilization optional Description Schema Average write size in bytes. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests. number (float) read_bandwid th Read rate in bytes per second. number (float) Total read operations per second.
PAGE 724
Name write_iops optional Description Schema Total write operations per second. number (float) performance_metrics_by_appliance_rollup Summary of appliance level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : response_definition Name appliance_id optional avg_io_size optional Description Schema Unique identifier representing a specific appliance.
PAGE 725
Name avg_total_iops optional Description Schema 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. number (float) Localized message string corresponding to entity.
PAGE 726
Name Description Schema Maximum of average write size in bytes. number (float) 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. Derived from an average of optional utilization across all nodes within the appliance. number (float) max_read_ba ndwidth Maximum read bandwidth in bytes per second. number (float) Maximum reads per second.
PAGE 727
performance_metrics_by_cluster Performance metrics for the cluster collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional 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.
PAGE 728
Name repeat_count optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string 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.
PAGE 729
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 Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds.
PAGE 730
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.
PAGE 731
Name Description Schema Maximum writes per second. number (float) max_write_io ps optional repeat_count optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string End of sample period. string (date-time) required timestamp optional performance_metrics_by_fe_eth_node Ethernet performance metrics for the node collected at twenty second interval.
PAGE 732
Name pkt_rx_crc_er ror_ps optional pkt_rx_no_buf fer_error_ps optional pkt_rx_ps optional pkt_tx_error_ ps optional pkt_tx_ps optional repeat_count optional Description The number of packets received with CRC error (and thus dropped) per second. The number of packets discarded per second due to lack of buffer space. The number of packets received per second. The number of packets that failed to be transmitted per second due to error. The number of packets transmitted per second.
PAGE 733
Name Description Schema The average total bytes transmitted per second. number (float) avg_bytes_tx_ ps optional avg_pkt_rx_cr c_error_ps optional The average number of packets received with CRC error (and thus dropped) per second. number (float) avg_pkt_rx_no _buffer_error_ The average number of packets discarded per second due ps to lack of buffer space.
PAGE 734
Name Description Schema 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. number (float) max_pkt_tx_p s The maximum number of packets transmitted per second.
PAGE 735
Name bytes_rx_ps optional bytes_tx_ps optional entity required entity_l10n optional Description Schema The total bytes received per second. number (float) The total bytes transmitted per second. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string fe_port_id Reference optional (eth_port) on which these metrics were recorded.
PAGE 736
Name timestamp optional Description Schema 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. Polymorphism : Inheritance Discriminator : response_definition Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. Schema string avg_bytes_rx_ ps The average total bytes received per second.
PAGE 737
Name entity_l10n optional Description Schema Localized message string corresponding to entity string 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.
PAGE 738
Name Description Schema Response definition for the entity. string End of sample period. string (date-time) response_defi nition required timestamp optional performance_metrics_by_fe_fc_node Fibre channel performance metrics for the node collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes.
PAGE 739
Name entity required entity_l10n optional Description Schema Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string 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.
PAGE 740
Name Description Schema Response definition for the entity. string 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. number (float) Unaligned read input/output per second.
PAGE 741
Name write_iops optional Description Schema Total write operations per second. number (float) performance_metrics_by_fe_fc_node_rollup Fibre channel performance metrics for the node rolled up at various rollup intervals. Polymorphism : Inheritance Discriminator : response_definition Name Description avg_current_l Average number of logins to the target from initiators.
PAGE 742
Name Description Schema Average loss of sync count per second. number (float) avg_loss_of_sy nc_count_ps 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. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes.
PAGE 743
Name Description Schema 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. number (float) Localized message string corresponding to entity.
PAGE 744
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.
PAGE 745
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.
PAGE 746
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) max_unaligne d_write_band width optional 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.
PAGE 747
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.
PAGE 748
Name Description Schema 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. number (float) Reference to the node the port belongs to.
PAGE 749
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.
PAGE 750
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 Schema string 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.
PAGE 751
Name Description Schema 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. number Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second.
PAGE 752
Name Description Schema 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. number (float) Localized message string corresponding to entity.
PAGE 753
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_writ e_latency optional max_avg_writ e_size optional 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.
PAGE 754
Name Description Schema 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. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second.
PAGE 755
Name Description Schema 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_write_ba ndwidth optional max_write_io ps optional node_id optional repeat_count optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string End of sample period.
PAGE 756
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Unique identifier of the file system. string Read rate in bytes per second. number (float) Total read operations per second.
PAGE 757
Name Description Schema Write rate in bytes per second. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional sdnas_file_system_metrics_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 : response_definition Name Description Schema avg_latency Maximum optional microseconds.
PAGE 758
Name Description Schema Average write rate in bytes per second. number (float) Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Unique identifier of the file system.
PAGE 759
Name Description Schema Maximum of average write size in bytes. number (float) Maximum read and write operations per second. number (float) Maximum read rate in bytes per second. number (float) 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.
PAGE 760
version 2.0.0.0. Polymorphism : Inheritance Discriminator : response_definition 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.
PAGE 761
Name Description Schema Response definition for the entity. string 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 Write rate in bytes per second. number (float) Total write operations per second.
PAGE 762
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.
PAGE 763
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. number (float) Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second.
PAGE 764
Name repeat_count optional Description Schema Number of times the metrics is repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string End of sample period. string (date-time) required timestamp optional performance_metrics_by_node Performance metrics for the node collected at twenty second interval.
PAGE 765
Name Description current_login The number of logins to the target from initiators. s Minimum value : 0 optional Maximum value : 9223372036854775807 entity required entity_l10n optional io_workload_c pu_utilization optional node_id optional Schema integer (int64) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests.
PAGE 766
Name Description Schema 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.
PAGE 767
Name Description avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 avg_io_size optional Average size of read and write operations in bytes. Schema integer (int64) 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 across appliance.
PAGE 768
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.
PAGE 769
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.
PAGE 770
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.
PAGE 771
Name timestamp optional Description Schema End of sample period. string (date-time) performance_metrics_by_vg Performance metrics for the volumes in a volume group collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional 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.
PAGE 772
Name read_iops optional repeat_count optional Description Schema Total read operations per second. number (float) Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string 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 volume group.
PAGE 773
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) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Read rate in bytes per second.
PAGE 774
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 specific virtual machine. string Write rate in byte/sec. number (float) Total write operations per second.
PAGE 775
Name avg_read_size optional Description Schema 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.
PAGE 776
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) 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.
PAGE 777
Name timestamp optional vm_id optional Description Schema End of sample period. string (date-time) Unique identifier representing a specific virtual machine. string performance_metrics_by_volume Performance metrics for the volume collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded.
PAGE 778
Name Description Schema Read rate in bytes per second. number (float) Total read operations per second. number (float) read_bandwid th optional read_iops optional repeat_count optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string End of sample period. string (date-time) Total data transfer rate in bytes per second.
PAGE 779
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) 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.
PAGE 780
Name avg_write_size optional entity required entity_l10n optional max_avg_io_si ze optional Description Schema Weighted average write size in bytes. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string 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.
PAGE 781
Name Description Schema 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_total_ba ndwidth optional max_total_iop s optional max_write_ba ndwidth optional max_write_io ps optional repeat_count optional Number of times the metrics are repeated.
PAGE 782
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. number (float) Localized message string corresponding to entity.
PAGE 783
Name timestamp optional Description Schema 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 bytes per second. number (float) Total write operations per second.
PAGE 784
Name Description Schema Maximum of average read latency in microseconds. number (float) Average read size in bytes. number (float) Average data transfer rate in bytes per second. number (float) Average read and write operations per second. number (float) Average write rate in bytes per second. number (float) Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes.
PAGE 785
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 rate in bytes per second. number (float) Maximum read operations per second. number (float) Maximum data transfer rate in bytes per second.
PAGE 786
Name Description Schema Response definition for the entity. string Time at the beginning of sample period. string (date-time) response_defi nition required timestamp optional sdnas_file_by_cluster_instance Performance metrics cluster for the file collected at twenty second interval. Was added in version 2.0.0.0. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes.
PAGE 787
Name Description Schema Read rate in bytes per second. number (float) Total read operations per second. number (float) read_bandwid th 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). integer (int32) Minimum value : 0 Maximum value : 2147483647 response_defi nition Response definition for the entity.
PAGE 788
Name avg_io_size optional Description Schema Average read and write size in bytes. number (float) avg_latency Maximum of optional microseconds. 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. number (float) Average read size in bytes. number (float) Average data transfer rate in bytes per second.
PAGE 789
Name entity required entity_l10n optional Description Schema Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Maximum of average read and write size in bytes. number (float) max_avg_io_si ze 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.
PAGE 790
Name Description Schema 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_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. If the value is omitted from the response, it is 1 (no additional repeats).
PAGE 791
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) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Unique identifier of the node. string Read rate in bytes per second. number (float) Total read operations per second.
PAGE 792
Name total_iops optional Description Schema Total read and write operations per second. number (float) Write rate in bytes per second. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional sdnas_file_by_node_rollup Summary of file level performance metric data per node for the period beginning with timestamp, including the average and maximum values for that period. Was added in version 2.0.0.0.
PAGE 793
Name avg_total_iops optional Description Schema Average read and write operations per second. number (float) Average write rate in bytes per second. number (float) Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes. number (float) Localized message string corresponding to entity.
PAGE 794
Name Description Schema Maximum of average write size in bytes. number (float) Maximum read and write operations per second. number (float) Maximum read rate in bytes per second. number (float) 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) Unique identifier of the node.
PAGE 795
sdnas_nfs_metrics_instance Performance metrics for the nfs collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional 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.
PAGE 796
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 response_defi nition Response definition for the entity. string End of sample period.
PAGE 797
Name avg_read_ban dwidth optional avg_read_iops optional Description Average read rate in bytes per second. Was added in version 2.0.0.0. Schema number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_total_ban dwidth optional avg_total_iops optional avg_write_ban dwidth optional Average data transfer rate in bytes per second.
PAGE 798
Name Description Schema Maximum of average read and write size in bytes. number (float) max_avg_io_si ze optional max_avg_late ncy optional Maximum of average read and write latency in microseconds. 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 write latency in microseconds. number (float) Maximum of average write size in bytes.
PAGE 799
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 response_defi nition Response definition for the entity.
PAGE 800
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 response_defi nition Response definition for the entity. string End of sample period.
PAGE 801
Name avg_md_ops optional avg_read_iops optional avg_total_iops optional Description Schema 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. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Maximum average md latency per second.
PAGE 802
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 response_defi nition Response definition for the entity. string Time at the beginning of sample period.
PAGE 803
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 response_defi nition Response definition for the entity. string End of sample period. string (date-time) Total read and write iops in microseconds. number (float) Total write iops in microseconds.
PAGE 804
Name avg_total_iops optional Description Schema Average read and write operations per second. number (float) Average write operations per second. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string 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.
PAGE 805
Name Description Schema Response definition for the entity. string Time at the beginning of sample period. string (date-time) response_defi nition required timestamp optional sdnas_smb_v1_client_metrics_instance Performance metrics for the smb v1 client collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes.
PAGE 806
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 response_defi nition Response definition for the entity. string End of sample period.
PAGE 807
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.
PAGE 808
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.
PAGE 809
Name timestamp optional Description Schema Time at the beginning of sample period. string (date-time) sdnas_smb_v1_node_metrics_instance Performance metrics for the smb v1 node collected at twenty second interval. Polymorphism : Inheritance Discriminator : response_definition Name avg_io_size 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.
PAGE 810
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 response_defi nition Response definition for the entity. string End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second.
PAGE 811
Name avg_read_iops optional Description Schema 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. number (float) Localized message string corresponding to entity.
PAGE 812
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.
PAGE 813
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. number (float) Localized message string corresponding to entity.
PAGE 814
Name timestamp optional total_calls optional total_iops optional write_iops optional Description Schema End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second. number (float) Total write operations per second. number (float) sdnas_smb_v2_client_metrics_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.
PAGE 815
Name Description Schema Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) Localized message string corresponding to entity.
PAGE 816
Name max_iops optional Description Schema 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. 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.
PAGE 817
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) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Unique identifier of the node. string Total read operations per second.
PAGE 818
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) sdnas_smb_v2_node_metrics_rollup Summary of smb v1 node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
PAGE 819
Name Description Schema Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string avg_write_late ncy optional avg_write_size optional entity required entity_l10n optional max_avg_late ncy optional Maximum of average read and write latency microseconds.
PAGE 820
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).
PAGE 821
Name hash_avg_size optional Description Schema 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.
PAGE 822
Name total_tasks optional Description Schema Total tasks. number (float) sdnas_smb_cache_metrics_rollup Performance metrics nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : response_definition Name entity required entity_l10n optional Description Schema Localized message string corresponding to entity.
PAGE 823
Name Description Schema Min hash latency. number (float) Max hash size. number (float) Max used threads number (float) Unique identifier of the node. string hash_min_late ncy optional hash_min_size optional 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).
PAGE 824
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. number (float) Localized message string corresponding to entity.
PAGE 825
Name timestamp optional total_calls optional total_iops optional write_iops optional Description Schema End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second. number (float) Total write operations per second. number (float) sdnas_smb_client_metrics_rollup Summary of smb client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
PAGE 826
Name Description Schema Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) Localized message string corresponding to entity.
PAGE 827
Name max_iops optional Description Schema 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. 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.
PAGE 828
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) Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string Unique identifier of the node.
PAGE 829
Name total_bandwid th optional total_calls optional total_iops optional write_bandwi dth optional write_iops optional Description Total data transfer rate in bytes per second. Was added in version 2.0.0.0. Schema number (float) Total calls. number (float) Total read and write operations per second. number (float) Write rate in bytes per second. Was added in version 2.0.0.0. Total write operations per second.
PAGE 830
Name avg_read_iops optional Description Schema Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_total_ban dwidth optional avg_write_ban dwidth optional Average data transfer rate in bytes per second. Was added in version 2.0.0.0. Average write rate in bytes per second. Was added in version 2.0.0.0.
PAGE 831
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.
PAGE 832
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 response_defi nition Response definition for the entity. string Time at the beginning of sample period.
PAGE 833
Name Description Schema connect_meth PhysicalSwitchConn od ectMethodEnum required port optional Port used for connection to switch. Minimum value : 0 integer (int32) Maximum value : 65535 snmp_commu SNMPv2 community string, if SNMPv2c connect method is string (password) nity_string specified. optional Maximal length : 128 ssh_password optional username optional SSH password to connect a physical switch if SSH connect method is specified.
PAGE 834
Name physical_switc h_id optional port optional username optional Description Id of physical switch to which connection belongs. Maximal length : 128 Schema 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. string Maximal length : 128 physical_switch_connection_modify Name address required Description Physical switch address in IPv4 or IPv6 or DNS hostname format.
PAGE 835
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.
PAGE 836
Name Description name Name of physical switch. optional Length : 1 - 128 Schema 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. At least le_ids one snapshot rule or one replication rule must be specified < string > array optional to create a protection policy.
PAGE 837
Name Description Schema 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. This property supports case-insensitive optional filtering. performance_ rules optional replication_ru les optional snapshot_rule s optional List of the performance_rules that are associated with this policy.
PAGE 838
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.
PAGE 839
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.
PAGE 840
Name source_timest amp optional Description The time at which the resource was sourced from the resource identified by source_id. Schema string (date-time) remote_support_contact_instance Remote support instance properties. Was added in version 2.0.0.0. Name email optional first_name optional Description The email address of the support contact for this system. Was added in version 2.0.0.0. The first name of the support contact for this system. Was added in version 2.0.0.0.
PAGE 841
Name last_name optional phone optional Description Schema The last name of the support contact for this system. Was added in version 2.0.0.0. string Maximal length : 128 The phone number of this support contact for this system. Was added in version 2.0.0.0. string Maximal length : 64 remote_syslog_server_create Create a remote syslog server configuration. Was added in version 2.0.0.0. Name audit_types required Description Schema Audit type selections.
PAGE 842
Name audit_types optional audit_types_l1 0n optional Description Schema Audit type selections. If empty, all types will be sent to the < remote log server. Otherwise, only audit events of the AuditEventTypeEnu specified type(s) will be sent. Localized message array corresponding to audit_types Was added in version 2.0.0.0.
PAGE 843
remote_syslog_server_modify Modify parameters for remote syslog server configurations. Was added in version 2.0.0.0. Name audit_types optional Description Schema Audit type selections. If empty, all types will be sent to the < remote log server. Otherwise, only audit events of the AuditEventTypeEnu specified type(s) will be sent. m > array encryption EncryptionTypeEnu optional m is_enabled optional port optional If true, then this instance will receive audit messages.
PAGE 844
Name data_network _latency optional Description Network latency choices for remote system. This is RemoteSystemLaten applicable to PowerStore remote systems. description User-specified description of the remote system. optional Maximal length : 256 discovery_cha p_mode optional import_chap_i nfo optional is applicable to non-PowerStore remote systems. is applicable to non-PowerStore remote systems. remote system. Must be specified when creating a non- optional PowerStore remote system.
PAGE 845
remote_system_delete Delete a remote system and any associated x509 Replication HTTP certificates. Type : object remote_system_instance A remote system. This resource type has queriable associations from import_session, replication_session Name Description Schema data_connecti on_state DataConnectionState State of the data connection.
PAGE 846
Name id optional import_sessio ns optional iscsi_addresse s optional Description Schema Unique identifier of the remote system instance. string This is the inverse of the resource type import_session association. < import_session_insta nce > array iSCSI target addresses for the data connection to the remote < string (ip-address) system. > array Management IP address of the remote system instance.
PAGE 847
Name type_l10n optional Description Schema Localized message string corresponding to type string user_name Username used to access the non-PowerStore remote optional systems. version optional Version of the remote system. Was added in version 2.0.0.0. string string remote_system_modify Modify the remote system. Name Description data_network _latency Network latency for the PowerStore remote system. optional description User-specified description of the remote system.
PAGE 848
Type : object replication_element_pair Replication session element pair which maps the local storage element to the remote storage element. Name Description Schema Unique identifier of a local storage element. string Unique identifier of a remote storage element. string local_storage_ element_id required remote_storag e_element_id required replication_sh adow_id optional Unique identifier of the internal snap used for replicating data. storage_eleme nt_type Storage element type.
PAGE 849
Name Description Schema rpo RPOEnum required replication_rule_instance Properties of the replication rule. This resource type has queriable associations from policy, replication_session 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.
PAGE 850
Name rpo_l10n optional Description Schema Localized message string corresponding to rpo string replication_rule_modify Replication rule modify request. Name Description Schema Acceptable delay in minutes between the expected and alert_threshol d optional actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold.
PAGE 851
Name Description Schema Indicates whether an unplanned failover needs to be force performed for a session that is already in a failed over optional state. boolean Default : false Indicates whether the replication session failover is is_planned planned or unplanned. For planned failovers, the value is optional true. For unplanned failovers, the value is false. boolean Default : true reverse optional Indicates whether the system is auto-reprotected.
PAGE 852
Name id optional Description Schema Unique identifier of the replication session instance. string Elapsed time of the last synchronization operation in last_sync_dur ation optional milliseconds. integer (int32) Was added in version 2.0.0.0. Minimum value : 0 Maximum value : 2147483647 last_sync_time stamp Time of last successful synchronization.
PAGE 853
Name replication_ru le optional replication_ru le_id optional resource_type optional Description This is Schema the embeddable reference form of replication_rule_inst replication_rule_id attribute. Associated replication rule instance if created by policy engine. Type of the storage resource.
PAGE 854
Name Description snapshot_id Identifier of the optional snapshot instance created at the optional end of the test. Schema string replication_start_failover_test Parameter(s) to start a disaster recovery (DR) failover simulation test at the destination site of a replication session. Was added in version 2.0.0.0.
PAGE 855
role_instance Name description optional id optional is_built_in optional name optional Description Schema Description of the role. string Unique identifier of the role. string Indicates whether the role is built-in. boolean Name of the role. string 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.
PAGE 856
Name Description Schema Indicates whether the SAS port’s link is up. Values are: is_link_up true Link is up. false Link is down. optional name Name of the SAS port. This property supports case- optional insensitive filtering. node optional 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.
PAGE 857
sc_profile_rule_instance Snapshot profile rule. Name Description Schema Dates of the month in which a snapshot will be taken. < integer > array date_of_mont h optional day_of_week optional Days of the week in which a snapshot will be taken. < DayOfWeekEnum > array day_of_week_l 10n Localized message array corresponding to day_of_week < string > array Time when snapshot creation will stop.
PAGE 858
Name name optional start_date_tim e optional start_time optional Description Schema Name of the snapshot profile rule. string Date and time when the snapshot will be created. This applies to the value Once in the ScScheduleTypeEnum. Time when snapshot creation will start. week_of_mont h string (date-time) string (timestamp) < Weeks of the month in which a snapshot will be taken.
PAGE 859
Name Schema protocol_mode SecurityProtocolModeEnum optional 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. is_ssh_enable d optional true SSH access is enabled false SSH access is disabled boolean service_config_modify Name Description Schema Current SSH service access state.
PAGE 860
Name Description Schema 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.
PAGE 861
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 required 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.
PAGE 862
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.
PAGE 863
Name nas_server_id optional Description Schema Unique identifier of the NAS server. string 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.
PAGE 864
smb_server_modify Arguments for the SMB server modify operation. 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 (.
PAGE 865
Name Description Schema NetBIOS name is the network name of the standalone SMB server. SMB servers joined to Active Directory also have NetBIOS Name, defaulted to the 15 first characters of the computer_name attribute. Administrators can specify a custom NetBIOS Name for an SMB server using this netbios_name optional attribute.
PAGE 866
Name Description description SMB share description. optional Length : 0 - 511 file_system_id Unique identifier of the file system on which the SMB Share required will be created. Schema string string Indicates whether Access-based Enumeration (ABE) is is_ABE_enable d optional enabled. ABE filters the list of available files and folders on a server to include only those to which the requesting user has access. Values are: - true - ABE is enabled. - false - ABE boolean is disabled.
PAGE 867
Name Description Schema Local path to the file system or any existing sub-folder of the file system that is shared over the network. This path is relative to the NAS Server and must start with the path required filesystem’s mountpoint path, which is the filesystem name. For example to share the top-level of a filesystem named string svr1fs1, which is on the /svr1fs1 mountpoint of the NAS Server, use /svr1fs1 in the path parameter.
PAGE 868
Name Description Schema Indicates whether BranchCache optimization is enabled. BranchCache optimization technology copies content from is_branch_cac your main office or hosted cloud content servers and he_enabled caches the content at branch office locations, allowing boolean optional client computers at branch offices to access the content locally rather than over the WAN. Values are: - true BranchCache is enabled. - false - BranchCache is disabled.
PAGE 869
smb_share_modify Name Description description NFS Share description. optional Length : 0 - 511 Schema string Indicates whether Access-based Enumeration (ABE) is is_ABE_enable enabled. ABE filters the list of available files and folders on d a server to include only those, that the requesting user has boolean optional access to. Values are: - true - ABE is enabled. - false - ABE is disabled. Indicates whether BranchCace optimization is enabled.
PAGE 870
Name Description id Unique identifier of the SMTP configuration. This value is optional always '0'. port optional source_email optional Schema string 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_modify Name address optional port optional source_email optional Description Schema IP address of the SMTP server. string (ip-address) Port used for sending SMTP messages.
PAGE 871
Name desired_reten tion required Description Schema Desired snapshot retention period in hours. The system will retain snapshots for this time period. Minimum value : 1 integer (int32) Maximum value : 8760 interval SnapRuleIntervalEn optional um name required Snapshot rule name. string 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 may be set, but string not both.
PAGE 872
Name desired_reten tion optional id optional Description Schema Desired snapshot retention period in hours. The system will retain snapshots for this time period. integer (int32) Minimum value : 0 Maximum value : 2147483647 Unique identifier of the snapshot rule.
PAGE 873
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. desired_reten tion optional Schema > array Desired snapshot retention period in hours. The system will retain snapshots for this time period. Minimum value : 1 integer (int32) Maximum value : 8760 interval SnapRuleIntervalEn optional um name optional Snapshot rule name.
PAGE 874
Name Description Schema Port number to use with the address of the SNMP server: port 162, [1024-49151] required Minimum value : 162 integer (int32) Maximum value : 49151 privacy_proto SNMPPrivacyProtoc col olEnum optional trap_commun Trap Community string. Usually describes the security ity level, relevant only for SNMPv2c. optional Length : 0 - 256 user_name User name, relevant only for SNMPv3.
PAGE 875
Name ip_address optional port optional Description Schema IPv4 address, IPv6 address, or FQDN of the SNMP server. string (ip-address) Port number to use with the address of the SNMP server. Minimum value : 0 integer (int32) Maximum value : 2147483647 privacy_proto SNMPPrivacyProtoc col olEnum optional privacy_proto col_l10n optional trap_commun ity optional user_name optional Localized message string corresponding to privacy_protocol Was added in version 2.0.0.0. Trap Community string.
PAGE 876
Name ip_address optional Description Schema IPv4 address, IPv6 address, or FQDN of the SNMP server. string (ip-address) Port number to use with the address of the SNMP server: port 162, [1024-49151] optional Minimum value : 162 integer (int32) Maximum value : 49151 privacy_proto SNMPPrivacyProtoc col olEnum optional trap_commun Trap Community string. Usually describes the security ity level. optional Length : 0 - 256 user_name User name, relevant only for SNMPv3.
PAGE 877
Name build_type_l10 n optional Description Localized message string corresponding to build_type Was added in version 2.0.0.0. build_version Build version of the installed software package release. optional id optional installed_date optional Was added in version 2.0.0.0. Unique identifier of the installed software instance. Schema string string string Date and time when the software was successfully installed and committed on the cluster.
PAGE 878
Name build_flavor_l 10n optional build_id optional build_type optional build_type_l10 n optional Description Localized message string corresponding to build_flavor Was added in version 2.0.0.0. string Unique identifier of this build. Was added in version 2.0.0.0. string Was added in version 2.0.0.0. Localized message string corresponding to build_type Was added in version 2.0.0.0. build_version Build number of the software package. Was added in optional Schema version 2.0.0.0.
PAGE 879
Name Description Schema Version number of the software package. string release_versio n optional size optional File size of the software package in bytes.
PAGE 880
Name Description Schema The overall efficiency is computed as a ratio of the total space provisioned to physical used space. For example, ten 2 GB volumes were provisioned and 1 GB of data is written efficiency_rati to each of them. Each of the volumes has one snapshot as o well, for another ten 2 GB volumes. All volumes are thinly number (float) optional provisioned with deduplication and compression applied, there is 4 GB of physical space used.
PAGE 881
Name Description Schema Amount of data in bytes written to all virtual volumes on logical_used_v vol optional an appliance, without any deduplication and/or compression. This metric includes all primaries, snaps and clones. Was added in version 2.0.0.0. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 Total combined space on the physical drives of the physical_total appliance available for data.
PAGE 882
Name Description Schema Amount of data in bytes written to all virtual volumes on shared_logical _used_vvol optional an appliance, without any deduplication and/or compression. This metric includes all primaries and clones. Was added in version 2.0.0.0. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 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.
PAGE 883
Name Description last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_data_red uction 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.
PAGE 884
Name Description Schema last_shared_lo Last shared logical used during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space for file systems during the gical_used_fil period. Was added in version 2.0.0.0. e_system Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space for block volumes during the gical_used_vol period.
PAGE 885
Name Description Schema max_logical_u Maxiumum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space for file systems during the sed_file_syste period. Was added in version 2.0.0.0.
PAGE 886
Name Description Schema max_shared_l Maximum shared logical used space for virtual volumes ogical_used_v during the period. Was added in version 2.0.0.0. vol Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_snapshot _savings Maximum snapshot savings space during the period. number (float) Maximum thin savings ratio during the period. number (float) optional max_thin_savi ngs optional repeat_count optional Number of times the metrics are repeated.
PAGE 887
Name Description Schema The overall efficiency is computed as a ratio of the total space provisioned to physical used space. For example, ten 2 GB volumes were provisioned and 1 GB of data is written efficiency_rati to each of them. Each of the volumes has one snapshot as o well, for another ten 2 GB volumes. All volumes are thinly number (float) optional provisioned with deduplication and compression applied, there is 4 GB of physical space used.
PAGE 888
Name Description Schema Amount of data in bytes written to all virtual volumes logical_used_v vol optional within the cluster, without any deduplication and/or compression. This metric includes all primaries, snaps and clones. Was added in version 2.0.0.0. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 The total combined space on the physical drives of the physical_total cluster available for data.
PAGE 889
Name Description Schema Amount of data in bytes written to all virtual volumes on shared_logical _used_vvol optional an appliance, without any deduplication and/or compression. This metric includes all primaries and clones. Was added in version 2.0.0.0. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 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.
PAGE 890
Name Description last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_data_red uction 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.
PAGE 891
Name Description Schema last_shared_lo Last shared logical used during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space for file systems during the gical_used_fil period. Was added in version 2.0.0.0. e_system Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space for block volumes during the gical_used_vol period.
PAGE 892
Name Description Schema max_logical_u Maximum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space for file systems during the sed_file_syste period. Was added in version 2.0.0.0.
PAGE 893
Name Description Schema max_shared_l Maximum shared logical used space for virtual volumes ogical_used_v during the period. Was added in version 2.0.0.0. vol Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_snapshot _savings Maximum snapshot savings space during the period. number (float) Maximum thin savings ratio during the period. number (float) optional max_thin_savi ngs optional repeat_count optional Number of times the metrics are repeated.
PAGE 894
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. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity.
PAGE 895
Name entity required entity_l10n optional Description Schema Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity 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.
PAGE 896
Name Description Schema Response definition for the entity. string Internal ID of the storage container. string End of sample period. string (date-time) response_defi nition required storage_conta iner_id optional timestamp optional space_metrics_by_vg Space metrics for a volume group collected at a five minute interval.
PAGE 897
Name Description Schema Total amount of data in bytes host has written to all snap_clone_lo gical_used optional volumes in the volume group without any deduplication, compression or sharing. This metric includes used snaps and clones in the volume group.
PAGE 898
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_snap_clon Last snap and clone logical used space during the period.
PAGE 899
Name Description Schema Response definition for the entity. string End of sample period. string (date-time) Unique identifier representing a specific volume group. string response_defi nition required timestamp optional vg_id optional space_metrics_by_vm Space metrics for the VM collected at five minute interval.
PAGE 900
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.
PAGE 901
Name entity required entity_l10n optional Description Schema Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity 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.
PAGE 902
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 max_unique_ Max unique physical used space during the period. physical_used Minimum value : 0 optional repeat_count optional integer (int64) Maximum value : 9223372036854775807 Number of times the metrics are repeated.
PAGE 903
Name Description Schema Configured size in bytes of a volume which amount of data logical_provis can be written to. This metric includes primaries, snaps ioned and clones. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Amount of data in bytes host has written to a volume logical_used optional without any deduplication, compression or sharing. This metric includes primaries, snaps and clones.
PAGE 904
Name entity required entity_l10n optional family_id optional Description Schema Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string ID of the family. 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.
PAGE 905
Name Description Schema Ratio of the amount of space that would have been used by snapshots if space efficiency was not applied to logical snapshot_savi space used solely by snapshots. For example, a volume is ngs provisioned as 1 GB bytes and it has two snapshots. Each number (float) optional 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. timestamp optional End of sample period.
PAGE 906
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snap_clon Last snap and clone logical used space during the period.
PAGE 907
Name repeat_count optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 response_defi nition Response definition for the entity. string End of sample period. string (date-time) required timestamp optional space_metrics_by_volume_rollup Summary of volume level space metric data for one hour or one day period beginning with timestamp, including the maximum and final values for that period.
PAGE 908
Name Description Schema 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. sed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_thin_savi ngs Max thin savings ratio during the period. number (float) optional repeat_count optional Number of times the metrics are repeated.
PAGE 909
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.
PAGE 910
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.
PAGE 911
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.
PAGE 912
Name Description username Username of the local user account which will be used by required vSphere to register VASA provider. Schema string vcenter_create Name Description address IP address of vCenter host, in IPv4, IPv6, or hostname optional format. password optional username optional string (ip-address) Password to login to vCenter. string (password) User name to login to vCenter. string vasa_provider _credentials Schema Was added in version 2.0.0.0.
PAGE 913
Name instance_uuid optional username optional Description Schema UUID instance of the vCenter. string User name to login to vCenter. string General status of the VASA vendor provider in vCenter. A vendor_provi der_status optional VASA vendor provider is required for HCI deployments, and optional for SAN deployments. To register or re- VendorProviderStat register the VASA vendor provider, pass appropriate usEnum storage system credentials using the modify request. Was added in version 2.0.0.0.
PAGE 914
Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional Unique identifier of the appliance. Schema appliance_instance string Maximum Transmission Unit (MTU) packet size that the current_mtu virtual Ethernet port can transmit. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 current_speed optional id optional ip_ports optional Virtual Ethernet port transmission speed, in bits/sec (bps).
PAGE 915
Name Description Schema Identifier of the virtual Ethernet port with the same logical partner_id optional location on the other node of the appliance. Partner ports are configured symmetrically for HA and load balancing string purposes within the appliance. Was added in version 2.0.0.0. vswitch_name Name of the virtual switch that holds the virtual Ethernet optional vswitch_port_ group_name optional vswitch_port_i d optional port.
PAGE 916
Name Description id Unique identifier of the VM instance. This value is optional generated by the appliance. instance_uuid optional is_consistent optional Schema string UUID instance of the VM in vCenter. This value is stored in the VM and migrates with the VM to other vCenter string instances. Not applicable to VM snapshots. Indicates whether the VM snapshot is crash-consistent. boolean is_consistent_ snaps_support Indicates whether the VM supports creating crashed consistent snapshots.
PAGE 917
Name Description Schema type VirtualMachineType optional Enum type_l10n optional Localized message string corresponding to type vcenter This is the embeddable reference form of vcenter_id optional attribute. vcenter_id The unique identifier of the vCenter object that hosts the optional VM. Was added in version 2.0.0.0. vcenter_insta nce_uuid optional virtual_volum es optional UUID instance of the vCenter that hosts the VM. Was deprecated in version 2.0.0.0.
PAGE 918
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.
PAGE 919
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.
PAGE 920
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.
PAGE 921
Name type_l10n optional Description Schema Localized message string corresponding to type string 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 virtual_machi nes optional List of the virtual_machines that are associated with this virtual_volume.
PAGE 922
Name parent_id optional source_id optional Description Schema VM from which the snapshot was created. string For VM snapshots, this value is the same as parent_id. string Time when the snapshot was created. string (date-time) source_timest amp optional volume_attach Parameters for the volume attach operation. 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.
PAGE 923
Name Description Schema Optional logical unit number when creating a mapped logical_unit_n volume. If no host_id or host_group_id is specified, this umber property is ignored. optional Minimum value : 0 integer (int32) Maximum value : 16383 name optional Name of the clone. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 performance_ policy_id Unique identifier of the performance policy. string Unique identifier of the protection policy.
PAGE 924
Name host_id optional Description Schema Unique identifier of the host to be attached to the volume. If not specified, an unmapped volume is created. Only one string of host_id or host_group_id can be supplied. Optional logical unit number when creating a attached logical_unit_n volume. If no host_id or host_group_id is specified, this umber property is ignored.
PAGE 925
volume_detach Name host_group_id optional host_id optional Description Schema Unique identifier of the host group to be detached from this volume. Only one of host_id or host_group_id can be string supplied. Unique identifier of the host to be detached from this volume. Only one of host_id or host_group_id can be string supplied. volume_group_add_members Request to add members to a volume group.
PAGE 926
volume_group_clone_response Response for volume group clone action Name id optional Description Schema Unique identifier of the new instance created. string 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.
PAGE 927
Name Description Schema A list of identifiers of existing volumes that should be added to the volume group. volume_ids optional All the volumes must be on the same Cyclone appliance and should not be part of another volume group. < string > array If a list of volumes is not specified or if the specified list is empty, an empty volume group of type Volume will be created. volume_group_delete Delete volume group request.
PAGE 928
Name Description This is a Schema derived field that is set internally. It enables/disables the following functionality: is_protectable optional • Whether a protection_policy can be applied to the group. boolean • Whether manual snapshots can be taken. • Whether clones of the group can be created. Indicates whether this volume group is a replication destination. A replication destination will be created by the system when a replication session is created.
PAGE 929
Name Description Schema name Name of the volume group. This property supports case- optional insensitive filtering. string placement_rul e VGPlacementRule optional 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.
PAGE 930
Name Description Schema Time after which the snapshot set can be auto-purged. This parameter is only valid for a snapshot set. Time must be expiration_ti mestamp optional specified in Zulu time zone. Expiration time cannot be prior to current time. Use a maximum timestamp value to set an expiration to never expire. If an empty string is specified, string expiration_timestamp will be cleared for the snapshot set. Valid format is yyyy-MM-dd’T’HH:mm:ssZ or yyyy-MMdd’T’HH:mm:ss.SSSZ.
PAGE 931
Name Description Schema New name for the volume group. The name should contain no special HTTP characters and no unprintable characters. name Although the case of the name provided is reserved, optional uniqueness check is case-insensitive, so the same name in string two different cases is not considered unique. Maximal length : 128 protection_po licy_id optional Unique identifier of the protection policy to assign to a primary or clone volume group.
PAGE 932
volume_group_remove_members Request to remove members from a volume group. Name Description volume_ids A list of volumes that need to be removed from the volume required group. This list cannot be empty. Schema < string > array volume_group_restore Restore volume group request.
PAGE 933
Name Description description optional Schema Optional description for the snapshot set. If description is not specified, the description for the snapshot set will not string be set. Time after which the snapshot set can be auto-purged. Time must be specified in Zulu time zone. Expiration time expiration_ti cannot be prior to current time. Use a maximum timestamp mestamp value to set an expiration to never expire. Valid format is string optional yyyy-MM-dd’T’HH:mm:ssZ or yyyy-MM- dd’T’HH:mm:ss.
PAGE 934
Name description optional id optional Description Schema Description of the volume. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 Unique identifier of the volume instance. string Indicates whether this volume is a replication destination. A replication destination will be created by the system when a replication session is created.
PAGE 935
Name nguid optional Description Schema NVMe Namespace globally unique identifier. Used for volumes attached to NVMEoF hosts. Was added in version string 2.0.0.0. node_affinity Node affinity. Node which offers optimized IO for volume, optional values are: NodeAffinityEnum node_affinity_ l10n Localized message string corresponding to node_affinity string optional NVMe nsid optional Namespace unique identifier in the NVME subsystem. Used for volumes attached to NVMEoF hosts.
PAGE 936
Name Description Schema type VolumeTypeEnum optional type_l10n optional volume_group s optional wwn optional Localized message string corresponding to type string List of the volume_groups that are associated with this volume. < volume_group_insta nce > array World wide name of the volume. string volume_modify Parameters for the volume modify operation. Name description optional Description Schema New description of the volume.
PAGE 937
Name Description Schema New value for is_replication_destination property. The is_replication modification is only supported for primary and clone _destination volume, only when the current value is true and there is no boolean optional longer a replication session using this volume as a destination, and only to false. name optional node_affinity optional performance_ policy_id optional protection_po licy_id optional New name of the volume.
PAGE 938
Name from_object_i d required Description Unique identifier of the source volume that will be used for the refresh operation. Schema string volume_refresh_response Volume refresh response definition. Name backup_snaps hot_id optional Description Unique identifier of the backup snapshot of the target volume, if one is created prior to the refresh operation. Schema string volume_restore Parameters for the volume restore operation.
PAGE 939
volume_snapshot Parameters for the volume snapshot operation. 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 Time at which the snapshot will expire. Expired snapshots expiration_ti are deleted by the snapshot aging service that runs mestamp periodically in the background.
PAGE 940
Name Description error_code Minimum value : 0 optional Maximum value : 2147483647 Schema integer (int32) wear_metrics_by_drive_daily_instance Wear metrics for the drives collected daily. Was added in version 2.0.0.0. Polymorphism : Inheritance Discriminator : response_definition Name Description drive_id Reference to the associated drive which these metrics were optional recorded. entity required entity_l10n optional Schema string Localized message string corresponding to entity.
PAGE 941
Name Description drive_id Reference to the associated drive which these metrics were optional recorded. entity required entity_l10n optional Schema string Localized message string corresponding to entity. MetricsEntityEnum Localized message string corresponding to entity string The percentage of drive wear remaining. number (float) percent_endu rance_remain ing optional repeat_count optional Number of times the metrics is repeated.
PAGE 942
Name Description Schema Indicates whether this is the current X509 certificate to be used by the service or this X509 Certificate will be used in is_current the future. When is_current is false for a X509 Certificate, optional this X509 Certificate will not be picked up by the service. boolean Potential usage of this attribute is to prepare for the certificate roll-over/rotation. passphrase optional Passphrase used to encrypt private key.
PAGE 943
Name Description Schema Part of distinguished name. e.g., www.dell.common. string Part of distinguished name. e.g., US. string DNS names in the certificate extensions < string > array IP addresses in the certificate extensions < string > array common_nam e optional country optional dns_name required ip_addresses required key_length required locality optional organization optional Private key length. It can only be 2048 or 4096.
PAGE 944
Name Description Schema Scope defines a subset of certificates belonging to one Service. Scope has different meanings from different Services and types. For example, in Replication_HTTP, CA type certificates will use scope to indicate the origin of these certificates.
PAGE 945
Name Description Schema Indicates whether this is the current X509 certificate to be used by the service or this X509 certificate will be used in is_current the future. When is_current is false for a X509 Certificate, optional this X509 Certificate will not be picked up by the service. boolean Potential usage of this attribute is to prepare for the certificate roll-over/rotation. Indicate whether this is a valid X509 Certificate.
PAGE 946
Name Description Schema type X509CertificateUsag optional eTypeEnum type_l10n Localized message string corresponding to type Was added optional in version 2.0.0.0. string x509_certificate_exchange x509 certificate exchange opertation request body. Name address required Description Schema Peer’s ip v4 or v6 address or dns name. string (ip-address) password Password required PowerStore cluster.
PAGE 947
Name Description Schema Indicates whether this is a valid X509 certificate. When is_valid X509 certificate is expired or X509 Certificate of server type optional missing either a private key or a valid certificate entry, it boolean will be false. Member certificates included in this x509_certificate. members Member certificates should be remained in an ordered optional sequence. Filtering on the fields of this embedded resource is not supported.