本文へジャンプします。

ニフクラ APIリファレンス

nifty-describe-nat-tables

処理概要

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

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「*」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字(「\*nifty\?\\ 」は「*nifty?\」を検索)となります。
曖昧検索が指定可能な絞り込み条件の項目名は、nat-rule.description、nat-rule.source.address、nat-rule.translation.address、nat-rule.outbound-interface.network-name、nat-rule.inbound-interface.network-nameになります。

コマンド構文

nifty-describe-nat-tables [オプション]

オプション

オプション 短縮 説明 必須
--nat-table-id ID1 [,ID2,…]   NATテーブルIDを指定します。  
--filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...]   絞り込み条件を指定します。
“association.association-id =値1,値2,…” : NATテーブル適用IDによる絞り込み
“association.nat-table-id =値1,値2,…” : NATテーブル適用情報のNATテーブルIDによる絞り込み
“association.router-id =値1,値2,…” : NATテーブル適用情報のルーターユニークIDによる絞り込み
“nat-table-id =値1,値2,…” : NATテーブルIDによる絞り込み
“nat-rule.nat-type =値1,値2,…” : NATタイプによる絞り込み
“nat-rule.rule-number =値1,値2,…” : ルール番号による絞り込み
“nat-rule.description =値1,値2,…” : NATルールのメモによる絞り込み
“nat-rule.protocol =値1,値2,…” : プロトコルによる絞り込み
“nat-rule.outbound-interface.network-id =値1,値2,…” : NATトラフィックのアウトバウンドインターフェイスのネットワークIDによる絞り込み
“nat-rule.outbound-interface.network-name =値1,値2,…” : NATトラフィックのアウトバウンドインターフェイスのネットワーク名による絞り込み
“nat-rule.inbound-interface.network-id =値1,値2,…” : NATトラフィックのインバウンドインターフェイスのネットワークIDによる絞り込み
“nat-rule.inbound-interface.network-name =値1,値2,…” : NATトラフィックのインバウンドインターフェイスのネットワーク名による絞り込み
“nat-rule.destination.port =値1,値2,…” : 送信先ポートによる絞り込み
“nat-rule.source.address =値1,値2,…” : 送信元アドレスによる絞り込み
“nat-rule.source.port =値1,値2,…” : 送信元ポートによる絞り込み
“nat-rule.translation.address =値1,値2,…” : 変換アドレスによる絞り込み
“nat-rule.translation.port =値1,値2,…” : 変換ポートによる絞り込み
 

出力要素

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

  • NATTABLE / natTableId
  • NATRULE / natType
  • NATRULE / ruleNumber
  • NATRULE / description
  • NATRULE / protocol
  • OUTBOUND_INTERFACE / networkId
  • OUTBOUND_INTERFACE / networkName
  • INBOUND_INTERFACE / networkId
  • INBOUND_INTERFACE / networkName
  • DESTINATION / port
  • SOURCE / address
  • SOURCE / port
  • TRANSLATION / address
  • TRANSLATION / port
  • ASSOCIATION / associationId
  • ASSOCIATION / natTableId
  • ASSOCIATION / routerId
  • ASSOCIATION / routerName

実行サンプル

PROMPT>nifty-describe-nat-tables --nat-table-id nat-8db04f81 --filter "nat-rule.protocol=tcp"
NATTABLE nat-8db04f81
NATRULE snat 1 memo tcp
OUTBOUND_INTERFACE net-8db04f81 network001
SOURCE 172.16.10.12 8080
TRANSLATION 8080
ASSOCIATION natassoc-12ad487b nat-8db04f81 rt-13ad487a router1

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

APIメニュー

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

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