string

The string output type allows you to define read-only string text fields that will appear on the Stack Overview page which can be used to display information to the Dell Cloud Manager console end user.

Typical uses for string output text boxes are to show items like:

  • Server IP addresses or hostnames
  • Application user account IDs

A string output is defined with a section name, a type, description (optional), value and properties (optional).

section name

Example: vm_ip:

type

type: string

Example

outputs:                                                        # Define outputs
  application_group:                                            # Create a Group
    type: dcm.outputs.DisplayGroup                              # It's a displayGroup
    properties:
      displayName: "Apache Web Server Information"              # Set the display name for the group containing the outputs which appears on the Stack Overview page

  vm_ip:                                                        # Define an output
    type: string                                                # It's a string output
    description: IP of the server                               # Set the description for the string output
    value: {get_attribute: [vm, publicIpAddress]}               # Set the value to the public IP address of the server running in the stack
    properties:
      displayName: IP address                                   # Set the display name (label) for the string output
      displayGroup: application_group                           # Place this output in the displayGroup named application_group

Note

In the above example, get_attribute: is an internal function that retrieves a attribute from a node. For instance host: {get_attribute: [vm, publicIpAddress]} retrieves the public IP address of the resource. Refer to Internal functions for more details.

String IP address on the console

../../../_images/stack_overview_string_ip_address.png