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

Dell PowerStore 9000T EMC PowerStore REST API Developers Guide - Page 346

UnityScheduleTypeEnum, Ok_But, Degraded, Minor, Major, Critical, Non_Recoverable, N_Hours_At_MM

View all Dell PowerStore 9000T manuals

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

Page 346 highlights

Ok The system is operating normally. Ok_But The system is operating normally but there are potential issues. Degraded The system is working, but performance may not be optimum. Minor The system is working, but it has experienced one or more minor failures. Major The system is failing; some or all of its functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately. Critical The system has failed and recovery may not be possible. This condition should be remedied immediately. Non_Recoverable The system has failed and recovery may not be possible. This condition should be remedied immediately. Type : enum (Unknown, Ok, Ok_But, Degraded, Minor, Major, Critical, Non_Recoverable) UnityScheduleTypeEnum Snapshot schedule types. Values are: N_Hours_At_MM Create a snapshot every {interval} hours, at {minutes} past the hour. Supported parameters: interval (required), minutes (optional, default 0). Day_At_HHMM Specify a list of {hour[,...]} when to create a snapshot each day at {minutes} past the hour. Supported parameters: hours (at least one required), minutes (optional). N_Days_At_HHMM Create a snapshot every {interval} days at the time {hours}:{minutes}. Supported Parameters: interval (required), hours (optional, exactly one), minutes (optional). 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) 280

Section	Page
PowerStore_REST_API_Developers_Guide_Introduction	1
Dell EMC PowerStore REST API Developers Guide	3
Additional Resources	5
Overview	6
The PowerStore Management REST API	6
Resource-oriented architecture and REST	6
JSON data exchange format	7
REST request components	8
HTTP request headers	8
URI patterns	8
Request parameters	9
REST requests	12
REST responses	13
Response components	13
HTTP response headers	13
HTTP status codes	13
JSON collection response body	15
JSON instance response body	15
JSON create response body	16
Response with no body	16
JSON job response body	16
Error response	17
JSON encodings	18
JSON base value encodings	18
JSON list encoding	19
Managing a REST API session	20
Connecting and authenticating	20
Obtaining login session information	20
Logging out of the REST API session	21
Querying a resource	22
Pagination	22
Retrieving data for multiple occurrences in a collection	22
Retrieving data for a specified resource instance	23
Specifying the attributes to return in a query response	24
Filtering response data	25
Sorting response data	27
Including data from a related resource type in a query	28
Creating other types of requests	32
Creating a resource instance	32
Modifying a resource instance	33
Deleting a resource instance	34
Performing an instance-level resource-specific action	35
Performing a class-level action	36
Working with asynchronous requests	37
Reference content	40
REST_API_Reference	41
Storage cluster API	41
Table of Contents	42
Resources	67
alert	67
GET /alert	67
GET /alert/{id}	67
PATCH /alert/{id}	68
appliance	68
GET /appliance	68
GET /appliance/{id}	69
PATCH /appliance/{id}	69
POST /appliance/{id}/forecast	70
POST /appliance/{id}/time_to_full	71
audit_event	72
GET /audit_event	72
bond	72
GET /bond	72
GET /bond/{id}	73
chap_config	73
GET /chap_config	74
GET /chap_config/{id}	74
PATCH /chap_config/{id}	75
cluster	75
GET /cluster	75
GET /cluster/{id}	76
PATCH /cluster/{id}	76
POST /cluster/{id}/forecast	77
POST /cluster/{id}/time_to_full	78
discovered_initiator	79
GET /discovered_initiator	79
dns	79
GET /dns	80
GET /dns/{id}	80
PATCH /dns/{id}	81
email_notify_destination	81
GET /email_notify_destination	81
POST /email_notify_destination	82
GET /email_notify_destination/{id}	82
DELETE /email_notify_destination/{id}	83
PATCH /email_notify_destination/{id}	83
POST /email_notify_destination/{id}/test	84
eth_port	85
GET /eth_port	85
GET /eth_port/{id}	85
PATCH /eth_port/{id}	86
event	86
GET /event	86
GET /event/{id}	87
fc_port	87
GET /fc_port	87
GET /fc_port/{id}	88
PATCH /fc_port/{id}	88
file_dns	89
GET /file_dns	89
POST /file_dns	90
GET /file_dns/{id}	90
DELETE /file_dns/{id}	91
PATCH /file_dns/{id}	91
file_ftp	92
GET /file_ftp	92
POST /file_ftp	93
GET /file_ftp/{id}	93
DELETE /file_ftp/{id}	94
PATCH /file_ftp/{id}	94
file_interface	95
GET /file_interface	95
POST /file_interface	95
GET /file_interface/{id}	96
DELETE /file_interface/{id}	96
PATCH /file_interface/{id}	97
file_interface_route	97
GET /file_interface_route	98
POST /file_interface_route	98
GET /file_interface_route/{id}	99
DELETE /file_interface_route/{id}	99
PATCH /file_interface_route/{id}	100
file_kerberos	100
GET /file_kerberos	101
POST /file_kerberos	101
GET /file_kerberos/{id}	102
DELETE /file_kerberos/{id}	102
PATCH /file_kerberos/{id}	103
POST /file_kerberos/{id}/upload_keytab	103
GET /file_kerberos/{id}/download_keytab	104
file_ldap	105
GET /file_ldap	105
POST /file_ldap	105
GET /file_ldap/{id}	106
DELETE /file_ldap/{id}	106
PATCH /file_ldap/{id}	107
POST /file_ldap/{id}/upload_config	107
GET /file_ldap/{id}/download_config	108
POST /file_ldap/{id}/upload_certificate	109
GET /file_ldap/{id}/download_certificate	109
file_ndmp	110
GET /file_ndmp	110
POST /file_ndmp	110
GET /file_ndmp/{id}	111
DELETE /file_ndmp/{id}	111
PATCH /file_ndmp/{id}	112
file_nis	113
GET /file_nis	113
POST /file_nis	113
GET /file_nis/{id}	114
DELETE /file_nis/{id}	114
PATCH /file_nis/{id}	115
file_system	115
GET /file_system	115
POST /file_system	116
GET /file_system/{id}	116
DELETE /file_system/{id}	117
PATCH /file_system/{id}	117
POST /file_system/{id}/clone	118
POST /file_system/{id}/snapshot	119
POST /file_system/{id}/refresh	119
POST /file_system/{id}/restore	120
POST /file_system/{id}/refresh_quota	121
file_tree_quota	121
GET /file_tree_quota	122
POST /file_tree_quota	122
GET /file_tree_quota/{id}	122
DELETE /file_tree_quota/{id}	123
PATCH /file_tree_quota/{id}	123
POST /file_tree_quota/{id}/refresh	124
file_user_quota	125
GET /file_user_quota	125
POST /file_user_quota	125
GET /file_user_quota/{id}	126
PATCH /file_user_quota/{id}	126
POST /file_user_quota/{id}/refresh	127
file_virus_checker	127
GET /file_virus_checker	128
POST /file_virus_checker	128
GET /file_virus_checker/{id}	129
DELETE /file_virus_checker/{id}	129
PATCH /file_virus_checker/{id}	130
POST /file_virus_checker/{id}/upload_config	130
GET /file_virus_checker/{id}/download_config	131
hardware	132
GET /hardware	132
GET /hardware/{id}	132
PATCH /hardware/{id}	133
POST /hardware/{id}/drive_repurpose	134
host	134
GET /host	134
POST /host	135
GET /host/{id}	136
DELETE /host/{id}	136
PATCH /host/{id}	137
POST /host/{id}/attach	138
POST /host/{id}/detach	138
host_group	139
GET /host_group	139
POST /host_group	140
GET /host_group/{id}	140
DELETE /host_group/{id}	141
PATCH /host_group/{id}	141
POST /host_group/{id}/attach	142
POST /host_group/{id}/detach	143
host_virtual_volume_mapping	144
GET /host_virtual_volume_mapping	144
GET /host_virtual_volume_mapping/{id}	144
host_volume_mapping	145
GET /host_volume_mapping	145
GET /host_volume_mapping/{id}	145
import_host_initiator	146
GET /import_host_initiator	146
GET /import_host_initiator/{id}	146
import_host_system	147
GET /import_host_system	147
POST /import_host_system	147
GET /import_host_system/{id}	148
DELETE /import_host_system/{id}	148
POST /import_host_system/{id}/refresh	149
import_host_volume	150
GET /import_host_volume	150
GET /import_host_volume/{id}	150
import_psgroup	151
GET /import_psgroup	151
GET /import_psgroup/{id}	151
POST /import_psgroup/{id}/discover	152
import_psgroup_volume	152
GET /import_psgroup_volume	152
GET /import_psgroup_volume/{id}	153
POST /import_psgroup_volume/{id}/import_snapshot_schedules	153
import_session	154
GET /import_session	154
POST /import_session	155
GET /import_session/{id}	155
DELETE /import_session/{id}	156
PATCH /import_session/{id}	156
POST /import_session/{id}/cutover	157
POST /import_session/{id}/cancel	158
POST /import_session/{id}/pause	158
POST /import_session/{id}/resume	159
POST /import_session/{id}/cleanup	160
import_storage_center	160
GET /import_storage_center	160
GET /import_storage_center/{id}	161
POST /import_storage_center/{id}/discover	161
import_storage_center_consistency_group	162
GET /import_storage_center_consistency_group	162
GET /import_storage_center_consistency_group/{id}	163
POST /import_storage_center_consistency_group/{id}/import_snapshot_profiles	163
import_storage_center_volume	164
GET /import_storage_center_volume	164
GET /import_storage_center_volume/{id}	164
POST /import_storage_center_volume/{id}/import_snapshot_profiles	165
import_unity	166
GET /import_unity	166
GET /import_unity/{id}	166
POST /import_unity/{id}/discover	167
import_unity_consistency_group	167
GET /import_unity_consistency_group	167
GET /import_unity_consistency_group/{id}	168
POST /import_unity_consistency_group/{id}/import_snapshot_schedules	168
import_unity_volume	169
GET /import_unity_volume	169
GET /import_unity_volume/{id}	169
POST /import_unity_volume/{id}/import_snapshot_schedules	170
import_vnx_array	171
GET /import_vnx_array	171
GET /import_vnx_array/{id}	171
POST /import_vnx_array/{id}/discover	172
import_vnx_consistency_group	172
GET /import_vnx_consistency_group	172
GET /import_vnx_consistency_group/{id}	173
import_vnx_volume	173
GET /import_vnx_volume	173
GET /import_vnx_volume/{id}	174
ip_pool_address	174
GET /ip_pool_address	174
GET /ip_pool_address/{id}	175
ip_port	175
GET /ip_port	176
GET /ip_port/{id}	176
PATCH /ip_port/{id}	177
job	177
GET /job	177
GET /job/{id}	178
keystore_archive	178
POST /keystore_archive/regenerate	178
GET /keystore_archive/{filename}	179
license	180
GET /license	180
GET /license/{id}	180
POST /license/upload	181
POST /license/retrieve	181
local_user	182
GET /local_user	182
POST /local_user	182
GET /local_user/{id}	183
DELETE /local_user/{id}	183
PATCH /local_user/{id}	184
login_session	185
GET /login_session	185
logout	185
POST /logout	185
maintenance_window	186
GET /maintenance_window	186
GET /maintenance_window/{id}	187
PATCH /maintenance_window/{id}	187
metrics	188
POST /metrics/generate	188
migration_recommendation	188
GET /migration_recommendation	189
POST /migration_recommendation	189
GET /migration_recommendation/{id}	190
DELETE /migration_recommendation/{id}	190
POST /migration_recommendation/{id}/create_migration_sessions	191
POST /migration_recommendation/{id}/start_migration_sessions	191
migration_session	192
GET /migration_session	192
POST /migration_session	192
GET /migration_session/{id}	193
DELETE /migration_session/{id}	194
POST /migration_session/{id}/pause	194
POST /migration_session/{id}/resume	195
POST /migration_session/{id}/sync	195
POST /migration_session/{id}/cutover	196
nas_server	197
GET /nas_server	197
POST /nas_server	197
GET /nas_server/{id}	198
DELETE /nas_server/{id}	198
PATCH /nas_server/{id}	199
POST /nas_server/{id}/ping	199
POST /nas_server/{id}/upload/passwd	200
GET /nas_server/{id}/download/passwd	201
POST /nas_server/{id}/upload/hosts	201
GET /nas_server/{id}/download/hosts	202
POST /nas_server/{id}/upload/group	203
GET /nas_server/{id}/download/group	203
POST /nas_server/{id}/upload/netgroup	204
GET /nas_server/{id}/download/netgroup	205
POST /nas_server/{id}/upload/nsswitch	205
GET /nas_server/{id}/download/nsswitch	206
POST /nas_server/{id}/upload/homedir	207
GET /nas_server/{id}/download/homedir	207
POST /nas_server/{id}/upload/ntxmap	208
GET /nas_server/{id}/download/ntxmap	209
POST /nas_server/{id}/update_user_mappings	209
GET /nas_server/{id}/download/user_mapping_report	210
network	210
GET /network	211
GET /network/{id}	211
PATCH /network/{id}	212
POST /network/{id}/replace	212
POST /network/{id}/scale	213
nfs_export	214
GET /nfs_export	214
POST /nfs_export	214
GET /nfs_export/{id}	215
DELETE /nfs_export/{id}	215
PATCH /nfs_export/{id}	216
nfs_server	217
GET /nfs_server	217
POST /nfs_server	217
GET /nfs_server/{id}	218
DELETE /nfs_server/{id}	218
PATCH /nfs_server/{id}	219
POST /nfs_server/{id}/join	219
POST /nfs_server/{id}/unjoin	220
node	221
GET /node	221
GET /node/{id}	221
ntp	222
GET /ntp	222
GET /ntp/{id}	222
PATCH /ntp/{id}	223
performance_rule	224
GET /performance_rule	224
GET /performance_rule/{id}	224
physical_switch	225
GET /physical_switch	225
POST /physical_switch	225
GET /physical_switch/{id}	226
DELETE /physical_switch/{id}	226
PATCH /physical_switch/{id}	227
policy	227
GET /policy	228
POST /policy	228
GET /policy/{id}	229
DELETE /policy/{id}	229
PATCH /policy/{id}	230
remote_system	230
GET /remote_system	231
POST /remote_system	231
GET /remote_system/{id}	232
DELETE /remote_system/{id}	233
PATCH /remote_system/{id}	233
POST /remote_system/{id}/verify	234
replication_rule	235
GET /replication_rule	235
POST /replication_rule	236
GET /replication_rule/{id}	236
DELETE /replication_rule/{id}	237
PATCH /replication_rule/{id}	237
replication_session	238
GET /replication_session	239
GET /replication_session/{id}	239
POST /replication_session/{id}/sync	240
POST /replication_session/{id}/pause	241
POST /replication_session/{id}/resume	242
POST /replication_session/{id}/failover	243
POST /replication_session/{id}/reprotect	244
role	245
GET /role	245
GET /role/{id}	246
sas_port	246
GET /sas_port	246
GET /sas_port/{id}	247
security_config	247
GET /security_config	247
GET /security_config/{id}	248
service_config	248
GET /service_config	248
GET /service_config/{id}	249
PATCH /service_config/{id}	249
service_user	250
GET /service_user	250
GET /service_user/{id}	251
PATCH /service_user/{id}	251
smb_server	252
GET /smb_server	252
POST /smb_server	253
GET /smb_server/{id}	253
DELETE /smb_server/{id}	254
PATCH /smb_server/{id}	254
POST /smb_server/{id}/join	255
POST /smb_server/{id}/unjoin	256
smb_share	256
GET /smb_share	256
POST /smb_share	257
GET /smb_share/{id}	257
DELETE /smb_share/{id}	258
PATCH /smb_share/{id}	258
smtp_config	259
GET /smtp_config	259
GET /smtp_config/{id}	260
PATCH /smtp_config/{id}	260
POST /smtp_config/{id}/test	261
snapshot_rule	261
GET /snapshot_rule	261
POST /snapshot_rule	262
GET /snapshot_rule/{id}	262
DELETE /snapshot_rule/{id}	263
PATCH /snapshot_rule/{id}	263
software_installed	264
GET /software_installed	264
GET /software_installed/{id}	265
software_package	265
GET /software_package	265
POST /software_package	266
GET /software_package/{id}	266
DELETE /software_package/{id}	267
POST /software_package/{id}/install	268
POST /software_package/{id}/puhc	269
storage_container	269
GET /storage_container	269
POST /storage_container	270
GET /storage_container/{id}	270
DELETE /storage_container/{id}	271
PATCH /storage_container/{id}	272
POST /storage_container/{id}/mount	272
POST /storage_container/{id}/unmount	273
vcenter	274
GET /vcenter	274
POST /vcenter	274
GET /vcenter/{id}	275
DELETE /vcenter/{id}	275
PATCH /vcenter/{id}	276
veth_port	276
GET /veth_port	277
GET /veth_port/{id}	277
virtual_machine	278
GET /virtual_machine	278
GET /virtual_machine/{id}	278
DELETE /virtual_machine/{id}	279
PATCH /virtual_machine/{id}	279
POST /virtual_machine/{id}/snapshot	280
virtual_volume	280
GET /virtual_volume	281
GET /virtual_volume/{id}	281
DELETE /virtual_volume/{id}	281
volume	282
GET /volume	282
POST /volume	282
GET /volume/{id}	283
DELETE /volume/{id}	283
PATCH /volume/{id}	284
POST /volume/{id}/snapshot	285
POST /volume/{id}/clone	285
POST /volume/{id}/refresh	286

Match case Limit results 1 per page

The system is operating normally.

Ok_But

The system is operating normally but there are potential issues.

Degraded

The system is working, but performance may not be optimum.

Minor

The system is working, but it has experienced one or more minor failures.

Major

The system is failing; some or all of its functions may be degraded or not working. This condition

has a significant impact on the system and should be remedied immediately.

Critical

The system has failed and recovery may not be possible. This condition should be remedied

immediately.

Non_Recoverable

The system has failed and recovery may not be possible. This condition should be remedied

immediately.

Type

: enum (Unknown, Ok, Ok_But, Degraded, Minor, Major, Critical, Non_Recoverable)

UnityScheduleTypeEnum

Snapshot schedule types. Values are:

N_Hours_At_MM

Create a snapshot every {interval} hours, at {minutes} past the hour. Supported parameters:

interval (required), minutes (optional, default 0).

Day_At_HHMM

Specify a list of {hour[,…]} when to create a snapshot each day at {minutes} past the hour.

Supported parameters: hours (at least one required), minutes (optional).

N_Days_At_HHMM

Create a snapshot every {interval} days at the time {hours}:{minutes}. Supported Parameters:

interval (required), hours (optional, exactly one), minutes (optional).

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)

280