Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_ike_peer — управление конфигурацией пирингового узла IPSec IKE на BIG-IP

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

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

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

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управление конфигурацией пирингового узла IPSec IKE на устройстве BIG-IP.

Параметры

Параметр

Комментарии

description

string

Описание пирингового узла IKE.

name

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

Задает имя пирингового узла IKE.

partition

string

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

phase1_auth_method

string

Задает метод аутентификации для согласования фазы 1.

При создании нового пирингового узла IKE, если это значение не указано, по умолчанию используется rsa-signature.

Варианты:

  • "pre-shared-key"
  • "rsa-signature"

phase1_cert

string

Задает цифровой сертификат, используемый для подписи RSA.

При создании нового пирингового узла IKE, если это значение не указано и phase1_auth_method имеет значение rsa-signature, по умолчанию используется default.crt.

Этот параметр недопустим, если phase1_auth_method имеет значение pre-shared-key.

phase1_encryption_algorithm

string

Задает алгоритм шифрования IKE.

IKE version v2 не поддерживает blowfish, camellia и cast128.

Варианты:

  • "3des"
  • "des"
  • "blowfish"
  • "cast128"
  • "aes128"
  • "aes192"
  • "aes256"
  • "camellia"

phase1_hash_algorithm

string

Задает алгоритм аутентификации IKE.

Варианты:

  • "sha1"
  • "md5"
  • "sha256"
  • "sha384"
  • "sha512"

phase1_key

string

Задает открытый ключ, содержащийся в цифровом сертификате.

При создании нового пирингового узла IKE, если это значение не указано и phase1_auth_method имеет значение rsa-signature, по умолчанию используется default.key.

Этот параметр недопустим, если phase1_auth_method имеет значение pre-shared-key.

phase1_lifetime

integer

добавлено в f5networks.f5_modules 1.1.0

Задает срок действия в минутах ассоциации безопасности IKE (SA), предлагаемой при согласовании фазы 1.

Допустимый диапазон значений: 1 - 4294967295 минут.

При создании нового пирингового узла IKE, если это значение не указано, используется значение по умолчанию, заданное системой: 1440 минут.

phase1_perfect_forward_secrecy

string

Задает группу Диффи — Хеллмана для согласования фаз 1 и 2 IKE.

Варианты:

  • "ecp256"
  • "ecp384"
  • "ecp521"
  • "modp768"
  • "modp1024"
  • "modp1536"
  • "modp2048"
  • "modp3072"
  • "modp4096"
  • "modp6144"
  • "modp8192"

phase1_verify_peer_cert

boolean

В IKEv2 указывает, проверяется ли сертификат, отправленный пиринговым узлом IKE, с помощью доверенных центров сертификации, списка отозванных сертификатов (CRL) и/или сертификата пира.

В IKEv1 указывает, проверяется ли идентификатор, отправленный пиром, по учетным данным в сертификате следующим образом: ASN1DN — полное имя субъекта сертификата сравнивается с идентификатором; Address, FQDN или User FQDN — поле subjectAltName сертификата сравнивается с идентификатором. Если они не совпадают, согласование завершается ошибкой.

При создании нового пирингового узла IKE, если это значение не указано и phase1_auth_method имеет значение rsa-signature, по умолчанию используется false.

Этот параметр недопустим, если phase1_auth_method имеет значение pre-shared-key.

Варианты:

  • false
  • true

presented_id_type

string

Задает тип идентификатора, с помощью которого локальная система представляет себя пиру при согласовании фазы 1 IKE.

Варианты:

  • "address"
  • "asn1dn"
  • "fqdn"
  • "keyid-tag"
  • "user-fqdn"
  • "override"

presented_id_value

string

Задает значение идентификатора при использовании типа presented_id_type — override.

Это значение обязательно, если version содержит (Cv2).

preshared_key

string

Задает строку, которую пиринговые узлы IKE используют совместно для взаимной аутентификации.

Этот параметр используется только если phase1_auth_method имеет значение pre-shared-key.

Этот параметр недопустим, если phase1_auth_method имеет значение rsa-signature.

provider

dictionary

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

Словарь с параметрами подключения.

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

remote_address

string

Отображает IP-адрес удаленной системы BIG-IP относительно настраиваемой системы.

state

string

Если задано present, обеспечивает наличие ресурса.

Если задано absent, обеспечивает удаление ресурса.

Варианты:

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

update_password

string

always разрешает обновление паролей, если пользователь решит это сделать. on_create задает пароль только для вновь созданных пиринговых узлов IKE.

Варианты:

  • "always" ← (по умолчанию)
  • "on_create"

verified_id_type

string

Задает тип идентификатора, с помощью которого локальная система идентифицирует пиринговый узел при согласовании фазы 1 IKE.

Это значение обязательно, если version содержит (Cv2).

Если задано user-fqdn, значение verified_id_value должно иметь формат «Пользователь @ DNS-домен».

Варианты:

  • "address"
  • "asn1dn"
  • "fqdn"
  • "keyid-tag"
  • "user-fqdn"
  • "override"

verified_id_value

string

Задает значение идентификатора при использовании типа verified_id_type — override.

Это значение обязательно, если version содержит (Cv2).

version

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

Задает используемую версию IKE (Internet Key Exchange).

Если настраиваемая система является инициатором IPsec и выбраны обе версии, система пытается использовать для согласования IKEv2. Если удаленный пир не поддерживает IKEv2, туннель IPsec не устанавливается. Чтобы в этом случае использовать IKEv1, отмените выбор версии 2 и повторите попытку.

Если настраиваемая система является ответчиком IPsec и выбраны обе версии, инициатор IPsec определяет, какую версию IKE использовать.

При создании нового пирингового узла IKE это значение обязательно.

Варианты:

  • "v1"
  • "v2"

Примечания

Примечание

  • Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия программного обеспечения BIG-IP >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить на диске конфигурацию BIG-IP, обязательно включите как минимум одну задачу с модулем f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в его документации.

Примеры

- name: Create new IKE peer
  bigip_ike_peer:
    name: ike1
    remote_address: 1.2.3.4
    version:
      - v1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change presented id type - keyid-tag
  bigip_ike_peer:
    name: ike1
    presented_id_type: keyid-tag
    presented_id_value: key1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove IKE peer
  bigip_ike_peer:
    name: ike1
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

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

Ключ

Описание

phase1_auth_method

string

Новое значение метода аутентификации учетных данных IKE Phase 1 для ресурса.

Возвращается: changed

Пример: "rsa-signature"

phase1_cert

string

Новые учетные данные сертификата IKE Phase 1.

Возвращается: changed

Пример: "/Common/cert1.crt"

phase1_encryption_algorithm

string

Новый алгоритм шифрования IKE Phase 1.

Возвращается: changed

Пример: "3des"

phase1_hash_algorithm

string

Новый алгоритм аутентификации IKE Phase 1.

Возвращается: changed

Пример: "sha256"

phase1_key

string

Новые учетные данные ключа IKE Phase 1.

Возвращается: changed

Пример: "/Common/cert1.key"

phase1_perfect_forward_secrecy

string

Новое значение Perfect Forward Secrecy для IKE Phase 1.

Возвращается: changed

Пример: "modp1024"

phase1_verify_peer_cert

boolean

Новое значение параметра проверки сертификата узла-партнера для ключа IKE Phase 1.

Возвращается: changed

Пример: true

presented_id_type

string

Новое значение типа представленного идентификатора ресурса.

Возвращается: changed

Пример: "address"

presented_id_value

string

Новое значение параметра типа представленного идентификатора.

Возвращается: changed

Пример: "1.2.3.1"

remote_address

string

Новое значение удаленного адреса ресурса.

Возвращается: changed

Пример: "1.2.2.1"

verified_id_type

string

Новое значение типа проверенного идентификатора ресурса.

Возвращается: changed

Пример: "address"

verified_id_value

string

Новое значение параметра типа проверенного идентификатора.

Возвращается: changed

Пример: "1.2.3.1"

version

list / elements=string

Новый список версий IKE.

Возвращается: changed

Пример: ["v1", "v2"]

Авторы

  • Tim Rupp (@caphrim007)
  • 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/bigip_ike_peer_module.html

Spec-Zone.ru

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