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