SONM CLI is a command-line interface, that allow Customer (buyer of hardware) and Supplier (owner of hardware) to interact with SONM components.
Global Flags:
--insecure Disable TLS for connection
--keystore string Keystore dir
--node string Node endpoint (default "localhost:15030")
--out string Output mode: simple or json
--timeout Connection timeout duration (default 1m0s)
-h --help Help about any commandAllows you to manage blacklisted addresses in your personal blacklist (connected to your profile). If you think someone is cheating you during the deal, you may close the deal and add counterparty address to your blacklist. See close deal for additional info. You cannot add someone to your blacklist manually. You may see the list of blacklisted profiles and remove address from blacklist.
Usage:
sonmcli blacklist [command]Available Commands:
list Show your blacklist or for given address
remove Remove given address from your blacklistUsage:
sonmcli blacklist list [addr] [flags]Example: sonmcli blacklist list 0x8125721c2413d99a33e351e1f6bb4e56b6b61567
Usage:
sonmcli blacklist remove <addr> [flags]Example: sonmcli blacklist remove 0x8125721c2413d99a33e351e1f6bb4e56b6b633fd
After deleting you receive a successful message.
SONM CLI has auto-complete, and it usually works out-of-the-box for bash. If you use zsh or have issues with auto-complete in bash, you may generate and run shell-completion script manually.
Usage:
sonmcli completion <bash|zsh> [flags]Usage:
sonmcli deal [command]Available Commands:
close Close given deal
list Show your active deals
open Open deal with given orders
quick-buy Instantly open deal with provided ASK order id and optional duration (should be less or equal comparing to ask order)
status Show deal statusCustomer may close any deal at any moment (spot or forward). Payments will be executed for a certain deal duration.
Supplier may close spot deal at any moment. Payments will be executed for a certain deal duration. Supplier cannot close forward (time limited) deal until deal duration is over.
Usage:
sonmcli deal close <deal_id> [flags]Flags:
--blacklist Add counterparty to blacklistExample: sonmcli deal close 231 --blacklist
To see your blacklist use sonmcli blacklist list command.
Usage:
sonmcli deal list [flags]Flags:
--limit uint Deals count to show (default 10)Example: sonmcli deal list --limit uint 1
The normal way to open a deal is:
For Supplier:
- Use auto-seller bot 'Optimus' to manage your Worker resources and place ASK orders to the market. Deal will open automatically when matching BID order will be placed onto the SONM marketplace by the Customer.
For Customer:
- (first option) Place BID order to the SONM marketplace. Deal will open automatically when matching ASK order will be placed onto the SONM marketplace by the Supplier's worker node.
- (second option) Find suitable ASK order with SONM marketplace GUI and buy it - quick-buy function.
But, in some cases it is useful to have an option to try to open a deal directly with providing two orders (BID and ASK).
Usage:
sonmcli deal open <ask_id> <bid_id> [flags]Example: sonmcli deal open 2314 2235
In case of success you get deal ID. The opened deal has the duration from Customer's BID order and the other parameters from Supplier's ASK order. In case of another answer please go to How-to section. If you don't find an answer then go to Support page.
This command allow Customer to quickly open new deal with Supplier. User should specify certain ASK order ID.
Customer do not have to create new BID order to use
Customer may specify deal duration, that is less or equals the duration specified in Supplier’s ASK order.
If [duration] flag omitted, the deal opens under conditions specified in ASK order.
Usage:
sonmcli deal quick-buy <ask_id> [duration] [flags]Example: sonmcli deal quick-buy 2314 1h23m13s
In case of success you get a deal ID.
Usage:
sonmcli deal status <deal_id> [flags]Example: sonmcli deal status 2314
You will get information about the deal. As a result you may see proposed change requests in the answer.
Any deal participant (Customer or Supplier) may propose to counterparty to change deal conditions: price and/or duration.
Some requests affect deal conditions automatically:
Other requests need to be confirmed by counterparty:
You may see proposed change requests in deal status (see 'sonmcli deal status' command).
Change request does not affect deal conditions untill approval by counterparty.
Counterparty may:
Usage:
sonmcli deal change-request [command]Available Commands:
approve Agree to change deal conditions with given change request
cancel Decline given change request
create Request changes for given dealUsage:
sonmcli deal change-request approve <req_id> [flags]Usage:
sonmcli deal change-request cancel <req_id> [flags]Usage:
sonmcli deal change-request create <deal_id> [flags]Example: sonmcli deal change-request create 123 --new-duration=10h --new-price=0.3USD/h
Flags:
--new-duration string Propose new duration for a deal in the format XdYmZs
--new-price string Propose new price for a deal in the format X.X...XUSD/h or USD/s Use flag -h or --help to get help about any command.
SONM CLI may generate new UTC/JSON keystore with this command if you just installed SONM coomponents. If you have several keystore files in your keystore folder, you may switch between them.
Usage:
sonmcli login [addr] [flags]In case of the installation use sonmcli login.
In case of switching/login with exist keystore write your address. Example: sonmcli login 0x8125721c2413d99a33e351e1f6bb4e56b6b633fd. After that you should input the passphrase.
Supplier should specify his Master Ethereum address in Worker configuration file (/etc/sonm/worker-default.yaml). Master address is using for payment execution for a deal.
One Supplier may have unlimited Worker nodes.
The relation "Master"-"Worker" is recorded in the blockchain. Worker checks the availability of a record in the blockchain at each start.
If there is no entry, the worker will create it.
The resource owner must confirm the link between the application of the worker and master using sonmcli master confirm <worker ether address> command.
Supplier may manage (confirm, remove) workers with Master key.
Important: Worker will not start to place ASK orders to the SONM marketplace until master has not confirmed this worker.
Usage:
sonmcli master [command]Available Commands:
confirm Confirm pending Worker's registration request
list Show known worker's addresses
remove_master Remove self (worker) from the specified master
remove_worker Remove registered worker from masterUsage:
sonmcli master confirm <worker_eth> [flags]Usage:
sonmcli master list [master_eth] [flags]Usage:
sonmcli master remove_master <master_eth> [flags]After removing the worker will stop to create ASK orders on the Marketplace. To start working your should restart Worker with old or different Master address, and confirm it again.
Usage:
sonmcli master remove_worker <worker_eth> [flags]After removing the Worker will stop to create ASK orders on the Marketplace. To start working your should restart Worker with old or different Master address, and confirm it again.
Customer may create or cancel BID orders on SONM marketplace. Customer and Supplier may see the list of they BID and ASK orders. Anyone may check the status of any specified order.
Usage:
sonmcli order [command]Available Commands:
cancel Cancel order on Marketplace
create Place new BID order on Marketplace
list Show your active orders
purge Remove all your orders from Marketplace
status Show order statusUsage:
sonmcli order cancel <order_id> [flags]Customer should create BID order specification to create new BID order on SONM Marketplace (bid.yaml). For more information see Order. BID specification example:
# spot deal (0h, supplier may close the deal at any moment), or forward deal duration (fixed time)
duration: 1h40m30s
price: 0.06 USD/h
# optional - restricts buying resources only from specified address
# counterparty: 0x8125721c2413d99a33e351e1f6bb4e56b6b61567
# optional - third-party blacklist, wich you want take to account (well known address you trust,
# for example - SONM auto-buyer, that buys resources for mining, and blacklists suppliers who
# can not provide the promised performance, and considered as dishonest (unfair) supplier.
# blacklist: 0x1124fCC307756f4077c5e8E09b948C1CA7123eC9
# identity level of the counterparty. Can be "anonymous", "registered", "identified" and "professional"
identity: anonymous
# optional, set tag for the task
tag: my-app
# benchmarks for needed resources, some are mandatory (cpu-cores), other may be omitted
resources:
# network connection requirements
network:
overlay: false
outbound: true
incoming: false
# benchmarks for needed resources, some are mandatory (cpu-cores), other may be omitted
# all values are given in units, for example:
# - ram, gpu memory, network bandwidth must be specified in bytes,
# - gpu-eth-hashrate - in hashes per second
benchmarks:
ram-size: 512000000
cpu-cores: 1
cpu-sysbench-single: 500
cpu-sysbench-multi: 500
net-download: 1000000
net-upload: 1000000
gpu-count: 1
gpu-mem: 3000000000
gpu-eth-hashrate: 50000000
storage-size: 512000000
gpu-cash-hashrate: 120
gpu-redshift: 50Place the file
sonmcli order create <yourbid.yaml> [flags]In case of success you get the order ID in the answer.
To get information about resource benchmarks and their values go to the Resources concept page.
Usage:
sonmcli order list [flags]Flags:
--limit uint Orders count to show (default 10)Customer may quickly remove all own active BID orders from the market with this command.
Usage:
sonmcli order purge [flags]Usage:
sonmcli order status <order_id> [flags]You will get all information about the order.
Usage:
sonmcli profile [command]Available Commands:
status Show profile details
remove-attr Remove attribute form your profileUsage:
sonmcli profile status [addr] [flags]Use sonmcli profile status without address to see your current account profile.
User has a permission to remove any attribute from his profile. It will be completely deleted without possibility of restoration.
Usage:
sonmcli profile remove-attr <attr_id> [flags]Value of the attr_id you may see in the result of sonmcli profile status command.
The group of commands for task management. Customer may use these commands to manage his tasks on rented hardware.
Usage:
sonmcli task [command]Available Commands:
join Provide network specs for joining to specified task's specific network
list Show active tasks
logs Retrieve task logs
pull Pull committed image from the completed task.
push Push an image from the filesystem
start Start task
status Show task status
stop Stop taskUsage:
sonmcli task join <deal_id> <task_id> <network_id> [flags]Usage:
sonmcli task list [deal_id] [flags]If you don't specify the deal ID, you get all your tasks.
Usage:
sonmcli task logs <deal_id> <task_id> [flags]Flags:
--detailed Show extra details provided to logs
--follow Stream logs continuously
--since string Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
--source Show stream (stderr or stdout) for each line of logs
--tail string Number of lines to show from the end of the logs (default "50")
--ts Show timestamp for each log line (default true)
--type string "stdout" or "stderr" or "both" (default "both")Usage:
sonmcli task pull <deal_id> <task_id> [flags]Flags:
--output string file to outputUsage:
sonmcli task push <deal_id> <archive_path> [flags]Customer should create task specification to run task on rented hardware (task.yaml). Task specification example:
# docker image settings, required section
container:
# Image name to start on worker, required param.
image: httpd:latest
# Env variables that will be passed to container on start.
env:
param1: value1
param2: value2
param3: value3
# Add ability to pull container back.
commit_on_stop: true
# networks:
# - type: tinc
# subnet: "10.20.30.0/24"
# volumes:
# cifs:
# type: cifs
# options:
# share: samba-host.ru/share
# username: username
# password: password
# security: ntlm
# vers: 3.0
# mounts:
# - cifs:/mnt:rw
# - cifs:/opt:rw
# # custom registry settings, optional section
# registry:
# # if not empty, Worker will use given registry to pull an image from, optional param
# server_address: registry.user.io
# # registry username, optional param
# username: name
# # registry password, optional param
# password: secretUsage:
sonmcli task start <deal_id> <task.yaml> [flags]Usage:
sonmcli task status <deal_id> <task_id> [flags]Usage:
sonmcli task stop <deal_id> <task_id> [flags]Usage:
sonmcli token [command]Available Commands:
allowance Show current allowance dor marketplace on sidchain network
balance Show SONM token balance (ERC20)
deposit Transfer funds from masterchain to SONM blockchain
withdraw Transfer funds from SONM blockchain to masterchainShow current allowance for Marketplace smart contract on SONM blockchain.
Usage:
sonmcli token allowance [flags]Usage:
sonmcli token balance [flags]You will get SNM balance of the current account on Masterchain and on SONM blockchain. Example:
On Ethereum: 80 SNM
On SONM: 17.114423720059097 SNMNotice that the Worker balance always will be zero because all payments comes to Master account.
Transfer specified amount of SNM tokens from masterchain to SONM blockchain.
Usage:
sonmcli token deposit <amount> [flags]Where amount accept value in wei (1 SNM = 1*10^18 wei).
Example: sonmcli token deposit 34.2
Notice that the Deposite operation requires Ether on your account because the transaction in the Ethereum blockchain is executed. The fee of the transaction is calculated as (gas price * gas amount). Gas amount is defined after finishing the transaction. Gas price now is a constant 20 Gwei.
But if you make deposite using SONM GUI you may set the value of gas price and gas limit. See SONM GUI Market Guide.
Transfer specified amount of SNM tokens from SONM blockchain to Masterchain.
Usage:
sonmcli token withdraw <amount> [flags]Example: sonmcli token withdraw 30.1.
Notice The withrdaw operation don't require Ether on your address because the transaction is executed in SONM blockchain. But you pay constant commission in SNM for every operation. Now the value is 0 SNM.
Usage:
sonmcli token transfer <addr> <amount> [flags]Example: sonmcli token transfer 0x87...34 0.1.
Notice The transfer operation don't require Ether on your address because the transaction is executed in SONM blockchain.
Usage:
sonmcli version [flags]Worker management is for Supplier.
Supplier may manage Worker locally or with remote access with Master key or Admin key (specified in worker config /etc/sonm/worker-default.yaml).
Usage:
sonmcli worker [command]Available Commands:
ask-plan Operations with [ASK plan](/concepts/main-entities/ask-plan)
current Show current Worker's address
devices Show Worker's hardware
free-devices Show Worker's hardware with remaining resources available for scheduling
maintenance Schedule Worker maintenance
next-maintenance Print next scheduled maintenance
status Show Worker status
switch Switch current Worker to specified address
tasks Show tasks running on WorkerThe normal way for Supplier is to use auto-seller bot 'Optimus' to manage Worker resources and place ASK orders to the Market. But manual management for ASK plans is also allowed.
Attention To use manual management first stop the Optimus using 'sudo service sonm-optimus stop.'
Usage:
sonmcli worker ask-plan [command]Available Commands:
create Create new ASK plan
list Show current ASK plans
purge Purge all exiting ASK plans on Worker
remove Remove ASK plan by IDThe normal way for Supplier is to use auto-seller bot 'Optimus' to manage Worker resources and place ASK orders to the Market. But manual management for ASK plans is also allowed.
ASK plan example:
duration: 8h30m
price: 0.73 USD/h
# You may specify any public blacklist address (in addition to your own blacklist). Deal cannot be opened if counterparty is included to blacklist.
blacklist: 0x8125721c2413d99a33e351e1f6bb4e56b6b633fd
# optional - restricts selling resources only to specified address
# counterparty: 0x8125721c2413d99a33e351e1f6bb4e56b6b61567
# Minimum identity level of the counterparty. Can be "anonymous", "registered", "identified":
# - anonymous - allow all users to rent your hardware
# - registered - allow registered and identified counterparty
# - identified - allow only identified byers
identity: anonymous
resources:
cpu:
# Number of cores to assign for this plan, can be fractional
cores: 1.5
ram:
size: 2GB
storage:
size: 512MB
gpu:
indexes: [3, 5]
network:
throughputin: 25 Mbit/s
throughputout: 40 Mbit/s
overlay: true
outbound: true
incoming: trueUsage:
sonmcli worker ask-plan create <ask_plan.yaml> [flags]As a result you get ASK plan ID.
Usage:
sonmcli worker ask-plan list [flags]Usage:
sonmcli worker ask-plan purge [flags]Usage:
sonmcli worker ask-plan remove <ask_plan_id> [flags]Usage:
sonmcli worker benchmark [command]Available commands:
purge Remove all benchmarks from cache to rebenchmark on next worker restart
remove Remove specified benchmark from cache to rebenchmark on next worker restartTo get information about Worker resource benchmarks and their values go to the Resources concept page.
Usage:
sonmci worker benchmark purge [flags]Usage:
sonmcli worker benchmark remove <id> [flags]Benchmark ID you may find on the Resources concept page.
Usage:
sonmcli worker current [flags]Usage:
sonmcli worker devices [flags]You will get for example:
CPU: 1 cores at 1 sockets
Benchmarks:
cpu-sysbench-multi: 1132
cpu-sysbench-single: 1108
cpu-cores: 1
RAM: 1.953 GiB
Benchmarks:
ram-size: 2097446912
GPUs:
GeForce GTX 1080 Ti (index=0: hash=53bb55600079b5a0076888218c20a7e7)
Benchmarks:
gpu-eth-hashrate: 32456000
gpu-cash-hashrate: 701
gpu-redshift: 1600
gpu-count: 1
gpu-mem: 11718885376
Network:
Incoming: false
Overlay: true
In: 75.460 Mibit/s
Out: 57.130 Mibit/s
Benchmarks:
net-download: 79125854
net-upload: 59905506
Storage:
Volume: 1.912 GiB
Benchmarks:
storage-size: 2053124096Usage:
sonmcli worker free_devices [flags]This command allows Supplier to schedule Worker maintenance at certain time specified, or after expiration of time period specified.
Duration of all active ASK orders will be reduced to match maintenance time specified.
After the specified maintenance time has come, all spot deals will be closed automatically, active ASK orders will be removed from Marketplace.
We strictly recommend to check for existing forward deals when planning Worker maintenance. Worker maintenance mode does not affect opened forward deals. If you will switch Worker OFF when forwarding deal is active, it is highly probable that you will receive claim as unfair Supplier, and will be included in counterpart’s blacklist.
Usage:
sonmcli worker maintenance <XhYmZs time before maintenance> [flags]Example: sonmcli worker maintenance 12h35m20s
In case to shut down the worker immediately use: sonmcli worker maintenance 0h.
After time is set you can always check it by executing this command: 'sonmcli worker next-maintenance'. It will print next scheduled maintenance.
In case you want to change that time - use sonmcli worker maintenance
Usage:
sonmcli worker next-maintenance [flags]Usage:
sonmcli worker status [flags]The result, for example, is:
Uptime: 5h26m29s
Version: v0.4.8-7f2f38bf linux/amd64/go1.10.2
Eth address: 0x26200241593722FA17DE5722Ed66d8830dc58C6D
Task count: 10
DWH status:
Rendezvous status: 79.137.70.2:14099You may manage only one worker at once. This command is used to swith to another worker. You may see all available Workers for managing using sonmcli master list + <your Master ethereum address (may be omitted if you use SONM Node with keystore containing your Masker key)>.
Usage:
sonmcli worker switch <worker_eth_addr> [flags]Usage:
sonmcli worker tasks [flags]