tibrvcfg

Command

Syntax

tibrvcfg [-http-only]
         [-login name:password ]
         [-url base_url ]
         command arg1 arg2 ...

Purpose

Connect to a daemon component and run one configuration command.

Remarks

This tool lets you send one configuration command to a component. The set of configuration commands parallels the methods of the configuration API. For details about any command, see page in this book that documents the corresponding method. For XML commands, see XML Commands.

The script tibrvcfg resides in the bin directory under TIBRV_HOME.

Parameter

Description

-http-only

When present, the configuration tool uses non-secure HTTP protocols to connect to the component, instead of secure HTTPS protocols.

You must specify -http-only to tibrvcfg if and only if the component command line specified -http-only.

-login name:password

When present, the configuration tool supplies this administrator name and password when the component requests them. For more information, see SecurityProxy.useCredentials().

-url base_url

When present, the configuration tool connects to the browser administration interface of the component at this URL. When loading an XML file, this parameter (if present) overrides the URL in the XML file.

When absent, the configuration tool seeks the component at the default URL, http://localhost:7580, which is appropriate for rvd, rvrd, rvsd or rvsrd, running on the same computer as the configuration tool.

Construct the URL from the IP address of the daemon’s host computer, and its HTTP port.

command arg1 arg2 ...

The remaining parameters specify the command to the component, and its arguments.

If you omit the command, or supply an invalid command, the configuration tool outputs a lengthy help message that lists all valid commands.

Execution as a Java Object

The tibrvcfg script is the most convenient way to use this tool, because it automatically arranges the environment properly. However, you can bypass the script, executing the tool as a Java object; for example:

  java com.tibco.tibrv.config.tools.TibrvConfigurationTool ...

XML Commands

Command

Description

dumpXML [ output_filename ]

dumpXML gets current configuration data from a component, and builds an XML document incorporating that data.

When output_filename is present, dumpXML directs the XML document to the specified file. The file is suitable as input for the mergeXML or matchXML command. When output_filename absent, the default is stdio.

mergeXML xml_file

mergeXML reads an XML document, and builds a set of commands to update the component with configuration in the XML document—overlaying the existing configuration with changes specified in the XML file. Where the two configurations conflict, the XML document overrides the existing configuration. Elements of the existing configuration that do not conflict with the XML specification remain in force.

The parameter xml_file must contain an XML document appropriate for configuring the component (its syntax must conform to the DTD specification).

matchXML xml_file

matchXML reads an XML document, and builds a set of commands that force the component to conform to the XML document—removing elements of the existing configuration that are absent from the XML specification.

The parameter xml_file must contain an XML document appropriate for configuring the component (its syntax must conform to the DTD specification).

Merge vs. Match

To illustrate the difference between mergeXML and matchXML, consider an example in which the existing configuration of rvrd has two routers, R1 and R2; the XML document specifies a change to R2 and a new router R3:

With mergeXML, R1 remains unchanged, R2 is modified, and R3 is added.
With matchXML, R1 is removed, R2 is modified, and R3 is added.
Creating XML Input

You may edit the XML output of dumpXML, and supply the edited file as input to mergeXML or matchXML. The edited file must conform to the DTD.