community.network.cnos_backup – Резервное копирование текущей или стартовой конфигурации на удаленный сервер на устройствах с Lenovo CNOS
Примечание
Этот плагин входит в состав коллекции community.network (версия 2.0.1).
Для его установки используйте: 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/cnos_backup_module.html