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

Примечание

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

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

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

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

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

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

Описание

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

Параметры

Параметр	Комментарии
access_conflict_policy строка	Устанавливает политику разрешения конфликтов для объектов модуля доступа `apm`. Используется только при указании модуля `apm`. Варианты: `"use_bigiq"` `"use_bigip"` `"keep_version"`
access_group_first_device логическое	Указывает, является ли импортируемое устройство первым устройством в группе доступа для импорта общей конфигурации для этой группы доступа. Варианты: `false` `true` ← (по умолчанию)
access_group_name строка	Имя группы доступа для импорта конфигурации доступа для устройств. После установки изменить его нельзя.
conflict_policy строка	Устанавливает политику разрешения конфликтов для общих объектов на устройствах BIG-IP, кроме профилей и мониторов LTM. Варианты: `"use_bigiq"` ← (по умолчанию) `"use_bigip"`
device_address строка / обязательно	IP-адрес устройства BIG-IP, которое необходимо импортировать/управлять. Для этого модуля блок `provider` должен указывать на данные `BIG-IQ` аутентификации.
device_conflict_policy строка	Устанавливает политику разрешения конфликтов для объектов, специфичных для конкретного устройства BIG-IP и не общих для устройств BIG-IP. Варианты: `"use_bigiq"` ← (по умолчанию) `"use_bigip"`
device_password строка	Пароль администратора для устройства BIG-IP. Этот параметр требуется только при добавлении нового устройства BIG-IP для управления.
device_port целое число	Порт, на котором должно происходить установление доверия между BIG-IQ и BIG-IP. По умолчанию: `443`
device_username строка	Имя пользователя администратора для устройства BIG-IP. Этот параметр требуется только при добавлении нового устройства BIG-IP для управления.
force логическое	Принудительно переоткрывает и импортирует существующие модули на управляемом BIG-IP. Варианты: `false` ← (по умолчанию) `true`
ha_name строка	Имя кластера DSC устройства BIG-IP, которое необходимо управлять. Необязательно, если управляемое устройство не является частью группы кластера. Если `use_bigiq_sync` установлено в `true`, этот параметр обязателен.
modules список / элементы=строка	Список модулей, которые необходимо обнаружить и импортировать в устройство. Эти модули должны быть предоставлены на целевом устройстве, иначе операция завершится ошибкой. Модуль `ltm` всегда должен быть указан при обнаружении или повторном обнаружении устройства. Если указаны `asm` или `afm`, модуль `shared_security` также необходимо объявить. Варианты: `"ltm"` `"asm"` `"apm"` `"afm"` `"dns"` `"websafe"` `"security_shared"`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект типа словарь, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщик аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem логическое	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку ее имя вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост 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` ← (по умолчанию)
state string	Состояние управляемого устройства в системе. Если `present`, добавляет новые устройства, а также позволяет повторное обнаружение/импорт устройств. Если `absent`, полностью удаляет устройство из системы. Доступные значения: `"absent"` `"present"` ← (по умолчанию)
statistics dictionary	Указывает сбор статистики для обнаруженного устройства.
enable boolean	Включает сбор статистики устройства. Доступные значения: `false` ← (по умолчанию) `true`
interval integer	Устанавливает интервал сбора данных с обнаруженного устройства в секундах. Доступные значения: `30` `60` ← (по умолчанию) `120` `500`
stat_modules list / elements=string	Указывает, для каких модулей собираются данные. Доступные значения: `"device"` ← (по умолчанию) `"ltm"` ← (по умолчанию) `"dns"` По умолчанию: `["device", "ltm"]`
zone string	Указывает зону DCD, в которой собираются данные с устройства. По умолчанию: `"default"`
use_bigiq_sync boolean	Если установлено `false`, инициировать синхронизацию BIG-IP DSC при внесении изменений в конфигурацию. Если установлено `true`, игнорировать синхронизацию BIG-IP DSC при внесении изменений в конфигурацию. Доступные значения: `false` ← (по умолчанию) `true`
versioned_conflict_policy string	Устанавливает политику разрешения конфликтов для профилей LTM и мониторинга объектов, специфичных для версии программного обеспечения BIG-IP. Доступные значения: `"use_bigiq"` `"use_bigip"` `"keep_version"`

Примечания

Примечание

BIG-IQ >= 6.1.0.
Этот модуль не поддерживает атомарное удаление обнаруженных модулей на устройстве.
Провайдер должен указывать данные для входа в BIG-IQ.
Дополнительную информацию об использовании 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: cm.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: cm.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: true
    provider:
      password: secret
      server: cm.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: cm.mydomain.com
      user: admin
  delegate_to: localhost

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

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

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

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на сборку

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