- 1
-SoftLayer Command Line Interface
環境の導⼊
(Rev-1.0)
2013 年１⽉
株式会社シーホース 協栄テックス株式会社
- 2 -【本資料における使⽤上のご注意事項】 １．本資料の内容は予告なく変更・更新することがあります。 ２．本資料に記載された内容は情報の提供のみを⽬的としたもので、正式に記載各社のテストやレビューを受けておりま せん。 ３．本資料の内容についてできる限り正確を期すよう努めておりますが、いかなる明⽰または暗黙の保証も責任も負いか ねます。本資料の情報は、ご使⽤先の責任において活⽤される情報であることを、あらかじめご了承ください。 ４．本資料の著作権は、株式会社シーホース及び協栄テックス株式会社が保有しています。 ５．本資料へのお問い合わせ、⼆次配布等につきましては、株式会社シーホースまたは協栄テックス株式会社までご連 絡ください。 ６．本⽂中にある製品名は各社の商標または登録商標です。 ７．また、「developerWorks ご利⽤条件」も併せてご参照ください。 https://www.ibm.com/developerworks/community/terms?lang=ja
- 3 -１．はじめに ２．導⼊ステップ概要 ３．導⼊ ４．おわりに ⽬ 次
- 4 -SoftLayer の提供するメイン API は、多くのファンクションコールがあり（API Ver3.0：180 を超える サービス、2200 のファンクションコール）、ポータルで提供している機能のほとんどが API を使ってプログラミ ングできるそうです。
これを使えば、独⾃のポータルを作成、運⽤操作の⾃動化が可能になります。
例えば、インスタンス（サーバー）の作成、削除、変更をはじめとし、運⽤・保守など様々な⽤途が独⾃ のルールで組み⽴てられます。
⾔語は C#, Perl, PHP, Python, Ruby, VB .Net がサポートされ、REST, SOAP & XML-RPC イ ンターフェースがサポートされています。
ただ、筆者は⾔語やインターフェースをよく知らないため、勉強するにもかなりの時間をかけなくてはならなく、 結局この恩恵をすぐに受けることができませんでした。
幸いなことに、「Command Line Interface」も提供されていますので、シェルプログラムに組み込めば、 API を使ってプログラミングしなくても、各種機能が使えます。
では、次にくる問題としては、「Command Line Interface」は Python で書かれているため、Python の環境を作らなくてはいけません。Python をご存じの⽅は簡単に導⼊できるでしょうが、Python という名 前しか知らない筆者にとって何をどうすれば良いかを調べるところから始めました。
本資料は、「Command Line Interface」を動かすための、Python 導⼊から環境づくりまでを書いた ものです。
（意外と簡単に導⼊できました。）
「Command Line Interface」の各機能については、別資料で作成する予定ですので、あえて触れて いません。
尚、クライアント PC システム環境は Windows7（32bit）を使⽤しています。 １．はじめに
- 5 -① ポータル画⾯のユーザー⼀覧(Users)から、API Key を取得。
② Python 2 系と Python 3 系がありますが、今回２系の Python 2.7.6 を導⼊。 ③ 次のステップ（④）で Python ツールを導⼊する際、wget を使⽤。
④ Python でよく使われているツール、ez_setup / pip の導⼊。 ⑤ pip で SoftLayer パッケージを導⼊。
⑥ ユーザーID や API Key を設定。
◆◆◆ これで環境作成完了です。 ◆◆◆ ⑦ 実際にコマンドを⼊⼒し、結果を確認。
２．導⼊ステップ概要
①API Key 取得 ②Python 導⼊ ③wget 導⼊
④Python ツール 導⼊ ⑤SoftLayer パッケージ導⼊ ⑥構成のセットアップ ⑦機能の確認 【図.01】
- 6 -３－①．API Key 取得
API Key は API を使ってアクセスするユーザーを許可する、英数字の⼀意の識別⼦です
「Command Line Interface」は SoftLayer API を使⽤していますので、API Key が必要です。 ・API Key はポータル画⾯の 「Account」 ⇒ 「Users」 ユーザー⼀覧から設定・取得します。
・API Key を取得するユーザー⾏の右側にある 「Generate」 リンクをクリック。
・しばらくすると 「Generate」 から 「View」 へ変わり、API Key が作成されました。 ３．導⼊
【図.02】
【図.03】
- 7 -・「View」 リンクをクリックすると作成された API Key が表⽰されます。
OK を押し、ウインドゥを閉じて完了です。
【補⾜】
⽣成した API Key を削除するには．．．．。
・API Key を削除するユーザー⾏の右側にある 「Action」 プルダウンメニューから 「Remove API Key」を選択します。
【図.05】
【図.06】
- 8 -３－②．Python 導⼊
Python を Windows７（32bit）環境で使えるように、導⼊と環境設定を説明します。
Python 2 系と Python 3 系がありますが、ここでは２系で現在最新の Python 2.7.6 を導⼊します。 ３－②－１．Python 2.7.6 のダウンロード
・http://www.python.org/のサイトから Python2.7.6 の Windows ⽤インストーラーをダウンロード します。
「Quick Links (2.7.6)」 ⇒ 「Windows Installer」 をクリックし、ダウンロード開始。 尚、ダウンロードするインストーラーモジュール名は 「python-2.7.6.msi」です。 ３－②－２．Python 2.7.6 のセットアップ ・ダウンロードした 「python-2.7.6.msi」をダブルクリックして、インストーラーを起動します。 「Next」ボタンを押す。 【図.08】 【図.09】
- 9 -・Python 導⼊フォルダーを選択します。 ここでは、そのままの値を使いました。
「Next」ボタンを押す。
【図.10】
- 10 -・これで Python 導⼊が完了しました。 「Finish」ボタンを押して、終了してください。 ３－②－３．Python 環境変数の設定 ・「Python.exe」が実⾏モジュールです。 初期値で導⼊したので、導⼊フォルダーは 「c:\Python27」、 その中に「Python.exe」があるのが確認できます。 このフォルダーに環境変数 Path を通します。 尚、導⼊フォルダーを変更した⽅は、「Python.exe」のあるフォルダーに Path を通します。 【図.12】 【図.13】
- 11 -・「コントロールパネル」から「システム」を選択してください。 ・「システムの詳細設定」をクリックすると、「システムのプロパティ」「詳細設定」タグが表⽰されますので、 「環境変数」ボタンをクリックしてください。 【図.14】 【図.15】 【図.16】
- 12 -・下段の「システム環境変数」から、「変数名 Path」を選択し、「編集」ボタンを押します。 ・「変数値」の末尾に「;Paython27」を追加して、「OK」ボタンを押してください。 尚、Python 導⼊フォルダーを変更した⽅は、Python.exe のあるフォルダーに変えて設定してください。 その際、セミコロンを忘れないようにお願いします。 ※ご注意）最初からある変数値を誤って消した場合は、「キャンセル」で抜けて上記⼿順から開始して ください。 「OK」ボタンで終了したら、環境変数の設定完了です。 【図.17】 【図.18】
- 13 -３－②－４．Python 導⼊の確認 ・Python が正常に導⼊されたかを、コマンドプロンプトで確認します。 「Python」と⼊⼒し、Enter キーを押してください。 正常に導⼊されていれば、Python の対話型シェルが起動されます。 バージョン情報の後に、プロンプト「>>>」が表⽰されたら正常に導⼊されています。 「Ctrl」と「ｚ」ボタンを押し、Enter キーを押して対話型シェルから抜けます。 コマンドプロンプトになりましたら、「Exit」で終了してください。 対話型シェルが起動しない⽅は、環境変数の設定を確認してください 【図.19】 【図.20】
- 14 -３－③．wget 導⼊
次のステップで、Python ツールを導⼊します。
Python ツール導⼊は wget コマンドを使⽤します。Linux はコマンドとして標準提供されていますが、残 念な事に Windows には標準提供されていないため、ダウンロードして導⼊します。 ３－③－１．wget ダウンロード ・http://gnuwin32.sourceforge.net/packages/wget.htm のサイトから、「wget-1.11.4-1-dep.zip」、「wget-1.11.4-1-bin.zip」の 2 つのファイルをダウンロ ードします。 Download セクションの下記場所からダウンロードできます。
・Binaries Zip ---- 「wget-1.11.4-1-bin.zip」 ・Dependencies Zip --- 「wget-1.11.4-1-dep.zip」
３－③－2．ダウンロードファイルの解凍 ・C:\wget_tool フォルダーを作成し、ダウンロードした 2 つのファイルを解凍します。 2 つの Zip ファイルは解凍後、削除して構いません。 ・ 【図.21】 【図.22】
- 15 -３－③－３．フォルダー名の変更 wget-1.11.4-1-bin フォルダー名を wget に変更 ３－③－４．DLL のコピー C:\wget_tool\wget-1.11.4-1-dep\bin の 4 つの dll を、C:\wget_tool\wget\bin へコピー 【図.24】 【図.25】 【図.23】
- 16 -３－③－５．wget 環境変数の設定 環境変数画⾯までは＜３－②－３．Python 環境変数の設定＞をご参照ください。 ・下段の「システム環境変数」から、「変数名 Path」を選択し、「編集」ボタンを押します。 ・「変数値」の末尾に「;C:\wget_tool\wget\bin」を追加して、「OK」ボタンを押してください。 ※ご注意）最初からある変数値を誤って消した場合は、「キャンセル」で抜けて上記⼿順から開始して ください。 「OK」ボタンで終了したら、環境変数の設定完了です。 【図.26】 【図.27】
- 17 -３－③－6．wget 導⼊の確認 ・Python が正常に導⼊されたかを、コマンドプロンプトで確認します。 「wget」と⼊⼒し、Enter キーを押してください。 正常に導⼊されていれば、下図のメッセージが表⽰されます。 「Exit」で終了してください。 これで、wget の導⼊完了です。 【図.28】 【図.29】
- 18 -３－④．Python ツール導⼊
後程、SoftLayer パッケージを導⼊しますが、その導⼊のために pip が必要で、pip を使⽤するために、 setuptools が必要になります。ここでは、setuptools と pip を wget を使って導⼊します。
前提として、Python と wget が必要です。 ３－④－１．setuptools 導⼊ 導⼊は簡単です。
・コマンドプロンプトで下記コマンドを⼊⼒してください。
（表⽰は 2 ⾏ですが、続いてます。1 ⾏で⼊⼒してください。）
wget --no-check-certificate https://bitbucket.org/pypa/setuptools/raw/ bootstrap/ez_setup.py && Python ez_setup.py ⏎
導⼊が完了すると、下図のようになります。
【図.30】
- 19 -３－④－２．pip 導⼊
導⼊は簡単です。
・コマンドプロンプトで下記コマンドを⼊⼒してください。
（表⽰は 2 ⾏ですが、続いてます。1 ⾏で⼊⼒してください。）
wget --no-check-certificate https://raw.github.com/pypa/pip/master/contrib/ get-pip.py && python get-pip.py ⏎
導⼊が完了すると、下図のようになります。
以上で Python ツール導⼊完了です。
【図.32】
- 20 -３－⑤．SoftLayer パッケージ導⼊
Pip を使⽤して、SoftLayer パッケージを導⼊します。
Pip.exe は、Python 導⼊ディレクトリー\Scripts にありますので、ディレクトリーを変更してください。 （本環境は c:\Python27 に導⼊しましたので、c:\Python27\Scripts になります。） ・コマンドプロンプトで下記コマンドを⼊⼒してください。
pip install softlayer ⏎
導⼊が完了すると、下図のようになります。
以上で SoftLayer パッケージ導⼊完了です。
【図.34】
- 21 -３－⑥．構成のセットアップ
「Command Line Interface」環境導⼊の最後のステップです。
ここでは、導⼊済みの SoftLayer パッケージを起動し、ユーザーID、API Key を登録します。 sl.exe は、Python 導⼊ディレクトリー\Scripts にありますので、ディレクトリーを変更してください。 （本環境は c:\Python27 に導⼊しましたので、c:\Python27\Scripts になります。） ・コマンドプロンプトで下記コマンドを⼊⼒してください。
sl config setup ⏎
・SoftLayer ID、パスワード（または API Key）、EndPoint を⼊⼒します。 【図.36】
- 22 -・構成の最終確認
この設定で良ければ 「ｙ」を⼊⼒して終了。
以上で、「Command Line Interface」環境導⼊が完了しました。
- 23 -３－⑦．機能の確認
ここでは例として、現在稼働している Cloud Computer Instance の⼀覧を⾒ます。 コマンドは、 sl cci list です。 コマンドプロンプトでは、改⾏のために⾒にくくなってますので、メモ帳で⾒てみます・ 以上で機能の確認終了です。 【図.39】 【図.40】
- 24 SoftLayer の提供する多くの API を理解するには、「Command Line Interface」から⼊ると分かり やすいと思います。
本資料は、「Command Line Interface」を動かすまでの環境作りを中⼼にしています。 次回は「Command Line Interface」について、資料を作成する予定です。
参考資料： http://sldn.softlayer.com/reference/overview http://www.softlayer.com/about/automation/open-api/ http://knowledgelayer.softlayer.com/topic/developmentapi http://sldn.softlayer.com/ https://softlayer-api-python-client.readthedocs.org/en/latest/ 誤字脱字などなにかございましたらこちらまでお願いいたします。 株式会社シーホース 村北光明 [email protected] 協栄テックス株式会社 ⼯藤崇史 [email protected] ４．おわりに
