Spec-Zone.ru › Ansible 2.4

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
да
  • running-config
  • startup-config
Указывает, какой тип конфигурации будет создана резервная копия. Доступные варианты — текущая или стартовая конфигурация. Значение по умолчанию отсутствует, поэтому некорректный ввод приведёт к ошибке.
deviceType
(добавлено в 2.3)
да
  • g8272_cnos
  • g8296_cnos
  • g8332_cnos
  • NE1072T
  • NE1032
  • NE1032T
  • NE10032
  • NE2572
Указывает тип устройства, на котором выполняется метод. Значения NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены начиная с версии 2.4
enablePassword
(добавлено в 2.3)
нет
Устанавливает пароль для входа в режим глобальной конфигурации коммутатора. Если коммутатор не запрашивает этот пароль, параметр игнорируется. В целом значение должно поступать из файла инвентаризации, но вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не используется.
host
(добавлено в 2.3)
да
Используется для поиска в файле hosts по пути /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применена конфигурация. Обычно в плейбуке используется ключевое слово Ansible {{ inventory_hostname }} в качестве абстракции группы сетевых элементов, которые необходимо настроить.
outputfile
(добавлено в 2.3)
да
Указывает путь к файлу, где сохраняются результаты выполнения каждой команды. Здесь сохраняются команды, указанные в объединённом файле шаблона, и все ответы от устройства. Обычно это папка results, но вы можете выбрать другое место в зависимости от ваших прав доступа.
password
(добавлено в 2.3)
да
Устанавливает пароль для аутентификации подключения к удалённому устройству. Значение параметра password используется для аутентификации сеанса SSH. В целом значение должно поступать из файла инвентаризации, но вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не используется.
protocol
да
  • SFTP
  • SCP
  • FTP
  • TFTP
Указывает протокол, используемый сетевым устройством для взаимодействия с удалённым сервером, куда загружается резервная копия конфигурации. Допустимые варианты — FTP, SFTP, TFTP или SCP. Любые другие протоколы приведут к ошибке. Если этот параметр не указан, значение по умолчанию не используется.
rcpath
да
Указывает полный путь к файлу, куда конфигурационный файл будет скопирован на удалённом сервере. В случае использования относительного пути в качестве значения переменной необходимо указать корневую папку для пользователя сервера.
rcserverip
да
Указывает IP-адрес удалённого сервера, куда будет сохранена резервная копия конфигурации.
serverpassword
да
Укажите пароль для сервера, относящегося к используемому протоколу.
serverusername
да
Укажите имя пользователя для сервера, относящегося к используемому протоколу.
username
(добавлено в 2.3)
да
Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Значение параметра username используется для аутентификации сеанса SSH. В целом значение должно поступать из файла инвентаризации, но вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не используется.

Примеры

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]['username'] }}"
      password: "{{ hostvars[inventory_hostname]['password'] }}"
      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]['username'] }}"
      password: "{{ hostvars[inventory_hostname]['password'] }}"
      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]['username'] }}"
      password: "{{ hostvars[inventory_hostname]['password'] }}"
      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]['username'] }}"
      password: "{{ hostvars[inventory_hostname]['password'] }}"
      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 и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API