vpscのドキュメントへようこそ!
さくらのVPSの非公式クライアントです。 さくらのVPS API をコマンドラインもしくはPython上で容易に扱えるようにすることを目標に作っています。
利用可能コマンドや関数に関しては vpsc package を参照してください。
利用方法
インストール
$ pip install vpsc
環境変数の設定
利用するためにはAPIキーの設定が最低限必要です
$ export VPS_API_KEY=xxx
// optional
$ export VPS_API_HOST="https://secure.sakura.ad.jp/vps/api/v7"
もしくは ~/.vpsc に設定を入れます
VPS_API_KEY=xxx
// optional
VPS_API_HOST="https://secure.sakura.ad.jp/vps/api/v7"
Todo
エラーハンドリング
コマンドの追加
その他
気になることがありましたら、リポジトリにissueやPRを投げてください!
Contents:
- vpsc package
- vpsc.commands module
- vpsc.models module
ContractContract1CreateSwitchErrorsExternalConnectionInvalidParameterDetailInvalidParameterDetailItemIpv4Ipv41Ipv6NfsServerNfsServerPowerStatusPaginationProblemDetails400ProblemDetails404ProblemDetails409ProblemDetails429ProblemDetails503ServerServerPowerStatusServiceShutdownServerStorageItemStorageItem1SwitchUpdateHostUpdateNfsServerUpdateNfsServerIpv4UpdateServerUpdateSwitchZone
- Module contents
- vpsc.api_request module
- vpsc.client module
APIConfigClientClient.create_switch()Client.delete_switch()Client.force_force_reboot_server()Client.get_nfs_server()Client.get_nfs_server_power_status()Client.get_nfs_servers()Client.get_server()Client.get_server_power_status()Client.get_servers()Client.get_switch()Client.get_switches()Client.power_on_server()Client.shutdown_server()Client.update_nfs_server()Client.update_nfs_server_ipv4()Client.update_server()Client.update_server_ipv4_ptr()Client.update_server_ipv6_ptr()Client.update_switch()