Annotations specification

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

  2 minute read  

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 that generates the annotation, covered below.
  • Orchestration action: a pre-create resource orchestration action runs code to determine the annotation.

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.