Skip to content

aida0710/mdx-cli

BranchesTags

Repository files navigation

mdx-cli

MDX 1 クラウドインフラプラットフォームの非公式CLIツール。

Web ポータル (oprpl.mdx.jp) の操作をコマンドラインから実行できます。VM の一括作成・起動・停止、SSH接続、ネットワーク管理、DNAT/ACL 設定などに対応。

image

前提条件

  • MDX内部ネットワークからの実行が必要です。 MDX VPN 接続中、または MDX VM 上から実行してください。oprpl.mdx.jp および mdxidm.mdx.jp への疎通が必要です。
  • Python 3.13+
  • uv

インストール

uv tool install .

アップデート

git pull
uv tool install . --force

クイックスタート

# 1. ログイン（Shibboleth SSO、OTP必要）
# MDX Local Auth のみ対応、学認は非対応
mdx auth login

# 2. プロジェクトを選択（一度だけ）
mdx project select

# 3. VM一覧を見る
mdx vm list

# 4. VMにSSH接続
mdx vm ssh my-vm-01

コマンド一覧

mdx auth          認証管理
mdx project       プロジェクト管理
mdx vm            仮想マシン管理（list/show/deploy/start/stop/shutdown/reboot/reset/destroy/reconfigure/ssh/csv/sync）
mdx network       ネットワーク管理
  mdx network segment  セグメント管理
  mdx network acl      ACL管理
  mdx network dnat     DNAT管理
  mdx network ips      割当可能グローバルIP一覧
  mdx network check-ip グローバルIP使用状況チェック
  mdx network check-acl ACL穴チェック
mdx template      テンプレート管理
mdx task          タスク・操作履歴管理
  mdx task list    操作履歴一覧
  mdx task status  タスク状態確認
  mdx task wait    タスク完了待機

認証

Shibboleth SSO 経由でログインします。ユーザー名・パスワード・TOTP の入力が必要です。

mdx auth login     # ログイン
mdx auth status    # 認証状態を確認
mdx auth logout    # ログアウト（全クレデンシャル削除）
  • ユーザー名とパスワードは keyring（macOS Keychain 等）に保存
  • 2回目以降のログインは OTP の入力のみ
  • トークン期限切れ時は自動で再ログイン（OTP だけプロンプト）

プロジェクト

mdx project list       # プロジェクト一覧
mdx project summary    # VM数・リソース・ストレージ使用量
mdx project select     # 使用するプロジェクトを選択（以降 --project-id 不要）
mdx project show <id>  # プロジェクト詳細
mdx project storage <id>  # ストレージ情報
mdx project keys <id>  # アクセスキー一覧

project summary の表示例:

VM（スポット）:
  稼働中: 5  停止: 2  未割当: 13  合計: 20

VMディスク:
  使用: 1,500 GB / 5,000 GB（残り 3,500 GB）

高速ストレージ: /fast/0/d12345678
  使用: 100.0 GB / 500.0 GB（残り 400.0 GB, 20.0%）

大容量ストレージ: /large/0/d12345678
  使用: 2,048.0 GB / 10,000.0 GB（残り 7,952.0 GB, 20.5%）

オブジェクトストレージ: /object
  使用: 512.0 GB / 5,000.0 GB（残り 4,488.0 GB, 10.2%）

仮想マシン (VM)

一覧・詳細

mdx vm list                    # VM一覧
mdx vm show my-vm-01           # 名前で詳細表示
mdx vm show                    # 一覧から番号選択
mdx vm list --json             # JSON出力
mdx vm list --json | jq '.[] | select(.status == "PowerON") | .name'

vm show の表示例:

my-vm-01
  UUID:           a1b2c3d4-e5f6-7890-abcd-ef1234567890
  状態:           PowerON
  サービスレベル: スポット仮想マシン
  OS:             Ubuntu Linux (64-bit)
  CPU:            16
  メモリ:         64.0 GB
  GPU:            0
  パック:         cpu x 16

ディスク:
  #1: 100 GB (ds-nfs-01)

ネットワーク:
  アダプタ 1:
    セグメント:   my-network-segment
    IPv4:         10.0.0.10
    グローバルIP: 203.0.113.10

SSH接続

mdx vm ssh my-vm-01                    # 名前で接続（IP・ユーザー名を自動取得）
mdx vm ssh                             # 稼働中VMから一覧選択
mdx vm ssh my-vm-01 -i ~/.ssh/mdx-key  # 秘密鍵を指定
mdx vm ssh my-vm-01 -u root            # ユーザー名を指定
mdx vm ssh my-vm-01 -g                 # グローバルIPで接続
  • SSHユーザー名はテンプレートの login_username から自動検出（mdxuser, mdx-user01 等）
  • デフォルトはプライベートIP、-g でグローバルIPを使用

デプロイ

対話式とワンライナーの両方に対応。引数を指定した分はスキップ、未指定分だけ対話で聞きます。

# 全て対話式
mdx vm deploy

# 全引数指定（スクリプトから対話なし実行）
mdx vm deploy \
  -t "Ubuntu 22.04" \
  -n "worker-{a-e}-{0-9}" \
  --pack-type cpu \
  --pack-num 3 \
  --disk 40 \
  --service-level spot \
  -k ~/.ssh/id_ed25519.pub \
  --power-on \
  -y \
  --no-wait

# 一部だけ指定（残りは対話）
mdx vm deploy -n my-vm --pack-num 10
オプション 説明
-t / --template テンプレート名（部分一致）
-n / --name VM名（パターン対応）
--pack-type cpu / gpu
--pack-num パック数
--disk ディスクサイズ (GB)
--service-level spot / guarantee
-k / --key SSH公開鍵のパス
--power-on デプロイ後に自動起動
-y / --yes 確認をスキップ
--no-wait タスク完了を待たない

バッチ作成

VM 名にパターンを指定すると複数台を一括作成できます。

パターン 展開結果 台数 リクエスト数
my-vm my-vm 1 1
my-vm-{0-9} my-vm-0 ~ my-vm-9 10 1（API側で展開）
crawler-{a-g}-{0-9} crawler-a-0 ~ crawler-g-9 70 7（アルファベット部分のみ展開）
node-{00-05} node-00 ~ node-05 6 6（ゼロ埋めはクライアント展開）
vm-{1-99} vm-1 ~ vm-99 99 99（複数桁はクライアント展開）

単一桁数値範囲（{0-9}, {1-9}, {3-7} 等）は MDX API の [N-M] 記法に変換されサーバー側で展開されます。リクエスト数が大幅に削減され、レート制限を回避できます。

起動・停止・削除（パターン対応、5並列）

全操作でパターン指定による一括操作に対応。5並列・リトライ付き。

# 起動
mdx vm start web-server
mdx vm start "worker-*" -s spot

# 正常シャットダウン
mdx vm shutdown "worker-*"

# 強制停止
mdx vm stop "worker-*"

# 再起動 / リセット
mdx vm reboot "worker-*"
mdx vm reset "worker-*"

# 削除（稼働中VMは自動停止してから削除）
mdx vm destroy "test-*"

# 範囲パターン
mdx vm stop "worker-{a-c}-*"

構成変更（対話式、パターン対応）

VMのパック数・ディスクサイズを変更。稼働中VMは自動停止します。パターン指定で複数台を一括変更可能。

mdx vm reconfigure my-vm              # 名前指定
mdx vm reconfigure                    # 一覧から選択
mdx vm reconfigure "worker-*"         # パターンで複数台一括
mdx vm reconfigure "worker-{a-c}-*"   # 範囲パターン

複数台指定時の制約：

  • pack_type（cpu / gpu）が全VMで一致していること
  • ディスク本数が全VMで一致していること
  • 新しい pack_num と各ディスクの新容量は全VM共通で適用（device_key と segment は各VMの現状を保持）

CSV出力

mdx vm csv                          # 全VM
mdx vm csv "worker-*"               # パターン指定
mdx vm csv -o vm-info.csv           # ファイル出力
mdx vm csv "worker-*" -o out.csv    # 組み合わせ

Webポータルと同じ列構成（SERVICE_NET_1-8, STORAGE_NET_1-8）で出力します。

その他

mdx vm start "worker-*" -s guarantee  # サービスレベル指定
mdx vm sync                          # VM情報を同期
mdx vm deploy --no-wait              # タスク完了を待たない

ネットワーク

セグメント・IP

mdx network segment list         # セグメント一覧
mdx network segment show         # セグメント詳細（一覧から選択可能）
mdx network ips                  # 割当可能グローバルIP一覧
mdx network check-ip             # グローバルIPv4 使用状況チェック（穴DNATは確認後に削除可）
mdx network check-ip --fix       # 確認なしで穴DNATを即削除
mdx network check-acl            # 死んだVM宛のACL（穴）を検出（確認後に削除可）
mdx network check-acl --fix      # 確認なしで穴ACLを即削除

check-ip の表示例:

グローバルIPv4 使用状況:

  203.0.113.10  DNAT → 10.0.0.20 (db-server)
  203.0.113.11  VM: web-server
  203.0.113.12  VM: my-vm-01
  203.0.113.13  未使用
  203.0.113.14  未使用

  合計: 5  使用中: 3  未使用: 2

VM直接割当・DNAT経由・未使用を一覧表示。DNATの宛先からVM名も逆引き表示。並列取得で高速。

check-acl はプロジェクト全体のACLを走査し、宛先（10.15.*）が現存しないVMを指すルールを「穴」として検出する。VMを削除してもACL/DNATは残るため、IPが再割当されると意図しない通信を許可してしまう。

check-ip / check-acl は穴を検出すると「削除しますか?」と確認し、yes で一括削除する。--fix を付けると確認なしで即削除する。VM詳細の取得に一部失敗した場合は、穴判定が不正確になるため削除をスキップする（誤削除防止）。

DNAT（全て対話式）

mdx network dnat list    # DNAT一覧
mdx network dnat add     # 追加（グローバルIP一覧から選択、宛先を入力）
mdx network dnat edit    # 編集（一覧から選択、現在値をデフォルト表示）
mdx network dnat delete  # 削除（一覧から選択可能）

ACL（全て対話式）

mdx network acl list     # ACL一覧（セグメント自動選択）
mdx network acl add      # 追加（プロトコル・アドレス・ポートを対話入力）
mdx network acl edit     # 編集（一覧から選択、現在値をデフォルト表示）
mdx network acl delete   # 削除（一覧から選択可能）

テンプレート

mdx template list       # テンプレート一覧
mdx template show       # テンプレート詳細（一覧から選択可能）

タスク・操作履歴

mdx task list              # 操作履歴一覧（最新100件）
mdx task list -n 20        # 件数指定
mdx task list -t デプロイ   # 操作種別でフィルタ（デプロイ、自動休止 等）
mdx task list -n 1000      # 最大1000件
mdx task status <task-id>  # 個別タスクの状態確認
mdx task wait <task-id>    # タスク完了まで待機

task list の表示例:

┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┓
┃ 操作種別  ┃ 対象             ┃ 状態      ┃ 開始                ┃ ユーザー┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━┩
│ デプロイ  │ worker-a-0       │ Completed │ 2025-01-15 10:00:00 │ taro.y  │
│ 自動休止  │ worker-b-1       │ Completed │ 2025-01-15 09:30:00 │ system  │
│ DNATの削除│ 203.0.113.10     │ Completed │ 2025-01-15 09:00:00 │ taro.y  │

task status / task wait は --no-wait でデプロイした後にタスクIDで進捗を確認する用途です。

出力形式

デフォルトは、テーブル表示。--json フラグで JSON 出力に切り替え。API 取得中はスピナーが表示されます。

mdx vm list                # テーブル表示（スピナー付き）
mdx vm list --json         # JSON出力
mdx vm list --json | jq .  # jq と組み合わせ

グローバルオプション

オプション 説明
--verbose / -v API リクエスト/レスポンスの詳細ログ表示
--json JSON 出力（各サブコマンド）
--project-id / -p プロジェクト ID の明示指定

設定

環境変数 デフォルト 説明
MDX_BASE_URL https://oprpl.mdx.jp API ベース URL
MDX_PROJECT_ID - デフォルトプロジェクト ID
MDX_REQUEST_TIMEOUT 120 リクエストタイムアウト（秒）

設定ファイル: ~/.config/mdx-cli/

シェル補完

mdx --install-completion zsh  # 補完をインストール（bash/fish も対応）
exec zsh                      # シェルを再起動

開発

uv sync                # 依存インストール
uv run pytest -v       # テスト実行
mdx -v auth login      # デバッグモード

About

東大 MDX 1 クラウドインフラプラットフォームの非公式CLIツール。Web ポータル (oprpl.mdx.jp) の操作をコマンドラインから実行できます。VM の一括作成・起動・停止、SSH接続、ネットワーク管理、DNAT/ACL 設定などに対応。

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 7

v1.5.0 Latest
May 19, 2026
+ 6 releases

Contributors

Languages