vpsc package

コマンドモジュール

VPSC のコマンド一覧です

vpsc.commands.entry_point()[ソース]

vpsc

VPSC コマンドです。

操作するリソースを指定して実行してください

vpsc [OPTIONS] COMMAND [ARGS]...

apikey

APIキーのリソースに対する操作

vpsc apikey [OPTIONS] COMMAND [ARGS]...

create

vpsc apikey create [OPTIONS]

Options

-n, --name <name>: 名前

-rid, --role-id <role_id>: Required ロールID

list

APIキー情報の取得

vpsc apikey list [OPTIONS]

Options

-id, --key-id <key_id>: APIキーID

update

vpsc apikey update [OPTIONS]

Options

-id, --key-id <key_id>: Required APIキーID

-n, --name <name>: 名前

-rid, --role-id <role_id>: Required ロールID

nfs-server

NFSサーバーのリソースに対する操作

vpsc nfs-server [OPTIONS] COMMAND [ARGS]...

list

NFSサーバー情報の取得

vpsc nfs-server list [OPTIONS]

Options

-id, --nfs-server-id <nfs_server_id>: NFSサーバーID

power-status

NFSサーバーの電源状態を取得

vpsc nfs-server power-status [OPTIONS]

Options

-id, --nfs-server-id <nfs_server_id>: Required サーバーID

update

サーバー情報更新

vpsc nfs-server update [OPTIONS]

Options

-id, --nfs-server-id <nfs_server_id>: NFSサーバーID

-n, --name <name>: 名前

-d, --description <description>: 説明

update-ipv4

NFSサーバーのipv4を設定

vpsc nfs-server update-ipv4 [OPTIONS]

Options

-id, --nfs-server-id <nfs_server_id>: NFSサーバーID

-h, --hostname <hostname>: Required ホスト名

server

サーバーリソースに対する操作

vpsc server [OPTIONS] COMMAND [ARGS]...

limitation

サーバーの電源状態を取得

vpsc server limitation [OPTIONS]

Options

-id, --server-id <server_id>: Required サーバーID

list

サーバー情報の取得

vpsc server list [OPTIONS]

Options

-id, --server-id <server_id>: サーバーID

power-on

サーバーを起動

vpsc server power-on [OPTIONS]

Options

-id, --server-id <server_id>: Required サーバーID

power-status

サーバーの電源状態を取得

vpsc server power-status [OPTIONS]

Options

-id, --server-id <server_id>: Required サーバーID

ptr-record

サーバーの逆引きホスト名を設定

vpsc server ptr-record [OPTIONS]

Options

-id, --server-id <server_id>: Required サーバーID

-t, --type <type_>

Required 設定タイプ

Options:: ipv4 | ipv6

-h, --hostname <hostname>: Required ホスト名

shutdown

サーバーをシャットダウン

vpsc server shutdown [OPTIONS]

Options

-id, --server-id <server_id>: Required サーバーID

-f, --force: 強制的にシャットダウン

update

サーバー情報更新

vpsc server update [OPTIONS]

Options

-id, --server-id <server_id>: Required サーバーID

-n, --name <name>: 名前

-d, --description <description>: 説明

データモデル

リクエストモジュール

リクエストモジュール

APIへのリクエストを直接的に行なっているモジュールです。ページングなどの処理もこちらで対応。

class vpsc.api_request.APIRequest(config: APIConfig, header: MappingProxyType)[ソース]

ベースクラス: Iterator, Sized

count = 0

generator = None

request(endpoint: str, method: Literal['get', 'post', 'put', 'delete'], data: BaseModel | None = None, response_obj: Type[BaseModel] | None = None)[ソース]

unsafe_methods = ['post', 'put', 'delete']

クライアントモジュール

pydantic settings vpsc.client.APIConfig[ソース]

ベースクラス: BaseSettings

Config:

env_prefix: str = vps_
env_file: str = ~/.vpsc
env_file_encoding: str = utf-8

Fields:

api_key (str)
host (str)

field api_key: str [Required]

field host: str = 'https://secure.sakura.ad.jp/vps/api/v7'

class vpsc.client.Client(config: APIConfig)[ソース]

ベースクラス: object

create_api_key(data: CreateApiKey) → ApiKey[ソース]

APIキーを作成する

パラメータ:: data
戻り値:

create_role(data: CreateRole) → Role[ソース]

ロールを作成する

戻り値:

create_switch(data: CreateSwitch) → Switch[ソース]

スイッチを作成する

パラメータ:: data -- 作成データ
戻り値:

delete_api_key(key_id: int) → ApiKey[ソース]

APIキーを削除する

パラメータ:: key_id
戻り値:

delete_role(role_id: int) → Role[ソース]

ロールを削除する

パラメータ:: role_id
戻り値:

delete_switch(switch_id: int)[ソース]

スイッチを削除する

パラメータ:: switch_id -- スイッチID
戻り値:

force_force_reboot_server(server_id: int)[ソース]

サーバーを強制再起動する

パラメータ:: server_id -- サーバーID
戻り値:

get_api_key(key_id: int) → ApiKey[ソース]

APIキーを取得する

パラメータ:: key_id
戻り値:

get_api_keys() → Iterable[ApiKey][ソース]

APIキーの一覧を取得する

戻り値:

get_nfs_server(nfs_server_id: int) → NfsServer[ソース]

NFSサーバー情報を取得する

パラメータ:: nfs_server_id -- NFSサーバーID
戻り値:

get_nfs_server_power_status(nfs_server_id: int) → NfsServerPowerStatus[ソース]

NFSサーバーの電源状態を取得する

パラメータ:: nfs_server_id
戻り値:

get_nfs_servers() → Iterable[NfsServer][ソース]

NFSサーバー情報一覧を取得する

戻り値:

get_permissions() → Iterable[Permission][ソース]

権限の一覧を取得する

戻り値:

get_role(role_id: int) → Role[ソース]

ロールを取得する

パラメータ:: role_id
戻り値:

get_server(server_id: int) → Server[ソース]

サーバー情報を取得する

パラメータ:: server_id -- サーバーID
戻り値:

get_server_limitation(server_id: int) → Limitation[ソース]

サーバーの制限情報を取得する

パラメータ:: server_id -- サーバーID
戻り値:

get_server_power_status(server_id: int) → ServerPowerStatus[ソース]

サーバーの電源状態を取得する

:param server_id:　サーバーID :return:

get_servers(sort: Literal['service_code', '-service_code', 'name', '-name', 'storage_size_gibibytes', '-storage_size_gibibytes', 'memory_mebibytes', '-memory_mebibytes', 'cpu_cores', '-cpu_cores', 'hostname', '-hostname', 'ipv6_hostname', '-ipv6_hostname', 'ipv4_address', '-ipv4_address', 'ipv6_address', '-ipv6_address', 'zone_code', '-zone_code', 'ipv4_ptr', '-ipv4_ptr', 'ipv6_ptr', '-ipv6_ptr'] | None = None) → Iterable[Server][ソース]

サーバー一覧を取得する

パラメータ:: sort -- ソート情報
戻り値:

get_switch(switch_id: int) → Switch[ソース]

スイッチ情報を取得する

パラメータ:: switch_id -- スイッチID
戻り値:

get_switches() → Iterable[Switch][ソース]

スイッチ情報一覧を取得する

戻り値:

power_on_server(server_id: int)[ソース]

サーバーを起動する

パラメータ:: server_id -- サーバーID
戻り値:

rotate_api_key(key_id: int) → ApiKey[ソース]

APIキーのトークンのローテーションを行う

パラメータ:: key_id
戻り値:

shutdown_server(server_id: int, force: bool = False)[ソース]

サーバーをシャットダウンする

パラメータ:

force -- 強制停止を行うか
server_id -- サーバーID

戻り値:

update_api_key(key_id: int, data: UpdateApiKey) → ApiKey[ソース]

APIキーを更新する

パラメータ:: key_id
戻り値:

update_nfs_server(nfs_server_id: int, data: UpdateNfsServer)[ソース]: NFSサーバー情報を更新する :param nfs_server_id: NFSサーバーID :param data: 更新データ :return:

update_nfs_server_ipv4(nfs_server_id: int, data: UpdateNfsServerIpv4)[ソース]

NFSサーバーのipv4を設定する

パラメータ:

nfs_server_id -- NFSサーバーID
data -- 設定情報

戻り値:

update_role(role_id: int, data: UpdateRole) → Role[ソース]

ロールを更新する

パラメータ:

role_id
data

戻り値:

update_server(server_id: int, data: UpdateServer) → Server[ソース]

サーバー情報を更新する

パラメータ:

server_id -- サーバーID
data -- 更新データ

戻り値:

update_server_ipv4_ptr(server_id: int, data: UpdateHost)[ソース]

サーバーのipv4の逆引きホスト名を設定する

パラメータ:

server_id -- サーバーID
data -- 設定データ

戻り値:

update_server_ipv6_ptr(server_id: int, data: UpdateHost)[ソース]

サーバーのipv6の逆引きホスト名を設定する

パラメータ:

server_id -- サーバーID
data -- 設定データ

戻り値:

update_switch(switch_id: int, data: UpdateSwitch) → Switch[ソース]

スイッチ情報を更新する

パラメータ:

switch_id -- スイッチID
data -- 更新データ

戻り値: