プロトコル拡張 - コマンドリファレンス

最終公開日 : Sep 25, 2026
次の表は、カスタムプロトコルに対して追加された新しいコマンドと、カスタムプロトコル用に変更された既存のコマンドの一覧です。
show lb persistentSessions [<vserv-name>]
  • CLI コマンド：
    add user protocol <name> -transport ( TCP | SSL ) -extension <string> -comment <string>]>
  • 説明：
    拡張機能を使用して、Citrix ADCアプライアンスに新しいユーザープロトコルを追加します。現在、トランスポート値 TCP または SSL を持つユーザプロトコルのみがサポートされています。
    例：
    add user protocol MQTT -transport TCP -extension mqtt_code
  • CLI コマンド：
    rm user protocol <name>
  • 説明：
    Citrix ADCアプライアンスに追加したユーザープロトコルを削除します。
    例：
    rm user protocol mqtt
  • CLI コマンド：
    set user protocol <name> -comment <string>
  • 説明：
    Citrix ADCアプライアンスに追加したユーザープロトコルの設定を変更します。
    例：
    set user protocol mqtt -comment "MQTT protocol implementation”
  • CLI コマンド：
    unset user protocol <name> -comment
  • 説明：
    Citrix ADCアプライアンスに追加したユーザープロトコルの設定を削除します。
    例：
    unset user protocol mqtt -comment "MQTT protocol implementation”
  • CLI コマンド：
    update ns extension <extension name>
  • 説明：
    拡張機能を使用して、以前に追加されたユーザープロトコルの実装を更新します。
    プロトコルの実装を更新できるのは、そのプロトコルがユーザーの仮想サーバーによって使用されていない場合だけです。
    例：
    update ns extension my-extension
  • CLI コマンド：
    add lb vserver <name> [USER_TCP | USER_SSL_TCP] [-lbmethod USER_TOKEN] [-persistencetype USERSESSION] [-timeout <value>]
  • 説明：
    負荷分散仮想サーバーをCitrix ADCアプライアンスに追加します。これは既存の CLI コマンドです。
    負荷分散ユーザー仮想サーバーの場合、使用するサービスタイプは USER_TCP または USER_SSL_TCP です。IP アドレスとポートは、ユーザーロードバランシング仮想サーバーでは許可されません。
    ユーザー負荷分散仮想サーバーでは、ROUNDROBIN 負荷分散方式のみが許可され、トークン値は拡張コードによって提供されます。同様に、USERSESSION 永続性のみが許可され、永続性設定は拡張コードによって提供されます。
    例：
    add lb vserver mysv USER_TCP –lbmethod ROUNDROBIN
  • CLI コマンド：
    add user vserver <name> <userProtocol> <IPAddress> <port> -defaultLB <string> [-params <string>] [-comment <string>]
  • 説明：
    拡張機能を使用して、ユーザープロトコルの仮想サーバーを追加します。設定されたデフォルトのユーザロードバランシング仮想サーバは、ctxt.output として TCP クライアントデータ拡張ハンドラで使用できます。仮想サーバーの場合、拡張パラメータは、名前と値のペアを指定して-params オプションを使用して設定できます。対応するパラメータ値は、拡張ハンドラで ctxt.vserver.params.\&lt;paramName>として利用できます。
    例：
    add user vs v_mqtt MQTT 10.217.24.28 80 -defaultlb mysv
  • CLI コマンド：
    rm user vserver <name>
  • 説明：
    Citrix ADCアプライアンスに追加済みのユーザー仮想サーバーを削除します。
    例：
    rm user vserver v_mqtt
  • CLI コマンド：
    set user vserver <name> [-IPAddress <ip_addr|ipv6_addr|*>] [-defaultLB <string>] [-params <string>] [-comment <string>]
  • 説明：
    Citrix ADCアプライアンスに追加したユーザー仮想サーバーの設定を変更します。拡張パラメータに-params オプションによって新しい値が割り当てられると、古い値は上書きされます。
    例：
    set user vs v_mqtt MQTT 10.217.24.28 -defaultlb mysv -comment "MQTT protocol implementation”
  • CLI コマンド：
    unset user vserver <name> [-params] [-comment]
  • 説明：
    Citrix ADCアプライアンスに追加したユーザー仮想サーバーの設定を削除します。—params オプションを使用して拡張パラメータの設定を解除すると、拡張ハンドラで使用できる対応するパラメータ値が nil に変更されます。
    例：
    unset user vs v_mqtt MQTT 10.217.24.28 -defaultlb mysv -comment "MQTT protocol implementation”
  • CLI コマンド：
    show user protocol [<name>]
  • 説明：
    拡張機能やコールバックなど、ユーザプロトコルに関する情報を表示します。
    例：
    show user protocol mqtt
  • CLI コマンド：
    show user vserver [<name>]
  • 説明：
    ユーザー仮想サーバーに関する情報を表示します。
    例：
    show user vserver vs_mqtt
  • CLI コマンド：
    stat user vserver [<name>]
  • 説明：
    ユーザー仮想サーバーに関する統計情報を表示します。
    例：
    stat user vserver vs_mqtt
  • CLI コマンド：
    show lb persistentSessions [<vserv-name>]
  • 説明：
    永続セッションに関する情報を表示します。これは既存の CLI です。ユーザープロトコルの場合、持続性タイプは USERSESSION と表示されます。
  • CLI コマンド：
    rm lb vserver <name>
  • 説明：
    Citrix ADC アプライアンスに追加したユーザー LB 仮想サーバーを削除します。
    例：
    rm lb vserver mysv
  • CLI コマンド：
    add service <name> <IPAddr> (USER_TCP | USER_SSL_TCP) <Port>
  • 説明：
    ユーザプロトコルに使用するバックエンドサービスを追加します。これは、新しいサービスタイプ USER_TCP および USER_SSL_TCP を持つ既存の CLI コマンドです。
    例：
    add service mqtt_svr1 10.217.24.48 USER_TCP 1501
    注意: 既存の「サービスの設定およびサービスの設定解除」コマンドを使用して、ユーザープロトコルに対して以前に追加したサービスの設定を削除または変更することができます。
  • CLI コマンド：
    bind lb vserver <name> <serviceName>
  • 説明：
    サービスをユーザー LB vserver にバインドします。サービスタイプは、タイプが USER_TCP/USER_SSL_TCP の LB 仮想サーバーにバインドする場合は、USER_TCP/USER_SSL_TCP である必要があります。
    例：
    bind lb vserver mysv mqtt_svr1
  • CLI コマンド：
    unbind lb vserver <name> <serviceName>
  • 説明：
    以前にバインドされたサービスをユーザー LB vserver にバインド解除します。
    例：
    unbind lb vserver mysv mqtt_svr1
  • CLI コマンド：
    rm service <name>
  • 説明：
    ユーザープロトコルに対して以前に追加されたサービスを削除します。
    例：
    rm service mqtt_svr1
Related information