SACM コマンドラインツール 『msh』 概要

はじめに

SACM コマンドラインツール 『msh』(以降 msh) はBashのようなUNIXシェルプログラムによるCUI環境において、SACMで提供される機能を利用するためのコマンドラインツールです。

SACMの管理下に置かれるサービスアダプタは、コントロールパネルから操作することを前提としているため、サービスアダプタのコンソールから直接操作することはできません。 加えて、SACMのコントロールパネルはJavaScriptをサポートするブラウザを必要とするため、通常はCUI環境からではサービスアダプタを操作することはできません。

一方で、SACMの機能はRESTful APIを経由することでコントロールパネル以外から利用することができます。 mshではこれらのAPIを用いることで、CUI環境からでもSACMを利用できる環境を提供します

下図で示すように、mshはサービスアダプタの管理者がコントロールパネル以外からSACMの機能を利用するための選択肢として提供されます。

msh概要

できること

SACMサーバと疎通性のある任意のホストにmshをインストールし、mshのコマンドを実行することにより、SACMの機能がコマンドラインから利用できるようになります。

mshには、専用のシェルからコマンドを実行するインタラクティブモードとUNIXシェルから直接個々のmshコマンドを実行する非インタラクティブモードがあります。

mshを用いることで、pingやtracerouteなどのオペレーションコマンドの実行や、監視設定やコンフィグの投入などをコマンドラインから行うことができます。 また、非インタラクティブモードを利用することにより、各種スクリプト言語による一括処理を行うことも可能です。

動作条件

mshでSACMを操作するためには、次の要件を満たす必要があります。

  • 契約関連
    • SACM に契約しており、パートナーアカウント、マネージメントコード、SAコードが発行されていること
  • mshの実行ホスト
    • mshの実行環境からSACMサーバへの到達性があること
    • mshを実行するホストが次の要件を満たしていること
      • Linux等のUNIX系OS (Ubuntu 12.04で動作を確認しています)
      • Ruby 1.9.2 以降の実行環境 (1.8系はサポートしていません)
      • git (ソースファイルを取得する場合に利用します)