Contributing lib/ansible/modules/network/cloudengine/ce_snmp_location.py module to manage HUAWEI data center CloudEngine (#22065)

* add ce_snmp_location.py

* fix review issues

lib/ansible/modules/network/cloudengine/ce_snmp_location.py

@@ -0,0 +1,252 @@
+#!/usr/bin/python
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+ANSIBLE_METADATA = {'status': ['preview'],
+                    'supported_by': 'community',
+                    'metadata_version': '1.0'}
+
+DOCUMENTATION = '''
+---
+module: ce_snmp_location
+version_added: "2.4"
+short_description: Manages SNMP location configuration on HUAWEI CloudEngine switches.
+description:
+    - Manages SNMP location configurations on HUAWEI CloudEngine switches.
+author:
+    - wangdezhuang (@CloudEngine-Ansible)
+options:
+    location:
+        description:
+            - Location information.
+        required: true
+        default: null
+    state:
+        description:
+            - Manage the state of the resource.
+        required: false
+        default: present
+        choices: ['present','absent']
+'''
+
+EXAMPLES = '''
+
+- name: CloudEngine snmp location test
+  hosts: cloudengine
+  connection: local
+  gather_facts: no
+  vars:
+    cli:
+      host: "{{ inventory_hostname }}"
+      port: "{{ ansible_ssh_port }}"
+      username: "{{ username }}"
+      password: "{{ password }}"
+      transport: cli
+
+  tasks:
+
+  - name: "Config SNMP location"
+    ce_snmp_location:
+      state:  present
+      location:  nanjing China
+      provider: "{{ cli }}"
+
+  - name: "Remove SNMP location"
+    ce_snmp_location:
+      state:  absent
+      location:  nanjing China
+      provider: "{{ cli }}"
+'''
+
+RETURN = '''
+changed:
+    description: check to see if a change was made on the device
+    returned: always
+    type: boolean
+    sample: true
+proposed:
+    description: k/v pairs of parameters passed into module
+    returned: always
+    type: dict
+    sample: {"location": "nanjing China",
+             "state": "present"}
+existing:
+    description: k/v pairs of existing aaa server
+    returned: always
+    type: dict
+    sample: {}
+end_state:
+    description: k/v pairs of aaa params after module execution
+    returned: always
+    type: dict
+    sample: {"location": "nanjing China"}
+updates:
+    description: command sent to the device
+    returned: always
+    type: list
+    sample: ["snmp-agent sys-info location nanjing China"]
+'''
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.ce import get_config, load_config, ce_argument_spec
+
+
+class SnmpLocation(object):
+    """ Manages SNMP location configuration """
+
+    def __init__(self, **kwargs):
+        """ Class init """
+
+        # module
+        argument_spec = kwargs["argument_spec"]
+        self.spec = argument_spec
+        self.module = AnsibleModule(argument_spec=self.spec, supports_check_mode=True)
+
+        # config
+        self.cur_cfg = dict()
+
+        # module args
+        self.state = self.module.params['state']
+        self.location = self.module.params['location']
+
+        # state
+        self.changed = False
+        self.updates_cmd = list()
+        self.results = dict()
+        self.proposed = dict()
+        self.existing = dict()
+        self.end_state = dict()
+
+    def check_args(self):
+        """ Check invalid args """
+
+        if self.location:
+            if len(self.location) > 255 or len(self.location) < 1:
+                self.module.fail_json(
+                    msg='Error: The len of location %s is out of [1 - 255].' % self.location)
+        else:
+            self.module.fail_json(
+                msg='Error: The len of location is 0.')
+
+    def get_proposed(self):
+        """ Get proposed state """
+
+        self.proposed["state"] = self.state
+
+        if self.location:
+            self.proposed["location"] = self.location
+
+    def get_existing(self):
+        """ Get existing state """
+
+        tmp_cfg = self.cli_get_config()
+        if tmp_cfg:
+            temp_data = tmp_cfg.split(r"location ")
+            self.cur_cfg["location"] = temp_data[1]
+            self.existing["location"] = temp_data[1]
+
+    def get_end_state(self):
+        """ Get end state """
+
+        tmp_cfg = self.cli_get_config()
+        if tmp_cfg:
+            temp_data = tmp_cfg.split(r"location ")
+            self.end_state["location"] = temp_data[1]
+
+    def cli_load_config(self, commands):
+        """ Load config by cli """
+
+        if not self.module.check_mode:
+            load_config(self.module, commands)
+
+    def cli_get_config(self):
+        """ Get config by cli """
+
+        regular = "| include snmp | include location"
+        flags = list()
+        flags.append(regular)
+        tmp_cfg = get_config(self.module, flags)
+
+        return tmp_cfg
+
+    def set_config(self):
+        """ Set configure by cli """
+
+        cmd = "snmp-agent sys-info location %s" % self.location
+        self.updates_cmd.append(cmd)
+
+        cmds = list()
+        cmds.append(cmd)
+
+        self.cli_load_config(cmds)
+        self.changed = True
+
+    def undo_config(self):
+        """ Undo configure by cli """
+
+        cmd = "undo snmp-agent sys-info location"
+        self.updates_cmd.append(cmd)
+
+        cmds = list()
+        cmds.append(cmd)
+
+        self.cli_load_config(cmds)
+        self.changed = True
+
+    def work(self):
+        """ Main work function """
+
+        self.check_args()
+        self.get_proposed()
+        self.get_existing()
+
+        if self.state == "present":
+            if "location" in self.cur_cfg.keys() and self.location == self.cur_cfg["location"]:
+                pass
+            else:
+                self.set_config()
+        else:
+            if "location" in self.cur_cfg.keys() and self.location == self.cur_cfg["location"]:
+                self.undo_config()
+
+        self.get_end_state()
+
+        self.results['changed'] = self.changed
+        self.results['proposed'] = self.proposed
+        self.results['existing'] = self.existing
+        self.results['end_state'] = self.end_state
+        self.results['updates'] = self.updates_cmd
+
+        self.module.exit_json(**self.results)
+
+
+def main():
+    """ Module main """
+
+    argument_spec = dict(
+        state=dict(choices=['present', 'absent'], default='present'),
+        location=dict(type='str', required=True)
+    )
+
+    argument_spec.update(ce_argument_spec)
+    module = SnmpLocation(argument_spec=argument_spec)
+    module.work()
+
+
+if __name__ == '__main__':
+    main()