cnos_banner – Управление многострочными баннерами на устройствах Lenovo CNOS
Новая версия с 2.8.
Обзор
- Данный модуль настраивает баннеры входа и motd на удаленных устройствах, работающих под управлением Lenovo CNOS. Он позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner - / обязательно |
| Указывает, какой баннер должен быть настроен на удалённом устройстве. В Ansible 2.8 и более ранних версиях поддерживались только login и motd. | |
| provider - добавлен в 2.8 | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. руководство CNOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот параметр не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | Значение по умолчанию: 22 | Указывает порт для подключения к удалённому устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль возвращает ошибку. | |
| username - | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| state - |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации устройства. | |
| text - | Текст баннера, который должен присутствовать в рабочей конфигурации удалённого устройства. Этот параметр принимает многострочную строку без пустых строк. Требуется state=наличие. | ||
Примечания
Примечание
- Проверено на CNOS 10.8.1
Примеры
- name: configure the login banner
cnos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
cnos_banner:
banner: motd
state: absent
- name: Configure banner from file
cnos_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'] |
Статус
- Этот модуль не гарантирует обратной совместимости. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/cnos_banner_module.html
