Configuring the gateway


The BMC AMI Enterprise Connector for Venafi (EC for Venafi) gateway supports transactions driven by the Venafi Trust Protection Platform (TPP). The gateway is responsible for distributing the TPP transactions to the target mainframe system for processing by an agent.

To set up your gateway, you must configure the following statements:


Global statement

The following global parameters define general functionality:

Parameter

Description

MessageLevel level level

Message level written to SYSPRINT

You can define multiple message levels.

We recommend that you include message level Info Error.

Activate appName

Name of the application to be loaded

The value of this parameter must be Venafi.


Example

MessageLevel     Info Error
Activate         Venafi

ECGateway statement

The following ECGateway parameters define the REST API server for the gateway instance. Only one ECGateway statement is required per instance.

Parameter

Description

ECGateway

Begins the ECGateway statement

HostName hostName | IPaddress

(Required) Location of the gateway instance

Enter the host name or IP address for the server on which the gateway is located.

Port portNumber

(Required) Port number of the gateway instance

Enter the port number that the server uses for the gateway.

RequestTimeout seconds | hours

Number of seconds or hours after which agent requests from this gateway are abandoned

Transactions that are not completed within this time period stop with a timeout error message. 

The default value is 120 seconds.

TLSAware Yes | No

Verifies whether incoming transactions have been secured by a valid AT-TLS policy

Transactions that are flagged as insecure or not having an AT-TLS policy are rejected.

The default value is No.

TPPHostName tppName | tppIPaddress

(Optional) Host name or IP address of the TPP client instance from which TPP transactions are expected to arrive

Transactions arriving from other hosts are rejected.

You can define multiple TPP client instances.

Encoding ASCII | UTF8

Encoding used for incoming requests from the REST API

The default value is ASCII.

GatewayId gatewayID

Name that the logging reports should use to identify the gateway from which a specific request is received

EndECGateway

Ends the ECGateway statement

Example

***********************************************     
* Define TPP Gateway                          *     
***********************************************     
ECGateway                                           
   HostName             SYSA              
   Port                 4000                        
   RequestTimeout       120 seconds                 
   TLSAware             Yes
   TPPHostName          TPPProdSystem
   GatewayId            SystemA                      
EndECGateway

TargetEnvironment statement

The following TargetEnvironment parameters define the environment (LPAR) in which an EC for Venafi agent is running. You can use multiple statement blocks to define multiple agent environments.

Parameter

Description

TargetEnvironment envName

(Required) Name of the environment

Enter the name of the environment in which the agent is located. The value specified for TargetEnvironment must match the value specified for the target environment in the definition of the TPP application that sends certificates to the agent. 

HostName hostName | IPaddress

(Required) Location of the agent instance

Enter the host name or IP address for the server on which the the agent is located.

Port portNumber

(Required) Port number of the agent instance

Enter the port number that the server uses for the agent.

EndTargetEnvironment

Ends the TargetEnvironment statement

Example

***********************************************     
* Define Target Environment                   *     
***********************************************     
TargetEnvironment       PROD                                  
   HostName             SYS1              
   Port                 4000                        
EndTargetEnvironment    
TargetEnvironment       TEST                                  
   HostName             SYS2              
   Port                 4000                        
EndTargetEnvironment    
TargetEnvironment       DEV                                  
   HostName             SYS3              
   Port                 4000                        
EndTargetEnvironment


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*