The tabadmin command line utility allows a user to automate site administration task on your Tableau Server site, such as creating or deleting users and projects. Tabadmin also allows for backup, upgrade and install of tableau servers. While tabcmd utility is included with Tableau Server, the installer is not included. Here is a link to the installer.
In this blog I will go over some of tabcmd commands that I learnt a few weeks ago.
When our lesson began, the first this I noticed that my prompt command screen mine was automatically set to a grey background and white writing. Whereas everyone else’s was set to a much easier to read and, being a black background and white writing. After a quick google search I was able to find a command to change the colour. However silly me kept spelling ‘colour’ the Australian way and not the American way, so this simple mistake left me to struggling to read for the rest of the class. But ones I realised my mistake it was a very easy fix.
The first thing to do is as navigated to the location where the prompt command was installed, below is an example of what my file path looked like.
Next step is to log into a your server. Below highlighted in yellow are the fields were you will enter in your own details. Server address is the unique IP address that will connect you to your server, and username and password are the credentials that you usually use to log into that server. If you have entered in you detailed correctly then the it will tell us that our sign in was successful.
After signing in there are a number of commands that can be action-ed. I will demonstrate a few, but you can see the full list here.
First thing I want to do is to create a new project for me to publish a workbook to. Below you can see the script how to create a new project.
Is the name of the project
Is an optional description.
Next I want to publish some of my workbooks into this new project. Here I have the name of the file I want to publish, although note that if the file is not in the same directory as the tabcmd the file path will need to be included in this.
Is where on the server I want it to be published to.
I can also download views, workbooks and datasources from a server. For example below will download the workbook named Monthly Sales and will download it into the desired destination.
Is the filepath and name for the download.
You can also create users and set their role type. Below I have created a new user with the role type as Read Only User.
Finally, tabcmd allows you can also delete users, workbooks, projects and etc.