The configuration file is in ini format. See the example provided in the repository. Here are explanations for each section and variable:
- [CHECK]
- HOST
- The host URL you are checking.
- HOST
- [VALIDATION]
- RETURNCODE
- What you expect the return code to be.
- SSLVALID
- If you wish to report failure if certificate is invalid or nonexistant.
- 0 – Do not report if SSL/TLS certificate is invalid.
- 0 – Do not report if SSL/TLS certificate is nonexistant (http).
- 1 – Report if SSL/TLS certificate is invalid or nonexistant (http).
- SSLEXPIRYREMINDER
- How many days before SSL/TLS certificate expires to notify.
- RETURNCODE
- [REPORTING]
- LOGFILE
- Location of the logfile.
- Relative to where you execute the PingLite command or fully qualified path required.
- Does not log to a file when –silent flag is used.
- RESULTS
- Location of results file to track info between runs.
- Relative to where you execute the PingLite command or fully qualified path required.
- METHOD
- Reporting Options:
- NONE – STDOUT only. Default
- RETCODE – Returns 1 on failure of program or validation.
- See logs or STDOUT for failure reason.
- API – Sends API call based on configured information.
- Reporting Options:
- SSLEXPIRYSNOOZE
- How many days to wait to remind you about SSL/TLS certificate expiring.
- ALERTSNOOZE
- How many minutes after prior alert to realert you of failure.
- LOGFILE
- [API] – Only needed if [REPORTING]METHOD is API.
- URL
- URL to send API alert to.
- HEADERS
- Headers of the API call.
- PAYLOAD
- The JSON payload file you wish to send.
- See PAYLOAD configuration example.
- URL