bimbly 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1532 @@
1
+ NsSchedule:
2
+ Desc: Protection schedule associated with a volume collection or protection template.
3
+ Type: object
4
+ Members:
5
+ id:
6
+ Desc: ID of protection schedule.
7
+ Type: NsObjectID
8
+ schedule_id:
9
+ Desc: ID of protection schedule.
10
+ Type: NsObjectID
11
+ Depricated: Yes
12
+ name:
13
+ Desc: Name of protection schedule.
14
+ Type: NsObjectName
15
+ schedule_name:
16
+ Desc: Name of protection schedule.
17
+ Type: NsObjectName
18
+ Depricated: Yes
19
+ period:
20
+ Desc: Frequency of snapshots.
21
+ Type: NsUnsignedLong
22
+ period_unit:
23
+ Desc: Units for repeat frequency -- minutes, hours, days or weeks.
24
+ Type: NsPeriodUnit
25
+ at_time:
26
+ Desc: Time of day when snapshot should be taken.
27
+ Type: NsTimeOfDay
28
+ until_time:
29
+ Desc: Time of day to stop taking snapshots.
30
+ Type: NsTimeOfDay
31
+ days:
32
+ Desc: Which days snapshots should be taken.
33
+ Type: NsDays
34
+ num_retain:
35
+ Desc: Number of snapshots to retain.
36
+ Type: NsUnsignedLong
37
+ downstream_partner:
38
+ Desc: Partner name if snapshots created by this schedule should be replicated.
39
+ Type: NsObjectName
40
+ Depricated: Yes
41
+ downstream_partner_id:
42
+ Desc: Partner ID if snapshots created by this schedule should be replicated.
43
+ Type: NsObjectID
44
+ downstream_partner_name:
45
+ Desc: Partner name if snapshots created by this schedule should be replicated.
46
+ Type: NsObjectName
47
+ replicate_every:
48
+ Desc: Which snapshots should be replicated.
49
+ Type: NsUnsignedLong
50
+ num_retain_replica:
51
+ Desc: Number of snapshots to retain on the replica.
52
+ Type: NsUnsignedLong
53
+ repl_alert_thres:
54
+ Desc: Replication alert threshold.
55
+ Type: NsTime
56
+ snap_verify:
57
+ Desc: Run verification tool on snapshot created by this schedule.
58
+ Type: NsBoolean
59
+ skip_db_consistency_check:
60
+ Desc: Skip consistency check for database files on snapshots created by this schedule.
61
+ Type: NsBoolean
62
+ disable_appsync:
63
+ Desc: Disables application synchronized snapshots and creates crash consistent snapshots instead.
64
+ Type: NsBoolean
65
+ schedule_type:
66
+ Desc: Schedule type regular or external_trigger.
67
+ Type: NsScheduleType
68
+ NsFcInterfaceUpdateInfo:
69
+ Desc: Fibre Channel interface information to update.
70
+ Type: object
71
+ Members:
72
+ id:
73
+ Desc: ID of Fibre Channel interface.
74
+ Type: NsObjectID
75
+ online:
76
+ Desc: Identify whether the Fibre Channel interface is online.
77
+ Type: NsBoolean
78
+ NsDomainName:
79
+ Desc: Domain name for the Active Directory. Example 'abc.corp'.
80
+ Type: string
81
+ NsISCSIInitiators:
82
+ Desc: List of iSCSI initiators.
83
+ Type: Array Of NsISCSIInitiator
84
+ NsNIC:
85
+ Desc: Network interface controller.
86
+ Type: object
87
+ Members:
88
+ name:
89
+ Desc: Name of NIC.
90
+ Type: NsObjectName
91
+ subnet_label:
92
+ Desc: Subnet label for this NIC.
93
+ Type: NsObjectName
94
+ data_ip:
95
+ Desc: Data IP address.
96
+ Type: NsIPAddress
97
+ tagged:
98
+ Desc: Identify whether the NIC is tagged.
99
+ Type: NsBoolean
100
+ NsFCInitiators:
101
+ Desc: List of Fibre Channel initiators.
102
+ Type: Array Of NsFCInitiator
103
+ NsAccessControlRecords:
104
+ Desc: List of access control records associated with a volume or snapshot or protocol endpoint.
105
+ Type: Array Of NsAccessControlRecord
106
+ NsNetZoneType:
107
+ Desc: Possible values 'none', 'evenodd', 'bisect', 'single'.
108
+ Type: string
109
+ NsStatIdComp:
110
+ Desc: Domain_id and set_id components of stat name. String of up to 64 alphanumberic characters. Undercore and hyphen are allowed. For example "ds".
111
+ Type: string
112
+ NsArrayFcConfig:
113
+ Desc: Array Fibre Channel configuration.
114
+ Type: object
115
+ Members:
116
+ name:
117
+ Desc: Name of the array.
118
+ Type: NsObjectName
119
+ array_name:
120
+ Desc: Name of the array.
121
+ Type: NsObjectName
122
+ Depricated: Yes
123
+ id:
124
+ Desc: ID of the array.
125
+ Type: NsObjectID
126
+ array_id:
127
+ Desc: ID of the array.
128
+ Type: NsObjectID
129
+ Depricated: Yes
130
+ ctrlr_a_fc_config:
131
+ Desc: Controller A Fibre Channel configuration.
132
+ Type: NsCtrlrFcConfig
133
+ ctrlr_b_fc_config:
134
+ Desc: Controller B Fibre Channel configuration.
135
+ Type: NsCtrlrFcConfig
136
+ NsObjectIDKVList:
137
+ Desc: A list of key value pairs containing object ids as values.
138
+ Type: Array Of NsObjectIDKV
139
+ NsScope:
140
+ Desc: Possible values array serial number, or '-'. Example 'AC-109084'.
141
+ Type: string
142
+ NsPinnedVolumeInfo:
143
+ Desc: Select fields containing pinned volume info.
144
+ Type: object
145
+ Members:
146
+ id:
147
+ Desc: ID of volume.
148
+ Type: NsObjectID
149
+ name:
150
+ Desc: Name of volume.
151
+ Type: NsVolSnapName
152
+ size_pinned_cache_bytes:
153
+ Desc: Total pinned cache size of the volume in bytes.
154
+ Type: NsBytes
155
+ NsAccessApplyTo:
156
+ Desc: Possible values 'volume', 'snapshot', 'both', 'pe', 'vvol_volume', 'vvol_snapshot'.
157
+ Type: string
158
+ NsAsciiString255:
159
+ Desc: String of printable ASCII characters, maximum length 255.
160
+ Type: string
161
+ NsFcInterfaceList:
162
+ Desc: List of Fibre Channel interfaces.
163
+ Type: Array Of NsFcInterfaceInfo
164
+ NsObjectIDKV:
165
+ Desc: A key value pair containing an object id as a value.
166
+ Type: object
167
+ Members:
168
+ key:
169
+ Desc: Identifier of key-value pair.
170
+ Type: NsString
171
+ id:
172
+ Desc: An object id.
173
+ Type: NsObjectID
174
+ NsTargetSubnets:
175
+ Desc: List of target subnet tables.
176
+ Type: Array Of NsTargetSubnet
177
+ NsRouteConfigs:
178
+ Desc: List of route configs.
179
+ Type: Array Of NsRoute
180
+ NsNetConfigRole:
181
+ Desc: Possible values 'active', 'backup', 'draft'.
182
+ Type: string
183
+ NsPrivilegeList:
184
+ Desc: List of privileges associated with a role.
185
+ Type: Array Of NsPrivilege
186
+ NsArraySerialNumber:
187
+ Desc: Example 'AC-109084'.
188
+ Type: string
189
+ NsEventType:
190
+ Desc: Non-negative integer in range [0,2147483647].
191
+ Type: number
192
+ NsADTestUserReturn:
193
+ Desc: Active Directory user details.
194
+ Type: object
195
+ Members:
196
+ username:
197
+ Desc: Name of the Active Directory user.
198
+ Type: NsString
199
+ primary_group_name:
200
+ Desc: Name of the Active Directory group the user belongs to. RBAC is based on this primary group.
201
+ Type: NsGroupName
202
+ primary_group_id:
203
+ Desc: Id of the Active Directory group the user belongs to. RBAC is based on this primary group.
204
+ Type: NsObjectID
205
+ group_count:
206
+ Desc: Number of Active Directory groups the user belongs to.
207
+ Type: NsUnsignedLong
208
+ groups:
209
+ Desc: List of Active Directory groups the user belongs to.
210
+ Type: NsUserGroupNames
211
+ role:
212
+ Desc: The role the user belongs to.
213
+ Type: NsUserRoles
214
+ NsSnapVolListReturn:
215
+ Desc: Object returned after creating snapshot collection.
216
+ Type: object
217
+ Members:
218
+ snap_ids:
219
+ Desc: A list of snapshot ids.
220
+ Type: NsObjectIDKVList
221
+ NsPlatFcOperationalStatus:
222
+ Desc: Possible values 'plat_fc_operational_status_unknown', 'plat_fc_operational_status_unconfigured', 'plat_fc_operational_status_configured', 'plat_fc_operational_status_operational', 'plat_fc_operational_status_fault', 'plat_fc_operational_status_admin_offline', plat_fc_operational_status_initializing.
223
+ Type: string
224
+ NsVolSnapName:
225
+ Desc: String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.
226
+ Type: string
227
+ NsPlatFcLinkStatus:
228
+ Desc: Possible values 'plat_fc_link_status_unknown', 'plat_fc_link_status_down', 'plat_fc_link_status_up', 'plat_fc_link_status_not_connected', 'plat_fc_link_status_error'.
229
+ Type: string
230
+ NsCRUDOperations:
231
+ Desc: List of CRUD (Create, Read, Update, Delete) operations associated with an object.
232
+ Type: Array Of NsCRUDOperation
233
+ NsArrayNetConfigs:
234
+ Desc: List of array network configs.
235
+ Type: Array Of NsArrayNet
236
+ NsFcLinkInfo:
237
+ Desc: Fibre Channel link information.
238
+ Type: object
239
+ Members:
240
+ link_speed:
241
+ Desc: Speed of the Fibre Channel link.
242
+ Type: NsPlatFcLinkSpeed
243
+ max_link_speed:
244
+ Desc: Maximum speed of the Fibre Channel link.
245
+ Type: NsPlatFcLinkSpeed
246
+ link_status:
247
+ Desc: Status of the Fibre Channel link.
248
+ Type: NsPlatFcLinkStatus
249
+ operational_status:
250
+ Desc: Operational status of the Fibre Channel link.
251
+ Type: NsPlatFcOperationalStatus
252
+ NsStatsSensor:
253
+ Desc: Data for one stat sensor.
254
+ Type: object
255
+ Members:
256
+ name:
257
+ Desc: Name sensor.
258
+ Type: NsString
259
+ index:
260
+ Desc: Index of sensor in stat for versioning.
261
+ Type: NsUnsignedLong
262
+ msec:
263
+ Desc: Creation time of stat sensor in millisecs.
264
+ Type: NsUnsignedLong
265
+ prev_unavail:
266
+ Desc: Previous stat value is not valid.
267
+ Type: NsBoolean
268
+ cur_unavail:
269
+ Desc: Current stat value is not valid.
270
+ Type: NsBoolean
271
+ cur:
272
+ Desc: Current stat value.
273
+ Type: NsUnsignedLong
274
+ prev:
275
+ Desc: Previous stat value from last sample period.
276
+ Type: NsUnsignedLong
277
+ NsFcFabricInfo:
278
+ Desc: Fibre Channel fabric information.
279
+ Type: object
280
+ Members:
281
+ fabric_switch_name:
282
+ Desc: Name of the Fibre Channel switch.
283
+ Type: NsAsciiString255
284
+ fabric_switch_port:
285
+ Desc: Port on the Fibre Channel switch to which connection is established.
286
+ Type: NsAsciiString16
287
+ fabric_switch_wwnn:
288
+ Desc: WWNN (World Wide Node Name) for the connected port on the fabric switch.
289
+ Type: NsWWN
290
+ fabric_switch_wwpn:
291
+ Desc: WWPN (World Wide Port Name) for the connected port on the fabric switch.
292
+ Type: NsWWN
293
+ fabric_wwn:
294
+ Desc: WWNN(World Wide Node Name) for the Fabric Switch.
295
+ Type: NsWWN
296
+ fc_id:
297
+ Desc: FCID assigned to the Fabric Channel fabric port.
298
+ Type: NsFcId
299
+ logged_in:
300
+ Desc: Login information for interface. True if interface has logged in to the Fibre Channel fabric, else false.
301
+ Type: NsBoolean
302
+ NsArraySummaryList:
303
+ Desc: List of arrays' information. Each item contains array_name and array_id for the array name and its ID respectively.
304
+ Type: Array Of NsArraySummary
305
+ NsFlexiblePassword:
306
+ Desc: A password with few constraints. A string of up to 255 characters. Example 'password_25-24'.
307
+ Type: string
308
+ NsTargetName:
309
+ Desc: The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target.
310
+ Type: string
311
+ NsArraySummary:
312
+ Desc: Array summary information.
313
+ Type: object
314
+ Members:
315
+ id:
316
+ Desc: Array API ID.
317
+ Type: NsObjectID
318
+ array_id:
319
+ Desc: Array API ID.
320
+ Type: NsObjectID
321
+ Depricated: Yes
322
+ name:
323
+ Desc: Unique name of array.
324
+ Type: NsObjectName
325
+ array_name:
326
+ Desc: Unique name of array.
327
+ Type: NsObjectName
328
+ Depricated: Yes
329
+ NsStatsSensors:
330
+ Desc: Set of stat sensors for this record.
331
+ Type: Array Of NsStatsSensor
332
+ NsSubnet:
333
+ Desc: A subnet configuration.
334
+ Type: object
335
+ Members:
336
+ label:
337
+ Desc: Subnet label.
338
+ Type: NsObjectName
339
+ network:
340
+ Desc: Network IP address.
341
+ Type: NsIPAddress
342
+ netmask:
343
+ Desc: Subnet netmask address.
344
+ Type: NsIPNetmask
345
+ netzone_type:
346
+ Desc: Netzone type.
347
+ Type: NsNetZoneType
348
+ type:
349
+ Desc: Subnet type.
350
+ Type: NsSubnetType
351
+ allow_iscsi:
352
+ Desc: Allow iSCSI.
353
+ Type: NsBoolean
354
+ allow_group:
355
+ Desc: Allow group.
356
+ Type: NsBoolean
357
+ discovery_ip:
358
+ Desc: Discovery IP.
359
+ Type: NsIPAddress
360
+ mtu:
361
+ Desc: MTU for specified subnet.
362
+ Type: NsMTU
363
+ vlan_id:
364
+ Desc: VLAN ID for specified subnet.
365
+ Type: NsVlanId
366
+ NsSnapcollSummary:
367
+ Desc: Select fields containing snapshot collection information.
368
+ Type: object
369
+ Members:
370
+ snapcoll_id:
371
+ Desc: ID of snapshot collection.
372
+ Type: NsObjectID
373
+ snapcoll_name:
374
+ Desc: Name of snapshot collection.
375
+ Type: NsVolSnapName
376
+ snapcoll_creation_time:
377
+ Desc: Creation time of snapshot collection.
378
+ Type: NsTime
379
+ NsAuditLogAccessType:
380
+ Desc: Possible values 'GUI', 'CLI', 'API'.
381
+ Type: string
382
+ NsIPNetmask:
383
+ Desc: A netmask expressed as a 32 bit binary value must have the highest bit set (2^31) and the lowest bit clear (2^0) with the first zero followed by only zeros. Example '255.255.255.0'.
384
+ Type: string
385
+ NsSpacePolicy:
386
+ Desc: Possible values 'invalid', 'offline', 'non_writable', 'read_only', 'login_only'.
387
+ Type: string
388
+ NsPrivilege:
389
+ Desc: Privilege info.
390
+ Type: object
391
+ Members:
392
+ object_type:
393
+ Desc: Object type name associated with this privilege.
394
+ Type: NsString
395
+ operations:
396
+ Desc: List of operations associated with the above object for this privilege.
397
+ Type: NsCRUDOperations
398
+ NsStatsResponse:
399
+ Desc: List of stats records.
400
+ Type: Array Of NsStatsRecord
401
+ NsEmail:
402
+ Desc: Case insensitive email address. Example bob@wikipedia.com.
403
+ Type: string
404
+ SmFcInitiatorAliasSource:
405
+ Desc: Possible values 'invalid', 'user', 'fabric'.
406
+ Type: string
407
+ NsSensorList:
408
+ Desc: Comma separated list of up to 64 stat sensor names. Sensor names are non-empty alphanumeric strings without spaces. The underscore '_' is allowed. Example 'reads,scratch_slosh_cur,schedCpuQueueSizeSysHiPrio'.
409
+ Type: string
410
+ NsBoolean:
411
+ Desc: Possible values 'true', 'false'.
412
+ Type: boolean
413
+ NsOperationType:
414
+ Desc: Possible values 'edit_vol', 'snap_vol', 'edit_snap', 'add_vol_acl', 'remove_vol_acl', 'create_initiator_grp', 'delete_initiator_grp', 'edit_initiator_grp', 'add_fc_vol_acl', 'add_initiator', 'remove_initiator'.
415
+ Type: string
416
+ NsFCInitiator:
417
+ Desc: Fibre Channel initiator.
418
+ Type: object
419
+ Members:
420
+ id:
421
+ Desc: Unique identifier of the Fibre Channel initiator.
422
+ Type: NsObjectID
423
+ initiator_id:
424
+ Desc: Unique identifier of the Fibre Channel initiator.
425
+ Type: NsObjectID
426
+ Depricated: Yes
427
+ alias:
428
+ Desc: Alias of the Fibre Channel initiator.
429
+ Type: NsInitiatorAlias
430
+ wwpn:
431
+ Desc: WWPN (World Wide Port Name) of the Fibre Channel initiator.
432
+ Type: NsWWN
433
+ NsThrottles:
434
+ Desc: All the throttles for the partner.
435
+ Type: Array Of NsThrottle
436
+ NsPlatNicType:
437
+ Desc: Possible values 'nic_type_unknown', 'nic_type_tp', 'nic_type_sfp'.
438
+ Type: string
439
+ NsFcPortInfo:
440
+ Desc: Fibre Channel port information.
441
+ Type: object
442
+ Members:
443
+ name:
444
+ Desc: Name of Fibre Channel port.
445
+ Type: NsObjectName
446
+ bus_location:
447
+ Desc: PCI bus location of the HBA for this Fibre Channel port.
448
+ Type: NsBusLocation
449
+ port:
450
+ Desc: HBA port number for this Fibre Channel port.
451
+ Type: NsPlatPort
452
+ slot:
453
+ Desc: HBA slot number for this Fibre Channel port.
454
+ Type: NsPlatSlot
455
+ NsArrayDetail:
456
+ Desc: Detailed array information.
457
+ Type: object
458
+ Members:
459
+ id:
460
+ Desc: Array API ID.
461
+ Type: NsObjectID
462
+ array_id:
463
+ Desc: Array API ID.
464
+ Type: NsObjectID
465
+ Depricated: Yes
466
+ name:
467
+ Desc: Unique name of array.
468
+ Type: NsObjectName
469
+ array_name:
470
+ Desc: Unique name of array.
471
+ Type: NsObjectName
472
+ Depricated: Yes
473
+ evac_time:
474
+ Desc: Start time of array evacuation.
475
+ Type: NsTime
476
+ evac_usage:
477
+ Desc: Initial data in the array.
478
+ Type: NsBytes
479
+ usable_capacity:
480
+ Desc: Usable capacity of the array.
481
+ Type: NsBytes
482
+ usage:
483
+ Desc: Usage of the array.
484
+ Type: NsBytes
485
+ vol_usage_compressed_bytes:
486
+ Desc: Usage of volumes in the array.
487
+ Type: NsBytes
488
+ snap_usage_compressed_bytes:
489
+ Desc: Usage of snapshots in the array.
490
+ Type: NsBytes
491
+ usage_valid:
492
+ Desc: Indicate whether usage of the array is valid.
493
+ Type: NsBoolean
494
+ migrate:
495
+ Desc: Migrate status of array.
496
+ Type: NsPoolMigrate
497
+ NsSnapshotListFromSnapshotCollections:
498
+ Desc: Snapshot list as presented in snapshot collections object set.
499
+ Type: Array Of NsSnapshotFromSnapshotCollections
500
+ NsTokenReportUserDetailsReturn:
501
+ Desc: Return values of token reporting user details.
502
+ Type: object
503
+ Members:
504
+ user_name:
505
+ Desc: User name for the session.
506
+ Type: NsUserName
507
+ primary_group_id:
508
+ Desc: The ID of the primary Active Directory user group the user belongs to. RBAC is granted based on this group.
509
+ Type: NsObjectID
510
+ primary_group_name:
511
+ Desc: The primary Active Directory user group the user belongs to. RBAC is granted based on this group.
512
+ Type: NsUserGroupName
513
+ group_count:
514
+ Desc: The number of Active Directory user groups the user belongs to.
515
+ Type: NsUnsignedLong
516
+ role:
517
+ Desc: Role of the user.
518
+ Type: NsUserRoles
519
+ inactivity_timeout:
520
+ Desc: Role of the user.
521
+ Type: NsUnsignedLong
522
+ user_id:
523
+ Desc: Global Id of the user.
524
+ Type: NsObjectID
525
+ groups:
526
+ Desc: The list of Active Directory groups the user belongs to.
527
+ Type: NsUserGroupNames
528
+ NsAppSyncType:
529
+ Desc: Possible values 'none', 'vss', 'vmware'.
530
+ Type: string
531
+ NsAppName:
532
+ Desc: String of 0-255 printable ASCII characters. Example 'GUI'.
533
+ Type: string
534
+ NsSnapVol:
535
+ Desc: Select fields containing volume info.
536
+ Type: object
537
+ Members:
538
+ vol_id:
539
+ Desc: ID of volume.
540
+ Type: NsObjectID
541
+ snap_name:
542
+ Desc: Snapshot name.
543
+ Type: NsVolSnapName
544
+ snap_description:
545
+ Desc: Snapshot description.
546
+ Type: NsDescription
547
+ cookie:
548
+ Desc: A cookie.
549
+ Type: NsString
550
+ online:
551
+ Desc: Snapshot is online.
552
+ Type: NsBoolean
553
+ writable:
554
+ Desc: Snapshot is writable.
555
+ Type: NsBoolean
556
+ app_uuid:
557
+ Desc: Application identifier of snapshots.
558
+ Type: NsAppUuid
559
+ agent_type:
560
+ Desc: External management agent type.
561
+ Type: NsAgentType
562
+ metadata:
563
+ Desc: Key-value pairs that augment a snapshot's attributes.
564
+ Type: NsKeyValues
565
+ NsAuditOperationType:
566
+ Desc: Possible values 'create', 'read', 'update', 'delete', 'other'.
567
+ Type: string
568
+ NsCRUDOperation:
569
+ Desc: A CRUD (Create, Read, Update, Delete) operation associated with an object.
570
+ Type: string
571
+ NsFcInterfaceUpdateList:
572
+ Desc: List of Fibre Channel interfaces to update.
573
+ Type: Array Of NsFcInterfaceUpdateInfo
574
+ NsIPAddressList:
575
+ Desc: List of IP Addresses.
576
+ Type: Array Of NsIPAddressObject
577
+ NsUnsignedLong:
578
+ Desc: Unsigned 64-bit integer. Example 1234.
579
+ Type: number
580
+ NsActiveDirectoryServerList:
581
+ Desc: Comma separated strings of up to 63 characters of hostname and/or ip addresses. Total length cannot exceed 255 characters.
582
+ Type: string
583
+ NsSeverityLevel:
584
+ Desc: Possible values 'info', 'notice', 'warning', 'critical'.
585
+ Type: string
586
+ NsAccessControlRecord:
587
+ Desc: An access control record associated with a volume or snapshot or protocol endpoint.
588
+ Type: object
589
+ Members:
590
+ id:
591
+ Desc: ID of access control record.
592
+ Type: NsObjectID
593
+ acl_id:
594
+ Desc: ID of access control record.
595
+ Type: NsObjectID
596
+ Depricated: Yes
597
+ initiator_group_id:
598
+ Desc: ID of initiator group.
599
+ Type: NsObjectID
600
+ initiator_group_name:
601
+ Desc: Name of initiator group.
602
+ Type: NsObjectName
603
+ chap_user_id:
604
+ Desc: ID of chap user.
605
+ Type: NsObjectID
606
+ chap_user_name:
607
+ Desc: Name of chap user.
608
+ Type: NsObjectName
609
+ apply_to:
610
+ Desc: State of apply to.
611
+ Type: NsAccessApplyTo
612
+ lun:
613
+ Desc: LUN of snapshot or volume. Secondary LUN if this is Virtual Volume.
614
+ Type: NsUnsignedLong
615
+ access_protocol:
616
+ Desc: Access protocol of snapshot or volume.
617
+ Type: NsAccessProtocol
618
+ snapluns:
619
+ Desc: Information about the snapshot LUNs. This information is available only for Fibre Channel.
620
+ Type: NsSnapLunInfoList
621
+ pe_id:
622
+ Desc: ID of protocol endpoint.
623
+ Type: NsObjectID
624
+ pe_name:
625
+ Desc: Name of protocol endpoint.
626
+ Type: NsVolSnapName
627
+ pe_lun:
628
+ Desc: LUN of protocol endpoint.
629
+ Type: NsUnsignedLong
630
+ vol_id:
631
+ Desc: ID of volume.
632
+ Type: NsObjectID
633
+ vol_name:
634
+ Desc: Name of volume.
635
+ Type: NsVolSnapName
636
+ snap_id:
637
+ Desc: ID of snapshot.
638
+ Type: NsObjectID
639
+ snap_name:
640
+ Desc: Name of snapshot.
641
+ Type: NsVolSnapName
642
+ NsPartnerCfgSyncStatus:
643
+ Desc: Possible values 'N/A', 'Yes', 'No'.
644
+ Type: string
645
+ NsPlatFcLinkSpeed:
646
+ Desc: Possible values 'plat_fc_link_speed_unknown', 'plat_fc_link_speed_2G', 'plat_fc_link_speed_4G', 'plat_fc_link_speed_8G', 'plat_fc_link_speed_16G', 'plat_fc_link_speed_32G', 'plat_fc_link_speed_10G', 'plat_fc_link_speed_40G'.
647
+ Type: string
648
+ NsALUA:
649
+ Desc: Possible values 'active_optimized', 'active_non_optimized', 'standby', 'unavailable', 'logical_block_dependent', 'invalid', 'offline', 'transitioning'.
650
+ Type: string
651
+ NsObjectID:
652
+ Desc: A 42 digit hexadecimal number. Example '2a0df0fe6f7dc7bb16000000000000000000004817'.
653
+ Type: string
654
+ NsFqdn:
655
+ Desc: String of up to 255 alphanumeric characters; - and . are allowed after the first and before the last character. Example 'example-1.com'.
656
+ Type: string
657
+ NsNetConfigName:
658
+ Desc: Possible values 'active', 'backup', 'draft'.
659
+ Type: string
660
+ NsSnapLunInfoList:
661
+ Desc: Information about the snapshot LUNs as presented in the access_control_records object set. This information is available only for Fibre Channel.
662
+ Type: Array Of NsSnapLunInfo
663
+ NsSnapshotFromSnapshotCollections:
664
+ Desc: Snapshot as presented in snapshot collections object set.
665
+ Type: object
666
+ Members:
667
+ id:
668
+ Desc: Snapshot collection id which owns this snapshot.
669
+ Type: NsObjectID
670
+ snapcoll_id:
671
+ Desc: Snapshot collection id which owns this snapshot.
672
+ Type: NsObjectID
673
+ name:
674
+ Desc: Snapshot collection name which owns this snapshot.
675
+ Type: NsVolSnapName
676
+ snapcoll_name:
677
+ Desc: Snapshot collection name which owns this snapshot.
678
+ Type: NsVolSnapName
679
+ vol_id:
680
+ Desc: Volume id that is parent to this snapshot.
681
+ Type: NsObjectID
682
+ vol_name:
683
+ Desc: Volume name that is parent to this snapshot.
684
+ Type: NsVolSnapName
685
+ snap_id:
686
+ Desc: Snapshot id.
687
+ Type: NsObjectID
688
+ Depricated: Yes
689
+ snap_name:
690
+ Desc: Snapshot name.
691
+ Type: NsVolSnapName
692
+ Depricated: Yes
693
+ schedule_id:
694
+ Desc: ID of protection schedule.
695
+ Type: NsObjectID
696
+ schedule_name:
697
+ Desc: Name of protection schedule.
698
+ Type: NsObjectName
699
+ NsPlatPort:
700
+ Desc: Port on the HBA (Host Bus Adapter).
701
+ Type: number
702
+ NsObjectIDList:
703
+ Desc: A list of object ids.
704
+ Type: Array Of NsObjectID
705
+ NsVolStatus:
706
+ Desc: Possible values 'online', 'offline', 'non_writable', 'read_only', 'login_only'.
707
+ Type: string
708
+ NsChapPassword:
709
+ Desc: String of 12 to 16 printable ASCII characters excluding ampersand and ^[];`. Example 'password_25-24'.
710
+ Type: string
711
+ NsPassword:
712
+ Desc: String of 8 to 255 printable characters excluding ampersand, backslash and ~;[]`. Example 'password-91'.
713
+ Type: string
714
+ NsWWN:
715
+ Desc: Eight bytes expressed in hex separated by colons. Example 'af32f120bcba431a'.
716
+ Type: string
717
+ NsThrottle:
718
+ Desc: A single throttle for the partner.
719
+ Type: object
720
+ Members:
721
+ id:
722
+ Desc: Id of the throttle.
723
+ Type: NsObjectID
724
+ name:
725
+ Desc: Name of the throttle.
726
+ Type: NsObjectName
727
+ description:
728
+ Desc: Description of the throttle.
729
+ Type: NsObjectName
730
+ creation_time:
731
+ Desc: Creation time of the throttle.
732
+ Type: NsTime
733
+ last_modified:
734
+ Desc: Last modification time of the throttle.
735
+ Type: NsTime
736
+ thr_partner_id:
737
+ Desc: ID of the partner object.
738
+ Type: NsObjectID
739
+ thr_day_mask:
740
+ Desc: Mask for days that the throttle operates.
741
+ Type: NsUnsignedLong
742
+ thr_at_time:
743
+ Desc: Start time set for the throttle.
744
+ Type: NsTimeOfDay
745
+ thr_until_time:
746
+ Desc: End time set for the throttle.
747
+ Type: NsTimeOfDay
748
+ thr_bandwidth:
749
+ Desc: Bandwidth set for the throttle in megabits per second.
750
+ Type: NsUnsignedLong
751
+ thr_bandwidth_kbps:
752
+ Desc: Bandwidth set for the throttle in kilobits per second.
753
+ Type: NsUnsignedLong
754
+ NsSnapshotListFromVolumes:
755
+ Desc: Snapshot list as presented in volumes object set.
756
+ Type: Array Of NsSnapshotFromVolumes
757
+ NsJobStatus:
758
+ Desc: Possible values 'done', 'inprogress'.
759
+ Type: string
760
+ NsSnapVolList:
761
+ Desc: List of snapshots to create.
762
+ Type: Array Of NsSnapVol
763
+ NsAccessProtocol:
764
+ Desc: Possible values 'iscsi', 'fc'.
765
+ Type: string
766
+ NsSearchName:
767
+ Desc: Alphanumeric string, up to 64 characters including hyphen, period, colon. Example 'vol1'.
768
+ Type: string
769
+ NsFcId:
770
+ Desc: Unique identifier of the Fibre Channel port in hexadecimal representation.
771
+ Type: string
772
+ NsKeyValues:
773
+ Desc: List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.
774
+ Type: Array Of NsKeyValue
775
+ NsPercent:
776
+ Desc: Percentage as integer from 0 to 100.
777
+ Type: number
778
+ NsActiveDirectoryComputerName:
779
+ Desc: Name of the computer account in Active Directory. Example 'storage-array01'.
780
+ Type: string
781
+ NsUserGroupName:
782
+ Desc: String of up to 64 uppercase or lowercase characters excluding ampersand, less than, greater than and ^/\[];|=,+*?;. Example 'admin-group-24'.
783
+ Type: string
784
+ NsBaseWWN:
785
+ Desc: Six bytes expressed in hex separated by colons. Example 'af32f1'.
786
+ Type: string
787
+ NsVolumeListReturn:
788
+ Desc: Object containing a list of volume names and IDs.
789
+ Type: object
790
+ Members:
791
+ vol_list:
792
+ Desc: A list of volume names and IDs.
793
+ Type: NsVolumeList
794
+ NsPoolMigrate:
795
+ Desc: Possible values 'none', 'in', 'out'.
796
+ Type: string
797
+ NsToken:
798
+ Desc: String of 31 or 32 alphanumeric characters. Example '9f53a789f1e9eae7b9385f4d8873fb1'.
799
+ Type: string
800
+ NsISCSIInitiator:
801
+ Desc: ISCSI initiator.
802
+ Type: object
803
+ Members:
804
+ id:
805
+ Desc: Unique identifier of the iSCSI initiator.
806
+ Type: NsObjectID
807
+ initiator_id:
808
+ Desc: Unique identifier of the iSCSI initiator.
809
+ Type: NsObjectID
810
+ Depricated: Yes
811
+ label:
812
+ Desc: Unique label of the iSCSI initiator.
813
+ Type: NsObjectName
814
+ iqn:
815
+ Desc: IQN name of the iSCSI initiator.
816
+ Type: NsIQN
817
+ ip_address:
818
+ Desc: IP address of the iSCSI initiator.
819
+ Type: NsInitiatorIPAddress
820
+ NsOfflineReason:
821
+ Desc: Possible values 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'over_snapshot_reserve', 'nvram_loss_recovery', 'serial_number_collision', 'encryption_inactive', 'encryption_key_deleted', 'vvol_unbind', 'cache_unpin_in_progress'.
822
+ Type: string
823
+ NsSnapStatus:
824
+ Desc: Possible values 'invalid', 'okay', 'failed_delete', 'deleted', 'creating', 'create_retry', 'force_delete', 'deferred_delete'.
825
+ Type: string
826
+ NsObjectType:
827
+ Desc: Possible values 'active_directory', 'group', 'chapuser', 'initiatorgrp', 'perfpolicy', 'snapshot', 'snapcoll', 'vol', 'volcoll', 'partner', 'array', 'pool', 'initiator', 'protsched', 'volacl', 'throttle', 'sshkey', 'user', 'protpol', 'prottmpl', 'branch', 'route', 'role', 'privilege', 'netconfig', 'events', 'session', 'subnet', 'array_netconfig', 'nic', 'initiatorgrp_subnet', 'fc_initiator_alias', 'fc_port', 'fc_interface_collection', 'fc', 'event_dipatcher', 'fc_target_port_group', 'encrypt_key', 'encrypt_config', 'snapshot_lun', 'syslog', 'async_job', 'application_server', 'audit_log', 'ip address', 'disk', 'shelf', 'protocol_endpoint', 'folder', 'pe_acl', 'vvol', 'vvol_acl'.
828
+ Type: string
829
+ NsRoute:
830
+ Desc: Route configuration.
831
+ Type: object
832
+ Members:
833
+ tgt_network:
834
+ Desc: Target network address.
835
+ Type: NsIPAddress
836
+ tgt_netmask:
837
+ Desc: Target network mask.
838
+ Type: NsIPNetmask
839
+ gateway:
840
+ Desc: Gateway IP address.
841
+ Type: NsIPAddress
842
+ NsOrganizationalUnit:
843
+ Desc: The location where the computer account has to be created. The value should be specified in fully distinguished name (DN) format. Reserved characters - comma, plus sign, double quote, backslash, left angle bracket, right angle bracket, semicolon, linefeed, carriage return, equals sign and forward slash must be escaped. Example ou=ABC\, San Jose,dc=MY,dc=LOCAL.
844
+ Type: string
845
+ NsEventCategory:
846
+ Desc: Possible values 'unknown', 'hardware', 'service', 'replication', 'volume', 'update', 'configuration', 'test', 'security'.
847
+ Type: string
848
+ NsOptionalObjectID:
849
+ Desc: An optional NsObjectID. A 42 digit hexadecimal number or the empty string. Example '1234123412341234123412341234123412341234cd' or ''.
850
+ Type: string
851
+ NsNICList:
852
+ Desc: List of NICs.
853
+ Type: Array Of NsNIC
854
+ NsIPAddress:
855
+ Desc: Four numbers in the range [0,255] separated by periods. Example '128.0.0.1'.
856
+ Type: string
857
+ NsChksum:
858
+ Desc: A 8 digit hexadecimal number. Example 'ffffffff'.
859
+ Type: string
860
+ NsPeriodUnit:
861
+ Desc: Possible values 'minutes', 'hours', 'days', 'weeks'.
862
+ Type: string
863
+ NsProtectionPolicyType:
864
+ Desc: Possible values 'protection_template', 'volume_collection'.
865
+ Type: string
866
+ NsErrorCode:
867
+ Desc: Non-negative integer in range [0,9000].
868
+ Type: string
869
+ NsSoftwareVersion:
870
+ Desc: Software version of storage array or group.
871
+ Type: string
872
+ NsMTU:
873
+ Desc: Positive integer in range [512,1600].
874
+ Type: number
875
+ NsSnapshotFromVolumes:
876
+ Desc: Snapshot as presented in volumes object set.
877
+ Type: object
878
+ Members:
879
+ id:
880
+ Desc: Snapshot id.
881
+ Type: NsObjectID
882
+ snap_id:
883
+ Desc: Snapshot id.
884
+ Type: NsObjectID
885
+ Depricated: Yes
886
+ name:
887
+ Desc: Snapshot name.
888
+ Type: NsVolSnapName
889
+ snap_name:
890
+ Desc: Snapshot name.
891
+ Type: NsVolSnapName
892
+ Depricated: Yes
893
+ NsIPAddressObject:
894
+ Desc: Object wrapper of IP Address.
895
+ Type: object
896
+ Members:
897
+ ip_addr:
898
+ Desc: An IP Address.
899
+ Type: NsIPAddress
900
+ NsAuditActivity:
901
+ Desc: String of 1-1476 printable characters. Example 'Created snapshot % of volume %'.
902
+ Type: string
903
+ NsDescription:
904
+ Desc: String of up to 255 printable ASCII characters. Example '99.9999% availability'.
905
+ Type: string
906
+ NsAppServerType:
907
+ Desc: Possible values 'vss', 'vmware'.
908
+ Type: string
909
+ NsExtendedPrivilegeList:
910
+ Desc: List of extended privileges associated with a role.
911
+ Type: Array Of NsExtendedPrivilege
912
+ NsArrayFcConfigList:
913
+ Desc: List of array Fibre Channel configurations.
914
+ Type: Array Of NsArrayFcConfig
915
+ NsAuditLogUserName:
916
+ Desc: String of up to 32 alphanumeric characters, beginning with a letter. Or _ampersand_amp;lt;system_ampersand_amp;gt; for system user. Example 'user99'.
917
+ Type: string
918
+ NsVlanId:
919
+ Desc: Positive integer in range [0,4096].
920
+ Type: number
921
+ NsFcInterfaceInfo:
922
+ Desc: Fibre Channel interface information.
923
+ Type: object
924
+ Members:
925
+ name:
926
+ Desc: Name of Fibre Channel interface.
927
+ Type: NsObjectName
928
+ wwnn:
929
+ Desc: WWNN (World Wide Node Name) for this Fibre Channel interface.
930
+ Type: NsWWN
931
+ wwpn:
932
+ Desc: WWPN (World Wide Port Name)for this Fibre Channel interface.
933
+ Type: NsWWN
934
+ online:
935
+ Desc: Identify whether the Fibre Channel interface is online.
936
+ Type: NsBoolean
937
+ bus_location:
938
+ Desc: PCI bus location of the HBA.
939
+ Type: NsBusLocation
940
+ slot:
941
+ Desc: Information about the Fibre Channel slot.
942
+ Type: NsPlatSlot
943
+ port:
944
+ Desc: Information about the Fibre Channel port on which the interface is hosted.
945
+ Type: NsPlatPort
946
+ NsAbsolutePath:
947
+ Desc: Absolute path that starts with / and delimited by /. Each component name must conform to NsObjectName type. Example '/path/to/folder'.
948
+ Type: string
949
+ NsInitiatorIPAddress:
950
+ Desc: String of four period-separated numbers, each in range [0,255]. Example '128.0.0.1' or '*'.
951
+ Type: string
952
+ NsCommaSeparatedList:
953
+ Desc: Comma separated list of up to 64 non-empty lowercase alphanumeric strings without spaces. Example 'name,app_id'.
954
+ Type: string
955
+ NsPlatSlot:
956
+ Desc: Slot that is mapped on the PCIe bus.
957
+ Type: number
958
+ NsDomainUser:
959
+ Desc: Active Directory username. String up to 255 printable characters. Example 'joe-91'.
960
+ Type: string
961
+ NsFullName:
962
+ Desc: Alphanumeric string of up to 64 chars, starts with letter, can include space, apostrophe('), hythen(-). Example 'User-13 Peterson'.
963
+ Type: string
964
+ NsBulkVolSettingReturn:
965
+ Desc: Return codes for setting an attribute to a list of items.
966
+ Type: object
967
+ Members:
968
+ error_codes:
969
+ Desc: Error codes for every element in a list of items.
970
+ Type: NsErrorCodeList
971
+ NsExtUserId:
972
+ Desc: String of up to 255 printable ASCII characters. Example 'S_aba-123'.
973
+ Type: string
974
+ NsBusLocation:
975
+ Desc: Platform HBA (Host Bus Adapter) bus location. Example 00008100.0.
976
+ Type: string
977
+ NsVolumeList:
978
+ Desc: List of volumes associated with a volume collection.
979
+ Type: Array Of NsVolumeSummary
980
+ NsNetbiosName:
981
+ Desc: Netbios name for the Active Directory. Example 'corp'.
982
+ Type: string
983
+ NsPerfPolicyName:
984
+ Desc: String of up to 64 alphanumeric characters, - and . and and space are allowed after first character. Example 'SQL Server Logs'.
985
+ Type: string
986
+ NsAuditCategory:
987
+ Desc: Possible values 'data_provisioning', 'data_protection', 'data_access', 'user_access', 'system_configuration', 'software_update'.
988
+ Type: string
989
+ NsPoolMergeReturn:
990
+ Desc: Return values of pool merge.
991
+ Type: object
992
+ Members:
993
+ snapcoll_count:
994
+ Desc: Snapshot collection count.
995
+ Type: NsUnsignedLong
996
+ array_list:
997
+ Desc: List of arrays in the pool with detailed information. When create/update array list, only arrays' id is required.
998
+ Type: NsArrayDetailList
999
+ array_count:
1000
+ Desc: Number of arrays in the pool.
1001
+ Type: NsUnsignedLong
1002
+ unassigned_array_list:
1003
+ Desc: List of arrays being unassigned from the pool.
1004
+ Type: NsArraySummaryList
1005
+ all_flash:
1006
+ Desc: Indicate whether the pool is an all_flash pool.
1007
+ Type: NsBoolean
1008
+ cache_capacity:
1009
+ Desc: Total usable cache capacity of the pool in bytes.
1010
+ Type: NsBytes
1011
+ capacity:
1012
+ Desc: Total storage space of the pool in bytes.
1013
+ Type: NsBytes
1014
+ compressed_snap_usage_bytes:
1015
+ Desc: Compressed usage of snapshots in the pool.
1016
+ Type: NsBytes
1017
+ compressed_vol_usage_bytes:
1018
+ Desc: Compressed usage of volumes in the pool.
1019
+ Type: NsBytes
1020
+ compression_ratio:
1021
+ Desc: Compression savings for the pool expressed as ratio.
1022
+ Type: NsRatio
1023
+ creation_time:
1024
+ Desc: Time when this pool was created.
1025
+ Type: NsTime
1026
+ dedupe_ratio:
1027
+ Desc: Dedupe savings for the pool expressed as ratio.
1028
+ Type: NsRatio
1029
+ description:
1030
+ Desc: Text description of pool. Default ''.
1031
+ Type: NsDescription
1032
+ free_space:
1033
+ Desc: Free space of the pool in bytes.
1034
+ Type: NsBytes
1035
+ full_name:
1036
+ Desc: Fully qualified name of pool.
1037
+ Type: NsObjectName
1038
+ id:
1039
+ Desc: Identifier for the pool.
1040
+ Type: NsObjectID
1041
+ dedupe_enabled:
1042
+ Desc: Indicate whether the pool is a dedupe enabled pool.
1043
+ Type: NsBoolean
1044
+ last_modified:
1045
+ Desc: Time when this pool was last modified.
1046
+ Type: NsTime
1047
+ name:
1048
+ Desc: Name of pool.
1049
+ Type: NsObjectName
1050
+ pinnable_cache_capacity:
1051
+ Desc: Total pinnable cache capacity of the pool in bytes.
1052
+ Type: NsBytes
1053
+ pinned_cache_capacity:
1054
+ Desc: Total pinned cache capacity of the pool in bytes.
1055
+ Type: NsBytes
1056
+ pinned_vol_list:
1057
+ Desc: The list of pinned volumes in the pool.
1058
+ Type: NsVolumeList
1059
+ savings_compression:
1060
+ Desc: Space usage savings in the pool due to compression.
1061
+ Type: NsBytes
1062
+ savings_dedupe:
1063
+ Desc: Space usage savings in the pool due to deduplication.
1064
+ Type: NsBytes
1065
+ search_name:
1066
+ Desc: Name of pool used for object search.
1067
+ Type: NsSearchName
1068
+ snap_compression_ratio:
1069
+ Desc: Compression ratio of snapshots in the pool.
1070
+ Type: NsRatio
1071
+ snap_count:
1072
+ Desc: Snapshot count.
1073
+ Type: NsUnsignedLong
1074
+ uncompressed_snap_usage_bytes:
1075
+ Desc: Uncompressed usage of snapshots in the pool.
1076
+ Type: NsBytes
1077
+ uncompressed_vol_usage_bytes:
1078
+ Desc: Uncompressed usage of volumes in the pool.
1079
+ Type: NsBytes
1080
+ unused_reserve:
1081
+ Desc: Unused reserve space of the pool in bytes.
1082
+ Type: NsBytes
1083
+ usage:
1084
+ Desc: Used space of the pool in bytes.
1085
+ Type: NsBytes
1086
+ usage_valid:
1087
+ Desc: Indicate whether the usage of pool is valid.
1088
+ Type: NsBoolean
1089
+ vol_compression_ratio:
1090
+ Desc: Compression ratio of volumes in the pool.
1091
+ Type: NsRatio
1092
+ vol_count:
1093
+ Desc: Number of volumes assigned to the pool.
1094
+ Type: NsUnsignedLong
1095
+ vol_list:
1096
+ Desc: The list of volumes in the pool.
1097
+ Type: NsVolumeList
1098
+ NsEncryptionCipher:
1099
+ Desc: Possible values 'none', 'aes_256_xts'.
1100
+ Type: string
1101
+ NsKeyValue:
1102
+ Desc: Key-value pair.
1103
+ Type: object
1104
+ Members:
1105
+ key:
1106
+ Desc: Identifier of key-value pair.
1107
+ Type: NsString
1108
+ value:
1109
+ Desc: Value of key-value pair.
1110
+ Type: NsString
1111
+ NsISCSISessions:
1112
+ Desc: List of iSCSI initiator sessions information.
1113
+ Type: Array Of NsISCSISession
1114
+ NsTimeOfDay:
1115
+ Desc: Non-negative integer in range [0,86399] which is equivalent to [00000 AM, 235959 PM].
1116
+ Type: number
1117
+ NsTag:
1118
+ Desc: String of up to 128 printable ASCII characters. Example 'GUI debugger'.
1119
+ Type: string
1120
+ NsUserRoles:
1121
+ Desc: Possible values 'administrator', 'poweruser', 'operator', 'guest'.
1122
+ Type: string
1123
+ NsScheduleList:
1124
+ Desc: List of snapshot schedules associated with a volume collection or protection template.
1125
+ Type: Array Of NsSchedule
1126
+ NsPinnedVolumeInfoList:
1127
+ Desc: List of pinned volumes in a pool.
1128
+ Type: Array Of NsPinnedVolumeInfo
1129
+ NsTime:
1130
+ Desc: Seconds since last epoch i.e. 0000 January 1, 1970. Example '3400'.
1131
+ Type: number
1132
+ NsTraceLevel:
1133
+ Desc: Possible values 'info', 'warn', 'note', 'error', 'critical'.
1134
+ Type: string
1135
+ NsArrayDetailList:
1136
+ Desc: List of arrays' detailed information.
1137
+ Type: Array Of NsArrayDetail
1138
+ NsUserGroupNames:
1139
+ Desc: List of Active Directory groups the user belongs to.
1140
+ Type: Array Of NsUserGroupName
1141
+ NsRatio:
1142
+ Desc: Fraction expressed as floating point number. Example '9.18'.
1143
+ Type: number
1144
+ NsAgentType:
1145
+ Desc: Possible values 'none', 'smis', 'all', 'vvol', 'openstack'.
1146
+ Type: string
1147
+ NsAppUuid:
1148
+ Desc: String of up to 255 alphanumeric characters, hyphen, dot and underscore are allowed. Example 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'.
1149
+ Type: string
1150
+ NsAsciiString16:
1151
+ Desc: String of printable ASCII characters, maximum length 16.
1152
+ Type: string
1153
+ NsEventTargetType:
1154
+ Desc: Possible values 'anon', 'array', 'controller', 'disk', 'nic', 'temperature', 'service', 'volume', 'protection_set', 'nvram', 'fan', 'power_supply', 'partner', 'raid', 'test', 'iscsi', 'pool', 'group', 'shelf', 'ntb', 'fc', 'initiator_group'.
1155
+ Type: string
1156
+ NsDomainPassword:
1157
+ Desc: Active Directory user password. String up to 255 printable characters. Example 'password-91'.
1158
+ Type: string
1159
+ NsFcPortList:
1160
+ Desc: List of Fibre Channel ports.
1161
+ Type: Array Of NsFcPortInfo
1162
+ NsStatScope:
1163
+ Desc: String of up to 10 alphanumberic characters. For example 'array'.
1164
+ Type: string
1165
+ NsObjectName:
1166
+ Desc: String of up to 64 alphanumeric characters, - and . and are allowed after first character. Example 'myobject-5'.
1167
+ Type: string
1168
+ NsBytes:
1169
+ Desc: Unsigned 64-bit integer. Example '1234'.
1170
+ Type: number
1171
+ NsBitMap:
1172
+ Desc: A hexadecimal number with maximum of 8192 characters. Example '0810'.
1173
+ Type: string
1174
+ NsFcConfigRegenerateReturn:
1175
+ Desc: Return values of Fibre channel config regeneration.
1176
+ Type: object
1177
+ Members:
1178
+ array_list:
1179
+ Desc: List of array Fibre Channel configs.
1180
+ Type: NsArrayFcConfigList
1181
+ group_leader_array:
1182
+ Desc: Name of the group leader array.
1183
+ Type: NsObjectName
1184
+ id:
1185
+ Desc: Identifier for Fibre Channel configuration.
1186
+ Type: NsObjectID
1187
+ NsADReportStatusReturn:
1188
+ Desc: Status of the Active Directory domain.
1189
+ Type: object
1190
+ Members:
1191
+ joined:
1192
+ Desc: Joined the Active Directory group.
1193
+ Type: NsBoolean
1194
+ enabled:
1195
+ Desc: Active Directory group is enabled.
1196
+ Type: NsBoolean
1197
+ local_service_status:
1198
+ Desc: Status of the local service.
1199
+ Type: NsBoolean
1200
+ remote_service_status:
1201
+ Desc: Status of the remote service.
1202
+ Type: NsBoolean
1203
+ trust_valid:
1204
+ Desc: Trust is valid.
1205
+ Type: NsBoolean
1206
+ NsPort:
1207
+ Desc: Integer value between 0-65535 representing TCP/IP TCP/IP port. Example 1234.
1208
+ Type: number
1209
+ NsIQN:
1210
+ Desc: Alphanumeric, hyphenated, colon or period separated string of up to 255 characters. Example 'iqn.2007-11.com.storagezmytestvol1-v0df0fe6f7dc7bb16.0000016b.70374579'.
1211
+ Type: string
1212
+ NsISCSISession:
1213
+ Desc: ISCSI initiator session information.
1214
+ Type: object
1215
+ Members:
1216
+ id:
1217
+ Desc: Unique identifier of the iSCSI session.
1218
+ Type: NsObjectID
1219
+ session_id:
1220
+ Desc: Unique identifier of the iSCSI session.
1221
+ Type: NsObjectID
1222
+ Depricated: Yes
1223
+ initiator_name:
1224
+ Desc: Name of the iSCSI initiator (IQN).
1225
+ Type: NsObjectName
1226
+ num_connections:
1227
+ Desc: Number of connections in iSCSI session.
1228
+ Type: NsUnsignedLong
1229
+ pr_key:
1230
+ Desc: Registered persistent reservation key for the I-T nexus on this LU (if there is no registration, its value will be zero).
1231
+ Type: NsUnsignedLong
1232
+ initiator_ip_addr:
1233
+ Desc: IP address of the iSCSI initiator.
1234
+ Type: NsInitiatorIPAddress
1235
+ target_ip_addr:
1236
+ Desc: Target IP address of the iSCSI initiator.
1237
+ Type: NsInitiatorIPAddress
1238
+ header_digest_enabled:
1239
+ Desc: Indicate whether header digest is enabled.
1240
+ Type: NsBoolean
1241
+ data_digest_enabled:
1242
+ Desc: Indicate whether data digest is enabled.
1243
+ Type: NsBoolean
1244
+ NsFcSessionInitiator:
1245
+ Desc: Information of the Fibre Channel Session Initiator.
1246
+ Type: object
1247
+ Members:
1248
+ initiator_alias:
1249
+ Desc: Alias of the Fibre Channel initiator.
1250
+ Type: NsInitiatorAlias
1251
+ initiator_wwpn:
1252
+ Desc: WWPN (World Wide Port Name) of the Fibre Channel initiator.
1253
+ Type: NsWWN
1254
+ initiator_switch_name:
1255
+ Desc: Name of the switch used by the Fibre Channel initiator.
1256
+ Type: NsAsciiString255
1257
+ initiator_switch_port:
1258
+ Desc: Port on the switch used by the Fibre Channel initiator.
1259
+ Type: NsAsciiString16
1260
+ initiator_symbolic_portname:
1261
+ Desc: Symbolic port name associated with the Fibre Channel initiator.
1262
+ Type: NsAsciiString255
1263
+ initiator_symbolic_nodename:
1264
+ Desc: Symbolic node name associated with the Fibre Channel initiator.
1265
+ Type: NsAsciiString255
1266
+ initiator_fcid:
1267
+ Desc: FCID assigned to the Fibre Channel initiator.
1268
+ Type: NsFcId
1269
+ NsUserName:
1270
+ Desc: String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (\), dash (-), period (.), underscore (_) and space. Example 'user1', 'companydomain\user1'.
1271
+ Type: string
1272
+ NsCtrlrFcConfig:
1273
+ Desc: Controller Fibre Channel configuration.
1274
+ Type: object
1275
+ Members:
1276
+ fc_port_list:
1277
+ Desc: List of Fibre Channel ports.
1278
+ Type: NsFcPortList
1279
+ fc_interface_list:
1280
+ Desc: List of Fibre Channel interfaces.
1281
+ Type: NsFcInterfaceList
1282
+ NsPEOpStateType:
1283
+ Desc: Possible values 'normal', 'deprecated'.
1284
+ Type: string
1285
+ NsSubnetType:
1286
+ Desc: Possible values 'invalid', 'unconfigured', 'mgmt', 'data', 'mgmt_data'.
1287
+ Type: string
1288
+ NsFcSessionTarget:
1289
+ Desc: Information of the Fibre Channel session target.
1290
+ Type: object
1291
+ Members:
1292
+ target_port_array_name:
1293
+ Desc: Name of the array hosting the Fibre Channel target port.
1294
+ Type: NsObjectName
1295
+ target_port_ctrlr_name:
1296
+ Desc: Name (A or B) of the controller to which the port belongs.
1297
+ Type: NsObjectName
1298
+ target_port_interface_name:
1299
+ Desc: Name of the interface hosted on the Fibre Channel target port.
1300
+ Type: NsObjectName
1301
+ target_wwnn:
1302
+ Desc: WWNN (World Wide Node Name) of the Fibre Channel target port.
1303
+ Type: NsWWN
1304
+ target_wwpn:
1305
+ Desc: WWPN (World Wide Port Name) of the Fibre Channel target port.
1306
+ Type: NsWWN
1307
+ target_fcid:
1308
+ Desc: FCID assigned to the Fibre Channel target port.
1309
+ Type: NsFcId
1310
+ NsSeconds:
1311
+ Desc: Unsigned 64-bit integer. Example '1234'.
1312
+ Type: number
1313
+ NsSubnetConfigs:
1314
+ Desc: List of subnet configs.
1315
+ Type: Array Of NsSubnet
1316
+ NsStatsRecord:
1317
+ Desc: One stat record.
1318
+ Type: object
1319
+ Members:
1320
+ create_time:
1321
+ Desc: Creation time of stat sample.
1322
+ Type: NsTime
1323
+ sensors:
1324
+ Desc: Array of stats sensors for this record.
1325
+ Type: NsStatsSensors
1326
+ NsVersion:
1327
+ Desc: String of up to 8 alphanumeric characters starting with v. Example 'v1'.
1328
+ Type: string
1329
+ NsInitiatorAlias:
1330
+ Desc: String of up to 32 alphanumeric characters, or one of $^-_. cannot begin with non-alphanumeric character. Example 'my_initiator-4'.
1331
+ Type: string
1332
+ NsString:
1333
+ Desc: Plain string.
1334
+ Type: string
1335
+ NsGroupName:
1336
+ Desc: String of up to 64 alphanumeric characters, - is allowed after first character. Example 'g1-exchange'.
1337
+ Type: string
1338
+ NsArrayNet:
1339
+ Desc: Array network config.
1340
+ Type: object
1341
+ Members:
1342
+ name:
1343
+ Desc: Name of the array.
1344
+ Type: NsObjectName
1345
+ member_gid:
1346
+ Desc: GID of member.
1347
+ Type: NsUnsignedLong
1348
+ ctrlr_a_support_ip:
1349
+ Desc: IP address of controller A.
1350
+ Type: NsIPAddress
1351
+ ctrlr_b_support_ip:
1352
+ Desc: IP address of controller B.
1353
+ Type: NsIPAddress
1354
+ nic_list:
1355
+ Desc: List of NICs.
1356
+ Type: NsNICList
1357
+ NsCachePolicy:
1358
+ Desc: Possible values 'disabled', 'normal', 'aggressive', 'no_write', 'aggressive_read_no_write'.
1359
+ Type: string
1360
+ NsPlatLinkSpeed:
1361
+ Desc: Possible values 'link_speed_unknown', 'link_speed_10M', 'link_speed_100M', 'link_speed_1000M', 'link_speed_10000M'.
1362
+ Type: string
1363
+ NsErrorCodeList:
1364
+ Desc: List of error codes.
1365
+ Type: Array Of NsErrorCode
1366
+ NsAppIdType:
1367
+ Desc: Possible values 'inval', 'exchange', 'sql2005', 'sql2008', 'sql2012', 'exchange_dag', 'sql2014'.
1368
+ Type: string
1369
+ NsOperationStatus:
1370
+ Desc: Possible values 'invalid', 'unknown', 'succeeded', 'failed', 'inprogress'.
1371
+ Type: string
1372
+ NsHostName:
1373
+ Desc: String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen.
1374
+ Type: string
1375
+ NsFCSessions:
1376
+ Desc: List of Fibre Channel initiator sessions information.
1377
+ Type: Array Of NsFCSession
1378
+ NsChksumReturn:
1379
+ Desc: Return computed checksum.
1380
+ Type: object
1381
+ Members:
1382
+ NsChksum:
1383
+ Desc: Computed checksum.
1384
+ Type: NsChksum
1385
+ NsTargetSubnet:
1386
+ Desc: List of subnet labels.
1387
+ Type: object
1388
+ Members:
1389
+ id:
1390
+ Desc: Subnet ID.
1391
+ Type: NsObjectID
1392
+ label:
1393
+ Desc: Subnet label.
1394
+ Type: NsObjectName
1395
+ NsExtendedPrivilege:
1396
+ Desc: Extended privilege info.
1397
+ Type: object
1398
+ Members:
1399
+ object_type:
1400
+ Desc: Object type name associated with this privilege.
1401
+ Type: NsString
1402
+ operation:
1403
+ Desc: Operation associated with the above object for this privilege.
1404
+ Type: NsString
1405
+ allow:
1406
+ Desc: Indicate whether the above operation is allowed for this privilege.
1407
+ Type: NsBoolean
1408
+ NsSnapLunInfo:
1409
+ Desc: Snapshot LUN information as presented in the access_control_records object set. This information is only available for Fibre Channel.
1410
+ Type: object
1411
+ Members:
1412
+ id:
1413
+ Desc: Snapshot ID.
1414
+ Type: NsObjectID
1415
+ name:
1416
+ Desc: Snapshot name.
1417
+ Type: NsVolSnapName
1418
+ lun:
1419
+ Desc: Snapshot LUN.
1420
+ Type: NsUnsignedLong
1421
+ NsSnapReplStatus:
1422
+ Desc: Possible values 'complete', 'in_progress', 'pending'.
1423
+ Type: string
1424
+ NsPlatLinkStatus:
1425
+ Desc: Possible values 'link_status_unknown', 'link_status_down', 'link_status_up'.
1426
+ Type: string
1427
+ NsVolumeSummary:
1428
+ Desc: Select fields containing volume info.
1429
+ Type: object
1430
+ Members:
1431
+ id:
1432
+ Desc: ID of volume.
1433
+ Type: NsObjectID
1434
+ vol_id:
1435
+ Desc: ID of volume.
1436
+ Type: NsObjectID
1437
+ Depricated: Yes
1438
+ name:
1439
+ Desc: Name of volume.
1440
+ Type: NsVolSnapName
1441
+ vol_name:
1442
+ Desc: Name of volume.
1443
+ Type: NsVolSnapName
1444
+ Depricated: Yes
1445
+ NsDays:
1446
+ Desc: Comma separated list of days of the week or 'all'. Example 'monday,sunday'.
1447
+ Type: string
1448
+ NsMac:
1449
+ Desc: Mac address of an interface.
1450
+ Type: string
1451
+ NsFibreChannelPortID:
1452
+ Desc: An ID of a Fibre Channel Port. Example '1f01067316132'.
1453
+ Type: string
1454
+ NsLogMessage:
1455
+ Desc: String of up to 1024 printable ASCII characters. Example 'Null pointer exception, at line 320'.
1456
+ Type: string
1457
+ NsBitMapReturn:
1458
+ Desc: Return bitmap under certain request.
1459
+ Type: object
1460
+ Members:
1461
+ bitmap:
1462
+ Desc: Returned bitmap.
1463
+ Type: NsBitMap
1464
+ NsScheduleType:
1465
+ Desc: Possible values 'regular', 'external_trigger'.
1466
+ Type: string
1467
+ NsISCSISerialNumber:
1468
+ Desc: A 32 digit hexadecimal number. Example '1234123412341234abcdacbdacbdacbd'.
1469
+ Type: string
1470
+ NsLunReturn:
1471
+ Desc: Return LU number.
1472
+ Type: object
1473
+ Members:
1474
+ lun:
1475
+ Desc: LU number.
1476
+ Type: NsUnsignedLong
1477
+ NsFCSession:
1478
+ Desc: Fibre Channel initiator session information.
1479
+ Type: object
1480
+ Members:
1481
+ id:
1482
+ Desc: Unique identifier of the Fibre Channel session.
1483
+ Type: NsObjectID
1484
+ session_id:
1485
+ Desc: Unique identifier of the Fibre Channel session.
1486
+ Type: NsObjectID
1487
+ Depricated: Yes
1488
+ alua:
1489
+ Desc: ALUA (Asymmetric Logical Unit Access) value of the Fibre Channel session.
1490
+ Type: NsALUA
1491
+ pr_key:
1492
+ Desc: Registered persistent reservation key for this session on associated logical unit (if there is no registration, its value will be zero).
1493
+ Type: NsUnsignedLong
1494
+ initiator_alias:
1495
+ Desc: Alias of the Fibre Channel initiator.
1496
+ Type: NsInitiatorAlias
1497
+ initiator_wwpn:
1498
+ Desc: WWPN (World Wide Port Name) of the Fibre Channel initiator.
1499
+ Type: NsWWN
1500
+ initiator_switch_name:
1501
+ Desc: Name of the switch used by the Fibre Channel initiator.
1502
+ Type: NsAsciiString255
1503
+ initiator_switch_port:
1504
+ Desc: Port on the switch used by the Fibre Channel initiator.
1505
+ Type: NsAsciiString16
1506
+ initiator_symbolic_portname:
1507
+ Desc: Symbolic port name associated with the Fibre Channel initiator.
1508
+ Type: NsAsciiString255
1509
+ initiator_symbolic_nodename:
1510
+ Desc: Symbolic node name associated with the Fibre Channel initiator.
1511
+ Type: NsAsciiString255
1512
+ initiator_fcid:
1513
+ Desc: FCID assigned to the Fibre Channel initiator.
1514
+ Type: NsUnsignedLong
1515
+ target_port_array_name:
1516
+ Desc: Name of the array hosting the Fibre Channel target port.
1517
+ Type: NsObjectName
1518
+ target_port_ctrlr_id:
1519
+ Desc: Identifier of the controller hosting the Fibre Channel target port.
1520
+ Type: NsUnsignedLong
1521
+ target_port_interface_name:
1522
+ Desc: Name of the interface hosted on the Fibre Channel target port.
1523
+ Type: NsObjectName
1524
+ target_wwnn:
1525
+ Desc: WWNN (World Wide Node Name) of the Fibre Channel target port.
1526
+ Type: NsWWN
1527
+ target_wwpn:
1528
+ Desc: WWPN (World Wide Port Name) of the Fibre Channel target port.
1529
+ Type: NsWWN
1530
+ target_fcid:
1531
+ Desc: FCID assigned to the Fibre Channel target port.
1532
+ Type: NsUnsignedLong