Back to Lego

IBM Cloud (SoftLayer)

docs/content/dns/zz_gen_ibmcloud.md

4.35.21.9 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/ibmcloud/ibmcloud.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for IBM Cloud (SoftLayer).

<!--more-->
  • Code: ibmcloud
  • Since: v4.5.0

Here is an example bash command using the IBM Cloud (SoftLayer) provider:

bash
SOFTLAYER_USERNAME=xxxxx \
SOFTLAYER_API_KEY=yyyyy \
lego --dns ibmcloud -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
SOFTLAYER_API_KEYClassic Infrastructure API key
SOFTLAYER_USERNAMEUsername (IBM Cloud is {accountID}_{emailAddress})

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
SOFTLAYER_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
SOFTLAYER_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
SOFTLAYER_TIMEOUTAPI request timeout in seconds (Default: 30)
SOFTLAYER_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 120)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/ibmcloud/ibmcloud.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->