Conventions used in this document

This document uses content conventions to convey specific meaning.

Command conventions

  • < > - Replace the variable content that is shown inside < > with values specific to your needs. Do not include the < > characters in the command. (As an alternative, the text sometimes shows as words in all capital letters.) Examples:
    palmctl get application <application-id>
    palmctl get application APPLICATION-ID
  • [ ] - The content inside [ ] is optional. Example:
    palmctl get applications [-h]
  • { } - The content inside { } contains two or more choices that are separated by |. Choose one of them. (As an alternative, ( ) is sometimes used.) Example:
    palmctl get policy {--id <policy-id> | --name <policy-name>}

Literal strings

  • In instructions for using the Mesh console, words that are shown as bold text are literal strings that you see in the console.
  • In instructions for using the CLI, words that are shown as monospace font are literal strings that you must enter word for word.