├── .github ├── CODEOWNERS └── workflows │ └── publish-role.yml ├── .gitignore ├── LICENSE ├── README.md ├── defaults └── main.yml ├── meta └── main.yml ├── tasks └── main.yml ├── tests ├── inventory └── test.yml └── vars └── main.yml /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @stackhpc/ansible 2 | -------------------------------------------------------------------------------- /.github/workflows/publish-role.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Publish Ansible Role 3 | 'on': 4 | push: 5 | tags: 6 | - "v?[0-9]+.[0-9]+.[0-9]+" 7 | workflow_dispatch: 8 | jobs: 9 | publish_role: 10 | uses: stackhpc/.github/.github/workflows/publish-role.yml@main 11 | secrets: 12 | GALAXY_API_KEY: ${{ secrets.GALAXY_API_KEY }} 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Dell PowerConnect Switch 2 | ======================== 3 | 4 | This role configures Dell PowerConnect switches using the 5 | [expect](http://docs.ansible.com/ansible/latest/modules/expect_module.html) 6 | Ansible module. 7 | 8 | This role will install the python `expect` package to the system site packages 9 | on the local machine. 10 | 11 | Requirements 12 | ------------ 13 | 14 | The switches should be configured to allow SSH access. 15 | 16 | Role Variables 17 | -------------- 18 | 19 | `dell_powerconnect_switch_provider` is authentication provider information, 20 | similar to the `provider` argument to the `dellos` modules. It should be a dict 21 | containing the following fields: 22 | 23 | - `host`: the host or IP address of the switch. 24 | - `username`: the username with which to access the switch via SSH. 25 | - `auth_pass`: the password with which to authenticate. 26 | 27 | `dell_powerconnect_switch_config` is a list of configuration lines to apply to 28 | the switch, and defaults to an empty list. 29 | 30 | `dell_powerconnect_switch_interface_config` contains interface configuration. 31 | It is a dict mapping switch interface names to configuration dicts. Each dict 32 | may contain the following items: 33 | 34 | - `description` - a description to apply to the interface. 35 | - `name` - a name to apply to the vlan interface, if you're configuring a vlan. 36 | - `config` - a list of per-interface configuration. 37 | 38 | `dell_powerconnect_switch_write_memory` is a boolean flag, which when set to true, 39 | will save the switch's running configuration to the startup configuration file, 40 | after the role applies its configuration. This will allow the configuration to 41 | persist after a restart or power failure. By default, this option is set to false. 42 | 43 | `dell_powerconnect_switch_write_command` is the command which is run when the flag 44 | dell_powerconnect_switch_write_memory is set to true. The default command is 45 | "write memory". 46 | 47 | Dependencies 48 | ------------ 49 | 50 | None 51 | 52 | Example Playbook 53 | ---------------- 54 | 55 | The following playbook configures hosts in the `dell-powerconnect-switches` 56 | group. It assumes host variables for each switch holding the host, username 57 | and passwords. It applies global configuration for LLDP, enables two 10G 58 | ethernet interfaces as switchports, and saves the configuration changes to 59 | memory. 60 | 61 | --- 62 | - name: Ensure Dell PowerConnect switches are configured 63 | hosts: dell-powerconnect-switches 64 | gather_facts: no 65 | roles: 66 | - role: dell-powerconnect-switch 67 | dell_powerconnect_switch_write_memory: yes 68 | dell_powerconnect_switch_provider: 69 | host: "{{ switch_host }}" 70 | username: "{{ switch_user }}" 71 | password: "{{ switch_password }}" 72 | transport: cli 73 | authorize: yes 74 | auth_pass: "{{ switch_auth_pass }}" 75 | dell_powerconnect_switch_config: 76 | - "protocol lldp" 77 | - " advertise dot3-tlv max-frame-size" 78 | - " advertise management-tlv management-address system-description system-name" 79 | - " advertise interface-port-desc" 80 | - " no disable" 81 | - " exit" 82 | dell_powerconnect_switch_interface_config: 83 | Te1/1/1: 84 | description: server-1 85 | config: 86 | - "no shutdown" 87 | - "switchport" 88 | Te1/1/2: 89 | description: server-2 90 | config: 91 | - "no shutdown" 92 | - "switchport" 93 | "vlan 1234": 94 | name: "mytestvlan" 95 | config: 96 | - "ip address 192.168.1.254 255.255.255.0" 97 | 98 | Author Information 99 | ------------------ 100 | 101 | - Mark Goddard () 102 | -------------------------------------------------------------------------------- /defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Authentication provider information. 3 | dell_powerconnect_switch_provider: 4 | 5 | # List of configuration lines to apply to the switch. 6 | dell_powerconnect_switch_config: [] 7 | 8 | # Interface configuration. Dict mapping switch interface names to configuration 9 | # dicts. Each dict contains a 'description' (or 'name' in case of vlans) item and 10 | # a 'config' item which should contain a list of per-interface configuration. 11 | dell_powerconnect_switch_interface_config: {} 12 | 13 | # When true, switch configuration will be written to the startup config file. 14 | dell_powerconnect_switch_write_memory: false 15 | 16 | # Change this to override the command to save switch configuration 17 | dell_powerconnect_switch_write_command: "write memory" 18 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | galaxy_info: 3 | # role_name: dell-powerconnect-switch 4 | # namespace: stackhpc 5 | author: Mark Goddard 6 | description: > 7 | Role to configure Dell PowerConnect switches 8 | company: StackHPC Ltd 9 | license: Apache2 10 | min_ansible_version: "2.0" 11 | platforms: 12 | - name: EL 13 | versions: 14 | - all 15 | galaxy_tags: 16 | - networking 17 | - dell 18 | - switch 19 | - powerconnect 20 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Need to use pip since the CentOS provided package is too old for Ansible. 3 | - name: Ensure the pexpect Python package is installed 4 | delegate_to: localhost 5 | ansible.builtin.pip: 6 | name: pexpect 7 | state: present 8 | become: true 9 | 10 | - name: Ensure global switch configuration is applied 11 | delegate_to: localhost 12 | ansible.builtin.expect: 13 | command: "ssh {{ ansible_ssh_common_args | default }} {{ dell_powerconnect_switch_provider.username }}@{{ dell_powerconnect_switch_provider.host }}" 14 | responses: >- 15 | {{ dell_powerconnect_auth_responses | 16 | combine(enable_responses) | 17 | combine(main_responses) | 18 | combine(config_responses) }} 19 | register: result 20 | failed_when: >- 21 | result.get('rc') != 255 or 22 | '% Unrecognized command' in result.stdout_lines or 23 | "% Invalid input detected at '^' marker." in result.stdout_lines or 24 | "% missing mandatory parameter" in result.stdout_lines or 25 | "% bad parameter value" in result.stdout_lines or 26 | 'Connection to ' ~ dell_powerconnect_switch_provider.host ~ ' closed.' not in result.stdout_lines[-1] 27 | vars: 28 | enable_responses: "{{ {dell_powerconnect_enable_prompt: ['enable', 'exit']} }}" 29 | main_responses: "{{ {dell_powerconnect_main_prompt: ['configure', 'exit']} }}" 30 | config_responses: "{{ {dell_powerconnect_config_prompt: dell_powerconnect_switch_config + ['exit']} }}" 31 | 32 | - name: Ensure switch interface configuration is applied 33 | delegate_to: localhost 34 | ansible.builtin.expect: 35 | command: "ssh {{ ansible_ssh_common_args | default }} {{ dell_powerconnect_switch_provider.username }}@{{ dell_powerconnect_switch_provider.host }}" 36 | responses: >- 37 | {{ dell_powerconnect_auth_responses | 38 | combine(enable_responses) | 39 | combine(main_responses) | 40 | combine(config_responses) | 41 | combine(interface_responses) }} 42 | register: result 43 | failed_when: >- 44 | result.get('rc') != 255 or 45 | "% Invalid input detected at '^' marker." in result.stdout_lines or 46 | '% Unrecognized command' in result.stdout_lines or 47 | "% missing mandatory parameter" in result.stdout_lines or 48 | "% bad parameter value" in result.stdout_lines or 49 | 'Connection to ' ~ dell_powerconnect_switch_provider.host ~ ' closed.' not in result.stdout_lines[-1] 50 | with_dict: "{{ dell_powerconnect_switch_interface_config }}" 51 | vars: 52 | enable_responses: "{{ {dell_powerconnect_enable_prompt: ['enable', 'exit']} }}" 53 | main_responses: "{{ {dell_powerconnect_main_prompt: ['configure', 'exit']} }}" 54 | config_responses: "{{ {dell_powerconnect_config_prompt: ['interface ' ~ item.key, 'exit']} }}" 55 | # Long config lines seem to confuse expect, so we add two exits. 56 | interface_responses: >- 57 | {{ {dell_powerconnect_interface_prompt: 58 | (['description ' ~ item.value.description] if 'description' in item.value else []) + 59 | (['name ' ~ item.value.name] if 'name' in item.value else []) + 60 | item.value.config | default([]) + 61 | ['exit', 'exit']} }} 62 | loop_control: 63 | label: | 64 | "{'interface': '{{ item.key }}', 65 | 'description': '{{ item.value.description | default('') }}', 66 | 'name': '{{ item.value.name | default('') }}', 67 | 'config': '{{ item.value.config | default([]) }}'}" 68 | - name: Write running configuration to startup configuration 69 | delegate_to: localhost 70 | ansible.builtin.expect: 71 | command: "ssh {{ ansible_ssh_common_args | default }} {{ dell_powerconnect_switch_provider.username }}@{{ dell_powerconnect_switch_provider.host }}" 72 | responses: >- 73 | {{ dell_powerconnect_auth_responses | 74 | combine(dell_powerconnect_write_responses) | 75 | combine(enable_responses) | 76 | combine(main_responses) }} 77 | register: result 78 | failed_when: >- 79 | result.get('rc') != 255 or 80 | '% Unrecognized command' in result.stdout_lines or 81 | "% Invalid input detected at '^' marker." in result.stdout_lines or 82 | "% missing mandatory parameter" in result.stdout_lines or 83 | "% bad parameter value" in result.stdout_lines or 84 | 'Connection to ' ~ dell_powerconnect_switch_provider.host ~ ' closed.' not in result.stdout_lines[-1] 85 | vars: 86 | enable_responses: "{{ {dell_powerconnect_enable_prompt: ['enable', 'exit']} }}" 87 | main_responses: "{{ {dell_powerconnect_main_prompt: [dell_powerconnect_switch_write_command, 'exit']} }}" 88 | when: dell_powerconnect_switch_write_memory | bool 89 | -------------------------------------------------------------------------------- /tests/inventory: -------------------------------------------------------------------------------- 1 | [switches] 2 | localhost ansible_connection='local' ansible_python_interpreter='/usr/bin/env python' 3 | -------------------------------------------------------------------------------- /tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: switches 3 | connection: local 4 | roles: 5 | - stackhpc.dell-powerconnect-switch 6 | -------------------------------------------------------------------------------- /vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | dell_powerconnect_main_prompt: "([Cc]onsole|{{ inventory_hostname }})#[\\s]?" 3 | dell_powerconnect_config_prompt: "([Cc]onsole|{{ inventory_hostname }})\\(config(-vlan)?\\)#[\\s]?" 4 | dell_powerconnect_interface_prompt: "([Cc]onsole|{{ inventory_hostname }})\\(config-if.*\\)#[\\s]?" 5 | dell_powerconnect_enable_prompt: "([Cc]onsole|{{ inventory_hostname }})>[\\s]?" 6 | 7 | dell_powerconnect_auth_responses: 8 | "User Name:": "{{ dell_powerconnect_switch_provider.username }}" 9 | "(?i).*Password:": "{{ dell_powerconnect_switch_provider.auth_pass }}" 10 | 11 | dell_powerconnect_write_responses: 12 | "Overwrite file \\[startup\\-config\\] \\?\\[Yes\\/press any key for no\\]\\.\\.\\.\\.": "Y" 13 | --------------------------------------------------------------------------------