本文へジャンプします。

ニフクラ APIリファレンス

nifty-modify-web-proxy-attribute

処理概要

API「NiftyModifyWebProxyAttribute」が実行されます。
ルーターに設定されたWebプロキシの詳細情報を更新します。1回のリクエストで、1つのWebプロキシの情報を更新できます。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
受け側/迂回先ネットワークは、ルーターと紐付きのあるネットワークを指定する必要があります。

受け側/迂回先ネットワーク、受け側ポート、DNSサーバーのアドレスの更新時、ルーターがバックアップを保持している場合は、オプション「--agreement」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

コマンド構文

nifty-modify-web-proxy-attribute [オプション]

オプション

オプション 短縮 説明 必須
--router-id ID -r ルーターユニークIDを指定します。
(ルーター名といずれか)
--router-name NAME -R ルーター名を指定します。
(ルーターユニークIDといずれか)
--listen-interface-network-id ID   Webプロキシの受け側ネットワークIDを更新します。  
--listen-interface-network-name NAME   Webプロキシの受け側ネットワーク名を更新します。  
--listen-port PORT   Webプロキシのポートを更新します。  
--bypass-interface-network-id ID   Webプロキシの迂回先ネットワークIDを更新します。  
--bypass-interface-network-name NAME   Webプロキシの迂回先ネットワーク名を更新します。  
--option-name-server NAMESERVER   DNSサーバーのアドレス(IPv4)を更新します。  
--description DESCRIPTION   メモを更新します。  
--agreement   version up実施したのち、バックアップ状態を解除する事項への同意を指定します。
(バックアップを保持する場合のみ)

出力要素

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

  • routerId or routerName
  • 属性名(指定したパラメーターによって異なります)
  • value

実行サンプル

PROMPT>nifty-modify-web-proxy-attribute --router-id rt-8db04f81 -listen-port 14022
rt-8db04f81 listenPort 14022

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

APIメニュー

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

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