Product Documentation

Installing Citrix ADM agent on AWS

The Citrix Application Delivery Management (Citrix ADM) agent works as an intermediary between the Citrix ADM and the discovered instances in the data center or on the cloud.

Prerequisites

To launch a Citrix ADM agent AMI within an Amazon Web Services (AWS) Virtual Private Cloud (VPC) by using the Amazon GUI, you need:

  • An AWS account
  • An AWS Virtual Private cloud (VPC)
  • An IAM account

Note

  • Citrix recommends that you create security group, virtual private network, key pair, subnet, and other entities before you provision the Citrix ADM agent virtual machine, so that the network information is available during provisioning.
  • For Citrix ADM agent to communicate with the Citrix ADM, and the Citrix ADC instances, ensure that the recommended ports are open. For complete details about the port requirements for Citrix ADM agent, see Ports.

To install the Citrix ADM agent on AWS:

  1. Log on to the AWS marketplace (https://aws.amazon.com/marketplace) by using your Amazon AWS credentials.

  2. In the search field, type Citrix ADM Agent 12.0 to search for the Citrix ADM agent AMI, and click Go.

  3. On the search result page, click the Citrix Citrix ADM agent AMI from the available list.

  4. On the Citrix Citrix ADM Agent AMI page, click Continue.

    localized image

You have two options to register the Citrix ADM agent with Citrix ADM while launching the agent virtual machine in AWS.

  • Automatic Registration
  • Manual Registration

To automatically register the agent by using the Manual Launch tab in AWS Marketplace:

  1. To automatically register the Citrix ADM agent to Citrix ADM while launching the agent virtual machine in AWS, select the Manual Launch tab.

    localized image

  2. Under the Launch section, click Launch with EC2 Console for the appropriate AMI.

    localized image

  3. On Step 2: Choose an Instance Type page, select the instance and click Next: Configure Instance Details.

    localized image

  4. On the Step 3: Configure Instance Details page, in the User data field under the Advanced Details section, enter the Service-URL and the Activation code that you had copied and saved from the Set Up Agents page in Citrix ADM as instructed in Getting Started. You need to then enter the details in the following format and click Next: Add Storage.

    Note

    While you can auto-assign public IP address, you can also assign elastic IP address. Assigning elastic IP address is required when NAT Gateway is not configured. If you did not set the elastic IP address in this step, you can always do it on EC2 console. You can create a new elastic IP address and associate that with the MA Service agent using the instance ID or ENI-ID.

    registeragent -serviceurl <apigatewayurl> -activationcode <activationcodevalue>
    
    

    localized image

  5. On the Step 4: Add Storage page, configure the storage device settings for the instance and click Next: Add Tags.

    localized image

  6. On the Step 5: Add Tags page, define the tag for the instance and click Next: Configure Security Group.

    localized image

  7. On the Step 6: Configure Security Group page, add rules to allow specific traffic to your instance and click Review and Launch.

    localized image

  8. On the Step 7: Review Instance Launch page, review the instance settings and click Launch.

  9. In the Select an existing key pair or create a new key pair dialog box, create a new key pair or select an existing key pair and click Launch Instances.

    localized image

The deployment process might take approximately 10-15 minutes. After the deployment is successfully completed, you can view your Citrix ADM agent virtual machine on your Amazon AWS account.

To manually register the agent by using the 1-Click Launch tab in AWS Marketplace:

  1. Select 1-Click Launch tab and specify values for the following fields:

    1. Version - Version of the Citrix ADM agent.

    2. Region – Specify the region.

    3. EC2 Instance type – Type of the instance. Select one of the available instance types from the available list.

    4. VPC Settings – Select the VPC and the subnet as required.

    5. Security Group – Security groups define the inbound and out bound traffic to your Citrix ADM agent.

      Note: For recommended settings and for the list of ports to be opened for your Citrix ADM agent, see Ports.

    6. Key Pair – You can select the key pair to login to your Citrix ADM agent.

  2. Click Launch with 1-Click.

    localized image

    Once the purchase is confirmed, Amazon AWS deploys the agent, and displays the confirmation summary.

    localized image

    Note

    The deployment process might take approximately 10-15 minutes. After the deployment is successfully completed, you can view your Citrix ADM agent virtual machine on your Amazon AWS account.

  3. Once the agent is deployed, assign a name for your Citrix ADM agent.

  4. Once the agent is up and running, assign an elastic IP address for your Citrix ADM agent.

    Note

    Elastic IP address enables Citrix ADM agent to communicate with Citrix ADM. But, elastic IP address might not be required if you have configured NAT Gateway to route the traffic to the Internet.

  5. Using an SSH client, log on to your Citrix ADM agent using the public IP address.

    Note

    You can log on to Citrix ADM agent virtual machine by using the :

    • Citrix ADM agent user name (nsroot) and the key pair as the password.
    • Citrix ADM agent user name (nsrecover)
  6. Enter the following command to change the password of the Citrix ADM agent after provisioning and follow the directions:

    change_agent_system_password.py
    

    Note: Ensure that the password is not empty. You cannot use the “nsroot” user name to log on to the virtual machine before or after changing the password. But, you can still use the “nsrecover” user name with the new password.and the AMI instance id as the password.

  7. Enter the following command to invoke the deployment screen: deployment_type.py

  8. Enter the Service-URL and the Activation code that you had copied and saved from the Set Up Agents page in Citrix ADM as instructed in Getting Started. The agent uses the service URL to locate the service and the activation code to register with the service.

    localized image

After agent registration is successful, the agent restarts to complete the installation process.

After the agent has restarted, access Citrix ADM and on the Set Up Agent page, under Discovered Agents, verify the status of the agent.

Installing Citrix ADM agent on AWS

In this article