ec2_vpc_igw_facts – Сбор фактов об интернет-шлюзах в AWS
Новое в версии 2.3.
Обзор
- Сбор фактов об интернет-шлюзах в AWS.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводящего набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | |
| filters - | Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html для возможных фильтров. | |
| internet_gateway_ids - | Получение подробностей о конкретном идентификаторе интернет-шлюза. Укажите это значение в виде списка. | |
| profile строка | Использует профиль 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 строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| validate_certs логический тип |
| При значении «нет» сертификаты SSL для boto версии >= 2.6.0 не будут проверяться. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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 Internet Gateways for an account or profile
ec2_vpc_igw_facts:
region: ap-southeast-2
profile: production
register: igw_facts
- name: Gather facts about a filtered list of Internet Gateways
ec2_vpc_igw_facts:
region: ap-southeast-2
profile: production
filters:
"tag:Name": "igw-123"
register: igw_facts
- name: Gather facts about a specific internet gateway by InternetGatewayId
ec2_vpc_igw_facts:
region: ap-southeast-2
profile: production
internet_gateway_ids: igw-c1231234
register: igw_facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed логический тип | всегда | Истина, если получение списка интернет-шлюзов выполнено успешно. Пример: ложь |
| internet_gateways список | всегда | Список интернет-шлюзов для учетной записи. Пример: [{'attachments': [{'state': 'доступен', 'vpc_id': 'vpc-02123b67'}], 'internet_gateway_id': 'igw-2123634d', 'tags': [{'key': 'Имя', 'value': 'test-vpc-20-igw'}]}] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Nick Aslanidis (@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.8/modules/ec2_vpc_igw_facts_module.html