Модуль f5networks.f5_modules.bigip_device_sshd — управление настройками SSHD устройства BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_device_sshd.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

Управление настройками SSHD (демона безопасной оболочки) устройства BIG-IP.

Параметры

Параметр	Описание
allow list / elements=string	Если доступ по SSH включен, указывает IP-адрес или диапазон адресов других систем, которым разрешено взаимодействовать с этой системой по SSH. Чтобы указать все адреса, используйте значение `all`. Можно указать IP-адрес, например 172.27.1.10. Можно указать диапазоны IP-адресов, например 172.27.. или 172.27.0.0/255.255.0.0. Чтобы удалить доступ по SSH, укажите пустой список или пустую строку.
banner string	Включить или отключить баннер. Варианты: `"enabled"` `"disabled"`
banner_text string	Задает текст предварительного баннера, отображаемого при попытке пользователя войти в систему по SSH.
inactivity_timeout integer	Задает количество секунд бездействия, после которого сеанс SSH завершается.
log_level string	Задает минимальный уровень сообщений SSHD, включаемых в системный журнал. Варианты: `"debug"` `"debug1"` `"debug2"` `"debug3"` `"error"` `"fatal"` `"info"` `"quiet"` `"verbose"`
login string	Если параметр установлен в `enabled`, система принимает SSH-подключения. Варианты: `"enabled"` `"disabled"`
port integer	Порт, на котором должен работать демон SSH.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с данными для подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если задано `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку ее название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если задано `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Требуется BIG-IP версии 12.0.0 или выше
Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется BIG-IP версии >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить специфичную для BIG-IP конфигурацию на диск, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по правильному использованию модуля для сохранения текущей конфигурации см. в документации модуля.

Примеры

- name: Set the banner for the SSHD service from a string
  bigip_device_sshd:
    banner: enabled
    banner_text: banner text goes here
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set the banner for the SSHD service from a file
  bigip_device_sshd:
    banner: enabled
    banner_text: "{{ lookup('file', '/path/to/file') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set the SSHD service to run on port 2222
  bigip_device_sshd:
    port: 2222
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Описание
allow list / elements=string	Если доступ по SSH включен, указывает IP-адрес или диапазон адресов других систем, которым разрешено взаимодействовать с этой системой по SSH. Возвращается: changed Пример: `["192.0.2.*"]`
banner string	Указывает, включен ли баннер. Возвращается: changed Пример: `"True"`
banner_text string	Задает текст предварительного баннера, отображаемого при попытке пользователя войти в систему по SSH. Возвращается: changed и success Пример: `"This is a corporate device. Connecting to it without..."`
inactivity_timeout integer	Количество секунд бездействия, после которого сеанс SSH завершается. Возвращается: changed Пример: `10`
log_level string	Минимальный уровень сообщений SSHD, включаемых в системный журнал. Возвращается: changed Пример: `"debug"`
login boolean	Указывает, принимает ли система SSH-подключения. Возвращается: changed Пример: `true`
port integer	Порт, на котором должен работать демон SSH. Возвращается: changed Пример: `22`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_device_sshd_module.html