Retrieve an application template

Template properties

Each application template has a set of properties. These properties are always nested under a property with the same name as the template. For example, when using the mongo_db_on_san template, the properties are found nested inside the mongo_db_on_san property. The properties nested under the template property are all specific to the template. The model for the application template object includes all the available templates, but only the object that corresponds to the template's name is returned, and only one is provided in any application API.

The model of each template includes a description of each property and its allowed values or usage. Default values are also indicated when available. The template properties returned by this API include an example value for each property.

Template prerequisites

Each template has a set of prerequisites required for its use. If any of these prerequisites are not met, the missing_prerequisites property indicates which prerequisite is missing.

Learn more

DOC /application

Parameters

Name	Type	In	Required	Description
name	string	path	True	Template Name
fields	array[string]	query	False	Specify the fields to return.

Name

Type

In

Required

Description

name

string

path

True

Template Name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok

Name	Type	Description
_links	self_link
description	string	Description.
maxdata_on_san	maxdata_on_san	MAX Data application using SAN.
missing_prerequisites	string	Missing prerequisites.
mongo_db_on_san	mongo_db_on_san	MongoDB using SAN.
name	string	Template name.
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.
protocol	string	Access protocol.
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.
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

self_link

description

string

Description.

maxdata_on_san

MAX Data application using SAN.

missing_prerequisites

string

Missing prerequisites.

mongo_db_on_san

MongoDB using SAN.

name

string

Template name.

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.

protocol

string

Access protocol.

san

A generic SAN application.

sql_on_san

Microsoft SQL using SAN.

sql_on_smb

Microsoft SQL using SMB.

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"
    }
  },
  "description": "string",
  "maxdata_on_san": {
    "app_type": "string",
    "application_components": [
      {
      }
    ],
    "metadata": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "new_igroups": [
      {
        "initiators": [
          "string"
        ],
        "name": "string",
        "os_type": "string",
        "protocol": "string"
      }
    ],
    "ocsm_url": "string",
    "os_type": "string"
  },
  "missing_prerequisites": "string",
  "name": "string",
  "nas": {
    "application_components": [
      {
      }
    ],
    "cifs_access": [
      {
        "access": "string",
        "user_or_group": "string"
      }
    ],
    "nfs_access": [
      {
        "access": "string",
        "host": "string"
      }
    ],
    "protection_type": {
      "local_policy": "string",
      "local_rpo": "string",
      "remote_rpo": "string"
    }
  },
  "nvme": {
    "components": [
      {
      }
    ],
    "os_type": "string",
    "rpo": {
      "local": {
        "name": "string",
        "policy": "string"
      }
    }
  },
  "protocol": "string",
  "san": {
    "application_components": [
      {
      }
    ],
    "new_igroups": [
      {
        "initiators": [
          "string"
        ],
        "name": "string",
        "os_type": "string",
        "protocol": "string"
      }
    ],
    "os_type": "string",
    "protection_type": {
      "local_policy": "string",
      "local_rpo": "string",
      "remote_rpo": "string"
    }
  }
}

Error

Status: Default, Error

Name	Type	Description
error	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

Name

Type

Description

href

string

self_link

Name	Type	Description
self	href

Name

Type

Description

self

href

metadata

Name	Type	Description
key	string	Key to look up metadata associated with an application component.
value	string	Value associated with the key.

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.

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.

Name

Type

Description

name

string

The storage service 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
total_size	integer	The total size of the application component, split across the member LUNs. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}

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

storage_service

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.

Name

Type

Description

key

string

Key to look up metadata associated with an application.

value

string

Value associated with the key.

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

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.

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.

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

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

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

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.

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.

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]

Name

Type

Description

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

secondary_igroups

array[secondary_igroups]

component

Name	Type	Description
name	string	Name of the source component.

Name

Type

Description

name

string

Name of the source component.

svm

Name	Type	Description
name	string	Name of the source SVM.

Name

Type

Description

name

string

Name of the source SVM.

origin

Name	Type	Description
component	component
svm	svm

Name

Type

Description

component

svm

flexcache

Name	Type	Description
origin	origin

Name

Type

Description

origin

object_stores

Name	Type	Description
name	string	The name of the object-store to use. Usage: <(size 1..512)>

Name

Type

Description

name

string

The name of the object-store to use. Usage: <(size 1..512)>

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.

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
flexcache	flexcache
name	string	The name of the application component.
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]}

Name

Type

Description

flexcache

name

string

The name of the application component.

scale_out

boolean

Denotes a Flexgroup.

share_count

integer

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

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.

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.

app_nfs_access

The list of NFS access controls.

Name	Type	Description
access	string	The NFS access granted.
host	string	The name of the NFS entity granted 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 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.

Name

Type

Description

local_policy

string

The snapshot 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.
nfs_access	array[app_nfs_access]	The list of NFS access controls.
protection_type	protection_type

Name

Type

Description

application_components

array[application_components]

cifs_access

array[app_cifs_access]

The list of CIFS access controls.

nfs_access

array[app_nfs_access]

The list of NFS access controls.

protection_type

performance

Name	Type	Description
storage_service	storage_service

Name

Type

Description

storage_service

hosts

Name	Type	Description
nqn	string	The host NQN.

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>

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.

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
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 in the component

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.
policy	string	The snapshot policy to apply to each volume in the smart container. This property is only supported for smart containers. Usage: <snapshot policy>

Name

Type

Description

name

string

The local rpo of the application.

policy

string

The snapshot 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

Name

Type

Description

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

Name

Type

Description

components

array[components]

os_type

string

The name of the host OS running the application.

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

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

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.
ora_home	ora_home
protection_type	protection_type
redo_log	redo_log

Name

Type

Description

archive_log

db

nfs_access

array[app_nfs_access]

The list of NFS access controls.

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

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

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

os_type

string

The name of the host OS running the application.

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

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

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.

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.

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.

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

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

os_type

string

The name of the host OS running the application.

protection_type

redo_log

san_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

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.

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

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.

os_type

string

The name of the host OS running the application.

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

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.

os_type

string

The name of the host OS running the application.

protection_type

server_cores_count

integer

The number of server cores for the DB.

temp_db

access

Name

Type

Description

installer

string

SQL installer admin user name.

service_account

string

SQL service account user name.

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.

temp_db

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.

size

integer

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

storage_service

hyper_v_access

Name

Type

Description

service_account

string

Hyper-V service account.

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.

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.

protocol

string

The protocol of the new initiator group.

vdi_on_san

A VDI application using SAN.

Name

Type

Description

desktops

hypervisor

string

The name of the hypervisor hosting the application.

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.

size

integer

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

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.

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.

protocol

string

The protocol of the new initiator group.

vsi_on_san

A VSI application using SAN.

Name

Type

Description

datastore

hypervisor

string

The name of the hypervisor hosting the application.

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

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.

Retrieve an application template

Creating your file...

Template properties

Template prerequisites

Learn more

Parameters

Response

Error

Definitions