ec2_vpc_vgw_facts - Сбор фактов о виртуальных шлюзах в AWS
Новая версия с 2.3.
Обзор
- Сбор фактов о виртуальных шлюзах в AWS.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа к AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если оно есть. |
| filters | Значение по умолчанию: None | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html для возможных фильтров. |
| profile (добавлен в 1.6) | Значение по умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| region | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если оно есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token (добавлен в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| validate_certs (добавлен в 1.5) |
| Если установлено "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены. |
| vpn_gateway_ids | Значение по умолчанию: None | Получить сведения о конкретном идентификаторе виртуального шлюза. Это значение должно быть предоставлено в виде списка. |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные окружения могут быть использованы в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONмогут использоваться для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# # Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather facts about all virtual gateways for an account or profile
ec2_vpc_vgw_facts:
region: ap-southeast-2
profile: production
register: vgw_facts
- name: Gather facts about a filtered list of Virtual Gateways
ec2_vpc_vgw_facts:
region: ap-southeast-2
profile: production
filters:
"tag:Name": "main-virt-gateway"
register: vgw_facts
- name: Gather facts about a specific virtual gateway by VpnGatewayIds
ec2_vpc_vgw_facts:
region: ap-southeast-2
profile: production
vpn_gateway_ids: vgw-c432f6a7
register: vgw_facts
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed bool | всегда | True, если список виртуальных шлюзов выполнен успешно. Пример: false |
| virtual_gateways список | всегда | Виртуальные шлюзы для учетной записи. Пример: [{'vpc_attachments': [{'vpc_id': 'vpc-22a93c74', 'state': 'подключен'}], 'state': 'доступно', 'vpn_gateway_id': 'vgw-23e3d64e', 'type': 'ipsec.1', 'tags': [{'key': 'Имя', 'value': 'TEST-VGW'}]}] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- Ник Асланидис (@naslanidis)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ для улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ec2_vpc_vgw_facts_module.html