cnos_backup - Архивирование текущей или стартовой конфигурации на удаленном сервере на устройствах с Lenovo CNOS
Новое в версии 2.3.
Описание
- Этот модуль позволяет работать с конфигурациями коммутаторов. Он предоставляет способ создания резервной копии текущей или стартовой конфигурации коммутатора на удаленном сервере. Это достигается путем периодического сохранения копии стартовой или текущей конфигурации сетевого устройства на удаленном сервере с использованием FTP, SFTP, TFTP или SCP. Первый шаг — создание каталога, из которого можно получить доступ к удаленному серверу. Следующий шаг — предоставление полного пути к файлу, в котором будет создана резервная копия конфигурации. Также необходимо предоставить данные для аутентификации, требуемые удаленным сервером. Этот модуль использует SSH для управления конфигурацией сетевых устройств. Результаты операции будут помещены в каталог с именем «results», который должен быть создан пользователем в локальном каталоге, где выполняется playbook. Для получения дополнительной информации об этом модуле от Lenovo и для настройки его использования в ваших задачах, пожалуйста, посетите http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_backup.html
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| configType обязательно |
Нет | Указывает тип конфигурации, который будет резервироваться. Возможные варианты — текущая или стартовая конфигурация. Значение по умолчанию отсутствует, поэтому неверный ввод приведёт к ошибке. |
| deviceType обязательно (добавлено в 2.3) |
Нет | Указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены с версии 2.4 |
| enablePassword (добавлено в 2.3) | Значение по умолчанию: Нет | Настраивает пароль, используемый для входа в режим глобальной конфигурации коммутатора. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
| host обязательно (добавлено в 2.3) | Значение по умолчанию: Нет | Эта переменная используется для поиска файла хостов по пути /etc/ansible/hosts и определения IP-адреса устройства, на которое будет применена шаблон. Обычно в плейбуке используется ключевое слово Ansible {{ inventory_hostname }} в качестве абстракции группы сетевых элементов, которые требуется настроить. |
| outputfile обязательно (добавлено в 2.3) | Значение по умолчанию: Нет | Указывает путь к файлу, в котором сохраняется вывод каждой команды. Здесь сохраняются как команды, указанные в объединённом файле шаблона, так и ответы от устройства. Обычно это папка results, но вы можете выбрать другое местоположение в зависимости от прав на запись. |
| password обязательно (добавлено в 2.3) | Значение по умолчанию: Нет | Настраивает пароль, используемый для аутентификации подключения к удалённому устройству. Значение параметра password используется для аутентификации сеанса SSH. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
| protocol обязательно |
Нет | Указывает протокол, используемый сетевым устройством для взаимодействия с удалённым сервером для загрузки резервной конфигурации. Возможные варианты — FTP, SFTP, TFTP или SCP. Любой другой протокол приведёт к ошибке. Если этот параметр не указан, значение по умолчанию не используется. |
| rcpath обязательно | Значение по умолчанию: Нет | Указывает полный путь к файлу конфигурации, который будет скопирован на удалённый сервер. Если в качестве значения переменной используется относительный путь, необходимо указать корневую папку для пользователя сервера. |
| rcserverip обязательно | Значение по умолчанию: Нет | Указывает IP-адрес удалённого сервера, на который будет резервироваться конфигурация. |
| serverpassword обязательно | Значение по умолчанию: Нет | Укажите пароль для сервера, соответствующий используемому протоколу. |
| serverusername обязательно | Значение по умолчанию: Нет | Укажите имя пользователя для сервера, соответствующего используемому протоколу. |
| Имя пользователя обязательно (добавлено в 2.3) | Значение по умолчанию: Отсутствует | Настраивает имя пользователя, используемое для аутентификации подключения к удаленному устройству. Значение параметра имени пользователя используется для аутентификации сессии 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:
host: "{{ inventory_hostname }}"
username: "{{ hostvars[inventory_hostname]['ansible_ssh_user'] }}"
password: "{{ hostvars[inventory_hostname]['ansible_ssh_pass'] }}"
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
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:
host: "{{ inventory_hostname }}"
username: "{{ hostvars[inventory_hostname]['ansible_ssh_user'] }}"
password: "{{ hostvars[inventory_hostname]['ansible_ssh_pass'] }}"
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
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:
host: "{{ inventory_hostname }}"
username: "{{ hostvars[inventory_hostname]['ansible_ssh_user'] }}"
password: "{{ hostvars[inventory_hostname]['ansible_ssh_pass'] }}"
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
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:
host: "{{ inventory_hostname }}"
username: "{{ hostvars[inventory_hostname]['ansible_ssh_user'] }}"
password: "{{ hostvars[inventory_hostname]['ansible_ssh_pass'] }}"
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
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"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| сообщение строка | всегда | Сообщение об успехе или ошибке Пример: Файл конфигурации передан на сервер |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/cnos_backup_module.html