Common Request Parameters

A set of common request parameters is required for each Message Routing Service operation. The following table lists all of the Message Routing Service common request parameters. For more information about the parameters, view the TIBCO LogLogic® appliance user interface for message routing as well as the online help.
Message Routing Service Common Request Parameters
Parameter Description Values Required Type
authToken Token string returned from the authentication service or the “username/password”.   yes string
applianceIp The managed Appliance on which you perform the operation.

If the value is blank, it retrieves the Appliance IP address from the local Appliance.

This parameter is available only for Management Station Appliances using operations with Remote in the name.

IP address of a managed Appliance. To specify an IP address, use the standard IP address format. For example:

10.1.2.3

yes

(for xxxx Remote

operations only)

string
routingName Name of the routing or forwarding rule. Any text up to 64 characters in length. yes string
sourceDevice Source device from where messages are routed. Any text up to 64 characters in length. yes string
destinationIP IP address for the message forwarding. Standard IP address format. For example:

10.1.2.3

yes string
destinationPort Port for the message forwarding. Any positive integer. yes number
routingProtocol Protocol used for message forwarding. Possible values:
  • UDP Syslog
  • Raw TCP Syslog
  • LogLogic TCP

For more information about each protocol, see the online help.

yes string
enabled Enables message routing.

(Appears as enabled or disabled in returned value.)

Possible values:

yes — enable

No — disable

yes string
severity Message type used to filter messages Possible values:
  • All
  • Emergency
  • Alert
  • Critical
  • Error
  • Warning
  • Notice
  • Informational
  • Debug

For more information about each severity level, see the online help.

no string
facility The facility specifies the subsystem that produced the message. For example, all mail programs log with the mail facility (LOG_MAIL) if they log using syslog. Possible values:
  • auth
  • auth2
  • Clock
  • Clock2
  • FTP
  • kernel
  • Local0
  • Local1
  • Local3
  • Local4
  • Local5
  • Local6
  • Local7
  • LogAlert
  • LogAudit
  • Mail
  • News
  • NTP
  • Printer
  • Syslog
  • System
  • User-Level
  • UUCP

For more information about each facility, see the online help.

no string
searchFilterName Name of the search filter. Any text up to 64 characters in length. yes string
compression
Enabled
Note: Only applicable to LogLogic TCP
Enables or disables compression for LogLogic TCP message routing.

For LX Appliances, LogLogic recommends enabling compression.

Possible values:

yes — enable

no — disable

yes string
encryptionEnabled
Note: Applicable to TCP Syslog and LogLogic TCP.
Enables or disables encryption of the message routing rule. Possible values:

yes — enable

no — disable

yes string
authentication
Enabled
Note: Applicable to TCP Syslog and LogLogic TCP.
Enables and disables authentication of the log message.

When authentication is in use, there must be an Upstream Device profile of the current Appliance on the destination Appliance, and the authentication string in that profile must match the Authentication string from the current Appliance's General tab.

Possible values:

yes — enable

no — disable

yes string
changeNameTo New name of the routing or forwarding rule.

If empty, the object name is unchanged.

TIBCO LogLogic® Log Management Intelligence

(for Web Services API Implementation Guide and updateMsg
RoutingRemote only)

Any text up to 64 characters in length. yes string