Documentation Conventions

The Solace customer documentation uses the following conventions:

Examples of Solace CLI commands and responses are written in the following manner:
```
solace(configure)#
```
For this particular example, the Solace CLI is acting for the host event broker solace, it is at a CONFIG level, and it is awaiting a command string after the CONFIG prompt character (#).
When an item in a CLI command is not enclosed by < >, [ ], or { } symbols, the item is a required keyword.
Example:
```
solace(configure/service/smf)# shutdown
```
When an item in a CLI command is enclosed with < > symbols, the information requested is a variable and required.
Example:
```
interface <interface-id>
```
When an item in a CLI command is enclosed with [ ] symbols, the information requested is optional.
Example:
```
show logging debug [<subsystem-id>]
```
When an item in a CLI command is enclosed by { } symbols, the information requested is a list of options (keywords or variables), of which exactly one is required.
Example:
```
boot {<version> | backout}
```
When two or more options in a CLI command are separated by a | symbol, you may enter at most one of the options as part of the command.
Example:
```
tree [all | global]
```

Code snippets and command outputs are displayed in Courier font and may use a gray background.

Example:

solace> show hardware

Platform: Solace 3560
Power redundancy configuration: 1+1
Operational power supplies: 1
System Type: topic-routing
Supported Blade Configuration: Yes
. . .

Code snippets and command outputs are provided for demonstration purposes only. You should not assume that a code snippet copied directly from this document will work correctly in your CLI or that the response that is listed will be an exact match to what your operating environment will generate.
System limits and supported value ranges for configuration parameters may be written with decimal (for example, megabytes) or binary (for example, mebibytes) units. In some places, binary units will include the exact number of bytes for clarity.

Unit	Abbreviation	Size in Bytes
kilobyte	KB	1,000
kibibyte	KiB	1,024
megabyte	MB	1,000,000 or 1000²
mebibyte	MiB	1,048,576 or 1024²
gigabyte	GB	1,000,000,000 or 1000³
gibibyte	GiB	1,073,741,824 or 1024³
terabyte	TB	1,000,000,000,000 or 1000⁴
tebibyte	TiB	1,099,511,627,776 or 1024⁴

For some configuration parameters, the maximum permitted values may not be explicitly stated in this document because they are dependent on factors that may vary (for example, the hardware, API, or protocols used).

Provide feedback