Update IPsec Site Connection#
IPsecサイトコネクションを更新します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://nfv.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://nfv.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/vpn/nfv/ipsec-site-connections/{connection-id}
HTTPステータスコード#
正常時:202
エラー時:400,404
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
connection-id | path | string | 必須 | コネクションID |
ipsec_site_connection | body | object | 必須 | IPsecサイトコネクションのオブジェクト |
psk | body | string | 任意 | 事前共有キーの設定 |
admin_state_up | body | boolean | true 任意 |
IPsecサイトコネクションの状態 「false」でIPsecサイトコネクションは非活性です。 |
peer_cidrs | body | list | 任意 | 対向側の接続先ネットワークのCIDR <net_address>/<prefix> |
dpd | body | array | 任意 | DPD検出時の動作設定 DPD検出時に"hold"か"restart"を実施するか定義します。 検出間隔は10~3600秒の間で定義してください。 タイムアウト値は120秒固定です。 |
peer_address | body | string | 任意 | 対向IPsec装置が持つ公開IPアドレス(IPv4) |
peer_id | body | string | 任意 | 対向IPsec装置を認証するためのID IPv4/IPv6アドレス、メールアドレス、キーID、FQDNが利用可能です。 |
name | body | string | 任意 | IPsecサイトコネクションの名前 |
description | body | string | 任意 | IPsecサイトコネクションの説明 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
ipsec_site_connection | object | IPsecサイトコネクションのオブジェクト |
psk | string | 事前共有キーの設定 |
name | string | IPsecサイトコネクションの名前 |
admin_state_up | boolean | IPsecサイトコネクションの状態 「false」でIPsecサイトコネクションは非活性です。 |
description | string | IPsecサイトコネクションの説明 |
peer_cidrs | array | 対向側の接続先ネットワーク(CIDR形式) |
dpd | string | DPD検出時の動作 |
peer_address | string | 対向IPsec装置が持つ公開IP(IPv4) |
peer_id | string | 対向IPsec装置を認証するためのID |
id | string | IPsecサイトコネクションのID |
リクエスト例#
{ "ipsec_site_connection": { "admin_state_up": true, "description": "", "peer_cidrs": [ "200.200.1.0/24" ], "dpd": { "action": "restart", "interval": null, "timeout": 120 }, "name": "vpns-ipsec-sitec", "peer_address": "192.168.123.252", "peer_id": "aaa.company.com", "psk": "fujitsu123", } }
レスポンス例#
{ "ipsec_site_connection": { "admin_state_up": true, "description": "", "dpd": { "action": "restart", "interval": null, "timeout": 120 }, "id": "28098", "name": "vpns-ipsec-sitec", "peer_address": "192.168.123.252", "peer_cidrs": [ "200.200.1.0/24" ], "peer_id": "aaa.company.com", "psk": "fujitsu123" } }