本文へジャンプします。

ニフクラ ユーザーガイド

DescribeDhcpOptions

処理概要

DHCPオプションの設定情報を取得します。
DHCPオプションを指定するためには、DHCPオプションが必要です。
DHCPオプションを指定しない場合は、取得可能なすべてのDHCPオプション情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字(「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索)となります。
曖昧検索が指定可能な絞り込み条件の項目名は、key、valueになります。

指定するパラメーター

パラメーター 説明 必須
DhcpOptionsId.n string DHCPオプションID
Filter.n.Name string 絞り込み条件の項目名
値:
  • dhcp-options-id (DHCPオプションID)
  • key (DHCPオプション名)
  • value (DHCPオプションの値)
Filter.n.Value.m string 絞り込み条件の値
値:
Filter.n.Name=key の場合
  • default-router (デフォルトゲートウェイのIPアドレス)
  • domain-name (クライアントがホストの名前解決で使用するドメイン名)
  • domain-name-servers (DNSサーバーのIPアドレス)
  • ntp-servers (NTPサーバーのIPアドレス)
  • netbios-name-servers (NetBIOSサーバーのIPアドレス)
  • netbios-node-type (NetBIOSのノードタイプ)
  • lease-time (IPアドレスのリースタイム)

応答フィールド

フィールド (項目) 説明
DescribeDhcpOptionsResponse - DescribeDhcpOptionsレスポンス
Ancestor: なし
Children: requestId | dhcpOptionsSet
requestId string リクエスト識別子
Ancestor: DescribeDhcpOptionsResponse
Children: なし
dhcpOptionsSet - DHCPオプションリスト情報セット
Ancestor: DescribeDhcpOptionsResponse
Children: item
item - DHCPオプションリスト情報
Ancestor: dhcpOptionsSet
Children: dhcpOptionsId | dhcpConfigurationSet
dhcpOptionsId string DHCPオプションID
Ancestor: item
Children: なし
dhcpConfigurationSet - DHCPオプション設定情報セット
Ancestor: item
Children: item
item - DHCPオプション設定情報
Ancestor: dhcpConfigurationSet
Children: key | valueSet
key string DHCPオプション名
値:
  • default-router(デフォルトゲートウェイのIPアドレス)
  • domain-name(クライアントがホストの名前解決で使用するドメイン名)
  • domain-name-servers(DNSサーバーのIPアドレス)
  • ntp-servers(NTPサーバーのIPアドレス)
  • netbios-name-servers(NetBIOSサーバーのIPアドレス)
  • netbios-node-type(NetBIOSのノードタイプ)
  • lease-time(IPアドレスのリースタイム)
Ancestor: item
Children: なし
valueSet - DHCPオプションの値情報セット
Ancestor: item
Children: item
item - DHCPオプションの値情報
Ancestor: valueSet
Children: value
value string DHCPオプションの値
Ancestor: item
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeDhcpOptions
  &DhcpOptionsId=dopt-7a8b9c2d
  &CommonParams

  

応答サンプル

    <DescribeDhcpOptionsResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <dhcpOptionsSet>
    <item>
      <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>
      <dhcpConfigurationSet>
        <item>
          <key>domain-name-servers</key>
          <valueSet>
            <item>
              <value>10.2.5.1</value>
            </item>
            <item>
              <value>10.2.5.2</value>
            </item>
          </valueSet>
        </item>
      </dhcpConfigurationSet>
    </item>
  </dhcpOptionsSet>
</DescribeDhcpOptionsResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年6月15日時点の情報です。

推奨画面サイズ 1024×768 以上