Update IPsec site connection

URI

/v2.0/vpn/ipsec-site-connections/{connection-id}

HTTPメソッド

PUT

リクエストパラメタ

キー	説明	型	必須/省略可
psk	PSK(事前共有鍵): 任意の文字列	string	Optional
initiator	このVPNが接続に応答するだけか、開始も行うかを指定します。"bi-directional"または"response-only"を選択してください。 (デフォルト: bi-directional)	string	Optional
admin_state_up	VPN接続の管理状態 "false"(停止中)の場合、VPN接続はパケットを転送しません。	bool	Optional
peer_cidrs	ピアのプライベートCIDR <net_address>/<prefix>の書式で示される有効なCIDRの固有リスト。指定可能なCIDRは1つだけです。	list	Optional
dpd	DPD (Dead Peer Detection)プロトコルの制御アクションの値はhold またはrestartを指定します。間隔とタイムアウトの値は秒単位で指定します。 (デフォルト: {'action' : 'hold', 'interval' : 30, 'timeout' : 120)	dict	Optional
peer_address	ピアのゲートウェイ公開IPv4アドレス	string	Optional
peer_id	ピアのルーターの認証情報有効な値は、IPv4/IPv6アドレス、メールアドレス、キーID、またはFQDNです。	string	Optional
name	IPSecサイト間接続の名前	string	Optional
description	IPSecサイト間接続の説明	string	Optional

リクエスト例


{
  "ipsec_site_connection": {
    "description": "to datacenter2"
  }
}

レスポンスステータス

ステータスコード	説明
200	Normal response codes
Unauthorized (401)	Error response codes
Bad Request (400)	Error response codes
Not Found (404)	Error response codes

レスポンスボディ(正常系)


{
  "ipsec_site_connection": {
    "status": "DOWN",
    "psk": "secret",
    "initiator": "bi-directional",
    "name": "vpnconnection1",
    "admin_state_up": true,
    "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
    "description": " to datacenter2",
    "auth_mode": "psk",
    "peer_cidrs": [
      "10.2.0.0/24"
    ],
    "mtu": 1500,
    "ikepolicy_id": "771f081c-5ec8-4f9a-b041-015dfb7fbbe2",
    "dpd": {
      "action": "hold",
      "interval": 30,
      "timeout": 120
    },
    "route_mode": "static",
    "vpnservice_id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
    "peer_address": "172.24.4.233",
    "peer_id": "172.24.4.233",
    "id": "f7cf7305-f491-45f4-ad9c-8e7240fe3d72",
    "ipsecpolicy_id": "9958d4fe-3719-4e8c-84e7-9893895b76b4",
    "availability_zone": "AZ1"
  }
}

レスポンスボディ(正常系)の説明

要素名	説明
status	VPNコネクションの状態値は次のいずれかとなります:ACTIVE / DOWN / BUILD / ERROR / PENDING_CREATE / PENDING_UPDATE / PENDING_DELETE
psk	PSK(事前共有鍵): 任意の文字列
initiator	このVPNが接続に応答するだけか、開始も行うかを指定します。
name	IPSecサイト間接続の名前
admin_state_up	VPN接続の管理状態 "false"(停止中)の場合、VPN接続はパケットを転送しません。
tenant_id	プロジェクトID
description	IPSecサイト間接続の説明
auth_mode	認証モード: psk
peer_cidrs	ピアのプライベートCIDR
mtu	1度に伝送可能な最大データ量
ikepolicy_id	IKEポリシーID
dpd	DPD (Dead Peer Detection)プロトコルの制御アクションの値はhold またはrestartを指定します。間隔とタイムアウトの値は秒単位で指定します。
route_mode	ルートモード: static 今後拡張する予定です。
vpnservice_id	VPNサービスID
peer_address	ピアのゲートウェイ公開IPv4アドレス
peer_id	ピアのルーターの認証情報有効な値は、IPv4/IPv6アドレス、メールアドレス、キーID、またはFQDNです。
id	IPSecコネクションID
ipsecpolicy_id	IPSecポリシーID
availability_zone	アベイラビリティゾーン名

注意:

リソース更新後、接続相手先の設定が完了しているにも関わらず、statusがACTIVEにならない場合、「List IPsec site connections」の注意点に記載の事項に関して確認してください。