Configuring the Network Publisher
To configure the network publisher:
For information about the fields in this file, see Network Publisher Configuration File Fields.
Network Publisher Configuration File Fields
The /opt/UMC/nic/etc/networkPublisher/config.properties file contains the following types of configuration fields:
- Logging Configuration Fields
- Router Configuration Fields
- Filter Configuration Fields
- Directory Configuration Fields
- Troubleshooting Configuration Fields
Entries in the file have the format <field>=<value>.
The network publisher identifies routers by a number; for example, r1, r2.
Logging Configuration Fields
The network publisher uses the same logging properties as other SDX components.
See SDX Monitoring and Troubleshooting Guide, Chapter 2, Configuring Logging for SDX Components.
Router Configuration Fields
The router configuration fields provide information about the JUNOS routing platforms on which interfaces reside for which the network publisher collects information.
/routers/tags.release
- Release number of the JUNOS software installed on the JUNOS routing platform.
- Value—Release number in the format:
<major release>.<minor release>R<revision>
- Guidelines—If a value is also specified under /routers/r<number>tags.release, the value for the specified router is used for that router.
- Default—No value
- Example—/routers/tags.release=7.6R1
/routers/tags.hostname
- Hostname of the machine on which the network publisher runs.
- Value—<hostname>
- Default—No value
- Example—/routers/tags.hostname=myhost
/routers/junoscript-authentication.username
- Username to log in to the JUNOScript server.
- Value—<username>
- Default—No value
- Example—/routers/junoscript-authentication.username=root
/routers/junoscript-authentication.challenge_response
- Password to log in to the JUNOScript server
- Value—<password>
- Default—No value
- Example—/routers/junoscript-authentication.challenge_response=secret
/routers/r<number>/hostname
- Hostname of a JUNOS routing platform.
- Value—<hostname>
- Default—No value
- Example—/routers/r1/hostname=RouterExternal
/routers/r<number>/address
- IP address of the JUNOS routing platform for which you specified a hostname.
- Value—<IP address in dotted decimal notation>
- Default—No value
- Example—/routers/r1/address=10.10.10.10
/routers/r<number>/tags.release
- Release number of the JUNOS software installed on a specific JUNOS routing platform.
- Value—Release number in the format:
<major release>.<minor release>R<release number>
- Guidelines—If a value is also specified under /routers/tags.release, the value for the specified router is used for that router.
- Default—No value
- Example—/routers/r1/tags.release=7.6R1
Filter Configuration Fields
The filter configuration fields specify filters that the network publisher uses to collect information from JUNOS routing platforms. You can specify two filters.
/transform/route_table_filter
- Routing table from which the network publisher collects interface information.
- Value—Element name in the format:
/transform/route_entry_filter
- Element(s) in a specified router table from which the network publisher collects interface information.
- Value—Element name in the format:
Directory Configuration Fields
The directory fields specify information used to connect to the directory.
/dir/java.naming.provider.url
<host>—IP address or name of directory host
/dir/java.naming.security.principal
- Distinguished name (DN) of the directory entry that defines the username with which the network publisher accesses the directory.
- Value—<DN>
- Default—No value
- Example—/dir/java.naming.security.principal = cn=umcadmin, o=umc
/dir/java.naming.security.credentials
- Password with which the network publisher accesses the directory.
- Value—<password>
- Guidelines—The password can be encoded in base64 and not visible in plain text. To use an encoded value, use the format {BASE64} <encoded-value>.
- Default—No value
- Example
- /dir/java.naming.security.credentials = admin123
- /dir/java.naming.security.credentials = {BASE64}c3Nw
/dir/baseDN
- Subtree in the directory that stores router data.
- Value—<DN>
- Default—o=Network, o=umc
- Example—/dir/baseDN=o=Network, o=umc
Troubleshooting Configuration Fields
The troubleshooting configuration fields let you specify file information that you can use to troubleshoot configuration for the network publisher.
/routers/r<number>/session_type
- File that contains properties for the routers.
- Value—<filename>
- Guidelines—By default, the network publisher obtains router information through a Telnet session. You can specify an input file for one or more routers to troubleshoot the configuration for the network publisher. The values in an input file for a specified router take precedence over values obtained from the router through a Telnet session.
- Default—LocalFile
- Example—/routers/r1/session_type = LocalFile
/routers/r<number>/input_dir
- Directory that contains the <router_name>_1.xml document (where router_name is the hostname of a router), which contains router properties for the network publisher.
- Value—<directory-name>
- Guidelines—Use a file in the input directory if you do not want to connect to the router to obtain the interface configuration information. Use a file defined by routers/r<number>/session_type in this directory to troubleshoot the configuration for the network publisher.
- Default—/opt/UMC/nic/sample/junos/rt
- Example—/routers/r1/input_dir =/opt/UMC/nic/myconfig
/routers/r<number>/output_dir
- Directory that contains the <router_name>_1.xml document (where router_name is the hostname of a router), which contains interface configuration information collected from the routing table on a JUNOS routing platform.
- Value—<directory-name>
- Guidelines—You must specify an output directory for information to be written to an output file. You can read the information stored in files in this directory to determine whether they contain the expected information from the routing table on the specified JUNOS routing platform.
- Default—opt/UMC/nic/var/junos/rt
- Example—/routers/r1/output_dir = /var/junos/mydir