Login Timeout

changelogs/fragments/427-login-timeout.yaml

@@ -0,0 +1,2 @@
+major_changes:
+ - sonic_login_timeout - Add 'sonic_login_timeout' module to Dell enterprise SONiC collection (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/427).

plugins/module_utils/network/sonic/argspec/facts/facts.py

@@ -80,7 +80,8 @@ def __init__(self, **kwargs):
  'login_lockout',
  'poe',
  'mgmt_servers',
- 'ospf_area'
+ 'ospf_area',
+ 'login_timeout'
  ]
 
  argument_spec = {

plugins/module_utils/network/sonic/argspec/login_timeout/login_timeout.py

@@ -0,0 +1,53 @@
+#
+# -*- coding: utf-8 -*-
+# Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+#############################################
+# WARNING #
+#############################################
+#
+# This file is auto generated by the resource
+# module builder playbook.
+#
+# Do not edit this file manually.
+#
+# Changes to this file will be over written
+# by the resource module builder.
+#
+# Changes should be made in the model used to
+# generate this file or in the resource module
+# builder template.
+#
+#############################################
+
+"""
+The arg spec for the sonic_login_timeout module
+"""
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+class Login_timeoutArgs(object): # pylint: disable=R0903
+ """The arg spec for the sonic_login_timeout module
+ """
+
+ def __init__(self, **kwargs):
+ pass
+
+ argument_spec = {
+ 'config': {
+ 'options': {
+ 'exec_timeout': {
+ 'type': 'int'}
+ },
+ 'type': 'dict'
+ },
+ 'state': {
+ 'choices': ['merged', 'deleted', 'overridden', 'replaced'],
+ 'default': 'merged',
+ 'type': 'str'
+ }
+ } # pylint: disable=C0301

plugins/module_utils/network/sonic/config/login_timeout/login_timeout.py

@@ -0,0 +1,244 @@
+#
+# -*- coding: utf-8 -*-
+# Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+The sonic_login_timeout class
+It is in this file where the current configuration (as dict)
+is compared to the provided configuration (as dict) and the command set
+necessary to bring the current configuration to it's desired end-state is
+created
+"""
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.base import (
+ ConfigBase,
+)
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
+ to_list,
+)
+from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.facts.facts import Facts
+from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.utils.utils import (
+ get_diff,
+ update_states
+)
+from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.sonic import (
+ to_request,
+ edit_config
+)
+from ansible.module_utils.connection import ConnectionError
+
+
+PATCH = 'patch'
+DELETE = 'delete'
+
+
+class Login_timeout(ConfigBase):
+ """
+ The sonic_login_timeout class
+ """
+
+ gather_subset = [
+ '!all',
+ '!min',
+ ]
+
+ gather_network_resources = [
+ 'login_timeout',
+ ]
+
+ login_timeout_path = 'data/openconfig-system:system/openconfig-system-ext:login/session/config'
+ login_timeout_config_path = {
+ 'exec_timeout': login_timeout_path + '/exec-timeout',
+ }
+ default_config_dict = {"exec_timeout": 600}
+
+ def __init__(self, module):
+ super(Login_timeout, self).__init__(module)
+
+ def get_login_timeout_facts(self):
+ """ Get the 'facts' (the current configuration)
+
+ :rtype: A dictionary
+ :returns: The current configuration as a dictionary
+ """
+ facts, _warnings = Facts(self._module).get_facts(self.gather_subset, self.gather_network_resources)
+ login_timeout_facts = facts['ansible_network_resources'].get('login_timeout')
+ if not login_timeout_facts:
+ return []
+ return login_timeout_facts
+
+ def execute_module(self):
+ """ Execute the module
+
+ :rtype: A dictionary
+ :returns: The result from module execution
+ """
+ result = {'changed': False}
+ warnings = list()
+ commands = list()
+
+ fp = open("/tmp/timeout_cfg", "a")
+ fp.write("Entered execute module\r\n")
+ fp.close()
+ existing_login_timeout_facts = self.get_login_timeout_facts()
+ commands, requests = self.set_config(existing_login_timeout_facts)
+ if commands:
+ if not self._module.check_mode:
+ try:
+ edit_config(self._module, to_request(self._module, requests))
+ except ConnectionError as exc:
+ self._module.fail_json(msg=str(exc), code=exc.code)
+ result['changed'] = True
+ result['commands'] = commands
+
+ changed_login_timeout_facts = self.get_login_timeout_facts()
+
+ result['before'] = existing_login_timeout_facts
+
+ if result['changed']:
+ result['after'] = changed_login_timeout_facts
+ result['warnings'] = warnings
+
+ return result
+
+ def set_config(self, existing_login_timeout_facts):
+ """ Collect the configuration from the args passed to the module,
+ collect the current configuration (as a dict from facts)
+
+ :rtype: A list
+ :returns: the commands necessary to migrate the current configuration
+ to the desired configuration
+ """
+ want = self._module.params['config']
+ have = existing_login_timeout_facts
+ resp = self.set_state(want, have)
+ return to_list(resp)
+
+ def set_state(self, want, have):
+ """ Select the appropriate function based on the state provided
+
+ :param want: the desired configuration as a dictionary
+ :param have: the current configuration as a dictionary
+ :rtype: A list
+ :returns: the commands necessary to migrate the current configuration
+ to the desired configuration
+ """
+ state = self._module.params['state']
+ diff = get_diff(want, have)
+ if state == 'deleted':
+ commands, requests = self._state_deleted(want, have, diff)
+ elif state == 'merged':
+ commands, requests = self._state_merged(diff)
+ elif state == 'replaced':
+ commands, requests = self._state_replaced_overridden(want, have, diff)
+ elif state == 'overridden':
+ commands, requests = self._state_replaced_overridden(want, have, diff)
+ return commands, requests
+
+ def _state_replaced_overridden(self, want, have, diff):
+ """ The command generator when state is replaced or overridden
+ :rtype: A list
+ :returns: the commands necessary to migrate the current configuration
+ to the desired configuration
+ """
+ commands = []
+ requests = []
+ delete = {}
+ state = self._module.params['state']
+
+ for key in have:
+ if key in want:
+ if want[key] == have[key]:
+ continue
+ if key not in diff and have[key] != self.default_config_dict[key]:
+ delete[key] = have[key]
+ if delete:
+ commands = update_states(delete, 'deleted')
+ requests.extend(self.get_delete_specific_login_timeout_param_requests(delete))
+ if diff:
+ commands.extend(update_states(diff, state))
+ requests.extend(self.get_modify_specific_login_timeout_param_requests(diff))
+
+ return commands, requests
+
+ def _state_merged(self, diff):
+ """ The command generator when state is merged
+ :rtype: A list
+ :returns: the commands necessary to merge the provided into
+ the current configuration
+ """
+ commands = []
+ requests = []
+
+ if diff:
+ requests = self.get_modify_specific_login_timeout_param_requests(diff)
+ if len(requests) > 0:
+ commands = update_states(diff, 'merged')
+
+ return commands, requests
+
+ def _state_deleted(self, want, have, diff):
+ """ The command generator when state is deleted
+ :rtype: A list
+ :returns: the commands necessary to remove the current configuration
+ of the provided objects
+ """
+ commands = []
+ requests = []
+ delete = {}
+
+ if not want:
+ delete = have.copy()
+ delete = {key: value for key, value in delete.items() if key not in self.default_config_dict or self.default_config_dict[key] != value}
+ commands = delete
+ requests.extend(self.get_delete_specific_login_timeout_param_requests(commands))
+ else:
+ delete = get_diff(want, diff)
+ delete = {key: value for key, value in delete.items() if key not in self.default_config_dict or self.default_config_dict[key] != value}
+ commands = delete
+ requests.extend(self.get_delete_specific_login_timeout_param_requests(commands))
+
+ if len(requests) == 0:
+ commands = []
+
+ if commands:
+ commands = update_states(commands, "deleted")
+
+ return commands, requests
+
+ def get_modify_specific_login_timeout_param_requests(self, command):
+ """Get requests to modify specific Login Timeout configurations
+ based on the command specified
+ """
+ requests = []
+ config_dict = {}
+
+ if not command:
+ return requests
+
+ if 'exec_timeout' in command and command['exec_timeout'] is not None:
+ config_dict['exec-timeout'] = int(command['exec_timeout'])
+
+ payload = {"openconfig-system-ext:config": config_dict}
+
+ requests.append({'path': self.login_timeout_path, 'method': PATCH, 'data': payload})
+
+ return requests
+
+ def get_delete_specific_login_timeout_param_requests(self, command):
+ """Get requests to delete specific Login Timeout configurations
+ based on the command specified
+ """
+ requests = []
+
+ if not command:
+ return requests
+
+ if 'exec_timeout' in command:
+ url = self.login_timeout_config_path['exec_timeout']
+ requests.append({'path': url, 'method': DELETE})
+
+ return requests

plugins/module_utils/network/sonic/facts/facts.py

@@ -78,6 +78,8 @@
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.facts.poe.poe import PoeFacts
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.facts.mgmt_servers.mgmt_servers import Mgmt_serversFacts
 from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.facts.ospf_area.ospf_area import Ospf_areaFacts
+from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.facts.login_timeout.login_timeout import Login_timeoutFacts
+
 
 FACT_LEGACY_SUBSETS = {}
 FACT_RESOURCE_SUBSETS = dict(
@@ -140,7 +142,9 @@
  login_lockout=Login_lockoutFacts,
  poe=PoeFacts,
  mgmt_servers=Mgmt_serversFacts,
- ospf_area=Ospf_areaFacts
+ ospf_area=Ospf_areaFacts,
+ login_timeout=Login_timeoutFacts
+
 )