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