Adding a new feature to use commit timer

changelogs/fragments/eos_config_commit_timer.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add support for commit timer

docs/arista.eos.eos_config_module.rst

@@ -335,6 +335,21 @@ Parameters
                         <div>The <em>src</em> argument provides a path to the configuration file to load into the remote system.  The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the <em>lines</em> and <em>parents</em> arguments. It can be a Jinja2 template as well. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration (live switch config) of the device i ncluding the indentation to ensure idempotency and correct diff. Arista EOS device config has 3 spaces indentation.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="2">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>timer</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>This argument will configure a commit timer which will need to be confirmed before it is automatically rolled back. <em>timer</em> is define as HhMmSs and will be converted on the switches using the Arista format HH:MM:SS. Example values - 10h, 10h19m5s, 1m60s, 10s</div>
+                </td>
+            </tr>
     </table>
     <br/>
 
@@ -399,6 +414,15 @@ Examples
           filename: backup.cfg
           dir_path: /home/user
 
+    - name: deploying with a commit timer
+      arista.eos.eos_config:
+        timer: 1m
+      register: eos
+
+    - name: commit using the session id
+      arista.eos.eos_command:
+        commands: configure session {{ eos.session }} commit
+
 
 
 Return Values
@@ -481,6 +505,23 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">eos_config.2016-07-16@22:28:34</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>session</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>always</td>
+                <td>
+                            <div>Unique session ID to use when confirming changes with commit timer</div>
+                    <br/>
+                        <div style="font-size: smaller"><b>Sample:</b></div>
+                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ansible_168207712846</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="return-"></div>

plugins/module_utils/network/eos/eos.py

@@ -33,8 +33,11 @@
 __metaclass__ = type
 import json
 import os
+import re
 import time
 
+from datetime import timedelta
+
 from ansible.module_utils._text import to_text
 from ansible.module_utils.connection import Connection, ConnectionError
 from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import (
@@ -229,6 +232,10 @@ def get_capabilities(self):
 
 
 class HttpApi:
+    _TIMER_REGEX = re.compile(
+        r"(^(?P<hour>\d+)h)?((?P<min>\d+)m)?((?P<sec>\d+)s)?$",
+    )
+
     def __init__(self, module):
         self._module = module
         self._device_configs = {}
@@ -411,7 +418,12 @@ def edit_config(self, config, commit=False, replace=False):
             "configure session %s" % session,
             "show session-config diffs",
         ]
-        if commit:
+
+        timer = self._parse_timer(self._module.params["timer"])
+
+        if commit and timer:
+            commands.append("commit timer %s" % timer)
+        elif commit:
             commands.append("commit")
         else:
             commands.append("abort")
@@ -490,6 +502,34 @@ def get_capabilities(self):
 
         return json.loads(capabilities)
 
+    def _parse_timer(self, timer):
+        """Parse commit timer as "HhMmSs" format.
+        Eg 10h, 10h19m5s, 1m60s, 10s
+        Returns Arista compatible string
+        of form "HH:MM:SS"
+        Value must be non-zero and below 24 hours
+        """
+        if timer is not None:
+            match = self._TIMER_REGEX.match(timer)
+            if not match:
+                self._module.fail_json(
+                    msg="Invalid value for commit timer %r" % timer,
+                )
+            vals = match.groupdict()
+            total_secs = (
+                int(vals["hour"] or 0) * 60 * 60
+                + int(vals["min"] or 0) * 60
+                + int(vals["sec"] or 0)
+            )
+
+            td = timedelta(seconds=total_secs)
+
+            if not (timedelta(0) < td < timedelta(hours=24)):
+                self._module.fail_json(
+                    msg="commit timer must be > 0 and < 24 hours",
+                )
+            return str(td)
+
 
 def is_json(cmd):
     return to_text(cmd, errors="surrogate_then_replace").endswith("| json")

plugins/modules/eos_config.py

@@ -226,6 +226,13 @@
           in C(filename) within I(backup) directory.
         type: path
     type: dict
+  timer:
+    description:
+    - This argument will configure a commit timer which will need to be confirmed
+      before it is automatically rolled back. I(timer) is define as HhMmSs and will be
+      converted on the switches using the Arista format HH:MM:SS.
+      Example values - 10h, 10h19m5s, 1m60s, 10s
+    type: str
 """
 # noqa: E501
 
@@ -274,6 +281,15 @@
     backup_options:
       filename: backup.cfg
       dir_path: /home/user
+
+- name: deploying with a commit timer
+  arista.eos.eos_config:
+    timer: 1m
+  register: eos
+
+- name: commit using the session id
+  arista.eos.eos_command:
+    commands: configure session {{ eos.session }} commit
 """
 
 RETURN = """
@@ -312,6 +328,11 @@
   returned: when backup is true
   type: str
   sample: "22:28:34"
+session:
+  description: Unique session ID to use when confirming changes with commit timer
+  returned: always
+  type: str
+  sample: "ansible_168207712846"
 """
 from ansible.module_utils._text import to_text
 from ansible.module_utils.basic import AnsibleModule
@@ -402,6 +423,7 @@ def main():
         diff_ignore_lines=dict(type="list", elements="str"),
         running_config=dict(aliases=["config"]),
         intended_config=dict(),
+        timer=dict(),
     )
 
     mutually_exclusive = [("lines", "src"), ("parents", "src")]