Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

string

Задаёт политику разрешения конфликтов для объектов модуля Access apm. Используется только при указании модуля apm.

Варианты:

  • "use_bigiq"
  • "use_bigip"
  • "keep_version"

access_group_first_device

boolean

Указывает, является ли импортируемое устройство первым устройством в группе доступа, для которого импортируется общая конфигурация этой группы.

Варианты:

  • false
  • true ← (по умолчанию)

access_group_name

string

Имя группы доступа, для которой импортируется конфигурация Access устройств. После установки это значение нельзя изменить.

conflict_policy

string

Задаёт политику разрешения конфликтов для общих объектов на устройствах BIG-IP, за исключением профилей и мониторов LTM.

Варианты:

  • "use_bigiq" ← (по умолчанию)
  • "use_bigip"

device_address

string / обязательный

IP-адрес устройства BIG-IP, которое требуется импортировать или администрировать.

Для этого модуля блок provider должен содержать учётные данные BIG-IQ

device_conflict_policy

string

Задаёт политику разрешения конфликтов для объектов, относящихся к конкретному устройству BIG-IP и не являющихся общими для устройств BIG-IP.

Варианты:

  • "use_bigiq" ← (по умолчанию)
  • "use_bigip"

device_password

string

Пароль администратора устройства BIG-IP.

Этот параметр требуется только при добавлении нового устройства BIG-IP для администрирования.

device_port

integer

Порт, используемый для настройки доверительных отношений между BIG-IQ и BIG-IP.

По умолчанию: 443

device_username

string

Имя пользователя администратора устройства BIG-IP.

Этот параметр требуется только при добавлении нового устройства BIG-IP для администрирования.

force

boolean

Принудительно повторно обнаруживает и импортирует существующие модули на администрируемом устройстве BIG-IP.

Варианты:

  • false ← (по умолчанию)
  • true

ha_name

string

Имя кластера DSC устройства BIG-IP, подлежащего администрированию.

Этот параметр необязателен, если администрируемое устройство не входит в группу кластера.

Этот параметр обязателен, если для use_bigiq_sync задано значение true.

modules

list / элементы=string

Список модулей для обнаружения и импорта на устройство.

Эти модули должны быть подготовлены на целевом устройстве, иначе операция завершится с ошибкой.

При обнаружении или повторном обнаружении устройства всегда необходимо указывать модуль ltm.

При указании asm или afm также необходимо объявить модуль shared_security.

Варианты:

  • "ltm"
  • "asm"
  • "apm"
  • "afm"
  • "dns"
  • "websafe"
  • "security_shared"

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 ← (по умолчанию)

state

string

Состояние администрируемого устройства в системе.

При значении present разрешается добавление нового устройства, а также повторное обнаружение и импорт устройства.

При значении absent устройство полностью удаляется из системы.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

statistics

dictionary

Указывает параметры сбора статистики для обнаруженного устройства.

enable

boolean

Включает сбор статистики на устройстве.

Варианты:

  • false ← (по умолчанию)
  • true

interval

integer

Задаёт интервал сбора данных с обнаруженного устройства в секундах.

Варианты:

  • 30
  • 60 ← (по умолчанию)
  • 120
  • 500

stat_modules

list / элементы=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.
  • Этот модуль не поддерживает атомарное удаление обнаруженных модулей с устройства.
  • Параметр provider должен содержать учётные данные 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

string

Задает политику разрешения конфликтов для объектов модуля Access apm.

Возвращается: при изменении

Пример: "keep_version"

access_group_first_device

boolean

Первое устройство в группе доступа, импортирующее общую конфигурацию для этой группы доступа.

Возвращается: при изменении

Пример: true

access_group_name

string

Имя группы доступа, для которой импортируется конфигурация Access устройств.

Возвращается: при изменении

Пример: "foo_group"

conflict_policy

string

Задает политику разрешения конфликтов для общих объектов на устройствах BIG-IP.

Возвращается: при изменении

Пример: "use_bigip"

device_address

string

IP-адрес устройства BIG-IP, которое нужно импортировать или которым нужно управлять.

Возвращается: при изменении

Пример: "192.168.1.1"

device_conflict_policy

string

Задает политику разрешения конфликтов для объектов, относящихся к конкретному устройству BIG-IP.

Возвращается: при изменении

Пример: "use_bigip"

device_port

integer

Порт, используемый для настройки доверительных отношений между BIG-IQ и BIG-IP.

Возвращается: при изменении

Пример: 10443

ha_name

string

Имя кластера DSC управляемого устройства BIG-IP.

Возвращается: при изменении

Пример: "GROUP_1"

modules

list / элементы=string

Список модулей для обнаружения и импорта на устройство.

Возвращается: при изменении

Пример: ["ltm", "dns"]

use_bigiq_sync

boolean

Указывает, должен ли BIG-IQ вручную синхронизировать конфигурацию DSC.

Возвращается: при изменении

Пример: true

versioned_conflict_policy

string

Задает политику разрешения конфликтов для объектов профилей и мониторов LTM.

Возвращается: при изменении

Пример: "keep_version"

Авторы

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API