community.network.cnos_banner – Управление многострочными баннерами на устройствах Lenovo CNOS
Примечание
Этот плагин входит в состав коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.cnos_banner.
Описание
- Это позволит настроить баннеры входа и приветствия на удалённых устройствах, работающих под управлением Lenovo CNOS. Он позволяет книгам задач добавлять или удалять текст баннера из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner строка / обязательно |
| Указывает, какой баннер следует настроить на удалённом устройстве. В Ansible 2.8 и более ранних версиях поддерживались только login и motd. | |
| provider строка | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli.Для получения дополнительной информации обратитесь к руководству CNOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды 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=present. | ||
Примечания
Примечание
- Проверено на CNOS 10.8.1
Примеры
- name: Configure the login banner
community.network.cnos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: Remove the motd banner
community.network.cnos_banner:
banner: motd
state: absent
- name: Configure banner from file
community.network.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'] |
Авторы
- Anil Kumar Muraleedharan (@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/cnos_banner_module.html
