IBM Support

Enhancements to setWebServicesServerProperties.sh Qshell command

News


Abstract

Various enhancements to the setWebServicesServerProperties.sh Qshell command.

Content

You are in: IBM i Technology Updates > Welcome to IBM Integrated Web Services for i Technology Updates >  Enhancements to setWebServiceServerProperties.sh Qshell command

What is it?

The setWebServicesServerProperties.sh Qshell command supports the following new parameter:
 
  • -propertiesFile, path to a properties file that contains server properties to be changed. The server properties that can be updated are as follows:
      
    server.iws.gen.httpport=52000  
server.iws.gen.httpsport=52499        
server.iws.gen.adminport=52005          
server.iws.gen.contextroot=/api         
server.iws.gen.defaultkeystore=*NONE    
server.iws.gen.defaultkeystorepassword= 
server.iws.gen.verifyhostname=false     
server.iws.gen.trace=none               
# Following are OpenAPI properties - IWS 3.0 only properties
server.iws.openapi.enable=true 
server.iws.openapi.docpath=/openapi
server.iws.openapi.contactemail=sample_app_support@example.com
server.iws.openapi.contactname=API Support
server.iws.openapi.contacturl=http://www.example.com/sample_app/support
server.iws.openapi.description=Bunch of APIs deployed on IWS 3.0.
server.iws.openapi.licensename=License 2.0 
server.iws.openapi.licenseurl=https://www.example.org/licenses/LICENSE-2.0.html
server.iws.openapi.summary=
server.iws.openapi.termsofservice=http://example.com/sample_app/terms
server.iws.openapi.title=APIs for IWS 3.0
server.iws.openapi.version=1.0.2
server.iws.openapi.excludelist=hiddenService1
Properties in the properties file override parameters specified for the setWebServicesServerProperties.sh command.  
New server properties are the OpenAPI properties that are only applicable to IWS 3.0.  A description of the OpenAPI properties is given in the following table:
Description of OpenAPI properties
Property Description
server.iws.openapi.enable Whether to enable or disable the OpenAPI feature.  Specifying true enables the feature; false disables the feature.  The default is true.
server.iws.openapi.docpath Specifies the URL path for obtaining OpenAPI documents. The URL path must be constructed with  alphanumeric characters A-Za-z0-9, underscore (_), dash (-), forward slash (/), or period (.).  The URL path must end with '/openapi'. The default is /openapi.
server.iws.openapi.excludelist Colon-delimited web service names that are to be excluded from the OpenAPI document.
server.iws.openapi.contactemail Sets the info.contact.email field in the OpenAPI document. This field contains the e-mail address of a contact responsible for the API being documented.
server.iws.openapi.contactname Sets the info.contact.name field in the OpenAPI document. This field contains the name of a contact responsible for the APIs being documented.
server.iws.openapi.contacturl Sets the info.contact.url field in the OpenAPI document. This field contains the URL of a contact responsible for the APIs being documented.
server.iws.openapi.description Sets info.description in the OpenAPI document. This field contains a description of the APIs being documented.
server.iws.openapi.licensename Sets the info.license.name field in the OpenAPI document. This field contains the name of the license for the APIs being documented.
server.iws.openapi.licenseurl Sets the info.license.url field in the OpenAPI document. This field contains a URL at which the full license for the APIs being documented can be found.
server.iws.openapi.summary Sets the info.summary field in the OpenAPI document. This field contains a short summary of the APIs being documented.
server.iws.openapi.termsofservice Sets the info.termsOfService field in the OpenAPI document. This field contains the URL of the terms of service document for the APIs being documented.
server.iws.openapi.title Sets info.title in the OpenAPI document. This field contains the title of the APIs being documented.
server.iws.openapi.version Sets the info.version field in the OpenAPI document. This field contains the version number of the APIs being documented.

Why use it?

Using a properties file increases the number properties that you can set for a web services server.  

Availability

The support is enabled in the following PTFs:

V7R6M0 HTTP Group PTF SF99962 Level 6 or later
V7R5M0 HTTP Group PTF SF99952 Level 25 or later
V7R4M0 HTTP Group PTF SF99662 Level 47 or later

[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"HW1A1","label":"IBM Power Systems"},"Component":"","Platform":[{"code":"PF012","label":"IBM i"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB57","label":"Power"}}]

Document Information

Modified date:
16 October 2025

UID

ibm17248256

Page Feedback