Common Request Parameters
A set of Common Request Parameters are required for each Device Service operation. Table lists all of the Common Request parameters for the Device Service operations. For more information on the parameters, view the TIBCO LogLogic® Appliance user interface for managing devices as well as the online help.
| 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 Management > 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 |
| 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 updateDevice Remote only) |
string |