Available Ant Targets

Ant Targets available in the enterprise_healthcheck_build.xml build file, are explained in this section.

Main Targets

Main targets help you pick and choose what TIBCO ActiveMatrix entities to run Enterprise Deployment Health Check against. You must pick one of these targets to run Enterprise Deployment Health check.
Target Name (abbreviated names in parenthesis) Description
health.ent (he)
  • Runs Enterprise Deployment Health Check for the entire TIBCO ActiveMatrix Enterprise in which all the Nodes and Hosts will participate. If no other “options” targets were used, information about machines, JVM, TIBCO JVM is collected, for all Nodes and Hosts. Also deploys sample application across all Nodes in the Enterprise.
  • This is the default Ant target option.
health.envs (hes)
  • Runs Enterprise Deployment Health Check across all Nodes in given ActiveMatrix Environment.
  • You can specify names of Environments in the enterprise_healthcheck_data.xml file.
health.hosts (hhs)
  • Runs Enterprise Deployment Health Check across all Nodes managed by given TIBCO ActiveMatrix Host.
  • You can specify names of Hosts in the enterprise_healthcheck_data.xml file.
health.nodes (hns)
  • Runs Enterprise Deployment Health Check for all Nodes and their Hosts.
  • You can specify names of Nodes in the enterprise_healthcheck_data.xml file.

Options Targets

Options targets helps you decide what kind of operation to perform.
Target Name (abbreviated names in parenthesis) Description
get.adminMetaData (gamd)
  • When Enterprise Deployment Health Check is run with this “Options” target, it collects Metadata of TIBCO ActiveMatrix Administrator.
  • When you run a main target, this option is used by default.
  • If you want to get only the Metadata of TIBCO ActiveMatrix Administrator, Enterprise Deployment Health Check should be run with this option along with the main target: health.ent.
get.adminInfo (gai)
  • When Enterprise Deployment Health Check is run with this “options” target, it collects the runtime configuration information of TIBCO ActiveMatrix Administrator.
  • When you run a main target, this option is used by default.
  • If you want to get only the runtime configuration information of TIBCO ActiveMatrix Administrator, Enterprise Deployment Health Check should be run with this option along with the main target: health.ent.
  • If you run Enterprise Deployment Health Check with this option and other main targets such as health.envs, health.nodes, or health.hosts, the summary report created will only be filtered based on the TIBCO ActiveMatrix Entities (Environments, Nodes, and Hosts) specified in the enterprise_healthcheck_data.xml file.
get.adminHostInfo (gahi)
  • When Enterprise Deployment Health Check is run with this “options” target, it collects the runtime configuration information of Hosts and Nodes, in addition to all the information collected as a part of the get.adminInfo target.
  • When you run a main target, this option is used by default.
  • If you want to only get the runtime configuration information of TIBCO ActiveMatrix Administrator in conjunction with runtime information of certain Hosts and Nodes, Enterprise Deployment Health Check should be run with this option along with the main targets: health.envs, health.nodes, or health.hosts.
do.ping (dp)
  • When Enterprise Deployment Health Check is run with this “options” target it pings all the TIBCO ActiveMatrix Entities (Hosts and Nodes).
  • When you run a main target, this option is used by default.
  • If you want to only ping certain Hosts and Nodes, Enterprise Deployment Health Check should be run with this option along with the main targets: health.envs, health.nodes, or health.hosts.
test.deploy (td)
  • When Enterprise Deployment Health Check is run with this “options” target, it runs a test deployment (deploy a Sample Application and then undeploy it) on all the Nodes.
  • When you run a main target, this option is used by default.
  • If you want to only perform test deployment on certain Hosts and Nodes, Enterprise Deployment Health Check should be run with this option along with the main targets: health.envs, health.nodes, or health.hosts.

Report Targets

Report targets help you set various options for the generation of the report file.
Target Name (abbreviated names in parenthesis) Description
report.none (rn) When Enterprise Deployment Health Check is run with this option, no report file is created at the end of health check execution.
report.JSON (rj) When Enterprise Deployment Health Check is run with this option, the report file created at the end of health check execution is in JSON format.
report.XML (rx) When Enterprise Deployment Health Check is run with this option, the report file created at the end of health check execution is in XML format (the XSD Schema for this XML report can be found in TIBCO_HOME/administrator/<version>/samples/EnterpriseHealthCheck/reportSchema).
Note:
  • Abbreviated target names are also valid targets. For example, you can use "dp" to invoke the "do.ping" target. In the above tables, abbreviated target names are mentioned in parenthesis.
  • You can get the same information as above while running Ant script, via the help target. That is: 
    ant -f enterprise_healthcheck_build.xml help
  • By default, the report is created in the same directory as the location from where Enterprise Health Check Ant script is executed. To change this, you can edit the AMXAdminTask “options” in the enterprise_healthcheck_build.xml file and update the reportDir attribute to include the required directory for the report.
  • By default, Enterprise Deployment Health Check is enabled for the TIBCO ActiveMatrix Enterprise. You can disable Enterprise Deployment Health Check by setting the TRA property com.tibco.amx.admin.deployment.HealthCheck to false in the SystemNode TRA file followed by SystemNode restart: 
    java.property.com.tibco.amx.admin.deployment.HealthCheck=false
    If the TIBCO ActiveMatrix Administrator is replicated, the TRA property must be set in both the SystemNode TRA files and both SystemNodes must be restarted.