Spec-Zone.ru › Ansible 2.7

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

Новая версия 2.3.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
configType
- / обязательно
    Варианты:
  • running-config
  • startup-config
Значение по умолчанию:
null
Указывает, какой тип конфигурации будет скопирован. Варианты — текущая или стартовая конфигурация. Значения по умолчанию нет, поэтому неверный ввод приведёт к ошибке.
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
Используется для поиска в файле хостов по пути /etc/ansible/hosts и определения IP-адреса устройства, на которое будет применена конфигурация. Обычно в playbook используется Ansible-ключевое слово {{ inventory_hostname }} как абстракция группы сетевых элементов, которые нужно настроить.
outputfile
- / обязательно
добавлен в 2.3
Указывает путь к файлу, в котором сохраняется вывод каждого выполненного команд. Каждый команд, указанный в объединённом файле шаблона, и каждый ответ от устройства сохраняются здесь. Обычно используется каталог results, но вы можете выбрать другое расположение, исходя из ваших прав записи.
password
- / обязательно
добавлен в 2.3
Настраивает пароль, используемый для аутентификации подключения к удалённому устройству. Значение параметра password используется для аутентификации SSH-сессии. Обычно значение берётся из файла инвентаризации, но может быть указано и как переменная. Параметр необязательный. Если он не указан, значение по умолчанию не используется.
protocol
- / обязательно
    Варианты:
  • SFTP
  • SCP
  • FTP
  • TFTP
Значение по умолчанию:
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:
      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.7/modules/cnos_backup_module.html

Spec-Zone.ru

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