Spec-Zone.ru › Ansible

модуль amazon.aws.ec2_vpc_route_table — управление таблицами маршрутизации для виртуальных частных облаков AWS

Примечание

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

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

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

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

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

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

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

  • Управление таблицами маршрутизации для виртуальных частных облаков AWS (VPC).

Требования

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

  • 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

Путь к пакету центров сертификации, используемому для проверки 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.

gateway_id

string

добавлено в amazon.aws 3.2.0

Идентификатор шлюза, который нужно связать с таблицей маршрутизации.

Если gateway_id равно 'None' или '', шлюз будет отвязан от таблицы маршрутизации.

lookup

string

Искать таблицу маршрутизации по tags или по route_table_id.

Если не указаны lookup=tag и tags, поиск существующей таблицы маршрутизации не выполняется и будет создана новая таблица.

При использовании lookup=tag обнаружение нескольких совпадений приведет к сбою, и изменения внесены не будут.

Чтобы изменить теги таблицы маршрутизации, используйте lookup=id.

При использовании lookup=tag необходимо указать vpc_id.

Варианты:

  • "tag" ← (по умолчанию)
  • "id"

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.

propagating_vgw_ids

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

Включить распространение маршрутов от виртуальных шлюзов, указанных по идентификатору.

purge_routes

boolean

Удалять существующие маршруты, отсутствующие в routes.

Варианты:

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

purge_subnets

boolean

Удалять существующие подсети, отсутствующие в subnets.

Игнорируется, если не задан параметр subnets.

Варианты:

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

purge_tags

boolean

Если purge_tags=true и задан параметр tags, существующие теги ресурса будут удалены, чтобы они точно соответствовали значениям, заданным параметром tags.

Если параметр tags не задан, теги не изменяются, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

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

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.

route_table_id

string

Идентификатор таблицы маршрутизации, которую нужно обновить или удалить.

Обязателен при lookup=id.

routes

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

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

Маршруты задаются в виде словарей, содержащих ключ dest и один из ключей gateway_id, instance_id, network_interface_id, transit_gateway_id или vpc_peering_connection_id.

Значение dest используется для сопоставления адреса назначения. Это может быть блок IPv4 CIDR или IPv6 CIDR.

Если задан gateway_id, к IGW VPC можно обратиться, используя значение igw.

Для состояний present необходимо указать маршруты.

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

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 являются взаимоисключающими.

state

string

Создать или удалить таблицу маршрутизации VPC.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subnets

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

Массив подсетей, добавляемых в эту таблицу маршрутизации. Подсети можно указать по идентификатору подсети, тегу Name или в формате CIDR, например ‘10.0.0.0/24’ или ‘fd00::/8’.

tags

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

dictionary

Словарь тегов, применяемых к ресурсу.

Если параметр tags не задан, теги не изменяются.

validate_certs

boolean

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

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

Варианты:

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

vpc_id

string

Идентификатор VPC, в которой нужно создать таблицу маршрутизации.

Обязателен при state=present или lookup=tag.

Примечания

Примечание

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

# Basic creation example:
- name: Set up public subnet route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    tags:
      Name: Public
    subnets:
      - "{{ jumpbox_subnet.subnet.id }}"
      - "{{ frontend_subnet.subnet.id }}"
      - "{{ vpn_subnet.subnet_id }}"
    routes:
      - dest: 0.0.0.0/0
        gateway_id: "{{ igw.gateway_id }}"
      - dest: ::/0
        gateway_id: "{{ igw.gateway_id }}"
      - dest: 0.0.0.0/0
        gateway_id: "{{ transit_gateway_id }}"
  register: public_route_table

- name: Create VPC gateway
  amazon.aws.ec2_vpc_igw:
    vpc_id: vpc-1245678
  register: vpc_igw

- name: Create gateway route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    tags:
      Name: Gateway route table
    gateway_id: "{{ vpc_igw.gateway_id }}"
  register: gateway_route_table

- name: Disassociate gateway from route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    tags:
      Name: Gateway route table
    gateway_id: None
  register: gateway_route_table

- name: Set up NAT-protected route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    tags:
      Name: Internal
    subnets:
      - "{{ application_subnet.subnet.id }}"
      - 'Database Subnet'
      - '10.0.0.0/8'
    routes:
      - dest: 0.0.0.0/0
        instance_id: "{{ nat.instance_id }}"
  register: nat_route_table

- name: delete route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    route_table_id: "{{ route_table.id }}"
    lookup: id
    state: absent

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

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

Ключ

Описание

route_table

complex

Результат для таблицы маршрутизации.

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

associations

complex

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

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

association_state

complex

Состояние связи.

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

state

string

Состояние связи.

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

Пример: "associated"

state_message

string

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

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

Пример: "Creating association"

gateway_id

string

Идентификатор интернет-шлюза или виртуального частного шлюза.

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

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

main

boolean

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

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

Пример: false

route_table_association_id

string

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

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

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

route_table_id

string

Идентификатор таблицы маршрутизации.

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

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

subnet_id

string

Идентификатор подсети.

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

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

id

string

Идентификатор таблицы маршрутизации (совпадает с route_table.route_table_id для обратной совместимости).

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

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

owner_id

string

Учетная запись AWS, которой принадлежит ресурс.

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

Пример: "123456789012"

propagating_vgws

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

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

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

Пример: []

route_table_id

string

Идентификатор таблицы маршрутизации.

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

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

routes

complex

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

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

carrier_gateway_id

string

добавлено в amazon.aws 6.0.0

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

Возвращается: если маршрут проходит через Carrier-шлюз

Пример: "local"

destination_cidr_block

string

Блок IPv4 CIDR назначения

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

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

destination_ipv6_cidr_block

string

Блок IPv6 CIDR назначения

Возвращается: если маршрут включает назначение IPv6

Пример: "2600:1f1c:1b3:8f00:8000::/65"

gateway_id

string

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

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

Пример: "local"

instance_id

string

Идентификатор экземпляра NAT.

Возвращается: если маршрут проходит через экземпляр EC2

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

instance_owner_id

string

Учетная запись AWS, которой принадлежит экземпляр NAT.

Возвращается: если маршрут проходит через экземпляр EC2

Пример: "123456789012"

nat_gateway_id

string

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

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

Пример: "local"

origin

string

Механизм, посредством которого маршрут попал в таблицу.

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

Пример: "CreateRouteTable"

state

string

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

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

Пример: "active"

transit_gateway_id

string

добавлено в amazon.aws 9.0.0

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

Возвращается: если маршрут проходит через Transit-шлюз

Пример: "tgw-123456789012"

tags

dictionary

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

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

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

vpc_id

string

Идентификатор VPC, в которой находится маршрут.

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

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

Авторы

  • Robert Estelle (@erydo)
  • Rob White (@wimnat)
  • Will Thames (@willthames)

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

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

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

Spec-Zone.ru

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