Technical Documentation

annotate

Syntax

annotate statement "comment-string"

Release Information

Command introduced before JUNOS Release 7.4.

Description

Add comments to a configuration. You can add comments only at the current hierarchy level.

Any comments you add appear only when you view the configuration by entering the show command in configuration mode or the show configuration command in operational mode.

Note: The JUNOS Software supports annotation up to the last level in the configuration hierarchy. However, annotation of the configuration options or statements within the last level in the hierarchy is not supported. For example, in the following sample configuration hierarchy, annotation is supported up to the level 1 parent hierarchy, but not supported for the metric child statement:

[edit protocols]isis {interface ge-0/0/0.0 {level 1 metric 10;}}}

Options

comment-string—Text of the comment. You must enclose it in quotation marks. In the comment string, you can include the comment delimiters /* */ or #. If you do not specify any, the comment string is enclosed with the /* */ comment delimiters. If a comment for the specified statement already exists, it is deleted and replaced with the new comment.

statement—Statement to which you are attaching the comment.

Required Privilege Level

configure—To enter configuration mode, but other required privilege levels depend on where the statement is located in the configuration hierarchy.


Published: 2010-04-27