jdss-api-tools

Execute single or batch commands for automated setup or to control JovianDSS remotely.

Commands:

clone                         	clone_existing_snapshot       	create_pool
destroy_test_pool             	scrub                         	set_scrub_scheduler
create_storage_resource       	modify_volume                 	attach_volume_to_iscsi_target
detach_volume_from_iscsi_target	detach_disk_from_pool         	remove_disk_from_pool
add_read_cache_disk           	delete_clone                  	delete_clones
delete_snapshots              	delete_clone_existing_snapshot	set_host
set_time                      	network                       	create_bond
delete_bond                   	bind_cluster                  	disconnect_cluster
add_ring                      	set_ping_nodes                	set_mirror_path
create_vip                    	start_cluster                 	stop_cluster
move                          	info                          	download_settings
list_snapshots                	shutdown                      	reboot
batch_setup                   	create_factory_setup_files    	activate
import                        	export                        	cli
initialize

Commands description:

Create clone of iSCSI volume zvol00 from Pool-0 and attach to iSCSI target.

Every time it runs, it will delete the clone created last run and re-create new one. So, the target exports most recent data every run. The example is using default password and port. Tools automatically recognize the volume type. If given volume is iSCSI volume, the clone of the iSCSI volume will be attached to iSCSI target. If given volume is NAS dataset, the created clone will be exported via network share. The example is using default password and port.
```
jdss-api-tools.exe clone --pool Pool-0 --volume zvol00 --node 192.168.0.220
```
By default primarycache and secondarycache is set to all. It can be disabled or set to cache metadata only:
```
jdss-api-tools.exe clone --pool Pool-0 --volume zvol00 --primarycache none --secondarycache none --node 192.168.0.220
jdss-api-tools.exe clone --pool Pool-0 --volume zvol00 --primarycache metadata --secondarycache none --node 192.168.0.220
```
Create clone of NAS volume vol00 from Pool-0 and share via new created SMB share.

Every time it runs, it will delete the clone created last run and re-create new one. So, the share exports most recent data every run. The share is invisible by default. The example is using default password and port and makes the share visible with default share name and primarycache set to metadata only.
```
jdss-api-tools.exe clone --pool Pool-0 --volume vol00 --visible --primarycache metadata --node 192.168.0.220
```
The following examples are using default password and port and make the shares invisible.
```
jdss-api-tools.exe clone --pool Pool-0 --volume vol00 --share_name vol00_backup --node 192.168.0.220
jdss-api-tools.exe clone --pool Pool-0 --volume vol01 --share_name vol01_backup --node 192.168.0.220
```
Create clone of existing snapshot on iSCSI volume zvol00 from Pool-0 and attach to iSCSI target.

The example is using password 12345 and default port.
```
jdss-api-tools.exe clone_existing_snapshot --pool Pool-0 --volume zvol00 --snapshot autosnap_2018-06-07-080000 --node 192.168.0.220 --pswd 12345
```
Create clone of existing snapshot on NAS volume vol00 from Pool-0 and share via new created SMB share.

The example is using password 12345 and default port.
```
jdss-api-tools.exe clone_existing_snapshot --pool Pool-0 --volume vol00 --snapshot autosnap_2018-06-07-080000 --node 192.168.0.220 --pswd 12345
```

Delete clone of iSCSI volume zvol00 from Pool-0.

jdss-api-tools.exe delete_clone --pool Pool-0 --volume zvol00 --node 192.168.0.220

Delete clone of NAS volume vol00 from Pool-0.

jdss-api-tools.exe delete_clone --pool Pool-0 --volume vol00 --node 192.168.0.220

Delete clone of existing snapshot on iSCSI volume zvol00 from Pool-0.

The example is using password 12345 and default port.

jdss-api-tools.exe delete_clone_existing_snapshot --pool Pool-0 --volume zvol00 --snapshot autosnap_2018-06-07-080000 --node 192.168.0.220 --pswd 12345

Delete clone of existing snapshot on NAS volume vol00 from Pool-0.

The example is using password 12345 and default port.

jdss-api-tools.exe delete_clone_existing_snapshot --pool Pool-0 --volume vol00 --snapshot autosnap_2018-06-07-080000 --node 192.168.0.220 --pswd 12345

Delete clones (time-based).

Delete clones of provided volume and pool with creation date older than provided time period.

This example deletes clones of iSCSI zvol00 from Pool-0 with 5 seconds prompted delay, older than 2 months and 15 days.
```
jdss-api-tools.exe delete_clones --pool Pool-0 --volume zvol00 --older_than 2months 15days --delay 5 --node 192.168.0.220
```
The older_than option is human readable clone age written with or without spaces with following units: year(s),y month(s),m week(s),w day(s),d hour(s),h minute(s),min second(s),sec,s Examples: 2m15d -> two and a half months 3w1d12h -> three weeks, one day and twelf hours 2hours30min -> two and a half hours 2hours 30min -> two and a half hours (with space between)

Delete all (older_than 0 seconds) clones of NAS volume vol00 from Pool-0.
```
jdss-api-tools.exe delete_clones --pool Pool-0 --volume vol00 --older_than 0seconds --delay 1 --node 192.168.0.220
```
In order to delete all clones, the older_than must be zero. If the older_than option is missing, nothing will be deleted.
Delete snapshots (time-based).

Delete snapshots of provided volume and pool with creation date older than provided time period.

This example deletes snapshots of iSCSI zvol00 from Pool-0 with 1 seconds prompted delay, older than 2 months and 15 days.
```
jdss-api-tools.exe delete_snapshots --pool Pool-0 --volume zvol00 --older_than 2months 15days --delay 1 --node 192.168.0.220
```
The older_than option is human readable clone age written with or without spaces with following units: year(s),y month(s),m week(s),w day(s),d hour(s),h minute(s),min second(s),sec,s Examples: 2m15d -> two and a half months 3w1d12h -> three weeks, one day and twelf hours 2hours30min -> two and a half hours 2hours 30min -> two and a half hours (with space between)

Delete all (older_than 0 seconds) snapshots of NAS volume vol00 from Pool-0.
```
jdss-api-tools.exe delete_snapshots --pool Pool-0 --volume vol00 --older_than 0seconds --delay 1 --node 192.168.0.220
```
In order to delete all snapshots, the older_than must be zero. If the older_than option is missing, nothing will be deleted.
Create pool on single node or cluster with single JBOD:

Pool-0 with 2 * raidz1 (3 disks) total 6 disks.

Command create_pool creates data-groups only and use disks within provided disk_size_range,
```
jdss-api-tools.exe create_pool --pool Pool-0 --vdevs 2 --vdev raidz1 --vdev_disks 3 --disk_size_range 900GB 2TB --node 192.168.0.220
```
if disk_size_range is omitted it takes disks with size near to avarage-disks-size. Default size difference is 5GB.
```
jdss-api-tools.exe create_pool --pool Pool-0 --vdevs 2 --vdev raidz1 --vdev_disks 3 --node 192.168.0.220
```
The default size difference of 5GB can be changed with tolerance option.
```
jdss-api-tools.exe create_pool --pool Pool-0 --vdevs 2 --vdev raidz1 --vdev_disks 3 --tolerance 50GB --node 192.168.0.220
```
Create pool on Metro Cluster with single JBOD with 4-way mirrors:

Pool-0 with 2 * mirrors (4 disks) total 8 disks.
```
jdss-api-tools.exe create_pool --pool Pool-0 --vdevs 2 --vdev mirror --vdev_disks 4 --node 192.168.0.220
```
Create pool with raidz2 (4 disks each) over 4 JBODs with 60 HDD each.

Every raidz2 vdev consists of disks from all 4 JBODs. An interactive menu will be started. In order to read disks, POWER-ON single JBOD only. Read disks selecting "0" for the first JBOD. Next, POWER-OFF the first JBOD and POWER-ON the second one. Read disks of the second JBOD selecting "1". Repeat the procedure until all disks from all JBODs are read. Finally, create the pool selecting "args_count" from the menu.
```
jdss-api-tools.exe create_pool --pool Pool-0 --jbods 4 --vdevs 60 --vdev raidz2 --vdev_disks 4 --node 192.168.0.220
```
Destroy TEST pool:

The destroy_test_pool command deletes a test pool. The word "TEST" must be included in the pool name.
```
jdss-api-tools.exe destroy_test_pool --pool Pool-TEST --node 192.168.0.220
```
Import pool:

Get list of pools available for import:
```
jdss-api-tools.exe import --node 192.168.0.220
```
Import pool Pool-0:
```
jdss-api-tools.exe import --pool Pool-0 --node 192.168.0.220
```
Import pool Pool-0 with force option. Forces import, even if the pool appears to be potentially active.
```
jdss-api-tools.exe import --pool Pool-0 --force --node 192.168.0.220
```
Forced import of Pool-0 with missing write-log device.
```
jdss-api-tools.exe import --pool Pool-0 --force --ignore_missing_write_log --node 192.168.0.220
```
Forced import of Pool-0 in recovery mode for a non-importable pool. Attempt to return the pool to an importable state by discarding the last few transactions. Not all damaged pools can be recovered by using this option. If successful, the data from the discarded transactions is irretrievably lost.
```
jdss-api-tools.exe import --pool Pool-0 --force --recovery_import --node 192.168.0.220
```
Forced import of Pool-0 in recovery mode and missing write-log device.
```
jdss-api-tools.exe import --pool Pool-0 --force --recovery_import --ignore_missing_write_log --node 192.168.0.220
```
Forced import of Pool-0 in recovery mode and ignore unfinished resilver.
```
jdss-api-tools.exe import --pool Pool-0 --force --recovery_import --ignore_unfinished_resilver --node 192.168.0.220
```

Export pool:

Export pools. If the node belongs to cluster, export given pool in cluster.

jdss-api-tools.exe export --pool Pool-0 --node 192.168.0.220
jdss-api-tools.exe export --pool Pool-0 Pool-1 Pool-2 --node 192.168.0.220

Export with optional 5 seconds delay.

jdss-api-tools.exe export --pool Pool-0 --delay 5 --node 192.168.0.220

Shutdown three JovianDSS servers using default port but non default password,

jdss-api-tools.exe --pswd password shutdown --nodes 192.168.0.220 192.168.0.221 192.168.0.222

or with IP range syntax "..".

jdss-api-tools.exe --pswd password shutdown --node 192.168.0.220..222

Shutdown with optional 10 seconds delay.

jdss-api-tools.exe shutdown --delay 10 --node 192.168.0.220

Reboot single JovianDSS server.
```
jdss-api-tools.exe reboot --node 192.168.0.220
```
Forced reboot with optional 10 seconds delay.
```
jdss-api-tools.exe reboot --force --delay 10 --node 192.168.0.220
```
The forced reboot can be used as hard-reset equivalent for deployment tests. NOTE: The shutdown command does not support forced option. Please use reboot command if hard-reset equivalent is required.

Set host name to "node220", server name to "server220" and server description to "jdss220".

jdss-api-tools.exe set_host --host node220 --server server220 --description jdss220 --node 192.168.0.220

Set timezone and NTP-time with default NTP servers.

jdss-api-tools.exe set_time --timezone America/New_York --node 192.168.0.220
jdss-api-tools.exe set_time --timezone America/Chicago --node 192.168.0.220
jdss-api-tools.exe set_time --timezone America/Los_Angeles --node 192.168.0.220
jdss-api-tools.exe set_time --timezone Asia/Tokyo --node 192.168.0.220
jdss-api-tools.exe set_time --timezone Europe/Amsterdam --node 192.168.0.220
jdss-api-tools.exe set_time --timezone Europe/Berlin --node 192.168.0.220

Set NTP servers only.

jdss-api-tools.exe set_time --ntp_servers 0.pool.ntp.org 1.pool.ntp.org --node 192.168.0.220

Set new IP settings for eth0 and set gateway-IP and set eth0 as default gateway.

Missing netmask option will set default 255.255.255.0.

jdss-api-tools.exe network --nic eth0 --new_ip 192.168.0.80 --new_gw 192.168.0.1 --node 192.168.0.220

Setting new DNS only,

jdss-api-tools.exe network --new_dns 192.168.0.1 --node 192.168.0.220

or with 2 DNS servers.

jdss-api-tools.exe network --new_dns 192.168.0.1 192.168.100.254 --node 192.168.0.220

Setting new gateway only. The default gateway will be set automatically.

jdss-api-tools.exe network --nic eth0 --new_gw 192.168.0.1 --node 192.168.0.220

Create bond examples. Bond types: balance-rr, active-backup.

Default = active-backup.

jdss-api-tools.exe create_bond --bond_nics eth0 eth1 --new_ip 192.168.0.80 --node 192.168.0.80
jdss-api-tools.exe create_bond --bond_nics eth0 eth1 --new_ip 192.168.0.80 --new_gw 192.168.0.1 --node 192.168.0.80
jdss-api-tools.exe create_bond --bond_nics eth0 eth1 --bond_type active-backup --new_ip 192.168.0.80 --new_gw 192.168.0.1 --node 192.168.0.80

Delete bond.

jdss-api-tools.exe delete_bond --nic bond0 --node 192.168.0.80

Bind cluster. Bind node-b (192.168.0.81) with node-a (192.168.0.80).

RESTapi user = admin, RESTapi password = password, node-b GUI password = admin.
```
jdss-api-tools.exe bind_cluster --user admin --pswd password --bind_node_password admin --node 192.168.0.80 192.168.0.81
```
Disconnect cluster. Disconnect (Un-Bind) cluster nodes: node-a (192.168.0.80), node-b (192.168.0.81).

After disconnect command is completed, the cluster setup is deleted. The disconnect can be done while cluster is running in production, as after disconnect both cluster nodes will continue to run all services as single nodes. Before disconnect it is recommended to take screenshots of the cluster configuration, so it will be easy to bind both nodes back.

RESTapi user = admin, RESTapi password = password, node-b GUI password = admin.
```
jdss-api-tools.exe disconnect_cluster --user admin --pswd password --bind_node_password admin --nodes 192.168.0.80 192.168.0.81
```
If user and passwords are set to “admin”, the credential options can be omitted:
```
jdss-api-tools.exe disconnect_cluster --nodes 192.168.0.80 192.168.0.81
```
Add ring. Add second ring to the cluster.

RESTapi user = admin, RESTapi password = password, node-b GUI password = admin. The second ring to be set on bond2 on first node and also on bond2 on the second cluster node.
```
jdss-api-tools.exe add_ring --user admin --pswd password --bind_node_password admin --ring_nics bond2 bond2 --node 192.168.0.80
```
Same, but using default user & password.
```
jdss-api-tools.exe add_ring --ring_nics bond2 bond2 --node 192.168.0.80
```

Set HA-cluster ping nodes.

RESTapi user = administrator, RESTapi password = password, netmask = 255.255.0.0.

jdss-api-tools.exe set_ping_nodes --user administrator --pswd password --netmask 255.255.0.0 --ping_nodes 192.168.0.240 192.168.0.241 192.168.0.242 --node 192.168.0.80

Same, but with defaults: user = admin, password = admin, netmask = 255.255.255.0.

jdss-api-tools.exe set_ping_nodes --ping_nodes 192.168.0.240 192.168.0.241 192.168.0.242 --node 192.168.0.80

Set HA-cluster mirror path. Please enter space separated NICs, the first NIC must be from the same node as the specified access IP.
```
jdss-api-tools.exe set_mirror_path --mirror_nics eth4 eth4 --node 192.168.0.82
```

Create VIP (Virtual IP) examples.

jdss-api-tools.exe create_vip --pool Pool-0 --vip_name vip21 --vip_nics eth2 eth2 --vip_ip 192.168.21.100 --vip_mask 255.255.0.0 --node 192.168.0.80
jdss-api-tools.exe create_vip --pool Pool-0 --vip_name vip31 --vip_nics eth2 --vip_ip 192.168.31.100 --node 192.168.0.80

If cluster is configured both vip_nics must be provided. With single node (no cluster) only first vip_nic specified will be used. The second vip_nic (if specified) will be ignored. Default vip_mask = 255.255.255.0.

Start HA-cluster. Please enter first node IP address only.
```
jdss-api-tools.exe start_cluster --node 192.168.0.82
```
Stop HA-cluster. Please enter first node IP address only.
```
jdss-api-tools.exe stop_cluster --node 192.168.0.82
```
Move (failover) given pool.

The current active node of given pool will be found and pool will be moved to passive node with optional delay in seconds.
```
jdss-api-tools.exe move --pool Pool-0 --delay 120 --node 192.168.0.82
```

Create storage resource. Creates iSCSI target with volume (zvol) or SMB/NFS share with dataset.

Defaults are: size = 1TB, blocksize = 16KB, recordsize = 1MB, provisioning = thin, volume = auto, target = auto, share_name = auto. The blocksize or recordsize can be: 4KB, 8KB, 16KB, 32KB, 64KB, 128KB, 256KB, 512KB, 1MB.

Example for iSCSI target with specified volume, target, size, blocksize and provisioning.

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --volume zvol00 --target iqn.2018-09:target0 --size 1TB --blocksize 64KB --provisioning thin --node 192.168.0.220

If cluster name is specified, it will be used in the target name. Next examples will create both the same target name.

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --cluster ha-00 --node 192.168.0.220
jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --volume zvol00 --target iqn.2018-09:target0 --cluster ha-00 --node 192.168.0.220

With missing --target argument, it will produce auto-target name based on the host name.

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --node 192.168.0.220

By default primarycache and secondarycache is set to all. It can be disabled or set to cache metadata only:

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --primarycache metadata --secondarycache none --node 192.168.0.220

If sync (Write Cache sync requests) is not provided the default is set, which is "always" for zvols and "standard" for datasets. Here the sync is set to "disabled".

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --sync disabled --cluster ha-00 --node 192.168.0.220

Example for SMB share with dataset, using defaults (volume = auto, share_name = auto, sync = standard).

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type smb --node 192.168.0.220

Example for SMB share with dataset, using specified volume, recordsize, sync and share_name.

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type smb --volume vol00 --recordsize 128KB --sync always --share_name data --node 192.168.0.220

Example with specified quota and reservation.

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type smb --quota 100GB --reservation 50GB --node 192.168.0.220

Example for multi-resource with --quantity option, starting consecutive number from zero (default),

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --quantity 5 --node 192.168.0.220
jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type smb nfs --quantity 5 --node 192.168.0.220

and multi-resource with --quantity option, but starting consecutive number with 50 and increment 10.

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --quantity 5 --start_with 10 --increment 10 --node 192.168.0.220
jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type smb nfs --quantity 5 --start_with 10 --increment 10 --node 192.168.0.220

To attach more than single zvol to a target, use --zvols_per_target option. This example will create 3 targets with 2 zvols each with following auto-numbering: (vol 10,target 10),(vol 11,target 10),(vol 12,target 11),(vol 13,target 11),(vol 14,target 12),(vol 15,target 12).

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --quantity 3 --start_with 10 --zvols_per_target 2 --node 192.168.0.220

This example will create 2 targets with 4 volumes each with following auto-numbering: (vol 100,target 100),(vol 101,target 100),(vol 102,target 100),(vol 103,target 100), (vol 200,target 200),(vol 201,target 200),(vol 202,target 200),(vol 203,target 200).

jdss-api-tools.exe create_storage_resource --pool Pool-0 --storage_type iscsi --quantity 2 --start_with 100 --increment 100 --zvols_per_target 4 --node 192.168.0.220

Modify volumes settings. Modifiy volume (SAN) or dataset (NAS) setting.

Current version modify only: Write cache logging (sync) settings, quota and reservation for datasets (NAS) and volume size for volumes (SAN).

jdss-api-tools.exe modify_volume --pool Pool-0 --volume zvol00 --sync always --node 192.168.0.220
jdss-api-tools.exe modify_volume --pool Pool-0 --volume zvol00 --sync disabled --node 192.168.0.220

jdss-api-tools.exe modify_volume --pool Pool-0 --volume vol00 --sync always --node 192.168.0.220
jdss-api-tools.exe modify_volume --pool Pool-0 --volume vol00 --sync standard --node 192.168.0.220
jdss-api-tools.exe modify_volume --pool Pool-0 --volume vol00 --sync disabled --node 192.168.0.220

Modify quota and reservation.

jdss-api-tools.exe modify_volume --pool Pool-0 --volume vol00 --quota 200GB --reservation 80GB --node 192.168.0.220

Modify SAN volume size in human readable format i.e. 100GB, 1TB, etc. New size must be bigger than current size, but not bigger than double of current size.

jdss-api-tools.exe modify_volume --pool Pool-0 --volume zvol00 --new_size 1024 GB --node 192.168.0.220

Attach volume to iSCSI target.

jdss-api-tools.exe attach_volume_to_iscsi_target --pool Pool-0 --volume zvol00 --target iqn.2019-06:ha-00.target0 --node 192.168.0.220

Detach volume from iSCSI target.

jdss-api-tools.exe detach_volume_from_iscsi_target --pool Pool-0 --volume zvol00 --target iqn.2019-06:ha-00.target0 --node 192.168.0.220

Detach disk from pool.

Detach disk from pool works with mirrored vdevs or with disks in raidz vdevs which are during or stopped replace process.
```
jdss-api-tools.exe detach_disk_from_pool --pool Pool-0 --disk_wwn wwn-0x5000c5008574a736 --node 192.168.0.220
```

Remove (delete) disk from pool.

Only spare, single log and cache disks can be removed from pool.

jdss-api-tools.exe remove_disk_from_pool --pool Pool-0 --disk_wwn wwn-0x5000c5008574a736 --node 192.168.0.220

Add read cache disk to pool.

Only single read cache disk can be add a time.

jdss-api-tools.exe add_read_cache_disk --pool Pool-0 --disk_wwn wwn-0x5000c5008574a736 --node 192.168.0.220

Scrub start|stop|status.

Scrub all pools. If the node belongs to cluster, scrub all pools in cluster.

jdss-api-tools.exe scrub --node 192.168.0.220

Scrub on specified pools only.

jdss-api-tools.exe scrub --pool Pool-0 --node 192.168.0.220
jdss-api-tools.exe scrub --pool Pool-0 Pool-1 Pool-2 --node 192.168.0.220

Stop scrub on all pools.

jdss-api-tools.exe scrub --scrub_action stop --node 192.168.0.220

Scrub status on all pools.

jdss-api-tools.exe scrub --scrub_action status --node 192.168.0.220

Set scrub scheduler.

By default the command searches all pools on node or cluster (if configured) and set default schedule: every month at 0:15 AM. Every pool will be set on different month day.
```
jdss-api-tools.exe set_scrub_scheduler --node 192.168.0.220
```
Set default schedule on Pool-0 and Pool-1 only.
```
jdss-api-tools.exe set_scrub_scheduler --pool Pool-0 Pool-1 --node 192.168.0.220
```
Set schedule every week on Monday at 1:10 AM on Pool-0 only.
```
jdss-api-tools.exe set_scrub_scheduler --pool Pool-0 --day_of_the_month * --day_of_the_week 1 --hour 1 --minute 10 --node 192.168.0.220
```
Set schedule every day at 2:30 AM on Pool-0 only.
```
jdss-api-tools.exe set_scrub_scheduler --pool Pool-0 --day_of_the_month * --hour 2 --minute 30 --node 192.168.0.220
```
Set schedule every second day at 21:00 (9:00 PM) on Pool-0 only.
```
jdss-api-tools.exe set_scrub_scheduler --pool Pool-0 --day_of_the_month */2 --hour 21 --minute 0 --node 192.168.0.220
```
TIP: Quick schedule params check via browser on Pool-0 on 192.168.0.220:

https://192.168.0.220:82/api/v3/pools/Pool-0/scrub/scheduler

Initialize start|cancel|suspend.

Initialize all pools. If the node belongs to cluster, initialize all pools in cluster.

jdss-api-tools.exe initialize --node 192.168.0.220

Initialize on specified pools only.

jdss-api-tools.exe initialize --pool Pool-0 --node 192.168.0.220
jdss-api-tools.exe initialize --pool Pool-0 Pool-1 Pool-2 --node 192.168.0.220

Stop initialize scrub on all pools.

jdss-api-tools.exe initialize --initialize_action cancel --node 192.168.0.220

Suspend initialize on all pools.

jdss-api-tools.exe initialize --initialize_action suspend --node 192.168.0.220

Note: The pool initialize function requires up30 or newer. The initialize progress can be checked in inspect or logs.

Generate factory setup files for batch setup.

It creates and overwrites (if previously created) batch setup files. Setup files need to be edited and changed to required setup accordingly. For single node setup single node ip address can be specified. For cluster, both cluster nodes ip addresses, so it will create setup file for every node.

jdss-api-tools.exe create_factory_setup_files --nodes 192.168.0.80 192.168.0.81
jdss-api-tools.exe create_factory_setup_files --nodes 192.168.0.80 192.168.0.81 --ping_nodes 192.168.0.30 192.168.0.40 --mirror_nics bond1 bond1
jdss-api-tools.exe create_factory_setup_files --nodes 192.168.0.80..81 --ping_nodes 192.168.0.30 192.168.0.40 --mirror_nics eth4 eth4 --new_gw 192.168.0.1 --new_dns 192.168.0.1

Execute factory setup files for batch setup.

This example runs setup for nodes 192.168.0.80 and 192.168.0.81. Both nodes need to be fresh rebooted with factory defaults: eth0 = 192.168.0.220. First only one node must be started. Once booted, the RESTapi must be enabled via GUI. The batch setup will start to configure first node. Now, the second node can be booted. Once the second node is up, the RESTapi must also be enabled via GUI.
```
jdss-api-tools.exe batch_setup --setup_files api_setup_single_node_80.txt api_setup_single_node_81.txt api_setup_cluster_80.txt
jdss-api-tools.exe batch_setup --setup_files api_test_cluster_80.txt
```
Product activation.
```
jdss-api-tools.exe activate --online --node 192.168.0.220
```
Sends online Product Activation request. On-line activation requires an internet connection. Note: The off-line activation is not implemented yet.
Download current system settings.
```
jdss-api-tools.exe download_settings --directory C:\Downloads --nodes 192.168.0.220 192.168.0.221
```
It generates current system settings and download to provided directory. More than one node is supported. If the --directory option is missing, the settings file will be saved in the current directory.
```
jdss-api-tools.exe download_settings --keep_settings --node 192.168.0.220
```
The just generated and downloaded settings are NOT preserved in the storage node by default. The just generated and downloaded settings will be preserved if --keep_settings option is provided.
Print system info.
```
jdss-api-tools.exe info --node 192.168.0.220
```
The info command lists system information together with only the most recent snapshots. In order to list all snapshots use --all_snapshots option,
```
jdss-api-tools.exe info --all_snapshots --node 192.168.0.220
```
or just --all.
```
jdss-api-tools.exe info --all --node 192.168.0.220
```
Print only snapshot info.
```
jdss-api-tools.exe list_snapshots --node 192.168.0.220
```
The list_snapshots command lists only the most recent snapshots. In order to list all snapshots use --all_snapshots option, In order to list all dataset (NAS) snapshots use --all_dataset_snapshots option, In order to list all zvol (SAN) snapshots use --all_zvol_snapshots option,
```
jdss-api-tools.exe list_snapshots --all_snapshots --node 192.168.0.220
jdss-api-tools.exe list_snapshots --all_dataset_snapshots --node 192.168.0.220
jdss-api-tools.exe list_snapshots --all_zvol_snapshots --node 192.168.0.220
```
Note: If you want complete system information, please use the info command instead.

Enable/disable CLI access.

jdss-api-tools.exe cli --enable  --node 192.168.0.220
jdss-api-tools.exe cli --disable --node 192.168.0.220

The cli --enable will set default password "admin" and default port 22223

####################################################################################### After any modifications of source of jdss-api-tools.py, run pyinstaller to create new jdss-api-tools.exe:

pyinstaller.exe --onefile jdss-api-tools.py

And try it:

C:\Python\Scripts\dist>jdss-api-tools.exe -h

NOTE: To fix anti-virus false positive problem of the exe file generated using PyInstaller, it needs to re-compile the pyinstaller bootloader. Follow step-by-step below:

    1) git clone https://github.com/pyinstaller/pyinstaller         # download the source
    2) cd pyinstaller
    3) cd bootloader
    4) python ./waf distclean all               # to build the bootloader for your system
    5) cd ..                            
    5) python setup.py install             # to install the fresh re-compiled pyinstaller  
    6) pyinstaller.exe --onefile jdss-api-tools.py             # to create the executable

Missing Python modules need to be installed with pip, e.g.:

C:\Python\Scripts>pip install ipcalc
C:\Python\Scripts>pip install ping3
C:\Python\Scripts>pip install colorama
C:\Python\Scripts>pip install requests
...

NOTE: Some modules may requrie MS Visual Studio: https://visualstudio.microsoft.com/downloads In case of error: "msvcr100.dll missing...", download and install "Microsoft Visual C++ 2010 Redistributable Package (x86)": vcredist_x86.exe #######################################################################################

Get help:

     jdss-api-tools.exe -h

Get help for a single command:

     jdss-api-tools.exe create_factory_setup_files
     jdss-api-tools.exe batch_setup
     jdss-api-tools.exe create_pool
  ...

Commands:

clone                         	clone_existing_snapshot       	create_pool
destroy_test_pool             	scrub                         	set_scrub_scheduler
create_storage_resource       	modify_volume                 	attach_volume_to_iscsi_target
detach_volume_from_iscsi_target	detach_disk_from_pool         	remove_disk_from_pool
add_read_cache_disk           	delete_clone                  	delete_clones
delete_snapshots              	delete_clone_existing_snapshot	set_host
set_time                      	network                       	create_bond
delete_bond                   	bind_cluster                  	disconnect_cluster
add_ring                      	set_ping_nodes                	set_mirror_path
create_vip                    	start_cluster                 	stop_cluster
move                          	info                          	download_settings
list_snapshots                	shutdown                      	reboot
batch_setup                   	create_factory_setup_files    	activate
import                        	export                        	cli
initialize

Name		Name	Last commit message	Last commit date
Latest commit History 478 Commits
.gitignore		.gitignore
JovianDSS-Logo.png		JovianDSS-Logo.png
LICENSE		LICENSE
README.md		README.md
jdss-api-tools.exe		jdss-api-tools.exe
jdss-api-tools.py		jdss-api-tools.py

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

jdss-api-tools

About

Releases

Packages

Contributors 2

Languages

License

open-e/jdss-api-tools

Folders and files

Latest commit

History

Repository files navigation

jdss-api-tools

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Languages

Packages