Skip to main content
A newer release of this product is available.

Retrieve applications

Contributors

GET /application/applications

Introduced In: 9.6

Retrieves applications.

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 Requesting specific fields to learn more.

  • <template> the property corresponding to the template.name of the application

Query examples

Numerous queries are available for classifying and sorting applications:

  1. Return a list of applications sorted by name.

      GET /application/applications?order_by=name
  2. Return a list of applications for a specific SVM.

      GET /application/applications?svm.name=<name>
  3. Return a list of all SQL applications.

      GET /application/applications?template.name=sql*
  4. Return a list of all applications that can be accessed via SAN.

      GET /application/applications?template.protocol=san
  5. Return the top five applications consuming the most IOPS.

      GET /application/applications?order_by=statistics.iops.total desc&max_records=5

The above examples are not comprehensive. There are many more properties available for queries. Also, multiple queries can be mixed and matched with other query parameters for a large variety of requests. See the per-property documentation below for the full list of supported query parameters.

Learn more

Parameters

Name Type In Required Description

uuid

string

query

False

Filter by UUID

name

string

query

False

Filter by name

svm.name

string

query

False

Filter by svm.name

svm.uuid

string

query

False

Filter by svm.uuid

template.name

string

query

False

Filter by template.name

template.version

string

query

False

Filter by template.version

template.protocol

string

query

False

Filter by template.protocol

generation

string

query

False

Filter by generation

state

string

query

False

Filter by state

protection_granularity

string

query

False

Filter by protection granularity

rpo.is_supported

string

query

False

Filter by rpo.is_supported

rpo.local.name

string

query

False

Filter by rpo.local.name

rpo.local.description

string

query

False

Filter by rpo.local.description

rpo.remote.name

string

query

False

Filter by rpo.remote.name

rpo.remote.description

string

query

False

Filter by rpo.remote.description

rpo.components.name

string

query

False

Filter by rpo.components.name

rpo.components.uuid

string

query

False

Filter by rpo.components.uuid

rpo.components.rpo.local.name

string

query

False

Filter by rpo.components.rpo.local.name

  • Introduced in: 9.7

rpo.components.rpo.local.description

string

query

False

Filter by rpo.components.rpo.local.description

rpo.components.rpo.remote.name

string

query

False

Filter by rpo.components.rpo.remote.name

rpo.components.rpo.remote.description

string

query

False

Filter by rpo.components.rpo.remote.description

statistics.space.provisioned

string

query

False

Filter by statistics.space.provisioned

statistics.space.used

string

query

False

Filter by statistics.space.used

statistics.space.used_percent

string

query

False

Filter by statistics.space.used_percent

statistics.space.used_excluding_reserves

string

query

False

Filter by statistics.space.used_excluding_reserves

statistics.space.logical_used

string

query

False

Filter by statistics.space.logical_used

statistics.space.reserved_unused

string

query

False

Filter by statistics.space.reserved_unused

statistics.space.available

string

query

False

Filter by statistics.space.available

statistics.space.savings

string

query

False

Filter by statistics.space.savings

statistics.iops.total

string

query

False

Filter by statistics.iops.total

statistics.iops.per_tb

string

query

False

Filter by statistics.iops.per_tb

statistics.snapshot.reserve

string

query

False

Filter by statistics.snapshot.reserve

statistics.snapshot.used

string

query

False

Filter by statistics.snapshot.used

statistics.latency.raw

string

query

False

Filter by statistics.latency.raw

statistics.latency.average

string

query

False

Filter by statistics.latency.average

statistics.statistics_incomplete

string

query

False

Filter by statistics.statistics_incomplete

statistics.shared_storage_pool

string

query

False

Filter by statistics.shared_storage_pool

statistics.components.name

string

query

False

Filter by statistics.components.name

statistics.components.uuid

string

query

False

Filter by statistics.components.uuid

statistics.components.storage_service.name

string

query

False

Filter by statistics.components.storage_service.name

statistics.components.space.provisioned

string

query

False

Filter by statistics.components.space.provisioned

statistics.components.space.used

string

query

False

Filter by statistics.components.space.used

statistics.components.space.used_percent

string

query

False

Filter by statistics.components.space.used_percent

statistics.components.space.used_excluding_reserves

string

query

False

Filter by statistics.components.space.used_excluding_reserves

statistics.components.space.logical_used

string

query

False

Filter by statistics.components.space.logical_used

statistics.components.space.reserved_unused

string

query

False

Filter by statistics.components.space.reserved_unused

statistics.components.space.available

string

query

False

Filter by statistics.components.space.available

statistics.components.space.savings

string

query

False

Filter by statistics.components.space.savings

statistics.components.iops.total

string

query

False

Filter by statistics.components.iops.total

statistics.components.iops.per_tb

string

query

False

Filter by statistics.components.iops.per_tb

statistics.components.snapshot.reserve

string

query

False

Filter by statistics.components.snapshot.reserve

statistics.components.snapshot.used

string

query

False

Filter by statistics.components.snapshot.used

statistics.components.latency.raw

string

query

False

Filter by statistics.components.latency.raw

statistics.components.latency.average

string

query

False

Filter by statistics.components.latency.average

statistics.components.statistics_incomplete

string

query

False

Filter by statistics.components.statistics_incomplete

statistics.components.shared_storage_pool

string

query

False

Filter by statistics.components.shared_storage_pool

smart_container

string

query

False

Filter by smart_container

  • Introduced in: 9.7

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[application]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        },
        "snapshots": {
          "href": "/api/resourcelink"
        }
      },
      "creation_timestamp": "string",
      "generation": 0,
      "maxdata_on_san": {
        "app_type": "string",
        "application_components": [
          {
          }
        ],
        "metadata": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "new_igroups": [
          {
            "comment": "string",
            "igroups": [
              {
                "name": "string",
                "uuid": "string"
              }
            ],
            "initiator_objects": [
              {
                "comment": "string",
                "name": "string"
              }
            ],
            "initiators": [
              "string"
            ],
            "name": "string",
            "os_type": "string",
            "protocol": "string"
          }
        ],
        "ocsm_url": "string",
        "os_type": "string"
      },
      "name": "string",
      "nas": {
        "application_components": [
          {
          }
        ],
        "cifs_access": [
          {
            "access": "string",
            "user_or_group": "string"
          }
        ],
        "cifs_share_name": "string",
        "exclude_aggregates": [
          {
            "name": "string",
            "uuid": "string"
          }
        ],
        "nfs_access": [
          {
            "access": "string",
            "host": "string"
          }
        ],
        "protection_type": {
          "local_policy": "string",
          "local_rpo": "string",
          "remote_rpo": "string"
        }
      },
      "nvme": {
        "components": [
          {
            "name": "string",
            "os_type": "string",
            "performance": {
              "storage_service": {
                "name": "string"
              }
            },
            "qos": {
              "policy": {
                "name": "string",
                "uuid": "string"
              }
            },
            "subsystem": {
              "hosts": [
                {
                  "nqn": "string"
                }
              ],
              "name": "string",
              "os_type": "string",
              "uuid": "string"
            },
            "tiering": {
              "control": "string",
              "object_stores": [
                {
                  "name": "string"
                }
              ],
              "policy": "string"
            }
          }
        ],
        "os_type": "string",
        "rpo": {
          "local": {
            "name": "string",
            "policy": "string"
          }
        }
      },
      "protection_granularity": "string",
      "rpo": {
        "components": [
          {
            "name": "string",
            "rpo": {
              "local": {
                "description": "string",
                "name": "string"
              },
              "remote": {
                "description": "string",
                "name": "string"
              }
            },
            "uuid": "string"
          }
        ],
        "local": {
          "description": "string",
          "name": "string"
        },
        "remote": {
          "description": "string",
          "name": "string"
        }
      },
      "s3_bucket": {
        "application_components": [
          {
          }
        ]
      },
      "san": {
        "application_components": [
          {
            "igroup_name": "string",
            "name": "string",
            "os_type": "string",
            "qos": {
              "policy": {
                "name": "string",
                "uuid": "string"
              }
            },
            "storage_service": {
              "name": "string"
            },
            "tiering": {
              "control": "string",
              "object_stores": [
                {
                  "name": "string"
                }
              ],
              "policy": "string"
            }
          }
        ],
        "exclude_aggregates": [
          {
            "name": "string",
            "uuid": "string"
          }
        ],
        "new_igroups": [
          {
            "comment": "string",
            "igroups": [
              {
                "name": "string",
                "uuid": "string"
              }
            ],
            "initiator_objects": [
              {
                "comment": "string",
                "name": "string"
              }
            ],
            "initiators": [
              "string"
            ],
            "name": "string",
            "os_type": "string",
            "protocol": "string"
          }
        ],
        "os_type": "string",
        "protection_type": {
          "local_policy": "string",
          "local_rpo": "string",
          "remote_rpo": "string"
        }
      },
      "state": "string",
      "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
        }
      },
      "svm": {
        "name": "string",
        "uuid": "string"
      },
      "template": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "string",
        "protocol": "string",
        "version": 0
      },
      "uuid": "string"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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

Name Type Description

next

href

self

href

Name Type Description

self

href

snapshots

href

metadata

Name Type Description

key

string

Key to look up metadata associated with an application component.

value

string

Value associated with the key.

protection_type

Name Type Description

local_rpo

string

The local rpo of the application component.

remote_rpo

string

The remote rpo of the application component.

storage_service

Name Type Description

name

string

The storage service of the application component.

object_stores

Name Type Description

name

string

The name of the object-store to use.

maxdata_on_san_application_components_tiering

tiering

Name Type Description

control

string

Storage tiering placement rules for the container(s)

object_stores

array[object_stores]

policy

string

The storage tiering type of the application component.

maxdata_on_san_application_components

The list of application components to be created.

Name Type Description

file_system

string

Defines the type of file system that will be installed on this application component.

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.

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.

metadata

array[metadata]

name

string

The name of the application component.

protection_type

protection_type

storage_service

storage_service

tiering

maxdata_on_san_application_components_tiering

tiering

total_size

integer

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

metadata

Name Type Description

key

string

Key to look up metadata associated with an application.

value

string

Value associated with the key.

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>

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.

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

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.

application_components

array[maxdata_on_san_application_components]

The list of application components to be created.

metadata

array[metadata]

new_igroups

array[maxdata_on_san_new_igroups]

The list of initiator groups to create.

ocsm_url

string

The OnCommand System Manager URL for this application.

os_type

string

The name of the host OS running the application.

storage_service

Name Type Description

name

string

The storage service of the database.

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.

replication_factor

integer

The number of data bearing members of the replicaset, including 1 primary and at least 1 secondary.

size

integer

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

storage_service

storage_service

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.

protection_type

Name Type Description

local_rpo

string

The local RPO of the application.

remote_rpo

string

The remote RPO of the application.

secondary_igroups

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.

os_type

string

The name of the host OS running the application.

primary_igroup_name

string

The initiator group for the primary.

protection_type

protection_type

secondary_igroups

array[secondary_igroups]

export_policy

Name Type Description

id

integer

The ID of an existing NFS export policy.

name

string

The name of an existing NFS export policy.

component

Name Type Description

name

string

Name of the source component.

svm

Name Type Description

name

string

Name of the source SVM.

origin

Name Type Description

component

component

svm

svm

flexcache

Name Type Description

dr_cache

boolean

Dr-cache is a FlexCache volume create time option that has the same flexgroup-msid as that of the origin of a FlexCache volume. By default, dr-cache is disabled. The flexgroup-msid of the FlexCache volume does not need to be same as that of the origin of a FlexCache volume.

origin

origin

policy

Name Type Description

name

string

The name of an existing QoS policy.

uuid

string

The UUID of an existing QoS policy. Usage: <UUID>

qos

Name Type Description

policy

policy

nas_application_components_tiering

application-components.tiering

Name Type Description

control

string

Storage tiering placement rules for the container(s)

object_stores

array[object_stores]

policy

string

The storage tiering type of the application component.

application_components

Name Type Description

export_policy

export_policy

flexcache

flexcache

name

string

The name of the application component.

qos

qos

scale_out

boolean

Denotes a Flexgroup.

share_count

integer

The number of shares in 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]}

app_cifs_access

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

Name Type Description

access

string

The CIFS access granted to the user or group.

user_or_group

string

The name of the CIFS user or group that will be granted access.

exclude_aggregates

Name Type Description

name

string

The name of the aggregate to exclude. Usage: <aggregate name>

uuid

string

The ID of the aggregate to exclude. Usage: <UUID>

app_nfs_access

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

Name Type Description

access

string

The NFS access granted.

host

string

The name of the NFS entity granted access.

protection_type

Name Type Description

local_policy

string

The Snapshot copy policy to apply to each volume in the smart container. This property is only supported for smart containers. Usage: <snapshot policy>

local_rpo

string

The local RPO of the application.

remote_rpo

string

The remote RPO of the application.

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. You must provide either 'user_or_group' or 'access' to enable CIFS access.

cifs_share_name

string

The name of the CIFS share. Usage: <Share>

exclude_aggregates

array[exclude_aggregates]

nfs_access

array[app_nfs_access]

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

protection_type

protection_type

performance

Name Type Description

storage_service

storage_service

hosts

Name Type Description

nqn

string

The host NQN.

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. Usage: <UUID>

zapp_nvme_components_tiering

application-components.tiering

Name Type Description

control

string

Storage tiering placement rules for the container(s)

object_stores

array[object_stores]

policy

string

The storage tiering type of the application component.

components

Name Type Description

name

string

The name of the application component.

namespace_count

integer

The number of namespaces in the component.

os_type

string

The name of the host OS running the application.

performance

performance

qos

qos

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.

policy

string

The Snapshot copy policy to apply to each volume in the smart container. This property is only supported for smart containers. Usage: <snapshot policy>

rpo

Name Type Description

local

local

zapp_nvme

An NVME application.

Name Type Description

components

array[components]

os_type

string

The name of the host OS running the application.

rpo

rpo

storage_service

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

db

Name Type Description

size

integer

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

storage_service

storage_service

storage_service

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

storage_service

Name Type Description

name

string

The storage service of the redo log group.

redo_log

Name Type Description

mirrored

boolean

Specifies whether the redo log group should be mirrored.

size

integer

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

storage_service

storage_service

oracle_on_nfs

Oracle using NFS.

Name Type Description

archive_log

archive_log

db

db

nfs_access

array[app_nfs_access]

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

ora_home

ora_home

protection_type

protection_type

redo_log

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.

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

os_type

string

The name of the host OS running the application.

protection_type

protection_type

redo_log

redo_log

storage_service

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

storage_service

Name Type Description

name

string

The storage service of the Oracle CRS volume.

oracle_crs

Name Type Description

copies

integer

The number of CRS volumes.

size

integer

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

storage_service

storage_service

oracle_rac_on_nfs

Oracle RAC using NFS.

Name Type Description

archive_log

archive_log