set-route-prop

構文

tadm set-route-prop common_options --config=config-name --vs=vs_name --route=route_name (property_name=property_value)+

説明

このコマンドを使用して、仮想サーバーのルート・プロパティを設定します。

オプション

common_optionsの詳細は、helpコマンドを実行してください。

--config|-c: ルート・プロパティを設定する構成の名前を指定します。

--vs|-s: 仮想サーバーの名前を指定します。

--route|-r: ルート・プロパティの名前を指定します。

オペランド

property-name=property-value

定義する1つ以上のプロパティに対してname=valueペアを指定します。name=valueペアは、スペースで区切る必要があります。

次のルート・プロパティを設定できます。

server: サーバー名を指定します。
値: テキスト文字列であることが必要です。

sticky-cookie: 後続のリクエストを特定のオリジン・サーバーに固定するCookieの名前を指定します。
値: テキスト文字列であることが必要です。

sticky-uri-param: ルート情報を検査するURIパラメータの名前を指定します。URIパラメータがリクエストURIに存在し、その値にコロン(:)が含まれ、その後にルートIDが続く場合、そのルートIDによって識別されるオリジン・サーバーにリクエストが固定されます。
値: テキスト文字列であることが必要です。

route-header: ルートIDをオリジン・サーバーに伝達するために使用されるHTTPリクエスト・ヘッダーの名前を指定します。
値: テキスト文字列であることが必要です。

route-cookie: サーバーがレスポンス内にsticky-cookie Cookieを検出した場合に、そのサーバーによって生成されるCookieの名前を指定します。route-cookieパラメータは、サーバーが後続のリクエストを同じオリジン・サーバーに戻すことができるルートIDを格納します。
値: テキスト文字列であることが必要です。

rewrite-headers: カンマで区切られたHTTPリクエスト・ヘッダーのリストを指定します。
値: テキスト文字列であることが必要です。

注意:

プロパティrewrite-headersでは、複数の値を指定できます。それぞれの値を引用符で囲い、カンマで区切ります。

validate-server-cert: オリジン・サーバーから提供された証明書をサーバーで検証するかどうかを指定します。
値: true、false。デフォルト: true。

use-keep-alive: すべてのタイプのリクエストに対してHTTPクライアントで既存の永続接続を使用するかどうかを指定します。
値: true、false。デフォルト: true。

keep-alive-timeout: 永続接続を維持する最大数(秒単位)を指定します。
値: 整数。デフォルト: 29

timeout: 接続のアイドル状態を許可する最大数(秒単位)を指定します。
値: 整数。デフォルト: 300

always-use-keep-alive: すべてのタイプのリクエストに対してHTTPクライアントで既存の接続を再利用するかどうかを指定します。
値: true、false。デフォルト: false。

protocol: HTTPプロトコルのバージョン文字列を指定します。
値: テキスト文字列であることが必要です。

proxy-agent: オリジン・サーバーにプロキシ・サーバーの製品名およびバージョンを転送する必要があるかどうかを指定します。
値: true、false。デフォルト: true。

origin-server-pool: このルートについてタイプがHTTPのオリジン・サーバーのプールを指定します。
値: HTTP。

websocket-upgrade-enabled: 標準HTTP (S)接続を双方向の全二重Webソケット接続にアップグレードするかどうかを指定します。
値: true、false。デフォルト: true。

websocket-idle-timeout: 接続のアイドル状態が可能な最大秒数。
値: 整数(値を指定しない場合、TCP接続スレッド・プールからのタイムアウト(300秒)が使用されます)。

from: マップするURI接頭辞を指定します。接頭辞の末尾にはスラッシュを含めないでください。

to: リクエストのマップ先となるURL接頭辞を指定します。接頭辞の末尾にはスラッシュを含めないでください。

buffer-size: 個々のアクセス・ログ・バッファのサイズ(バイト単位)。
値: 0 - 2147483647。

プロパティをデフォルト値にリセットするには、プロパティ値を指定しないでください。
例: property-name=<empty_string>

例

tadm set-route-prop --user=admin --host=admin.example.com 
--password-file=./admin.passwd --port=8989 
--no-prompt --config=www.example.org 
--vs=soa.example.org --route=route-1 keep-alive-timeout=29 from=/ to=/docs

終了コード

次の終了値が戻されます。

0: コマンドの実行に成功しました。

>0: コマンドの実行時にエラーが発生しました。

終了コードと構文表記の詳細は、helpコマンドを実行してください。