Install 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 a 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 a 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 AWS credentials.

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

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

  4. On the ADM External Agent AMI page, click Continue to Subscribe.

    ADM external agent

  5. After the subscription is successful, click Continue to Configuration.

    Continue configuration

  6. On the Configure this software page:

    1. Select the AMI from the Fulfillment option list.

    2. Select the latest Citrix ADM agent version from the Software Version list.

    3. Select your region from the Region list.

    4. Click Continue to Launch

      Continue to launch

  7. On the Launch this software page, you have two options to register the Citrix ADM agent:

    1. Launch from Website

    2. Launch with EC2

      Launch with EC2

Launch from a Website

To launch from a Website, select:

  1. An EC2 instance type from the EC2 Instance Type list

  2. A VPC from the VPC Settings list. Click Create a VPC in EC2 to create a VPC for your software.

  3. A Subnet from the Subnet Settings list. Click Create a subnet in EC2 to create a subnet after you selected the VPC.

  4. A security group for the firewall from the Security Group Settings list. Click Create New Based On Seller Settings to create a security group.

  5. A key pair to ensure access security from the Key Pair Settings list. Click Create a key pair in EC2 to create a key pair for your software.

  6. Click Launch

    Launch a website

  7. The launch from a Website is successful.

    Launch from a website is successful

    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 AWS account.

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

  9. 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, an elastic IP address might not be required if you have configured NAT Gateway to route the traffic to the Internet.

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

    Note

    You can log on to the Citrix ADM Agent using one of the following ways:

    • Use nsrecover as the user name and AWS instance ID as the password.

    • Use nsroot as the user name and a valid keypair as the password.

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

  12. 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.

    ADM service deployment

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.

Launch with EC2

To launch with EC2, select Launch through EC2 from the Choose Action list, and then click Launch.

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

    Configure instance details

  2. On the Step 3: Configure Instance Details page, specify the required parameters, and 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. 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 an elastic IP address is required when NAT Gateway is not configured. If you have not set the elastic IP address in this step, you can always do it on the EC2 console. You can create a new elastic IP address and associate that with the Citrix ADM Agent using the instance ID or ENI-ID.

    registeragent -serviceurl <apigatewayurl> -activationcode <activationcodevalue>
    
    

    Configure instance details

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

    Add tags

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

    Configure security group

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

    Review and launch

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

  7. 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, accept the acknowledgment, and click Launch Instances.

    Launch instances

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 AWS account.