community.network.cnos_backup – Резервное копирование текущей рабочей или стартовой конфигурации на удалённый сервер на устройствах, работающих под управлением Lenovo CNOS
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач, укажите: community.network.cnos_backup.
Обзор
- Этот модуль позволяет работать с конфигурациями коммутаторов. Он предоставляет способ резервного копирования текущей или стартовой конфигурации коммутатора на удалённый сервер. Это достигается периодическим сохранением копии стартовой или текущей конфигурации сетевого устройства на удалённый сервер с помощью FTP, SFTP, TFTP или SCP. Первым шагом является создание каталога, к которому может получить доступ удалённый сервер. Следующим шагом является указание полного пути к файлу, где будет выполнено резервное копирование конфигурации. Также необходимо предоставить данные для аутентификации, требуемые удалённым сервером. Этот модуль использует SSH для управления конфигурацией сетевого устройства. Результаты операции будут помещены в каталог с именем «results», который должен быть создан пользователем в локальном каталоге, где выполняется книга задач.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| configType строка / обязательно |
| Указывает, какой тип конфигурации будет скопирован. Возможные значения — текущая или стартовая конфигурация. Значение по умолчанию отсутствует, поэтому неправильный ввод приведёт к ошибке. |
| deviceType строка / обязательно |
| Указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены с Ansible 2.4. Вариант NE0152T добавлен с 2.8 |
| enablePassword строка | Настраивает пароль, используемый для входа в режим глобальной конфигурации коммутатора. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Обычно значение берётся из файла инвентаризации, но можно также указать его как переменную. Этот параметр необязательный. Если он не указан, значение по умолчанию не будет использоваться. | |
| host строка / обязательно | Переменная для поиска в файле хостов /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применена шаблон. Обычно в книге задач используется ключевое слово Ansible {{ inventory_hostname }} для абстрагирования группы сетевых элементов, которые необходимо настроить. | |
| outputfile строка / обязательно | Указывает путь к файлу, в котором сохраняются результаты выполнения каждой команды. Здесь сохраняются и команды, указанные в объединённом файле шаблона, и каждый ответ от устройства. Обычно используется папка results, но можно выбрать другое место в зависимости от разрешений на запись. | |
| password строка / обязательно | Настраивает пароль, используемый для аутентификации соединения с удалённым устройством. Значение параметра password используется для аутентификации сеанса SSH. Обычно значение берётся из файла инвентаризации, но можно также указать его как переменную. Этот параметр необязательный. Если он не указан, значение по умолчанию не будет использоваться. | |
| protocol строка / обязательно |
| Указывает протокол, используемый сетевым устройством для взаимодействия с удалённым сервером для загрузки резервной копии конфигурации. Возможные значения — FTP, SFTP, TFTP или SCP. Любые другие протоколы приведут к ошибке. Если этот параметр не указан, значение по умолчанию отсутствует. |
| rcpath строка / обязательно | Указывает полный путь, куда будет скопирован файл конфигурации на удалённом сервере. Если используется относительный путь, необходимо указать корневой каталог для пользователя сервера. | |
| rcserverip строка / обязательно | Указывает IP-адрес удалённого сервера, на который будет выполнено резервное копирование конфигурации. | |
| serverpassword строка / обязательно | Указывает пароль для сервера, относящегося к используемому протоколу. | |
| serverusername строка / обязательно | Указывает имя пользователя для сервера, относящегося к используемому протоколу. | |
| username строка / обязательно | Настраивает имя пользователя, используемое для аутентификации соединения с удалённым устройством. Значение параметра username используется для аутентификации сеанса SSH. Обычно значение берётся из файла инвентаризации, но можно также указать его как переменную. Этот параметр необязательный. Если он не указан, значение по умолчанию не будет использоваться. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Lenovo см. на странице https://www.ansible.com/ansible-lenovo.
Примеры
Tasks : The following are examples of using the module cnos_backup.
These are written in the main.yml file of the tasks directory.
---
- name: Test Running Config Backup
community.network.cnos_backup:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
configType: running-config
protocol: "sftp"
serverip: "10.241.106.118"
rcpath: "/root/cnos/G8272-running-config.txt"
serverusername: "root"
serverpassword: "root123"
- name: Test Startup Config Backup
community.network.cnos_backup:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
configType: startup-config
protocol: "sftp"
serverip: "10.241.106.118"
rcpath: "/root/cnos/G8272-startup-config.txt"
serverusername: "root"
serverpassword: "root123"
- name: Test Running Config Backup -TFTP
community.network.cnos_backup:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
configType: running-config
protocol: "tftp"
serverip: "10.241.106.118"
rcpath: "/anil/G8272-running-config.txt"
serverusername: "root"
serverpassword: "root123"
- name: Test Startup Config Backup - TFTP
community.network.cnos_backup:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
configType: startup-config
protocol: "tftp"
serverip: "10.241.106.118"
rcpath: "/anil/G8272-startup-config.txt"
serverusername: "root"
serverpassword: "root123"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| msg строка | всегда | Сообщение об успехе или ошибке Пример: Файл конфигурации передан на сервер |
Авторы
- Anil Kumar Muraleedharan (@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/cnos_backup_module.html