The Library section is used to add Virtual Images as custom Instance Types to the provisioning catalog. The Library section is composed of:

  • Instance Types
  • Layouts
  • Node Types
  • Option Types
  • Option Lists
  • File Templates
  • Scripts
  • Spec Templates
  • Cluster Layouts

When provisioning, the User selects an INSTANCE TYPE from the provisioning wizard. At this stage, we can present custom OPTION TYPES to the User which alter deployment in ways the administrator predetermines. Based on the selected Cloud technology and Version, the User is presented with applicable LAYOUTS selections. LAYOUTS can take advantage of Workflows which automate Tasks and can utilize a wide range of DevOps automation technologies. One or more NODE TYPES is associated with the LAYOUT. NODE TYPES are the bridge between LAYOUTS and Images. NODE TYPES can also take advantage of File Templates for custom configuration and Scripts which can be queued to run at any stage of the Instance lifecycle.


Instance Types

Adding an Instance Type creates a new Library item category. Multiple Layouts can be added to an Instance Type and these Layouts can have different Nodes attached. The Instance provisioning wizard will present the Layout options compatible with the selected Cloud. If Cloud selection is turned off, all Layouts will be presented for all Cloud types accessible by the User.

Name of the Instance Type in the provisioning Library
A useful shortcode for provisioning naming schemes and export reference
The description of the Instance Type shown in the Provisioning Library. (255 characters max)

For filtering in Instance sections and provisioning wizard

  • Web
  • SQL
  • NoSQL
  • Apps
  • Network
  • Messaging
  • Cache
  • OS
  • Cloud
  • Utility
An identifiable icon to display in-line with your Instance Type in the provisioning wizard (Suggested dimensions: 150 x 51)
  • Private: Only accessible by assigned Accounts/Tenants
  • Public: Accessible by all Accounts/Tenants
Option Types
Custom options presented to the user at provision time, Option Types are also created and stored in Morpheus Library
Environment Prefix
Used for exportable environment variables when tying Instance Types together in App contexts. If not specified, a name will be generated
Environment Variables
Name and value pairs for environment variables to be loaded on initialization
Enable Settings
Allows for attachment of modifiable file templates to Node Types in a settings tab of the Instance after deployment
Enable Scaling (Horizontal)
Enables load balancer assignment and auto-scaling features
Support Deployments
Enables deployment features (Requires a data volume be configured on each version. Files will be copied into this location)

Upon saving, this Instance Type will be available in the provisioning catalog, per User Role access. However, we still need to add Layouts to the Instance Type, and prior to creating a Layout, we will add a Node Type.


Layouts are attached to Instance Types. A Layout can only be attached to a single Instance Type and a single Technology. An Instance Type can have one or many Layouts attached to it, allowing for a single Instance Type to work with any Technology type. Node Types are added to Layouts. A Layout can have one or many node types attached to it. Node types can be shared across Layouts of matching Technology types.


Once an Instance Type is defined on a Layout and saved, the Instance Type setting and Technology selections on the Layout cannot be changed.

Layout List View

The default page for Layouts is the Layout list view. Select + ADD to create a new Layout. Layouts can also be created from an Instance Type detail page.

The following fields are displayed for each Layout:

  • NAME: Links to the Layout detail page
  • INSTANCE TYPE: Links to the associated Instance Type

The Actions menu in each row reveals the following options:

  • Permissions: Scope the Layout to Group(s) to narrow the list of available groups for a chosen Instance Type at provision time
  • Edit: Edit the Layout
  • Delete: Delete the Layout


A Layout that is in use cannot be deleted.

Available Filters:

  • Technology: Display Layouts by selected Cloud technology
  • Instance Type: Display Layouts by the associated Instance Type

Layout Detail View

The Layout Detail view shows details on the Layout including Name, Short Name, Version, and Category. It also lists all associated Node Types.

  • Select a Layout Name from the list page or Instance Type detail page to get to a Layout detail page.

Layout Configuration Options

Instance Type

Select the Instance Type to add to the new Layout. Custom Instance Types must already be created and one Layout cannot be added to multiple instance types. The Instance Type also cannot be changed after creation.


Layouts cannot be added to Morpheus pre-defined Instance Types

The name the Layout presents as in the Configuration Options dropdown of the provisioning wizard
The version number or name for the Layout. Layouts in an Instance Type with the same version will all show under the Configuration Options dropdown when that version is selected while provisioning
Description of the Layout, viewable on the Layout list view
When checked, this Layout will be selectable at provision time for the associated Instance Type (assuming the Layout is otherwise compatible with provisioning conditions). Instance Types with no Creatable Layouts will not be selectable from the provisioning wizard
Technology determines which Cloud this layout will be available for and which Node Types can be added to it
Minimum Memory
Defines the minimum amount of memory required for this Layout. Only Service Plans that meet the defined memory minimum will be available during provisioning when this Layout is selected. Custom memory values must also meet this minimum. Entering a minimum memory value of zero (the default value) indicates no minimum. This minimum memory value will override any Virtual Image minimum memory requirements
Select a Workflow to automatically run and be attached to associated Instances using this Layout. If a Workflow is defined, it is not presented in the provisioning wizard and is not user configurable
Supports Convert to Managed
Enabled to allow users to select this layout when converting a Discovered workload to Managed
Enable Scaling (Horizontal)
Enables Instances with this layout to use scaling features
Environment Variables
Custom environment variables to be added to the Instance when provisioned
Option Types
Search for and select one or multiple Option Types to add to the Layout. Option Type input fields (except for Hidden Option Types) will appear in Provisioning, App, Blueprint, and Cloning wizards when this layout is selected
Single or multiple nodes can be added to a Layout by searching for and selecting the Node(s)

Node Types

Node Types are the link between Images and Layouts.

Node Type Configuration Options

The following fields are for all Technology types:

Name of the Node Type in Morpheus
Short Name
The short name is a lowercase name with no spaces used for display in your container list
Version for the Node Type. Examples: 7.5, 2012 R2, latest
Select associated Technology. This will filter the available configuration options, images and which Layouts the Node Type can be added to
Environment Variables
Add pre-set environment variables to the Node Type
Node Types of differing categories within the same Layout can have differing sizing

Technology-Specific Options

The Options fields will change depending on the Technology option selected. For VM provisioning technology options, select an image from the VM Image dropdown. This list is populated from the Morpheus Virtual Images section and will include images uploaded into Morpheus as well as synced images from added clouds.


Amazon and Azure Marketplace Images can be added in the Virtual Images section for use as Node Types in custom library items.

Docker Options

For Docker, type in the name and version of the Docker Image, then select the integrated registry.

Service Ports

To open ports on the node, enter the name and port to expose. The Load Balancer HTTP, HTTPS, or TCP setting is required when attaching to Load Balancers.

Defining an Exposed port will also create a hyperlink(s) on the container location (IP) in the VM or Container section of the associated Instance detail page.

Search for and select one or multiple scripts to be executed when the Node Type is provisioned
File Templates
Search for and select one or multiple File Templates to be written when the Node Type is provisioned

Example port configuration:


VMware Options

When VMware Technology Type is selected, EXTRA OPTIONS will be available in the VMware VM Options section. These allow defining Advance vmx-file parameters during provisioning.

Some Example include:

tools.setinfo.sizeLimit : 1048576
vmci0.unrestricted : FALSE : TRUE


Not all parameters can be set using extra config parameters. A sample reference list can be found at


Use caution when setting Extra Options. Malformed config files can break provisioning. Troubleshooting issues related to Extra Options defined are beyond the scope of Morpheus product support.

Option Types

Option Types are custom input fields that can be added to Instance Types and Layouts, then presented in Instance, App, and Cloning wizards. The resulting value is available in the Instance config map as <%=customOptions.fieldName%>. The fieldName and value can also be exported as Tags.


Create Option Type


All possible fields listed. Displayed fields depend on TYPE selection

Name of the Option Type
Description for reference in Option Type list view
This is the input fieldName property that the value gets assigned to
Creates Tags for fieldName/value (key/value) on Instances
  • Text: Text Input Field
  • Select List: Populated by Option Lists, presents a manual or REST-populated dropdown list
  • Checkbox: Checkbox for on or off values
  • Number: Input field allowing only numbers
  • Typeahead: Populated by Option Lists: Rather than presenting a potentially-large dropdown menu, the user can begin typing a selection into a text field and choose the desired option. Multiple selections can be allowed with this type by marking the ‘ALLOW MULTIPLE SELECTIONS’ box
  • Hidden: No field will be displayed, but the field name and default value will be added to the Instance config map for reference
  • Password: An input field with suitable encryption for accepting passwords
This is the input label that typically shows to the left of a custom option
Background text that populates inside a field for adding example values, does not set a value
Pre-populates field with a default value
Prevents User from proceeding without setting value
For Checkbox types, when marked the Checkbox will be checked by default

For Select List types, select a pre-existing Option List to set dropdown values


Select List and Typeahead Option Types require creation and association of an Option List

Option Lists

Option Lists allow you to give the user more choices during provisioning to then be passed to scripts and/or automation. Option Lists, however, are pre-defined insofar as they are not free-form. They can be manually entered CSV or JSON, they can be dynamically compiled from REST calls via GET or POST requests, or populated by LDAP queries.


JSON entries must be formatted like the following example: [{"name":"Test","value":1},{"name":"Testing","value":2}]


Option List Fields

The displayed fields in the create/edit Option List modal depend on the TYPE value selected.

Name of the Option List
Description of the Option List for reference in Option List list view
  • REST: REST API call to populate Option List
  • Manual: Manually entered dataset, CSV or JSON
  • ** Morpheus API:** Call to Morpheus API to populate the Option List
  • LDAP: Searches and returns a list of Active Directory objects
If the account currently signed in is not in the master tenant, visibility will automatically change to private

For manual Option Lists:

Appears only for manual Option Lists. Add your CSV or JSON list to this field

For Option Lists populated by a REST call:

A REST URL used to fetch list data which is cached in the appliance database
When checked, a REST call will be made to update the Option List at the time its presented to the User
Do not fail API query for self-signed or invalid certs on REST call target
Custom HTTP Headers to include in the source request
Create an initial JSON or CSV dataset to be used as the collection for this option list. It should be a list containing objects with properties ‘name’ and ‘value’
Create a JS script to translate the result data object into an array containing objects with properties ‘name’ and ‘value’. The input data is provided as ‘data’ and the result should be put on the global variable ‘results’.

Create a JS script to prepare the request. Return a data object as the body for a POST request, and return an array containing properties ‘name’ and ‘value’ for a GET request. The input data is provided as ‘data’ and the result should be put on the global variable ‘results’

For Option Lists populated by an LDAP query:

The URL pointing to the LDAP server
The fully qualified username (with @ suffix syntax) for the binding account
The password for the above account
LDAP Query
The LDAP query to pull the appropriate objects. See the next section for an example use case
Create a JS script to translate the result data object into an array containing objects with properties ‘name’ and ‘value’. The input data is provided as ‘data’ and the result should be put on the global variable ‘results’.


Option Lists are set on one or multiple Select List or Typeahead Option Types. The Option Type is then set on an Instance Type, Layout, Cluster Layout, and/or Operational Workflow for input during provisioning or execution.

Creating an Option List Based on an LDAP Query

In Morpheus version 4.2.1 and higher, Option Lists can be populated from LDAP queries. This gives users the ability to search Active Directory, capture objects, and present them as custom options where needed.

It’s recommended that you connect LDAP-type Option Lists to Typeahead-type Option Types as the list of returned selections can be very large. This also allows you to select multiple options from the list, presuming you’ve allowed for that when creating the Option Type.

Populating LDAP-type Option Lists requires knowledge of LDAP query syntax. This guide provides one example and there are many publicly-available resources for help writing additional queries.

  1. Create a new Option List (Provisioning > Library > Option Lists > ADD)
  2. Enter a name for the new LDAP Option List
  3. Change the Type value to LDAP and the relevant fields will appear as shown in the screenshot:
  4. Enter the LDAP URL in the following format (an example is also shown as a placeholder in the UI form field):
  1. Enter the fully qualified username with @ suffix syntax, such as:
  2. Enter the account password
  3. Enter your LDAP query. You can even inject variables into your query structure to query based on the value the user has entered into the typeahead field as shown in the example below:
  1. Finally, enter a translation script which will convert the returned LDAP object into a list of name:value pairs you can work with in Morpheus. The example script below shows the user DisplayName and sets the value to the SAMAccountName:
for(var x=0;x < data.length ; x++) {

  var row = data[x];
  var a = {};

    if(row.displayName != null) {
    a['name'] = row.displayName;

  } else {

    a['name'] = row.sAMAccountName;


  a['value'] = row.sAMAccountName;


File Templates

File Templates are for generating config files, such as my.cnf, elasticsearch.yml, morpheus.rb, or any text file. With full config map variable support, Template Files are dynamically generated during a Workflow phase or ad hoc via Instance actions.

File Templates can also be exposed on Instances in the Settings Tab. Ensure the Instance Type supports settings, and Category is defined in Advance Options on the Library Template config.


Morpheus variables are supported in Library Templates using <%= variable.var %> format


HA Proxy Config (haproxy.cfg)

  • FILE NAME: haproxy.cfg
  • FILE PATH: /config/haproxy.cfg
  • PHASE: Pre Provision
  • SETTING NAME: haproxyConfig

 maxconn 256
 log /dev/log local0 warning
 log-tag <%=logTag%>

 mode http
 timeout connect 5000ms
 timeout client 50000ms
 timeout server 50000ms
 log global

frontend http-in
 bind *:<%=container.externalPort%>
 default_backend servers

backend servers
 # server server1 maxconn 32

mysql config (mysqld.cnf)

  • FILE NAME: mysqld.cnf
  • FILE PATH: /config/mysqld.cnf
  • PHASE: Pre Provision

pid-file= /var/run/mysqld/
socket= /var/run/mysqld/mysqld.sock
datadir= /var/lib/mysql
# Disabling symbolic-links is recommended to prevent assorted security risks
explicit_defaults_for_timestamp = 1


Scripts are bash and Powershell scripts that can be attached to Node Types to always execute at the selected phase when that Node Type is provisioned, added to Workflows as Library Script Tasks, and/or executed ad-hoc on Instances.

Creating Scripts

  1. Navigate to Provisioning > Library > Scripts

  2. Select + ADD

  3. Enter the Following:


    Name of the Script in Morpheus

    • Bash
    • Powershell

    Select which phase the Script will execute when attached to a Node Type. When a script is attached to a Node Type, it will execute according to the selcted phase:

    Start Service

    Any time the Instance action Start Service is executed

    Stop Service

    Any time the Instance action Stop Service is executed

    • Containers: Script will execute against the container host before the container is provisioned
    • Virtual Machines: Script will execute before any provision phase Scripts or Tasks

    Script will execute once per new Instance node during the provision Phase. Provisioning will not be considered complete until all scripts and tasks in the provisioning phase are completed


    Any Script or Task set to the provision phase will be included in the total provision time and impact success/warn/failure provisioning status messages. As an example, your VM could be up and running but if your Script is in the provision phase and fails, provisioning will be marked as a failure.


    Script will execute once per new Instance node after the provision phase is completed. Scripts and Tasks in the Post-Provision phase will show execution status and history, but are not considered part of the provision and do not impact provisioning status.


    Script will execute on target Instance any time a deployment is run against the Instance. The Script will run prior to the deployment file(s) being written


    Script will execute on target Instance any time a deployment is run against the Instance. The script will run after the deployment file(s) are written


    Script will execute on target Instance any time a reconfigure is executed against the Instance.


    Script will execute on target Instance upon Instance deletion. Script will execute against target Instance prior to the deletion/removal of resources.


    Enter Bash or Powershell script.


    Morpheus variables are supported in Library Scripts using <%= variable.var %> format


    By default Scripts are execute as morpheus-node. To execute as another User, populate RUN AS USER and ensure proper user permissions & group access


    Flag SUDO if sudo is required to execute the Script

To attach Scripts and templates that have been added to the Library to a Node Type, start typing the name and then select the script(s) and/or template(s).

  • Multiple scripts and templates can be added to a Node Type
  • Scripts and Templates can be added/shared among multiple Node Types
  • The execution phase can be set for Scripts in the Scripts section
  • Search will populate Scripts or Templates containing the characters entered anywhere in their name, not just the first letter(s) of the name

Spec Templates

Spec Templates allow Morpheus users to leverage several major Infrastructure-as-Code solutions. These are typically JSON or YAML-based configuration files which make creating and managing multiple resource types easier. Morpheus allows users to create and/or manage a collection of these templates for different solutions and from different sources.

Morpheus currently supports Spec Templates of the following types:

  • Kubernetes Spec
  • Helm Chart
  • Terraform
  • ARM Template
  • CloudFormation Template
  • OneView Server Profile Template
  • UCS Service Profile Template

Morpheus also allows users to leverage templates pulled from URL sources, online repositories (such as GitHub), or you can write a template locally inside the “NEW SPEC TEMPLATE” modal.


To see Morpheus Spec Templates in action, take a look at an example use case in our KnowledgeBase where a CloudFormation Spec Template is used to create a provisionable custom Instance Type in Morpheus.

Creating a Spec Template

  1. Navigate to Provisioning > Library > SPEC TEMPLATES
  2. Click + ADD
  3. Complete the following fields, then click SAVE CHANGES:
  • NAME
  • TYPE: See the previous section for a complete list of Spec Template types
  • SOURCE: Local, Repository, or URL
  • CONTENT: If this is a local Spec Template, supply the template in this field. If the template is supplied through a URL or online repository, the CONTENT field will change to allow the user to point Morpheus to that resource.

Cluster Layouts

Morpheus provided Cluster Layouts:

Users can add new cluster layouts using the +ADD button. Morpheus-provided cluster layouts can be cloned for use in creating custom layouts. Custom cluster layouts can also be deleted or edited from the list view using the pencil or trash can icons.