Documentation Index

Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt

Use this file to discover all available pages before exploring further.

vastcatalogconfig modify

Prev Next

This command enables or disables VAST Catalog, and also modifies the periodic snapshot schedule for VAST Catalog.

Usage

vastcatalogconfig modify --id ID
                        [--schedule SCHEDULE]
                        [--enable|--disable]
                        [--splits COUNT]

Required Parameters

--id ID

Specifies the ID of the existing VAST Catalog configuration. To retrieve this ID, use vastcatalogconfig list.

Options

--schedule SCHEDULE

Specifies the schedule definition in the following format:

every <integer><time unit> start-at YYYY-MM-DD HH:MM:SS keep-local <integer><time unit> keep-remote <integer><time unit>

For example:

--schedule every 90m start-at 2025-07-27 20:10:35 keep-local 10h keep-remote 30d

--enable

Enables VAST Catalog.

--disable

Disables VAST Catalog.

--splits COUNT

Specifies the number of splits (concurrent threads) used to scan catalog tables. This option can be used to improve VAST Catalog performance for queries that require scanning a large amount of table rows.

Example

vcli: admin> vastcatalogconfig modify --id 1 --enable