Schema Format String Syntax
The following defines common syntax block options. These options appear in similar commands and are detailed here for easy reference.
The schema format string is used to define the structure of generated bulk statistics data. The string may contain static text, dynamic content, and bulk statistic variables, or any combination.
Static text includes any ASCII characters that are of a fixed value. Static text may also include control characters by using Escape character sequences. Supported Escape character shortcuts are "\n" for new line and "\t" for tab.
Enclosing an alphanumeric string within double quotation marks (") allows you to include spaces in the string.
Variables within the format string must be enclosed within "% and %", for example, "%var%". The actual variables supported are command-dependent and are described in the Statistics and Counters Reference (prior to Release 20.0) and in the Statistics and Counters spreadsheet (Release 20.0 and higher).
Schema Format String Length
The maximum length for a schema format specified via the CLI command cannot be more than 3599 characters long. However, the format should be broken into multiple lines using backslash such that each line is less than 1024 characters in length. The syntax is shown below.
<schema_type> schema <schema_name> format <schema_format>
<schema_name> can be a maximum of 31 alphanumeric characters.
<schema_format> can be a maximum of 3599 characters, including spaces within double quotation marks (" ").
Bulk Statistic Variables
For a list of the statistical variables (%var%) available for use in creating a schema format for each schema type:
Run the Exec mode show bulkstats variables schema_type command.
See the Statistics and Counters Overview chapter of the Statistics and Counters Reference (StarOS releases prior to 20.0) or the Statistics and Counters Reference spreadsheet (release 20.0 and higher) .