community.network.cnos_backup модуль – Резервное копирование текущей запущенной или начальной конфигурации на удаленный сервер на устройствах под управлением Lenovo CNOS

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network.

Для использования в playbook, укажите: community.network.cnos_backup.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет работать с конфигурациями коммутатора. Он предоставляет способ резервного копирования запущенных или начальных конфигураций коммутатора на удаленный сервер. Это достигается путем периодического сохранения копии начальной или запущенной конфигурации сетевого устройства на удаленном сервере с использованием FTP, SFTP, TFTP или SCP. Первым шагом является создание каталога, из которого можно получить доступ к удаленному серверу. Следующим шагом является указание полного пути к файлу в месте, где будет создана резервная копия конфигурации. Необходимо также указать данные аутентификации, необходимые удаленному серверу. Этот модуль использует SSH для управления конфигурацией сетевого устройства. Результаты операции будут помещены в каталог с именем «results», который должен быть создан пользователем в своем локальном каталоге, в котором выполняется playbook.

Псевдонимы: network.cnos.cnos_backup

Параметры

Параметр	Комментарии
configType string / required	Указывает, какой тип конфигурации будет зарезервирован. Варианты: запущенная или начальная конфигурации. Отсутствует значение по умолчанию, поэтому некорректный ввод приведет к ошибке. Варианты: `"running-config"` `"startup-config"`
deviceType string / required	Указывает тип устройства, на котором выполняется метод. Варианты NE1072T,NE1032,NE1032T,NE10032,NE2572 добавлены начиная с Ansible 2.4. Вариант NE0152T добавлен начиная с 2.8 Варианты: `"g8272_cnos"` `"g8296_cnos"` `"g8332_cnos"` `"NE0152T"` `"NE1072T"` `"NE1032"` `"NE1032T"` `"NE10032"` `"NE2572"`
enablePassword string	Настраивает пароль, используемый для входа в режим команд глобальной конфигурации на коммутаторе. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его в виде переменной. Этот параметр является необязательным. Если он не указан, значение по умолчанию использоваться не будет.
host string / required	Это переменная, используемая для поиска файла hosts в /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применен шаблон. Обычно ключевое слово Ansible {{ inventory_hostname }} указывается в playbook как абстракция группы сетевых элементов, которые необходимо настроить.
outputfile string / required	Указывает путь к файлу, куда сохраняется результат каждого выполнения команды. Каждая команда, указанная в объединенном файле шаблона, и каждый ответ от устройства сохраняются здесь. Обычно это папка results, но вы можете выбрать другое местоположение в зависимости от ваших прав на запись.
password string / required	Настраивает пароль, используемый для аутентификации соединения с удаленным устройством. Значение параметра password используется для аутентификации сеанса SSH. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его в виде переменной. Этот параметр является необязательным. Если он не указан, значение по умолчанию использоваться не будет.
protocol string / required	Определяет протокол, используемый сетевым устройством для взаимодействия с удаленным сервером, на который необходимо загрузить резервную копию конфигурации. Варианты: FTP, SFTP, TFTP или SCP. Любые другие протоколы приведут к ошибке. Если этот параметр не указан, значение по умолчанию использоваться не будет. Варианты: `"SFTP"` `"SCP"` `"FTP"` `"TFTP"`
rcpath string / required	Указывает полный путь к файлу, куда будет скопирован файл конфигурации на удаленном сервере. В случае использования относительного пути в качестве значения переменной необходимо указать корневую папку для пользователя сервера.
rcserverip string / required	-Указывает IP-адрес удаленного сервера, на который будет создана резервная копия конфигурации.
serverpassword string / required	Укажите пароль для сервера, относящийся к используемому протоколу.
serverusername string / required	Укажите имя пользователя для сервера, относящееся к используемому протоколу.
username string / required	Настраивает имя пользователя, используемое для аутентификации соединения с удаленным устройством. Значение параметра 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 string	Сообщение об успехе или неудаче Возвращается: всегда Пример: `"Config file transferred to server"`

Авторы

Anil Kumar Muraleedharan (@amuraleedhar)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/cnos_backup_module.html