1.2 移行作業内容(API利用版)¶
- 動作確認バージョン
NetScaler VPX Version13.1 Standard Edition
Contents
1.2.2 前提条件¶
旧バージョンである 12.0-53.13 においては プラン変更 による移行を実施できません。異なるバージョン間の切替 を参照し、新環境に最新バージョンのロードバランサーを構築して切り替えてください。
設備更改における共通のガイドラインおよび注意事項については こちら の特設サイトをご確認ください。
注釈
旧バージョンである 12.1-55.18 Standard Editionにおいては プラン変更 による移行が可能です。
1.2.3 注意事項¶
プラン変更の実施前に コンフィグ管理 を参照し必ずコンフィグのバックアップを取得してください。
- プラン変更時の注意事項については、下記 FAQ/既知の問題 を参照してください。
1.2.4 移行作業内容¶
1.2.4.1 API利用のための準備
1.2.4.2 利用しているロードバランサー 一覧の取得
1.2.4.3 利用しているロードバランサーのプラン詳細情報を順番に取得
1.2.4.4 移行先プランの選定
1.2.4.5 移行対象ロードバランサーのプラン変更
1.2.4.6 移行完了したことの確認
1.2.4.1 API利用のための準備¶
以下URLのページを参考に 3. トークン(Token)の取得 までの手順を実施し、トークンを取得してください。
以下URLのページを参考に、お使いのリージョンでの エンドポイントURL を把握してください。
ロードバランサーのエンドポイントURLは、通常 network-[Region Name]-ecl.api.ntt.com です。
これらの変数を設定してください
$ token=取得したトークン
$ endpoint=ロードバランサーのエンドポイントURL
1.2.4.2 利用しているロードバランサー 一覧の取得¶
以下のコマンドで、利用しているロードバランサーの一覧を取得します。
$ curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" \
https://${endpoint}/v2.0/load_balancers
以下のようなレスポンスが返ってきます。お使いの全ての "load_balancer_plan_id" をメモしてください。今回の例では、"fc916849-9d43-48ce-9884-db2b62bdcbfb" のプランIDを対象とします。
{
"load_balancers": [
{
"admin_username": "user-admin",
"availability_zone": "zone1-groupa",
"default_gateway": null,
"description": "{description of your load balancer}",
"id": "{uuid of your load balancer}",
"load_balancer_plan_id": "fc916849-9d43-48ce-9884-db2b62bdcbfb",
"name": "{name of load balancer}",
"status": "ACTIVE",
"tenant_id": "{your tenant_id}",
"user_username": "user-read"
}
]
}
1.2.4.3 利用しているロードバランサーのプラン詳細情報を順番に取得¶
以下のコマンドで、利用しているロードバランサーのプラン詳細情報を順番に取得します。今回の例では "fc916849-9d43-48ce-9884-db2b62bdcbfb"です。
$ load_balancer_plan_id=fc916849-9d43-48ce-9884-db2b62bdcbfb
$ curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" \
https://${endpoint}/v2.0/load_balancer_plans/${load_balancer_plan_id}
以下のようなレスポンスが返ってきます。
"name"に"MIGRATION_NEEDED"が含まれるプランを採用しているロードバランサーは、新プランへの以降が必要 です。該当プランを用いている ロードバランサーのID を全てリストアップしてください。
{
"load_balancer_plan": {
"description": "Citrix_NetScaler_VPX_13.1-33.52_Standard_Edition_50Mbps_2CPU-8GB-4IF",
"enabled": true,
"id": "fc916849-9d43-48ce-9884-db2b62bdcbfb",
"maximum_syslog_servers": 8,
"model": {
"edition": "Platinum",
"size": "50"
},
"name": "MIGRATION_NEEDED_Citrix_NetScaler_VPX_13.1-33.52_Standard_Edition_50Mbps_2CPU-8GB-4IF",
"update_enabled": false,
"vendor": "citrix",
"version": "13.1-33.52"
}
}
1.2.4.4 移行先プランの選定¶
以下のコマンドで、ロードバランサーのプラン一覧を取得します。
$ curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" \
https://${endpoint}/v2.0/load_balancer_plans?update_enabled=true
以下のようなレスポンスが返ってきます。
"name"に"MIGRATION_NEEDED"を含まない プランを選定し、idを控えてください。今回の例では、"id"が "a2e6de45-0e01-4741-b08f-891b9bd9a271" のプランを用います。
{
"load_balancer_plans": [
{
"description": "Citrix_NetScaler_VPX_13.1-52.19_Standard_Edition_50Mbps_2CPU-8GB-4IF",
"enabled": true,
"id": "a2e6de45-0e01-4741-b08f-891b9bd9a271",
"maximum_syslog_servers": 8,
"model": {
"edition": "Platinum",
"size": "50"
},
"name": "Citrix_NetScaler_VPX_13.1-52.19_Standard_Edition_50Mbps_2CPU-8GB-4IF",
"update_enabled": true,
"vendor": "citrix",
"version": "13.1-52.19"
},
]
}
1.2.4.5 移行対象ロードバランサーのプラン変更¶
移行先プランIDを変数に指定します。今回の例では "a2e6de45-0e01-4741-b08f-891b9bd9a271" です。
$ load_balancer_plan_id=a2e6de45-0e01-4741-b08f-891b9bd9a271
プラン移行が必要な全てのロードバランサーについて、以下の手順を実施します。プラン移行が必要なロードバランサーのIDを変数に指定します。
$ load_balancer_id={uuid of your load balancer}
次のコマンドを実行します。
$ curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" \
https://${endpoint}/v2.0/load_balancers/${load_balancer_id} \
-d "{
\"load_balancer\": {
\"load_balancer_plan_id\": \"${load_balancer_plan_id}\"
}
}"
レスポンス(長いため省略)の"status" が "PENDING_UPDATE" になっていることを確認してください。
ロードバランサーのプラン変更に伴いまして、ロードバランサーの再起動が発生いたします。
注釈
再起動は処理完了まで通常10分ほど掛かります。
1.2.4.6 移行完了したことの確認¶
プラン移行を実施したロードバランサーのIDを変数に指定します。
$ load_balancer_id={uuid of your load balancer}
次のコマンドを実行します。
$ curl -X GET -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" \
https://${endpoint}/v2.0/load_balancers/${load_balancer_id}
確認ポイント
レスポンス(長いため省略) の "status" が "active" になっていることを確認してください。
レスポンスの "load_balancer_plan_id" が 指定したプランID になっていることを確認してください。
実施が必要な手順は以上となります。
1.2.5 切り戻し方法¶
切り戻しの機能は提供しておりません。
1.2.6 切り戻し方法¶
下記既知の問題に記載のとおり、プラン変更時にオペレーションステータスが稀に「エラー」となる事象が確認されています。本設備更改におけるプラン変更実施時に事象が発生した場合は、復旧可能なケースがありますので、お手数ですがチケットにてお問い合わせください。