You can install an agent on a target machine using a script.


  • Complete all the prerequisites. For more information, see Prerequisites.
  • The unzip package must be available on the target machine.
  • The user must have access permissions to the download folder.
  • Windows PowerShell must be >= 5.0.
  • The guest IP must be properly configured and is unique across vCenter Servers. If more than one VM is managed by the vCenter Server cloud account with the same IP is monitored, the script cannot resolve and subscribe to application monitoring.
  • Note: This prerequisite is applicable only to the VMs managed by the vCenter Server cloud account. For more information about object types, see OS and Application Monitoring.
  • The VM managed by the vCenter Server cloud account must be available in VMware Aria Operations.
    Note: This prerequisite is applicable only to the VMs managed by the vCenter Server cloud account.
  • The cloud account must be configured for the vCenter Server to which the VM belongs.
    Note: This prerequisite is applicable only to the VMs managed by the vCenter Server cloud account.
  • Port 443 in VMware Aria Operations must be accessible to the target machine.
  • The VMware Aria Operations user must have the following permissions:
    • Administration > REST-APIs > All other Read, Write APIs
    • Administration > REST-APIs > Read access to APIs
    • Environment > Applications > Manage Telegraf Agent
    • Environment > Actions > Bootstrap virtual machines
    • Environment > Actions > Download bootstrap
    Note: To check permissions navigate to Administration > Access Control > Roles, select the role to which the user is assigned. You can view the permissions on the right side at the end of the page.
  • Only IPv4 is supported at present for cloud proxy.
  • VMTools version must be >=10.2.
    Note: Applicable only to VMs managed by the vCenter Server cloud account.


  1. Log in to the target machine on which you want to install/uninstall the agent and download the sample script from cloud proxy from the following location: https://<CloudProxy>/downloads/salt/ telegraf-utils.ps1

    If the script download fails with the following message: The request was aborted: Could not create SSL/TLS secure channel, follow the steps mentioned in Script Download Fails on a Windows Platform.

    Run one of the following commands:
    PowerShell command:
    Invoke-WebRequest "https://<CloudProxy>/downloads/salt/telegraf-utils.ps1" -OutFile telegraf-utils.ps1
    Or if you have the wget tool:
    wget --no-check-certificate https://<CloudProxy>/downloads/salt/telegraf-utils.ps1
    Note: Use the relevant cloud proxy IP address for <CloudProxy> in the preceding commands and location specified. For application monitoring high availability activated collector groups, provide the virtual IP.
  2. To execute the script and install/uninstall the agent, run the following command:
    telegraf-utils.ps1  product-managed -c cloud_proxy_ip_or_collector_group_name -t token (-v vmwareariaoperations_ip_or_fqdn | [-g gateway_url -a csp_auth_url]) [-d download_tmp_dir -s sleep_seconds -i list_of_IPs -o operation]
    Description of arguments:
          -c : [REQUIRED] cloud_proxy_ip_or_collector_group_name - Cloud Proxy IP or Collector Group Name
          -t : [REQUIRED] token - This can be user_saas_refresh_token or on-prem vmwareariaoperations_auth_token.
                on-prem: Auth Token of the user/account. For getting new token
                         ( https://<VMwareAriaOperations_IP>/suite-api/ or curl -ks -X POST https://<VMwareAriaOperations_IP>/suite-api/api/auth/token/acquire -H \"Content-Type: application/json\" -H \"Accept: application/json\" -d \"{\"username\":\"<VMwareAriaOperations_USER>\",\"password\":\"<VMwareAriaOperations_USER_PASSWORD>\"}\")
          -d : [OPTIONAL] download_tmp_dir - Temporary directory for agent installation. Default: current directory
          -v : [CONDITIONAL] [ON-PREM-SPECIFIC] vmwareariaoperations_ip_or_fqdn - IP/FQDN of VMware Aria Operations master node and required for on-prem.
          -o : [OPTIONAL] operation - The type of operation to be performed {install,uninstall} Default: install
          -s : [OPTIONAL] sleep_seconds - Time (in seconds) to delay the script execution. This optional parameter will be helpful when this script is used in vRA to have agent installed on deploying VM. Recommended time 600 seconds.
          -i : [OPTIONAL] list_of_IPs - This is an optional parameter. Comma separated IPs that are set as properties of a VM in VMware Aria Operations (VM -> Properties -> Network -> <Integer> -> IP Address). If single adapter has multiple IP Addresses, then delimit them using '_'
                        ex:- If your VM has 3 adapters with IP Address as follows: Adapter1: Adapter2: & Adapter3:
                        Then this parameter should be given as ",,"
    Example: .\telegraf-utils.ps1 product-managed -t 8dab02cc-277c-4383-b910-bd2e89c7e741::8bcde100-6318-44d7-a8dc-11f4ff84b3b -v -c
    Note: The -c argument is mandatory to run the helper script.
    Note: Do not use a space in the configuration path. Paths with spaces can be passed as a short name notation, such as  c:\PROGRA~1 for  c:\Program Files.

    To verify the bootstrap status, view the uaf-bootstrap-results file. If the installation fails, look for error messages in uaf_bootstrap.log.

    If the script is successful, the agent status will be updated in the Manage Telegraf Agents tab after one collection cycle that takes 5–10 minutes.

    Note: When you use an automation script, concurrent agent installation with a batch size of 20 is supported.