Common Request Parameters

A set of common request parameters is required for each Device Group Service operation. The following table lists all of the common request parameters for the Device Group Service operations. For more information on the parameters, view the TIBCO LogLogic® appliance user interface for managing device groups as well as the online help.
Device Group Service Operation 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
deviceGroup​Name Name of the device group on the TIBCO LogLogic® appliance. Any text up to 64 characters in length. yes string
description Description for the device group. 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
groupType Type of device group, either local or global. The groupType value cannot be changed after the device profile is added. local or global 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
deviceNames DeviceName in the group

Device name. For example:

10.11.2.3_CiscoASA

If the device is not configured on the local appliance, then it is configured on the remote appliance. You must attach the remote appliance IP address as prefix. For example,

10.114.2.3/Device_name

yes string
changeNameTo New name of the device group.

If empty, the object name is unchanged.

(for LogLogic LMI and updateDeviceGroup
Remote only)

Any text up to 64 characters in length. yes

(for LogLogic LMI and updateDeviceGroup
Remote only)

string