vpscのドキュメントへようこそ！

さくらのVPSの非公式クライアントです。 さくらのVPS API をコマンドラインもしくはPython上で容易に扱えるようにすることを目標に作っています。

利用可能コマンドや関数に関しては vpsc package を参照してください。

---

利用方法

インストール

$ pip install vpsc

環境変数の設定

利用するためにはAPIキーの設定が最低限必要です

$ export VPS_API_KEY=xxx
// optional
$ export VPS_HOST="https://secure.sakura.ad.jp/vps/api/v7"

もしくは ~/.vpsc に設定を入れます

VPS_API_KEY=xxx
// optional
VPS_HOST="https://secure.sakura.ad.jp/vps/api/v7"

Todo

• エラーハンドリング

• コマンドの追加

その他

気になることがありましたら、リポジトリにissueやPRを投げてください！

---

Contents:

• vpsc package
  • コマンドモジュール
    • entry_point()
    • vpsc
      • apikey
      • nfs-server
      • server
  • データモデル
  • リクエストモジュール
    • APIRequest
      • APIRequest.count
      • APIRequest.generator
      • APIRequest.request()
      • APIRequest.unsafe_methods
  • クライアントモジュール
    • APIConfig
      • APIConfig.api_key
      • APIConfig.host
    • Client
      • Client.create_api_key()
      • Client.create_role()
      • Client.create_switch()
      • Client.delete_api_key()
      • Client.delete_role()
      • Client.delete_switch()
      • Client.force_force_reboot_server()
      • Client.get_api_key()
      • Client.get_api_keys()
      • Client.get_nfs_server()
      • Client.get_nfs_server_power_status()
      • Client.get_nfs_servers()
      • Client.get_permissions()
      • Client.get_role()
      • Client.get_server()
      • Client.get_server_limitation()
      • Client.get_server_power_status()
      • Client.get_servers()
      • Client.get_switch()
      • Client.get_switches()
      • Client.power_on_server()
      • Client.rotate_api_key()
      • Client.shutdown_server()
      • Client.update_api_key()
      • Client.update_nfs_server()
      • Client.update_nfs_server_ipv4()
      • Client.update_role()
      • Client.update_server()
      • Client.update_server_ipv4_ptr()
      • Client.update_server_ipv6_ptr()
      • Client.update_switch()

Indices and tables

• 索引

• モジュール索引

• 検索ページ