NetScaler Application Delivery Managementサービス

Amazon Web Services (AWS) にエージェントをインストールする

May 23, 2023

寄稿者:

NetScaler ADM エージェントは、NetScaler ADM とデータセンターまたはクラウドで検出されたインスタンスの仲介者として動作します。

前提条件

Amazon GUI を使用して、Amazon Web Services（AWS）仮想プライベートクラウド（VPC）内で NetScaler ADM エージェント AMI を起動するには、次のものが必要です。

AWSアカウント
AWS 仮想プライベートクラウド（VPC）
IAMアカウント

注

NetScaler ADM エージェント仮想マシンをプロビジョニングする前に、セキュリティグループ、仮想プライベートネットワーク、キーペア、サブネット、およびその他のエンティティを作成することをお勧めします。したがって、ネットワーク情報は、プロビジョニング中に利用できます。

NetScaler ADM エージェントがCitrix ADMおよびCitrix ADC インスタンスと通信するには、推奨ポートが開いていることを確認します。NetScaler ADM エージェントのポート要件について詳しくは、「ポート」を参照してください。

AWS に NetScaler ADM エージェントをインストールするには:

AWS 認証情報を使用して AWS マーケットプレイスにログオンします。
検索フィールドに「 NetScaler ADM エージェント 」と入力して NetScaler ADM エージェント AMI を検索し、「実行」をクリックします。
検索結果ページで、使用可能なリストから NetScaler ADM 外部エージェント AMI をクリックします。
NetScaler ADM 外部エージェント AMI ページで、「 購読を続行」をクリックします。
サブスクリプションが正常に完了したら、[ 構成に進む] をクリックします。
[ このソフトウェアの構成 ] ページで、次の操作を行います。
1. フルフィルメントオプションリストからAMIを選択します 。
2. ［ ソフトウェアバージョン］の一覧から、最新のCitrix ADMエージェントバージョンを選択します 。
3. [地域] リストから地域を選択します 。
4. [ 続行] をクリックして起動
［ このソフトウェアの起動 ］ページでは、Citrix ADMエージェントを登録する2つのオプションがあります。
1. ウェブサイトからの起動
2. EC2 で起動

ウェブサイトからの起動

Web サイトから起動するには、次を選択します。

EC2 インスタンスタイプリストの EC2 インスタンスタイプ
[VPC 設定] リストから VPC 。[ EC2 で VPC を作成 ] をクリックして、ソフトウェアの VPC を作成します。
[ サブネット設定] リストのサブネット。VPC を選択した後にサブネットを作成するには、[EC2 にサブネットを作成] をクリックします。
[ セキュリティグループ設定] リストからファイアウォールのセキュリティグループ。出品者設定に基づいて新規作成をクリックし 、セキュリティグループを作成します。
[Key Pair Settings] リストからアクセスセキュリティを確保するためのキーペア 。[ EC2 でキーペアを作成する ] をクリックして、ソフトウェアのキーペアを作成します。
[ 起動] をクリックします
ウェブサイトからの起動は成功しました。

注

展開プロセスには約 10 ～ 15 分かかる場合があります。デプロイが正常に完了すると、AWS アカウントの NetScaler ADM エージェント仮想マシンを表示できます。
エージェントを展開したら、Citrix ADMエージェントの名前を割り当てます。
エージェントが起動して実行されたら、Citrix ADMエージェントにElastic IPアドレスを割り当てます。

注

Elastic IPアドレスを使用すると、Citrix ADMエージェントがCitrix ADMと通信できるようになります。ただし、トラフィックをインターネットにルーティングするように NAT ゲートウェイを設定している場合は、Elastic IP アドレスは必要ありません。
SSHクライアントを使用して、NetScaler ADM エージェントにログオンします。
注:

NetScaler ADM エージェントには、次のいずれかの方法でログオンできます。
- nsrecoverをユーザー名として、AWS インスタンス ID をパスワードとして使用します。
- nsrootをユーザー名として使用し、有効なキーペアをパスワードとして使用します。
次のコマンドを入力して、展開画面を起動します。 deployment_type.py
「はじめに」の指示に従って、NetScaler ADM の「 エージェントの設定 」 **ページからコピーして保存したサービスURLとアクティベーションコードを入力します**。エージェントは、サービス URL を使用してサービスを検索し、アクティベーションコードを使用してサービスに登録します。

エージェントの登録に成功すると、エージェントは再起動してインストールプロセスを完了します。

エージェントが再起動したら、Citrix ADMにアクセスし、［ エージェントの設定 ］ページの［ 検出されたエージェント］で、エージェントの状態を確認します。

EC2 で起動

EC2で起動するには、[ アクションの選択] リストから [ EC2 経由で起動 ] を選択し、[Launch] をクリックします。

[ インスタンスタイプの選択 ] ページで、インスタンスを選択し、[ 次へ:インスタンスの詳細の設定] をクリックします。

[ インスタンスの詳細の設定 ] ページで、必要なパラメータを指定します。

[ 詳細情報 ] セクションで、[ User data ] フィールドに認証の詳細またはスクリプトを指定して、ゼロタッチエージェントを有効にできます。

認証の詳細 -「はじめに」の指示に従ってCitrix ADM の「 エージェントの設定 」 **ページからコピーしたサービスURLとアクティベーションコードを指定します**。次の形式で詳細を入力します。
```
 registeragent -serviceurl <apigatewayurl> -activationcode <activationcodevalue>
 
```
エージェントはこの情報を使用して、起動時にCitrix ADM に自動登録します。

スクリプト ：ユーザーデータとしてエージェント自動登録スクリプトを指定します。スクリプトの例を次に示します。

 #!/var/python/bin/python2.7
 import os
 import requests
 import json
 import time
 import re
 import logging
 import logging.handlers
 import boto3

 '''
 Overview of the Script:
 The script helps to register a NetScaler ADM agent with NetScaler ADM. Pass it in userdata to make NetScaler ADM agent in AWS to autoregister on bootup. The workflow is as follows
 1)  Fetch the NetScaler ADM API credentials (ID and secret) from AWS secret store (NOTE: you have to assign IAM role to the NetScaler ADM agent that will give permission to fetch secrets from AWS secret store)
 2)  Login to NetScaler ADM with credentials fetched in step 1
 3)  Call NetScaler ADM to fetch credentials (serviceURL and token) for agent registration
 4)  Calls registration by using the credentials fetched in step 3
 '''

 '''
 These are the placeholders which you need to replace according to your setup configurations
 aws_secret_id: Id of the AWS secret where you have stored NetScaler ADM Credentials
 The secrets value should be in the following json format
 { "adm_user_id_key": "YOUR_ID", " adm_user_secret_key": "YOUR_SECRET"}
 '''

 aws_secret_id = "<AWS_secret_id>"
 adm_ip_or_hostname = "<YOUR_ADM_POP>.adm.cloud.com"

 '''
 Set up a specific logger with your desired output level and log file name
 '''
 log_file_name_local = os.path.basename(\_\_file\_\_)
 LOG_FILENAME = '/var/log/' + 'bootstrap' + '.log'
 LOG_MAX_BYTE = 50\*1024\*1024
 LOG_BACKUP_COUNT = 20

 logger = logging.getLogger(\_\_name\_\_)
 logger.setLevel(logging.DEBUG)
 logger_handler = logging.handlers.RotatingFileHandler(LOG_FILENAME, maxBytes=LOG_MAX_BYTE, backupCount=LOG_BACKUP_COUNT)
 logger_fortmater = logging.Formatter(fmt='%(asctime)-2s:%(funcName)30s:%(lineno)4d: [%(levelname)s] %(message)s', datefmt="%Y-%m-%d %H:%M:%S")
 logger_handler.setFormatter(logger_fortmater)
 logger.addHandler(logger_handler)

 class APIHandlerException(Exception):
     def \_\_init\_\_(self, error_code, message):
         self.error_code = error_code
         self.message = message

     def \_\_str\_\_(self):
         return self.message + ". Error code '" + str(self.error_code) + "'"

 def parse_response(response, url, print_response=True):
     if not response.ok:
         if "reboot" in url:
             logger.debug('No response for url: reboot')
             resp = {"errorcode": "500", "message": "Error while reading response."}
             return resp

         if print_response:
             logger.debug('Response text for %s is %s' % (url, response.text))

         response = json.loads(response.text)
         logger.debug("ErrorCode - " + str(response['errorcode']) + ". Message -" + str(response['message']))
         raise APIHandlerException(response['errorcode'], str(response['message']))
     elif response.text:
         if print_response:
             logger.debug('Response text for %s is %s' % (url, response.text))

         result = json.loads(response.text)
         if 'errorcode' in result and result['errorcode'] > 0:
             raise APIHandlerException(result['errorcode'], str(result['message']))
         return result

 def _request(method, url, data=None, headers=None, retry=3, print_response=True):
     try:
         response = requests.request(method, url, data=data, headers=headers)
         result = parse_response(response, url, print_response=print_response)
         return result
     except [requests.exceptions.ConnectionError, requests.exceptions.ConnectTimeout]:
         if retry > 0:
             return _request(method, url, data, headers, retry-1, print_response=print_response)
         else:
             raise APIHandlerException(503, 'ConnectionError')
     except requests.exceptions.RequestException as e:
         logger.debug(str(e))
         raise APIHandlerException(500, str(e))
     except APIHandlerException as e:
         logger.debug("URL: %s, Error: %s, Message: %s" % (url, e.error_code, e.message))
         raise e
     except Exception as e:
         raise APIHandlerException(500, str(e))

 try:
     '''Get the AWS Region'''
     client = boto3.client('s3')
     my_region = client.meta.region_name
     logger.debug("The rgion is %s" % (my_region))

     '''Creating a Boto cleint session'''
     session = boto3.session.Session()
     client = session.client(
         service_name='secretsmanager',
         region_name=my_region
     )

     '''Getting the values stored in the secret with id: <aws_secret_id>'''
     get_id_value_response = client.get_secret_value(
         SecretId = aws_secret_id
     )
     adm_user_id = json.loads(get_id_value_response["SecretString"])["adm_user_id_key"]
     adm_user_secret = json.loads(get_id_value_response["SecretString"])["adm_user_secret_key"]

 except Exception as e:
     logger.debug("Fetching of NetScaler ADM credentials from AWS secret failed with error: %s" % (str(e)))
     raise e

 '''
 Initializing common NetScaler ADM API handlers
 '''
 mas_common_headers = {
     'Content-Type': "application/json",
     'Accept-type': "application/json",
     'Connection': "keep-alive",
     'isCloud': "true"
 }

 '''
 API to login to the NetScaler ADM and fetch the Session ID and Tenant ID
 '''
 url = "https://" + str(adm_ip_or_hostname) + "/nitro/v1/config/login"
 payload = 'object={"login":{"ID":"' + adm_user_id + '","Secret":"' + adm_user_secret + '"}}'
 try:
     response = _request("POST", url, data=payload, headers=mas_common_headers)
     sessionid = response["login"][0]["sessionid"]
     tenant_id = response["login"][0]["tenant_name"]
 except Exception as e:
     logger.debug("Login call to the NetScaler ADM failed with error: %s" % (str(e)))
     raise e

 '''
 API to fetch the service URL and Token to be used for registering the agent with the NetScaler ADM
 '''
 mas_common_headers['Cookie'] = 'SESSID=' + str(sessionid)
 url = "https://" + str(adm_ip_or_hostname) + "/nitro/v1/config/trust_preauthtoken/" + tenant_id +"?customer="+ tenant_id
 logger.debug("Fetching Service URL and Token.")
 try:
     response = _request("GET", url, data=None, headers=mas_common_headers)
     service_name  = response["trust_preauthtoken"][0]["service_name"]
     token = response["trust_preauthtoken"][0]["token"]
     api_gateway_url = response["trust_preauthtoken"][0]["api_gateway_url"]
 except Exception as e:
     logger.debug("Fetching of the Service URL Passed with error. %s" % (str(e)))
     raise e

 '''
 Running the register agent command using the values we retrieved earlier
 '''
 try:
     registeragent_command = "registeragent -serviceurl "+api_gateway_url+" -activationcode "+service_name+";"+token
     file_run_command = "/var/python/bin/python2.7 /mps/register_agent_cloud.py "+registeragent_command
     logger.debug("Executing registeragent command: %s" % (file_run_command))
     os.system(file_run_command)
 except Exception as e:
     logger.debug("Agent Registeration failed with error: %s" % (str(e)))
         raise e
 <!--NeedCopy-->

このスクリプトは、AWSシークレットマネージャーから認証の詳細を取得し、 deployment.py スクリプトを実行してエージェントをCitrix ADM に登録します。

インスタンスの詳細を設定する

注

パブリック IP アドレスを自動割り当てできますが、Elastic IP アドレスを割り当てることもできます。NAT Gatewayが設定されていない場合は、Elastic IP アドレスを割り当てる必要があります。

このステップで Elastic IP アドレスが設定されていない場合でも、EC2 コンソールで行うことができます。インスタンス ID または ENI-ID を使用して、新しい Elastic IP アドレスを作成し、それを NetScaler ADM エージェントに関連付けることができます。

[ ストレージの追加] をクリックします。

[ Add Storage ] ページで、インスタンスのストレージデバイス設定を構成し、[ 次へ:Add Tags] をクリックします。
[ Add Tags ] ページで、インスタンスのタグを定義し、[ 次へ:セキュリティグループの設定] をクリックします。
[ Configure Security Group ] ページで、インスタンスへの特定のトラフィックを許可するルールを追加し、[ Review and Launch] をクリックします。
[ Review Instance Launch ] ページで、インスタンスの設定を確認し、[ Launch] をクリックします。
[ 既存のキーペアの選択または新しいキーペアの作成 ] ダイアログボックスで、キーペアを作成します。既存のキーペアから選択することもできます。

確認を受け入れ、[ Launch Instances] をクリックします。

展開プロセスには約 10 ～ 15 分かかる場合があります。デプロイが正常に完了すると、AWS アカウントの NetScaler ADM エージェント仮想マシンを表示できます。

このコンテンツの正式なバージョンは英語で提供されています。Cloud Software Groupドキュメントのコンテンツの一部は、お客様の利便性のみを目的として機械翻訳されています。Cloud Software Groupは機械翻訳されたコンテンツを管理していないため、誤り、不正確な情報、不適切な用語が含まれる場合があります。英語の原文から他言語への翻訳について、精度、信頼性、適合性、正確性、またはお使いのCloud Software Group製品またはサービスと機械翻訳されたコンテンツとの整合性に関する保証、該当するライセンス契約書またはサービス利用規約、あるいはCloud Software Groupとのその他すべての契約に基づき提供される保証、および製品またはサービスのドキュメントとの一致に関する保証は、明示的か黙示的かを問わず、かかるドキュメントの機械翻訳された範囲には適用されないものとします。機械翻訳されたコンテンツの使用に起因する損害または問題について、Cloud Software Groupは責任を負わないものとします。

この情報は役に立ちましたか?

Amazon Web Services (AWS) にエージェントをインストールする

May 23, 2023

寄稿者:

May 23, 2023

寄稿者:

この情報は役に立ちましたか?