目次

概要

Cadre 製品の管理に必要なコマンドをパッケージ化したツールです。
- Cadre 製品のデプロイ(新規インストール、バージョンアップ)を行います。
- コマンドラインからユーザー操作(ユーザー追加/削除、パスワード変更)を行います。
- サポートリクエストに必要なログファイル一式を出力します。
ユーティリティツールは、リリース資材 (Cadre_<version>_<os>.7z) を解凍後、Cadre/cadreutl ディレクトリ内に配置されます。

機能一覧

使用方法

以下に示す使用方法は全て Cadre/cadreutl ディレクトリ内で実施してください。

デプロイ

Cadre アプリケーションのデプロイを行います。
使用方法の詳細はインストール手順ページの「インストール手順」章 (Windows版 / Linux版) を参照してください。

ログファイルの出力

Cadre アプリケーションのログをダンプします。
製品に不具合等があり、弊社サポートへのリクエストを行う際に使用します。

以下コマンドを実行します。

# Windows の場合
dumplog.bat
# Linux の場合
sudo ./dumplog.sh

log/yyyymmddHHMMSS ディレクトリが作成されその中にログが出力されます。
サポートリクエストをご利用の際は、日付時刻ディレクトリを圧縮してご提供をお願い致します。
yyyymmddHHMMSS は、コマンド実行時の日付時刻。

管理者ユーザー追加

Cadre アプリケーションに管理者ユーザーの追加を行います。

Cadre アプリケーションを初めてデプロイした後、必ず実施が必要です。
管理者ユーザー追加後は、Web アプリケーションの User 画面からも追加することができます。

以下コマンドを実行します。

# Windows の場合
create_admin_user.bat
# Linux の場合
sudo ./create_admin_user.sh

対話形式で管理者ユーザーの名前とパスワードを入力します。
create_user: <入力したユーザー名> succeeded. が表示されれば成功です。
入力例（成功した場合）
```
input user name:admin_user
input password:abcdefg-12345
create_user: admin_user succeeded.
2022-02-17 03:33:39.043209 create_user_main end       elapsed_time:117.25039005279541
```
create_user_main end の上にエラーメッセージが表示されている場合はエラーとなります。
エラー内容を確認し、再度実行してください。
下記エラー例はユーザー名の重複エラーです。
入力例（エラーの場合）
```
input user name:admin_user
input password:abcdefg-12345
create_user: admin_user failed. / already exists.
2022-02-17 03:35:41.751718 create_user_main end       elapsed_time:20.041305780410767
```

一般ユーザー追加

Cadre アプリケーションに一般ユーザーの追加を行います。

ユーザーの追加は Web アプリケーションの User 画面からも行えます。(管理者ユーザーでのログインが必要です。)

以下コマンドを実行します。
成功 / エラー確認方法は管理者ユーザー追加の場合と同じです。

<パラメーター説明>
--user : ユーザー名
--password : パスワード
```
# Windows の場合
cadreutl.bat create_user --user normal_user --password abcdefg-12345
# Linux の場合
sudo ./cadreutl.sh create_user --user normal_user --password abcdefg-12345
```

ユーザー削除

Cadre アプリケーションのユーザー削除を行います。(管理者ユーザー/一般ユーザー共通)

ユーザーの削除は Web アプリケーションの User 画面からも行えます。(管理者ユーザーでのログインが必要です。)

以下コマンドを実行します。
delete_user: <入力したユーザー名> succeeded. が表示されれば成功です。
delete_user_main end の上にエラーメッセージが表示されている場合はエラーとなります。
エラー内容を確認し、再度実行してください。

<パラメーター説明>
--user : ユーザー名

# Windows の場合
cadreutl.bat delete_user --user admin_user
# Linux の場合
sudo ./cadreutl.sh delete_user --user admin_user
 
# 成功の場合
delete_user: admin_user succeeded.
2022-02-17 04:13:20.968469 delete_user_main end       elapsed_time:6.344092607498169
 
# 失敗の場合
delete_user: admin_user failed. / admin_user does not exist.
2022-02-17 04:29:03.955301 delete_user_main end       elapsed_time:4.874463796615601

パスワード変更

Cadre アプリケーションのユーザーのパスワード変更を行います。

パスワード変更は Web アプリケーションからも行えます。
管理者ユーザーは、User 画面から全ユーザーのパスワード変更が行えます。
一般ユーザーは、右上のユーザーメニューの「CHANGE PASSWORD」から自身のパスワード変更が行えます。

以下コマンドを実行します。

change_password: <入力したユーザー名> succeeded. が表示されれば成功です。
change_password_main end の上にエラーメッセージが表示されている場合はエラーとなります。
エラー内容を確認し、再度実行してください。

<パラメーター説明>
--user : ユーザー名
--password: 変更するパスワード

# Windows の場合
cadreutl.bat change_password --user normal_user --password zaq12wsxcde3
# Linux の場合
sudo ./cadreutl.sh change_password --user normal_user --password zaq12wsxcde3
 
# 成功の場合
change_password: normal_user succeeded.
2022-02-17 05:56:45.748424 change_password_main end       elapsed_time:6.223598003387451
# 失敗の場合
change_password: normal_user failed. / user does not exist.
2022-02-17 05:58:31.719490 change_password_main end       elapsed_time:4.597001791000366

サポートされていないブラウザーです