Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263572.5 KB
Template Management

Get specified Template

Get the Template by Template name and Template Set name.

get/templates/{setName}/{templateName}

Response

A Template object.

titlestring

A "pretty name" for the Template

descriptionstring

Template description

definitionsParametersDefinition

Object must conform to specified template's schema.

targetstring

A hint to Template consumers about the intended purpose of the Template

templateTextstring

A Mustache-templated string

defaultParametersParametersDefinition

Object must conform to specified template's schema.

sourceTypestring

A hint on where templateText originated from (e.g., "MST" for loading via Template.loadMst())

sourceTextstring

The raw text of the source the Template class parsed

sourceHashstring

A sha256 hash of the sourceText (useful for determining if a Template has changed)

contentTypestring

A MIME type for the intended output of Template.render()

Example response

{
  "title": "Simple UDP Application",
  "description": "** FOR DEMONSTRATION PURPOSES--NOT INTENDED FOR USE IN PRODUCTION ** This Template is an example of how one might build a simple UDP Application with load balancing. It allows the user to provide a virtual IP address and port along with a list of UDP server addresses. The user-supplied values are inserted when the Template is rendered, yielding an AS3 declaration suitable for submission to BIG-IP.",
  "definitions": {
    "tenant": "foo",
    "application": "bar",
    "virtualAddress": "192.0.2.11"
  },
  "target": "as3",
  "templateText": "{\n  \"class\": \"ADC\",\n  \"schemaVersion\": \"3.0.0\",\n  \"{{tenant_name}}\": {\n    \"class\": \"Tenant\",\n    \"{{application_name}}\": {\n      \"class\": \"Application\",\n      \"template\": \"udp\",\n      \"serviceMain\": {\n        \"class\": \"Service_UDP\",\n        \"virtualAddresses\": [\n          \"{{virtual_address}}\"\n        ],\n        \"virtualPort\": {{virtual_port:types:port}},\n        \"pool\": \"{{application_name}}_Pool1\"\n      },\n      \"{{application_name}}_Pool1\": {\n        \"class\": \"Pool\",\n        \"monitors\": [\n          \"icmp\"\n        ],\n        \"members\": [\n          {\n            \"serverAddresses\": {{server_addresses::array}},\n            \"servicePort\": {{service_port:types:port}}\n          }\n        ]\n      }\n    }\n  }\n}\n",
  "defaultParameters": {
    "tenant": "foo",
    "application": "bar",
    "virtualAddress": "192.0.2.11"
  },
  "sourceType": "YAML",
  "sourceText": "# Simple UDP Template with parameters defined outside of the Template\ntitle: Simple UDP Application\ndescription:  \"** FOR DEMONSTRATION PURPOSES--NOT INTENDED FOR USE IN PRODUCTION ** This Template is an example of how one might build a simple UDP Application with load balancing. It allows the user to provide a virtual IP address and port along with a list of UDP server addresses. The user-supplied values are inserted when the Template is rendered, yielding an AS3 declaration suitable for submission to BIG-IP.\"\nparameters:\n  tenant_name: foo\n  application_name: bar\n  virtual_address: 192.0.2.11\n  virtual_port: 5555\n  server_addresses:\n    - 192.0.2.22\n  service_port: 5555\ntemplate: |\n  {\n    \"class\": \"ADC\",\n    \"schemaVersion\": \"3.0.0\",\n    \"{{tenant_name}}\": {\n      \"class\": \"Tenant\",\n      \"{{application_name}}\": {\n        \"class\": \"Application\",\n        \"template\": \"udp\",\n        \"serviceMain\": {\n          \"class\": \"Service_UDP\",\n          \"virtualAddresses\": [\n            \"{{virtual_address}}\"\n          ],\n          \"virtualPort\": {{virtual_port:types:port}},\n          \"pool\": \"{{application_name}}_Pool1\"\n        },\n        \"{{application_name}}_Pool1\": {\n          \"class\": \"Pool\",\n          \"monitors\": [\n            \"icmp\"\n          ],\n          \"members\": [\n            {\n              \"serverAddresses\": {{server_addresses::array}},\n              \"servicePort\": {{service_port:types:port}}\n            }\n          ]\n        }\n      }\n    }\n  }\n",
  "sourceHash": "a52a2f6cd3d03f7cdec09248fd59fc75b30fa14fa067a137628e7e6ee0b43b4f"
}