Mapping For Comments About Configuration Statements - Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual

Junos 10.3 Junos XML Management Protocol Guide

Mapping for Comments About Configuration Statements

20
A Junos configuration can include comments that describe statements in the configuration.
In CLI configuration mode, the
with a statement at the current hierarchy level. You can also use a text editor to insert
comments directly into a configuration file. For more information, see the Junos CLI User
Guide.
The Junos XML API encloses comments about configuration statements in the
tag element. (These comments are different from the comments that
<junos:comment>
are enclosed in the strings
server.)
In the Junos XML API, the
<junos:comment>
element for the associated configuration statement. (If the tag element for the associated
statement is omitted, the comment is not recorded in the configuration database.) The
comment text string can include one of the two delimiters that indicate a comment in
the configuration database: either the
strings before the comment and
/*
the delimiter, the protocol server adds the appropriate one when it adds the comment
to the configuration. The protocol server also preserves any white space included in the
comment.
The following example shows the Junos XML tag elements that associate comments
with two statements in a sample configuration statement. The first comment illustrates
how including newline characters in the contents of the
( /* New backbone area */ ) results in the comment appearing on its own line in the
configuration file. There are no newline characters in the contents of the second
tag element, so in the configuration file the comment directly follows
<junos:comment>
the associated statement on the same line.
command specifies the comment to associate
annotate
<!-- and --> and are automatically discarded by the protocol
tag element immediately precedes the tag
character before the comment or the paired
#
after it. If the client application does not include
*/
tag element
<junos:comment>
Copyright © 2010, Juniper Networks, Inc.