tabcmd コマンド


重要: ご利用のサイトが存在するポッドが Hyperforce に移ると、tabcmd 1.0 は Tableau Cloud で動作しなくなります。この影響を受けないようにするため、できるだけ早く tabcmd バージョン 2.0 への移行を計画してください。Tableau Cloud の Hyperforce への移行の詳細については、ナレッジ記事「Tableau Cloud の Hyperforce への移行」(新しいウィンドウでリンクが開く)を参照してください。Tableau Server はこの廃止による影響を受けません。

注: Tableau Cloud では、ほとんどの場合、tabcmd コマンドライン ユーティリティ 2.0 (tabcmd 2.0) を使用する必要があります。Tabcmd 2.0 は Tableau tabcmd(新しいウィンドウでリンクが開く) で入手できます。この新バージョンでは、MacOS や Linux で tabcmd コマンドを:実行し、個人アクセストークン (PAT) を使って認証することで、多要素認証 (MFA) に対応することができます。バージョン 2.0 は、Python ベースの Tableau Server クライアント (TSC) で利用可能なパブリック エンドポイントに基づいて構築されています。

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

addusers group-name

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

例

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

オプション

--users

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

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

--[no-]complete

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

グローバル オプション

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

-h, --help

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[no-]cookie

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

--timeout

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

--

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

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

creategroup group-name

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

例

tabcmd creategroup "Development"

グローバル オプション

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

-h, --help

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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 オプションを使用してそのサイトを指定します。(指定するサイト上でユーザーを作成するには、パーミッションが付与されている必要があります。)

例

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

オプション

--admin-type

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

--auth-type

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

注: SAML 認証を使用するには、サイト自身でも 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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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 のインストールでは、サーバーに複数のサイトがある場合、サーバー管理者のサイト ロールを割り当てられたユーザーは、サイトから削除されますが、サーバーからは削除されません。

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

例

tabcmd deletesiteusers "users.csv"

グローバル オプション

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

-h, --help

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[no-]cookie

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

--timeout

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

--

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

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

export

Tableau Cloud からビューまたはワークブックをエクスポートして、ファイルに保存します。このコマンドはビューに使用されるデータのみをエクスポートすることもできます。ビュー データは、集計レベルでエクスポートされます。詳細レベルのデータをエクスポートするには、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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[no-]cookie

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

--timeout

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

--

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

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

get url

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

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

  • パーミッション: ファイルを取得するには、[ダウンロード/名前を付けて 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 Cloud からダウンロードする場合、.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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[no-]cookie

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

--timeout

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

--

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

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

login

重要: tabcmd 1.0 は、多要素認証 (MFA) をサポートしていません。Tableau Cloud で tabcmd を使用するには、Tableau tabcmd 2.0(新しいウィンドウでリンクが開く) (新しいウィンドウ) を使用します。Tableau で MFA を使用する方法については、「多要素認証と Tableau Cloud について」を参照してください。

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

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

注: tabcmd login コマンドを使用する場合は、サイトが SAML を使用するよう構成されている場合でも SAML シングル サインオン (SSO) を使用できません。ログインするには、サイト上で作成されたユーザー名とパスワードを渡す必要があります。サインインしている Tableau Cloud ユーザーのパーミッションが付与されます。

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

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

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

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

例

指定されたサイト ID を使用して Tableau Cloud サイトにログインします。

tabcmd login -s https://prod-useast-b.online.tableau.com -t siteID -u user@email.com -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 コマンドが失敗します。

--cookie

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

--no-cookie

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

--timeout SECONDS

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

グローバル オプション

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

-h, --help

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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 Cloud にパブリッシュします。

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

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

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

例

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

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

例

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

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

保護された OAuth 接続からデータに接続し、トークンにアクセスする場合、代わりに --oauth-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

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

グローバル オプション

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

-h, --help

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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 を使用して、クラウドでホストされるサポート対象のデータ ソースを更新できます。たとえば、SQL Server、MySQL、クラウド プラットフォーム上の PostgreSQL、Google アナリティクスなど。
  • tabcmd を使用してオンプレミス データを更新するには、データ ソースが Tableau Bridge 推奨スケジュール用に構成できるタイプである必要があります。オンプレミス データに接続するその他すべてのデータ ソース、に対しては、Bridge またはコマンド ライン データ抽出ユーティリティを使用できます。詳しくは、Bridge を使用してデータを最新に保つおよびコマンド ラインからの抽出更新タスクの自動化を参照してください。

例

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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[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

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

注: リスト上の一部のコマンドは、Tableau Cloud で tabcmd を使用する場合は適用されない場合があります。

-s, --server

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

-u, --user

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

-p, --password

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

--password-file

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

-t, --site

コマンドを、単一引用符または二重引用符で囲んだ Tableau Cloud サイト ID によって指定されたサイトに適用することを示しています。指定されたユーザーが 2 つ以上のサイトに関連付けられている場合に、このオプションを使用します。キャッシュされた認証トークンを使用する場合、サイト ID では大文字と小文字が区別されます。大文字と小文字が一致しない場合、トークンがまだ有効であっても、パスワードの入力を求めるメッセージが表示されることがあります。

--no-prompt

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

--[no-]cookie

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

--timeout

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

--

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

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

ヒント: Tableau Server で使用できる Tabcmd 1.0 コマンドについては、「tabcmd コマンド(新しいウィンドウでリンクが開く)」を参照してください。
一番上に戻る
フィードバックをお送りいただき、ありがとうございます。フィードバックは正常に送信されました。ありがとうございます!