REST API reference
Retrieve an application
Suggest changes
PDFs
GET /application/applications/{uuid}
Retrieves an application
Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See DOC Requesting specific fields to learn more.
-
<template>the property corresponding to thetemplate.nameof the application
Property overview
An application includes three main groups or properties.
-
Generic properties - such as the
name,template.name, andstateof the application. These properties are all inexpensive to retrieve and their meaning is consistent for every type of application. -
statistics.*- application statistics report live usage data about the application and its components. Various space and IOPS details are included at both the application level and at a per component level. The application model includes a detailed description of each property. These properties are slightly more expensive than the generic properties because live data must be collected from every storage element in the application. -
<template>- the property corresponding to the value of thetemplate.namereturns the contents of the application in the same layout that was used to provision the application. This information is very expensive to retrieve because it requires collecting information about all the storage and access settings for every element of the application. There are a few notable limitations to what can be returned in the<template>section:-
The
new_igroupsarray of many SAN templates is not returned by GET. This property allows igroup creation in the same call that creates an application, but is not a property of the application itself. Thenew_igroupsarray is allowed during PATCH operations, but that does not modify thenew_igroupsof the application. It is another way to allow igroup creation while updating the application to use a different igroup. -
The
vdi_on_sanandvdi_on_nasdesktops.countproperty is rounded to the nearest 1000 during creation, and is reported with that rounding applied. -
The
mongo_db_on_sandataset.element_countproperty is rounded up to an even number, and is reported with that rounding applied. -
The
sql_on_sanandsql_on_smbserver_cores_countproperty is limited to 8 for GET operations. Higher values are accepted by POST, but the impact of theserver_cores_countproperty on the application layout currently reaches its limit at 8.
-
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
path |
True |
Application UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
creation_timestamp |
string |
The time when the application was created |
generation |
integer |
The generation number of the application. This indicates which features are supported on the application. For example, generation 1 applications do not support snapshots. Support for snapshots was added at generation 2. Any future generation numbers and their feature set will be documented |
maxdata_on_san |
MAX Data application using SAN. |
|
mongo_db_on_san |
MongoDB using SAN. |
|
name |
string |
Application Name. This field is user supplied when the application is created. Required in the POST body |
nas |
A generic NAS application. |
|
oracle_on_nfs |
Oracle using NFS. |
|
oracle_on_san |
Oracle using SAN. |
|
oracle_rac_on_nfs |
Oracle RAC using NFS. |
|
oracle_rac_on_san |
Oracle RAC using SAN. |
|
protection_granularity |
string |
Protection granularity determines the scope of Snapshot operations for the application. Possible values are "application" and "component". If the value is "application", Snapshot operations are performed on the entire application. If the value is "component", Snapshot operations are performed separately on the application components |
rpo |
||
san |
A generic SAN application. |
|
sql_on_san |
Microsoft SQL using SAN. |
|
sql_on_smb |
Microsoft SQL using SMB. |
|
state |
string |
The state of the application. For full functionality, applications must be in the online state. Other states indicate that the application is in a transient state and not all operations are supported |
statistics |
||
svm |
||
template |
||
uuid |
string |
Application UUID. This field is generated when the application is created. Required in the URL |
vdi_on_nas |
A VDI application using NAS. |
|
vdi_on_san |
A VDI application using SAN. |
|
vsi_on_nas |
A VSI application using NAS. |
|
vsi_on_san |
A VSI application using SAN. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
},
"snapshots": {
"href": "/api/resourcelink"
}
},
"creation_timestamp": "string",
"generation": 0,
"maxdata_on_san": {
"app_type": "mongodb",
"application_components": {
"file_system": "generic",
"host_management_url": "string",
"metadata": {
},
"protection_type": {
"local_rpo": "6_hourly",
"remote_rpo": "6_hourly"
},
"storage_service": {
"name": "extreme"
}
},
"metadata": {
},
"new_igroups": {
"initiators": {
},
"os_type": "aix",
"protocol": "fcp"
},
"ocsm_url": "string",
"os_type": "aix"
},
"mongo_db_on_san": {
"dataset": {
"storage_service": {
"name": "extreme"
}
},
"new_igroups": {
"initiators": {
},
"os_type": "hyper_v",
"protocol": "fcp"
},
"os_type": "hyper_v",
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"secondary_igroups": {
}
},
"nas": {
"application_components": {
"storage_service": {
"name": "extreme"
}
},
"cifs_access": {
"access": "change"
},
"nfs_access": {
"access": "none"
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
}
},
"oracle_on_nfs": {
"archive_log": {
"storage_service": {
"name": "extreme"
}
},
"db": {
"storage_service": {
"name": "extreme"
}
},
"nfs_access": {
"access": "none"
},
"ora_home": {
"storage_service": {
"name": "extreme"
}
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"redo_log": {
"storage_service": {
"name": "extreme"
}
}
},
"oracle_on_san": {
"archive_log": {
"storage_service": {
"name": "extreme"
}
},
"db": {
"storage_service": {
"name": "extreme"
}
},
"new_igroups": {
"initiators": {
},
"os_type": "aix",
"protocol": "fcp"
},
"ora_home": {
"storage_service": {
"name": "extreme"
}
},
"os_type": "aix",
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"redo_log": {
"storage_service": {
"name": "extreme"
}
}
},
"oracle_rac_on_nfs": {
"archive_log": {
"storage_service": {
"name": "extreme"
}
},
"db": {
"storage_service": {
"name": "extreme"
}
},
"grid_binary": {
"storage_service": {
"name": "extreme"
}
},
"nfs_access": {
"access": "none"
},
"ora_home": {
"storage_service": {
"name": "extreme"
}
},
"oracle_crs": {
"storage_service": {
"name": "extreme"
}
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"redo_log": {
"storage_service": {
"name": "extreme"
}
}
},
"oracle_rac_on_san": {
"archive_log": {
"storage_service": {
"name": "extreme"
}
},
"db": {
"storage_service": {
"name": "extreme"
}
},
"db_sids": {
},
"grid_binary": {
"storage_service": {
"name": "extreme"
}
},
"new_igroups": {
"initiators": {
},
"os_type": "aix",
"protocol": "fcp"
},
"ora_home": {
"storage_service": {
"name": "extreme"
}
},
"oracle_crs": {
"storage_service": {
"name": "extreme"
}
},
"os_type": "aix",
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"redo_log": {
"storage_service": {
"name": "extreme"
}
}
},
"protection_granularity": "application",
"rpo": {
"components": {
"name": "string",
"rpo": {
"local": {
"description": "string",
"name": "6_hourly"
},
"remote": {
"description": "string",
"name": "6_hourly"
}
},
"uuid": "string"
},
"local": {
"description": "string",
"name": "6_hourly"
},
"remote": {
"description": "string",
"name": "6_hourly"
}
},
"san": {
"application_components": {
"storage_service": {
"name": "extreme"
}
},
"new_igroups": {
"initiators": {
},
"os_type": "aix",
"protocol": "fcp"
},
"os_type": "aix",
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
}
},
"sql_on_san": {
"db": {
"storage_service": {
"name": "extreme"
}
},
"log": {
"storage_service": {
"name": "extreme"
}
},
"new_igroups": {
"initiators": {
},
"os_type": "hyper_v",
"protocol": "fcp"
},
"os_type": "windows",
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"temp_db": {
"storage_service": {
"name": "extreme"
}
}
},
"sql_on_smb": {
"db": {
"storage_service": {
"name": "extreme"
}
},
"log": {
"storage_service": {
"name": "extreme"
}
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
},
"temp_db": {
"storage_service": {
"name": "extreme"
}
}
},
"state": "creating",
"statistics": {
"components": {
"iops": {
"per_tb": 0,
"total": 0
},
"latency": {
"average": 0,
"raw": 0
},
"name": "string",
"snapshot": {
"reserve": 0,
"used": 0
},
"space": {
"available": 0,
"logical_used": 0,
"provisioned": 0,
"reserved_unused": 0,
"savings": 0,
"used": 0,
"used_excluding_reserves": 0,
"used_percent": 0
},
"storage_service": {
"name": "string",
"uuid": "string"
},
"uuid": "string"
},
"iops": {
"per_tb": 0,
"total": 0
},
"latency": {
"average": 0,
"raw": 0
},
"snapshot": {
"reserve": 0,
"used": 0
},
"space": {
"available": 0,
"logical_used": 0,
"provisioned": 0,
"reserved_unused": 0,
"savings": 0,
"used": 0,
"used_excluding_reserves": 0,
"used_percent": 0
}
},
"template": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"protocol": "nas",
"version": 0
},
"uuid": "string",
"vdi_on_nas": {
"desktops": {
"storage_service": {
"name": "extreme"
}
},
"nfs_access": {
"access": "none"
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
}
},
"vdi_on_san": {
"desktops": {
"storage_service": {
"name": "extreme"
}
},
"hypervisor": "hyper_v",
"new_igroups": {
"initiators": {
},
"protocol": "fcp"
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
}
},
"vsi_on_nas": {
"datastore": {
"storage_service": {
"name": "extreme"
}
},
"nfs_access": {
"access": "none"
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
}
},
"vsi_on_san": {
"datastore": {
"storage_service": {
"name": "extreme"
}
},
"hypervisor": "hyper_v",
"new_igroups": {
"initiators": {
},
"protocol": "fcp"
},
"protection_type": {
"local_rpo": "hourly",
"remote_rpo": "none"
}
}
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": {
"code": "string",
"message": "string"
},
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
||
snapshots |
metadata
| Name | Type | Description |
|---|---|---|
key |
string |
Key to look up metadata associated with an application component. Optional in the POST body |
value |
string |
Value associated with the key. Optional in the POST body |
protection_type
| Name | Type | Description |
|---|---|---|
local_rpo |
string |
The local rpo of the application component. Optional in the POST or PATCH body |
remote_rpo |
string |
The remote rpo of the application component. Optional in the POST or PATCH body |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the application component. Optional in the POST or PATCH body |
maxdata_on_san_application_components
application-components
| Name | Type | Description |
|---|---|---|
file_system |
string |
Defines the kind of file system that will be installed on this application component. Optional in the POST body |
host_management_url |
string |
The host management URL for this application component |
host_name |
string |
FQDN of the L2 host that contains the hot tier of this application component. Required in the POST body |
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
lun_count |
integer |
The number of LUNs in the application component. Required in the POST body |
metadata |
array[metadata] |
|
name |
string |
The name of the application component. Required in the POST body and optional in the PATCH body |
protection_type |
||
storage_service |
||
total_size |
integer |
The total size of the application component, split across the member LUNs. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body |
metadata
| Name | Type | Description |
|---|---|---|
key |
string |
Key to look up metadata associated with an application. Optional in the POST body |
value |
string |
Value associated with the key. Optional in the POST body |
maxdata_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
maxdata_on_san
MAX Data application using SAN.
| Name | Type | Description |
|---|---|---|
app_type |
string |
Type of the application that is being deployed on the L2. Required in the POST body |
application_components |
application-components. Optional in the POST or PATCH body |
|
metadata |
array[metadata] |
|
new_igroups |
array[maxdata_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
ocsm_url |
string |
The OnCommand System Manager URL for this application |
os_type |
string |
The name of the host OS running the application. Required in the POST body |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the database. Optional in the POST or PATCH body |
dataset
| Name | Type | Description |
|---|---|---|
element_count |
integer |
The number of storage elements (LUNs for SAN) of the database to maintain. Must be an even number between 2 and 16. Odd numbers will be rounded up to the next even number within range. Optional in the POST body |
replication_factor |
integer |
The number of data bearing members of the replicaset, including 1 primary and at least 1 secondary. Optional in the POST body |
size |
integer |
The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
mongo_db_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
protection_type
| Name | Type | Description |
|---|---|---|
local_rpo |
string |
The local rpo of the application. Optional in the POST or PATCH body |
remote_rpo |
string |
The remote rpo of the application. Optional in the POST body |
secondary_igroups
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the initiator group for each secondary. Optional in the POST or PATCH body |
mongo_db_on_san
MongoDB using SAN.
| Name | Type | Description |
|---|---|---|
dataset |
||
new_igroups |
array[mongo_db_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
os_type |
string |
The name of the host OS running the application. Optional in the POST body |
primary_igroup_name |
string |
The initiator group for the primary. Required in the POST body and optional in the PATCH body |
protection_type |
||
secondary_igroups |
array[secondary_igroups] |
application_components
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the application component. Optional in the POST or PATCH body |
share_count |
integer |
The number of shares in the application component. Optional in the POST body |
storage_service |
||
total_size |
integer |
The total size of the application component, split across the member shares. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
app_cifs_access
The list of CIFS access controls.
| Name | Type | Description |
|---|---|---|
access |
string |
The CIFS access granted to the user or group. Optional in the POST body |
user_or_group |
string |
The name of the CIFS user or group that will be granted access. Optional in the POST body |
app_nfs_access
The list of NFS access controls.
| Name | Type | Description |
|---|---|---|
access |
string |
The NFS access granted. Optional in the POST body |
host |
string |
The name of the NFS entity granted access. Optional in the POST body |
nas
A generic NAS application.
| Name | Type | Description |
|---|---|---|
application_components |
array[application_components] |
|
cifs_access |
array[app_cifs_access] |
The list of CIFS access controls. Optional in the POST body |
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
protection_type |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the archive log. Optional in the POST or PATCH body |
archive_log
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the archive log. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
db
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the ORACLE_HOME storage volume. Optional in the POST or PATCH body |
ora_home
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the ORACLE_HOME storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the redo log group. Optional in the POST or PATCH body |
redo_log
| Name | Type | Description |
|---|---|---|
mirrored |
boolean |
Should the redo log group be mirrored? Optional in the POST body |
size |
integer |
The size of the redo log group. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
oracle_on_nfs
Oracle using NFS.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
ora_home |
||
protection_type |
||
redo_log |
oracle_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
oracle_on_san
Oracle using SAN.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
new_igroups |
array[oracle_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
ora_home |
||
os_type |
string |
The name of the host OS running the application. Required in the POST body |
protection_type |
||
redo_log |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the Oracle grid binary storage volume. Optional in the POST or PATCH body |
grid_binary
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the Oracle grid binary storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the Oracle CRS volume. Optional in the POST or PATCH body |
oracle_crs
| Name | Type | Description |
|---|---|---|
copies |
integer |
The number of CRS volumes. Optional in the POST body |
size |
integer |
The size of the Oracle CRS/voting storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST body |
storage_service |
oracle_rac_on_nfs
Oracle RAC using NFS.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
grid_binary |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
ora_home |
||
oracle_crs |
||
protection_type |
||
redo_log |
db_sids
| Name | Type | Description |
|---|---|---|
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Optional in the POST or PATCH body |
oracle_rac_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
oracle_rac_on_san
Oracle RAC using SAN.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
db_sids |
array[db_sids] |
|
grid_binary |
||
new_igroups |
The list of initiator groups to create. Optional in the POST or PATCH body |
|
ora_home |
||
oracle_crs |
||
os_type |
string |
The name of the host OS running the application. Required in the POST body |
protection_type |
||
redo_log |
local
| Name | Type | Description |
|---|---|---|
description |
string |
A detailed description of the local RPO. This will include details about the snapshot schedule |
name |
string |
The local RPO of the component. This indicates how often component snapshots are automatically created |
remote
| Name | Type | Description |
|---|---|---|
description |
string |
A detailed description of the remote RPO |
name |
string |
The remote RPO of the component. A remote RPO of zero indicates that the component is synchronously replicated to another cluster |
rpo
| Name | Type | Description |
|---|---|---|
local |
||
remote |
components
| Name | Type | Description |
|---|---|---|
name |
string |
Component Name |
rpo |
||
uuid |
string |
Component UUID |
local
| Name | Type | Description |
|---|---|---|
description |
string |
A detailed description of the local RPO. This will include details about the snapshot schedule |
name |
string |
The local RPO of the application. This indicates how often application snapshots are automatically created |
remote
| Name | Type | Description |
|---|---|---|
description |
string |
A detailed description of the remote RPO |
name |
string |
The remote RPO of the application. A remote RPO of zero indicates that the application is synchronously replicated to another cluster |
rpo
| Name | Type | Description |
|---|---|---|
components |
array[components] |
|
is_supported |
boolean |
Is RPO supported for this application? Generation 1 applications did not support snapshots or MetroCluster |
local |
||
remote |
application_components
| Name | Type | Description |
|---|---|---|
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Optional in the POST or PATCH body |
lun_count |
integer |
The number of LUNs in the application component. Optional in the POST body |
name |
string |
The name of the application component. Optional in the POST or PATCH body |
storage_service |
||
total_size |
integer |
The total size of the application component, split across the member LUNs. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
san
A generic SAN application.
| Name | Type | Description |
|---|---|---|
application_components |
array[application_components] |
|
new_igroups |
array[san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
os_type |
string |
The name of the host OS running the application. Required in the POST body |
protection_type |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the db. Optional in the POST or PATCH body |
db
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the db. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the log db. Optional in the POST or PATCH body |
log
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the log db. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
sql_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the temp db. Optional in the POST or PATCH body |
temp_db
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the temp db. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
sql_on_san
Microsoft SQL using SAN.
| Name | Type | Description |
|---|---|---|
db |
||
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
log |
||
new_igroups |
array[sql_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
os_type |
string |
The name of the host OS running the application. Optional in the POST body |
protection_type |
||
server_cores_count |
integer |
The number of server cores for the db. Optional in the POST body |
temp_db |
access
| Name | Type | Description |
|---|---|---|
installer |
string |
SQL installer admin user name. Optional in the POST body |
service_account |
string |
SQL service account user name. Required in the POST body |
sql_on_smb
Microsoft SQL using SMB.
| Name | Type | Description |
|---|---|---|
access |
||
db |
||
log |
||
protection_type |
||
server_cores_count |
integer |
The number of server cores for the db. Optional in the POST body |
temp_db |
iops
| Name | Type | Description |
|---|---|---|
per_tb |
integer |
The number of IOPS per terabyte of logical space currently being used by the application component |
total |
integer |
The total number of IOPS being used by the application component |
latency
| Name | Type | Description |
|---|---|---|
average |
integer |
The cumulative average response time in microseconds for this component |
raw |
integer |
The cumulative response time in microseconds for this component |
snapshot
| Name | Type | Description |
|---|---|---|
reserve |
integer |
The amount of space reserved by the system for snapshots |
used |
integer |
The amount of spacing currently in use by the system to store snapshots |
space
| Name | Type | Description |
|---|---|---|
available |
integer |
The available amount of space left in the application component. Note that this field has limited meaning for SAN applications. Space may be considered used from ONTAP's perspective while the host filesystem still considers it available
|
logical_used |
integer |
The amount of space that would currently be used if no space saving features were enabled. For example, if compression were the only space saving feature enabled, this field would represent the uncompressed amount of space used |
provisioned |
integer |
The originally requested amount of space that was provisioned for the application component |
reserved_unused |
integer |
The amount of space reserved for system features such as snapshots that has not yet been used |
savings |
integer |
The amount of space saved by all enabled space saving features |
used |
integer |
The amount of space that is currently being used by the application component. Note that this includes any space reserved by the system for features such as snapshots |
used_excluding_reserves |
integer |
The amount of space that is currently being used, excluding any space that is reserved by the system for features such as snapshots |
used_percent |
integer |
The percentage of the originally provisioned space that is currently being used by the application component |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service name. AFF systems support the extreme storage service. All other systems only support value |
uuid |
string |
The storage service UUID |
components
| Name | Type | Description |
|---|---|---|
iops |
||
latency |
||
name |
string |
Component Name |
shared_storage_pool |
boolean |
An application component is considered to use a shared storage pool if storage elements for for other components reside on the same aggregate as storage elements for this component |
snapshot |
||
space |
||
statistics_incomplete |
boolean |
If not all storage elements of the application component are currently available, the returned statistics might only include data from those elements that were available |
storage_service |
||
uuid |
string |
Component UUID |
iops
| Name | Type | Description |
|---|---|---|
per_tb |
integer |
The number of IOPS per terabyte of logical space currently being used by the application |
total |
integer |
The total number of IOPS being used by the application |
latency
| Name | Type | Description |
|---|---|---|
average |
integer |
The cumulative average response time in microseconds for this application |
raw |
integer |
The cumulative response time in microseconds for this application |
space
| Name | Type | Description |
|---|---|---|
available |
integer |
The available amount of space left in the application. Note that this field has limited meaning for SAN applications. Space may be considered used from ONTAP's perspective while the host filesystem still considers it available
|
logical_used |
integer |
The amount of space that would currently be used if no space saving features were enabled. For example, if compression were the only space saving feature enabled, this field would represent the uncompressed amount of space used |
provisioned |
integer |
The originally requested amount of space that was provisioned for the application |
reserved_unused |
integer |
The amount of space reserved for system features such as snapshots that has not yet been used |
savings |
integer |
The amount of space saved by all enabled space saving features |
used |
integer |
The amount of space that is currently being used by the application. Note that this includes any space reserved by the system for features such as snapshots |
used_excluding_reserves |
integer |
The amount of space that is currently being used, excluding any space that is reserved by the system for features such as snapshots |
used_percent |
integer |
The percentage of the originally provisioned space that is currently being used by the application |
statistics
| Name | Type | Description |
|---|---|---|
components |
array[components] |
|
iops |
||
latency |
||
shared_storage_pool |
boolean |
An application is considered to use a shared storage pool if storage elements for multiple components reside on the same aggregate |
snapshot |
||
space |
||
statistics_incomplete |
boolean |
If not all storage elements of the application are currently available, the returned statistics might only include data from those elements that were available |
svm
| Name | Type | Description |
|---|---|---|
name |
string |
SVM Name. Either the SVM name or UUID must be provided to create an application. Optional in the POST body |
uuid |
string |
SVM UUID. Either the SVM name or UUID must be provided to create an application. Optional in the POST body |
self_link
| Name | Type | Description |
|---|---|---|
self |
template
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the template that was used to provision this application. Optional in the POST body |
protocol |
string |
The protocol access of the template that was used to provision this application |
version |
integer |
The version of the template that was used to provision this application. The template version changes only if the layout of the application changes over time. For example, redo logs in Oracle RAC templates were updated and provisioned differently in DATA ONTAP 9.3.0 compared to prior releases, so the version number was increased. If layouts change in the future, the changes will be documented along with the corresponding version numbers
|
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the desktops. Optional in the POST or PATCH body |
desktops
| Name | Type | Description |
|---|---|---|
count |
integer |
The number of desktops to support. Optional in the POST or PATCH body |
size |
integer |
The size of the desktops. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body |
storage_service |
hyper_v_access
| Name | Type | Description |
|---|---|---|
service_account |
string |
Hyper-V service account. Optional in the POST body |
vdi_on_nas
A VDI application using NAS.
| Name | Type | Description |
|---|---|---|
desktops |
||
hyper_v_access |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
protection_type |
vdi_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
vdi_on_san
A VDI application using SAN.
| Name | Type | Description |
|---|---|---|
desktops |
||
hypervisor |
string |
The name of the hypervisor hosting the application. Required in the POST body |
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
new_igroups |
array[vdi_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
protection_type |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the datastore. Optional in the POST or PATCH body |
datastore
| Name | Type | Description |
|---|---|---|
count |
integer |
The number of datastores to support. Optional in the POST or PATCH body |
size |
integer |
The size of the datastore. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body |
storage_service |
vsi_on_nas
A VSI application using NAS.
| Name | Type | Description |
|---|---|---|
datastore |
||
hyper_v_access |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
protection_type |
vsi_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
vsi_on_san
A VSI application using SAN.
| Name | Type | Description |
|---|---|---|
datastore |
||
hypervisor |
string |
The name of the hypervisor hosting the application. Required in the POST body |
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
new_igroups |
array[vsi_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
protection_type |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |