Device Service Operations

The Device Service operations enable you to manage devices in your LogLogic Appliance.

Overview

The Device Service operations let you create, read, update, and delete devices as well as view all devices in the LogLogic Appliance.

Devices are any source of log data that you want captured by a LogLogic Appliance. In the LogLogic Appliance, to view the user interface implementation navigate to Administration > Manage Devices.

Implementation Guidelines

The following are general implementation guidelines for Device 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
  
• When using the createDevice Operation, createDeviceRemote Operation, updateDevice Operation, or updateDeviceRemote Operation, if the dnsRefreshEnabled parameter is enabled, the value for the deviceName parameter can be overwritten by the value on your DNS server. If this occurs, use the DNS name of the device as the value for the deviceName parameter. You can retrieve the DNS name by looking up the IP address of the device.

Device 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 Device Service operations are as follows:

• createDevice Operation
  
• createDeviceRemote Operation
  
• readDevice Operation
  
• readDeviceRemote Operation
  
• updateDevice Operation
  
• updateDeviceRemote Operation
  
• deleteDevice Operation
  
• deleteDeviceRemote Operation
  
• getList Operation
  
• getListRemote Operation
  
• deviceResponse Type
  

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 Device Service operation. This table lists all of the Common Request parameters for the Device Service operations. For more information on the parameters, view the LogLogic Appliance user interface for managing devices as well as the online help.

Device Service Operation 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
deviceName	Name of the device from which you intend to transfer log data.	Any text up to 64 characters in length.	yes	string
deviceType	Type of device or application generating the logs to be transferred. The deviceType value cannot be changed once the device profile is added.	For example “Cisco Pix” See the Administration > Manage Devices user interface for a list of available device type values.	yes	string
description	Description for the remote device. If you do not provide a description, you must at least specify the value as an empty string.	Any text up to 64 characters in length. Type double quotation marks (““) to specify an empty string or no description text.	yes	string
enabled	Indicates whether retrieval of log files from this device is enabled. (Appears as enabled or disabled in returned value.)	Possible values: yes -- enable no -- disable	yes	string
dnsRefreshEnabled	Enables the Device Name to be refreshed through DNS lookups. The DNS name might override any name you assign in the deviceName.	Possible values: yes -- enable no -- disable	yes	string
deviceIp	IP address of the device from which you want to transfer files.	Standard IP address format. For example: 10.1.2.3	yes	string
changeNameTo	New name of the device. If empty, the object name is unchanged.	Any text up to 64 characters in length.	yes (for updateDevice and updateDeviceRemote only)	string