Home » Dell Manuals » Storage Devices » Dell PowerStore 500T » Manual Viewer

Dell PowerStore 500T EMC PowerStore REST API Reference Guide - Page 934

Description, Schema, Maximal length, is_replication, destination, Default, location_histo, mapped_volu

View all Dell PowerStore 500T manuals

Add to My Manuals
Save this manual to your list of manuals

Page 934 highlights

Name description optional Description Schema Description of the volume. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 id optional Unique identifier of the volume instance. string is_replication _destination optional Indicates whether this volume is a replication destination. A replication destination will be created by the system when a replication session is created. When there is an active replication session, all the user operations are restricted including modification, deletion, host operation, snapshot, clone, etc. After the replication session is deleted, the replication destination volume will remain as it is until the end user changes it to be a non-replication destination. boolean After the change, it becomes a primary volume. If the end user keeps it as a replication destination, when the replication session is recreated, the replication destination volume could potentially be reused in the new session to avoid a time-consuming full sync. This property is only valid for primary and clone volumes. Default : false location_histo ry optional Filtering on supported. the fields of this embedded resource is not < location_history_inst ance > array mapped_volu mes optional This is the inverse of the host_volume_mapping association. resource < type host_volume_mappi ng_instance > array migration_ses sion optional This is the embeddable migration_session_id attribute. reference form of migration_session_i nstance migration_ses sion_id Unique identifier of the migration session assigned to the string volume if it is part of a migration activity. optional name optional Name of the volume. This value must contain 128 or fewer printable Unicode characters. This property supports case- insensitive filtering. string Maximal length : 128 933

Section	Page
pwrstr-apirefg_cover	1
PowerStore_APIReferenceGuide	2
Storage cluster API	2
Table of Contents	2
Changelog	31
Version 2.0.0.0	31
Paths	31
Parameters	32
Enumeration values	32
Definitions	33
Definition members	39
Version 1.0.3	44
Paths	44
Enumeration values	45
Definitions	45
Definition members	45
Version 1.0.2	45
Paths	46
Enumeration values	46
Definitions	46
Definition members	48
Resources	49
alert	49
GET /alert	49
GET /alert/{id}	49
PATCH /alert/{id}	50
appliance	51
GET /appliance	51
POST /appliance	51
POST /appliance/validate_create	52
GET /appliance/{id}	53
DELETE /appliance/{id}	53
PATCH /appliance/{id}	54
POST /appliance/{id}/forecast	55
POST /appliance/{id}/time_to_full	56
audit_event	56
GET /audit_event	56
bond	57
GET /bond	57
GET /bond/{id}	57
chap_config	58
GET /chap_config	58
GET /chap_config/{id}	59
PATCH /chap_config/{id}	59
cluster	60
GET /cluster	60
POST /cluster	61
POST /cluster/validate_create	61
GET /cluster/{id}	62
PATCH /cluster/{id}	63
POST /cluster/{id}/forecast	64
POST /cluster/{id}/time_to_full	64
discovered_initiator	65
GET /discovered_initiator	65
dns	66
GET /dns	66
GET /dns/{id}	66
PATCH /dns/{id}	67
email_notify_destination	68
GET /email_notify_destination	68
POST /email_notify_destination	68
GET /email_notify_destination/{id}	69
DELETE /email_notify_destination/{id}	69
PATCH /email_notify_destination/{id}	70
POST /email_notify_destination/{id}/test	71
eth_port	71
GET /eth_port	71
GET /eth_port/{id}	72
PATCH /eth_port/{id}	72
event	73
GET /event	73
GET /event/{id}	73
fc_port	74
GET /fc_port	74
GET /fc_port/{id}	74
PATCH /fc_port/{id}	75
file_dns	76
GET /file_dns	76
POST /file_dns	76
GET /file_dns/{id}	77
DELETE /file_dns/{id}	77
PATCH /file_dns/{id}	78
file_ftp	78
GET /file_ftp	79
POST /file_ftp	79
GET /file_ftp/{id}	80
DELETE /file_ftp/{id}	80
PATCH /file_ftp/{id}	81
file_interface	81
GET /file_interface	81
POST /file_interface	82
GET /file_interface/{id}	82
DELETE /file_interface/{id}	83
PATCH /file_interface/{id}	83
file_interface_route	84
GET /file_interface_route	84
POST /file_interface_route	85
GET /file_interface_route/{id}	85
DELETE /file_interface_route/{id}	86
PATCH /file_interface_route/{id}	86
file_kerberos	87
GET /file_kerberos	87
POST /file_kerberos	88
GET /file_kerberos/{id}	88
DELETE /file_kerberos/{id}	89
PATCH /file_kerberos/{id}	89
POST /file_kerberos/{id}/upload_keytab	90
GET /file_kerberos/{id}/download_keytab	91
file_ldap	91
GET /file_ldap	92
POST /file_ldap	92
GET /file_ldap/{id}	93
DELETE /file_ldap/{id}	93
PATCH /file_ldap/{id}	94
POST /file_ldap/{id}/upload_config	94
GET /file_ldap/{id}/download_config	95
POST /file_ldap/{id}/upload_certificate	95
GET /file_ldap/{id}/download_certificate	96
file_ndmp	97
GET /file_ndmp	97
POST /file_ndmp	97
GET /file_ndmp/{id}	98
DELETE /file_ndmp/{id}	98
PATCH /file_ndmp/{id}	99
file_nis	99
GET /file_nis	100
POST /file_nis	100
GET /file_nis/{id}	100
DELETE /file_nis/{id}	101
PATCH /file_nis/{id}	101
file_system	102
GET /file_system	102
POST /file_system	103
GET /file_system/{id}	103
DELETE /file_system/{id}	104
PATCH /file_system/{id}	104
POST /file_system/{id}/clone	105
POST /file_system/{id}/snapshot	105
POST /file_system/{id}/refresh	106
POST /file_system/{id}/restore	107
POST /file_system/{id}/refresh_quota	108
file_tree_quota	108
GET /file_tree_quota	108
POST /file_tree_quota	109
GET /file_tree_quota/{id}	109
DELETE /file_tree_quota/{id}	110
PATCH /file_tree_quota/{id}	110
POST /file_tree_quota/{id}/refresh	111
file_user_quota	112
GET /file_user_quota	112
POST /file_user_quota	112
GET /file_user_quota/{id}	113
PATCH /file_user_quota/{id}	113
POST /file_user_quota/{id}/refresh	114
file_virus_checker	114
GET /file_virus_checker	115
POST /file_virus_checker	115
GET /file_virus_checker/{id}	116
DELETE /file_virus_checker/{id}	116
PATCH /file_virus_checker/{id}	117
POST /file_virus_checker/{id}/upload_config	117
GET /file_virus_checker/{id}/download_config	118
hardware	119
GET /hardware	119
GET /hardware/{id}	119
PATCH /hardware/{id}	120
POST /hardware/{id}/drive_repurpose	121
host	121
GET /host	121
POST /host	122
GET /host/{id}	123
DELETE /host/{id}	123
PATCH /host/{id}	124
POST /host/{id}/attach	125
POST /host/{id}/detach	125
host_group	126
GET /host_group	126
POST /host_group	127
GET /host_group/{id}	127
DELETE /host_group/{id}	128
PATCH /host_group/{id}	129
POST /host_group/{id}/attach	129
POST /host_group/{id}/detach	130
host_virtual_volume_mapping	131
GET /host_virtual_volume_mapping	131
GET /host_virtual_volume_mapping/{id}	131
host_volume_mapping	132
GET /host_volume_mapping	132
GET /host_volume_mapping/{id}	132
import_host_initiator	133
GET /import_host_initiator	133
GET /import_host_initiator/{id}	134
import_host_system	134
GET /import_host_system	134
POST /import_host_system	135
GET /import_host_system/{id}	135
DELETE /import_host_system/{id}	136
POST /import_host_system/{id}/refresh	136
import_host_volume	137
GET /import_host_volume	137
GET /import_host_volume/{id}	138
import_psgroup	138
GET /import_psgroup	138
GET /import_psgroup/{id}	139
POST /import_psgroup/{id}/discover	139
import_psgroup_volume	140
GET /import_psgroup_volume	140
GET /import_psgroup_volume/{id}	140
POST /import_psgroup_volume/{id}/import_snapshot_schedules	141
import_session	142
GET /import_session	142
POST /import_session	142
GET /import_session/{id}	143
DELETE /import_session/{id}	143
PATCH /import_session/{id}	144
POST /import_session/{id}/cutover	145
POST /import_session/{id}/cancel	145
POST /import_session/{id}/pause	146
POST /import_session/{id}/resume	147
POST /import_session/{id}/enable_destination_volume	147
POST /import_session/{id}/start_copy	148
POST /import_session/{id}/cleanup	149
import_storage_center	149
GET /import_storage_center	149
GET /import_storage_center/{id}	150
POST /import_storage_center/{id}/discover	150
import_storage_center_consistency_group	151
GET /import_storage_center_consistency_group	151
GET /import_storage_center_consistency_group/{id}	152
POST /import_storage_center_consistency_group/{id}/import_snapshot_profiles	152
import_storage_center_volume	153
GET /import_storage_center_volume	153
GET /import_storage_center_volume/{id}	153
POST /import_storage_center_volume/{id}/import_snapshot_profiles	154
import_unity	155
GET /import_unity	155
GET /import_unity/{id}	155
POST /import_unity/{id}/discover	156
import_unity_consistency_group	156
GET /import_unity_consistency_group	156
GET /import_unity_consistency_group/{id}	157
POST /import_unity_consistency_group/{id}/import_snapshot_schedules	157
import_unity_volume	158
GET /import_unity_volume	158
GET /import_unity_volume/{id}	159
POST /import_unity_volume/{id}/import_snapshot_schedules	159
import_vnx_array	160
GET /import_vnx_array	160
GET /import_vnx_array/{id}	160
POST /import_vnx_array/{id}/discover	161
import_vnx_consistency_group	161
GET /import_vnx_consistency_group	162
GET /import_vnx_consistency_group/{id}	162
import_vnx_volume	163
GET /import_vnx_volume	163
GET /import_vnx_volume/{id}	163
import_xtremio	164
GET /import_xtremio	164
GET /import_xtremio/{id}	164
POST /import_xtremio/{id}/discover	165
import_xtremio_consistency_group	165
GET /import_xtremio_consistency_group	165
GET /import_xtremio_consistency_group/{id}	166
POST /import_xtremio_consistency_group/{id}/import_snapshot_schedules	166
import_xtremio_volume	167
GET /import_xtremio_volume	167
GET /import_xtremio_volume/{id}	168
POST /import_xtremio_volume/{id}/import_snapshot_schedules	168
ip_pool_address	169
GET /ip_pool_address	169
GET /ip_pool_address/{id}	169
ip_port	170
GET /ip_port	170
GET /ip_port/{id}	170
PATCH /ip_port/{id}	171
job	172
GET /job	172
GET /job/{id}	172
keystore_archive	173
POST /keystore_archive/regenerate	173
GET /keystore_archive/{filename}	174
ldap_account	174
GET /ldap_account	174
POST /ldap_account	175
GET /ldap_account/{id}	175
DELETE /ldap_account/{id}	176
PATCH /ldap_account/{id}	176
ldap_domain	177
GET /ldap_domain	177
POST /ldap_domain	178
GET /ldap_domain/{id}	178
DELETE /ldap_domain/{id}	179
PATCH /ldap_domain/{id}	179
POST /ldap_domain/{id}/verify	180
license	180
GET /license	181
GET /license/{id}	181
POST /license/upload	182
POST /license/retrieve	182
local_user	183
GET /local_user	183
POST /local_user	183
GET /local_user/{id}	184
DELETE /local_user/{id}	184
PATCH /local_user/{id}	185
login_session	186
GET /login_session	186
logout	186
POST /logout	186
maintenance_window	187
GET /maintenance_window	187
GET /maintenance_window/{id}	188
PATCH /maintenance_window/{id}	188
metrics	189
POST /metrics/generate	189
migration_recommendation	189
GET /migration_recommendation	190
POST /migration_recommendation	190
GET /migration_recommendation/{id}	191
DELETE /migration_recommendation/{id}	191
PATCH /migration_recommendation/{id}	192
POST /migration_recommendation/{id}/create_migration_sessions	192
POST /migration_recommendation/{id}/start_migration_sessions	193
migration_session	194
GET /migration_session	194
POST /migration_session	194
GET /migration_session/{id}	195
DELETE /migration_session/{id}	195
POST /migration_session/{id}/pause	196
POST /migration_session/{id}/resume	197
POST /migration_session/{id}/sync	197
POST /migration_session/{id}/cutover	198
nas_server	199
GET /nas_server	199
POST /nas_server	199
GET /nas_server/{id}	200
DELETE /nas_server/{id}	200
PATCH /nas_server/{id}	201
POST /nas_server/{id}/ping	202
POST /nas_server/{id}/upload/passwd	202
GET /nas_server/{id}/download/passwd	203
POST /nas_server/{id}/upload/hosts	204
GET /nas_server/{id}/download/hosts	204
POST /nas_server/{id}/upload/group	205
GET /nas_server/{id}/download/group	206
POST /nas_server/{id}/upload/netgroup	206
GET /nas_server/{id}/download/netgroup	207
POST /nas_server/{id}/upload/nsswitch	207
GET /nas_server/{id}/download/nsswitch	208
POST /nas_server/{id}/upload/homedir	209
GET /nas_server/{id}/download/homedir	210
POST /nas_server/{id}/upload/ntxmap	210
GET /nas_server/{id}/download/ntxmap	211
POST /nas_server/{id}/update_user_mappings	211
GET /nas_server/{id}/download/user_mapping_report	212
network	213
GET /network	213
POST /network	213
GET /network/{id}	214
DELETE /network/{id}	214
PATCH /network/{id}	215
POST /network/{id}/replace	216
POST /network/{id}/scale	216
nfs_export	217
GET /nfs_export	217
POST /nfs_export	218
GET /nfs_export/{id}	218
DELETE /nfs_export/{id}	219
PATCH /nfs_export/{id}	219
nfs_server	220
GET /nfs_server	220
POST /nfs_server	221
GET /nfs_server/{id}	221
DELETE /nfs_server/{id}	222
PATCH /nfs_server/{id}	222
POST /nfs_server/{id}/join	223
POST /nfs_server/{id}/unjoin	224
node	224
GET /node	224
GET /node/{id}	225
ntp	225
GET /ntp	226
GET /ntp/{id}	226
PATCH /ntp/{id}	226
performance_rule	227
GET /performance_rule	227
GET /performance_rule/{id}	228
physical_switch	228
GET /physical_switch	229
POST /physical_switch	229
GET /physical_switch/{id}	229
DELETE /physical_switch/{id}	230
PATCH /physical_switch/{id}	231
policy	231
GET /policy	231
POST /policy	232
GET /policy/{id}	233
DELETE /policy/{id}	233
PATCH /policy/{id}	234
remote_support_contact	234
GET /remote_support_contact	234
GET /remote_support_contact/{id}	235
PATCH /remote_support_contact/{id}	235
remote_syslog_server	236
GET /remote_syslog_server	236
POST /remote_syslog_server	237
GET /remote_syslog_server/{id}	237
DELETE /remote_syslog_server/{id}	238
PATCH /remote_syslog_server/{id}	238
POST /remote_syslog_server/{id}/test	239
remote_system	240
GET /remote_system	240
POST /remote_system	240
GET /remote_system/{id}	241
DELETE /remote_system/{id}	242
PATCH /remote_system/{id}	243
POST /remote_system/{id}/verify	244
replication_rule	244
GET /replication_rule	244
POST /replication_rule	245
GET /replication_rule/{id}	245
DELETE /replication_rule/{id}	246
PATCH /replication_rule/{id}	246
replication_session	247
GET /replication_session	248
GET /replication_session/{id}	248
POST /replication_session/{id}/sync	249
POST /replication_session/{id}/pause	250
POST /replication_session/{id}/resume	251
POST /replication_session/{id}/failover	252
POST /replication_session/{id}/reprotect	254
POST /replication_session/{id}/start_failover_test	254
POST /replication_session/{id}/stop_failover_test	255
role	256
GET /role	256
GET /role/{id}	257
sas_port	257
GET /sas_port	257
GET /sas_port/{id}	258
security_config	258
GET /security_config	258
GET /security_config/{id}	259
PATCH /security_config/{id}	260
service_config	260
GET /service_config	260
GET /service_config/{id}	261
PATCH /service_config/{id}	261
service_user	262
GET /service_user	262
GET /service_user/{id}	263
PATCH /service_user/{id}	263
smb_server	264
GET /smb_server	264
POST /smb_server	265
GET /smb_server/{id}	265
DELETE /smb_server/{id}	266
PATCH /smb_server/{id}	266
POST /smb_server/{id}/join	267
POST /smb_server/{id}/unjoin	268
smb_share	268
GET /smb_share	268
POST /smb_share	269
GET /smb_share/{id}	269
DELETE /smb_share/{id}	270
PATCH /smb_share/{id}	270
smtp_config	271
GET /smtp_config	271
GET /smtp_config/{id}	272
PATCH /smtp_config/{id}	272
POST /smtp_config/{id}/test	273
snapshot_rule	273
GET /snapshot_rule	273
POST /snapshot_rule	274
GET /snapshot_rule/{id}	274
DELETE /snapshot_rule/{id}	275
PATCH /snapshot_rule/{id}	275
snmp_server	276
GET /snmp_server	276
POST /snmp_server	277
GET /snmp_server/{id}	277
DELETE /snmp_server/{id}	278
PATCH /snmp_server/{id}	278
POST /snmp_server/{id}/test	279
software_installed	280
GET /software_installed	280
GET /software_installed/{id}	280
software_package	281
GET /software_package	281
POST /software_package	281
GET /software_package/{id}	282
DELETE /software_package/{id}	282
POST /software_package/{id}/install	283
POST /software_package/{id}/puhc	284
storage_container	285
GET /storage_container	285
POST /storage_container	285
GET /storage_container/{id}	286
DELETE /storage_container/{id}	286
PATCH /storage_container/{id}	287
POST /storage_container/{id}/mount	288