|
|
|
|
This section explains how information is organized and presented in this book.
This book is organized as follows:
Introduction to SNAP-IX Administration Commands, provides an overview of the tasks involved in administering SNAP-IX, provides an overview of how to use the snaadmin administration program, and describes characteristics (such as parameter type) that are common to parameters used by all commands.
Administration Commands, provides detailed information about the parameters required for specific administration operations such as defining, starting, or querying a particular resource.
Common Return Codes from snaadmin Commands, lists error return codes that are common to all commands.
Configuration Files, describes the contents of the data files that control how SNAP-IX operates and explains how to modify these files if required.
Environment Variables, provides a brief summary of all the environment variables that are used by SNAP-IX programs.
Typographic Conventions shows the typographic styles used in this document.
| Special Element | Sample of Typography |
| Document title | SNAP-IX Administration Command Reference |
| File or path name | sna.err |
| Directory name | /var/opt/sna |
| Program or application | snaadmin |
| Command or utility | define_node; snahelp |
| General reference to all commands of a particular type | For example, query_* indicates all the administration records that query details of a SNAP-IX resource (query_cn, query_cos , query_dlc, and so on). |
| Option or flag | |
| Parameter | lu_name |
| Literal value or selection that the user can enter (including default values) | 255 |
| Constant (one of several possible parameter values) | |
| Return value | INVALID_LU_ALIAS |
| Variable representing a supplied value | infile |
| Environment variable | |
| User input | snaadmin status_dependent_lu,pu_name=ETH0 |
| Function, call, or entry point | ctime() |
| Data structure | |
| Field name (in a data structure) | |
| Keyboard keys | ENTER |
| Hexadecimal value | 0x20 |
|
|
|
 |
|