# Annotations specification

> Set descriptive notes (annotations) on new servers, from manual entry to dynamically generated templates

---

Site [llms.txt](/llms.txt)

---

Annotations, also called server notes, can be set for new servers in three ways:

- **Manual entry:** the user enters annotations when ordering a server. This is the default.
- **Parameter template:** an admin sets the *Annotation* parameter to a [parameter template](/docs/cmp/configure/order-forms-and-pricing/parameters/parameter-templates/) that generates the annotation, covered below.
- **Orchestration action:** a pre-create resource orchestration action runs code to determine the annotation.

<div class="alert alert-info" role="alert">


Annotations are supported on many resource handlers, where they map to the platform's native notes, description, or tag field. For example, VMware uses the native Notes field, and AWS applies an Annotation tag when the handler is set to add Name and Annotation tags to new servers (enable *Add Name & Annotation tags to new servers* in the handler's Edit Settings; the Name and Annotation entries then appear on its Tags tab). Annotations sync back to the server after creation.
</div>


## Using annotation templates

The *Annotation* parameter specifies how annotations are generated for new servers. An annotation template dynamically generates the annotation from attributes of the server, portal, job, and owner, such as the order and job ID, or a link back to Cloud Management Platform (CMP) to view the server.

### Context variables available within annotation templates

- *server:* the server that was ordered
- *portal:* the CMP portal through which the server was ordered (for example, `portal.site_url` returns the portal URL)
- *job:* the job in which the server was ordered
- *profile:* the owner of the order (the job owner)
- *order:* the order in which the job provisioned the server

### Annotation template examples

| Template | Result |
| --- | --- |
| `{{ server.owner }}` | The name (or username) of the server's owner. |
| `{{ portal.site_url }}` | The CMP portal URL. |
| `{{ server.add_date\|date:"SHORT_DATE_FORMAT" }}` | The date the server was added, formatted per the short date format. |
| `{{ job.id }}` | The ID of the job that ordered the server. |
| `{{ order.id }}` | The ID of the order that provisioned the server. |

## Related

- [Order form customization](/docs/cmp/use/blueprints/customize-order-form/order-form-customization/): Every way to customize the order form.
- [Hostname specification](/docs/cmp/configure/order-forms-and-pricing/parameters/parameter-templates/hostname-specification/): Set hostnames with templates.