ニフクラAPI (コンピューティング: NiftyReplaceDhcpOption)

NiftyReplaceDhcpOption

処理概要

ルーターに登録されたDHCPオプションを解除し、指定したDHCPオプションに入れ替えます。

ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

パラメーター	型	説明	必須
RouterId	string	ルーターユニークID	○ (ルーター名といずれか)
RouterName	string	ルーター名	○ (ルーターユニークIDといずれか)
NetworkId	string	ネットワークユニークID	○ (ネットワーク名といずれか)
NetworkName	string	ネットワーク名	○ (ネットワークユニークIDといずれか)
DhcpOptionsId	string	変更するDHCPオプションID	○
Agreement	boolean	version up実施したのち、バックアップ状態を解除する事項への同意 値: true (同意する) false (同意しない) Default: false	○ (バックアップを保持する場合のみ)

応答フィールド

フィールド (項目)	型	説明
NiftyReplaceDhcpOptionResponse	-	NiftyReplaceDhcpOptionレスポンス
␣requestId	string	リクエスト識別子
␣return	boolean	処理ステータス 値: true (成功)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyReplaceDhcpOption
  &RouterId=rt-8db04f81
  &NetworkId=net-6dd04c54
  &DhcpOptionsId=dopt-7a8b9c2d
  &CommonParams

  

応答サンプル

    <NiftyReplaceDhcpOptionResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <return>true</return>
</NiftyReplaceDhcpOptionResponse>