github.com/NVIDIA/aistore@v1.3.23-0.20240517131212-7df6609be51d/docs/command_line.md (about)

     1  ---
     2  layout: post
     3  title: COMMAND LINE
     4  permalink: /docs/command-line
     5  redirect_from:
     6   - /command_line.md/
     7   - /docs/command_line.md/
     8  ---
     9  
    10  ### Command-Line arguments
    11  
    12  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:
    13  
    14  ```console
    15  # Example deploying `aisnode` proxy
    16  $ aisnode -config=/etc/ais/config.json -local_config=/etc/ais/local_config.json -role=proxy -ntargets=16
    17  
    18  # Example deploying `aisnode` target (ie., storage server)
    19  $ aisnode -config=/etc/ais/config.json -local_config=/etc/ais/local_config.json -role=target
    20  ```
    21  
    22  The common executable, typically called `aisnode`, supports the following command-line arguments:
    23  
    24  ```console
    25    -config string
    26          config filename: local file that stores the global cluster configuration
    27    -config_custom string
    28          "key1=value1,key2=value2" formatted string to override selected entries in config
    29    -daemon_id string
    30          user-specified node ID (advanced usage only!)
    31    -h    show usage and exit
    32    -local_config string
    33          config filename: local file that stores daemon's local configuration
    34    -ntargets int
    35          number of storage targets expected to be joining at startup (optional, primary-only)
    36    -override_backends
    37          configure remote backends at deployment time (potentially, override previously stored configuration)
    38    -role string
    39          _role_ of this aisnode: 'proxy' OR 'target'
    40    -skip_startup
    41          whether primary, when starting up, should skip waiting for target joins (used only in tests)
    42    -standby
    43          when starting up, do not try to join cluster - standby and wait for admin request (target-only)
    44    -transient
    45          false: store customized (via config_custom) configuration
    46          true: runtime only (non-persistent)
    47    -v value
    48          log level for V logs
    49  ```
    50  
    51  For usage and the most recently updated set of command-line options, run `aisnode` with empty command-line:
    52  
    53  ```console
    54  $ $GOPATH/bin/aisnode
    55  ```