f5networks.f5_modules.bigiq_device_discovery – Управление устройствами BIG-IP через BIG-IQ

Примечание

Этот плагин является частью коллекции f5networks.f5_modules (версия 1.6.0).

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigiq_device_discovery.

Новое в версии 1.0.0: of f5networks.f5_modules

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

Описание

Обнаруживает и импортирует конфигурацию устройства BIG-IP на BIG-IQ.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_conflict_policy строка		Варианты: use_bigiq use_bigip keep_version	Устанавливает политику разрешения конфликтов для модуля доступа `apm` объектов. Используется только при указании модуля `apm`.
access_group_first_device логический тип		Варианты: no yes ←	Указывает, является ли импортированное устройство первым в группе доступа для импорта общей конфигурации этой группы.
access_group_name строка			Имя группы доступа для импорта конфигурации доступа для устройств. После установки оно не может быть изменено.
conflict_policy строка		Варианты: use_bigiq ← use_bigip	Устанавливает политику разрешения конфликтов для общих объектов между устройствами BIG-IP, за исключением профилей LTM и мониторов.
device_address строка / обязательно			IP-адрес устройства BIG-IP, подлежащего импорту/управлению.
device_conflict_policy строка		Варианты: use_bigiq ← use_bigip	Устанавливает политику разрешения конфликтов для объектов, специфичных для конкретного устройства BIG-IP и не общих среди устройств BIG-IP.
device_password строка			Пароль администратора для устройства BIG-IP. Этот параметр требуется только при добавлении нового устройства BIG-IP для управления.
device_port целое число		Значение по умолчанию: 443	Порт, на котором должно происходить установление доверия между BIG-IQ и BIG-IP.
device_username строка			Имя пользователя администратора для устройства BIG-IP. Этот параметр требуется только при добавлении нового устройства BIG-IP для управления.
force логический тип		Варианты: no ← yes	Принудительно переоткрывает и импортирует существующие модули на управляемом BIG-IP.
ha_name строка			Имя кластера DSC устройства BIG-IP, подлежащего управлению. Этот параметр необязателен, если управляемое устройство не является частью группы кластеров. Когда `use_bigiq_sync` установлено на `yes`, этот параметр требуется.
modules список / элементы=строка		Варианты: ltm asm apm afm dns websafe security_shared	Список модулей, которые необходимо открыть и импортировать в устройство. Эти модули должны быть развернуты на целевом устройстве, в противном случае произойдет сбой операции. Модуль `ltm` должен всегда указываться при обнаружении или повторном обнаружении устройства. Когда `asm` или `afm` указаны, модуль `shared_security` также необходимо объявить.
provider словарь добавлено в 1.0.0 of f5networks.f5_modules			Объект типа dict, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem логический тип	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете пропустить этот параметр, установив переменную окружения `F5_TEEM`.
	password строка / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_PASSWORD`. алиасы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете пропустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логический тип	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете пропустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
state строка		Варианты: absent present ←	Состояние управляемого устройства в системе. Когда `present`, позволяет добавление новых устройств, а также повторное обнаружение/импорт устройств. Когда `absent`, полностью удаляет устройство из системы.
statistics словарь			Укажите сбор статистики для обнаруженного устройства.
	enable логический тип	Варианты: no ← yes	Включает сбор статистики на устройстве.
	interval целое число	Варианты: 30 60 120 500 Значение по умолчанию: 60	Указывает интервал сбора данных с обнаруженного устройства в секундах.
	stat_modules список / элементы=строка	Варианты: device ← ltm ← dns Значение по умолчанию: ["device", "ltm"]	Указывает, для каких модулей собираются данные.
	zone строка	Значение по умолчанию: "default"	Указывает, в какой зоне DCD собираются данные с устройства.
use_bigiq_sync логический тип		Варианты: no ← yes	При установке в значение true, BIG-IQ вручную синхронизирует изменения конфигурации между членами кластера DSC.
versioned_conflict_policy строка		Варианты: use_bigiq use_bigip keep_version	Устанавливает политику разрешения конфликтов для профилей LTM и мониторов, специфичных для определенной версии ПО BIG-IP.

Примечания

Примечание

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

Примеры

- name: Discover a new device and import config, use default conflict policy.
  bigiq_device_discovery:
    device_address: 192.168.1.1
    device_username: bigipadmin
    device_password: bigipsecret
    modules:
      - ltm
      - afm
      - shared_security
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Discover a new device and import config, use non- default conflict policy.
  bigiq_device_discovery:
    device_address: 192.168.1.1
    modules:
      - ltm
      - dns
    conflict_policy: use_bigip
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Force full device rediscovery
  bigiq_device_discovery:
    device_address: 192.168.1.1
    modules:
      - ltm
      - afm
      - dns
      - shared_security
    force: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove discovered device and its config
  bigiq_device_discovery:
    device_address: 192.168.1.1
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
access_conflict_policy строка	изменено	Устанавливает политику разрешения конфликтов для объектов модуля Access `apm`. Пример: keep_version
access_group_first_device логическое	изменено	Первое устройство в группе доступа для импорта общей конфигурации для этой группы доступа. Пример: True
access_group_name строка	изменено	Имя группы доступа для импорта конфигурации доступа для устройств. Пример: foo_group
conflict_policy строка	изменено	Устанавливает политику разрешения конфликтов для общих объектов на устройствах BIG-IP. Пример: use_bigip
device_address строка	изменено	IP-адрес устройства BIG-IP, которое нужно импортировать/управлять им. Пример: 192.168.1.1
device_conflict_policy строка	изменено	Устанавливает политику разрешения конфликтов для объектов, специфичных для конкретного устройства BIG-IP. Пример: use_bigip
device_port целое число	изменено	Порт, на котором должно произойти установление доверия между BIG-IQ и BIG-IP для устройства. Пример: 10443
ha_name строка	изменено	Имя кластера DSC устройства BIG-IP, которым нужно управлять. Пример: GROUP_1
modules список / элементы=строка	изменено	Список модулей, которые должны быть обнаружены и импортированы в устройство. Пример: ['ltm', 'dns']
use_bigiq_sync логическое	изменено	Указывает, должен ли BIG-IQ вручную синхронизировать конфигурацию DSC. Пример: True
versioned_conflict_policy строка	изменено	Устанавливает политику разрешения конфликтов для профилей LTM и мониторинговых объектов. Пример: keep_version

Авторы

Wojciech Wypior (@wojtek0806)

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