Skip to content

REST API server

This function allows you to update the values used by ZMF REST API server.

Select option E, REST, on the Update Global Administration Options menu (CMNGAMN1). The REST API Server (CMNGRS01) panel is displayed.

CMNGRS01                         REST api server  
Command ===>     

        Server procedure . . SERDTCI 
                 address . . d001.microfocus.com 
                    port . . 08085 
                 context . . zmfrest 

        http send time-out . . 2 
        http recv time-out . . 2   

    Enter / to select option 
    _ Issue start command for procedure?   
    _ Server active?   
    _ Poll for server using http?

    _ Apply saved admin settings

This panel enables you to maintain the values used by the ZMF REST API server.

To save all changes and leave this panel use PF3/end. To discard all changes and leave use the CANCEL primary command. ENTER redisplays the panel with the same values; nothing is saved.

Field Description
Server procedure The name of the cataloged procedure which is used by ZMF to start the Tomcat started task which will host the REST API server.
address The DNS name or IP address of the server.
port The port number on which the server is listening.
context The context used by the REST API servlet running in the server address space. The default is zmfrest.
http send time-out The send time out value (in seconds) applied to connections from internal ZMF functions to the REST API server. The range is 1 - 2678400. The default is 2 seconds.
http recv time-out The receive time out value (in seconds) applied to connections from internal ZMF functions to the REST API server. The range is 1 - 2678400. The default is 2 seconds.
Issue start command for procedure? Select this option to have ZMF issue the start command for the Tomcat procedure. If the REST API server is required to be active, ZMF will issue the start command during initialization if it cannot detect the presence of the relevant servlet.
The same is true should these admin definitions be applied 'in-flight'.
Only select this option if you wish to run your Tomcat started task on the same LPAR as this ZMF instance.
Server active? Select this option to activate REST server support within this ZMF instance. Turning this on will prompt ZMF to fill in relevant ISPF skeleton and HLLX REXX variables supporting the event emission processes. It will also cause ZMF to actively look for the presence of the relevant Tomcat-hosted REST servlet.
Poll for server using http? Select this option to require ZMF to issue http requests to detect the presence of the REST server. The default detection process is through a sysplex-wide enqueue mechanism, which is more efficient than using http. However, if your Tomcat started task is not running on the local sysplex, the http mechanism must be used.
Apply saved admin settings Select this option to request that the dialog use the REFRESH service to take the actions needed to apply the settings (for example, start the server) as required.

...