Create console access#

作成したベアメタルサーバに対するコンソール(iRMC)接続を開設します。

APIエンドポイント#

リージョン	APIエンドポイント
西日本リージョン3の場合	https://baremetal.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://baremetal.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/v1/server-consoles/{server_id}

HTTPステータスコード#

正常時：202

エラー時：400, 401, 403, 404, 500, 503, 504

リクエストパラメータの説明#

名前	In	Type	デフォルト値 /必須指定	Description
server_id	path	string	必須	ベアメタルサーバのID
console_access_point	body	object	必須	コンソールアクセスポイントのオブジェクト
vpn_username	body	string	必須	クライアントのVPNのユーザ名 8～64文字で、半角英数字と以下の記号が指定できます。 `!#%&()+=@{}~-` 📒注: 2022/5/19以降に新規でコンソール接続を生成する場合ユーザー名の末尾には、接続するベアメタルサーバの物理ポート（任意）の、MACアドレス下位6桁（英数字）を付与してください。例：ユーザー名：username-b11220 MACアドレス：3c:fd:fe:b1:12:20 既にコンソール接続を利用している場合は、現行のユーザーを継続して利用できます。ただし、再作成する際は上記の命名規則に従ってユーザーを作成してください。
vpn_user_password	body	string	必須	クライアントのVPNのパスワード 16～32文字で、半角英数字と以下の記号が指定できます。 `!#$%&()*+.=@[]_{}~` 英字を1文字以上、数字を1文字以上含む必要があります。
user_access_source_ip	body	string	必須	クライアントのIPアドレス 📒注: 10.172.31.254.0/24はシステム上で予約されているアドレス帯のため、user_access_source_ipでは利用できません。

レスポンスボディ（正常系）の説明#

名前	Type	Description
console_access_point	object	コンソールアクセスポイントのオブジェクト
vpn_access_ip	string	SSL-VPN接続先のグローバルIP
tenant_id	string	ユーザのプロジェクトID
console_ip_address	string	コンソール(iRMC)IPアドレス
user_access_source_ip	string	利用者がSSL-VPNで接続可能なソースIPアドレス
id	string	コンソールアクセスポイントのID
vpn_groupname	string	SSL-VPNアクセス時のログイングループ
vpn_username	string	SSL-VPNアクセス時のログインユーザ名
server_id	string	コンソールアクセスが所属するベアメタルサーバのID
status	string	コンソールアクセス状態「ACTIVE」、「BUILD」、「DELETING」、「CREATE_ERROR」、「DELETE_ERROR」または「null」のどれかが表示されます。

リクエスト例#

{
    "console_access_point": {
            "vpn_username": "irmc-user01",
            "vpn_user_password": "password1234!",
            "user_access_source_ip": "192.168.10.159"
    }
}

レスポンス例#

{
    "console_access_point": {
         "vpn_access_ip" : null,
         "tenant_id" : "ddb8377cd26d4331b2c76c4e9af7305e",
         "console_ip_address": null,
         "user_access_source_ip" : "192.168.10.159",
         "id": "74fa907d-aabf-6ac1-24cf-5d5ff47b38ba",
         "vpn_groupname": null,
         "vpn_username" : "irmc-user01",
         "server_id" : "a4a3604a-1b8a-4dc9-be25-f18d4a34892a",
         "status" : "BUILD"
     }
}