bigip_gtm_server - Управляет серверами F5 BIG-IP GTM
Новая версия с 2.5.
Обзор
- Управление конфигурацией серверов BIG-IP. Этот модуль может манипулировать определениями серверов в BIG-IP.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| datacenter | Центр обработки данных, к которому принадлежит сервер. При создании нового сервера GTM это значение обязательно. | ||
| devices | Список собственных IP-адресов и переводов для каждого устройства. При создании нового сервера GTM это значение обязательно. Этот список — сложный список, который определяет ряд ключей. Поддерживаются несколько ключей. Ключ name указывает имя устройства. Имя устройства должно быть уникальным для каждого сервера. Этот ключ обязателен.Ключ address содержит IP-адрес или список IP-адресов целевого сервера. Этот ключ обязателен.Ключ translation содержит IP-адрес для перевода значения address выше. Этот ключ необязателен.Указание дублирующих полей name — поддерживаемый способ предоставления адресов устройств. В этом случае адреса будут назначены списку адресов name. | ||
| link_discovery |
| Указывает, автоматически ли система обнаруживает ссылки для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию disabled.Если вы установите этот параметр в enabled или enabled-no-delete, вы также должны убедиться, что параметр virtual_server_discovery также установлен в enabled или enabled-no-delete. | |
| name обязательно | Имя сервера. | ||
| partition (добавлено в 2.5) | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | Объект словаря, содержащий данные подключения. | ||
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для переводов cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| server_type |
| Указывает тип сервера. Тип сервера определяет метрики, которые система может собирать с сервера. При создании нового сервера GTM используется значение по умолчанию bigip.псевдонимы: product | |
| state |
| Состояние сервера. Если absent, будет предпринята попытка удалить сервер. Это удастся только в том случае, если этот сервер не используется виртуальным сервером. present создаёт сервер и включает его. Если enabled, включить сервер, если он существует. Если disabled, создать сервер при необходимости и установить состояние в disabled. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| virtual_server_discovery |
| Указывает, автоматически ли система обнаруживает виртуальные серверы для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию disabled. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Create server "GTM_Server"
bigip_gtm_server:
server: lb.mydomain.com
user: admin
password: secret
name: GTM_Server
datacenter: /Common/New York
server_type: bigip
link_discovery: disabled
virtual_server_discovery: disabled
devices:
- {'name': 'server_1', 'address': '1.1.1.1'}
- {'name': 'server_2', 'address': '2.2.2.1', 'translation':'192.168.2.1'}
- {'name': 'server_2', 'address': '2.2.2.2'}
- {'name': 'server_3', 'addresses': [{'address':'3.3.3.1'},{'address':'3.3.3.2'}]}
- {'name': 'server_4', 'addresses': [{'address':'4.4.4.1','translation':'192.168.14.1'}, {'address':'4.4.4.2'}]}
delegate_to: localhost
- name: Create server "GTM_Server" with expanded keys
bigip_gtm_server:
server: lb.mydomain.com
user: admin
password: secret
name: GTM_Server
datacenter: /Common/New York
server_type: bigip
link_discovery: disabled
virtual_server_discovery: disabled
devices:
- name: server_1
address: 1.1.1.1
- name: server_2
address: 2.2.2.1
translation: 192.168.2.1
- name: server_2
address: 2.2.2.2
- name: server_3
addresses:
- address: 3.3.3.1
- address: 3.3.3.2
- name: server_4
addresses:
- address: 4.4.4.1
translation: 192.168.14.1
- address: 4.4.4.2
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| datacenter строка | изменённое | Новая datacenter, к которой относится сервер.Пример: datacenter01 |
| link_discovery строка | изменённое | Новая link_discovery, настроенная на удалённом устройстве.Пример: enabled |
| server_type строка | изменённое | Новый тип сервера. Пример: bigip |
| virtual_server_discovery строка | изменённое | Новое имя virtual_server_discovery для пункта назначения трапа.Пример: disabled |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будет внесено обратной несовместимости.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. в разделе здесь.
Автор
- Robert Teller
- Tim Rupp (@caphrim007)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_gtm_server_module.html