cnos_backup – Резервное копирование текущей рабочей или начальной конфигурации на удалённый сервер на устройствах с Lenovo CNOS
Описание
- Этот модуль позволяет работать с конфигурациями коммутаторов. Он предоставляет способ резервного копирования рабочей или начальной конфигурации коммутатора на удалённый сервер. Это достигается путём периодического сохранения копии начальной или рабочей конфигурации сетевого устройства на удалённый сервер с использованием FTP, SFTP, TFTP или SCP. Первым шагом является создание каталога, из которого можно будет обратиться к удалённому серверу. Следующим шагом является предоставление полного пути к файлу, где будет выполнено резервное копирование конфигурации. Также необходимо предоставить данные для аутентификации, требуемые удалённым сервером. Этот модуль использует SSH для управления конфигурацией сетевых устройств. Результаты операции будут помещены в каталог с именем «results», который должен быть создан пользователем в локальном каталоге, где выполняется playbook.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| configType - / обязательно |
null | Указывает, какой тип конфигурации будет скопирован резервным образом. Возможные значения — рабочая или начальная конфигурация. Значения по умолчанию нет, поэтому неверный ввод приведёт к ошибке. |
| deviceType строка / обязательно |
| Указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены начиная с Ansible 2.4. Вариант NE0152T добавлен начиная с 2.8 |
| enablePassword строка | Настраивает пароль для входа в режим глобальной конфигурации коммутатора. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. | |
| host строка / обязательно | Эта переменная используется для поиска файла хостов по адресу /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применена шаблон. Обычно в playbook используется ключевое слово Ansible {{ inventory_hostname }} в качестве абстракции группы сетевых элементов, которые необходимо настроить. | |
| outputfile строка / обязательно | Указывает путь к файлу, где сохраняется вывод каждой команды. Здесь сохраняются каждая команда, указанная в объединённом файле шаблонов, и каждый ответ от устройства. Обычно это папка results, но вы можете выбрать другое местоположение, имея соответствующие права на запись. | |
| password строка / обязательно | Настраивает пароль, используемый для аутентификации подключения к удалённому устройству. Значение параметра password используется для аутентификации сеанса SSH. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. | |
| protocol - / обязательно |
null | Определяет протокол, используемый сетевым устройством для взаимодействия с удалённым сервером для загрузки резервной копии конфигурации. Доступные варианты — FTP, SFTP, TFTP или SCP. Использование других протоколов приведёт к ошибке. Если этот параметр не указан, значение по умолчанию не используется. |
| rcpath - / обязательно | Значение по умолчанию: null | Указывает полный путь к файлу, куда будет скопирован файл конфигурации на удалённом сервере. В случае использования относительного пути в качестве значения переменной, необходимо указать корневую папку для пользователя сервера. |
| rcserverip - / обязательно | Значение по умолчанию: null | Указывает IP-адрес удалённого сервера, куда будет выполнено резервное копирование конфигурации. |
| serverpassword - / обязательно | Значение по умолчанию: null | Укажите пароль для сервера, соответствующий используемому протоколу. |
| serverusername - / обязательно | Значение по умолчанию: null | Укажите имя пользователя для сервера, соответствующий используемому протоколу. |
| username строка / обязательно | Настраивает имя пользователя, используемое для аутентификации подключения к удалённому устройству. Значение параметра username используется для аутентификации сеанса SSH. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Lenovo Network см. на сайте 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
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
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
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
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 строка | всегда | Сообщение об успехе или неудаче Пример: Файл конфигурации передан на сервер |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/cnos_backup_module.html