tabcmd コマンド


注: tabcmd コマンドライン ユーティリティ バージョン 2.0 は、Tableau tabcmd(新しいウィンドウでリンクが開く) で入手できます。この新バージョンでは、MacOS や Lunux で tabcmd コマンドを実行し、個人アクセス トークン (PAT) を使って認証することができます。バージョン 2.0 は、Python ベースの Tableau Server クライアント (TSC) で使用可能なパブリック エンドポイントに基づいて構築されています。この最新バージョンでは、Tableau Server のサポートに制限があります。

Tableau Server on Windows については、「tabcmd コマンド」(新しいウィンドウでリンクが開く)を参照してください。

tabadmin コマンド ライン ツールで次のコマンドを使用することができます。

addusers (グループに対して)
createextracts
creategroup
createproject
createsite
createsiteusers
createusers
decryptextracts
delete workbook-name または delete datasource-name
deleteextracts
deletegroup
deleteproject
deletesite
deletesiteusers
deleteusers
editdomain
editsite
encryptextracts
export
get url
initialuser
listdomains
listsites
login
logout
publish
publishsamples
reencryptextracts
refreshextracts
removeusers
reset_openid_sub
runschedule
set
syncgroup
upgradethumbnails
validateidpmetadata
version

addusers group-name

指定したグループにユーザーを追加します。

例

tabcmd addusers "Development" --users "users.csv"

オプション

--users

特定の .csv ファイル内のユーザーを指定されたグループに追加します。ファイルは、1 行にユーザー名が 1 つの簡単なリストでなければなりません。ユーザー名は大文字と小文字を区別しません。ユーザーは、既に Tableau Server で作成されている必要があります。

詳細については、CSV インポート ファイルのガイドラインを参照してください。

--[no-]complete

このオプションを complete に設定した場合、変更を正常に行うには、すべての行が有効でなければなりません。指定しない場合、--complete が使用されます。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createextracts

パブリッシュ済みワークブックまたはデータ ソースの抽出の作成。

オプション

-d, --datasource

抽出作成対象のデータ ソースの名前。

--embedded-datasources

ターゲット ワークブック内の埋め込みデータ ソース名をスペースで区切ったリスト。データ ソース名にスペースが含まれている場合は、二重引用符で囲みます。ワークブックの抽出を作成する場合にのみ使用できます。

--encrypt

暗号化された抽出の作成。

--include-all

ターゲット ブック内のすべての埋め込みデータ ソースを含めます。ブックの抽出を作成する場合にのみ使用できます。

--parent-project-path

ターゲット リソースを含むプロジェクトの親であるプロジェクトのパス。プロジェクト名を --project で指定する必要があります。

--project

ターゲット リソースを含むプロジェクトの名前。--workbook または --datasource が指定されている場合にのみ必要です。指定されていない場合は、既定のプロジェクト 'Default' が使用されます。

-u, -url

URL に表示されるリソースの正規名です。

-w, -workbook

抽出作成先のブックの名前。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

creategroup group-name

グループを作成します。グループ作成後にユーザーを追加するには、addusers (ローカル グループの場合) を使用します。Tableau Server グループを作成して Active Directory グループと同期するには、syncgroup (Active Directory グループの場合) を使用します。

例

tabcmd creategroup "Development"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createproject project-name

プロジェクトを作成します。

例

tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."

オプション

-n, --name

作成するプロジェクトの名前を指定します。

--parent-project-path

-n オプションで指定されたネストされたプロジェクトで、親プロジェクトの名前を付けます。たとえば、"Main (主)" プロジェクトにある "Nested (ネスト)" という名前のプロジェクトを指定するには、構文 --parent-project-path "Main" -n "Nested" を使用します。

-d, --description

プロジェクトの説明を指定します。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createsite site-name

サイトを作成します。

例

West Coast Sales という名前のサイトを作成します。のサイト IDWestCoastSales は自動的に作成され、サイトには保存容量の制限がなく、サイト管理者はユーザーの追加や削除を行うことができます。

tabcmd createsite "West Coast Sales"

wsalesのサイト ID を持つ West Coast Sales という名前のサイトを作成します。

tabcmd createsite "West Coast Sales" -r "wsales"

サイト管理者がユーザーをサイトに追加できないようにします。

tabcmd createsite "West Coast Sales" --no-site-mode

保存容量を MB 単位で設定します。

tabcmd createsite "West Coast Sales" --storage-quota 100

オプション

-r, --url

サイトを指定するために URL で使用されます。サイト名とは異なります。

--user-quota

サイトに追加できる最大ユーザー数。

--[no-]site-mode

サイトに対してユーザーの追加または削除を行う権限をサイト管理者に許可/拒否します。

--storage-quota

MBで、サイト上に格納できるワークブック、抽出、およびデータ ソースの量。

--extract-encryption-mode

サイトに対する抽出の暗号化モードを実行、有効、または無効にできます。詳細については、保存中の抽出の暗号化を参照してください。

--run-now-enabled

ユーザーが抽出の更新、フロー、またはスケジュールを手動で実行することを許可または拒否します。ユーザーが手動でタスクを実行できるようにする場合は真、ユーザーが手動でタスクを実行できないようにする場合は偽を設定します。詳細については、サーバー設定 (全般とカスタマイズ)を参照してください。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createsiteusers filename.csv

コンマ区切りの値 (CSV) で提供される情報に基づいて、サイトにユーザーを追加します。ユーザーがサーバー上にまだ作成されていない場合、このコマンドはそのユーザーを作成してからサイトに追加します。

CSV ファイルには 1 つまたは複数のユーザー名が含まれる必要があります。また、(各ユーザー用の) パスワード、フル ネーム、ライセンス タイプ、管理者レベル、パブリッシャー (はい/いいえ)、および電子メール アドレスを含めることができます。CSV ファイルの書式設定の詳細については、CSV インポート ファイルのガイドラインを参照してください。

管理者レベルおよびパブリッシャーのパーミッションを CSV ファイルに含める他の方法として、--role オプションを含め、CSV ファイルにリストされているユーザーを割り当てたいサイト ロールを指定することにより、アクセス レベル情報を渡すことができます。

デフォルトでは、ユーザーはログインしているサイトに追加されます。異なるサイトにユーザーを追加するには、広範囲の --site オプションを使用してそのサイトを指定します。(指定するサイト上でユーザーを作成するには、パーミッションが付与されている必要があります。)

サーバーに複数のサイトがある場合、createsiteusers コマンドを使用してサーバー (システム) 管理者を追加することはできません。代わりに createusers を使用してください。--role オプションの ServerAdministrator サイト ロールを指定する場合、コマンドによりエラーが返されます。CSV ファイルに管理者の値として System が含まれる場合、値は無視され、ユーザーに Unlicensed ライセンス タイプが割り当てられます。

サーバーに含まれるサイトが 1 つのみ (既定のサイト) の場合、ユーザーに対し管理者の値として system を指定できます。または、CSV ファイルに含まれるすべてのユーザーをサーバー管理者にする必要がある場合には --role オプションを使用して ServerAdministrator サイト ロールを割り当てることもできます。

既定では、このコマンドは同期操作 (続行する前にすべての操作が完了するのを待つ) を使用してユーザーを作成します。--no-waitオプションを使用して、非同期操作を指定できます。

ローカル認証

サーバーがローカル認証を使用するよう構成されている場合、CSV ファイル内の情報はユーザーを作成するために使用されます。

Active Directory 認証

サーバーが Active Directory 認証を使用するよう構成されている場合、ユーザー情報は Active Directory からインポートされ、CSV ファイル内のパスワードとわかりやすい名前の情報は無視されます。さらに、ユーザーが CSV ファイル内で指定されていても、対応するユーザーが Active Directory 内に存在しない場合、ユーザーは Tableau Server に追加されません。Active Directory ユーザーの場合、ユーザー名がドメイン全体で一意であることが保証されないため、ユーザー名の一部としてドメインを含める必要があります。これを domain\username または username@domain.com として指定できますが、domain\username 形式の使用をお勧めします。詳細については、外部 ID ストアを使用した展開におけるユーザー管理を参照してください。

例

tabcmd createsiteusers "users.csv" --role "Explorer"

オプション

--admin-type

非推奨です。代わりに、--role オプションを使用します。

--auth-type

すべてのユーザーの認証タイプ (Local または SAML) を、.csv ファイルで設定します。指定がない場合、既定では Local です。

注: SAML 認証を使用するには、Tableau Server の設定で、サイトをサイト固有の SAML 用に構成する必要があります。詳細については、「サイト固有の SAML の構成」を参照してください。

--[no-]complete

非推奨です。既定のエラー動作: 10 行の範囲内に 3 つ以上のエラーがある場合、コマンドは失敗します。

--no-publisher

非推奨です。代わりに、--role オプションを使用します。

--nowait

非同期ジョブが完了するのを待ちません。

--publisher

非推奨です。代わりに、--role オプションを使用します。

--role

.csv ファイルに含まれるすべてのユーザーに対して 1 つのサイト ロールを指定します。--role option で複数のサイト ロールを割り当てる必要がある場合、各サイト ロールに対応する別個の CSV ファイルを作成します。

有効な値は、ServerAdministrator、SiteAdministratorCreator、SiteAdministratorExplorer、SiteAdministrator、Creator、ExplorerCanPublish、Publisher、Explorer、Interactor, Viewer、および Unlicensed です。

既定値は、新しいユーザーの場合は Unlicensed で、既存のユーザーの場合は変更されません。また、ユーザーベースのサーバー インストールを行っている場合、および createsiteusers コマンドによって新しいユーザーが作成されたものの、ユーザーのライセンス数が既に上限に達している場合、ユーザーはライセンスなしとして追加されます。

注: 複数サイトの Tableau Server で ServerAdministrator サイト ロールを --role オプションを使用して割り当てる必要がある場合、createsiteusers ではなく createusers コマンドを使用します。

--silent-progress

コマンドの進捗状況メッセージを表示しません。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

createusers filename.csv

コンマ区切りの値 (CSV) で提供される情報に基づいて、Tableau Server にユーザーを作成します。

CSV ファイルには 1 つまたは複数のユーザー名が含まれる必要があります。また、(各ユーザー用の) パスワード、フル ネーム、ライセンス タイプ、管理者レベル、パブリッシャー (はい/いいえ)、および電子メール アドレスを含めることができます。CSV ファイルの書式設定の詳細については、CSV インポート ファイルのガイドラインを参照してください。

管理者レベルおよびパブリッシャーのパーミッションを CSV ファイルに含める他の方法として、--role オプションを含め、CSV ファイルにリストされているユーザーを割り当てたいサイト ロールを指定することにより、アクセス レベル情報を渡すことができます。

サーバーに 1 つのサイト (既定のサイト) しかない場合、ユーザーが作成され、サイトに追加されます。サーバーに複数のサイトがある場合、ユーザーは作成されますが、サイトには追加されません。サイトにユーザーを追加するには、createsiteusers を使用します。

ユーザーベースのサーバー インストールを行っている場合、およびコマンドによって新しいユーザーが作成されたものの、ユーザーのライセンス数が既に上限に達している場合、そのユーザーはライセンスなしのユーザーとして追加されます。

ローカル認証

サーバーがローカル認証を使用するよう構成されている場合、CSV ファイル内の情報はユーザーを作成するために使用されます。

Active Directory 認証

サーバーが Active Directory 認証を使用するよう構成されている場合、ユーザー情報は Active Directory からインポートされ、CSV ファイル内のパスワードとわかりやすい名前の情報は無視されます。さらに、ユーザーが CSV ファイル内で指定されていても、対応するユーザーが Active Directory 内に存在しない場合、ユーザーは Tableau Server に追加されません。Active Directory ユーザーの場合、ユーザー名がドメイン全体で一意であることが保証されないため、ユーザー名の一部としてドメインを含める必要があります。これを domain\username または username@domain.com として指定できますが、domain\username 形式の使用をお勧めします。詳細については、外部 ID ストアを使用した展開におけるユーザー管理を参照してください。

例

tabcmd createusers "users.csv" --role "ServerAdministrator"

tabcmd createusers "users.csv"

オプション

--admin-type

非推奨です。代わりに、--role オプションを使用します。

--[no-]complete

非推奨です。既定のエラー動作: 10 行の範囲内に 3 つ以上のエラーがある場合、コマンドは失敗します。

--no-publisher

非推奨です。代わりに、--role オプションを使用します。

--nowait

非同期ジョブが完了するのを待ちません。

--publisher

非推奨です。代わりに、--role オプションを使用します。

-r, --role

.csv ファイルに含まれるすべてのユーザーに対して 1 つのサイト ロールを指定します。--role option で複数のサイト ロールを割り当てる必要がある場合、各サイト ロールに対応する別個の CSV ファイルを作成します。

有効な値は、ServerAdministrator、SiteAdministratorCreator、SiteAdministratorExplorer、SiteAdministrator、Creator、ExplorerCanPublish、Publisher、Explorer、Interactor, Viewer、および Unlicensed です。

複数のサイトがあるサーバーでは、ユーザーはこのコマンドでサイトに割り当てられません。そのため、このコマンドによって割り当てできるサイト ロールは ServerAdministrator と Unlicensed のみです。他のサイト ロールを指定すると、コマンドにより Unlicensed ロールが割り当てられます。

単一サイトのサーバー上で、指定するロールを使用してユーザーが作成され、既定のサイトに追加されます。

ユーザーベースのサーバー インストールを行っている場合、およびコマンドによって新しいユーザーが作成されたものの、ユーザーのライセンス数が既に上限に達している場合、そのユーザーはライセンスなしのユーザーとして追加されます。

--silent-progress

コマンドの進捗状況メッセージを表示しません。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

decryptextracts

サイト上のすべての抽出を復号化します。サイトが指定されていない場合は、既定のサイトの抽出が復号化されます。詳細については、保存中の抽出の暗号化を参照してください。

抽出の数とサイズによっては、この操作によって大量のサーバー リソースが消費される場合があります。このコマンドは、通常の営業時間外に実行することを検討してください。

例

tabcmd decryptextracts "West Coast Sales"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

delete workbook-name または delete datasource-name

指定のワークブックまたはデータ ソースをサーバーから削除します。

このコマンドは、パブリッシュ時のファイル名ではなく、サーバー上に表示されるワークブック名またはデータ ソース名を取得します。

例

tabcmd delete "Sales_Analysis"

オプション

-r, --project

削除するワークブックまたはデータ ソースを含むプロジェクトの名前。未指定の場合は "既定" プロジェクトが使用されます。

--parent-project-path

-r オプションで指定されたネストされたプロジェクトで、親プロジェクトの名前を付けます。たとえば、"Main (主)" プロジェクトにある "Nested (ネスト)" という名前のプロジェクトを指定するには、構文 --parent-project-path "Main" -r "Nested" を使用します。

--workbook

削除するワークブックの名前。

--datasource

削除するデータ ソースの名前。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deleteextracts

パブリッシュ済みワークブックまたはデータ ソースの抽出の削除。

オプション

-d, --datasource

抽出削除対象のデータ ソースの名前。

--embedded-datasources

ターゲット ワークブック内の埋め込みデータ ソース名をスペースで区切ったリスト。データ ソース名にスペースが含まれている場合は、二重引用符で囲みます。ブックの抽出を削除する場合にのみ使用できます。

--encrypt

暗号化された抽出の作成。

--include-all

ターゲット ブック内のすべての埋め込みデータ ソースを含めます。

--parent-project-path

ターゲット リソースを含むプロジェクトの親であるプロジェクトのパス。プロジェクト名を --project で指定する必要があります。

--project

ターゲット リソースを含むプロジェクトの名前。--workbook または --datasource が指定されている場合にのみ必要です。指定されていない場合は、既定のプロジェクト 'Default' が使用されます。

-u, -url

URL に表示されるリソースの正規名です。

-w, -workbook

抽出削除先のブックの名前。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deletegroup group-name

指定のグループをサーバーから削除します。

例

tabcmd deletegroup "Development"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deleteproject project-name

指定のプロジェクトをサーバーから削除します。

tabcmd を使用して、プロジェクト階層で上位のプロジェクトのみを指定できます。親プロジェクト内のプロジェクトに対して実行するタスクを自動化するには、同等の Tableau REST API(新しいウィンドウでリンクが開く) 呼び出しを使用します。

例

tabcmd deleteproject "Designs"

オプション

--parent-project-path

コマンドで指定されたネストされたプロジェクトで、親プロジェクトの名前を付けます。たとえば、"Main (主)" プロジェクトにある "Designs (デザイン)" という名前のプロジェクトを指定するには、構文 --parent-project-path "Main" "Designs" を使用します。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deletesite site-name

指定のサイトをサーバーから削除します。

例

tabcmd deletesite "Development"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deletesiteusers filename.csv

ログインしているサイトからユーザーを削除します。削除するユーザーは、1 行に 1 つのユーザー名を指定した簡単なリストを含むファイルで指定されます。(ユーザー名以外の追加情報は必要ありません。)

既定では、サーバーに 1 つのサイトしかない場合、またはユーザーが 1 つのサイトにのみ属している場合、ユーザーはサーバーからも削除されます。Tableau Server Enterprise のインストールでは、サーバーに複数のサイトがある場合、サーバー管理者のサイト ロールを割り当てられたユーザーは、サイトから削除されますが、サーバーからは削除されません。

ユーザーがコンテンツを所有している場合、ユーザー ロールは「ライセンスなし」に変更されますが、ユーザーはサーバーやサイトから削除されません。コンテンツの所有者はそのユーザーのままです。ユーザーを完全に削除するには、コンテンツの所有者を変更してからユーザーの削除を再試行する必要があります。

ユーザーが Active Directory からインポートされた場合、ユーザーはサイトから削除されます。また、サーバーからも削除される可能性があります。ただし、Active Directory からは削除されません。

例

tabcmd deletesiteusers "users.csv"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

deleteusers filename.csv

指定したコンマ区切り値 (.csv) ファイルにリストされているユーザーを削除します。

.csv ファイルには 1 行に 1 つのユーザー名を指定した簡単なリストが含まれている必要があります。

例

tabcmd deleteusers "users.csv"

オプション

--[no-]complete

このオプションを --complete に設定した場合、変更を正常に行うには、すべての行が有効でなければなりません。指定しない場合、--complete が使用されます。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

editdomain

注: ベスト プラクティスとして、ドメインを編集する前に Tableau Server をバックアップする必要があります。ドメインは Tableau リポジトリに保存されます。ドメインが誤って変更されると、管理者がサインインできなくなる可能性があります。

サーバー上の Active Directory ドメインのニックネームや完全修飾ドメイン名を変更します。ドメインの「ニックネーム」は、Windows NetBIOS ドメイン名です。

サーバーが使用しているドメインのニックネームは変更可能です。通常、サインインに使用したドメイン以外のドメインでは、フルドメイン名を変更できます。ただし、現在サインインしているユーザー名が現在のドメインと新しいドメインの両方に存在する場合、現在のドメインのフルネームを変更することができます。

Tableau Server が他のアクティブ ディレクトリ ドメインに接続できるようにするには TSM で wgserver.domain.whitelist オプションを設定して Tableau Server が接続するセカンダリ ドメインも指定する必要があります。セカンダリ ドメインおよび接続の設定の詳細については、wgserver.domain.whitelistを参照してください。

外部 ID ストアを使用した展開におけるユーザー管理を見直し、複数のドメイン、ドメイン名マッピング、ユーザー名が Tableau Server をどのように操作するかを理解してください。

ドメインのリストを参照するには、listdomains を使用します。

例

tabcmd editdomain --id 2 --nickname "new-nickname"

tabcmd editdomain --id 3 --name "new-name"

オプション

--id

変更するドメインの ID です。ドメイン ID のリストを取得するには、listdomains を使用します。

--name

ドメインの新しい名前です。

--nickname

ドメインの新しいニックネームです。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

editsite site-name

サイトまたはその Web フォルダー名を変更します。このコマンドを使用して、サイト管理者がユーザーを追加/削除したりユーザーによる特定のタスクの手動実行を防止したりすることを許可または拒否することもできます。サイト管理者にユーザー管理権限がある場合は、サイトに追加できるユーザー数を指定できます。

例

tabcmd editsite wc_sales --site-name "West Coast Sales"

tabcmd editsite wc_sales --site-id "wsales"

tabcmd editsite wsales --status ACTIVE

tabcmd editsite wsales --user-quota 50

オプション

--site-name

表示されたサイトの名前。

--site-id

サイトを一意に識別するために URL で使用されます。

--user-quota

サイトのメンバーになれる最大ユーザー数。

--[no-]site-mode

サイトへのユーザーの追加をサイト管理者に許可/拒否します。

--status

ACTIVE に設定してサイトを有効化するか、あるいは SUSPENDED に設定してサイトを一時停止します。

--storage-quota

MBで、サイト上に格納できるワークブック、抽出、およびデータ ソースの量。

--extract-encryption-mode

サイトに対する抽出の暗号化モードを実行、有効、または無効にできます。詳細については、保存中の抽出の暗号化を参照してください。抽出の数とサイズによっては、この操作によって大量のサーバー リソースが消費される場合があります。

--run-now-enabled

ユーザーが抽出の更新、フロー、またはスケジュールを手動で実行することを許可または拒否します。ユーザーが手動でタスクを実行できるようにする場合は真、ユーザーが手動でタスクを実行できないようにする場合は偽を設定します。詳細については、サーバー設定 (全般とカスタマイズ)を参照してください。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

encryptextracts

サイト上のすべての抽出を暗号化します。サイトが指定されていない場合は、既定のサイトの抽出が暗号化されます。詳細については、保存中の抽出の暗号化を参照してください。

抽出の数とサイズによっては、この操作によって大量のサーバー リソースが消費される場合があります。このコマンドは、通常の営業時間外に実行することを検討してください。

例

tabcmd encryptextracts "West Coast Sales"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

export

Tableau Server からビューまたはワークブックをエクスポートして、ファイルに保存します。このコマンドはビューに使用されるデータのみをエクスポートすることもできます。ビュー データは、集計レベルでエクスポートされます。詳細レベルのデータをエクスポートするには、Tableau Server UI を使用する必要があります。詳細については、「「ビューとワークブックのダウンロード(新しいウィンドウでリンクが開く)」を参照してください。

このコマンドを使用するときには、以下に注意してください。

  • パーミッション: エクスポートするには、[イメージのエクスポート] パーミッションが必要です。既定では、このパーミッションはすべての役割で許可されているか継承されますが、ワークブックまたはビューごとにパーミッションを設定することもできます。

  • データのエクスポート: ビューに使用されるデータのみをエクスポートするには、--csv オプションを使用します。ビューで使用されるサマリー データを .csv ファイルにエクスポートします。

  • ビュー、ワークブック、またはエクスポートするデータの指定:

    • URL の一部をエクスポート対象を特定するために使用します。具体的にはワークブックまたはビューの URL に現れる "workbook/view" 文字列を使用します。「わかりやすい名前」は使用せず、URL の末尾にあるセッション ID 「:iid=<n>」を除外します。

      例えば、Tableau の Superstore ワークブックのサンプル ビュー [オーダーの詳細] には次のような URL があります。<server_name>/#/views/Superstore/OrderDetails?:iid=2

      [オーダーの詳細] ビューをエクスポートするには、文字列「Superstore/OrderDetails」を使用します。

      Superstore/Order Details や Superstore/OrderDetails?:iid=2 は使用しないでください。

    • サーバーが複数のサイトを実行し、ビューまたはワークブックが "既定" 以外のサイトにある場合、-t <site_id> を使用します。

    • ワークブックをエクスポートするには、ワークブック内でビューを開いて、URL 文字列を取得し、使用するストリングにビューを含めます。

      上の例では、Superstore ワークブックをエクスポートするために、文字列 Superstore/OrderDetails を使用します。

    • ワークブックをエクスポートするには、[Tableau Desktop パブリッシュ] ダイアログ ボックスで [シートをタブとして表示] を選択して、それをパブリッシュしておく必要があります。

      注: 管理ビュー(新しいウィンドウでリンクが開く) を含む Tableau ワークブックはエクスポートできません。

    • ダウンロードするデータをフィルターするには、次の形式を使用してパラメーター フィルターを追加します。

      ?<filter_name>=value

      または、パラメーターのフィルター処理で、そのパラメーターにメジャーまたはディメンションの名前と一致する表示名が含まれている場合は、次の形式を使用します。

      ?Parameters.<filter_name>=value

  • ファイルの保存形式: 形式オプションは、エクスポートするファイルによって異なります。ワークブックは --fullpdf 引数を使用して PDF としてエクスポートします。ビューは PDF (--pdf) または PNG (--png) としてエクスポートできます。

  • 保存するファイルの名前と場所 (省略可): 名前を指定しなければ、ビューまたはワークブックの名前から生成されます。場所を指定しなければ、ファイルは現在の作業ディレクトリに保存されます。それ以外の場合は、完全パスまたは現在の作業ディレクトリに対して相対的なパスを指定できます。

    注: .csv や .pdf などのファイル名拡張子を含める必要があります。このコマンドは、指定したファイル名に拡張子を自動的に追加しません。

  • PDF エクスポートに含まれていないダッシュボード Web ページ オブジェクト: ダッシュボードはオプションで Web ページ オブジェクトを含めることができます。Web ページ オブジェクトを含むダッシュボードの PDF へエクスポートする場合、Web ページ オブジェクトは PDF に含まれません。

  • 非 ASCII 文字と非標準の ASCII 文字、PDF のエクスポート: 名前に ASCII 文字セット以外の文字、または非標準の ASCII 文字セットが含まれるビューまたはワークブックをエクスポートする場合は、その文字を URL エンコード (パーセント エンコード) する必要があります。

    たとえば、コマンドに都市「Zürich」が含まれる場合、URL を「Z%C3%BCrich」とエンコードする必要があります。

    tabcmd export "/Cities/Sheet1?locationCity=Z%C3%BCrich" -fullpdf

キャッシュをクリアしてリアルタイム データを使用

キャッシュからデータを取得する代わりに新しいデータ クエリを強制的に実行するために、オプションで URL パラメーターの ?:refresh=yes を追加できます。独自のスクリプトで tabcmd を使用していて、refresh URL パラメーターを頻繁に使用している場合、パフォーマンスに悪影響を与える可能性があります。リアルタイム データが必要な場合は refresh のみを使用することをお勧めします (ワークブック全体の代わりに 1 つのダッシュボードなど)。

例

ビュー

tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report.csv"

tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

tabcmd export "Finance/InvestmentGrowth" --png

tabcmd export "Finance/InvestmentGrowth?:refresh=yes" --png

ワークブック

tabcmd export "Q1Sales/Sales_Report" --fullpdf

tabcmd export "Sales/Sales_Analysis" --fullpdf --pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

オプション

-f, --filename

指定したファイル名と拡張子でファイルが保存されます。

--csv

ビューのみ。ビューのデータ (サマリー データ) を .csv 形式でエクスポートします。

--pdf

ビューのみ。PDF としてエクスポートします。

--png

ビューのみ。イメージとして .png 形式でエクスポートします。

--fullpdf

ワークブックのみ。PDF としてエクスポートします。ワークブックは [シートをタブとして表示] を有効にしてパブリッシュする必要があります。

--pagelayout

エクスポートする PDF のページの向き (landscape または portrait) を設定します。指定しなければ、Tableau Desktopの設定が使用されます。

--pagesize

エクスポートする PDF のページサイズを次のいずれかに設定します。unspecified、letter、legal、note folio、tabloid、ledger、statement、executive、a3、a4、a5、b4、b5、または quarto。既定は letter です。

--width

幅をピクセル単位で設定します。既定値は 800 px です。

--height

高さをピクセル単位で設定します。既定値は 600 px です。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

get url

指定した (部分的) URL によって表される Tableau Server からリソースを取得します。結果はファイルとして返されます。

このコマンドを使用するときには、以下に注意してください。

  • パーミッション: ファイルを取得するには、[ダウンロード/名前を付けて Web に保存] パーミッションが必要です。既定では、このパーミッションはすべての役割で許可されているか継承されますが、ワークブックまたはビューごとにパーミッションを設定することもできます。

  • 取得ビューまたはワークブックの指定: 取得するビューを指定するには "/views/<workbookname>/<viewname>.<extension>" 文字列を使用し、取得するワークブックを指定するには、"/workbooks/<workbookname>.<extension>"文字列を使用します。<workbookname>  と <viewname> を、ブラウザーデビューを開いたときに URL に表示されるワークブック名とビューに置き換え、<extension> を保存するファイル形式に置き換えます。URL の末尾にセッション ID (?:iid=<n>) を使用したり、「わかりやすい」名前をワークブックやビューに使用しないでください。

    たとえば、"メトリクス サマリー" というワークブックでビュー "地域合計" を開くと、URL は次のようになります。

    /views/MetricsSummary_1/RegionalTotals?:iid=1

    文字列 /views/MetricsSummary_1/RegionalTotals.<extension> を使用してビューを取得します。

    文字列 /workbooks/MetricsSummary_1.<extension> を使用してビューを取得ｓいます。

    ワークブックやビューを Tableau Server からダウンロードする場合、.twb または .twbx ファイルのコンテンツは、プレーン テキストで保存されます。ユーザーがファイルを開くと、データの意味的な手がかりとなるフィルター値を含むすべてのデータを読むことができます。

  • ファイル拡張子: URL にはファイル拡張子を含める必要があります。拡張子によって返される結果が異なります。ビューは、PDF、PNG、または CSV (サマリー データのみ) 形式で返すことができます。Tableau ワークブックは、パブリッシュされたデータ ソースに接続するかライブ接続を使用する場合、TWBとして返されます。データ抽出に接続する場合は TWBX として返されます。

    注: ビューを PDF または PNG ファイルにダウンロードし、.pdf または .png 拡張子を含む --filename パラメーターを含める場合、その URL に .pdf または .png 拡張子を含める必要はありません。

  • 保存するファイルの名前と場所 (省略可): --filename に使用する名前に、ファイル拡張子を含める必要があります。名前とファイル拡張子を指定しなければ、両方とも URL の文字列から取得されます。場所を指定しなければ、ファイルは現在の作業ディレクトリに保存されます。それ以外の場合は、完全パスまたは現在の作業ディレクトリに対して相対的なパスを指定できます。

  • PNG サイズ (オプション): 保存されているファイルが PNG の場合、ピクセル単位で URL のサイズを指定できます。

キャッシュをクリアしてリアルタイム データを使用

キャッシュからデータを取得する代わりに新しいデータ クエリを強制的に実行するために、オプションで URL パラメーターの ?:refresh=yes を追加できます。独自のスクリプトで tabcmd を使用していて、refresh パラメーターを頻繁に使用している場合、パフォーマンスに悪影響を与える可能性があります。リアルタイム データが必要な場合は refresh のみを使用することをお勧めします (ワークブック全体の代わりに 1 つのダッシュボードなど)。

例

ビュー

tabcmd get "/views/Sales_Analysis/Sales_Report.png" --filename "Weekly-Report.png"

tabcmd get "/views/Finance/InvestmentGrowth.pdf" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth.csv"

tabcmd get "/views/Finance/InvestmentGrowth.png?:size=640,480" -f growth.png

tabcmd get "/views/Finance/InvestmentGrowth.png?:refresh=yes" -f growth.png

ワークブック

tabcmd get "/workbooks/Sales_Analysis.twb" -f "C:\Tableau_Workbooks\Weekly-Reports.twb"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

initialuser

初期の管理ユーザーが定義されていないサーバーに、初期サーバーの管理者ユーザーを作成します。これにより、サーバー管理者が作成されます。この操作では、TSM 管理者は作成されません。

単一引用符で値を囲みます。

注: tabcmd initialuser コマンドは、Tableau Server への認証を要求しませんが、初期サーバー ノード上でコマンドを実行する必要があります。

注:

  • tabcmd initialuser コマンドは、Tableau Server への認証を必要としませんが、初期サーバー ノード上でコマンドを実行する必要があります。
  • ユーザー名のサフィックスが Tableau Server のプライマリ ドメインと一致しない限り、username 値に @ マークを含めることはできません。たとえば、Tableau Server がドメイン "myco.com" に接続する場合、"user@example.com@myco.com" というユーザー名は使用できません。

例

tabcmd initialuser --username 'admin' --password 'password' --server http://localhost

tabcmd initialuser --username 'admin' --password 'password' --friendly 'Tableau Admin' --server http://localhost

シェルでパスワードを要求するには、コマンドに --password パラメーターを含めません。例は次のとおりです。

tabcmd initialuser --username 'admin' --server http://localhost

オプション

-f, --friendly

表示名を持つ初期サーバー管理者ユーザーを作成します。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

listdomains

サーバーで使用中の Active Directory ドメインのリストをニックネームや ID と一緒に表示します。サーバーがローカルの認証を使用するように構成されている場合、コマンドによりドメイン名の local のみが返されます。

例

tabcmd listdomains

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

listsites

ログインしたユーザーが属しているサイトのリストを返します。

例

tabcmd listsites --username adam --password mypassword

オプション

--get-extract-encryption-mode

サイトに対する抽出の暗号化モードを実行、有効、または無効にできます。詳細については、保存中の抽出の暗号化を参照してください。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

login

Tableau Server ユーザーをログインします。

セッションを作成するために、--server、--site、--username、--passwordグローバル オプションが使用されます。

注: tabcmd login コマンドを使用する場合は、サーバーが SAML を使用するよう構成されている場合でも SAML シングル サインオン (SSO) を使用できません。ログインするには、サーバー上で作成されているユーザー名とパスワードを渡す必要があります。サインインしている Tableau Server ユーザーのパーミッションを取得します。詳細については、ユーザーのサイト ロールの設定およびパーミッションを参照してください。

セッションの作成で既に使用した情報を使用してログインする場合は、--password オプションだけを指定してください。cookie に保管されているサーバーとユーザー名が使用されます。

サーバーが 80 (既定) 以外のポートを使用している場合は、ポートを指定する必要があります。

サーバーで複数のサイトを実行し、デフォルト サイトでないサイトにログインしている場合にのみ、--site(-t) オプションが必要になります。パスワードを指定しない場合、パスワードを要求するプロンプトが表示されます。--no-prompt オプションを指定し、パスワードを指定しない場合、このコマンドは失敗します。

ログインした後、セッションはサーバーで有効期限が切れるか、logout コマンドが実行されるまで継続されます。

例

ユーザー jsmith をローカル マシンで稼働している Tableau Server にログインさせます。

tabcmd login -s http://localhost -u jsmith -p password

管理者を sales-server の Sales (セールス) サイトにログインさせます。

tabcmd login -s http://sales-server -t Sales -u administrator -p password

tabcmd login -s http://sales-server:8000 -t Sales -u administrator -p password

管理者は SSL を使用して sales-server の Sales サイトにログインしますが、サーバーの SSL 証明書は検証しません。

tabcmd login --no-certcheck -s https://sales-server -t Sales -u administrator -p password

localhost の順行プロキシとポートを確立します。

tabcmd login --proxy myfwdproxyserver:8888 -s http://localhost -u jsmith -p password

ユーザー jsmith に SSL を使用して、逆行プロキシにログインさせます。

tabcmd login -s https://myreverseproxy -u jsmith -p password

オプション

-s, --server

ネットワーク上の Tableau Server コンピューターからコマンドを実行する場合は、http://localhost を使用できます。そうでない場合は、http://bigbox.myco.com または http://bigbox のようにコンピューターの URL を指定します。

サーバーが SSL を使用している場合は、コンピューターの URL で https:// を指定する必要がありますにあります。

Tableau Cloud の場合は、サイトがデプロイされているポッドを含む完全な URL を指定します。例: https://prod-useast-b.online.tableau.com。

-t, --site

サーバーに複数のサイトがあり、ドフォルト サイトでないサイトにログインしている場合、このオプションを含めます。

サイト ID は、サイトを一意に識別するために URL で使用されます。たとえば、West Coast Sales という名前のサイトには、west-coast-salesというサイト ID が設定されている可能性があります。

-u, --username

ユーザーがログインするユーザー名。Tableau Cloud の場合、ユーザー名はユーザーの電子メール アドレスです。

-p, --password

--username 用に指定されたユーザーのパスワード。パスワードを指定しない場合、パスワードを要求するプロンプトが表示されます。

--password-file

パスワードを、コマンド ラインではなく指定された filename.txt ファイルに保管し、セキュリティを向上させることができます。

-x, --proxy

tabcmd 要求に HTTP プロキシ サーバーとポート (Host:Port) を指定するために使用します。

--no-prompt

パスワードを要求しません。パスワードを指定しないと、login コマンドが失敗します。

--no-proxy

HTTP プロキシ サーバーを使用しません。

--cookie

ログオン時のセッション ID を保存します。後続コマンドは、ログインを必要としません。この値は、このコマンドで既定です。

--no-cookie

ログインが正常に完了した後はセッション ID 情報を保存しません。後続コマンドにはログインが必要です。

--timeout SECONDS

login コマンドの処理まで、サーバーが待機する秒数です。既定: 30 秒です。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

logout

サーバーからログアウトします。

例

tabcmd logout

filename.twb(x)、filename.tds(x)、またはfilename.hyper のパブリッシュ

指定したワークブック (.twb(x))、データ ソース (.tds(x))、または抽出 (.hyper) を Tableau Server にパブリッシュします。

ワークブックをパブリッシュする場合、デフォルトでは、ワークブック内のすべてのシートは、データベースのユーザー名またはパスワードなしでパブリッシュされます。

ワークブックやデータ ソースに最初に割り当てられるパーミッションは、ファイルがパブリッシュされるプロジェクトからコピーされます。パブリッシュされるリソースのパーミッションは、ファイルがパブリッシュされた後に変更できます。 

ワークブックにユーザー フィルターが含まれている場合、いずれかのサムネイル オプションを指定する必要があります。

例

tabcmd publish "analysis.twbx" -n "Sales_Analysis" --db-username "jsmith" --db-password "secret-password"

tabcmd publish "analysis_sfdc.hyper" -n "Sales Analysis"
--oauth-username "user-name" --save-oauth

ファイルが tabcmd と同じディレクトリにない場合、ファイルへの完全なパスを含めます。

例

tabcmd publish "\\computer\volume\Tableau Workbooks\analysis.twbx" -n "Sales_Analysis" --db-username "jsmith" --db-password "secret-password"

tabcmd publish "\\computer\volume\Tableau Workbooks\analysis_sfdc.hyper" -n "Sales Analysis" --oauth-username "username" --save-oauth

オプション

-n, --name

サーバー上のワークブックまたはデータ ソースの名前。省略した場合は、ワークブック、データ ソース、またはデータ抽出がファイル名の後で指定されます。

-o, --overwrite

既にサーバー上に存在するワークブック、データ ソース、またはデータ抽出を上書きします。

-r, --project

指定されたプロジェクトにワークブック、データ ソース、データ抽出をパブリッシュします。未指定の場合は "既定" プロジェクトにパブリッシュされます。

--parent-project-path

-r オプションで指定されたネストされたプロジェクトで、親プロジェクトの名前を付けます。たとえば、"Main (主)" プロジェクトにある "Nested (ネスト)" という名前のプロジェクトを指定するには、構文 --parent-project-path "Main" -r "Nested" を使用します。

--db-username

ワークブック、データ ソース、またはデータ抽出と共にデータベース ユーザー名をパブリッシュするにはこのオプションを使用します。

--db-password

ワークブック、データ ソース、または抽出と共にデータベース パスワードをパブリッシュするにはこのオプションを使用します。

--save-db-password

指定されたデータベース パスワードをサーバーに保存します。

--oauth-username

ユーザー アカウントの電子メール アドレス。--name に指定されたクラウド データ ソースの保存されたアクセス トークンをユーザーが既に持っている場合、事前に構成された OAuth 接続からユーザーに接続します。アクセス トークンはユーザー設定で管理できます。

データ ソースへの既存の OAuth 接続では --db-username および --db-password ではなく、このオプションを使用します。

--save-oauth

--oauth-username により指定された認証資格情報を、パブリッシュされたワークブックまたはデータ ソースと一緒に埋め込み認証資格情報として保存します。

その後、パブリッシャーまたはサーバー管理者がサーバーにサインインして、そのワークブックまたはデータ ソースの接続を編集すると、接続設定ではこの OAuth 認証資格情報がコンテンツに埋め込まれているように表示されます。

パブリッシュ後に抽出更新をスケジュールする場合、--oauth-usernameを使用してこのオプションを含める必要があります。これは、従来のデータベース接続で --save-db-password を使用するのと似ています。

--thumbnail-username

ワークブックにユーザー フィルターが含まれている場合、指定されたユーザーが表示できる内容に基づいてサムネイルが生成されます。--thumbnail-group オプションが設定されている場合は、指定できません。

--thumbnail-group

ワークブックにユーザー フィルターが含まれている場合、指定されたグループが表示できる内容に基づいてサムネイルが生成されます。--thumbnail-username オプションが設定されている場合は、指定できません。

--tabbed

タブ付きのビューと共にワークブックがパブリッシュされた場合、各シートはタブになります。ビューアーはこのタブを使用して、ワークブック内のシートを切り替えることができます。シート レベルのセキュリティは、この設定によってオーバーライドされます。

--append

既存のデータ ソースに抽出ファイルを追加します。

--replace

既存のデータ ソースを置換するために抽出ファイルを使用します。

--disable-uploader

増分ファイル アップローダーを無効にします。

--restart

ファイルのアップロードを再開します。

--encrypt-extracts

ワークブック、データ ソース、または抽出をサーバーにパブリッシュするときに、抽出を暗号化します。詳細については、保存中の抽出の暗号化を参照してください。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

publishsamples

説明

Tableau のサンプル ワークブックを指定したプロジェクトにパブリッシュします。既存のサンプルはすべて上書きされます。

構文

tabcmd publishsamples -n [project name] [Global options]

例

[既定] サイトで、内部営業プロジェクトにサンプルをパブリッシュします (ユーザー = jsmith)。

tabcmd publishsamples -n "Inside Sales" -t "" -s localhost --username "jsmith" --password "secret-password"

オプション

-n, --name

必須。Tableau のサンプルを指定したプロジェクトにパブリッシュします。プロジェクト名にスペースが含まれている場合は、名前全体を引用符で囲んでください。

--parent-project-path

-n オプションで指定されたネストされたプロジェクトで、親プロジェクトの名前を付けます。たとえば、"Main (主)" プロジェクトにある "Nested (ネスト)" という名前のプロジェクトを指定するには、構文 --parent-project-path "Main" -n "Nested" を使用します。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

reencryptextracts

新しい暗号化キーを使用して、サイト上のすべての抽出を再暗号化します。このコマンドはキー暗号化キーとデータ暗号化キーを再生成します。サイトを指定する必要があります。詳細については、保存中の抽出の暗号化を参照してください。

抽出の数とサイズによっては、この操作によって大量のサーバー リソースが消費される場合があります。このコマンドは、通常の営業時間外に実行することを検討してください。

例

tabcmd reencryptextracts "Default"

tabcmd reencryptextracts "West Coast Sales"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

refreshextracts workbook-name または refreshextracts datasource-name

指定されたワークブックまたはデータ ソースに属する抽出の完全更新または増分更新を実行します。

このコマンドは、パブリッシュ時のファイル名ではなく、サーバー上に表示されるワークブック名またはデータ ソース名を取得します。ワークブックまたはデータ ソースの管理者や所有者のみがこの操作を実行できます。

注: サーバー管理者がサイトで [今すぐ実行] 設定を無効にしている場合、このメソッドは失敗してエラーになります。詳細については、「サーバー設定」(新しいウィンドウでリンクが開く)を参照してください。

例

tabcmd refreshextracts --datasource sales_ds

tabcmd refreshextracts --project "Sales External" --datasource sales_ds

tabcmd refreshextracts --project "Sales External" --parent-project-path "Main" --project "Sales External" --datasource sales_ds

tabcmd refreshextracts --workbook "My Workbook"

tabcmd refreshextracts --url SalesAnalysis

tabcmd refreshextracts --workbook "My Workbook" --addcalculations

tabcmd refreshextracts --datasource sales_ds --removecalculations

オプション

--incremental

増分更新操作を実行します。

--synchronous

バックグラウンダー プロセスが使用できるとすぐに実行されるように、完全なリフレッシュ操作をバックグラウンダー プロセスで使用されるキューに追加します。バックグラウンダー プロセスが使用できる場合、操作はすぐに実行されます。リフレッシュ操作がバックグラウンド タスク レポートに表示されます。

同期更新の間、tabcmd はリフレッシュ操作の実行中にサーバーとのライブ接続を保ち、バックグラウンド ジョブが実行されるまで毎秒ポーリングします。

注: --synchronous オプションは、Tableau Bridge で更新されたデータ ソースでは使用できません。

--workbook

更新する抽出を含むワークブックの名前。ワークブック名にスペースが含まれる場合、名前を引用符で囲みます。

--datasource

更新する抽出を含むデータ ソースの名前。

--project

"既定" 以外のプロジェクトのワークブックまたはデータ ソースを指定するには、--workbook または --datasource と共に使用します。未指定の場合は "既定" プロジェクトが使用されます。

--parent-project-path

--project オプションで指定されたネストされたプロジェクトで、親プロジェクトの名前を付けます。

例:

  • たとえば、"Main (主)" プロジェクトにある "Nested (ネスト)" という名前のプロジェクトを指定するには、次の構文を使用します
  • --parent-project-path "Main" --project "Nested"
  • "ネスト" プロジェクト内でネストされている "Nested2" という名前のプロジェクトを指定するには、次の手順を実行します。 
  • --parent-project-path "Main/Nested" --project "Nested2"

--url

URL に表示されるワークブック名です。"Sales Analysis" としてパブリッシュされたワークブックの URL 名は "SalesAnalysis" になります。

--addcalculations

ワークブックの埋め込まれた抽出の計算をマテリアライズするには --workbook と一緒に使用し、抽出データ ソースの計算をマテリアライズするには --datasource と一緒に使用します。バックグラウンダー プロセスが使用するキューに操作を追加します。バックグラウンダー プロセスが使用できる場合、操作はすぐに実行されます。この操作は [抽出でのバックグラウンド タスク] 管理ビューに表示されます。

--removecalculations

以前マテリアライズされた計算を削除するには、--workbook または --datasource と一緒に使用します。バックグラウンダー プロセスが使用するキューに操作を追加します。バックグラウンダー プロセスが使用できる場合、操作はすぐに実行されます。この操作は [抽出でのバックグラウンド タスク] 管理ビューに表示されます。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

reset_openid_sub

既に Tableau Server ID に関連付けられている OpenID Connect 識別子 (sub 値) をクリアします。Tableau Server で OpenID Connect 用に IdP を変更するを参照してください。

例

tabcmd reset_openid_sub --target-username jsmith

オプション

--target-username

指定した個々のユーザーの sub 値をクリアします。

--all

すべてのユーザーの sub 値をクリアします。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

removeusers group-name

指定したグループからユーザーを削除します。

例

tabcmd removeusers "Development" --users "users.csv"

オプション

--users

指定されたグループから指定された .csv ファイル内のユーザーを削除します。ファイルは、1 行にユーザー名が 1 つの簡単なリストでなければなりません。

--[no-]complete

変更を正常に行うには、すべての行が有効であることが必要です。指定しない場合、--completeが使用されます。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

runschedule schedule-name

現在ログインしているサイトのタスクを指定されたスケジュールで実行します。すべてのサイトに対して Tabcmd を使用して実行することはできません。すべてのサイトのタスクをスケジュールで実行するには、Web インターフェイスにログインし、[スケジュール] ページから [すべてのサイト] を選択して、スケジュールで [今すぐ実行] を実行します。

このコマンドは、サーバーで指定したスケジュールの名前を使用します。

このコマンドは Tableau Cloud では使用できません。

注: サーバー管理者がサイトで [今すぐ実行] 設定を無効にしている場合、このメソッドは失敗してエラーになります。詳細については、「サーバー設定」(新しいウィンドウでリンクが開く)を参照してください。

例

tabcmd runschedule "5AM Sales Refresh"

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

set setting

サーバー上の指定された設定を有効にします。各設定の詳細は、サーバーの [メンテナンス] ページで参照できます。

設定を無効にするには、設定名の前に感嘆符を付けてください。有有効にしたり無効にしたりできる設定は次のとおりです。

  • allow_scheduling

  • embedded_credentials

  • remember_passwords_forever

例

tabcmd set embedded_credentials

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

syncgroup group-name

Tableau Server グループを Active Directory グループと同期化します。Tableau Server グループがまだ存在しない場合、指定された Active Directory グループと同期して作成されます。

グループの名前に "@" が含まれている場合 (ドメイン セパレータ以外で)、16 進形式 "\0x40" を使用して記号を参照する必要があります.

例

tabcmd syncgroup "Development"

tabcmd syncgroup "Dev\0x40West"

注: 自分がメンバーであるグループを同期する場合、このコマンドを使用して行った変更は、自分自身のユーザーに適用されません。たとえば、自分がメンバーであるグループのユーザーから、このコマンドを使用して管理者権限を削除した場合、そのコマンドが実行されても自分自身は管理者のままです。

オプション

--grant-license-mode <grant-license-mode>

サインイン時にロールを付与するかどうかを指定します。既定は on-syncです。有効な値は、on-login、on-sync です。値を指定しない場合、on-syncが使用され、グループの同期時に既定のロールが付与されます。詳細については、"サインイン時にロールを付与" が有効になっているユーザー ロールを変更するを参照してください。

--no-publisher

非推奨です。代わりに、--role オプションを使用します。

--overwritesiterole

--role を使用すると、ユーザーのサイト ロールを特権の少ない役割で上書きできます。デフォルトでは、ユーザーのサイト ロールは --role を使用して昇格できますが、降格はできません。--overwritesiterole オプションはユーザーのサイト ロールを降格するため、注意して使用する必要があります。

--publisher

非推奨です。代わりに、--role オプションを使用します。

-r, --role

グループ内のユーザーのサイト ロールを指定します。既定では Unlicensed です。

有効な値は、SiteAdministratorCreator、SiteAdministratorExplorer、SiteAdministrator、Creator、ExplorerCanPublish、Publisher、Explorer、Interactor、Viewer、Unlicensed.です。

--silent-progress

コマンドの進捗状況メッセージを表示しません。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

upgradethumbnails

サムネイルのアップグレード ジョブを開始および停止します。詳細については、サムネイルのアップグレード ジョブを参照してください。

例

サムネイルのアップグレード ジョブを開始するには:

tabcmd upgradethumbnails --server <serverURL>

進行中のアップグレード サムネイル ジョブを停止するには:

tabcmd upgradethumbnails --server <serverURL> --stop

オプション

--stop

このオプションを指定すると、進行中のアップグレード サムネイル ジョブが停止します。このオプションを指定しない場合、サムネイルのアップグレード ジョブが開始します。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

validateidpmetadata

安全でないダイジェスト アルゴリズム SHA-1 を使用する IdP を用いて構成されている Tableau Server サイトを識別します。このコマンドは、RSA キーのサイズまたは楕円曲線のサイズが不十分である証明書を使用している IdP も識別します。

注: このコマンドは、サイト固有の SAML にのみ使用できます。詳細については、「サイト固有の SAML の構成」を参照してください。

オプション

--digest-algorithms <ALGORITHMS>

ダイジェスト アルゴリズムのスペース区切りのリスト有効な値は、sha1 と sha256 です。指定しない場合、サーバーはサーバー構成設定の wgserver.saml.blocklisted_digest_algorithms から値を使用します。

--min-allowed-elliptic-curve-size <SIZE>

指定しない場合、サーバーはサーバー構成設定の wgserver.saml.min_allowed.elliptic_curve_size から値を使用します。

--min-allowed-rsa-key-size <SIZE>

指定しない場合、サーバーはサーバー構成設定の wgserver.saml.min_allowed.rsa_key_size から値を使用します。

--site-names <SITENAMES>

証明書の検証を実行するサイト名のスペース区切りのリスト指定されていない場合は、すべてのサイトが検査されます。

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

version

tabcmd ユーティリティの現在のインストールのバージョン情報を出力します。

例

tabcmd version

グローバル オプション

次のオプションは、すべての tabcmd コマンドによって使用されます。セッションを開始するには、--server、--user、および --password オプションを少なくとも 1 回使用する必要があります。認証トークンは保管されているため、後続のコマンドを実行するときに、これらのオプションを含める必要はありません。このトークンは、それを使用した最後のコマンドの実行後、5 分間だけ有効です。

-h, --help

コマンドのヘルプを表示します。

-c, --use-certificate

クライアント証明書を使用してサインインします。相互 SSL が有効な場合に指定する必要があります。

証明書の構成方法の詳細については、最初に、Tableau Server OS の次の該当するトピックを参照してください。

-s, --server

Tableau Server URL。セッションを開始するために少なくとも 1 回指定する必要があります。

-u, --user

Tableau Server ユーザー名。セッションを開始するために少なくとも 1 回指定する必要があります。

-p, --password

Tableau Server パスワード。セッションを開始するために少なくとも 1 回指定する必要があります。

--password-file

パスワードを、コマンド ラインではなく指定された .txt ファイルに保管し、セキュリティを向上させることができます。

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Server サイト ID によって指定されたサイトに適用することを示しています。既定のサイトを指定するには、単一引用符または二重引用符 ('' または "") を付けた空の文字列を使用するか、二重引用符で囲んだ Default を使用します ("Default")。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

-x, --proxy

Host:Port

指定された HTTP プロキシを使用します。

--no-prompt

指定した場合、このコマンドではパスワードが要求されません。有効なパスワードを指定しないと、コマンドが失敗します。

--no-proxy

指定した場合、HTTP プロキシは使用されません。

--no-certcheck

指定した場合、tabcmd (クライアント) はサーバーの SSL 証明書を検証しません。

--[no-]cookie

指定した場合、セッション ID はログイン時に保存されるため、その後にコマンドを実行するときにログインする必要はなくなります。セッション ID を保存しない場合は、プレフィックス no- を使用します。既定ではセッションは保存されます。

--timeout

サーバーがコマンドの処理を完了するまで、指定された時間 (秒単位) 待機します。既定では、プロセスはサーバーが応答するまで待機します。

--

コマンド ラインでオプションの最後を指定します。-- を使用し、-- の後に続く値はオプション設定ではなく、コマンドの値として解釈することを tabcmd に示すことができます。ハイフンを含むコマンドで値を指定する必要がある場合に便利です。次の例では、tabcmd コマンドで -- の使用が必要になる場合を示しています。ここで、-430105/Sheet1 は export コマンドで必要な値です。

tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1

ヒント: Tableau Cloud で使用できる Tabcmd 1.0 コマンドについては、「 tabcmd コマンド(新しいウィンドウでリンクが開く)」を参照してください。
一番上に戻る
フィードバックをありがとうございます。フィードバックは正常に送信されました。ありがとうございます!