ec2_vpc_vgw_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
ec2_url -		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая существует.
filters -		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html для возможных фильтров.
profile - добавлен в 1.6		Использует профиль 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		AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
validate_certs boolean добавлен в 1.5	Варианты: нет да ←	Если установлено "нет", сертификаты SSL не будут проверены для boto версий >= 2.6.0.
vpn_gateway_ids -		Получить подробности определенного идентификатора виртуального шлюза. Это значение должно быть предоставлено в виде списка.

Примечания

Примечание

Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета 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 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 boolean	всегда	True, если перечисление виртуальных шлюзов успешно. Пример: false
virtual_gateways list	всегда	Виртуальные шлюзы для учетной записи. Пример: [{'state': 'доступен', 'tags': [{'key': 'Имя', 'value': 'TEST-VGW'}], 'type': 'ipsec.1', 'vpc_attachments': [{'state': 'подключено', 'vpc_id': 'vpc-22a93c74'}], 'vpn_gateway_id': 'vgw-23e3d64e'}]

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.7/modules/ec2_vpc_vgw_facts_module.html