Back to Lego

Efficient IP

docs/content/dns/zz_gen_efficientip.md

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

Configuration for Efficient IP.

<!--more-->
  • Code: efficientip
  • Since: v4.13.0

Here is an example bash command using the Efficient IP provider:

bash
EFFICIENTIP_USERNAME="user" \
EFFICIENTIP_PASSWORD="secret" \
EFFICIENTIP_HOSTNAME="ipam.example.org" \
EFFICIENTIP_DNS_NAME="dns.smart" \
lego --dns efficientip -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
EFFICIENTIP_DNS_NAMEDNS name (ex: dns.smart)
EFFICIENTIP_HOSTNAMEHostname (ex: foo.example.com)
EFFICIENTIP_PASSWORDPassword
EFFICIENTIP_USERNAMEUsername

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
EFFICIENTIP_HTTP_TIMEOUTAPI request timeout in seconds (Default: 10)
EFFICIENTIP_INSECURE_SKIP_VERIFYWhether or not to verify EfficientIP API certificate
EFFICIENTIP_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
EFFICIENTIP_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
EFFICIENTIP_VIEW_NAMEView name (ex: external)

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" %}}).

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