Syntax notation

The table below describes the conventions used for the syntax of commands, expressions, URLs, and object names in this book.

Notation Meaning Example
boldface Type exactly as it appears in the syntax (if the context is case insensitive, you can vary the case of the letters you type)

This book shows:

http://admin.hcp-domain-name/query

You enter: http://admin.hcp-ma.example.com/query

 

italics Replace with a value of the indicated type
| Vertical bar — Choose one of the elements on either side of the bar, but not both

This book shows: <verbose>(true|false</verbose>

You enter: <verbose>true</verbose>

or: <verbose>false</verbose>

[ ] Square brackets — Include none, one, or more of the elements between the brackets

This book shows: http[s]://tenant-name.hcp-domain-name/query

You enter: http://europe.hcp.example.com/query
or: https://europe.hcp.example.com/query

( ) Parentheses — Include exactly one of the elements between the parentheses

This book shows: (asc|desc)

You enter: asc
or: desc

-path Replace with a directory path with no file or object name

This book shows:

<directory>directory-path</directory>

You enter: <directory>/customers/widgetco/order</directory>

Ellipsis — Optionally, repeat the preceding parameter as many times as needed

This book shows: [object-property-value
    +(asc|desc)],...

You enter: size+asc, namespace+desc

Trademark and LegalDisclaimer

© 2015 Hitachi Data Systems Corporation. All rights reserved.