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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение пакета CA для проверки сертификатов SSL. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логический тип	Использование `botocore.endpoint` логгера для анализа уникальных (а не общих) `"resource:action"` API-вызовов, сделанных во время задачи, выводящих набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода в общий список, сделанный во время выполнения playbook. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это может быть использовано для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только с AWS. Также можно использовать переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
filters словарь	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html для возможных фильтров. По умолчанию: `{}`
nat_gateway_ids список / элементы=строка	Список конкретных идентификаторов шлюзов NAT для получения подробной информации. По умолчанию: `[]`
profile псевдонимы: aws_profile строка	Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
region псевдонимы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа 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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

END_OF_DOCUMENT_MARKER

session_token

aliases: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

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

Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверены при общении с API AWS.

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

Выбор:

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

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

Значения возврата

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

Ключ	Описание
изменён boolean	True, если перечисление интернет-шлюзов успешно. Возвращается: всегда Пример: `false`
результат список / элементы=строка	Результат описания, преобразованный в стилизованный ansible snake case. См. также http://boto3.readthedocs.io/en/latest/reference/services/ec2.html#EC2.Client.describe_nat_gateways. Возвращается: успех
тип_соединения строка	Указывает, поддерживает ли шлюз NAT общедоступное или частное соединение. Возвращается: всегда Пример: `"public"`
время_создания строка	Дата и время создания шлюза NAT. Возвращается: всегда Пример: `"2021-03-11T22:43:25+00:00"`
время_удаления строка	Дата и время удаления шлюза NAT. Возвращается: при удалении шлюза NAT Пример: `"2021-03-11T22:43:25+00:00"`
адреса_шлюза_nat словарь	Список, содержащий словарь с IP-адресами и сетевым интерфейсом, связанными со шлюзом NAT. Возвращается: всегда
идентификатор_выделения строка	Идентификатор выделения Elastic IP-адреса, связанного со шлюзом NAT. Возвращается: всегда Пример: `"eipalloc-0853e66a40803da76"`
идентификатор_связи строка	Идентификатор связи Elastic IP-адреса, связанного со шлюзом NAT. Возвращается: всегда Пример: `"eipassoc-0d6365c7eeb7d4932"`
является_главным boolean	Определяет, является ли IP-адрес основным. Возвращается: всегда Пример: `true`
идентификатор_сетевого_интерфейса строка	Идентификатор сетевого интерфейса, связанного со шлюзом NAT. Возвращается: всегда Пример: `"eni-0a37acdbe306c661c"`
приватный_ip строка	Приватный IP-адрес, связанный с Elastic IP-адресом. Возвращается: всегда Пример: `"10.0.238.227"`
общедоступный_ip строка	Elastic IP-адрес, связанный со шлюзом NAT. Возвращается: всегда Пример: `"34.204.123.52"`
статус строка	Статус адреса. Возвращается: всегда Пример: `"succeeded"`
идентификатор_шлюза_nat строка	Идентификатор шлюза NAT. Возвращается: всегда Пример: `"nat-0c242a2397acf6173"`
состояние строка	Состояние шлюза NAT. Возвращается: всегда Пример: `"available"`
идентификатор_подсети строка	Идентификатор подсети, в которой находится шлюз NAT. Возвращается: всегда Пример: `"subnet-098c447465d4344f9"`

Теги словарь	Примененные к шлюзу NAT теги. Возвращается: всегда Пример: `{"Tag1": "tag1", "Tag_2": "tag_2"}`
vpc_id строка	Идентификатор VPC, в котором находится шлюз NAT. Возвращается: всегда Пример: `"vpc-02f37f48438ab7d4c"`

Авторы

Karen Cheng (@Etherdaemon)

Ссылки на сборки

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