bigip_gtm_topology_region – Управляет областями топологии GTM
Новая в версии 2.8.
Обзор
- Управляет областями топологии GTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| name - / обязательно | Указывает имя региона. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. Параметр раздела также учитывается при использовании совместно с параметрами pool, data_center, и region. | |
| 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 строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| region_members список | Указывает список участников региона. Этот список участников — либо всё, либо ничего, для добавления или удаления участника необходимо указать весь список участников. Список перепишет содержимое устройства, если отличается. Если задано значение none, список участников региона будет удалён. | ||
| continent строка | Указывает один из семи континентов, а также параметр Unknown. Указание Unknown заставляет систему использовать стандартное разрешение, если система не может определить расположение локального DNS, отправляющего запрос.Поддерживаются полные имена континентов и их сокращённые версии. | ||
| country строка | Имя страны или код для использования. В дополнение к полным именам стран вы также можете указать их сокращённую форму, например US вместо United States. Действительные коды стран можно найти здесь https://countrycode.org/. | ||
| datacenter строка | Указывает имя дата-центра GTM, уже определённого в конфигурации. | ||
| geo_isp строка | Указывает ISP геолокации. | ||
| isp строка |
| Указывает интернет-провайдера. | |
| negate логическое значение |
| При установке в (yes) система выбирает этот топологический регион, когда источник запроса не совпадает. Может быть указана только одна запись списка вместе с negate. | |
| pool строка | Указывает имя пула GTM, уже определённого в конфигурации. | ||
| region строка | Указывает имя региона, уже определённого в конфигурации. | ||
| state строка | Указывает состояние в заданной стране. | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлено в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state строка |
| Когда state равно present, гарантирует, что регион существует.Когда state равно absent, гарантирует, что регион удалён. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диске, необходимо включить хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create topology region
bigip_gtm_topology_region:
name: foobar
region_members:
- country: CN
negate: yes
- datacenter: baz
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify topology region
bigip_gtm_topology_region:
name: foobar
region_members:
- continent: EU
- country: PL
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| name строка | changed | Значение имени региона GTM. Пример: foobar |
| region_members список | changed | Список членов региона GTM. Пример: [{'continent': 'Европа'}, {'country': 'Польша'}] |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается партнёром 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/bigip_gtm_topology_region_module.html