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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_conflict_policy строка		Варианты: use_bigiq use_bigip keep_version	Устанавливает политику разрешения конфликтов для объектов модуля Access `apm`, используется только при указании модуля `apm`.
access_group_first_device логическое		Варианты: нет да ←	Указывает, является ли импортированное устройство первым устройством в группе доступа для импорта общей конфигурации для этой группы доступа.
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 логическое		Варианты: нет ← да	Принудительно выполняет повторное обнаружение и импорт существующих модулей на управляемом 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` также должен быть объявлен.
password строка / обязательно			Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
provider словарь добавлен в 2.5			Объект типа dict, содержащий данные подключения.
	password строка / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
server_port целое число добавлен в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
state строка		Варианты: отсутствует есть ←	Состояние управляемого устройства в системе. При `present`, позволяет добавлять новые устройства, а также повторно обнаруживать/импортировать устройства. При `absent`, полностью удаляет устройство из системы.
statistics -			Указать сбор статистики для обнаруженного устройства.
	enable логическое	Варианты: нет ← да	Включает сбор статистики на устройстве.
	interval целое число	Варианты: 30 60 ← 120 500	Укажите интервал в секундах, в течение которого данные собираются с обнаруженного устройства.
	stat_modules список	Варианты: device ← ltm ← dns Значение по умолчанию: ["device", "ltm"]	Указывает, для каких модулей собираются данные.

END_OF_DOCUMENT_MARKER

	зона строка	По умолчанию: "default"	Укажите, в какой зоне DCD собирать данные с устройства.
use_bigiq_sync логический тип		Варианты: нет ← да	При значении «истина» BIG-IQ будет вручную синхронизировать изменения конфигурации между членами кластера DSC.
пользователь строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs логический тип добавлен в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
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, сохранится на диске, убедитесь, что включён хотя бы один task, использующий модуль 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 строка	изменено	Устанавливает политику разрешения конфликтов для объектов модуля доступа `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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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.8/modules/bigiq_device_discovery_module.html