Update application properties

Overview

Similar to creating an application, modification is done using the template properties of an application. The storage_service, size, and igroup_name of an application may be modified.

`storage_service`

Storage service modifications are processed in place, meaning that the storage can not be moved to a location with more performance headroom to accommodate the request. If the current backing storage of the application is in a location that can support increased performance, the QoS policies associated with the application will be modified to allow it. If not, an error will be returned. A storage service modification to a lower tier of performance is always allowed, but the reverse modification may not be supported if the cluster is over provisioned and the cluster is unlikely to be able to fulfil the original storage service.

`size`

Size modifications are processed in a variety of ways depending on the type of application. For NAS applications, volumes are grown or new volumes are added. For SAN applications, LUNs are grown, new LUNs are added to existing volumes, or new LUNs are added to new volumes. If new storage elements are created, they can be found using the GET /application/applications/{application.uuid}/components interface. The creation time of each storage object is included, and the newly created objects will use the same naming scheme as the previous objects. Resize follows the best practices associated with the type of application being expanded. Reducing the size of an application is not supported.

`igroup_name`

Modification of the igroup name allows an entire application to be mapped from one initiator group to another. Data access will be interrupted as the LUNs are unmapped from the original igroup and remapped to the new one.

Application state

During a modification, the state property of the application updates to indicate modifying. In modifying state, statistics are not available and snapshot operations are not allowed. If the modification fails, it is possible for the application to be left in an inconsistent state, with the underlying ONTAP storage elements not matching across a component. When this occurs, the application is left in the modifying state until the command is either retried and succeeds or a call to restore the original state is successful.

Examples

Change the storage service of the database of the Oracle application to extreme and resize the redo logs to 100GB.

  {
 "oracle_on_nfs": {
   "db": {
     "storage_service": {
       "name": "extreme"
     }
   },
   "redo_log": {
     "size": "100GB"
   }
 }
  }

Change the storage service, size, and igroup of a generic application by component name.

  {
 "san": {
   "application_components": [
     {
       "name": "component1",
       "storage_service": {
         "name": "value"
       }
     },
     {
       "name": "component2",
       "size": "200GB"
     },
     {
       "name": "component3",
       "igroup_name": "igroup5"
     }
   ]
 }
  }

Learn more

Parameters

Name	Type	In	Required	Description
uuid	string	path	True	Application UUID
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202. Default value: 1 Max value: 120 Min value: 0

Name

Type

In

Required

Description

uuid

string

path

True

Application UUID

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

Default value: 1
Max value: 120
Min value: 0

Request Body

Name	Type	Description
_links	_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 Snapshot copies. Support for Snapshot copies was added at generation 2. Any future generation numbers and their feature set will be documented.
mongo_db_on_san	mongo_db_on_san	MongoDB using SAN.
nas	nas	A generic NAS application.
nvme	zapp_nvme	An NVME application.
oracle_on_nfs	oracle_on_nfs	Oracle using NFS.
oracle_on_san	oracle_on_san	Oracle using SAN.
oracle_rac_on_nfs	oracle_rac_on_nfs	Oracle RAC using NFS.
oracle_rac_on_san	oracle_rac_on_san	Oracle RAC using SAN.
protection_granularity	string	Protection granularity determines the scope of Snapshot copy operations for the application. Possible values are "application" and "component". If the value is "application", Snapshot copy operations are performed on the entire application. If the value is "component", Snapshot copy operations are performed separately on the application components.
rpo	rpo
s3_bucket	zapp_s3_bucket	A generic S3 bucket application.
san	san	A generic SAN application.
sql_on_san	sql_on_san	Microsoft SQL using SAN.
sql_on_smb	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	statistics
template	template
uuid	string	Application UUID. This field is generated when the application is created.
vdi_on_nas	vdi_on_nas	A VDI application using NAS.
vdi_on_san	vdi_on_san	A VDI application using SAN.
vsi_on_nas	vsi_on_nas	A VSI application using NAS.
vsi_on_san	vsi_on_san	A VSI application using SAN.

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 Snapshot copies. Support for Snapshot copies was added at generation 2. Any future generation numbers and their feature set will be documented.

mongo_db_on_san

MongoDB using SAN.

nas

A generic NAS application.

nvme

zapp_nvme

An NVME 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 copy operations for the application. Possible values are "application" and "component". If the value is "application", Snapshot copy operations are performed on the entire application. If the value is "component", Snapshot copy operations are performed separately on the application components.

rpo

s3_bucket

zapp_s3_bucket

A generic S3 bucket application.

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

template

uuid

string

Application UUID. This field is generated when the application is created.

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.

Response

Status: 200, Ok

Name	Type	Description
job	job_link

Name

Type

Description

job

job_link

Example response

{
  "job": {
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default, Error

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

storage_service

Name	Type	Description
name	string	The storage service of the database.

Name

Type

Description

name

string

The storage service of the database.

dataset

Name	Type	Description
size	integer	The size of the database. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

size

integer

The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

igroups

Name	Type	Description
name	string	The name of an igroup to nest within a parent igroup. Mutually exclusive with initiators and initiator_objects.
uuid	string	The UUID of an igroup to nest within a parent igroup Usage: <UUID>

Name

Type

Description

name

string

The name of an igroup to nest within a parent igroup. Mutually exclusive with initiators and initiator_objects.

uuid

string

The UUID of an igroup to nest within a parent igroup Usage: <UUID>

initiator_objects

Name	Type	Description
comment	string	A comment available for use by the administrator.
name	string	The WWPN, IQN, or Alias of the initiator. Mutually exclusive with nested igroups and the initiators array.

Name

Type

Description

comment

string

A comment available for use by the administrator.

name

string

The WWPN, IQN, or Alias of the initiator. Mutually exclusive with nested igroups and the initiators array.

mongo_db_on_san_new_igroups

The list of initiator groups to create.

Name	Type	Description
comment	string	A comment available for use by the administrator.
igroups	array[igroups]
initiator_objects	array[initiator_objects]
initiators	array[string]
name	string	The name of the new initiator group.
os_type	string	The name of the host OS accessing the application. The default value is the host OS that is running the application.
protocol	string	The protocol of the new initiator group.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

os_type

string

The name of the host OS accessing the application. The default value is the host OS that is running the application.

protocol

string

The protocol of the new initiator group.

protection_type

Name	Type	Description
local_rpo	string	The local RPO of the application.

Name

Type

Description

local_rpo

string

The local RPO of the application.

secondary_igroups

Name	Type	Description
name	string	The name of the initiator group for each secondary.

Name

Type

Description

name

string

The name of the initiator group for each secondary.

mongo_db_on_san

MongoDB using SAN.

Name	Type	Description
dataset	dataset
new_igroups	array[mongo_db_on_san_new_igroups]	The list of initiator groups to create.
primary_igroup_name	string	The initiator group for the primary.
protection_type	protection_type
secondary_igroups	array[secondary_igroups]

Name

Type

Description

dataset

new_igroups

array[mongo_db_on_san_new_igroups]

The list of initiator groups to create.

primary_igroup_name

string

The initiator group for the primary.

protection_type

secondary_igroups

array[secondary_igroups]

export_policy

component

svm

origin

flexcache

policy

qos

retention

snaplock

storage_service

Name	Type	Description
name	string	The storage service of the application component.

Name

Type

Description

name

string

The storage service of the application component.

object_stores

nas_application_components_tiering

application-components.tiering

application_components

Name	Type	Description
name	string	The name of the application component.
storage_service	storage_service
tiering	nas_application_components_tiering	application-components.tiering
total_size	integer	The total size of the application component, split across the member shares. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}

Name

Type

Description

name

string

The name of the application component.

storage_service

tiering

nas_application_components_tiering

application-components.tiering

total_size

integer

The total size of the application component, split across the member shares. Usage: {<integer>[KB|MB|GB|TB|PB]}

app_cifs_access

The list of CIFS access controls. You must provide either 'user_or_group' or 'access' to enable CIFS access.

exclude_aggregates

app_nfs_access

The list of NFS access controls. You must provide either 'host' or 'access' to enable NFS access.

nas

A generic NAS application.

Name	Type	Description
application_components	array[application_components]
protection_type	protection_type

Name

Type

Description

application_components

array[application_components]

protection_type

performance

Name	Type	Description
storage_service	storage_service

Name

Type

Description

storage_service

dh_hmac_chap

Name	Type	Description
controller_secret_key	string	Authentication Controller Secret.
group_size	string	Authentication Diffie-Hellman Group.
hash_function	string	Authentication Hash Function.
host_secret_key	string	Authentication Host Secret.

Name

Type

Description

controller_secret_key

string

Authentication Controller Secret.

group_size

string

Authentication Diffie-Hellman Group.

hash_function

string

Authentication Hash Function.

host_secret_key

string

Authentication Host Secret.

hosts

Name	Type	Description
dh_hmac_chap	dh_hmac_chap
nqn	string	The host NQN.
priority	string	Host Priority.

Name

Type

Description

dh_hmac_chap

nqn

string

The host NQN.

priority

string

Host Priority.

zapp_nvme_components_subsystem

components.subsystem

Name	Type	Description
hosts	array[hosts]
name	string	The name of the subsystem accessing the component. If neither the name nor the UUID is provided, the name defaults to <application-name>_<component-name>, whether that subsystem already exists or not.
os_type	string	The name of the host OS accessing the component. The default value is the host OS that is running the application.
uuid	string	The UUID of an existing subsystem to be granted access to the component.

Name

Type

Description

hosts

array[hosts]

name

string

The name of the subsystem accessing the component. If neither the name nor the UUID is provided, the name defaults to <application-name>_<component-name>, whether that subsystem already exists or not.

os_type

string

The name of the host OS accessing the component. The default value is the host OS that is running the application.

uuid

string

The UUID of an existing subsystem to be granted access to the component.

zapp_nvme_components_tiering

application-components.tiering

components

Name	Type	Description
name	string	The name of the application component.
namespace_count	integer	The number of namespaces supported per request, with a total limit of 1024 per volume.
os_type	string	The name of the host OS running the application.
performance	performance
subsystem	zapp_nvme_components_subsystem	components.subsystem
tiering	zapp_nvme_components_tiering	application-components.tiering
total_size	integer	The total size of the component, spread across member namespaces. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}

Name

Type

Description

name

string

The name of the application component.

namespace_count

integer

The number of namespaces supported per request, with a total limit of 1024 per volume.

os_type

string

The name of the host OS running the application.

performance

subsystem

zapp_nvme_components_subsystem

components.subsystem

tiering

zapp_nvme_components_tiering

application-components.tiering

total_size

integer

The total size of the component, spread across member namespaces. Usage: {<integer>[KB|MB|GB|TB|PB]}

local

Name	Type	Description
name	string	The local RPO of the application.

Name

Type

Description

name

string

The local RPO of the application.

remote

rpo

Name	Type	Description
local	local

Name

Type

Description

local

zapp_nvme

An NVME application.

Name	Type	Description
components	array[components]
rpo	rpo

Name

Type

Description

components

array[components]

rpo

storage_service

Name	Type	Description
name	string	The storage service of the archive log.

Name

Type

Description

name

string

The storage service of the archive log.

archive_log

Name	Type	Description
size	integer	The size of the archive log. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

size

integer

The size of the archive log. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

db

Name	Type	Description
size	integer	The size of the database. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

size

integer

The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

Name	Type	Description
name	string	The storage service of the ORACLE_HOME storage volume.

Name

Type

Description

name

string

The storage service of the ORACLE_HOME storage volume.

ora_home

Name	Type	Description
size	integer	The size of the ORACLE_HOME storage volume. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

size

integer

The size of the ORACLE_HOME storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

Name	Type	Description
name	string	The storage service of the redo log group.

Name

Type

Description

name

string

The storage service of the redo log group.

redo_log

Name	Type	Description
size	integer	The size of the redo log group. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

size

integer

The size of the redo log group. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

oracle_on_nfs

Oracle using NFS.

Name	Type	Description
archive_log	archive_log
db	db
ora_home	ora_home
protection_type	protection_type
redo_log	redo_log

Name

Type

Description

archive_log

db

ora_home

protection_type

redo_log

oracle_on_san_new_igroups

The list of initiator groups to create.

Name	Type	Description
comment	string	A comment available for use by the administrator.
igroups	array[igroups]
initiator_objects	array[initiator_objects]
initiators	array[string]
name	string	The name of the new initiator group.
os_type	string	The name of the host OS accessing the application. The default value is the host OS that is running the application.
protocol	string	The protocol of the new initiator group.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

os_type

string

The name of the host OS accessing the application. The default value is the host OS that is running the application.

protocol

string

The protocol of the new initiator group.

oracle_on_san

Oracle using SAN.

Name	Type	Description
archive_log	archive_log
db	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.
new_igroups	array[oracle_on_san_new_igroups]	The list of initiator groups to create.
ora_home	ora_home
protection_type	protection_type
redo_log	redo_log

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.

new_igroups

array[oracle_on_san_new_igroups]

The list of initiator groups to create.

ora_home

protection_type

redo_log

storage_service

Name	Type	Description
name	string	The storage service of the Oracle grid binary storage volume.

Name

Type

Description

name

string

The storage service of the Oracle grid binary storage volume.

grid_binary

Name	Type	Description
size	integer	The size of the Oracle grid binary storage volume. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

size

integer

The size of the Oracle grid binary storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

Name	Type	Description
name	string	The storage service of the Oracle CRS volume.

Name

Type

Description

name

string

The storage service of the Oracle CRS volume.

oracle_crs

Name	Type	Description
storage_service	storage_service

Name

Type

Description

storage_service

oracle_rac_on_nfs

Oracle RAC using NFS.

Name	Type	Description
archive_log	archive_log
db	db
grid_binary	grid_binary
ora_home	ora_home
oracle_crs	oracle_crs
protection_type	protection_type
redo_log	redo_log

Name

Type

Description

archive_log

db

grid_binary

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.

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.

oracle_rac_on_san_new_igroups

The list of initiator groups to create.

Name	Type	Description
comment	string	A comment available for use by the administrator.
igroups	array[igroups]
initiator_objects	array[initiator_objects]
initiators	array[string]
name	string	The name of the new initiator group.
os_type	string	The name of the host OS accessing the application. The default value is the host OS that is running the application.
protocol	string	The protocol of the new initiator group.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

os_type

string

The name of the host OS accessing the application. The default value is the host OS that is running the application.

protocol

string

The protocol of the new initiator group.

oracle_rac_on_san

Oracle RAC using SAN.

Name	Type	Description
archive_log	archive_log
db	db
db_sids	array[db_sids]
grid_binary	grid_binary
new_igroups	array[oracle_rac_on_san_new_igroups]	The list of initiator groups to create.
ora_home	ora_home
oracle_crs	oracle_crs
protection_type	protection_type
redo_log	redo_log

Name

Type

Description

archive_log

db

db_sids

array[db_sids]

grid_binary

new_igroups

array[oracle_rac_on_san_new_igroups]

The list of initiator groups to create.

ora_home

oracle_crs

protection_type

redo_log

local

Name	Type	Description
description	string	A detailed description of the local RPO. This will include details about the Snapshot copy schedule.
name	string	The local RPO of the component. This indicates how often component Snapshot copies are automatically created.

Name

Type

Description

description

string

A detailed description of the local RPO. This will include details about the Snapshot copy schedule.

name

string

The local RPO of the component. This indicates how often component Snapshot copies 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.

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	local
remote	remote

Name

Type

Description

local

remote

components

Name	Type	Description
name	string	Component Name.
rpo	rpo
uuid	string	Component UUID.

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 copy schedule.
name	string	The local RPO of the application. This indicates how often application Snapshot copies are automatically created.

Name

Type

Description

description

string

A detailed description of the local RPO. This will include details about the Snapshot copy schedule.

name

string

The local RPO of the application. This indicates how often application Snapshot copies 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.

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 Snapshot copies or MetroCluster.
local	local
remote	remote

Name

Type

Description

components

array[components]

is_supported

boolean

Is RPO supported for this application? Generation 1 applications did not support Snapshot copies or MetroCluster.

local

remote

zapp_s3_bucket_application_components_access_policies_conditions

conditions

Name	Type	Description
delimiters	array[string]
max_keys	array[integer]
prefixes	array[string]
source_ips	array[string]
usernames	array[string]

Name

Type

Description

delimiters

array[string]

max_keys

array[integer]

prefixes

array[string]

source_ips

array[string]

usernames

array[string]

zapp_s3_bucket_application_components_access_policies

The list of S3 objectstore policies to be created.

Name	Type	Description
actions	array[string]
principals	array[string]
resources	array[string]

Name

Type

Description

actions

array[string]

principals

array[string]

resources

array[string]

zapp_s3_bucket_application_components

The list of application components to be created.

Name

Type

Description

name

string

The name of the application component.

size

integer

The total size of the S3 Bucket, split across the member components. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

uuid

string

Object Store Server Bucket UUID Usage: <UUID>

zapp_s3_bucket

A generic S3 bucket application.

Name

Type

Description

application_components

array[zapp_s3_bucket_application_components]

The list of application components to be created.

san_application_components_tiering

application-components.tiering

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.

lun_count

integer

The number of LUNs in the application component.

name

string

The name of the application component.

os_type

string

The name of the host OS running the application.

storage_service

tiering

san_application_components_tiering

application-components.tiering

total_size

integer

The total size of the application component, split across the member LUNs. Usage: {<integer>[KB|MB|GB|TB|PB]}

san_new_igroups

The list of initiator groups to create.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

os_type

string

The name of the host OS accessing the application. The default value is the host OS that is running the application.

protocol

string

The protocol of the new initiator group.

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.

protection_type

storage_service

Name

Type

Description

name

string

The storage service of the DB.

db

Name

Type

Description

size

integer

The size of the DB. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

Name

Type

Description

name

string

The storage service of the log DB.

log

Name

Type

Description

size

integer

The size of the log DB. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

sql_on_san_new_igroups

The list of initiator groups to create.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

os_type

string

The name of the host OS accessing the application. The default value is the host OS that is running the application.

protocol

string

The protocol of the new initiator group.

storage_service

Name

Type

Description

name

string

The storage service of the temp DB.

temp_db

Name

Type

Description

size

integer

The size of the temp DB. Usage: {<integer>[KB|MB|GB|TB|PB]}

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.

log

new_igroups

array[sql_on_san_new_igroups]

The list of initiator groups to create.

protection_type

temp_db

access

sql_on_smb

Microsoft SQL using SMB.

Name

Type

Description

db

log

protection_type

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 Snapshot copies.

used

integer

The amount of spacing currently in use by the system to store Snapshot copies.

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.

readOnly: 1
Introduced in: 9.6
x-nullable: true

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 Snapshot copies 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 Snapshot copies.

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 Snapshot copies.

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.

readOnly: 1
Introduced in: 9.6
x-nullable: true

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 Snapshot copies 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 Snapshot copies.

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 Snapshot copies.

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.

self_link

template

Name

Type

Description

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.

readOnly: 1
Introduced in: 9.6
x-nullable: true

storage_service

Name

Type

Description

name

string

The storage service of the desktops.

desktops

Name

Type

Description

count

integer

The number of desktops to support.

storage_service

hyper_v_access

vdi_on_nas

A VDI application using NAS.

Name

Type

Description

desktops

protection_type

vdi_on_san_new_igroups

The list of initiator groups to create.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

protocol

string

The protocol of the new initiator group.

vdi_on_san

A VDI application using SAN.

Name

Type

Description

desktops

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.

new_igroups

array[vdi_on_san_new_igroups]

The list of initiator groups to create.

protection_type

storage_service

Name

Type

Description

name

string

The storage service of the datastore.

datastore

Name

Type

Description

count

integer

The number of datastores to support.

storage_service

vsi_on_nas

A VSI application using NAS.

Name

Type

Description

datastore

protection_type

vsi_on_san_new_igroups

The list of initiator groups to create.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

protocol

string

The protocol of the new initiator group.

vsi_on_san

A VSI application using SAN.

Name

Type

Description

datastore

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.

new_igroups

array[vsi_on_san_new_igroups]

The list of initiator groups to create.

protection_type

application

Applications

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 Snapshot copies. Support for Snapshot copies was added at generation 2. Any future generation numbers and their feature set will be documented.

mongo_db_on_san

MongoDB using SAN.

nas

A generic NAS application.

nvme

zapp_nvme

An NVME 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 copy operations for the application. Possible values are "application" and "component". If the value is "application", Snapshot copy operations are performed on the entire application. If the value is "component", Snapshot copy operations are performed separately on the application components.

rpo

s3_bucket

zapp_s3_bucket

A generic S3 bucket application.

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

template

uuid

string

Application UUID. This field is generated when the application is created.

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.

job_link

Name

Type

Description

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name

Type

Description

code

string

Argument code

message

string

Message argument

returned_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.

Update application properties

Creating your file...

Overview

storage_service

size

igroup_name

Application state

Examples

Learn more

Parameters

Request Body

Response

Response

Error

Definitions

`storage_service`

`size`

`igroup_name`