Spec-Zone.ru › Ansible 2.4

eos_banner - Управление многострочными баннерами на устройствах Arista EOS

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

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Описание

  • Это позволит настроить баннеры входа и motd на удаленных устройствах, работающих на Arista EOS. Это позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.

Параметры

параметр обязательно по умолчанию возможные значения комментарии
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
banner
да
  • вход
  • motd
Указывает, какой баннер должен быть настроен на удаленном устройстве.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательно по умолчанию возможные значения комментарии
username
нет
Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в консоль CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
host
да
Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
timeout
нет 10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
use_ssl
нет True
  • да
  • нет
Настраивает transport на использование SSL, если значение равно true только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или eapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
validate_certs
нет
  • да
  • нет
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не eapi, это значение игнорируется.
port
нет 0 (использовать общий порт)
Указывает порт для подключения к удалённому устройству. Это значение относится к cli или eapi. Значение порта по умолчанию соответствует общему порту соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443).
transport
да cli
  • eapi
  • cli
Настраивает транспортное соединение для подключения к удалённому устройству.
state
нет present
  • present
  • absent
Указывает, присутствует ли конфигурация в активной рабочей конфигурации текущих устройств.
text
нет
Текст баннера, который должен присутствовать в конфигурации удалённого устройства. Этот аргумент принимает многострочный текст. Требуется state=present.

Примеры

- name: configure the login banner
  eos_banner:
    banner: login
    text: |
      this is my login banner
      that contains a multiline
      string
    state: present

- name: remove the motd banner
  eos_banner:
    banner: motd
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:

название описание возвращается тип пример
commands
Список команд режима конфигурации для отправки на устройство
всегда список ['banner login', 'это мой баннер входа', 'который содержит многострочный', 'строку', 'EOF']
session_name
Имя сессии конфигурации EOS, используемое для загрузки конфигурации
при изменениях строка ansible_1479315771

Примечания

Примечание

  • Проверено на EOS 4.15

Статус

Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля Red Hat см. в этом knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Чтобы узнать больше о разработке модулей, прочтите Информацию о сообществе и участии в разработке, Тестирование 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/eos_banner_module.html

Spec-Zone.ru

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