XRA-31 Command-line Interface¶

The same functionality available in the XRA-31 web interface can be accessed from the command-line. The items in the XRA-31 Control Panel map one-to-one on the following commands:

xra31-configure,
xra31-capture and
xra31-analyse.

Commands¶

xra31-configure¶

Configure the XRA-31 channels. The three commands can be combined, and will be executed in the order store, load, wait-lock.

usage: xra31-configure [-h] [-f] [-q] [-v] [--version] [--store channels.json]
                       [--load channels.json] [--wait-lock] [-t TIMEOUT]
                       [XRA-31]

positional arguments¶

xra-31¶: XRA-31 hostname or IP address

optional arguments¶

-h, --help¶: show this help message and exit

-f, --force¶: force full access mode if it’s in use

-q, --quiet¶: don’t print progress messages

-v, --verbose¶: print debugging messages

--version¶: print client version and server version

commands¶

--store <channels.json>¶: store the current XRA-31 channel configuration to JSON

--load <channels.json>¶: load a JSON channel configuration to the XRA-31

--wait-lock¶: wait for all channels to be locked

command options¶

-t <timeout>, --timeout <timeout>¶: maximum time to wait for lock and channel detection (seconds)

xra31-capture¶

Configure the XRA-31 capture. The commands can be combined, and will be executed in the order store, load, start, stop, wait (end or file-end). Command-line output options override configurations in the loaded file.

usage: xra31-capture [-h] [-f] [-q] [-v] [--version] [--store capture.json]
                     [--load capture.json] [--start] [--stop] [--wait-end]
                     [--wait-file-end] [-p directory/capture.pcap]
                     [-D DURATION] [-S SIZE] [-n NUMBER_OF_FILES]
                     [-d FILE_DURATION] [-s FILE_SIZE] [-t TIMEOUT]
                     [XRA-31]

positional arguments¶

xra-31¶: XRA-31 hostname or IP address

optional arguments¶

-h, --help¶: show this help message and exit

-f, --force¶: force full access mode if it’s in use

-q, --quiet¶: don’t print progress messages

-v, --verbose¶: print debugging messages

--version¶: print client version and server version

commands¶

--store <capture.json>¶: store the current XRA-31 capture configuration to JSON (channels, filtering, output)

--load <capture.json>¶: load a JSON capture configuration to the XRA-31

--start¶: start capturing

--stop¶: stop capturing

--wait-end¶: wait for the capture to end

--wait-file-end¶: wait for the next file rollover in a rolling file capture

output¶

-p <directory/capture.pcap>, --path <directory/capture.pcap>¶: capture path on the XRA-31

-D <duration>, --duration <duration>¶: duration limit of the capture (seconds). 0 for unlimited

-S <size>, --size <size>¶: size limit of the capture (MB). 0 for unlimited

rolling file¶

-n <number_of_files>, --number-of-files <number_of_files>¶: number of files in the rolling file capture (1 for single file capture)

-d <file_duration>, --file-duration <file_duration>¶: per-file duration limit (seconds). 0 for unlimited

-s <file_size>, --file-size <file_size>¶: per-file size limit (MB). 0 for unlimited

command options¶

-t <timeout>, --timeout <timeout>¶: maximum time to wait for the end of the capture or the rollover of a file (seconds)

xra31-analyse¶

Access XRA-31 capture files. The commands can be combined, and files won’t be deleted unless downloading succeeds.

usage: xra31-analyse [-h] [-p directory/remote.pcap] [-q] [-v] [--version]
                     [--wait-end] [--wait-file-end] [--download] [--delete]
                     [-o local.pcap] [-r] [-a] [-t TIMEOUT] [-c]
                     [XRA-31]

positional arguments¶

xra-31¶: XRA-31 hostname or IP address

optional arguments¶

-h, --help¶: show this help message and exit

-p <directory/remote.pcap>, --path <directory/remote.pcap>¶: captured file on the XRA-31. If missing, the latest capture is downloaded. If –wait-end or –wait-file-end is used, this option will be ignored.

-q, --quiet¶: don’t print progress messages

-v, --verbose¶: print debugging messages

--version¶: print client version and server version

commands¶

--wait-end¶: wait for the capture to end

--wait-file-end¶: wait for the next file rollover in a rolling file capture

--download¶: store captures locally

--delete¶: remove captures from the XRA-31

command options¶

-o <local.pcap>, --output <local.pcap>¶: local download location

-r, --rolling¶: treat path as a full rolling file capture

-a, --append¶: append capture to an existing file; requires download

-t <timeout>, --timeout <timeout>¶: maximum time to wait for the end of the capture or the rollover of a file (seconds)

-c, --compress¶: compress the downloaded capture file (gzip)