---
title: Analytics.LogExport
slug: ps/help/en_us/vtm/controlapi/analyticslogexport
docTags: 
createdAt: 2026-08-02T08:52:22.912Z
---

URI: http\://soap.zeus.com/zxtm/1.0/Analytics/LogExport/

The Analytics.LogExport interface allows management of log files which should be exported to an analytics engine

### Methods

### addFiles( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Add the set of files to export as part of this category, specified as a list of glob patterns.

```bash
void addFiles(
String[] names
String[][] values
)
```

### addFilesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Add the set of files to export as part of this category, specified as a list of glob patterns. This is a location specific function, any action will operate on the specified location.

```bash
void addFilesByLocation(
String location
String[] names
String[][] values
)
```

### addLogExport( names ) throws InvalidObjectName, InvalidInput, ObjectAlreadyExists, DeploymentError

Add new log export categories.

```bash
void addLogExport(
String[] names
)
```

### copyLogExport( old\_names, new\_names ) throws ObjectAlreadyExists, InvalidObjectName, ObjectDoesNotExist, DeploymentError

Copy the named log export categories.

```bash
void copyLogExport(
String[] old_names
String[] new_names
)
```

### deleteLogExport( names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError

Delete the named log export categories.

```bash
void deleteLogExport(
String[] names
)
```

### deleteMetadata( names, metadata\_names ) throws ObjectDoesNotExist

Deletes the named metadata values.

```bash
void deleteMetadata(
String[] names
String[] metadata_names
)
```

### getApplianceOnly( names ) throws ObjectDoesNotExist

Get whether entries from the specified log files should be exported only from appliances.

```bash
Boolean[] getApplianceOnly(
String[] names
)
```

### getApplianceOnlyByLocation( location, names ) throws ObjectDoesNotExist

Get whether entries from the specified log files should be exported only from appliances. This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getApplianceOnlyByLocation(
String location
String[] names
)
```

### getBuiltIn( names ) throws ObjectDoesNotExist

Get whether this configuration is built-in. Editing and deletion of built in configurations is restricted.

```bash
Boolean[] getBuiltIn(
String[] names
)
```

### getEnabled( names ) throws ObjectDoesNotExist

Get whether to export entries from the log files included in this category.

```bash
Boolean[] getEnabled(
String[] names
)
```

### getEnabledByLocation( location, names ) throws ObjectDoesNotExist

Get whether to export entries from the log files included in this category. This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getEnabledByLocation(
String location
String[] names
)
```

### getFiles( names ) throws ObjectDoesNotExist

Get the set of files to export as part of this category, specified as a list of glob patterns.

```bash
String[][] getFiles(
String[] names
)
```

### getFilesByLocation( location, names ) throws ObjectDoesNotExist

Get the set of files to export as part of this category, specified as a list of glob patterns. This is a location specific function, any action will operate on the specified location.

```bash
String[][] getFilesByLocation(
String location
String[] names
)
```

### getHistory( names ) throws ObjectDoesNotExist

Get how much historic log activity should be exported.

```bash
Analytics.LogExport.History[] getHistory(
String[] names
)
```

### getHistoryByLocation( location, names ) throws ObjectDoesNotExist

Get how much historic log activity should be exported. This is a location specific function, any action will operate on the specified location.

```bash
Analytics.LogExport.History[] getHistoryByLocation(
String location
String[] names
)
```

### getHistoryPeriod( names ) throws ObjectDoesNotExist

Get the number of days of historic log entries that should be exported.

```bash
Unsigned Integer[] getHistoryPeriod(
String[] names
)
```

### getHistoryPeriodByLocation( location, names ) throws ObjectDoesNotExist

Get the number of days of historic log entries that should be exported. This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getHistoryPeriodByLocation(
String location
String[] names
)
```

### getLogExportNames()

Get the names of all the configured log export categories.

```bash
String[] getLogExportNames()
```

### getMetadata( names ) throws ObjectDoesNotExist

Get the metadata.

```bash
Analytics.LogExport.Metadata[][] getMetadata(
String[] names
)
```

### getNote( names ) throws ObjectDoesNotExist

Get a description of this category of log files.

```bash
String[] getNote(
String[] names
)
```

### getNoteByLocation( location, names ) throws ObjectDoesNotExist

Get a description of this category of log files. This is a location specific function, any action will operate on the specified location.

```bash
String[] getNoteByLocation(
String location
String[] names
)
```

### removeFiles( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Remove the set of files to export as part of this category, specified as a list of glob patterns.

```bash
void removeFiles(
String[] names
String[][] values
)
```

### removeFilesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Remove the set of files to export as part of this category, specified as a list of glob patterns. This is a location specific function, any action will operate on the specified location.

```bash
void removeFilesByLocation(
String location
String[] names
String[][] values
)
```

### renameLogExport( old\_names, new\_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, InvalidOperation, DeploymentError

Rename the named log export categories.

```bash
void renameLogExport(
String[] old_names
String[] new_names
)
```

### setApplianceOnly( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set whether entries from the specified log files should be exported only from appliances.

```bash
void setApplianceOnly(
String[] names
Boolean[] values
)
```

### setApplianceOnlyByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set whether entries from the specified log files should be exported only from appliances. This is a location specific function, any action will operate on the specified location.

```bash
void setApplianceOnlyByLocation(
String location
String[] names
Boolean[] values
)
```

### setBuiltIn( names, values ) throws InvalidOperation

Set whether this configuration is built-in. Editing and deletion of built in configurations is restricted.

```bash
void setBuiltIn(
String[] names
Boolean[] values
)
```

### setEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set whether to export entries from the log files included in this category.

```bash
void setEnabled(
String[] names
Boolean[] values
)
```

### setEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set whether to export entries from the log files included in this category. This is a location specific function, any action will operate on the specified location.

```bash
void setEnabledByLocation(
String location
String[] names
Boolean[] values
)
```

### setFiles( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the set of files to export as part of this category, specified as a list of glob patterns.

```bash
void setFiles(
String[] names
String[][] values
)
```

### setFilesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the set of files to export as part of this category, specified as a list of glob patterns. This is a location specific function, any action will operate on the specified location.

```bash
void setFilesByLocation(
String location
String[] names
String[][] values
)
```

### setHistory( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set how much historic log activity should be exported.

```bash
void setHistory(
String[] names
Analytics.LogExport.History[] values
)
```

### setHistoryByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set how much historic log activity should be exported. This is a location specific function, any action will operate on the specified location.

```bash
void setHistoryByLocation(
String location
String[] names
Analytics.LogExport.History[] values
)
```

### setHistoryPeriod( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the number of days of historic log entries that should be exported.

```bash
void setHistoryPeriod(
String[] names
Unsigned Integer[] values
)
```

### setHistoryPeriodByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the number of days of historic log entries that should be exported. This is a location specific function, any action will operate on the specified location.

```bash
void setHistoryPeriodByLocation(
String location
String[] names
Unsigned Integer[] values
)
```

### setMetadata( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set the metadata.

```bash
void setMetadata(
String[] names
Analytics.LogExport.Metadata[][] values
)
```

### setNote( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set a description of this category of log files.

```bash
void setNote(
String[] names
String[] values
)
```

### setNoteByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError

Set a description of this category of log files. This is a location specific function, any action will operate on the specified location.

```bash
void setNoteByLocation(
String location
String[] names
String[] values
)
```

### Structures

### Analytics.LogExport.Metadata

A named metadata item for a log export category

```bash
struct Analytics.LogExport.Metadata {
# The name of the metadata item.
String name;
# The value of the metadata item.
String value;
}
```

### Enumerations

### Analytics.LogExport.History

```bash
enum Analytics.LogExport.History {
# Do not export any historic entries
none,
# Export all historic entries
all,
# Export recent historic entries, according to the 'history_period' setting
recent
}
```