【Citrix Gateway VPX】ファームウェアのアップデート手順の一例

本記事の内容は2023/01/30に更新しました。

こんにちは。Citrix製品のサポートを担当している川東（かわひがし）です。

今回は、１台構成のCitrix Gateway 13.0 build 88.16 を13.1 build 37.38にアップデートする手順の一例をご紹介します。本手順を実施する場合は、検証環境をご使用ください。

アップデートに関する注意点
事前準備
　（１）Citrix Gatewayの仮想アプライアンス（仮想マシン）自体をバックアップします
　（２）nsrootの初期パスワードを変更していない場合は変更します
　（３）ライセンスファイルの更新
　（４）Refererヘッダー関連の式を削除
ファームウェアのダウンロード
ファームウェアの配置
ファームウェアのアップデート
CLIを使用したインストール手順の一例
まとめ

一度に１つのメジャーリリースへアップグレードすることが推奨されています。
https://docs.citrix.com/ja-jp/citrix-adc/current-release/upgrade-downgrade-citrix-adc-appliance/upgrade-downgrade-before-you-begin.html

＜一部抜粋＞
Citrix では、メジャーリリースを1つずつアップグレードすることを推奨しています。たとえば、Citrix ADCアプライアンスがリリース12.1にあり、リリース13.1にアップグレードする場合は、まずアプライアンスをリリース13.0にアップグレードし、次にリリース13.1にアップグレードします。

※その他の注意点は上記ドキュメントをご参照ください。

こちらのバージョンからアップグレード、もしくは、ダウングレードする場合はCLIを使用してください。GUIを使用した方法は失敗する場合があります。
CLIを使用したバージョンアップ方法は「CLIを使用したインストール手順の一例」をご参照ください。

※リリースノートから一部抜粋
＊＊＊
https://docs.citrix.com/en-us/citrix-adc/current-release/citrix-adc-release-notes/release-notes-13-1-37-38.html#fixed-issues

Upgrading or downgrading a Citrix ADC appliance to one of the following
builds by using the Citrix ADC GUI might fail:

Release 13.1 build 30.52
Release 13.1 build 27.59
＊＊＊

ご使用のハイパーバイザーの機能を使用して仮想アプライアンス（仮想マシン）のバックアップをお願いします。

Citrix Gatewayの管理画面にて「System」－「User Administration」－「Users」を開き、nsrootにチェックをつけて「Change Password」をクリックします。
※以下の画面は、筆者の検証環境（Ver.13.0）の画面ショットです。

変更後、画面右上の保存アイコンをクリックします。

13.1以降にアップデートする場合は、SA日が以下のページに記載の日付よりも新しいライセンスファイルを使用してください。

CTX111618 : Citrix Product Customer Success Services Eligibility Dates

例えば、Citrix Gatewayが13.1の場合は、2021/08/23が製品の有効日になります。
※以下は、NetScaler VPXの表記ですが、Citrix Gateway VPXも同様です。

現在適用しているライセンスファイルをテキストエディタにて開き、以下の文字列内の YYYY.MMDDをご確認ください。Citrix Gateway 13.1の場合は、2021.0823より新しい日付が登録されているライセンスファイルを使用する必要があります。

　　INCREMENT CNS_XX CITRIX YYYY.MMDD

※現在適用しているライセンスファイルのYYYY.MMDDの日付は、Citrix Gateway仮想アプライアンス上の /nsconfig/license 内の拡張子が lic ファイルを参照することでも確認できます。

※ライセンスファイル適用後、再起動が必要です。ユーザ様の利用が無い状態で作業をお願いします。

１．CitrixのMy AccountサイトからCitrix Gatewayのライセンスファイルをダウンロードします。Citrix GatewayのSelectを毎年更新されている場合は、すでに割り当て済みのライセンスファイルを再度ダウンロードしていただくことで、SA日が更新されているライセンスファイルを入手できます。

２．ダウンロードしたライセンスファイルをテキストエディタにて開き、以下の文字列内の YYYY.MMDDが、CTX111618 に記載の製品バージョンの有効日よりも新しい日付であることを確認します。

３．Citrix Gatewayの管理画面を開きます。「System」－「License」を開きます。

４．「ADC License」タブを開き「Manage License」をクリックします。

５．「Add New License」をクリックします。

６．「Upload license files」が選択されていることを確認して「Browse」をクリックします。ファイルを開くダイアログにて新しいライセンスファイルを開きます。

７．新しいライセンスファイルが表示された後、「Reboot」をクリックします。

８．「Yes」をクリックします。

９．自動再起動されます。

Citrix Gateway 13.0以降にアップデート後、Virtual ServerにバインドしているSession Policyが以下のいずれかのように設定されている場合、

Citrix GatewayのICA-Proxy接続にてログインした際に「要求を完了できません」が表示されることが確認できております。Ver.12.1のアップデート前に以下の式に変更してください。（アップデート後も変更できます）

HTTP.REQ.HEADER("User-Agent").CONTAINS("CitrixReceiver").NOT

※REQ.HTTP.HEADER User-Agent NOTCONTAINS CitrixReceiverの場合も動作しますが、こちらはクラシックポリシーの書式になりますため、上記のアドバンスドポリシーの書式を推奨致します。

変更手順は以下をご参照ください。

１．「Citrix Gateway」ー「Policies」ー「Session」を開きます。「Session Policies」タブを開き、変更対象のポリシーにチェックをつけて「Edit」をクリックします。

２．「&&HTTP.REQ.HEADER("Referer").EXISTS」を削除して「OK」をクリックします。

３．画面右上の保存アイコンをクリックします。

１．https://www.citrix.com/downloads/ 　のページを開きます。

２．「Citrix Gateway」を選択します。

３．以下の画面を下にスクロールします。「Citrix Gateway (Feature Phase) 13.1 Build 37.38」をクリックします。
※こちらの画面は、2023/01/04時点の画面です。

４．Citrixサイトのログイン画面が表示された場合はログインします。

５．多要素認証のコードを入力してログインします。
※「今すぐ登録」のボタンが表示された場合は、多要素認証設定をしてください。

６．画面下にある「Citrix Gateway 13.1-37.38 Firmware (nCore)」の「Download File」をクリックします。
※「Citrix Gateway VPX for XXXX」もございますが、こちらはハイパーバイザー別の仮想アプライアンスのダウンロードになります。 (nCore)がついている項目からダウンロードをお願いします。

７．「End-User License Agreement」画面にて「Yes, I accept」をクリックします。

８．「I have read and ...」のチェックを付けて「Accept」をクリックします。

９．「build-13.1-37.38_nc_64.tgz」のダウンロードが開始されます。

１．WinSCP等を使用して、Citrix Gatewayの管理IPアドレスに接続後、/var/nsinstall/を開きます。古いファームウェアのアップデート用ファイルが残っている場合は削除します。
※以下は、筆者の検証環境の画面ショットです。build-13.0-88.16_nc_64を削除します。

２．以下のディレクトリを作成します。

　　/var/nsinstall/<アップグレードするバージョン>

例：ファームウェアのファイル名がbuild-13.1-37.38_nc_64.tgzの場合は、
「build-13.1-37.38_nc_64」の名前のディレクトを作成します。
※以下は、筆者の検証環境の画面ショットです。「build-13.1-37.38_nc_64」の名前でディレクトを作成しました。

３．作成したディレクトリに、アップデート用のファイルを配置します。
※以下は、筆者の検証環境の画面ショットです。”/var/nsinstall/build-13.1-37.38_nc_64” に
build-13.1-37.38_nc_64.tgzを配置しました。

※アップデート前に、Citrix Gatewayの再起動をお願いします。

１．Citrix Gatewayの管理画面にログインします。「Cofiguration」タブ画面にて「System」をクリックします。「System Upgrade」をクリックします。

２．ディスク使用率が緑色で表示されることを確認します。

３．「Appliance」をクリックします。

４．ディレクトリが表示されている場合は、選択して「Open」をクリックします。

５．ファームウェアのファイルを選択後、「Open」をクリックします。

６．本記事は「Upgrade Options」にて「Reboot after successful installation」にチェックをつけて、「Enabe CallHome」と「Enabel Citrix ADM Service Connect」のチェックを外しています。「Upgrade」をクリックします。

７．「System Upgrade」画面が表示されて、システムアップデート処理が開始されます。
※筆者の検証環境は、手順8の画面の表示までに10分程度かかりました。

８．アップデート完了後、自動再起動が始まります。以下の画面が表示されます。

９．しばらくして以下の画面が表示された場合は「OK」をクリックします。

１０．ログイン後、「Configuration」タブを開き、画面右上のログインアカウント名をクリック後、バージョンとビルド番号を確認して更新されていることを確認します。

※参考情報
　CLIを使用してCitrix ADCスタンドアロンアプライアンスをアップグレードする

以下の手順は、Ver.13.0 build 88.16 から Ver.13.1 build 37.38にアップデートしています。

必ず検証環境にて動作確認をしていただきますようお願い致します。

１．ファームウェアの配置をします。

２．TeraTermなどのターミナルエミュレータにてCitrix Gatewayの管理用IPアドレスに接続してログイン後、以下のコマンドを実行して現在の設定を保存します。

save config

３．以下のコマンドを実行して shellモードに切り替えます。

shell

４．以下のコマンドを実行して現在の設定ファイルをバックアップします

cd /nsconfig
cp ns.conf ns.conf<現在のバージョン>
※例：cp ns.conf ns.conf13.0-88.16

※バージョンは “show ns version”にて確認できます。shellモードの場合は exitにて抜けてから実行してください。

※バージョンアップ処理中にns.conf.NS13.0-88.16のファイルが自動作成されますが、念のため、上記の手動バックアップもお願いします。

５．以下の場所に移動します

cd /var/nsinstall/<手順1で作成したディレクトリ>

６．以下のコマンドを使用して展開します。

tar –xvzf <アップロードしたtgzファイル>

例: tar –xvzf build-13.1-37.38_nc_64.tgz

７．以下のコマンドを使用してインストールします。

./installns

※本項目の手順にて、12.1から13.0へアップデートした際にCitrix ADM Service Connectを無効にするかどうかの確認メッセージが表示されます。disable にするため「N」キーを入力していただくことも可能です。

８．古い signature file と kernel image の削除確認メッセージは、削除する場合は「Y」キーを入力します。本資料は削除するため「Y」キーを入力しました。

９．”Reboot NOW? [Y/N]” にて、再起動する場合は「Y」を入力します。本資料はアップデート完了後に自動再起動するため「Y」を入力しました。

１０．10分程度経過後、TeraTerm等のターミナルエミュレータを使用してADCの管理IPアドレスに接続してログインします。以下のコマンドを実行してバージョンを確認します。

show ns version

トラブル発生時に最短で解決に導くためのコツを動画でご紹介！
「Citrixトラブルシューティングセミナー」を視聴する

いかがでしたでしょうか。Citrix Gatewayのアップデート手順の参考になりますと幸いです。

クライアント仮想化の基礎知識から、仮想化製品「Citrix Virtual Apps and Desktops(XenAppおよびXenDesktop)」の製品概要、導入検討時に注意すべき点などをご紹介します。
今お持ちのお悩みを解決し、Citrix製品をより有効に活用する方法を具体的に学ぶことができる内容になっております。

アシストのCitrixサポートセンターに良くある設定・トラブル対処方法のFAQ10選の資料を無料プレゼント中です。また、Citrix XenApp/XenDesktopの問題発生時に原因を切り分ける方法も掲載しております。以下のバナーからお気軽にダウンロードください。