Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_nat_gateway_info — получение сведений об управляемых NAT-шлюзах VPC AWS с помощью методов AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_vpc_nat_gateway_info.

Добавлено в amazon.aws 1.0.0

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

Краткое описание

  • Получает различные сведения об управляемых NAT-шлюзах VPC AWS.

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

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

string

Идентификатор ключа доступа 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 в порядке убывания приоритета.

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

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

aws_ca_bundle

path

Путь к пакету сертификатов CA, который используется для проверки SSL-сертификатов.

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

aws_config

dictionary

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

Список параметров приведён в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

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

string

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

Также можно использовать переменную окружения AWS_URL.

filters

dictionary

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

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

nat_gateway_ids

list / элементы=string

Список идентификаторов конкретных NAT-шлюзов, сведения о которых нужно получить.

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

profile

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

string

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

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

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

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

region

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

string

Регион AWS для использования.

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

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

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

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

string

Секретный ключ доступа 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 в порядке убывания приоритета.

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

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

session_token

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

string

Токен сеанса 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.

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

validate_certs

boolean

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность использования параметра aws_ca_bundle.

Варианты:

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

Примечания

Примечание

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

Примеры

# Simple example of listing all nat gateways
- name: List all managed nat gateways in ap-southeast-2
  amazon.aws.ec2_vpc_nat_gateway_info:
    region: ap-southeast-2
  register: all_ngws

- name: Debugging the result
  ansible.builtin.debug:
    msg: "{{ all_ngws.result }}"

- name: Get details on specific nat gateways
  amazon.aws.ec2_vpc_nat_gateway_info:
    nat_gateway_ids:
      - nat-1234567891234567
      - nat-7654321987654321
    region: ap-southeast-2
  register: specific_ngws

- name: Get all nat gateways with specific filters
  amazon.aws.ec2_vpc_nat_gateway_info:
    region: ap-southeast-2
    filters:
      state: ['pending']
  register: pending_ngws

- name: Get nat gateways with specific filter
  amazon.aws.ec2_vpc_nat_gateway_info:
    region: ap-southeast-2
    filters:
      subnet-id: subnet-12345678
      state: ['available']
  register: existing_nat_gateways

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

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

Ключ

Описание

changed

boolean

Значение True, если получение списка интернет-шлюзов выполнено успешно.

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

Пример: false

result

list / элементы=string

Результат вызова describe, преобразованный в стиль snake case, используемый Ansible.

См. также: http://boto3.readthedocs.io/en/latest/reference/services/ec2.html#EC2.Client.describe_nat_gateways.

Возвращается: при успешном выполнении

connectivity_type

string

Указывает, поддерживает ли NAT-шлюз публичное или частное подключение.

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

Пример: "public"

create_time

string

Дата и время создания NAT-шлюза.

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

Пример: "2021-03-11T22:43:25+00:00"

delete_time

string

Дата и время удаления NAT-шлюза.

Возвращается: если NAT-шлюз был удалён

Пример: "2021-03-11T22:43:25+00:00"

nat_gateway_addresses

dictionary

Список со словарём, содержащим IP-адреса и сетевой интерфейс, связанные с NAT-шлюзом.

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

allocation_id

string

Идентификатор выделения эластичного IP-адреса, связанного с NAT-шлюзом.

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

Пример: "eipalloc-0853e66a40803da76"

association_id

string

Идентификатор ассоциации эластичного IP-адреса, связанного с NAT-шлюзом.

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

Пример: "eipassoc-0d6365c7eeb7d4932"

is_primary

boolean

Указывает, является ли IP-адрес основным.

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

Пример: true

network_interface_id

string

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

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

Пример: "eni-0a37acdbe306c661c"

private_ip

string

Частный IP-адрес, связанный с эластичным IP-адресом.

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

Пример: "10.0.238.227"

public_ip

string

Эластичный IP-адрес, связанный с NAT-шлюзом.

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

Пример: "34.204.123.52"

status

string

Статус адреса.

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

Пример: "succeeded"

nat_gateway_id

string

Идентификатор NAT-шлюза.

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

Пример: "nat-0c242a2397acf6173"

state

string

Состояние NAT-шлюза.

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

Пример: "available"

subnet_id

string

Идентификатор подсети, в которой расположен NAT-шлюз.

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

Пример: "subnet-098c447465d4344f9"

tags

dictionary

Теги, назначенные NAT-шлюзу.

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

Пример: {"Tag1": "tag1", "Tag_2": "tag_2"}

vpc_id

string

Идентификатор VPC, в которой расположен NAT-шлюз.

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

Пример: "vpc-02f37f48438ab7d4c"

Авторы

  • Karen Cheng (@Etherdaemon)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_vpc_nat_gateway_info_module.html

Spec-Zone.ru

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