computing / Client / nifty_modify_vpn_gateway_attribute

nifty_modify_vpn_gateway_attribute

computing.Client.nifty_modify_vpn_gateway_attribute(**kwargs)

指定された拠点間VPNゲートウェイの詳細情報を更新します。1回のリクエストで、1つの拠点間VPNゲートウェイの情報を更新できます。

拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイIDまたは拠点間VPNゲートウェイ名が必要です。

拠点間VPNゲートウェイ名、拠点間VPNゲートウェイタイプの更新時、拠点間VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_modify_vpn_gateway_attribute(
    Agreement=True|False,
    Attribute='niftyVpnGatewayName'|'niftyVpnGatewayType'|'niftyVpnGatewayDescription'|'niftyVpnGatewayAccountingType'|'groupId',
    NiftyVpnGatewayName='string',
    Value='string',
    VpnGatewayId='string'
)
Parameters:
  • Agreement (boolean) –

  • Attribute (string) – [REQUIRED]

  • NiftyVpnGatewayName (string) –

  • Value (string) – [REQUIRED]

  • VpnGatewayId (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –

    • RequestId (string) –

    • Return (boolean) –