48.11.1smileutil: Module Config Properties Export

The module-config-properties-export command uses the Module Config Endpoint functionality in the JSON Admin Endpoints.

It takes a target URL, optional node ID, base URL and in order to make a call to the module config endpoint and to write the results to an output file.

The command will write output similar to the following for the Master node:

################################################################################
# 	 Master
################################################################################
node.id=Master

################################################################################
# 	 admin_json
################################################################################
module.admin_json.type=ADMIN_JSON
module.admin_json.requires.SECURITY_IN_UP=local_security
module.admin_json.config.cors.origins=*
module.admin_json.config.context_path=/
module.admin_json.config.threadpool.max=10
module.admin_json.config.sessions.timeout.mins=30
module.admin_json.config.threadpool.min=5
module.admin_json.config.sessions.scavenger.interval.millis=60000
module.admin_json.config.port=9000

See Module Config Endpoint for a description of the functionality invoked by this feature.

bin/smileutil module-config-properties-export --target http://my-ip:9000 --output /path/to/export.properties --basic-auth myuser:mypassword --node-id my-node-id

48.11.2Options

• -o [output file] (or --output [output file]) – (required) This required argument tells the tool which file path to write the module properties to, for example /tmp/module-export.properties
• -t [base URL] (or --target [base URL]) – (required) This argument should point to the base URL of the Admin JSON server (e.g., http://localhost:9000). The tool will append the appropriate path to create the full URL (e.g., /module-config/properties or /module-config/{node-id}/properties).
• -b [username:password] (or --basic-auth [username:password]) – (required) If specified, provides a username and password that will be supplied to the server in an HTTP Basic Authorization header in the form of "username:password". If the value supplied is "PROMPT", smileutil will prompt the user to enter credentials interactively.
• --tls-auth [keystore-path]:[keystore-password]:[truststore-path]:[truststore-password] – (optional) If specified, provides TLS authentication credentials for secure connections. This is particularly important for production environments requiring certificate-based authentication.
• -n [node ID] (or --node-id [node-id]) – (optional) This optional argument tells the tool which Node ID to use. When specified, the tool will append /module-config/{node-id}/properties to the base URL; otherwise, it will use /module-config/properties.