Spec-Zone.ru › Ansible

Модуль community.aws.ec2_vpc_vpn_info – Сбор информации о подключениях VPN в AWS.

Примечание

Этот модуль входит в состав коллекции community.aws (версия 8.0.0).

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

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.aws.ec2_vpc_vpn_info.

Новое в community.aws 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Сбор информации о подключениях VPN в AWS.

Требования

Ниже приведен список требований к хосту, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение файла CA-сертификатов для проверки SSL-сертификатов.

Также может использоваться переменная среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

булево

Использовать botocore.endpoint логгер для парсинга уникальных (а не всех) "resource:action" API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, сделанный во время выполнения playbook.

Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных AWS-эндпоинтов. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS.

Также могут использоваться переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

filters

словарь

Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html для возможных фильтров.

По умолчанию: {}

profile

псевдонимы: aws_profile

строка

Используемый профиль AWS для аутентификации.

См. документацию AWS для получения дополнительной информации о профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также может использоваться переменная среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут использоваться переменные среды AWS_REGION или EC2_REGION.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_token

строка

Токен сеанса AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверяться при общении с API AWS.

Установка validate_certs=false настоятельно не рекомендуется; в качестве альтернативы, рассмотрите настройку aws_ca_bundle вместо этого.

Варианты:

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

vpn_connection_ids

список / элементы=строка

Получение подробностей о конкретных VPN-соединениях с использованием идентификатора(ов) VPN-соединения. Это значение должно быть предоставлено в виде списка.

По умолчанию: []

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Подробнее см. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# # Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all vpn connections
  community.aws.ec2_vpc_vpn_info:

- name: Gather information about a filtered list of vpn connections, based on tags
  community.aws.ec2_vpc_vpn_info:
    filters:
      "tag:Name": test-connection
  register: vpn_conn_info

- name: Gather information about vpn connections by specifying connection IDs.
  community.aws.ec2_vpc_vpn_info:
    filters:
      vpn-gateway-id: vgw-cbe66beb
  register: vpn_conn_info

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

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

Ключ

Описание

vpn_connections

сложный

Список одной или нескольких VPN-соединений.

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

category

строка

Категория VPN-соединения.

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

Пример: "VPN"

customer_gateway_id

строка

Идентификатор шлюза клиента на вашей стороне VPN-соединения.

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

Пример: "cgw-17a53c37"

customer_gatway_configuration

строка

Информация о конфигурации шлюза клиента VPN-соединения (в формате XML).

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

options

словарь

Параметры VPN-соединения.

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

Пример: {"static_routes_only": false}

routes

сложный

Список статических маршрутов, связанных с VPN-соединением.

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

destination_cidr_block

строка

Блок CIDR, связанный с локальной подсетью клиентского дата-центра.

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

Пример: "10.0.0.0/16"

state

строка

Текущее состояние статического маршрута.

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

Пример: "available"

state

строка

Текущее состояние VPN-соединения.

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

Пример: "available"

tags

словарь

Присвоенные теги VPN-соединения.

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

Пример: {"Name": "test-conn"}

type

строка

Тип VPN-соединения.

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

Пример: "ipsec.1"

vgw_telemetry

сложный

Информация о VPN-туннеле.

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

accepted_route_count

целое число

Количество принятых маршрутов.

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

Пример: 0

certificate_arn

строка

Amazon Resource Name сертификата конечной точки туннеля виртуального частного шлюза.

Возвращается: при использовании частного сертификата для аутентификации

Пример: "arn:aws:acm:us-east-1:123456789012:certificate/c544d8ce-20b8-4fff-98b0-example"

last_status_change

строка

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

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

Пример: "2018-02-09T14:35:27+00:00"

outside_ip_address

строка

Интернет-маршрутизируемый IP-адрес внешнего интерфейса виртуального частного шлюза.

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

Пример: "13.127.79.191"

status

строка

Статус VPN-туннеля.

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

Пример: "DOWN"
END_OF_DOCUMENT_MARKER

status_message

string

Если произошла ошибка, описание ошибки.

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

Пример: "IPSEC IS DOWN"

vpn_connection_id

string

ID подключения VPN.

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

Пример: "vpn-f700d5c0"

vpn_gateway_id

string

ID виртуального шлюза VPN на стороне AWS.

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

Пример: "vgw-cbe56bfb"

Авторы

  • Madhura Naniwadekar (@Madhura-CSI)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Общение

© 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/community/aws/ec2_vpc_vpn_info_module.html

Spec-Zone.ru

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