本文へジャンプします。

ニフクラ APIリファレンス

nifty-describe-dhcp-configs

処理概要

API「NiftyDescribeDhcpConfigs」が実行されます。
DHCPコンフィグ情報を取得します。
DHCPコンフィグを指定するためには、DHCPコンフィグIDが必要です。管理外のDHCPコンフィグを指定したなど、無効なDHCPコンフィグを指定した場合は、エラーが返されます。
DHCPコンフィグを指定しない場合は、取得可能なすべてのDHCPコンフィグ情報を取得します。

絞り込み条件の項目の値を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「*」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字(「\*nifty\?\\ 」は「*nifty?\」を検索)となります。
曖昧検索が指定可能な絞り込み条件の項目名は、ipaddress-pool-start, ipaddress-pool-stop, ipaddress-pool-description, static-mapping-ipaddress, static-mapping-macaddress, static-mapping-descriptionになります。

コマンド構文

nifty-describe-dhcp-configs [オプション]

オプション

オプション 短縮 説明 必須
--dhcp-config-id ID1 [,ID2 ,...]   DHCPコンフィグIDを指定します。  
--filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...]   絞り込み条件を指定します。
"dhcp-config-id=値1,値2,..." : DHCPコンフィグID
"ipaddress-pool-start=値1,値2,..." : ipAddressPoolの開始IPアドレス
"ipaddress-pool-stop=値1,値2,..." : ipAddressPoolの終了IPアドレス
"ipaddress-pool-description=値1,値2,..." : ipAddressPoolのメモ
"static-mapping-ipaddress=値1,値2,..." : staticMappingのIPアドレス
"static-mapping-macaddress=値1,値2,..." : staticMappingのMACアドレス
"static-mapping-description=値1,値2,..." : staticMappingのメモ
 

出力要素

※ニフクラAPIの応答フィールド名を記述します。

  • DHCP_CONFIGS / dhcpConfigId
  • IPADDRESS_POOLS / startIpAddress
  • IPADDRESS_POOLS / stopIpAddress
  • IPADDRESS_POOLS / description
  • STATIC_MAPPINGS / ipAddress
  • STATIC_MAPPINGS / macAddress
  • STATIC_MAPPINGS / description

実行サンプル

PROMPT>nifty-describe-dhcp-configs --dhcp-config-id dconf-0000000z,dconf-0gj0080x
DHCP_CONFIGS dconf-0000000z
IPADDRESS_POOLS 192.168.0.1 192.168.0.10 MEMO
STATIC_MAPPINGS 192.168.0.1 7f:43:27:fa:0a:88 MEMO
DHCP_CONFIGS dconf-0gj0080x
IPADDRESS_POOLS 127.0.0.1 127.0.0.10 MEMO
STATIC_MAPPINGS 127.0.0.1 1a:72:cd:3s:4f:96 MEMO

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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