Easy to use API for the Tintri-Storage-System. Including some CLI tools
================================================================================ README: for the Python HTTP-API for Tintri Storage Systems Version: 0.0.2 Copyright (c) 2016 - The MIT License (MIT) Uwe W. Schäfer Schäfer & Tobies Software u. Consulting GmbH www.schaefer-tobies.de uws: 2016.03.11 first version uws: 2016.03.22 add some checks and "--force" for tintri_snap.py
This repository is a wrapper implementation of the Tintri-REST-API in a object oriented Python Class. The Library includes a python setup.py script which will install the library into the local python dist-packages. But you can test and work with the library without installation too. The only other thing you have to do for initialization is a definition of your user credentials in a local_settings.py file (see local_settings later on in this README) After that just set the Python-Path and use the lib functions like this:
from schtob.tintri_http_api import TFilers
TFilers('tintri-adm').create_VMsnapshot(vm_name, snap_name)
There are two binaries you can use for working or for getting an idea how to use the API.
tintri_snap.py list, create and delete Snapshots on the Tintri-Storage System
tintri_flr.py mount a Tintri Storage Snapshot at a local linux system
================================================================================
================================================================================ The API is a classic Python Library. For installation pull the Git-rpository, step into the http_api directory and call:
sudo python setup.py install
================================================================================
================================================================================ You must define the user credentials for your Tintri-Systems in a Python-file. There are two possible places for the configuration file.
- Global definition Define the TINTRI_CONFIG dictionary in the python library area. i.e. /usr/local/lib/python2.7/dist-packages/schtob/tintri_http_api/local_settings.py
- User specific definition Define the TINTRI_CONFIG dictionary in you HOME directory. i.e. /home/uws/.tintri/local_settings.py
If both files are existent the local one will override the global one.
And here is the needed dictionary:
TINTRI_CONFIG = {
# Global definition
'roles': {
# the default user if no other role an "filer-role" matches
'default': {
'user': 'admin',
'password': 'admin-password',
},
# a different user for a different role, you can define the role
# parameter in the connection call
'my-fancy-default-role': {
'user': 'fancy-user',
'password': '1234',
},
},
# Filer specific definitions
'filer-roles': {
# The user for the Filer 'tintri-adm' should be the user 'uws'
'tintri-adm': {
'default': {
'user' : 'uws',
'password': 'uws-password',
},
'yet-another-fancy-role-only-for-this-filer': {
'user': 'yet-another-fancy-user',
},
},
}
}
================================================================================
================================================================================ The tintri_snap.py opens an easy CLI possibility to handle Tintri-Snapshots.
Here are the actual possible options
- List the actual Snapshots of a virtual machine
- Create a new Snapshot for a virtual machine
- Delete all or the given Snapshot-Names for a virtual machine
The functionality is more or less an example of the API usage, but it could be usefull too. But be carefull the delete function will delete without any further inquery and it will delete all matching snapshots.
Here is the complete Usage:
================================================================================
================================================================================ USAGE: tintri_snap.py [-v]* (-f | --filer) [--vm ] [--description ] --list tintri_snap.py [-v]* (-f | --filer) [--vm ] --create [] tintri_snap.py [-v]* (-f | --filer) [--vm ] --delete [--force] (--all | [<snap-name]*)
the meaning of the options:
-v add verbosity
--all delete ALL snapshots (see --delete)
-q | --quiet be quiet (only Error output)
-f | --filer Tintri-Filername
--vm | --vmname hypervisor virtual machine name
--list List the Snapshots of the selected machine
--create Create a new Snapshot for the selected machine.
if now snap-name is given the script will be asked for one
--delete Delete the the given snap_names or ALL snapshots if
the option --all is given
--force Force Deletion of Snapshots (no interaction with user)
--version print programm version and exit
--logging <lvl> Activate Logging of the API commands to the terminal.
possible Levels are:
DEBUG, INFO, WARNING, ERROR, CRITICAL
the programm and the http_api are using the python "logging"
module.
================================================================================
================================================================================ $ tintri_snap.py -f tintri-adm --vm T-ubuntu-99 --create API-Test-02
$ tintri_snap.py -f tintri-adm --vm T-ubuntu-99 --list
Nr. vmName createTime creatorName description Changed MB type
1 T-ubuntu-99 03/11/16 14:57:04 admin oracle12 2809.66 scheduled
2 T-ubuntu-99 03/11/16 14:59:23 admin oracle12 0.0 scheduled
3 T-ubuntu-99 03/11/16 15:00:02 tintri hourly scheduled 0.0 scheduled
4 T-ubuntu-99 03/11/16 15:21:23 uws API-Test 2.89 scheduled
5 T-ubuntu-99 03/11/16 15:26:23 admin oracle12-01 0.35 scheduled
6 T-ubuntu-99 03/11/16 16:00:03 tintri hourly scheduled 0.59 scheduled
7 T-ubuntu-99 03/11/16 16:06:32 admin GUI-Snapshot 0.54 manual
8 T-ubuntu-99 03/11/16 17:00:03 tintri hourly scheduled 1.39 scheduled
9 T-ubuntu-99 03/11/16 17:42:23 uws API-Test-02 0.87 scheduled
================================================================================
================================================================================ $ tintri_snap.py -f tintri-adm --vm T-ubuntu-99 --logging DEBUG --delete --force API-Test
2016-03-11 17:35:41,818 - DEBUG - TFilers:__new__: name: 'tintri-adm'
2016-03-11 17:35:41,819 - DEBUG - TFilers:get_connection: name: 'tintri-adm'
2016-03-11 17:35:41,819 - DEBUG - TFilers:create_connection: name: 'tintri-adm' role 'default'
2016-03-11 17:35:41,819 - DEBUG - login:
2016-03-11 17:35:41,819 - DEBUG - call_http_api_post:
url : https://tintri-adm/api/v310/session/login
data : {'username': 'uws', 'typeId': 'com.tintri.api.rest.vcommon.dto.rbac.RestApiCredentials', 'password': 'Admin_123'}
headers : {'content-type': 'application/json'}
verify : False
2016-03-11 17:35:41,860 - DEBUG - call_http_api: r.cookies: <<class 'requests.cookies.RequestsCookieJar'>[<Cookie JSESSIONID=6AA4811BBA4292066BCF5C8F0010D6B7 for tintri-adm.local/>]>
2016-03-11 17:35:41,861 - DEBUG - del_VMsnapshots: vmName: 'T-ubuntu-99' snap_name: '['API-Test']'
2016-03-11 17:35:41,862 - DEBUG - get_VMuuid: vmName: 'T-ubuntu-99'
2016-03-11 17:35:41,862 - DEBUG - get_VMinfo: vmName: 'None' force: False
2016-03-11 17:35:41,863 - DEBUG - call_http_api_get:
url : https://tintri-adm/api/v310/vm?offset=0&limit=2000
params : None
headers : {'cookie': 'JSESSIONID=6AA4811BBA4292066BCF5C8F0010D6B7', 'content-type': 'application/json'}
verify : False
2016-03-11 17:35:41,936 - DEBUG - get_VMsnapshots: vmName: 'T-ubuntu-99'
2016-03-11 17:35:41,936 - DEBUG - call_http_api_get:
url : https://tintri-adm/api/v310/snapshot?offset=0&limit=2000
params : {'queryType': 'TOP_DOCS_BY_TIME', 'contain': ['API-Test']}
headers : {'cookie': 'JSESSIONID=6AA4811BBA4292066BCF5C8F0010D6B7', 'content-type': 'application/json'}
verify : False
2016-03-11 17:35:41,960 - DEBUG - call_http_api_del:
url : https://tintri-adm/api/v310/snapshot/DCC9C84E-1062-CA6E-104D-E00EB460FC49-SST-0000000000000749
data : None
headers : {'cookie': 'JSESSIONID=6AA4811BBA4292066BCF5C8F0010D6B7', 'content-type': 'application/json'}
verify : False
2016-03-11 17:35:42,568 - INFO - [u'Successfully deleted snapshot (ID=DCC9C84E-1062-CA6E-104D-E00EB460FC49-SST-0000000000000749) of VM T-ubuntu-99.']
2016-03-11 17:35:42,569 - DEBUG - call_http_api_del:
url : https://tintri-adm/api/v310/snapshot/DCC9C84E-1062-CA6E-104D-E00EB460FC49-SST-0000000000000732
data : None
headers : {'cookie': 'JSESSIONID=6AA4811BBA4292066BCF5C8F0010D6B7', 'content-type': 'application/json'}
verify : False
2016-03-11 17:35:43,179 - INFO - [u'Successfully deleted snapshot (ID=DCC9C84E-1062-CA6E-104D-E00EB460FC49-SST-0000000000000732) of VM T-ubuntu-99.']
$ tintri_snap.py -f tintri-adm --vm T-ubuntu-99 --list
Nr. vmName createTime creatorName description Changed MB type
1 T-ubuntu-99 03/11/16 14:57:04 admin oracle12 2809.66 scheduled
2 T-ubuntu-99 03/11/16 14:59:23 admin oracle12 0.0 scheduled
3 T-ubuntu-99 03/11/16 15:00:02 tintri hourly scheduled 0.0 scheduled
4 T-ubuntu-99 03/11/16 15:26:23 admin oracle12-01 2.93 scheduled
5 T-ubuntu-99 03/11/16 16:00:03 tintri hourly scheduled 0.59 scheduled
6 T-ubuntu-99 03/11/16 16:06:32 admin GUI-Snapshot 0.54 manual
7 T-ubuntu-99 03/11/16 17:00:03 tintri hourly scheduled 1.39 scheduled
================================================================================
================================================================================ This python script tintri_flr.py intends to mount a snapshot from a Tintri-Storage on the actual LINUX-System.
After you recovered a Tintri-Snapshot you need to mount the newly generated SCSI-Devices on your LINUX System. You can do this by using several LINUX commands or by the tintri_flr.py Python script.
The only thing you have to do for mounting the snapshot is:
- call the tintri_flr.py without any option!
You must be "root" or use "sudo" to get the script working!
- check if the local virtual machine name is equal to a vmware machine name. If this is not the case, list all virtual machines and asks which one should be used.
- lists all available snapshots of the selected virtual machine. Let the user select one of them.
- maps the snapshot disks of the selected snapshot at the virtual machine
- determine the actual filesystem infomation.
- search for new Snapshot-Disks in the SCSI environment.
- generate new Mount-Points for the snapshot disks (if not allready existent).
- mount the disks.
- call the script with --reset option
================================================================================
================================================================================ This script can only be used with "normal" partitions. Volumemanager partitions couldn't be mounted from a tintri snapshot!
================================================================================
================================================================================ USAGE: tintri_flr.py [-v]* [-q] [(-f | --filer) ] [--vm ] tintri_flr.py [-v]* [-q] [--reset | --reset_all] tintri_flr.py --version
the meaning of the options:
-v add verbosity
-q | --quiet be quiet (only Error output)
-f | --filer Tintri-Filername
--vm | --vmname hypervisor virtual machine name
--reset Unmount the FLR Partitions
--reset_all Unmount the FLR Partitions and remove all cached
informations about the Linux-partitions
--version print programm version and exit
--logging <lvl> Activate Logging of the API commands to the terminal.
possible Levels are:
DEBUG, INFO, WARNING, ERROR, CRITICAL
the programm and the http_api are using the python "logging"
module.
The "reset" functionality doesn't need "filer" and "vm" parameters because these
informations are stored in a temporary file in the "dbg_path".
================================================================================
================================================================================ The filesystem information is stored in a information directory in the home directory of the "root" user. This can be changed on top of the script in the setting of the variable DBG_PATH.
The mount-points are generated in a directory named /tintri_recover. This can also be changed by editing the vraiable TINTRI_RECOVER_DIR in the top area of the script.
================================================================================
================================================================================ $ sudo tintri_flr.py Please enter the Tintri Storage-System-Name or address: admin no response from admin Could not reach Storage-System : 'admin'
Please enter the Tintri Storage-System-Name or address: tintri-adm
Please select the virtual machine for the local host
1 : EMC Backup and Recovery
2 : Oracle_Ceramtec
3 : Oracle_Ceramtec-clone
4 : T-ubuntu-01
5 : T-ubuntu-01-clone
6 : T-ubuntu-99
7 : ceramtec-a1
8 : ceramtec-b1
9 : edqtrn
10 : nsrve
Please type the Nr. of the virtual machine name for the local host
[1-10] : 6
Nr. vmName createTime creatorName description Changed MB type
1 T-ubuntu-99 03/11/16 14:57:04 admin oracle12 2809.66 scheduled
2 T-ubuntu-99 03/11/16 14:59:23 admin oracle12 0.0 scheduled
3 T-ubuntu-99 03/11/16 15:00:02 tintri hourly scheduled 0.0 scheduled
4 T-ubuntu-99 03/11/16 15:26:23 admin oracle12-01 2.93 scheduled
5 T-ubuntu-99 03/11/16 16:00:03 tintri hourly scheduled 0.59 scheduled
6 T-ubuntu-99 03/11/16 16:06:32 admin GUI-Snapshot 0.54 manual
7 T-ubuntu-99 03/11/16 17:00:03 tintri hourly scheduled 1.39 scheduled
Please enter the number of the Snapshot you want to recover from : 1
... snapshot disks will be mapped to VM; Please be patient
/bin/mount /dev/sdd2 /tintri_recover/tmp
/bin/mount /dev/sdd3 /tintri_recover/SLASH
/bin/mount /dev/sdc1 /tintri_recover/home
$ sudo tintri_flr.py --reset
... /bin/umount -l /tintri_recover/tmp
... /bin/umount -l /tintri_recover/home
... /bin/umount -l /tintri_recover/SLASH
... Remove mapped snapshot disks from virtual machine
================================================================================
================================================================================
login()
logout()
get_VMinfo(vmName=None, force=False)
get_VMnames(only_live_vms=True)
get_VMattrs(vmName=None, attrs=constants.vm_default_attrs, only_live_vms=True)
get_VMuuid(vmName)
get_VMsnapshots(vmName=None, snapname=None)
create_VMsnapshot(vmName, snap_name, consistency='CRASH_CONSISTENT')
del_VMsnapshots(vmName, snap_name=[])
flr_recover(vm_uuid, snap_uuid)
del_flr_disks(vmName)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent