Home » Web Services Implementation Guide

Message Routing Service Operations

Submitted by Anonymous on Tue, 06/03/2008 - 12:38

Message Routing Service Operations

The Message Routing Service operations enable you to manage message routing rules for your LogLogic Appliance.

Overview

The Message Routing Service operations enable you to create, read, update, and delete message routing rules as well as view all message routing rules in your LogLogic Appliance.

Message Routing Rules let you forward a copy of incoming log data from one LogLogic Appliance to another LogLogic Appliance or 3rd party device. In the LogLogic Appliance you can view the user interface implementation by navigating to Administration > Message Routing.

Implementation Guidelines

The following are general implementation guidelines for the Message Routing Service operations:


  • A set of Common Request Parameters are required for each operation.
  • You must specify a value for all Required parameters.
  • You must specify the value of the Common Request Parameters only.
  • All parameters must be implemented in the order in which they appear in the Request Parameters section for each of the operations.
  • All values for Common Request Parameters must be enclosed by double quotation marks (“value”). If the name of a device or a parameter value includes a forward
    slash (/), such as HP/UX, or IBM i5/OS, you must replace the forward slash with %2F.
    (The F is case-sensitive.)
    Examples: HP%2FUX or IBM i5%2FOS

Message Routing Service Operation Descriptions

There are two kinds of operations:


  • local - operation is performed on the local Appliance itself
  • remote - operations (names ending with Remote) performed on a specified remote Appliance

The Message Routing Service contains the following operations:

Status Codes

The Status Codes are:

2000 Server success
4000 Unauthorized request
5000 Invalid parameter, getStatusMessage() contains detail information about the error

Common Request Parameters

A set of Common Request Parameters are required for each Message Routing Service operation. This table lists all of the Message Routing Service Common Request Parameters. For more information on the parameters, view the 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 Unique authentication token.   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 xxxxRemote 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, SNMP, LogLogic TCP
For more information on 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 on 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, Log Alert, Log Audit, Mail, News, NTP, Printer, Syslog, System, User-Level, UUCP
For more information on each facility, see the online help.		 no string
searchFilterName Name of the search filter. Any text up to 64 characters in length. yes string
compressionEnabled 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 Enables or disables encryption of the message routing rule. Possible values:
yes -- enable
no -- disable		 yes string
authenticationEnabled 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.		 Any text up to 64 characters in length. yes (for updateMsgRouting and updateMsgRoutingRemote only) string
0
Your rating: None

User login

Current Poll

What programming language are you using to communicate with the LogLogic API?:

Recent Comments