Module netapp_ontap.resources.application_template
Copyright © 2019 NetApp Inc. All rights reserved.
Classes
class ApplicationTemplate (*args, **kwargs)
-
Application Templates
Initialize the instance of the resource.
Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:
MyResource(name='foo').name == 'foo'
Args
*args
- Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
- each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.
Ancestors
Static methods
def find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves application templates.
Query examples
The most useful queries on this API allows searches by name or protocol access. The following query returns all templates that are used to provision an Oracle application.
GET /application/templates?name=ora*
Similarly, the following query returns all templates that support SAN access.GET /application/templates?protocol=san
Learn more
Find an instance of an object on the host given a query.
The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found or if more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
Resource
object containing the details of the object.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves application templates.
Query examples
The most useful queries on this API allows searches by name or protocol access. The following query returns all templates that are used to provision an Oracle application.
GET /application/templates?name=ora*
Similarly, the following query returns all templates that support SAN access.GET /application/templates?protocol=san
Learn more
Fetch a list of all objects of this type from the host.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. max_records
- The maximum number of records to return per call
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A list of
Resource
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library.
Methods
def get(self, **kwargs) -> NetAppResponse
-
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 themongo_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
Fetch the details of the object from the host.
Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Inherited members
class ApplicationTemplateSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the ApplicationTemplate object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var description
-
Description
var links
-
The links field of the application_template.
var maxdata_on_san
-
The maxdata_on_san field of the application_template.
var missing_prerequisites
-
Missing Prerequisites
var mongo_db_on_san
-
The mongo_db_on_san field of the application_template.
var name
-
Template Name. Required in the URL
var nas
-
The nas field of the application_template.
var opts
var oracle_on_nfs
-
The oracle_on_nfs field of the application_template.
var oracle_on_san
-
The oracle_on_san field of the application_template.
var oracle_rac_on_nfs
-
The oracle_rac_on_nfs field of the application_template.
var oracle_rac_on_san
-
The oracle_rac_on_san field of the application_template.
var protocol
-
Access Protocol
Valid choices:
- nas
- san
var san
-
The san field of the application_template.
var sql_on_san
-
The sql_on_san field of the application_template.
var sql_on_smb
-
The sql_on_smb field of the application_template.
var vdi_on_nas
-
The vdi_on_nas field of the application_template.
var vdi_on_san
-
The vdi_on_san field of the application_template.
var vsi_on_nas
-
The vsi_on_nas field of the application_template.
var vsi_on_san
-
The vsi_on_san field of the application_template.