Spec-Zone.ru › Ansible 2.4

ios_banner - Управление многострочными баннерами на устройствах Cisco IOS

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

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

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

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

Параметры

параметр обязательный по умолчанию выбор комментарии
auth_pass
нет нет
Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
banner
да
  • login
  • motd
Указывает, какой баннер должен быть настроен на удаленном устройстве.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательный по умолчанию выбор комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_USERNAME.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
auth_pass
нет нет
Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
host
да
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
timeout
нет 10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, то используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт, используемый при установлении подключения к удаленному устройству.
state
нет present
  • present
  • absent
Указывает, присутствует ли конфигурация в активной рабочей конфигурации текущих устройств.
text
нет
Текст баннера, который должен присутствовать в рабочей конфигурации удаленного устройства. Этот аргумент принимает многострочный текст без пустых строк. Требуется state=present.

Примеры

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

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

- name: Configure banner from file
  ios_banner:
    banner:  motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
    state: present

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

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

название описание возвращаемое значение тип пример
commands
Список команд конфигурации режима, которые нужно отправить устройству
всегда список ['banner login', 'this is my login banner', 'that contains a multiline', 'string']

Примечания

Примечание

  • Проверено на IOS 15.6

Статус

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

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

Дополнительную информацию о поддержке этого модуля компанией 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/ios_banner_module.html

Spec-Zone.ru

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