CP_ENDPOINT

Systemwide variable that allows you to define where to reach the communication processes (CP).

Important! This variable is relevant only if a non-TLS/SSL Agent, such as BS2000, NSK, OS/400, VMS and z/OS, uses a third party load balancer to connect to an Automation Engine instance in a container-based environment.

The CP endpoint to be used can be defined using the CP_ENDPOINT parameter in the system settings and in the cp= parameter of the [TCP/IP] section of the configuration (INI) file of the relevant Agent. You can define more than one CP address by separating them with a semicolon. You cannot use a port number more than once, so make sure that you define different port numbers.

Example

host:2217;host:2218;host:2219

When an Agent starts using the value defined in the cp= parameter, it receives all entries from the CP_ENDPOINT variable and stores the information in the CP_LIST section of its configuration (INI) file. The Agent can then select an available endpoint from the list the next time it starts or reconnects to the Automation Engine.

If the CP_ENDPOINT is left empty or is not available in the UC_SYSTEM_SETTINGS variable and a non-TLS/SSL Agent tries to connect to a CP, this CP sends a list of all CPs available to the connecting Agent. In this case, the CP checks if the ports are unique in the system.

If the CP_ENDPOINT points to the location of only one load balancer, the CP sends this location to the connecting Agent. However, if the CP_ENDPOINT points to more than one load balancer, the CP sends the location of all the load balancers available to the connecting Agent. The Agent stores this information in the CP_LIST section of its configuration (INI) file. The Agent can then select an available endpoint from the list the next time it starts or reconnects to the Automation Engine. In these cases, the CP does not check if the CP ports are unique in the system.

  • Restart required:

    You have to restart the communication processes (CPs) if:

    • the CP_ENDPOINT variable is defined for the first time or is deleted

    • you want to start all communication processes (CPs) with the same port number

    You do not have to restart the communication processes (CPs) if:

    • you have an Automic Automation Kubernetes Edition deployment

    • you are only changing a port number that was already defined or adding additional ports to the variable definition. However, if you change the port definition, make sure that the change is reflected in the configuration (INI) file of the relevant Agent.

See also: