nifty-describe-web-proxies
処理概要
API「NiftyDescribeWebProxies」が実行されます。
ルーターに設定されているWebプロキシの設定情報を取得します。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。
絞り込み条件の項目の値を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「*」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字（「\*nifty\?\\ 」は「*nifty?\」を検索）となります。
曖昧検索が指定可能な絞り込み条件の項目名は、router-name、listen-network-name、listen-port、proxy-bypass-network-name、option-name-serverになります。
コマンド構文
nifty-describe-web-proxies [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --router-id ID1 [,ID2 ,...] | ルーターユニークIDを指定します。 | ||
| --router-name NAME1 [,NAME2 ,...] | ルーター名を指定します。 | ||
| --filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...] | 絞り込み条件を指定します。 "router-id=値1,値2,..." : ルーターユニークID "router-name=値1,値2,..." : ルーター名 "listen-network-id=値1,値2,..." : 受け側ネットワークID "listen-network-name=値1,値2,..." : 受け側ネットワーク名 "listen-port=値1,値2,..." : Webプロキシのポート "proxy-bypass-network-id=値1,値2,..." : 迂回先ネットワークID "proxy-bypass-network-name=値1,値2,..." : 迂回先ネットワーク名 "option-name-server=値1,値2,..." : DNSサーバーのアドレス(IPv4) |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- WEBPROXY / routerId
- WEBPROXY / routerName
- WEBPROXY / listenPort
- WEBPROXY / description
- LISTEN_INTERFACE / networkId
- LISTEN_INTERFACE / networkName
- BYPASS_INTERFACE / networkId
- BYPASS_INTERFACE / networkName
- OPTION / nameServer
実行サンプル
PROMPT>nifty-describe-web-proxies --router-id rt-8db04f81 --filter "listen-network-id=10.*"
WEBPROXY nrt-8db04f81 router1 140 memo
LISTEN_INTERFACE net-0xej1djx network001
BYPASS_INTERFACE net-0k87jhm network002
OPTION 11.11.11.11
