Install or remove the Citrix Smart Tools Agent

To manage your servers using Citrix Smart Tools, the Citrix Smart Tools Agent must be installed on each server you want to manage. You can have Smart Tools install the agent on new servers in your resource location or you can install the agent manually on existing servers you want Smart Tools to manage. 

Contents

Install the agent automatically

When you deploy a blueprint that provisions servers in a public or private cloud resource location, Smart Tools installs the agent automatically on the Windows or Linux servers that it provisions in the resource location. 

Note: You must provide the credentials that enable access to each server, such as a username and password or key pair. If using key pairs (as Amazon EC2 does), you must upload the private key (.pem) file associated with the machine. Typically, you supply the private key file when you configure the blueprint's deployment details. By default, the auto-installer attempts to log in to your machine as "ec2-user." If your Amazon EC2 server has a different username, you must specify the username in the field provided.

Port requirements for automatic installation

Smart Tools automatically installs the agent on Linux servers over inbound port 22 (SSH) and on Windows servers over inbound port 3389 (RDP). Therefore, you must set network rules to allow access over one of these ports. After the agent is installed, all further communication between the server and Citrix Smart Tools occurs over outbound HTTPS (port 443) only. So, you can block the installation port, if desired.

Note: For Amazon EC2 resource locations, configuring security groups with an inbound port is not necessary as Smart Tools uses the EC2 API to install the agent. However, configuration for outbound communication over port 443 is still required.

Automatic Agent installation on Citrix XenServer provisioned VMs

The following settings are required to enable automatic installation of the Smart Tools Agent on Citrix XenServer provisioned machines:

  • If you are using a Windows machine as a connector, ensure that Windows Management Instrumentation (WMI) and inbound connections on TCP port 135 (DCOM port) are enabled on your Windows VM template. This enables Smart Tools to install the Smart Tools Agent on the machines that are provisioned from the VM template.To enable WMI traffic through Windows Firewall:
  1. Select Start > Control Panel > System and Security > Windows Firewall
  2. Click Advanced settings. The Windows Firewall with Advanced Security console appears.
  3. In the left pane, click Inbound Rules.
  4. Select the following rules, right-click, and select Enable Rule:
    • Windows Management Instrumentation (Async-In)
    • Windows Management Instrumentation (DCOM-In)
    • Windows Management Instrumentation (WMI-In)
    wmi.png
  • If you are using a Linux machine as a connector, ensure that Remote Desktop Services and inbound connections on TCP port 3389 are enabled on your Windows VM template.

Back to top

Install the agent manually

You can download and install the agent manually on servers as needed. Manually installing the agent is required if you intend to use the server as a connector between your resource location and Smart Tools. For more information about using servers as connectors, see Agent and connector requirements

  1. Log on as an administrator user of the machine on which you want to install the agent.
  2. Log on to the Smart Tools web site using your account credentials.
  3. From the home page, click Resources & Settings.
  4. From the Resource Locations page, click Add Resource Location.
  5. Select the hypervisor or cloud in which the machine resides and with which the agent will communicate. Click Next.
  6. Select the machine operating system and bitness (32-bit or 64-bit), if applicable, and click Download Agent. When prompted, save the agent package to your computer.
  7. Install the agent: 
    • On Windows 32-bit and 64-bit operating systems: Locate the CitrixLifeCycleManagementAgent.exe file and double-click it to launch the installation. Click Run when prompted and accept the End User Licensing Agreement. Click Install
    • On Ubuntu, Debian, Redhat, CentOS, and Fedora 32-bit and 64-bit operating systems: execute the following commands:
      # sudo chmod u+x citrix-lifecycle-management-agent.bin
      # sudo ./citrix-lifecycle-management-agent.bin

After installation, the agent registers the machine with Smart Tools. Additionally, Smart Tools sends you an email message notifying you that the machine is registered. 

If you intend to specify the machine as a connector, click Next to continue setting up the resource location. For more information about setting up a resource location, see the Resource locations section. If you do not intend to make the machine a connector in your resource location, click Cancel to return to the Resource Locations page.

Back to top

Remove the agent

When you install the agent on a server, the agent registers with Smart Tools. This is the method by which Smart Tools becomes aware of servers that are available for management. When you remove the agent from a server, the agent signals Smart Tools to deregister the server and, therefore, to stop managing it.  

To remove the agent from machines running Windows operating systems

  1. From the Control Panel, under Programs, click Uninstall a program. The Programs and Features list of applications appears.
  2. Select Citrix Smart Tools Agent and click Uninstall. When prompted to confirm, click Yes.

To remove the agent from machines running Linux operating systems

Use the following commands to remove the Smart Tools Agent from Linux machines: 

Linux Distribution Uninstallation Commands
Unbuntu, Debian
sudo dpkg -P citrix-lifecycle-management-agent 
sudo rm -rf /opt/citrix
Redhat, CentOS, Fedora
sudo rpm -e citrix-lifecycle-management-agent 
sudo rm -rf /opt/citrix

Back to top

Troubleshooting

If Smart Tools does not register your server after installing the agent, ensure that the appropriate ports on your server are opened to allow Smart Tools to communicate with it. On Linux operating systems, this is port 22; on Windows operating systems, port 3389 (RDP). These ports are needed only to allow the agent to register the server with Smart Tools. After registration, these ports can be closed and the agent will communicate with Smart Tools on port 443 (HTTPS). 

If removing the agent from your Windows server fails, ensure the Citrix Smart Tools service is stopped and then retry the removal. 

If you continue to experience problems, you can contact Citrix Support for troubleshooting assistance. The Citrix Support team might request a copy of the agent log files to determine the problem. For more information about submitting these log files for troubleshooting, see Share debug log files with Citrix Support

 

0 Comments