Adding a TIBCO Host

GUI

Note: The Create and Register actions are separated in the GUI. The GUI only allows creation of a new Host. This Host does not try to bind to an unbound Host. For example, assume there was an unbound host with a managementURL 'x'. Prior to this release, if managementURL 'x' was provided while creating a new host, a Bind operation was invoked. Starting with this release, if managementURL 'x' is provided while creating a new host, it results in the creation of an entry in the TIBCO ActiveMatrix Administrator database. However, when an install/start operation is attempted, it results in a failure either due to port number conflict or same name folder validation.
  1. Select Infrastructure > Hosts.
  2. Click New.
  3. Specify the values in the following fields and click Save. The host is added to the Hosts list in the Not Installed State.
Field Description
Name (Required) Name of the TIBCO Host instance being added. The name assigned to a TIBCO Host must be unique in TIBCO ActiveMatrix Administrator.
Description and Contact (Optional) The description and contact text that is displayed in TIBCO ActiveMatrix Administrator GUI.
ManagementURL (Required) A JMX URL that TIBCO ActiveMatrix Administrator uses to contact the host (after it is running). The port must be free on the remote machine where the TIBCO Host instance is to be created.
When a machine is selected from the Machine drop down list, the next available port number on that machine is displayed in the ManagementURL field. The URL is of the format:
service:jmx:jmxmp://<machine_name>:<port>
Ports used by installed entities are checked and then a port number is displayed based on its availability.
  • If an entity is installed, the port is not considered as available.
  • If an entity is created (but not installed), the port is considered as available and is displayed in the ManagementURL field.
SourceHost (Optional) Source TIBCO Host for the host being created. If the source TIBCO Host is not specified, TIBCO ActiveMatrix Administrator inspects the ManagementURL, extracts the machine name from the URL, and finds any TIBCO Host that is known to be running on the same machine and uses that as the source TIBCO Host. If none are available, an error is reported.
Bind IP (Optional) IP address of the network interface that the TIBCO Host instance should listen on. A typical value is "0.0.0.0" which means listen on all network interfaces on the machine. When not specified, the value is inherited from the Source TIBCO Host at install action.
Assign To Environments The default selection is Assign this Host to all Environments. After you click on Assign this Host to specific Environments, it opens a new dialog box where you can select environments.
Note: The CLI has All or None options whereas the GUI enables you to assign the Host to Specific Environments as well.
Install as Windows Service (Optional)

(Microsoft Windows only) Installs the Host process as a Windows Service, enabling the operating system to manage the life-cycle of the Host. You can do this using the Services panel of Windows.

CLI

Example of data.xml

<Host 
   name="SecondHost"
   description="Description for SecondHost"
   contact="Owner contact
   managementUrl="service:jmx:jmxmp://localhost:36923" assignToEnvs="ALL">
   bindIP="0.0.0.0"
   hostType="TibcoHost"
   assignToEnvs="ALL"
   username="not_used"
   password="not_used" 
   windowsService="true"
   secure="false"
   sourceHost="SystemHost"
/Host>

Attributes

Attribute Required/Optional Description
name Required Name of the TIBCO Host instance being added. Name assigned to a TIBCO Host must be unique in TIBCO ActiveMatrix Administrator.
description and contact Optional A description and contact text that is displayed in TIBCO ActiveMatrix Administrator GUI.
managementUrl Required A JMX URL that TIBCO ActiveMatrix Administrator uses to contact the host (after it is running). The port must be free on the remote machine where the TIBCO Host instance is to be created.
bindIP Optional IP address of the network interface that the TIBCO Host instance should listen on. Typical value is “0.0.0.0” which means listen on all network interfaces on the machine. When not specified, the value is inherited from the Source TIBCO Host at install action.
hostType Required Must be set to value “TibcoHost”.
assignToEnvs Optional ALL or NONE. Controls whether this host is assigned to all ActiveMatrix logical environments or none.
username and password Required Currently unused fields whose value is ignored.
windowsService Optional

Installs the Host process as a Windows Service, enabling the operating system to manage the life-cycle of the Host. You can do this using the Services panel of Windows.

secure Optional Must be “false” while adding a new TIBCO Host.

Example of build.xml

<AMXAdminTask action="add" objectSelector="Host" /> 

Dual Purpose "add" Action

The add action is used to register a TCT-created TIBCO Host instance with TIBCO ActiveMatrix Administrator and also used to create a logical entry for a new TIBCO Host (that does not yet exist).

TIBCO ActiveMatrix Administrator differentiates these two cases using a Management URL test.

In the add action, you specify a Management URL. If the URL is reachable, the action proceeds to register the TIBCO Host instance. Otherwise, only a logical entry for a new TIBCO Host instance is added to the database.

State of a Newly Added TIBCO Host Instance

In the TIBCO ActiveMatrix Administrator GUI, a newly added TIBCO Host instance appears with state Not installed, empty values for Machine name, Operating System, and Action History. The values populate after the install action executes.