REST API reference
Retrieve an application template
Suggest changes
PDFs
GET /application/templates/{name}
Retrieves 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
Parameters
| 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 |
||
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. Required in the URL |
nas |
A generic NAS application. |
|
oracle_on_nfs |
Oracle using NFS. |
|
oracle_on_san |
Oracle using SAN. |
|
oracle_rac_on_nfs |
Oracle RAC using NFS. |
|
oracle_rac_on_san |
Oracle RAC using SAN. |
|
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": [
{
"file_system": "string",
"host_management_url": "string",
"host_name": "string",
"igroup_name": "string",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"storage_service": {
"name": "string"
}
}
],
"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",
"mongo_db_on_san": {
"dataset": {
"storage_service": {
"name": "string"
}
},
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"os_type": "string",
"protocol": "string"
}
],
"os_type": "string",
"primary_igroup_name": "string",
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"secondary_igroups": [
{
"name": "string"
}
]
},
"name": "string",
"nas": {
"application_components": [
{
"name": "string",
"storage_service": {
"name": "string"
}
}
],
"cifs_access": [
{
"access": "string",
"user_or_group": "string"
}
],
"nfs_access": [
{
"access": "string",
"host": "string"
}
],
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
}
},
"oracle_on_nfs": {
"archive_log": {
"storage_service": {
"name": "string"
}
},
"db": {
"storage_service": {
"name": "string"
}
},
"nfs_access": [
{
"access": "string",
"host": "string"
}
],
"ora_home": {
"storage_service": {
"name": "string"
}
},
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"redo_log": {
"storage_service": {
"name": "string"
}
}
},
"oracle_on_san": {
"archive_log": {
"storage_service": {
"name": "string"
}
},
"db": {
"storage_service": {
"name": "string"
}
},
"igroup_name": "string",
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"os_type": "string",
"protocol": "string"
}
],
"ora_home": {
"storage_service": {
"name": "string"
}
},
"os_type": "string",
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"redo_log": {
"storage_service": {
"name": "string"
}
}
},
"oracle_rac_on_nfs": {
"archive_log": {
"storage_service": {
"name": "string"
}
},
"db": {
"storage_service": {
"name": "string"
}
},
"grid_binary": {
"storage_service": {
"name": "string"
}
},
"nfs_access": [
{
"access": "string",
"host": "string"
}
],
"ora_home": {
"storage_service": {
"name": "string"
}
},
"oracle_crs": {
"storage_service": {
"name": "string"
}
},
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"redo_log": {
"storage_service": {
"name": "string"
}
}
},
"oracle_rac_on_san": {
"archive_log": {
"storage_service": {
"name": "string"
}
},
"db": {
"storage_service": {
"name": "string"
}
},
"db_sids": [
{
"igroup_name": "string"
}
],
"grid_binary": {
"storage_service": {
"name": "string"
}
},
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"os_type": "string",
"protocol": "string"
}
],
"ora_home": {
"storage_service": {
"name": "string"
}
},
"oracle_crs": {
"storage_service": {
"name": "string"
}
},
"os_type": "string",
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"redo_log": {
"storage_service": {
"name": "string"
}
}
},
"protocol": "string",
"san": {
"application_components": [
{
"igroup_name": "string",
"name": "string",
"storage_service": {
"name": "string"
}
}
],
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"os_type": "string",
"protocol": "string"
}
],
"os_type": "string",
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
}
},
"sql_on_san": {
"db": {
"storage_service": {
"name": "string"
}
},
"igroup_name": "string",
"log": {
"storage_service": {
"name": "string"
}
},
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"os_type": "string",
"protocol": "string"
}
],
"os_type": "string",
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"temp_db": {
"storage_service": {
"name": "string"
}
}
},
"sql_on_smb": {
"access": {
"installer": "string",
"service_account": "string"
},
"db": {
"storage_service": {
"name": "string"
}
},
"log": {
"storage_service": {
"name": "string"
}
},
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
},
"temp_db": {
"storage_service": {
"name": "string"
}
}
},
"vdi_on_nas": {
"desktops": {
"storage_service": {
"name": "string"
}
},
"hyper_v_access": {
"service_account": "string"
},
"nfs_access": [
{
"access": "string",
"host": "string"
}
],
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
}
},
"vdi_on_san": {
"desktops": {
"storage_service": {
"name": "string"
}
},
"hypervisor": "string",
"igroup_name": "string",
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"protocol": "string"
}
],
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
}
},
"vsi_on_nas": {
"datastore": {
"storage_service": {
"name": "string"
}
},
"hyper_v_access": {
"service_account": "string"
},
"nfs_access": [
{
"access": "string",
"host": "string"
}
],
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
}
},
"vsi_on_san": {
"datastore": {
"storage_service": {
"name": "string"
}
},
"hypervisor": "string",
"igroup_name": "string",
"new_igroups": [
{
"initiators": [
"string"
],
"name": "string",
"protocol": "string"
}
],
"protection_type": {
"local_rpo": "string",
"remote_rpo": "string"
}
}
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
self_link
| Name | Type | Description |
|---|---|---|
self |
metadata
| Name | Type | Description |
|---|---|---|
key |
string |
Key to look up metadata associated with an application component. Optional in the POST body |
value |
string |
Value associated with the key. Optional in the POST body |
protection_type
| Name | Type | Description |
|---|---|---|
local_rpo |
string |
The local rpo of the application component. Optional in the POST or PATCH body |
remote_rpo |
string |
The remote rpo of the application component. Optional in the POST or PATCH body |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the application component. Optional in the POST or PATCH body |
maxdata_on_san_application_components
application-components
| Name | Type | Description |
|---|---|---|
file_system |
string |
Defines the kind of file system that will be installed on this application component. Optional in the POST body |
host_management_url |
string |
The host management URL for this application component |
host_name |
string |
FQDN of the L2 host that contains the hot tier of this application component. Required in the POST body |
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
lun_count |
integer |
The number of LUNs in the application component. Required in the POST body |
metadata |
array[metadata] |
|
name |
string |
The name of the application component. Required in the POST body and optional in the PATCH body |
protection_type |
||
storage_service |
||
total_size |
integer |
The total size of the application component, split across the member LUNs. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body |
metadata
| Name | Type | Description |
|---|---|---|
key |
string |
Key to look up metadata associated with an application. Optional in the POST body |
value |
string |
Value associated with the key. Optional in the POST body |
maxdata_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
maxdata_on_san
MAX Data application using SAN.
| Name | Type | Description |
|---|---|---|
app_type |
string |
Type of the application that is being deployed on the L2. Required in the POST body |
application_components |
application-components. Optional in the POST or PATCH body |
|
metadata |
array[metadata] |
|
new_igroups |
array[maxdata_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
ocsm_url |
string |
The OnCommand System Manager URL for this application |
os_type |
string |
The name of the host OS running the application. Required in the POST body |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the database. Optional in the POST or PATCH body |
dataset
| Name | Type | Description |
|---|---|---|
element_count |
integer |
The number of storage elements (LUNs for SAN) of the database to maintain. Must be an even number between 2 and 16. Odd numbers will be rounded up to the next even number within range. Optional in the POST body |
replication_factor |
integer |
The number of data bearing members of the replicaset, including 1 primary and at least 1 secondary. Optional in the POST body |
size |
integer |
The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
mongo_db_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
protection_type
| Name | Type | Description |
|---|---|---|
local_rpo |
string |
The local rpo of the application. Optional in the POST or PATCH body |
remote_rpo |
string |
The remote rpo of the application. Optional in the POST body |
secondary_igroups
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the initiator group for each secondary. Optional in the POST or PATCH body |
mongo_db_on_san
MongoDB using SAN.
| Name | Type | Description |
|---|---|---|
dataset |
||
new_igroups |
array[mongo_db_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
os_type |
string |
The name of the host OS running the application. Optional in the POST body |
primary_igroup_name |
string |
The initiator group for the primary. Required in the POST body and optional in the PATCH body |
protection_type |
||
secondary_igroups |
array[secondary_igroups] |
application_components
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the application component. Optional in the POST or PATCH body |
share_count |
integer |
The number of shares in the application component. Optional in the POST body |
storage_service |
||
total_size |
integer |
The total size of the application component, split across the member shares. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
app_cifs_access
The list of CIFS access controls.
| Name | Type | Description |
|---|---|---|
access |
string |
The CIFS access granted to the user or group. Optional in the POST body |
user_or_group |
string |
The name of the CIFS user or group that will be granted access. Optional in the POST body |
app_nfs_access
The list of NFS access controls.
| Name | Type | Description |
|---|---|---|
access |
string |
The NFS access granted. Optional in the POST body |
host |
string |
The name of the NFS entity granted access. Optional in the POST body |
nas
A generic NAS application.
| Name | Type | Description |
|---|---|---|
application_components |
array[application_components] |
|
cifs_access |
array[app_cifs_access] |
The list of CIFS access controls. Optional in the POST body |
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
protection_type |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the archive log. Optional in the POST or PATCH body |
archive_log
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the archive log. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
db
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the ORACLE_HOME storage volume. Optional in the POST or PATCH body |
ora_home
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the ORACLE_HOME storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the redo log group. Optional in the POST or PATCH body |
redo_log
| Name | Type | Description |
|---|---|---|
mirrored |
boolean |
Should the redo log group be mirrored? Optional in the POST body |
size |
integer |
The size of the redo log group. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
oracle_on_nfs
Oracle using NFS.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
ora_home |
||
protection_type |
||
redo_log |
oracle_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
oracle_on_san
Oracle using SAN.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
new_igroups |
array[oracle_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
ora_home |
||
os_type |
string |
The name of the host OS running the application. Required in the POST body |
protection_type |
||
redo_log |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the Oracle grid binary storage volume. Optional in the POST or PATCH body |
grid_binary
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the Oracle grid binary storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the Oracle CRS volume. Optional in the POST or PATCH body |
oracle_crs
| Name | Type | Description |
|---|---|---|
copies |
integer |
The number of CRS volumes. Optional in the POST body |
size |
integer |
The size of the Oracle CRS/voting storage volume. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST body |
storage_service |
oracle_rac_on_nfs
Oracle RAC using NFS.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
grid_binary |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
ora_home |
||
oracle_crs |
||
protection_type |
||
redo_log |
db_sids
| Name | Type | Description |
|---|---|---|
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Optional in the POST or PATCH body |
oracle_rac_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
oracle_rac_on_san
Oracle RAC using SAN.
| Name | Type | Description |
|---|---|---|
archive_log |
||
db |
||
db_sids |
array[db_sids] |
|
grid_binary |
||
new_igroups |
The list of initiator groups to create. Optional in the POST or PATCH body |
|
ora_home |
||
oracle_crs |
||
os_type |
string |
The name of the host OS running the application. Required in the POST body |
protection_type |
||
redo_log |
application_components
| Name | Type | Description |
|---|---|---|
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Optional in the POST or PATCH body |
lun_count |
integer |
The number of LUNs in the application component. Optional in the POST body |
name |
string |
The name of the application component. Optional in the POST or PATCH body |
storage_service |
||
total_size |
integer |
The total size of the application component, split across the member LUNs. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
san
A generic SAN application.
| Name | Type | Description |
|---|---|---|
application_components |
array[application_components] |
|
new_igroups |
array[san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
os_type |
string |
The name of the host OS running the application. Required in the POST body |
protection_type |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the db. Optional in the POST or PATCH body |
db
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the db. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the log db. Optional in the POST or PATCH body |
log
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the log db. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body and optional in the PATCH body |
storage_service |
sql_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. Optional in the POST or PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the temp db. Optional in the POST or PATCH body |
temp_db
| Name | Type | Description |
|---|---|---|
size |
integer |
The size of the temp db. Usage: {<integer>[KB|MB|GB|TB|PB]} Optional in the POST or PATCH body |
storage_service |
sql_on_san
Microsoft SQL using SAN.
| Name | Type | Description |
|---|---|---|
db |
||
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
log |
||
new_igroups |
array[sql_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
os_type |
string |
The name of the host OS running the application. Optional in the POST body |
protection_type |
||
server_cores_count |
integer |
The number of server cores for the db. Optional in the POST body |
temp_db |
access
| Name | Type | Description |
|---|---|---|
installer |
string |
SQL installer admin user name. Optional in the POST body |
service_account |
string |
SQL service account user name. Required in the POST body |
sql_on_smb
Microsoft SQL using SMB.
| Name | Type | Description |
|---|---|---|
access |
||
db |
||
log |
||
protection_type |
||
server_cores_count |
integer |
The number of server cores for the db. Optional in the POST body |
temp_db |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the desktops. Optional in the POST or PATCH body |
desktops
| Name | Type | Description |
|---|---|---|
count |
integer |
The number of desktops to support. Optional in the POST or PATCH body |
size |
integer |
The size of the desktops. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body |
storage_service |
hyper_v_access
| Name | Type | Description |
|---|---|---|
service_account |
string |
Hyper-V service account. Optional in the POST body |
vdi_on_nas
A VDI application using NAS.
| Name | Type | Description |
|---|---|---|
desktops |
||
hyper_v_access |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
protection_type |
vdi_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
vdi_on_san
A VDI application using SAN.
| Name | Type | Description |
|---|---|---|
desktops |
||
hypervisor |
string |
The name of the hypervisor hosting the application. Required in the POST body |
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
new_igroups |
array[vdi_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
protection_type |
storage_service
| Name | Type | Description |
|---|---|---|
name |
string |
The storage service of the datastore. Optional in the POST or PATCH body |
datastore
| Name | Type | Description |
|---|---|---|
count |
integer |
The number of datastores to support. Optional in the POST or PATCH body |
size |
integer |
The size of the datastore. Usage: {<integer>[KB|MB|GB|TB|PB]} Required in the POST body |
storage_service |
vsi_on_nas
A VSI application using NAS.
| Name | Type | Description |
|---|---|---|
datastore |
||
hyper_v_access |
||
nfs_access |
array[app_nfs_access] |
The list of NFS access controls. Optional in the POST body |
protection_type |
vsi_on_san_new_igroups
The list of initiator groups to create.
| Name | Type | Description |
|---|---|---|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. Required in the POST body and optional in the PATCH body |
protocol |
string |
The protocol of the new initiator group. Optional in the POST or PATCH body |
vsi_on_san
A VSI application using SAN.
| Name | Type | Description |
|---|---|---|
datastore |
||
hypervisor |
string |
The name of the hypervisor hosting the application. Required in the POST body |
igroup_name |
string |
The name of the initiator group through which the contents of this application will be accessed. Modification of this parameter is a disruptive operation. All LUNs in the application component will be unmapped from the current igroup and re-mapped to the new igroup. Required in the POST body and optional in the PATCH body |
new_igroups |
array[vsi_on_san_new_igroups] |
The list of initiator groups to create. Optional in the POST or PATCH body |
protection_type |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |