Constructor
new Options()
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
hostname |
string | The dynamic DNS hostname |
||
username |
string | The dynamic DNS username. |
||
password |
string | The dynamic DNS password. |
||
publicIpUrl |
string |
<optional> |
https://domains.google.com/checkip | he HTTP/HTTPS URL used to check the current public IP of the device. The default value uses Google's provided URl but users can override this URL. |
updateIpUrl |
string |
<optional> |
https://domains.google.com/nic/update?hostname=%HOSTNAME%&myip=%IPADDRESS% | The HTTPS URL of the Google DNS API update. Typically this should not change unless Google decides to change the URL or format. |
userAgent |
string |
<optional> |
Nodejs google-ddns | The HTTP header User-Agent to send when updating the IP address. This is required by the Google Dynamic DNS API to identify the dynamic DNS client. |
failOnUnresolvedHostName |
boolean |
<optional> |
false | Indicates whether to fail or keep going during synchronizing if the current host name was not resolved. This typically happens if the domain was created and has not yet been applied or propagated. See TTL (Time-to-Live) for more information. Every though this can fail, the update can sill be successful. |
maxUnresolvedHostNameFail |
number |
<optional> |
3 | This works in conjunction with failOnUnresolvedHostName to make sure we don't keep failing over and over with no error back reporting. |
useHostIPAddressCache |
boolean |
<optional> |
true | Indicates whether to cache and use the last resolved host IP address or resolve every-time. Generally speaking we don't need to resolve the host every-time since it will not change unless we change it. This saves having to do a DNS request every interval. Use the hostIPAddressCacheExpires to do a check every once in a while. |
hostIPAddressCacheExpires |
number |
<optional> |
3600 | If useHostIPAddressCache is set to true, this timer is used to force a host IP address checked/resolution every once in a while rather than never. The time is in seconds and defaults to every hour. |
debug |
boolean |
<optional> |
false | Set the debug mode on or off. The debug mode will write debug and status information to the console. |
runService |
boolean |
<optional> |
true | Defines whether to run the application as a service as a one time call to update the google domain IP address. |
checkInterval |
number |
<optional> |
60 | Used by the service. The amount of time in seconds to wait before checking if the public IP has changed. |
maxConsecutiveErrors |
number |
<optional> |
10 | Used by the service. The maximum number of consecutive errors before stopping the check timer loop. |
exitOnMaxErrors |
boolean |
<optional> |
true | Used by the service. Defines whether to exit process when the max consecutive errors has been reached. |
logPath |
string | boolean |
<optional> |
'./logs.log' | Used by the service. Defines the log output path. Set to false to disable output logs. |
logToConsole |
boolean |
<optional> |
true | Used by the service. Defines whether to log output to the console or not. |
- Source: