io7m | single-page | multi-page | Cardant User Manual 1.0.0-SNAPSHOT
7.2. Shell Command Reference
Previous
7.2. Shell Command Reference
Up
7.2.2. audit-search-next
Next

# 7.2.1. audit-search-begin

- 7.2.1.1. Name
- 7.2.1.2. Description
- 7.2.1.3. Parameters
- 7.2.1.4. Examples

## 7.2.1.1. Name

1
audit-search-begin - Begin searching for audit records.

## 7.2.1.2. Description

1
The audit-search-begin command begins searching for audit records.

## 7.2.1.3. Parameters

### 7.2.1.3.1. --limit

Attribute | Value
--- | ---
Name | --limit
Type | java.lang.Integer
Default Value | 10
Cardinality | [1, 1]
Description | The maximum number of results per page.

### 7.2.1.3.2. --time-from

Attribute | Value
--- | ---
Name | --time-from
Type | java.time.OffsetDateTime
Default Value | 1970-01-01T00:00Z
Cardinality | [1, 1]
Description | Return audit events later than this date.

### 7.2.1.3.3. --time-to

Attribute | Value
--- | ---
Name | --time-to
Type | java.time.OffsetDateTime
Default Value | +101970-01-01T00:00Z
Cardinality | [1, 1]
Description | Return audit events earlier than this date.

### 7.2.1.3.4. --type-equal-to

Attribute | Value
--- | ---
Name | --type-equal-to
Type | java.lang.String
Default Value |
Cardinality | [0, 1]
Description | Filter events by type.

### 7.2.1.3.5. --type-not-equal-to

Attribute | Value
--- | ---
Name | --type-not-equal-to
Type | java.lang.String
Default Value |
Cardinality | [0, 1]
Description | Filter events by type.

### 7.2.1.3.6. --user

Attribute | Value
--- | ---
Name | --user
Type | com.io7m.cardant.model.CAUserID
Default Value |
Cardinality | [0, 1]
Description | Filter events by user.

## 7.2.1.4. Examples

### 7.2.1.4.1. Example

    $ audit-search-begin
    Search results: Page 1 of 1
    ┌────┬──────────────────────────────────────┬────────────────┬─────────────────────────────┬─────────────────────────────────────────────────────────────────────────┐
    │ ID │ Owner                                │ Type           │ Time                        │ Data                                                                    │
    ├────┼──────────────────────────────────────┼────────────────┼─────────────────────────────┼─────────────────────────────────────────────────────────────────────────┤
    │ 1  │ c5574d46-7413-43c8-b6db-31001c382ca3 │ USER_LOGGED_IN │ 2023-12-21T11:30:11.171839Z │ {UserAgent=com.io7m.cardant.client/0.0.1-SNAPSHOT, Host=10.1.6.1:53236} │
    └────┴──────────────────────────────────────┴────────────────┴─────────────────────────────┴─────────────────────────────────────────────────────────────────────────┘

7.2. Shell Command Reference
Previous
7.2. Shell Command Reference
Up
7.2.2. audit-search-next
Next
io7m | single-page | multi-page | Cardant User Manual 1.0.0-SNAPSHOT