8,949
edits
Changes
Template:Networking tswos manual dhcp (view source)
Revision as of 09:49, 13 October 2023
, 09:49, 13 October 2023Created page with "{{Template: Networking_rutos_manual_fw_disclosure | fw_version ={{Template: Networking_rutos_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }} __TOC__ ==..."
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
__TOC__
==Summary==
The <b>DHCP</b> page is used to to set up DHCP settings, which are used to connect device with external networks.
This manual page provides an overview of DHCP page in {{{name}}} devices.
==Server Settings==
A <b>DHCP</b> (<b>Dynamic Host Configuration Protocol</b>) server is a service that can automatically configure the TCP/IP settings of any device that requests such a service. If you connect a device that has been configured to obtain an IP address automatically, the DHCP server will lease out an IP address from the available IP pool and the device will be able to communicate within the private network.
[[File:Networking_rutx_manual_lan_static_dhcp_server_scheme_v1.png]]
To <b>Add add new DHCP server</b> select interface and press 'Add' button.
[[File:Networking_tswos_manual_dhcp_server_settings_add_button.png|border|class=tlt-border]]
You will be redirected to DHCP server settings:
===General Setup===
The <b>General Setup</b> section is used to set up the main operating parameters of the DHCP server.
[[File:Networking_tswos_manual_dhcp_server_settings_general_setup.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable DHCP</td>
<td>Enable {{!}} Disable {{!}} Relay<span class="asterisk">*</span>; default: <b>Enable</b></td>
<td>Turns the DHCP server on or off or enables DHCP relay<span class="asterisk">*</span>.<br>If DHCP Relay<span class="asterisk">*</span> is selected, you will be prompted to enter an IP address of another DHCP server in your LAN and optional DNS servers. In this case, whenever a new machine connects to this device, it will redirect any DHCP requests to the specified DHCP Server.</td>
</tr>
<tr>
<td>Start IP</td>
<td>integer [1..255]; default: <b>100</b></td>
<td>The DHCP server's IP address range start value.</td>
</tr>
<tr>
<td>End IP</td>
<td>integer [1..255]; default: <b>254</b></td>
<td>End IP, i.e., the last possible IP in the selected range for the DHCP server.</td>
</tr>
<tr>
<td>Lease time</td>
<td>integer [1..999999]; default: <b>12</b><br>integer [2..999999]<span class="asterisk">*</span><br>integer [120..999999]<span class="asterisk">**</span></td>
<td>A DHCP lease will expire after the amount of time specified in this field and the device that was using the lease will have to request a new one. However, if the device stays connected, its lease will be renewed after half of the specified amount of time passes (e.g., if lease time is 12 hours, then every 6 hours the device will ask the DHCP server to renew its lease).<br>The minimal amount of time that can be specified is 2 minutes.<br><span class="asterisk">*</span>If selected Units is Minutes.<br><span class="asterisk">**</span>If selected Units is seconds.</td>
</tr>
<tr>
<td>Units</td>
<td>Hours {{!}} Minutes {{!}} Seconds; default: <b>Hours</b></td>
<td>Lease time measurement units.</td>
</tr>
<tr>
<td>DNS servers</td>
<td>ipv4 {{!}} ipv6; default: <b>none</b></td>
<td>DNS server address.</td>
</tr>
</table>
===Advanced settings===
Refer to the table below for information on the <b>Advanced Settings</b> section.
[[File:Networking_tswos_manual_dhcp_server_settings_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Dynamic DHCP</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Dynamically allocate DHCP addresses for clients. If disabled, only clients having static leases will be served.</td>
</tr>
<tr>
<td>Force</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Force DHCP on this network even if another server is detected.</td>
</tr>
<tr>
<td>IPv4-Netmask</td>
<td>netmask; default: <b>none</b></td>
<td>Override the netmask sent to clients. Normally it is calculated from the subnet that is served.</td>
</tr>
<tr>
<td>Custom DHCP Options</td>
<td>-(interactive button)</td>
<td>Custom DHCP options are number and value pairs used to configure advanced DHCP functionality. It does not configure DHCP ipv6!.</td>
</tr>
<tr>
<td>Force DHCP options</td>
<td>off | on; default: <b>off</b></td>
<td>Force DHCP options to be sent even if it's not requested.</td>
</tr>
</table>
====Custom DHCP options====
Custom DHCP options are number and value pairs used to configure advanced DHCP functionality. It does not configure DHCP ipv6!. The <b>DHCP options</b> modal is used to 'Add', 'Delete', 'Save' multiple options.
[[File:Networking_tswos_manual_dhcp_server_advanced_settings_dhcp_options.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Option code</td>
<td>Custom {{!}} Time offset (2) {{!}} Router (3) {{!}} DNS (6) {{!}} Domain name (15) {{!}} NTP server (43); default: <b>DNS (6)</b></td>
<td>Standartized DHCP option code.</td>
</tr>
<tr>
<td>Option value</td>
<td>Custom {{!}} Time offset (2) - integer {{!}} Router (3)- IPv4 {{!}} DNS (6) - IPv4 {{!}} Domain name (15) - string {{!}} NTP server (43) - IPv4; default: <b>empty</b></td>
<td>Value that will be set for selected option.</td>
</tr>
</table>
<span class="asterisk">*</span> When an interface is set to act as a DHCP Relay, it redirects all received DHCP request messages to another specified DHCP server:
[[File:Networking_rutx_manual_lan_static_dhcp_server_relay_scheme_v2.png]]
==Static Leases==
<b>Static IP leases</b> are used to reserve specific IP addresses for specific devices by binding them to their MAC address. This is useful when you have a stationary device connected to your network that you need to reach frequently, e.g., printer, IP phone, etc.
This page displays static IP leases currently existing on this device.
<i>To make the Static Lease section visible, <b>set interface protocol to Static</b>.</i>
----
The Static Lease list is empty by default. To add a new Static Lease click the 'Add' button.
[[File:Networking_tswos_manual_dhcp_static_leases_add_button.png|border|class=tlt-border]]
Appears static lease, which should look similar to this:
[[File:Networking_tswos_manual_dhcp_static_leases.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>MAC</td>
<td>mac; default: <b>none</b></td>
<td>MAC address of a device that will connect to this network interface.</td>
</tr>
<tr>
<td>IP</td>
<td>ip; default: <b>none</b></td>
<td>The IP address that will be reserved for the specified device.</td>
</tr>
<tr>
<td>Description</td>
<td>string; default: <b>none</b></td>
<td>Name of static lease.</td>
</tr>
</table>
After you click 'Save & Apply' static leases will be saved.
[[Category:{{{name}}} Network section]]
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
__TOC__
==Summary==
The <b>DHCP</b> page is used to to set up DHCP settings, which are used to connect device with external networks.
This manual page provides an overview of DHCP page in {{{name}}} devices.
==Server Settings==
A <b>DHCP</b> (<b>Dynamic Host Configuration Protocol</b>) server is a service that can automatically configure the TCP/IP settings of any device that requests such a service. If you connect a device that has been configured to obtain an IP address automatically, the DHCP server will lease out an IP address from the available IP pool and the device will be able to communicate within the private network.
[[File:Networking_rutx_manual_lan_static_dhcp_server_scheme_v1.png]]
To <b>Add add new DHCP server</b> select interface and press 'Add' button.
[[File:Networking_tswos_manual_dhcp_server_settings_add_button.png|border|class=tlt-border]]
You will be redirected to DHCP server settings:
===General Setup===
The <b>General Setup</b> section is used to set up the main operating parameters of the DHCP server.
[[File:Networking_tswos_manual_dhcp_server_settings_general_setup.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable DHCP</td>
<td>Enable {{!}} Disable {{!}} Relay<span class="asterisk">*</span>; default: <b>Enable</b></td>
<td>Turns the DHCP server on or off or enables DHCP relay<span class="asterisk">*</span>.<br>If DHCP Relay<span class="asterisk">*</span> is selected, you will be prompted to enter an IP address of another DHCP server in your LAN and optional DNS servers. In this case, whenever a new machine connects to this device, it will redirect any DHCP requests to the specified DHCP Server.</td>
</tr>
<tr>
<td>Start IP</td>
<td>integer [1..255]; default: <b>100</b></td>
<td>The DHCP server's IP address range start value.</td>
</tr>
<tr>
<td>End IP</td>
<td>integer [1..255]; default: <b>254</b></td>
<td>End IP, i.e., the last possible IP in the selected range for the DHCP server.</td>
</tr>
<tr>
<td>Lease time</td>
<td>integer [1..999999]; default: <b>12</b><br>integer [2..999999]<span class="asterisk">*</span><br>integer [120..999999]<span class="asterisk">**</span></td>
<td>A DHCP lease will expire after the amount of time specified in this field and the device that was using the lease will have to request a new one. However, if the device stays connected, its lease will be renewed after half of the specified amount of time passes (e.g., if lease time is 12 hours, then every 6 hours the device will ask the DHCP server to renew its lease).<br>The minimal amount of time that can be specified is 2 minutes.<br><span class="asterisk">*</span>If selected Units is Minutes.<br><span class="asterisk">**</span>If selected Units is seconds.</td>
</tr>
<tr>
<td>Units</td>
<td>Hours {{!}} Minutes {{!}} Seconds; default: <b>Hours</b></td>
<td>Lease time measurement units.</td>
</tr>
<tr>
<td>DNS servers</td>
<td>ipv4 {{!}} ipv6; default: <b>none</b></td>
<td>DNS server address.</td>
</tr>
</table>
===Advanced settings===
Refer to the table below for information on the <b>Advanced Settings</b> section.
[[File:Networking_tswos_manual_dhcp_server_settings_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Dynamic DHCP</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Dynamically allocate DHCP addresses for clients. If disabled, only clients having static leases will be served.</td>
</tr>
<tr>
<td>Force</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Force DHCP on this network even if another server is detected.</td>
</tr>
<tr>
<td>IPv4-Netmask</td>
<td>netmask; default: <b>none</b></td>
<td>Override the netmask sent to clients. Normally it is calculated from the subnet that is served.</td>
</tr>
<tr>
<td>Custom DHCP Options</td>
<td>-(interactive button)</td>
<td>Custom DHCP options are number and value pairs used to configure advanced DHCP functionality. It does not configure DHCP ipv6!.</td>
</tr>
<tr>
<td>Force DHCP options</td>
<td>off | on; default: <b>off</b></td>
<td>Force DHCP options to be sent even if it's not requested.</td>
</tr>
</table>
====Custom DHCP options====
Custom DHCP options are number and value pairs used to configure advanced DHCP functionality. It does not configure DHCP ipv6!. The <b>DHCP options</b> modal is used to 'Add', 'Delete', 'Save' multiple options.
[[File:Networking_tswos_manual_dhcp_server_advanced_settings_dhcp_options.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Option code</td>
<td>Custom {{!}} Time offset (2) {{!}} Router (3) {{!}} DNS (6) {{!}} Domain name (15) {{!}} NTP server (43); default: <b>DNS (6)</b></td>
<td>Standartized DHCP option code.</td>
</tr>
<tr>
<td>Option value</td>
<td>Custom {{!}} Time offset (2) - integer {{!}} Router (3)- IPv4 {{!}} DNS (6) - IPv4 {{!}} Domain name (15) - string {{!}} NTP server (43) - IPv4; default: <b>empty</b></td>
<td>Value that will be set for selected option.</td>
</tr>
</table>
<span class="asterisk">*</span> When an interface is set to act as a DHCP Relay, it redirects all received DHCP request messages to another specified DHCP server:
[[File:Networking_rutx_manual_lan_static_dhcp_server_relay_scheme_v2.png]]
==Static Leases==
<b>Static IP leases</b> are used to reserve specific IP addresses for specific devices by binding them to their MAC address. This is useful when you have a stationary device connected to your network that you need to reach frequently, e.g., printer, IP phone, etc.
This page displays static IP leases currently existing on this device.
<i>To make the Static Lease section visible, <b>set interface protocol to Static</b>.</i>
----
The Static Lease list is empty by default. To add a new Static Lease click the 'Add' button.
[[File:Networking_tswos_manual_dhcp_static_leases_add_button.png|border|class=tlt-border]]
Appears static lease, which should look similar to this:
[[File:Networking_tswos_manual_dhcp_static_leases.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>MAC</td>
<td>mac; default: <b>none</b></td>
<td>MAC address of a device that will connect to this network interface.</td>
</tr>
<tr>
<td>IP</td>
<td>ip; default: <b>none</b></td>
<td>The IP address that will be reserved for the specified device.</td>
</tr>
<tr>
<td>Description</td>
<td>string; default: <b>none</b></td>
<td>Name of static lease.</td>
</tr>
</table>
After you click 'Save & Apply' static leases will be saved.
[[Category:{{{name}}} Network section]]
