dyndns¶
ibox.dyndns in the library, ibox dyndns in the CLI.
Dynamic DNS configuration and registered hosts.
set_enabled ¶
Turn DynDNS on or off for all hosts at once, including Swisscom's.
While it's off, the router doesn't update any host name when its public IP address changes: their "status" in hosts() is "BLOCKED". Each host keeps its own switch ("enable" in hosts()), and turning DynDNS back on updates the hosts that are on right away.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
enable
|
bool
|
True to turn DynDNS on, False to turn it off. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
response content |
set_host ¶
Register a host name with a dynamic DNS service, or change it, like the web UI's DynDNS settings.
The router then keeps the host name pointing to its public IP address. A host with the same service or the same host name is replaced: the router has one host per service. Other hosts stay, including Swisscom's. The web UI only shows one host besides Swisscom's.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
service
|
str
|
one of services() except "Swisscom", e.g. "No-IP". |
required |
hostname
|
str
|
host name registered with the service, e.g. "myhome.ddns.net". |
required |
username
|
str
|
account name at the service, up to 63 characters. |
required |
password
|
str
|
account password, 12 to 63 characters. |
required |
enable
|
bool
|
whether the router keeps the host name up to date. Default is True. |
True
|
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
response content |
Raises:
| Type | Description |
|---|---|
ValueError
|
if a value would be refused by the web UI, or the router doesn't add the host. A host that was to be replaced is then put back. |
delete_host ¶
Delete a DynDNS host added in the web UI or with set_host(). Swisscom's host stays.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hostname
|
str
|
host name, as listed by hosts(). |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
response content |