New module: cnos_template (#21786)

* Initial cnos_template commit

* fix compile errs, update short description, move roles to integration/roles

* now commit the module

* Change module directory name to Lenovo

* change import cnos statement

lib/ansible/modules/network/lenovo/cnos_template.py

@@ -0,0 +1,179 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2017 Lenovo, Inc.
+#
+# 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/>.
+#
+# Module to send CLI templates to Lenovo Switches
+# Lenovo Networking
+#
+
+ANSIBLE_METADATA = {'status': ['preview'],
+                    'supported_by': 'community',
+                    'version': '1.0'}
+
+DOCUMENTATION = '''
+---
+module: cnos_template
+short_description: Manage switch configuration using templates on devices running Lenovo CNOS
+description:
+    - This module allows you to work with the running configuration of a switch. It provides a way
+     to execute a set of CNOS commands on a switch by evaluating the current running configuration
+     and executing the commands only if the specific settings have not been already configured.
+     The configuration source can be a set of commands or a template written in the Jinja2 templating language.
+     This module uses SSH to manage network device configuration.
+     The results of the operation will be placed in a directory named 'results'
+     that must be created by the user in their local directory to where the playbook is run.
+     For more information about this module from Lenovo and customizing it usage for your
+     use cases, please visit our [User Guide](http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_template.html)
+version_added: "2.3"
+extends_documentation_fragment: cnos
+options:
+    commandfile:
+        description:
+           - This specifies the path to the CNOS command file which needs to be applied. This usually
+             comes from the commands folder. Generally this file is the output of the variables applied
+             on a template file. So this command is preceded by a template module.
+             Note The command file must contain the Ansible keyword {{ inventory_hostname }} in its
+             filename to ensure that the command file is unique for each switch and condition.
+             If this is omitted, the command file will be overwritten during iteration. For example,
+             commandfile=./commands/clos_leaf_bgp_{{ inventory_hostname }}_commands.txt
+        required: true
+        default: Null
+'''
+EXAMPLES = '''
+Tasks : The following are examples of using the module cnos_template. These are written in the main.yml file of the tasks directory.
+---
+- name: Replace Config CLI command template with values
+  template:
+      src: demo_template.j2
+      dest: "./commands/demo_template_{{ inventory_hostname }}_commands.txt"
+      vlanid1: 13
+      slot_chassis_number1: "1/2"
+      portchannel_interface_number1: 100
+      portchannel_mode1: "active"
+
+- name: Applying CLI commands on Switches
+  cnos_template:
+      host: "{{ inventory_hostname }}"
+      username: "{{ hostvars[inventory_hostname]['username'] }}"
+      password: "{{ hostvars[inventory_hostname]['password'] }}"
+      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
+      enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
+      commandfile: "./commands/demo_template_{{ inventory_hostname }}_commands.txt"
+      outputfile: "./results/demo_template_command_{{ inventory_hostname }}_output.txt"
+
+'''
+RETURN = '''
+  return value: |
+    On successful execution, the method returns a message in JSON format
+    [Template Applied.]
+    Upon any failure, the method returns an error display string.
+'''
+import sys
+import paramiko
+import time
+import argparse
+import socket
+import array
+import json
+import time
+import re
+try:
+    from ansible.module_utils import cnos
+    HAS_LIB = True
+except:
+    HAS_LIB = False
+from ansible.module_utils.basic import AnsibleModule
+from collections import defaultdict
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            commandfile=dict(required=True),
+            outputfile=dict(required=True),
+            host=dict(required=True),
+            deviceType=dict(required=True),
+            username=dict(required=True),
+            password=dict(required=True, no_log=True),
+            enablePassword=dict(required=False, no_log=True),),
+        supports_check_mode=False)
+    username = module.params['username']
+    password = module.params['password']
+    enablePassword = module.params['enablePassword']
+    commandfile = module.params['commandfile']
+    outputfile = module.params['outputfile']
+    deviceType = module.params['deviceType']
+    hostIP = module.params['host']
+    output = ""
+
+    # Create instance of SSHClient object
+    remote_conn_pre = paramiko.SSHClient()
+
+    # Automatically add untrusted hosts (make sure okay for security policy in your environment)
+    remote_conn_pre.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+
+    # initiate SSH connection with the switch
+    remote_conn_pre.connect(hostIP, username=username, password=password)
+    time.sleep(2)
+
+    # Use invoke_shell to establish an 'interactive session'
+    remote_conn = remote_conn_pre.invoke_shell()
+    time.sleep(2)
+
+    # Enable and enter configure terminal then send command
+    output = output + cnos.waitForDeviceResponse("\n", ">", 2, remote_conn)
+
+    output = output + cnos.enterEnableModeForDevice(enablePassword, 3, remote_conn)
+
+    # Make terminal length = 0
+    output = output + cnos.waitForDeviceResponse("terminal length 0\n", "#", 2, remote_conn)
+
+    # Go to config mode
+    output = output + cnos.waitForDeviceResponse("configure d\n", "(config)#", 2, remote_conn)
+
+    # Send commands one by one
+    #with open(commandfile, "r") as f:
+    f = open(commandfile, "r")
+    for line in f:
+        # Omit the comment lines in template file
+        if not line.startswith("#"):
+            command = line
+            if not line.endswith("\n"):
+                command = command+"\n"
+            response = cnos.waitForDeviceResponse(command, "#", 2, remote_conn)
+            errorMsg = cnos.checkOutputForError(response)
+            output = output + response
+            if(errorMsg is not None):
+                break   # To cater to Mufti case
+    # Write to memory
+    output = output + cnos.waitForDeviceResponse("save\n", "#", 3, remote_conn)
+    # Write output to file
+    file = open(outputfile, "a")
+    file.write(output)
+    file.close()
+
+    # Logic to check when changes occur or not
+    errorMsg = cnos.checkOutputForError(output)
+    if(errorMsg is None):
+        module.exit_json(changed=True, msg="Template Applied")
+    else:
+        module.fail_json(msg=errorMsg)
+
+if __name__ == '__main__':
+    main()