Command Line utility to handle most common tasks with ZFS Storage Appliance (OS86 and OS87).
This utility only works with the Rest Api service, so you must activate the service.
For convenience, clone the repo and setup a virtual environment to install the utility in it.
git clone https://github.com/aldenso/zfssa_utilscd zfssa_utilspython -m venv .venvsource .venv/bin/activate You'll see a prompt like this.
At the moment you can install the utility building with setup.
If you want to develop the program use the option.
Check the utility (remember to rehash if you are using zsh).
usage: zfssa-utils [-h] [-v] [-t TIMEOUT] [--cert CERT] {EXPLORER,PROJECTS,FILESYSTEMS,LUNS,SNAPSHOTS,TEMPLATES,UPDATE} ...Utils for ZFS Storage Appliance. This program allow you to generate zfssageneral info csv files, manipulate or validate info for projects, luns andsnapshots.positional arguments: {EXPLORER,PROJECTS,FILESYSTEMS,LUNS,SNAPSHOTS,TEMPLATES,UPDATE} COMMANDSoptional arguments: -h, --help show this help message and exit -v, --version program version -t TIMEOUT, --timeout TIMEOUT connection timeout --cert CERT use certificate --doc program documentation Note : You can run operations without validating certificates (PEM certificate), but you'll get a warning.
******************************************************************************* Warning: not using certificate verification.******************************************************************************* If you download the certificate, you can use it with the --cert option before the COMMANDS options.
example:
zfssa-utils --cert myzfssa.cert [EXPLORER| PROJECTS| ...] For every operations you'll need a server configuration file, where you will indicate the ip of the system, a user with enough privileges and the password for the user.
ip :192.168.56.150 username :root password :password Explorer generation will get the most common values you need about you zfssa system.
zfssa-utils EXPLORER -s test/serverOS86.yml -p 23% | ## ############ | ETA: 0:01:19 . . .100% | ## ###########################################################| Time: 0:01:57 zfssa_explorer_192.168.56.150_110218_144857.zip unzip -l data/zfssa_explorer_192.168.56.150_110218_144857.zip Archive: data/zfssa_explorer_192.168.56.150_110218_144857.zip Length Date Time Name--------- ---------- ----- ---- 178 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/devices.csv 5489 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/projects.csv 2829 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/luns.csv 326 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/cluster.csv 190 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/datalinks.csv 407 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/users.csv 249 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/fc_initiator-groups.csv 5951 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/filesystems.csv 601 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/pools.csv 62 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/routing.csv 247 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/iscsi_targets.csv 290 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/routes.csv 551 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/iscsi_initiators.csv 100 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/problems.csv 222 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/iscsi_initiator-groups.csv 28 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/iscsi_target-groups.csv 28 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/fc_target-groups.csv 687 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/version.csv 287 2018-02-11 14:49 zfssa_explorer_192.168.56.150_110218_144857/interfaces.csv 172 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/fc_targets.csv 339 2018-02-11 14:50 zfssa_explorer_192.168.56.150_110218_144857/fc_initiators.csv--------- ------- 19233 21 files Explorer Scheduler (not in windows platform) The script 'zfssa-sched-explorer' is useful to schedule regular explorers, even when you make changes in the directory, the script will detect events and will remove previous old files schedules and add the new ones.
usage: zfssa-sched-explorer [-h] -d DIRECTORY [-c] [-p] [--timeout TIMEOUT] -t TIME [TIME ...]Schedule zfssa explorersoptional arguments: -h, --help show this help message and exit -d DIRECTORY, --directory DIRECTORY Directory to find Server config files (YAML) -c, --cert Use certificate (Certificates must be named like the zfssa yml but with extension '.crt') -p, --progress progress bar --timeout TIMEOUT connection timeout -t TIME [TIME ...], --time TIME [TIME ...] 24Hr time where the Job should be launched If you want to use certificates, then you must place them in the same directoryof the servers with the same name, but with extension '.crt' instead of '.yml'.
examples:
zfssa-sched-explorer -d /tmp/myserver --timeout 100 --cert -t" 16:52" " 21:00" " 16:27" " 21:00" Started at: 2018-02-27 16:26:20.730649++++ Scheduled: 16:27 /tmp/myserver/serverOS86.yml ++++++++ Scheduled: 21:00 /tmp/myserver/serverOS86.yml ++++Explorer for '/tmp/myserver/serverOS86' launched++++ Creating csv for cluster ++++++++ Creating csv for problems ++++++++ Creating csv for datalinks ++++++++ Creating csv for version ++++++++ Creating csv for interfaces ++++++++ Creating csv for routes ++++++++ Creating csv for devices ++++++++ Creating csv for projects ++++++++ Creating csv for luns ++++++++ Creating csv for filesystems ++++++++ Creating csv for routing ++++++++ Creating csv for pools ++++++++ Creating csv for fc_initiators ++++++++ Creating csv for fc_targets ++++++++ Creating csv for fc_initiator-groups ++++++++ Creating csv for fc_target-groups ++++++++ Creating csv for iscsi_initiator-groups ++++++++ Creating csv for iscsi_initiators ++++++++ Creating csv for iscsi_target-groups ++++++++ Creating csv for iscsi_targets ++++++++ Creating csv for users ++++---- Removed previous schedules ----++++ Scheduled: 16:27 /tmp/myserver/serverOS86.yml ++++++++ Scheduled: 16:27 /tmp/myserver/serverOS87.yml ++++++++ Scheduled: 21:00 /tmp/myserver/serverOS86.yml ++++++++ Scheduled: 21:00 /tmp/myserver/serverOS87.yml ++++ Create templates files to make several components operations in a serial way.
usage: zfssa-utils TEMPLATES [-h] [--projects] [--filesystems] [--luns] [--snapshots] [-t TIMEOUT] (--create | --delete)optional arguments: -h, --help show this help message and exit --projects generate template for projects --filesystems generate template for filesystems --luns generate template for luns --snapshots generate template for snapshots --updates generate template for components(lun|fs|project) updates/modification -t TIMEOUT, --timeout TIMEOUT connection timeout --create template for creation --delete template for deletion zfssa-utils TEMPLATES --projects --createzfssa-utils TEMPLATES --projects --deletezfssa-utils TEMPLATES --filesystems --createzfssa-utils TEMPLATES --filesystems --deletezfssa-utils TEMPLATES --luns --createzfssa-utils TEMPLATES --luns --deletezfssa-utils TEMPLATES --snapshots --createzfssa-utils TEMPLATES --snapshots --deletezfssa-utils TEMPLATES --updates --create Created file 'create_projects.csv'Created file 'destroy_projects.csv'Created file 'create_filesystems.csv'Created file 'destroy_filesystems.csv'Created file 'create_luns.csv'Created file 'destroy_luns.csv'Created file 'create_snapshots.csv'Created file 'destroy_snapshots.csv'Created file 'update_components.csv' Every template comes with comment lines (lines starting with '#') indicating some values allowed for the fields, but check your restful API zfssa version to be sure (Only lines without comments will be processed ).
Example lun creation file.
# pool,project,lun,volsize,volblocksize,sparse,targetgroup,initiatorgroup,compression,logbias,nodestroypool_0,unittest,lun01,1g,128k,False,default,cluster-test,gzip,latency,FalseExample delete lun file.
# pool,project,lunpool_0,unittest,lun01Make changes in the templates you want and create, delete or show the components you need.
Projects operations, create, delete or show projects.
zfssa-utils PROJECTS -s serverOS86.yml -f create_projects.csv --createzfssa-utils PROJECTS -s serverOS86.yml -f create_projects.csv --listzfssa-utils PROJECTS -s serverOS86.yml -f destroy_projects.csv --delete ## ############################################################################# Creating projects## ############################################################################# CREATE - SUCCESS - project 'unittest01' pool 'pool_0'===============================================================================## ############################################################################# Listing projects## ############################################################################# LIST - PRESENT - project 'unittest01' pool 'pool_0' mountpoint '/export/unittest01' quota '10 GB' reservation '10 GB' compression 'gzip' dedup 'True' logbias 'latency' nodestroy 'False' recordsize '128 KB' readonly 'False' atime 'True' def_sparse 'True' def_user 'nobody' def_group 'other' def_perms '750' def_volblocksize '128 KB' def_volsize '1 GB' sharenfs 'on' sharesmb 'off'===============================================================================You are about to destroy==============================Pool Project------------------------------pool_0 unittest01==============================Do you want to destroy (y/N)y## ############################################################################# Deleting projects## ############################################################################# DELETE - SUCCESS - project 'unittest01' pool 'pool_0'===============================================================================Note : Every delete operation for projects has a --noconfirm flag if you are completely sure about the file accuracy.
Filesystems operations, create, delete or show filesystems.
zfssa-utils FILESYSTEMS -s serverOS86.yml -f create_filesystems.csv --createzfssa-utils FILESYSTEMS -s serverOS86.yml -f create_filesystems.csv --listzfssa-utils FILESYSTEMS -s serverOS86.yml -f create_filesystems.csv --delete ## ############################################################################# Creating filesystems## ############################################################################# CREATE - SUCCESS - filesystem 'fs10' project 'unittest' pool 'pool_0'===============================================================================## ############################################################################# Listing filesystems## ############################################################################# LIST - SUCCESS - filesystem 'fs10' project 'unittest' pool 'pool_0' mountpoint '/export/unittest/fs10' quota '2 GB' reservation '1 GB' compression 'lzjb' dedup 'False' logbias 'latency' nodestroy 'False' recordsize '128 KB' readonly 'False' atime 'False' root_user 'root' root_group 'other' root_permissions '750' sharenfs rw=@192.168.56.101/24:@192.168.56.1/24' sharesmb 'on'===============================================================================You are about to destroy=============================================Pool Project Filesystem---------------------------------------------pool_0 unittest fs10=============================================Do you want to destroy (y/N)y## ############################################################################# Deleting filesystems## ############################################################################# DELETE - SUCCESS - filesystem 'fs10' project 'unittest' pool 'pool_0'===============================================================================Note : Every delete operation for filesystems has a --noconfirm flag if you are completely sure about the file accuracy.
Luns operations, create, delete or show luns.
zfssa-utils LUNS -s serverOS86.yml -f create_luns.csv --createzfssa-utils LUNS -s serverOS86.yml -f create_luns.csv --listzfssa-utils LUNS -s serverOS86.yml -f destroy_luns.csv --delete ## ############################################################################# Creating luns## ############################################################################# CREATE - SUCCESS - lun 'lun01' project 'unittest' pool 'pool_0'===============================================================================## ############################################################################# Listing luns## ############################################################################# LIST - SUCCESS - lun 'lun01' project 'unittest' pool 'pool_0' assigned number '4' initiatorgroup '['cluster-test']' volsize '1 GB' volblocksize '128 KB' status 'online' space_total '1 GB' lunguid '600144F0EF0D2BCE00005A8C05890001' logbias ' latency' creation '20180220T11:24:42' thin 'False' nodestroy 'False'===============================================================================You are about to destroy=============================================Pool Project Lun---------------------------------------------pool_0 unittest lun01=============================================Do you want to destroy (y/N)y## ############################################################################# Deleting luns## ############################################################################# DELETE - SUCCESS - lun 'lun01' project 'unittest' pool 'pool_0'===============================================================================Note : Every delete operation for luns has a --noconfirm flag if you are completely sure about the file accuracy.
Update/Modify operations, modify mutable values in projects, filesystems and luns.
zfssa-utils.exe UPDATE -s serverOS86.yml -f update_components.csv You are about to modify/update===============================================================================TYPE NAME:PROJECT:POOL keyx: valx , keyx+1: valx+1, ...===============================================================================project -:unittest:pool_0 ['logbias: latency']lun lun10:unittest:pool_0 ['compression: lzjb', 'sparse: True']filesystem fs01:unittest:pool_0 ['reservation: 512m', 'atime: False']===============================================================================Do you want to proceed (y/N)y## ############################################################################# Updating project## ############################################################################# UPDATE - SUCCESS - project 'unittest' pool 'pool_0' - updates: logbias 'latency'===============================================================================## ############################################################################# Updating lun## ############################################################################# UPDATE - SUCCESS - lun 'lun10' project 'unittest' pool 'pool_0' - updates: compression 'lzjb' sparse 'True'===============================================================================## ############################################################################# Updating filesystem## ############################################################################# UPDATE - SUCCESS - filesystem 'fs01' project 'unittest' pool 'pool_0' - updates: reservation '512m' atime 'False'=============================================================================== Note : Every update/modify operation for projects, filesystems and luns has a --noconfirm flag if you are completely sure about the file accuracy.
Snapshots operations, create, delete or show snaps.
zfssa-utils SNAPSHOTS -s serverOS86.yml -f create_snapshots.csv --createzfssa-utils SNAPSHOTS -s serverOS86.yml -f create_snapshots.csv --listzfssa-utils SNAPSHOTS -s serverOS86.yml -f create_snapshots.csv --delete ## ############################################################################# Creating snapshots## ############################################################################# CREATE - SUCCESS - snapshot 'backup' project '-' project 'unittest' pool 'pool_0'===============================================================================## ############################################################################# Listing snapshots## ############################################################################# LIST - SUCCESS - snapshot 'backup' project '-' project 'unittest' pool 'pool_0' created_at '20180220T11:41:15' space_data '112 KB' space_unique '0 B'===============================================================================You are about to destroy===========================================================================Pool Project fs|lun SnapType Snapshot---------------------------------------------------------------------------pool_0 unittest - project backup===========================================================================Do you want to destroy (y/N)y## ############################################################################# Deleting snapshots## ############################################################################# DELETE - SUCCESS - snapshot 'backup' project '-' project 'unittest' pool 'pool_0'===============================================================================Note : Every delete operation for snapshots has a --noconfirm flag if you are completely sure about the file accuracy.