Tab Commands by Prazval.

ks
TABCMD, TABADMIN:-

TABCMD, TABADMIN are the two command line utilities in the Tableau Server.

 Using these two we could perform all the operations using command prompt.

TABCMD:-

Using TABCMD all the normal operations can be achieved.

 Normal operations like creating users, projects, sites, etc. can be achieved.
 TABCMD can be operated from any machine.
 If you want to use TABCMD on the other machines we need to install TABCMD on those machines.

TABADMIN:-

Using TABADMIN all the administrative operations can be performed.

 TABADMIN can be operated from only the machine where we have installed the Tableau Server.

TABCMD:-

TASK 1:- Installing TABCMD on other machines.

Step 1:- Connect to the machine where T.Server has installed. And copy the TABCMD Installation file from the
following location.

C:\program files (*86)\Tableau\Tableau Server\9.0\extracts ----------- 32 Bit

C:\program files\Tableau\Tableau Server\9.0\extracts ----------- 64 Bit

Step 2:- Click on the setup file in the welcome window click on Next.

Step 3:- Accept the agreement click on Next.

Click on next,

Click on Install

TASK 2:- Login into the server using TABCMD.

Note:- To work with the TABCMD we have to open the command prompt in the administrator mode.

Syntax: - TABCMD LOGIN -s <Server_Location> -u <User name> -p <Password>

-S/ -- Server  Server Location

-U/ -- User name  User Name

 Tab Commands by Prazval.ks
-P/ -- Password  Password

Step 1:- In the command prompt enter

TABCMD LOGIN –s http://192.168.1.202:84 –u Aim –p aim@123

And click on enter.

Step 2:- Check whether login got succeeded or not.

TASK 3:- Adding the users using TABCMD.

Syntax:- TABCMD CREATEUSERS <csv file> [Site Role]

Step 1:- In the command prompt enter.

TABCMD CREATEUSERS “c:\users\srini\documents\my tableau repository\local data\user.csv”

Step 2:- Login into the server and check whether users got added or not.

All the TABCMD commands are case sensitive and they have to be specified in the lowercase.

TASK 4:- Creating groups, projects using TABCMD.

Groups Syntax:- TABCMD Create group <Group-Name>

Ex:- TABCMD create group AIM

Project Syntax:- TABCMD create project –n <Project-name> -d <Project- Description>

Ex:- TABCMD create project –n ‘AIM’ –d “Aim’s Project”

TASK 5:- Adding users to the group using TABCMD.

Syntax:- TABCMD ADDUSERS <GRP-NAME> --USERS <csv.file> --[NO] –COMPLETE

Ex:- TABCMD addusers AIM –users “c:\users.csv” –no –complete

Step 1:- In the CSV File if we don’t specify that complete information then add an option of --no –complete.

TASK 6:- Publishing content into the Tableau Server using TABCMD.

Syntax:- TABCMD PUBLISH <workbook\data source location> [--project <project-name>]

Ex:- TABCMD publish “c:\workbook\AIM.twbx”  Publish into default project.

TABCMD publish “c:\workbook\AIM.twbx” –project ‘Aim’  Publish into AIM project.

 Tab Commands by Prazval.ks
Note:- While publishing if we don’t specify the project name, tableau will publish the content into the default
project.
TASK 7:- Create Sites.

Syntax:- TABCMD CREATESITE <Site-name>

Ex:- TABCMD createsite Aim

TASK 8:- Login into site using TABCMD.

Syntax:- TABCMD LOGIN –s <Server_location> -t <Site_id> -u <User- name> -p <Password>

Ex:- TABCMD login –s http:\\192.168.1.202:84 –t Aim –u Aim –p aim@123

TASK 9:- Creating site users.

Syntax:- TABCMD CREATESITEUSERS <csv.file> [Site_Rloe]

Ex:- TABCMD createsiteusers “c:/users.csv”

Note:- If we create users tableau will create them on the server. Where as if you create site users tableau will
add them to the required site.

TASK 10:- Editing the site using TABCMD.

Syntax:- TABCMD EDITSITE <SITE_ID> [Options]

Options Values

1. --Site-name <Req.name>
2. --Storage-quota <Req.quota>
3. --User-quota <User count>
4. --Status <Active or suspend>

Step 1:- In the CMD prompt enter.

TABCMD editsite Aim2 --Site-id Aim_cmd2.

Step 2:- To change the status of the site enter

TABCMD editsite aim_cmd2 --Status Suspend.

TASK 11:- Display the list of sites available in the T.Server.

 Tab Commands by Prazval.ks
Syntax:- TABCMD LISTSITES

In the CMD prompt enter

TABCMD listsites

TASK 12:- Running a schedule using TABCMD.

Syntax:- TABCMD RUNSCHEDULE <SCHEDULE-NAME>

Ex:- TABCMD runschedule “Everyday 7 PM”

TASK 13:- Refreshing the extracts using TABCMD.

Syntax:-

TABCMD REFRESHEXTRACT --data source <data source-name> --workbook <work book-name>

Options:- --incremental  To perform the incremental refresh.

Ex:- TABCMD refreshextract --datasource “Kbc” –incremental

TASK 14:- Listing the Active Directory domains.

Syntax:- TABCMD LISTDOMAINS

Delete operations:-

1) Delete group

Syntax:- TABCMD DELETEGROUP <group-name>

EX:- TABCMD deletegroup “Aim”

2) Delete Project

Syntax:- TABCMD DELETEPROJECT <Project-name>

Ex:- TABCMD deleteproject “2012 Files”

3) Delete Site

Syntax:- TABCMD DELETESITE <Site_name>

Ex:- TABCMD deletesite “INDIA”

 Tab Commands by Prazval.ks
4) Delete Users

Syntax:- TABCMD DELETEUSERS <csv.file>

EX:- TABCMD deleteusers “c:/documents/user.csv”

5) Delete Site Users

Syntax:- TABCMD DELETESITEUSERS <csv.file>

Ex:- TABCMD deletesiteusers “c:\documents\user.csv”

TABADMIN:-

 TABADMIN is the second command line utility from the T.Server.

 The TABADMIN can operate from only the machine where we have installed the T.server.

Note:- To use TABADMIN we have to open the command prompt in the Administrator mode.

TASK 1:- Starting, Stopping and restarting the server use TABADMIN.

Syntax:-

TABADMIN START  It will start the server

TABADMIN STOP  It will stop the server

TABADMIN RESTART  It will restart the server

Step 1:- Connect to the machine where T.Server has installed.

Step 2:- Open the cmd prompt in the Administrator mode.

Step 3:- Change the directory to the following location.

“cd c:\programfile (*86)\Tableau\Tableau Server\9.0\bin”

Step 4:- To stop the server enter

TABADMIN stop

Step 5:- To Start the server enter

TABADMIN start

Step 6:- To restart the server enter

TABADMIN restart
 Tab Commands by Prazval.ks
TASK 2:- Configuring autostart behaving for T.Server.

Syntax:-

TABADMIN AUTOSTART ON  It will automatically start the server, wherever the machine starts.

TABADMIN AUTOSTART OFF  It will denies the Auto start functions.

TASK 3:- Cleaning the Log Files

Syntax:- TABADMIN CLEANUP

Note:- Tableau Server internally managed by multiple server components like. VIZQL Server, Application
Server, Data server, etc.

 All these processes operate by generating the log files which will consume the memory.
 To clean them we will use cleanup command.

Note:- T.Server Log files will be stored in the following location.

“c:\program data\tableau\Tableau server\data\tabsvc”

 Where program data is a hidden folder.

CREATING BACKUP:-

TASK 4:- TAKING THE BACKUP OF THE T.SERVER

 T.Server Backup Contains complete repository information (postgre SQL data, user information,
configuration settings).
 Taking backup is one of the maintenance activities in the T.Server which will improves the efficiency of
the server by releasing the space on the machine.

Syntax:- TABADMIN BACKUP <backup filename>.tsbak.

Step 1:- In the CMD prompt enter

TABADMIN backup “c;\backup\batch17.tsbak” -d

And click on enter.

Step 2:- It will create a backup file in the backup folder.

Step 3:- “-d” will append date to the backup file.

 In real time the backup file size would be in 200 MB – 2 GB.

EXPORT SITE:-
 Tab Commands by Prazval.ks
TASK 5:- Taking the backup of the site.

Note:-

 In T.Server even the site can be backed up using export site command.
 If you take the export of a site that export file contains user information, data, settings of a site.

Syntax:- TABADMIN exportsite <Site ID> --file <file-Location>

Step 1:- In the CMD prompt enter.

TABADMIN Aim1 --file “c:\Backup\Aim_site”

Note:- Tableau will export the site in the ZIP format. ZIP Size(Approximate size in realtime would be
from 20 MB – 50 GB)

Note:- While exporting the site tableau will locks the site.

6.IMPORTING A SITE:-

The content of the one site can be imported from the other site using import site command.

Steps to perform import:-

Step 1:- Run the import site command.

Syntax:- TABADMIN IMPORTSITE <TARGET_SITE ID> - -File <Export file_Location>

Note:- Import site Requires

1) Site Id of the Target Site.

2) Export file of the Source Site.

Step 2:- Verify the mappings which got generated in the first step.

Note:- Mapping will be stored in the following location.

“c:\program data\tableau\T.Server\data\tabsvc\temp”

Step 3:- Run the import site verified command.

Syntax:- TABADMIN IMPORTSITE _verified <Target_Site ID> - - importjobdir <location>

Note:- Tableau will automatically generate importsite_verified command.

7.RESTORING THE T.SERVER:-

If you want to restore the T.Server to the previous state we can restore using the backup file.

Syntax:- TABADMIN RESTORE <Backup file>

 Tab Commands by Prazval.ks
Step 1:- In the CMD prompt enter

TABADMIN restore “c:\backup\batch17.tsbak”

Step 2:- After Restoring Start the T.Server using TABADMIN start

To avoid the configuration restore while taking the backup enter

Syntax:- TABADMIN restore --no -config <backup file> --restart TASK

8:- Changing the existing name and logo.

Step 1:- Using T.Server we can change the existing logo and name using customize option.

Syntax:- TABADMIN CUSTOMIZE LOGO <req_logo_image>

TABADMIN CUSTOMIZE LOGO <req_name>

EX:- TABADMIN customize logo “c:\users\Aimtech\Desktop\aim.jpg”

Step 2:- To change the Name enter

TABADMIN customize name “AIM TECHNOLOGY SERVER”

Step 3:- Enter TABADMIN restart To

effect the changes.

Step 4:- To change the logo & name to default enter

TABADMIN customize name –d

TABADMIN customize logo –d

TASK 9:- Checking the status of the T.SERVER

Step 1:- Enter TABADMIN status

TASK 10:- Validating the T.SERVER

Step 1:- In the CMD prompt enter TABADMIN validate

It will displays the processor size, memory, etc.

TASK 11:- Checking the license & processor codes

Step 1:- To check the license enter TABADMIN licenses

Step 2:- To check the processor codes enter TABADMIN licenses -p

 Tab Commands by Prazval.ks
12.CHANGING THE SITE STATE USING TABADMIN:-
Note:- While performing the import or export of the site first tableau will lock the site locking means
suspending.

If the import or export got failed then the sites remains in locked state. It is the responsibility of the system or
site admin to release the site as unlock.

Syntax:- TABADMIN sitestate <site_ID> --status <Activate/Suspended>

Step 1:- In CMD prompt enter

TABADMIN sitestate Aim1 --Status Active

13.CHANGING THE PASSWORD FOR SERVER ADMIN USER:-

Syntax:- TABADMIN password <username>

EX:- TABADMIN password Aim

14.GRANTING AND REMOVING THE SYSTEM ADMIN PERMISSION:-

Grant Syntax:- TABADMIN administrator <username> <true/false>

EX:- tabadmin administrator Aim true  Assign the role.

Remove role Example:- tabadmin administrator Aim False

15.TAKING THE BACKUP OF THE LOG FILES:-

Syntax:- TABADMIN ziplogs <filename>

EX:- tabadmin ziplogs –d 20-06-2015 ”c:\backup\aimtechlogs.zip”

It will Zip the log files from the specified date 20-06-2015.

16.CHANGING THE T.SERVER CONFIGURATION SETTINGS USING TABADMIN:-

1) Stop the server

Tabadmin stop
2) Set the req.option or value
Tabadmin set [option or value]
3) Configure the change
Tabadmin configure
4) Start the server
Tabadmin start
 Tab Commands by Prazval.ks
17.HELP:-

Tabadmin help commands