Skip to content

xaction.md

Latest commit

 

History

History
109 lines (69 loc) · 3.47 KB

xaction.md

File metadata and controls

109 lines (69 loc) · 3.47 KB
Raw

CLI Reference for Xaction (Job) management

Batch operations that may take many seconds (minutes, hours) to execute are called eXtended actions or xactions.

AIS xactions run asynchronously, have one of the enumerated kinds, start/stop times, and xaction-specific statistics. For more information, please refer to this document.

Table of Contents

Start xaction

ais job start <XACTION_COMMAND> [arguments...]

Start xaction(s). Some xactions require additional arguments such as bucket name to execute.

Examples

Start cluster-wide LRU

Starts LRU xaction on all nodes

$ ais job start lru
Started "lru" xaction.

An administrator may choose to run LRU on a subset of buckets. This can be achieved by using the --buckets flag to provide a comma-separated list of buckets, for instance --buckets bck1,gcp://bck2, on which LRU needs to be performed. Additionally, the --force(-f) option can be used to override the bucket's lru.enabled property.

Note: To ensure safety, the force flag (-f) only works when a list of buckets is provided.

$ ais job start lru --buckets ais://buck1,aws://buck2 -f

Stop xaction

ais job stop xaction XACTION_ID|XACTION_NAME [BUCKET]

Stop xaction(s). The second argument is used to determine the bucket name if it is required.

Examples

Stop cluster-wide LRU

Stops currently running LRU xaction.

$ ais job stop xaction lru
Stopped "lru" xaction.

Show xaction stats

ais show job xaction [XACTION_ID|XACTION_NAME] [BUCKET]

Display details about XACTION_ID or XACTION_NAME xaction. If no arguments are given, displays details about all xactions. The second argument is used to determine the bucket name if it is required.

Options

Flag Type Description Default
--json bool Output details in JSON format false
--all bool If set, additionally displays old, finished xactions false
--active bool If set, displays only running xactions false
--verbose -v bool If set, displays extended information about xactions where available false

Certain extended actions have additional CLI. In particular, rebalance stats can also be displayed using the following command:

ais show rebalance

Display details about the last rebalane xaction.

Flag Type Description Default
--refresh [N] string watch the rebalance until it finishes or CTRL-C is pressed. Display the current stats every N seconds, where N ends with time suffix: s, m. If N is not defined it prints stats every 1 second 1s
--all bool If set, show all rebalance xactions false

Output of this command differs from the generic xaction output.

Wait for xaction

ais job wait xaction XACTION_ID|XACTION_NAME [BUCKET]

Wait for the XACTION_ID or XACTION_NAME xaction to finish.

Options

Flag Type Description Default
--refresh duration Refresh rate 1s

Distributed Sort

ais job start dsort

Run dSort. Further reference for this command can be found here.

Downloader

ais job start download

Run the AIS Downloader. Further reference for this command can be found here.