Jump to content

Template:Networking rutos manual auto reboot: Difference between revisions

m
Added sentence " The maximum limit of instances is 30."
(Created page with "__TOC__ ==Summary== Various automatic device reboot scenarios can be configured in the <b>Auto Reboot</b> section. Automatic reboots can be used as a prophylactic or precauti...")
 
m (Added sentence " The maximum limit of instances is 30.")
(40 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__TOC__
{{#switch: {{{series}}} |TAP100|TAP200 ={{Template: Networking_device_manual_fw_disclosure
==Summary==
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Auto Reboot (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Auto Reboot (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}| #default =}}
 
{{#switch: {{{series}}} |TAP100|TAP200 =__TOC__ |#default =}}
{{#switch: {{{series}}} |TAP100|TAP200 = ==Summary== |#default = ===Summary===}}
 
Various automatic device reboot scenarios can be configured in the <b>Auto Reboot</b> section. Automatic reboots can be used as a prophylactic or precautionary measure that ensures the device will self-correct some unexpected issues, especially related to connection downtime.


Various automatic device reboot scenarios can be configured in the <b>Auto Reboot</b> section. Automatic reboots can be used as a prophylactic or precautionary measure that ensures the device will self-correct some unexpected issues, especially related to connection downtime. This chapter is an overview of the Auto Reboot section of {{{name}}} devices.
This chapter is an overview of the Auto Reboot section of {{{name}}} devices.


{{Template: Networking_rutx_manual_fw_disclosure
{{#switch: {{{series}}} | TAP100 | TAP200 =| #default = {{Template: Networking_rutos_manual_basic_advanced_webui_disclaimer
| fw_version = {{{fw_version}}}
| series = {{{series}}}
}}
}}}}


==Ping Reboot==
{{#switch: {{{series}}} |TAP100|TAP200 = ==Ping/Wget Reboot==|#default = ===Ping/Wget Reboot===}}


The <b>Ping Reboot</b> function periodically sends ICMP or Wget requests to a specified IP address or host and waits for a response. If no response is received, the device will attempt the same action a defined number of times at a defined frequency. If there is still no response, the device will execute the specified action (reboot, by default).
The <b>Ping/Wget Reboot</b> functions periodically send ICMP or Wget requests to a specified IP address or host and waits for a response. If no response is received, the device will attempt the same action a defined number of times at a defined frequency. If there is still no response, the device will execute the specified action (reboot, by default).


The Ping Reboot section contains one preconfigured rule by default:
The Ping/Wget Reboot section contains one pre-configured rule by default:


[[File:Networking_rutx_manual_auto_reboot_ping_reboot_v1.png]]
[[File:Networking_rutos_manual_auto_reboot_ping_wget_reboot_settings.png|border|class=tlt-border]]


To enable the default rule, use the off/on slider next to it. You can add more rules with the 'Add' button or delete them using the "Delete" button. If you wish to customize a rule, click the button that looks like a pencil next to it. Refer to the figure and table below for information Ping Reboot configuration.
To enable the default rule, use the off/on slider next to it. You can add more rules with the 'Add' button or delete them using the 'Delete' button. The maximum limit of instances is 30. If you wish to customize a rule, click the button that looks like a pencil next to it.


[[File:Networking_rutx09_rutx11_manual_auto_reboot_ping_reboot_configuration_v1.png]]
[[File:Networking_rutos_manual_auto_reboot_ping_wget_reboot_settings_configuration_mobile_{{{mobile}}}_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 28: Line 41:
     <tr>
     <tr>
         <td>Enable</td>
         <td>Enable</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns the rule on or off.</td>
         <td>Turns the rule on or off.</td>
     </tr>
     </tr>{{#ifeq:{{{mobile}}}|1|
{{#ifeq:{{{modem}}} | 1 | {{Template: Networking_rutx_manual_auto_reboot_ping_reboot_table_element_1}} |}}
     <tr>
     <tr>
         <td>Action if no echo is received</td>
         <td>No action on data limit</td>
         <td>Reboot | None; default: <b>Reboot</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Action that will be executed if there is no response after the specified amount of retries.</td>
         <td>Stop actions when mobile data limit is reached.</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
         <td>Type</td>
         <td>Type</td>
         <td>Ping | Wget; default: <b>Ping</b></td>
         <td>Ping {{!}} Wget{{#switch:{{{name}}}|OTD140= <span style="color: #olive;">Port</span>|#default=}}; default: <b>Ping</b></td>
         <td>Method used for health checking.
         <td>Method used for health checking.
             <ul>
             <ul>
                 <li><b>Ping</b> - sends ICMP requests to the specified host.</li>
                 <li><b>Ping</b> - sends ICMP requests to the specified host.</li>
                 <li><b>Wget</b> - retrieves the contents of the specified web server.</li>
                 <li><b>Wget</b> - retrieves the contents of the specified web server.</li>{{#switch:{{{name}}}|OTD140=
                <li><b>Port</b> - sends pings, if ping doesn't go through a certain amount of times, the port to which the device that has the IP address is connected to, will be restarted.</li>|#default=}}
             </ul>
             </ul>
         </td>
         </td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Interval between pings</td>
        <td>Action if no echo is received</td>
         <td>5 mins | 15 mins | 30 mins | 1 hour | 2 hours; default: <b>5 mins</b></td>
        <td>Device reboot {{!}} None{{#ifeq:{{{mobile}}} | 1 | {{!}} Modem reboot {{!}} Restart mobile connection {{!}} (Re)register {{!}} <span style="color: #20C0D7;"><b>Send SMS</b></span>}}; default: <b>Device reboot</b></td>
        <td>Action that will be executed if there is no response after the specified amount of retries. If <b>None</b> is selected, only a message to syslog will be logged.</td>
    </tr>{{#ifeq:{{{dualmodem}}} | 1 |
    <tr>
        <td><span style="color: #20C0D7;">Gateway modem</span></td>
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></td>
        <td>Specifies which modem to use for sending the SMS message.</td>
    </tr>|}}{{#ifeq:{{{mobile}}} | 1 |
    <tr>
        <td><span style="color: #20C0D7;">Phone Number</span></td>
        <td>phone number(s); default: <b>none</b></td>
        <td>Recipient's phone number(s) specified in international format.</td>
    </tr>
    <tr>
        <td><span style="color: #20C0D7;">Message text</span></td>
        <td>string; default: <b>none</b></td>
        <td>Text to be included in the SMS message.</td>
    </tr>|}}
    <tr>
         <td>Interval</td>
         <td>5 mins {{!}} 15 mins {{!}} 30 mins {{!}} 1 hour {{!}} 2 hours; default: <b>5 mins</b></td>
         <td>The frequency at which ping/Wget requests are sent to the specified host.</td>
         <td>The frequency at which ping/Wget requests are sent to the specified host.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Ping timeout (sec)</td>
         <td>Interval count</td>
        <td>integer [1..9999]; default: <b>2</b></td>
        <td>Indicates how many additional times the device will try sending requests if the initial one fails.</td>
    </tr>
    <tr>
        <td>Timeout (sec)</td>
         <td>integer [1..9999]; default: <b>5</b></td>
         <td>integer [1..9999]; default: <b>5</b></td>
         <td>Maximum response time. If no echo is received after the amount of time specified in this field has passed, the ping/wget request is considered to have failed.</td>
         <td>Maximum response time. If no echo is received after the amount of time specified in this field has passed, the ping/wget request is considered to have failed.</td>
Line 61: Line 99:
         <td>integer [0..1000]; default: <b>56</b></td>
         <td>integer [0..1000]; default: <b>56</b></td>
         <td>ICMP packet size in bytes.</td>
         <td>ICMP packet size in bytes.</td>
     </tr>
     </tr>{{#ifeq:{{{mobile}}} | 1 |
     <tr>
     <tr>
         <td>Retry count</td>
         <td>Interface</td>
         <td>integer [1..9999]; default: <b>2</b></td>
         <td>Automatically selected {{!}} <span style="color:red">Ping from mobile</span>; default: <b>Automatically selected</b></td>
         <td>Indicates how many additional times the device will try sending requests if the initial one fails.</td>
         <td>Specifies through which interface the pings will be sent. If <b>Automatically selected</b> is set, the pings will go through the main WAN interface.</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
         <td>Interface</td>
         <td>IP type</td>
         <td>{{#ifeq:{{{modem}}}|1|Ping from mobile {{!}} |}} Automatically selected; default: <b>Automatically selected</b></td>
         <td>IPv4 {{!}} IPv6; default: <b>IPv4</b></td>
         <td>Interface that will send the ping/Wget requests.</td>
         <td>IP address version of the host to ping.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Host to ping</td>
         <td>Host to ping</td>
         <td>host | ip; default: <b>8.8.8.8</b></td>
         <td>host {{!}} ip; default: <b>8.8.8.8</b></td>
         <td>Hostname or IP address to which the ping/Wget requests will be sent.</td>
         <td>Hostname or IP address to which the Ping/Wget requests will be sent.</td>
    </tr>{{#ifeq:{{{mobile}}} | 1 |
    <tr>
        <td><span style="color:red">Host to ping from SIM 1</span></td>
        <td>ip; default: <b>8.8.8.8</b></td>
        <td>IP address to which the Ping requests will be sent on SIM 1.</td>
    </tr>|}}{{#ifeq:{{{dualsim}}} | 1 |
    <tr>
        <td><span style="color:red">Host to ping from SIM 2</span></td>
        <td>ip; default: <b>8.8.8.8</b></td>
        <td>IP address to which the Ping requests will be sent on SIM 2.</td>
    </tr>|}}{{#switch:{{{name}}}|OTD140=
    <tr>
        <td><span style="color:olive">Ping by</span></td>
        <td><span style="color:green">Port</span> {{!}} IP; default: <b>8.8.8.8</b></td>
        <td>Ping IP's by Port or by IP.</td>
     </tr>
     </tr>
    <tr>
        <td><span style="color:green">Port to ping</span></td>
        <td>port number and number of devices (unsigned integer); default: <b>Port1:1</b></td>
        <td>Port number and number of devices addresses to be pinged. (Number of devices connected must be less or equal to the actual number of connected devices to the port).</td>
    </tr>|#default=}}
</table>
</table>


==Periodic Reboot==
{{#switch: {{{series}}} |TAP100|TAP200 = ==Reboot Scheduler==|#default = ===Reboot Scheduler===}}


<b>Periodic Reboot</b> is a function that reboots the device at a specified time interval regardless of other circumstances.  It can be used as a prophylactic measure, for example, to reboot the device once at the end of every day. Reboot time is chosen by selecting time interval boxes in the scheduler table to indicate on which days/hours reboot will occur.
The <b>Reboot Scheduler</b> is a function that reboots the device at a specified time interval regardless of other circumstances.  It can be used as a prophylactic measure, for example, to reboot the device once at the end of every day.
 
You can add more rules with the 'Add' button or delete them using the 'Delete' button. The maximum limit of instances is 30. If you wish to customize a rule, click the button that looks like a pencil next to it.
 
[[File:Networking_rutos_manual_auto_reboot_reboot_scheduler.png|border|class=tlt-border]]


The figure below is an example of the Periodic Reboot configuration page and the table below provides information on the fields contained in that page:  
The figure below is an example of the Periodic Reboot configuration page and the table below provides information on the fields contained in that page:  


[[File:{{{file_periodic_reboot}}}]]
[[File:Networking_rutos_manual_auto_reboot_reboot_scheduler_modify_reboot_instance.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 95: Line 157:
     <tr>
     <tr>
         <td>Enable</td>
         <td>Enable</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns Periodic Reboot on or off.</td>
         <td>Turns the rule on or off.</td>
     </tr></table>
     </tr>
 
    <tr>
[[Category:{{{name}}} Services section]]
        <td>Action</td>
        <td>Device reboot {{#ifeq:{{{mobile}}} | 1 | {{#ifeq:{{{dualmodem}}} | 1 | {{!}}<span style="color:red"> Modem reboot</span>| {{!}} Modem reboot}}|}}; default: <b> Device reboot</b></td>
        <td>Action that will be executed at the specified time.</td>
  </tr>{{#ifeq:{{{dualmodem}}} | 1 |
    <tr>
        <td><span style="color:red">Modem</span></td>
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></td>
        <td>Specifies which modem to reboot.</td>
    </tr>|}}
    <tr>
        <td>Interval type</td>
        <td><span style="color: green">Week days</span> {{!}} <span style="color: blue;">Month days</span>; default:  <b>Week days</b></td>
        <td>Scheduler instance interval type.</td>
    </tr>
    <tr>
        <td><span style="color: green">Week days</span></td>
        <td>Monday {{!}} Tuesday {{!}} Wednesday {{!}} Thursday {{!}} Friday {{!}} Saturday {{!}} Sunday; default:  <b>Monday</b></td>
        <td>Week day(s) when actions will be executed. This field becomes visible when Interval type is set to Week days.</td>
    </tr>
    <tr>
        <td><span style="color: blue">Month day</span></td>
        <td>integer [1..31]; default:  <b>1</b></td>
        <td>Day of the month on which the reboot will occur. This field becomes visible when Interval type is set to Month days.</td>
    </tr>
    <tr>
        <td><span style="color: blue">Month</span></td>
        <td>month(s) [january..december]; default:  <b>none</b></td>
        <td>The month(s) on which the reboot will occur. Leave empty to apply to all months. This field becomes visible when Interval type is set to Month days.</td>
    </tr>
    <tr>
        <td>Day time</td>
        <td>time [00:00..23:59]; default: <b>none</b></td>
        <td>Exact time of day the reboot will take place</td>
  </tr>
    <tr>
        <td>Force last day</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Forces intervals to accept last day of month as a valid option if selected day doesn't exist in the ongoing month. This field becomes visible when Interval type is set to Month days.</td>
    </tr>
</table>
{{#switch: {{{series}}} |TAP100|TAP200 = [[Category:{{{name}}} System section]] | #default =}}