Spec-Zone.ru › Ansible 2.11

community.aws.ec2_vpc_igw_info – Сбор информации об интернет-шлюзах в AWS

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в плейбуке укажите: community.aws.ec2_vpc_igw_info.

Введено в версии 1.0.0: коллекции community.aws

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

Описание

  • Сбор информации об интернет-шлюзах в AWS.
  • Этот модуль назывался ec2_vpc_igw_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров aws_access_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла сертификатов доверенных центров сертификации для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: Файл сертификатов читается со стороны «модуля» и может потребоваться его явное копирование с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения настроек botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для boto-модулей используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров aws_secret_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
convert_tags
булево
добавлен в 1.3.0 community.aws
    Варианты:
  • no
  • yes
Преобразовать теги из формата boto3 (список словарей) в стандартный формат словаря.
В настоящее время по умолчанию False. Значение по умолчанию будет изменено на True после 2022-06-22.
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Используйте регистрирующий инструмент botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», совершенных во время задачи, выведя набор в ключе resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
Адрес, используемый для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая есть.

псевдонимы: aws_endpoint_url, endpoint_url
filters
словарь
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html для возможных фильтров.
internet_gateway_ids
список / элементы=строка
Получить подробности конкретного идентификатора интернет-шлюза. Укажите это значение в виде списка.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка передачи их одновременно с profile устарела.
aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
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.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
validate_certs
булево
    Варианты:
  • нет
  • да ←
При значении «нет» SSL-сертификаты не будут проверены для boto-версий >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы внутри модуля, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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 information about all Internet Gateways for an account or profile
  community.aws.ec2_vpc_igw_info:
    region: ap-southeast-2
    profile: production
  register: igw_info

- name: Gather information about a filtered list of Internet Gateways
  community.aws.ec2_vpc_igw_info:
    region: ap-southeast-2
    profile: production
    filters:
        "tag:Name": "igw-123"
  register: igw_info

- name: Gather information about a specific internet gateway by InternetGatewayId
  community.aws.ec2_vpc_igw_info:
    region: ap-southeast-2
    profile: production
    internet_gateway_ids: igw-c1231234
  register: igw_info

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

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

Ключ Возвращаемое значение Описание
changed
булево
всегда
Истина, если успешное перечисление интернет-шлюзов.

Пример:
ложь
internet_gateways
список / элементы=строка
всегда
Интернет-шлюзы для учетной записи.

Пример:
[{'attachments': [{'state': 'доступен', 'vpc_id': 'vpc-02123b67'}], 'internet_gateway_id': 'igw-2123634d', 'tags': [{'key': 'Имя', 'value': 'test-vpc-20-igw'}]}]


Авторы

  • Nick Aslanidis (@naslanidis)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_vpc_igw_info_module.html

Spec-Zone.ru

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