Altium On-Prem Enterprise Server 管理用コマンドラインツール

Enterprise Server には、Enterprise Server の設定に関して以下の側面に対応するコマンドラインツールが用意されています。

  • User Management – 企業のシステムや記録から得たユーザー/グループ設定を一括で Enterprise Server Workspace に事前投入できるため、Workspace のブラウザベースのインターフェースで個別にエントリを作成する必要がなくなります。このツールは、標準のカンマ区切り *.csv ファイルから Users、Groups、およびユーザー‐グループ所属データのインポートをサポートします。
  • Part Choice Indexing – ユーザー定義の Part Sources(ローカル部品データベースへの接続)から取得した、Workspace ライブラリコンポーネントの Part Choices を手動で再インデックスできます。
Part choice の再インデックスは自動実行するよう設定できます。カスタムデータベースのパーツソースを定義する際に、Indexing part choices every フィールドで設定してください。パーツソースは、Workspace 管理者が Workspace のブラウザインターフェースの Part Providers ページ(Admin – Part Providers)で定義します。詳細は Configuring a Custom Database Part Source を参照してください。

このツール(avconfiguration.exe)は Enterprise Server のインストールに含まれており、\Program Files (x86)\Altium\Altium365\Tools\VaultConfigurationTool フォルダにあります。

このツールは自動ユーザー管理にも使用できますが、推奨される方法は LDAP synchronization functionality を使用することです。

設定ツールへのアクセス

ツールを使用するには:

  1. Windows のコマンドプロンプトを起動します。
  2. 正しいフォルダへ移動します。ホストコンピュータの C ドライブにデフォルトインストールした場合は、次の場所になります: cd C:\Program Files (x86)\Altium\Altium365\Tools\VaultConfigurationTool\
  3. ツールを実行して利用可能なオプションを一覧表示するには、プロンプトで次を入力します: avconfiguration ?
サーバー PC の OS によっては、コピーしたテキストを右クリックまたは Ctrl+V(あるいは両方)でコマンドプロンプトに貼り付けできます。

コマンドプロンプトから設定ツールにアクセスします。
コマンドプロンプトから設定ツールにアクセスします。

なお ? を付けると、設定ツールで利用可能な機能のヘルプが表示されます:

  • usermanagement – Users と Groups のインポート。
  • suppliers – Part Choice のインデックス作成。
  • help – ヘルプ画面の表示(文字列 help の代わりに ? を使用できます)。

ユーザー管理の構文とスイッチ

ツールの usermanagement 機能を使用する際に利用できるスイッチは次のとおりです:

avconfiguration usermanagement [-help | params [options]]

利用可能な params は次のとおりです:

  • --url – 必須。対象 Enterprise Server のアドレスとポート。
  • --user – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の User Name 部分。
  • --password – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の Password 部分(大文字小文字を区別)。
  • --roles – インポートするグループを含むファイルのファイル名。
  • --users – インポートするユーザーを含むファイルのファイル名。
  • --memberships – インポートするユーザー所属情報を含むファイルのファイル名。
CSV 入力データファイルのデフォルト検索パスは、現在のディレクトリ(avconfiguration.exe ファイルが存在する場所)です。データファイルが現在のディレクトリにない場合は、データファイルへのパスを含める必要があります。

利用可能なオプションは次のとおりです:

  • -d – 指定ファイルに記載されていないユーザーとグループを削除します。Enterprise Server Workspace に存在するユーザー/グループのうち、指定ファイルに記載されていないものはすべて削除されます(ただし System および admin ユーザー、ならびに Administrators グループは除きます)。
  • -o – 既存データを上書きします。Enterprise Server Workspace にユーザーが存在し、かつインポート対象ファイルにも同じユーザーが含まれる場合、Workspace 側の情報はインポートファイルの内容で上書きされます。

avconfiguration usermanagement のみを入力すると、これらのスイッチが補助情報として一覧表示されます。

ツールを usermanagement モードで使用する際に利用できるスイッチ。
ツールを usermanagement モードで使用する際に利用できるスイッチ。

サンプル CSV ファイル

認識される各 *.csv ファイルのサンプルがツールのディレクトリ(\Program Files (x86)\Altium\Altium365\Tools\VaultConfigurationTool)に含まれています。各ファイル種別の内容説明と要件を以下に示します。

users.csv

ユーザープロファイルデータを含みます。

フィールド名 説明 要件
FIRSTNAME 必須(少なくとも 1 文字)
LASTNAME 必須(少なくとも 1 文字)
USERNAME ユーザー名 必須
PASSWORD ユーザーパスワード 'Built In' 認証モードでは必須
PHONE 電話番号  
AUTHTYPE AUTHTYPE 必須: 認証タイプ。'Built In' 認証は 0、'Windows'(ドメイン)認証は 1
EMAIL メールアドレス  
DOMAIN ドメイン名 'Windows' 認証モードでは必須。
  • 各ユーザーはファイルの新しい行に定義する必要があります。
  • users.csv ファイルで必須フィールドのデータが欠けている場合、Enterprise Server Workspace には何もインポートされません。
  • AUTHTYPE が誤って 0('Built In')に設定されているのに DOMAIN が含まれている、などのデータエラーがある場合、ユーザーエントリはインポートされません。
  • CSV ファイルにはすべてのフィールドが存在し、カンマで区切られている必要があります。必須でないフィールドのデータは空欄にしてください(例: field1,,field2,...)。
roles.csv

グループデータを含みます。

フィールド名 説明
ROLENAME グループ名(少なくとも 1 文字)
  • 各グループはファイルの新しい行に定義する必要があります。
memberships.csv

ユーザーのグループ所属データ(どのユーザーがどのグループのメンバーか)を含みます。

フィールド名 説明
ROLENAME グループ名
USERNAME ユーザー名
  • 各ユーザー‐グループ所属の定義は、ファイルの新しい行に定義する必要があります。
  • フィールドはカンマで区切る必要があります。
  • 無効な USERNAME–ROLENAME の組み合わせは失敗しますが、有効な組み合わせのインポートは妨げません。

サプライヤーの構文とスイッチ

ツールの suppliers 機能を使用する際に利用できるスイッチは次のとおりです:

avconfiguration suppliers [-help | params]

利用可能な params は次のとおりです:

  • --url – 必須。対象 Enterprise Server のアドレスとポート。

  • --user – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の User Name 部分。

  • --passwordMD5 – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の Password 部分(MD5 ハッシュ値)。

パーツソースは、Workspace 管理者が Workspace のブラウザインターフェースの Part Providers ページ(Admin – Part Providers)で定義します。詳細は Configuring a Custom Database Part Source を参照してください。

avconfiguration suppliers のみを入力すると、これらのスイッチが補助情報として一覧表示されます。

ツールを suppliers モードで使用する際に利用できるスイッチ。
ツールを suppliers モードで使用する際に利用できるスイッチ。

入力例は次のとおりです:

avconfiguration suppliers --url=http://localhost:9780 --user=admin --passwordMD5=21232f297a57a5a743894a0e4a801fc3

AI-LocalizedAI で翻訳
問題が見つかった場合、文字/画像を選択し、Ctrl + Enter キーを押してフィードバックをお送りください。
Content