TemplateDefinitionListsResource


Create a template definition list


Create a new template definition list based on its representation. All the Template Definitions included will also be created.

POST https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists

Roles : [ROLE_APPLIB_ALLOW_MODIFY ]

Example

Create a template definition list from ovf index url


Create a new template definition list based on the content of a template repository (ovfindex.xml). One Template Definition for each .ovf in the list. Please refer to the template repository documentation for details of the ovfindex.xml format. All the Template Definitions included will also be created.

POST https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists

Roles : [ROLE_APPLIB_ALLOW_MODIFY ]

Content-Type : text/plain Accept : templatedefinitionlist

Error Codes

  • OVF-PACKAGE-3 - Cannot find the RepositorySpace
  • OVF-PACKAGE-4 - The requested RepositorySpace does not exist
  • OVF-PACKAGE-LIST-0 - OVF Package list name already exists

Example

List template definition lists


Retrieve template definition lists registered in the enterprise.

GET https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists

Roles : [ROLE_APPLIB_VIEW ]

Error Codes

  • EN-0 - The requested enterprise does not exist

Example

Delete a template definition list


Removes a template definition list, but doesn't delete the included Template Definitions.

DELETE https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists/{templateDefinitionList}

Roles : [ROLE_APPLIB_ALLOW_MODIFY ]

Example

Get a template definition list


GET https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists/{templateDefinitionList}

Roles : [ROLE_APPLIB_VIEW ]

Example

Refresh a template definition list from the url


Fetch new template definitions (.ovf) from an ovfindex.xml source, adding them to the current list. Also delete template definitions that are not present. Only apply if the list is associated with an ovfindex.xml (url), which is a list created by providing the ovfindex.xml location.

PUT https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists/{templateDefinitionList}

Roles : [ROLE_APPLIB_ALLOW_MODIFY ]

Update a template definition list


Modify the content of the template definition list based on the supplied list of template definitions.
Overwrite all the template definitions in the list.

PUT https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists/{templateDefinitionList}

Roles : [ROLE_APPLIB_ALLOW_MODIFY ]

Error Codes

  • OVF-PACKAGE-1 - The requested OVF package list does not exist
  • OVF-PACKAGE-LIST-0 - OVF Package list name already exists

Example

List template status of a template definition list in a datacenter repository


Retrieve the template status of all template definitions in the list for a given datacenter.

GET https://example.com/api/admin/enterprises/{enterprise}/appslib/templateDefinitionLists/{templateDefinitionList}/actions/repositoryStatus

Roles : [ROLE_APPLIB_VIEW ]

Parameter Type Default Value Description
datacenterId Integer Required. Identifier of the datacenter

Accept : templatestates