Spec-Zone.ru › Ansible

amazon.aws.ec2_vpc_route_table_info модуль – Сбор информации о таблицах маршрутизации VPC EC2 в AWS

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: amazon.aws.ec2_vpc_route_table_info.

Новая в amazon.aws 1.0.0

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

Описание

  • Сбор информации о таблицах маршрутизации EC2 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

строка

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

Псевдоним 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 обратный вызов, чтобы вывести общий список, созданный во время выполнения книги сценариев.

Также может быть использована переменная окружения 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_DescribeRouteTables.html для возможных фильтров.

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

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 AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

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

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_token

строка

Маркер сеанса 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.

END_OF_DOCUMENT_MARKER

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.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Gather information about all VPC route tables
  amazon.aws.ec2_vpc_route_table_info:

- name: Gather information about a particular VPC route table using route table ID
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      route-table-id: rtb-00112233

- name: Gather information about any VPC route table with a tag key Name and value Example
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      "tag:Name": Example

- name: Gather information about any VPC route table within VPC with ID vpc-abcdef00
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      vpc-id: vpc-abcdef00

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

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

Ключ

Описание

route_tables

complex

Список словарей, описывающих таблицы маршрутизации.

См. также https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_route_tables.

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

associations

complex

Список ассоциаций между таблицей маршрутизации и одной или несколькими подсетями или шлюзом.

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

association_state

complex

Состояние ассоциации.

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

state

string

Состояние ассоциации.

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

Пример: "associated"

state_message

string

Дополнительная информация о состоянии ассоциации.

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

Пример: "Creating association"

gateway_id

string

ID интернет-шлюза или виртуального частного шлюза.

Возвращается: когда таблица маршрутизации является таблицей маршрутизации шлюза

Пример: "igw-03312309"

main

boolean

Является ли это основной таблицей маршрутизации.

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

Пример: false

route_table_association_id

string

ID ассоциации между таблицей маршрутизации и подсетью.

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

Пример: "rtbassoc-ab47cfc3"

route_table_id

string

ID таблицы маршрутизации.

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

Пример: "rtb-bf779ed7"

subnet_id

string

ID подсети.

Возвращается: когда таблица маршрутизации является таблицей маршрутизации подсети

Пример: "subnet-82055af9"

id

string

ID таблицы маршрутизации (то же самое, что и route_tables.route_table_id для обратной совместимости).

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

Пример: "rtb-bf779ed7"

owner_id

string

ID учётной записи, которой принадлежит таблица маршрутизации.

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

Пример: "012345678912"

propagating_vgws

list / elements=string

Список виртуальных частных шлюзов, распространяющих маршруты.

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

Пример: []

route_table_id

string

ID таблицы маршрутизации.

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

Пример: "rtb-bf779ed7"

routes

complex

Список маршрутов в таблице маршрутизации.

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

destination_cidr_block

string

CIDR-блок назначения.

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

Пример: "10.228.228.0/22"

gateway_id

string

ID шлюза.

Возвращается: когда шлюз является локальным или интернет-шлюзом

Пример: "local"

instance_id

string

ID NAT-инстанса.

Пусто, если маршрут не через EC2-инстанс.

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

Пример: "i-abcd123456789"

instance_owner_id

string

AWS-аккаунт, которому принадлежит NAT-инстанс.

Пусто, если маршрут не через EC2-инстанс.

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

Пример: "123456789012"

nat_gateway_id

string

ID NAT-шлюза.

Возвращается: при маршрутизации через NAT-шлюз.

Пример: "local"

network_interface_id

string

ID сетевого интерфейса.

Пусто, если маршрут не через EC2-инстанс.

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

Пример: "123456789012"

origin

string

Механизм, через который маршрут находится в таблице.

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

Пример: "CreateRouteTable"

state

string

Состояние маршрута.

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

Пример: "active"

tags

dictionary

Теги, применённые к таблице маршрутизации.

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

Пример: {"Name": "Public route table", "Public": "true"}

vpc_id

string

ID VPC, в котором находится маршрут.

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

Пример: "vpc-6e2d2407"

Авторы

  • Rob White (@wimnat)
  • Mark Chappell (@tremble)

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

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

© 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_route_table_info_module.html

Spec-Zone.ru

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