NetScaler コンソールサービス

NetScalerテレメトリプログラムのデータガバナンス

既存のNetScaler Consoleのお客様は、必要なテレメトリデータをアップロードして、NetScalerテレメトリプログラムに準拠している必要があります。NetScalerテレメトリプログラムは14.1-28.xビルドから有効になり 、テレメトリデータは自動的にアップロードされます。詳しくは、 NetScalerテレメトリプログラムを参照してください。Citrix は、ライセンスコンプライアンスを含む正当な利益のために、基本的なライセンスのテレメトリデータと、NetScalerの展開と機能の使用状況のテレメトリデータを収集します。NetScaler Consoleの構成と機能の使用状況データも収集され、Citrix 製品とサービスの管理、測定、改善が行われます。

注:

  • テレメトリのアップロードは 24 時間ごとに自動的に行われます。

  • NetScalerインスタンスでテレメトリメトリックを収集して保存するために、2024年6月18日にリリースされたNetScalerテレメトリプログラムの一環として、次の構成がNetScaler コンソールを介してNetScalerインスタンスにプッシュされました。

enable ns feature AppFlow
add analytics profile telemetry_metrics_profile -type timeseries -outputMode prometheus -metrics ENABLED -serveMode Pull -schemaFile "./telemetry_collect_ns_metrics_schema.json" -metricsExportFrequency 300
<!--NeedCopy-->
  • /nsconfig/.telemetry.confファイルは、Gateway テレメトリの次のコマンドで更新されます。NetScaler Consoleは、このコマンドを1時間ごとにチェックし、このコマンドが見つからない場合は追加します。このコマンドは、VPN仮想サーバー構成のNetScalerインスタンスにのみプッシュされます:
ns_telemetry_server,<Console IP>,5140
<!--NeedCopy-->
  • 一部のテレメトリパラメーターは、NetScaler コンソールからNetScalerインスタンスにプッシュされるスクリプトを通じて収集されます。これらのスクリプトは読み取り専用で、NetScalerでは何も変更されません。

次の表は、NetScalerテレメトリプログラムの一部として収集される必須パラメーターの詳細を示しています:

カテゴリ 説明 使用目的
ライセンス、NetScalerの導入および使用状況に関するテレメトリ ライセンス資格、使用状況、高レベルのNetScaler展開データ、およびNetScaler機能の使用状況に関する情報。 ライセンスコンプライアンス、およびサービスの管理、測定、および改善。
NetScaler コンソールの展開と機能の使用状況に関するテレメトリ コンソールのデプロイと機能の使用に関する情報。 サービスを管理、測定、改善するため。

必要なテレメトリデータ

次の表は、NetScalerテレメトリプログラムの一部として収集された必須データの一覧を示しています:

ライセンス

パラメーター 説明
flex_vpx_inst_entitled 資格のあるVPXインスタンスの総数
flex_vpx_inst_allocated 割り当てられたVPXインスタンスの総数
flex_sdx_inst_entitled 資格が付与された SDX インスタンスの総数
splex_inst_allocated 割り当てられた SDX インスタンスの総数
flex_mpx_inst_entitled 資格が付与された MPX インスタンスの総数
flex_mpx_inst_allocated 割り当てられた MPX インスタンスの総数
flex_plt_bw_entitled 対象となるプラチナ帯域幅
flex_plt_bw_allocated 割り当てられたプラチナ帯域幅
flex_ent_bw_entited 対象となるエンタープライズ帯域幅
bw_flex_ent_allocated 割り当てられた企業帯域幅
flex_std_bw_entitled 対象となる標準帯域幅
flex_std_bw_allocated 割り当てられた標準帯域幅
flex_vpx_fips_inst_entitled 資格が付与された FIPS インスタンスの総数
flex_vpx_fips_inst_allocated 割り当てられた FIPS インスタンスの総数
license_name ライセンスタイプまたは機能名
peak_license_usage NetScalerインスタンスに適用されるライセンスのピーク使用量(割り当て)
peak_bandwidth_usage NetScalerインスタンスからのピーク使用量
avg_license_usage NetScalerインスタンスに適用されるライセンスの平均使用量(割り当て)
avg_bandwidth_usage NetScalerインスタンスからの平均使用量
license_edition プラチナ/エンタープライズ/標準帯域幅
[フィーチャ名] ライセンス機能名
ホスト ID デバイスホスト ID
ライセンスシリアル番号 ライセンスのシリアル番号
ライセンス開始日 ライセンスの開始日
ライセンス終了日 ライセンスの終了日
ライセンス SA 日付 ライセンスサブスクリプション特典日
tenantnslictype CPL、CULなどのライセンスタイプ
instance_id インスタンスの一意の識別子
instance_mode インスタンスがスタンドアロンか HA ペアかを確認します
instance_state インスタンスのステータス (Up/Down)
is_local_license ライセンスがNetScaler コンソールでホストされているかどうかを確認します
is_pooled_license ライセンスがプールライセンスかどうかをチェックします
license_edition ライセンスの種類 (プラチナ/スタンダード/エンタープライズ)
ライセンス終了日 ライセンスの有効期限が切れるまでの合計日数
platform デバイスタイプ
plt_license_allocation プラチナライセンスの割り当て
std_license_allocation 標準ライセンス割り当て
ent_license_allocation エンタープライズライセンスの割り当て
nslicensingtype ライセンスの種類 (フレックスまたは固定)
instance_ip_address NetScaler 管理 IP アドレス。注:IP アドレスはハッシュされます*。
total_pooled_devices ライセンスをプールしたNetScalerインスタンス(管理対象と管理対象外の両方)の合計
is_pooled_license_server NetScaler Consoleサービスをプールライセンスサーバーとして使用するかどうかを示します。
perc_discovered_vservers 検出された/使用資格のある仮想サーバの割合
perc_used_vservers 使用済み/使用資格のある仮想サーバーの割合
pool_cpxvcpu_entitled 使用資格のあるプールCPX vCPUの合計数
pool_cpxvcpu_used 使用されたプールCPX vCPUの合計数
pool_entbw_entitled [MBps] という表題のプールのエンタープライズ帯域幅の合計
pool_entbw_used プールのエンタープライズ帯域幅の合計使用量 [MBps]
pool_entvcpu_entitled 対象となるエンタープライズ vCPU の合計プール
pool_entvcpu_used 使用済みプールエンタープライズ vCPU の合計使用量
pool_fips_instances_entitled 資格が付与されたプールFIPSインスタンスの総数
pool_fips_instances_used 使用済みプール FIPS インスタンスの総数
pool_instances_entitled 資格が付与されたプールインスタンスの総数
pool_instances_used 使用済みプールインスタンスの総数
pool_perc_bw_used 使用済み帯域幅の割合
pool_perc_instances_used 使用済みインスタンスの割合
pool_perc_vcpu_used 使用済みの vCPU の割合
pool_pltbw_entitled [MBps] という表題のプールプラチナ帯域幅の合計
pool_pltbw_used プールプラチナ帯域幅の合計使用量 [MBps]
pool_pltvcpu_entitled 対象となるプラチナ vCPU プールの総数
pool_pltvcpu_used 使用されたプラチナ vCPU プールの総数
pool_stdbw_entitled プールに付与された標準帯域幅の合計
pool_stdbw_used 使用されたプールの標準帯域幅の合計
pool_stdvcpu_used 使用済みの標準 vCPU プールの総数
total_discovered_vservers 検出された仮想サーバーの総数
total_entitled_vservers 資格のある仮想サーバーの総数
total_used_vservers 使用された仮想サーバーの総数

NetScaler Gateway 機能の使い方

以下のデータテレメトリは、マネージドNetScaler Gatewayのオンプレミスバージョンが14.1~25.x以降の場合にのみ収集されます:

パラメーター 説明
accessMode アクセスモードのタイプ。たとえば、ICA、VPN などです
bytesTransferred セッションごとに送受信された合計バイト数
epaScans EPA スキャンの総数
機能 NetScaler Gateway で有効になっている機能
id 使用イベントの一意の識別子
prod 元の製品の識別と使用イベントの展開
prodVer ゲートウェイ製品バージョン
email ゲートウェイユーザーの電子メール。注:電子メール ID はハッシュされます*。
st データが取得されている現在の時刻
type CAS が Gateway オンプレミス使用イベントを識別するために使用するイベントタイプ
userName Gatewayのユーザー名。注:名前はハッシュされます*。
ver テレメトリイベントのバージョン

NetScaler 導入

パラメーター 説明
total_active_managed_devices 稼働状態にあるNetScalerインスタンスの総数
total_nsap_device NetScaler コンソールの管理パーティションインスタンスの総数
total_managed_devices NetScaler コンソールで管理されているNetScaler インスタンスの総数
instance_mode インスタンスがスタンドアロンか HA ペアかを確認します
instance_state インスタンスのステータス (Up/Down)
dev_pl_aws デバイスプラットフォームタイプ
dev_pl_azure デバイスプラットフォームタイプ
dev_pl_citrix_hypervisor デバイスプラットフォームタイプ
dev_pl_esx デバイスプラットフォームタイプ
dev_pl_gcp デバイスプラットフォームタイプ
dev_pl_hyper_v デバイスプラットフォームタイプ
dev_pl_kvm デバイスプラットフォームタイプ
dev_pl_unknown デバイスプラットフォームタイプ
dev_pl_vpx_on_sdx デバイスプラットフォームタイプ
total_blx_device NetScalerコンソールで管理されているBLXインスタンスの総数
total_cpx_device NetScalerコンソールで管理されているCPXインスタンスの総数
total_ng_device NetScalerコンソールの管理対象ゲートウェイインスタンスの総数
total_ngvpx_device NetScalerコンソールで管理されているGateway VPXインスタンスの総数
total_ns_device NetScalerコンソールで管理されているMPXインスタンスの総数
total_nssdx_device NetScalerコンソールで管理されているSDXインスタンスの総数
total_nsvpx_device NetScalerコンソールで管理されているVPXインスタンスの総数
total_nswg_device NetScalerコンソールで管理されているWebゲートウェイインスタンスの総数
total_nswgvpx_device NetScalerコンソールで管理されているWebゲートウェイVPXインスタンスの総数
device_id VPXインスタンスのユニークID
device_platform VPXインスタンスがホストされているプラットフォーム
state VPXインスタンスの現在のステータス (稼働中または停止中)
aaa_vservers AAA 仮想サーバの総数
cs_vservers コンテンツスイッチ仮想サーバーの総数
gslb_vservers GSLB 仮想サーバーの総数
lb_vservers_http HTTP LB 仮想サーバーの総数
lb_vservers_ssl SSL 仮想サーバーの総数

NetScaler 機能の使い方

パラメーター 説明
total_aaa_devices AAA仮想サーバーで構成されたNetScalerインスタンスの総数
aaa_as_Request_tot_blocked AAA の appfw プロファイルによってブロックされた HTTP リクエストの総数
aaatm_as_Request_tot_blocked AAATM の appfw プロファイルによってブロックされた HTTP リクエストの総数
as_Requests_aaatm_lb aaatm_lb モジュールに代わって appfw モジュールによって処理された HTTP リクエストの総数
as_Requests_vpn vpn モジュールに代わって appfw モジュールによって処理された HTTP リクエストの総数
nsapisec_builtin_tot_hits Project Shield のビルトイン API セキュリティスキーマの総数
nsapisec_builtin_tot_validated_success Project Shield のビルトイン API セキュリティスキーマに正常に合格したリクエストの総数
svpn_as_Request_tot_blocked VPN の appfw プロファイルによってブロックされた HTTP リクエストの総数
appfw.appfirewallrequests appfw プロファイルによる WAF リクエストの総数
appfw.appfirewallrequestsrate appfw プロファイルによる WAF リクエストの合計レート
appfwprofile.appfw_block プロファイルごとにブロックされた合計数
appfwprofile.appfw_bypass プロファイルごとに渡されたリクエストの総数
appfwprofile.appfw_drop プロファイルごとのドロップパス数の合計
appfwprofile.appfw_reset プロファイルごとに渡されたリセットの総数
bot requests appfw プロファイルによるボットリクエストの総数
bot_signature_version 使用されたボット署名のバージョン
botrequestsrate ボットプロファイルによるボットリクエストの割合
waf_signature_version 使用されている WAF 署名のバージョン
waf.as_requests デフォルトプロファイルも含む、すべての WAF プロファイルを通じて実行されたリクエストの総数
waf.as_req_bytes デフォルトプロファイルを除くすべての WAF プロファイルを通じて実行されたリクエストの総数
total_api_sec_deployments NetScaler コンソールサービスを介したAPIセキュリティ展開の総数
ingress_controllers 入力コントローラーの総数
admin_partitions パーティションの総数
gslb_site_tot_RequestBytes gslb プロファイルを通過したリクエストの合計バイト数
gslb_site_tot_Requests リクエストの合計数は gslb プロファイルを通過します
gslb_sites GSLB サイトの総数
gslb.services gslb サービスの総数
analytics.profile アナリティクスプロファイルの総数
appfw.policies AppFlow ポリシーの総数
appfw.profiles AppFlow プロファイルの総数
bot.policies ボットポリシーの総数
bot.profiles Bot プロファイルの総数
category デバイスの分類。たとえば、ゲートウェイ
cluster.nodes クラスターノードの総数
cr キャッシュリダイレクト仮想サーバーの総数
cs.all コンテンツスイッチ仮想サーバーの総数
cs.gw ゲートウェイとして使用されるコンテンツスイッチ仮想サーバーの総数
cs.used ローカルホストにバインドされていないアドレス可能なコンテンツスイッチ仮想サーバーの総数、および WEB または TCP プロトコルの総数
deployment_type NetScalerの展開タイプ(HAペアまたはスタンドアロン)
ha.node HA ペアの IP アドレス
lb.all すべての負荷分散仮想サーバーの総数
lb.gw ゲートウェイとして使用される負荷分散仮想サーバーの総数
lb.used ローカルホストにバインドされていないアドレス可能な負荷分散仮想サーバーの総数、および WEB または TCP プロトコルの総数
nsip NetScaler NSIP。注:IP アドレスはハッシュされます*。
reason 分類の詳細な理由
servers 仮想サーバーの総数
serviceGroups サービスグループの総数
services サービスの総数
services.dns ADNS/ADNS_TCP タイプのサービスの総数
vpn VPN 仮想サーバーの総数
vpn.ica ICA VPN 仮想サーバーの総数
vservers.gw ゲートウェイとして使用された LB + CS + CR 仮想サーバーの総数
vservers.used ローカルホストにバインドされていないアドレス指定可能なLB+CS+CR仮想サーバーの総数、およびWEBまたはTCPプロトコルの総数
waf_protection ワックス保護タイプ
total_cs_devices コンテンツスイッチ仮想サーバーで構成されたNetScalerインスタンスの総数
total_gslb_devices グローバルサーバー負荷分散仮想サーバーで構成されたNetScalerインスタンスの総数
total_gw_devices SSL VPNが有効になっているNetScalerインスタンスの総数
total_lb_devices 負荷分散仮想サーバーで構成されたNetScalerインスタンスの総数
total_lb_devices_http 負荷分散HTTP仮想サーバーで構成されたNetScalerインスタンスの総数
is_subscription_enabled サブスクリプションによって追加されたエクスポート設定が有効かどうか
telemetry_collected_at テレメトリスクリプトが実行される時刻
state VPXインスタンスの現在のステータス (稼働中または停止中)
version デバイスのビルドバージョン
exp.events イベントのエクスポートに使用されたアナリティクスプロファイルの総数
exp.managementlogs 管理ログのエクスポートに使用された分析プロファイルの総数
exp.metrics 指標のエクスポートに使用される分析プロファイルの数
exp.auditlogs 監査ログを Splunk にエクスポートするために使用される分析プロファイルの数
exp.prometheus Prometheus へのエクスポートに使用されたアナリティクスプロファイルの数
gw_hdx_insights HDX InsightとGateway Insightのエクスポートが有効かどうか

NetScaler コンソールの導入と機能の使用

パラメーター 説明
platform NetScaler コンソールがホストされているプラットフォーム。たとえば、Citrix Hypervisor
csp テナントがCitrix Service Providerかどうか
customer_onboard_date Citrix Cloud がオンボーディングされた日付
Customer_type 顧客が外部顧客か内部顧客か
email Citrix Cloud ID の電子メール ID (Citrix Cloud から収集)
end_date NetScaler コンソールのSKU終了日
product_sku 商品の SKU
product_sku_description 商品 SKU の説明
service_type テナントのサービスタイプ
session_count 最終日のログイン数
start_date NetScaler コンソールのSKU開始日
state NetScaler コンソールのSKUステータス
built_in_agents NetScalerインスタンスがNetScalerコンソールサービスと通信するために使用する組み込みエージェント
page_views NetScalerコンソールのGUIに表示される合計ページビュー数/訪問数
smart_deployment CADS デプロイメントの数
botinsight_usage Bot Insightが有効かどうか (「はい」または「いいえ」)
data_from_adm_service  
adm_pop NetScaler コンソールサービスのPoP名
model_id NetScaler モデルタイプ
total_haproxy_device タイプが「haproxyhost」のデバイスの合計数
version NetScalerのビルド、バージョン、リリース日
is_agt エージェントが設定されているかどうかを確認します
is_cloud NetScaler Consoleの展開がNetScalerコンソールサービスかオンプレミスのNetScalerコンソールかを確認します
number_of_ns_upgrade_jobs 使用されたアップグレードジョブの総数
webinsight Web Insightが lb または cs 仮想サーバーで有効になっているかどうか
webinisight_usage アクティブなHDXセッションがあるかどうか (はいまたはいいえ)
adm_analyt_hdx_apps HDX Insightが有効になっているデバイスからのリクエストの総数
adm_analyt_hdx_users 仮想デスクトップ経由で接続したユーザー数
adm_analyt_sec_insight Security Insightが有効になっているデバイスからのリクエストの総数
adm_analyt_webinsight Web Insightが有効になっているデバイスからのリクエストの総数
anomalyinsight lb または cs 仮想サーバーでリクエスト機能が有効になっているかどうかを示します
count アナリティクスに関連する問題の総数
feature 特定された問題の機能カテゴリ。機能には、BOT_INSIGHT、DEVICE、GATEWAY_INSIGHT、HDX_INSIGHT、SECURITY_INSIGHT、SERVICE_GRAPH、SWG_INSIGHT、WEB_INSIGHT、WEB_SECURITY_BOT_INSIGHT などがあります
feature 負荷分散仮想サーバーで有効になっている分析機能
feature コンテンツスイッチング仮想サーバーで有効になっている分析機能
feature VPN 仮想サーバーで有効になっている分析機能
gwinsight VPN 仮想サーバーで ICA_REQUEST 機能が有効になっているかどうかを示します
gwinsight_usage 過去 1 日に HDX ユーザーがいるかどうかを示します(はいまたはいいえ)
ge_hdx_insights HDX InsightとGateway Insightのエクスポートが有効になりました
issue_type 特定された問題が属する問題カテゴリ。たとえば、ライセンス、構成
secinsight Security Insightが lb または cs 仮想サーバーで有効になっているかどうかを示します
secinsight_usage 過去 1 日にセキュリティ攻撃が見つかったかどうか ([はい] または [いいえ])
sub_issue_type 特定された問題のサブ課題カテゴリ。サブ問題としては、NO_VIPS_LICENSED、BOT_IN_ACTION_DISABLED、NS_FEATURE_DISABLED、VSERVER_WITHOUT_BOT_POLICY_BINDING、APPFLOWPARAM_DISABLED、ICA_APPFLOW_POLICY_BINDING、SECURITY_INSIGHT_IN_ACTION_DISABLED、SECURITY_INSIGHT_ACTION_DISABLED、CPX_VIPS_PRESENT、VSERVER 内のコレクタバインド解除、APPFLOW_POLICY_BINDING
total_api_discovery APIリクエストを受信するNetScalerインスタンスの総数
total_csvserver_ft_enabled 少なくとも 1 つの分析機能が有効になっているコンテンツスイッチ仮想サーバーの総数
total_lbvserver_ft_enabled 少なくとも 1 つの分析機能が有効になっている負荷分散仮想サーバーの総数
total_web_transaction_analytics Webトランザクション分析が有効になっているNetScalerインスタンスの総数
agt_pl_azure エージェントプラットフォームタイプ
agt_pl_citrix_hypervisor エージェントプラットフォームタイプ
agt_pl_docker エージェントプラットフォームタイプ
agt_pl_esx エージェントプラットフォームタイプ
agt_pl_hyper_v エージェントプラットフォームタイプ
agt_pl_gcp エージェントプラットフォームタイプ
agt_pl_kvm エージェントプラットフォームタイプ
agt_pl_kubernetes エージェントプラットフォームタイプ
agt_pl_unknown エージェントプラットフォームタイプ
agt_pl_aws エージェントプラットフォームタイプ
agent_id デプロイされたエージェントの固有 ID
city エージェントが配置されている都市
country エージェントが配置されている国
platform NetScaler コンソールがホストされているプラットフォーム。たとえば、Citrix Hypervisor
region エージェントがデプロイされている地域
total_active_agents UP 状態にあるエージェントの合計数
version エージェントバージョン
city データセンターの都市
isCloud オンプレミスかクラウドか
total_k8s Kubernetes クラスターでホストされているNetScaler コンソール。Kubernetes クラスターの合計数
total_apps NetScaler コンソール内のアプリケーションの総数
total_custom_sites NetScaler コンソールで構成されているカスタムサイトの総数
total_managed_apps NetScaler コンソールで管理されているアプリケーションの総数
total_custom_apps NetScaler コンソール内のカスタムアプリケーションの総数
root /var、/root、/flash、/var/mpsディレクトリにあるNetScalerコンソールのディスク使用率の詳細
total NetScalerコンソールの合計ディスク容量 (単位:バイト)
used NetScalerコンソールの総使用ディスク容量
free NetScalerコンソールの使用可能な総ディスク容量
total_api_requests 過去24時間のNetScalerコンソールへのAPI経由のリクエストの合計数。これには、リモートプロキシユーザ (エージェントからの要求) も含まれます。
total_api_external_requests エージェントからのリクエストを除外したNetScaler ConsoleへのAPI経由のリクエストの合計数
total_gui_requests 過去24時間にNetScalerコンソールGUIにログインしたユーザーの総数
total_users NetScaler コンソールのローカルユーザーの総数
total_config_audit NetScalerコンソールで構成された構成監査テンプレート全体
total_config_job NetScalerコンソールで作成された構成ジョブの総数
total_ssl_certs NetScaler コンソールから作成/変更/削除されたSSL証明書の合計数
total_custom_event_rules NetScaler コンソールで作成されたカスタムイベントルールの総数
プレ認証リクエストの合計数 事前認証トークンの生成に成功したリクエストの数
total_event_rules NetScaler コンソールで作成されたイベントルールの総数
total_ingress_deployed Kubernetes のイングレスコントローラーの総数。
total_ipam NetScalerコンソールに追加されたIPAMプロバイダーの総数
total_ipam_configured NetScalerコンソールに追加されたIPAMネットワークの総数
total_network_report NetScaler コンソールで作成されたネットワークレポートの合計
total_pager_duty_profile NetScaler コンソールに追加されたページャーデューティプロファイルの総数
total_rbac_groups NetScalerコンソールで構成されているRBACグループの総数
total_slack_profile NetScaler コンソールに追加された Slack プロファイルの総数
total_ssl_certs NetScaler コンソールから作成/変更/削除されたSSL証明書の合計数
total_stylebook_config_store_count NetScaler コンソールで作成された構成パックの総数
total_user_sb_stylebook_count NetScaler コンソールで作成されたカスタム構成パックの総数
configpack StyleBookに保存されている構成パックの総数
export_end_point データが送信されるエンドポイント。
export_frequency データのエクスポートは 1 時間ごとまたは 1 日ごとです
export_type 日付の送信先。例:Splunk、ニューレリック
gather_feature どのデータがエクスポートされるか。例:WAF、ボット
subscribed_by オブザーバビリティ設定を追加したユーザー
subscription_name 構成を識別するためのサブスクリプション名
subscription_notification_enabled エクスポートで通知設定が有効になっているかどうか

*テレメトリを通じて収集された電子メールアドレス、ユーザー名、IPアドレスなどの情報は、一方向ハッシュアルゴリズムを使用してソースで情報をハッシュすることにより、安全に仮名化されます。その結果、Citrix はこれらの値にアクセスしたり読み取ったりできません。このテレメトリデータは、論理的な資産照合のみを目的として使用されます。

NetScalerテレメトリプログラムのデータガバナンス