[Contents] [Prev] [Next] [Index] [Report an Error]

Mapping for Objects That Have an Identifier

At some hierarchy levels, the same kind of configuration object can occur multiple times. Each instance of the object has a unique identifier to distinguish it from the other instances. In the CLI notation, the parent statement for such an object consists of a keyword and identifier of the following form:




keyword identifier {

    … configuration statements for individual characteristics …

}

keyword is a fixed string that indicates the type of object being defined, and identifier is the unique name for this instance of the type. In the SRC XML API, the tag element corresponding to the keyword is a container tag element for child tag elements that represent the object’s characteristics. The container tag element’s name generally matches the keyword string.

The SRC XML API differs from the CLI in its treatment of the identifier. Because the SRC XML API does not allow container tag elements to contain both other tag elements and untagged character data such as an identifier name, the identifier must be enclosed in a tag element of its own. Most frequently, identifier tag elements for configuration objects are called <name>. Some objects have multiple identifiers, which usually have names other than <name>. To verify the name of each identifier tag element for a configuration object, consult the entry for the object in the SRC XML API Configuration Reference.

Note: The SRC software reserves the prefix sdx- for the identifiers of configuration groups defined within the sdx-defaults configuration group. User-defined identifiers cannot start with the string sdx-.

Identifier tag elements also constitute an exception to the general XML convention that tag elements at the same level of hierarchy can appear in any order; the identifier tag element always occurs first within the container tag element.

The configuration for most objects that have identifiers includes additional leaf statements, which represent other characteristics of the object. For example, each SAE group configured at the [edit shared sae group] hierarchy level has an associated name (the identifier) and can have leaf statements for other characteristics, such as configuration, DHCP classification script, and subscriber classification script. For information about the XML mapping for leaf statements, see Mapping for Single-Value and Fixed-Form Leaf Statements, Mapping for Leaf Statements with Multiple Values, andUsing the Same Configuration Tag Elements in Requests and Responses.

The following example shows the XML tag elements for configuration statements that define two users called U1 and U2. Notice that the XML <user-name> tag element that encloses the identifier of each user does not have a counterpart in the CLI statements. For complete information about changing C-series Controller configurations, see Changing Configuration Information.

CLI Configuration Statements	SRC XML Tags
system login { user U1 { class admin; } user U2 { class admin; } }	<configuration> <system> <login> <user> <user-name>U1</user-name> <!-- identifier --> <class>admin</class> </user> <user> <user-name>U2</user-name> <!-- identifier --> <class>admin</class> </user> </login> </system> </configuration>

CLI Configuration Statements

SRC XML Tags

system login {
  user U1 {
    class admin;
  }
  user U2 {
    class admin;
  }
}

<configuration>
  <system>
    <login>
      <user>
        <user-name>U1</user-name> 
        <class>admin</class>
      </user>
      <user>
        <user-name>U2</user-name> 
        <class>admin</class>
      </user>
    </login>
  </system>
</configuration>

[Contents] [Prev] [Next] [Index] [Report an Error]