truesearch.status ================= Get the status of the index of each dataset that TrueSearch indexes. For each dataset, the status gives the state of the index, the number of entries in it, and the time of the last update. It also tells whether searches use the index. .. raw:: html
Type: object

Type: array
No Additional Items

TruesearchStatusData

Type: object

The indexing status of TrueSearch.

No Additional Properties

Running

Type: boolean

Whether the indexer responds.

Index Bytes


The size of all indexes, in bytes. The indexes are in the index dataset. It is the dataset .system/truesearchd on the pool of the system dataset. Its mountpoint is /var/db/system/truesearchd.

Type: integer
Type: null

Free Bytes


The free space in the index dataset, in bytes.

Type: integer
Type: null

Space Low


Whether the free space in the index dataset is less than twice the size of the largest index, or less than a rebuild of that index needs.

Type: boolean
Type: null

Datasets

Type: array of object

The status of each dataset that TrueSearch indexes.

No Additional Items
Each item of this array must be:

TruesearchDatasetStatus

Type: object
No Additional Properties

Dataset

Type: string

The name of the ZFS dataset.

Path

Type: string

The directory that TrueSearch indexes in the dataset. It is the deepest directory that contains all of the indexed shares in the dataset.

State

Type: enum (of string)

The state of the index of this dataset:

  • READY: The index is up to date.
  • INDEXING: The indexer builds or updates the index. During the first build, a search finds nothing in this dataset.
  • UNAVAILABLE: TrueSearch does not index or search the dataset now. reason gives the reason.
  • STOPPED: The indexer does not run.
Must be one of:
  • "READY"
  • "INDEXING"
  • "UNAVAILABLE"
  • "STOPPED"

Reason


The reason that the dataset is unavailable. This is null for the other states.

Type: string
Type: null

Served

Type: boolean

Whether searches use this index.

Entries


The number of files and directories in the index.

Type: integer
Type: null

Watching


Whether the indexer adds changes when they occur.

Type: boolean
Type: null

Last Full Pass


The time that the last pass over all files ended.

Type: stringFormat: date-time
Type: null

Last Directory Pass


The time that the last pass over all directories ended.

Type: stringFormat: date-time
Type: null

Index Size


The size of the index of this dataset, in bytes.

Type: integer
Type: null


*Required roles:* SERVICE_READ