Developer Resources

aisnode command line

View as Markdown

Command-Line arguments

There is a single AIS node (aisnode) binary that functions either as AIS proxy (gateway) or AIS target, depending on the -role option - examples follow below:

1# Example deploying `aisnode` proxy
2$ aisnode -config=/etc/ais/config.json -local_config=/etc/ais/local_config.json -role=proxy -ntargets=16
3
4# Example deploying `aisnode` target (ie., storage server)
5$ aisnode -config=/etc/ais/config.json -local_config=/etc/ais/local_config.json -role=target

The common executable, typically called aisnode, supports the following command-line arguments:

1  -config string
2        config filename: local file that stores the global cluster configuration
3  -config_custom string
4        "key1=value1,key2=value2" formatted string to override selected entries in config
5  -daemon_id string
6        user-specified node ID (advanced usage only!)
7  -h    show usage and exit
8  -local_config string
9        config filename: local file that stores daemon's local configuration
10  -loopback
11        use loopback devices (local playground, target-only)
12  -ntargets int
13        number of storage targets expected to be joining at startup (optional, primary-only)
14  -role string
15        _role_ of this aisnode: 'proxy' OR 'target'
16  -skip_startup
17        whether primary, when starting up, should skip waiting for target joins (used only in tests)
18  -standby
19        when starting up, do not try to auto-join cluster - stand by and wait for admin request (target-only)
20  -start_with_lost_mountpath
21        force starting up with a lost or missing mountpath (target-only)
22  -transient
23        false: store customized (via '-config_custom') configuration
24        true: keep '-config_custom' settings in memory only (non-persistent)

For usage and the most recently updated set of command-line options, run aisnode with empty command-line:

1$ $GOPATH/bin/aisnode