Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_dhcp_option – Управляет параметрами DHCP и может обеспечить соответствие параметров DHCP указанной VPC запрошенным значениям

Примечание

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

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

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

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

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

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

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

  • Этот модуль удаляет или создаёт наборы параметров DHCP и может связывать их с VPC.
  • При необходимости можно создать новый набор параметров DHCP, объединив существующий набор параметров DHCP VPC с заданными значениями.
  • Если указан dhcp_options_id, модуль выполнит следующие действия: 1. удалит ресурс (при state=’absent’); 2. обеспечит применение тегов (если state=’present’ и указаны теги); 3. свяжет его с VPC (если state=’present’ и указан vpc_id).
  • Если какие-либо необязательные значения не указаны, они будут либо считаться отсутствием действия (то есть для VPC будут унаследованы уже существующие значения).
  • Чтобы удалить существующие параметры, сохранив остальные унаследованные параметры, укажите пустое значение (например, задайте ntp_servers как [], если нужно удалить их из параметров VPC).

Требования

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_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 (в порядке убывания приоритета).

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

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

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 для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных за время плейбука.

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

Варианты:

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

delete_old

логическое значение

Удалять ли старый набор параметров DHCP VPC при связывании с новым набором.

Этот параметр в первую очередь полезен для отладки и разработки, когда требуется быстро вернуться к старому набору параметров. Обратите внимание: если старый набор параметров DHCP используется другой VPC, этот параметр будет проигнорирован, а набор сохранится. (В противном случае AWS вернёт ошибку.)

Варианты:

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

dhcp_options_id

строка

Идентификатор ресурса существующего набора параметров DHCP. Если этот параметр указан, он переопределяет другие настройки, за исключением тегов (они будут обновлены в соответствии с указанными).

dns_servers

список / элементы=строка

Список IP-адресов DNS-серверов для VPC.

domain_name

строка

Доменное имя, которое следует задать в наборах параметров DHCP.

endpoint_url

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

строка

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

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

inherit_existing

логическое значение

Для параметров DHCP, не указанных в этих параметрах, определяет, следует ли наследовать их из набора параметров, уже применённого к vpc_id, или сбросить их до пустых значений.

Варианты:

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

netbios_name_servers

список / элементы=строка

Список хостов, объявляемых в качестве серверов NetBIOS.

netbios_node_type

целое число

Тип узла NetBIOS, объявляемый в параметрах DHCP. AWS рекомендует использовать значение 2 (при использовании службы имён NetBIOS): https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html

ntp_servers

список / элементы=строка

Список хостов, объявляемых в качестве серверов NTP для VPC.

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 и session_token.

purge_tags

логическое значение

Если задано значение 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

строка

Регион 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

строка

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

строка

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

строка

Создать/назначить или удалить параметры DHCP. Если для state задано значение absent, соответствующий по идентификатору, тегам и параметрам набор параметров DHCP будет удалён, если это возможно.

Варианты:

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

tags

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

словарь

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

Если параметр tags не задан, теги не будут изменены.

validate_certs

логическое значение

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

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

Варианты:

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

vpc_id

строка

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

Если идентификатор VPC не указан и соответствующий набор параметров не найден, будет создан новый набор параметров DHCP.

Примечания

Примечание

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

Примеры

# Completely overrides the VPC DHCP options associated with VPC vpc-123456 and deletes any existing
# DHCP option set that may have been attached to that VPC.
- amazon.aws.ec2_vpc_dhcp_option:
    domain_name: "foo.example.com"
    region: us-east-1
    dns_servers:
      - 10.0.0.1
      - 10.0.1.1
    ntp_servers:
      - 10.0.0.2
      - 10.0.1.2
    netbios_name_servers:
      - 10.0.0.1
      - 10.0.1.1
    netbios_node_type: 2
    vpc_id: vpc-123456
    delete_old: true
    inherit_existing: false

# Ensure the DHCP option set for the VPC has 10.0.0.4 and 10.0.1.4 as the specified DNS servers, but
# keep any other existing settings. Also, keep the old DHCP option set around.
- amazon.aws.ec2_vpc_dhcp_option:
    region: us-east-1
    dns_servers:
      - "{{groups['dns-primary']}}"
      - "{{groups['dns-secondary']}}"
    vpc_id: vpc-123456
    inherit_existing: true
    delete_old: false

## Create a DHCP option set with 4.4.4.4 and 8.8.8.8 as the specified DNS servers, with tags
## but do not assign to a VPC
- amazon.aws.ec2_vpc_dhcp_option:
    region: us-east-1
    dns_servers:
      - 4.4.4.4
      - 8.8.8.8
    tags:
      Name: google servers
      Environment: Test

## Delete a DHCP options set that matches the tags and options specified
- amazon.aws.ec2_vpc_dhcp_option:
    region: us-east-1
    dns_servers:
      - 4.4.4.4
      - 8.8.8.8
    tags:
      Name: google servers
      Environment: Test
    state: absent

## Associate a DHCP options set with a VPC by ID
- amazon.aws.ec2_vpc_dhcp_option:
    region: us-east-1
    dhcp_options_id: dopt-12345678
    vpc_id: vpc-123456

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

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

Ключ

Описание

changed

логическое значение

Были ли изменены параметры DHCP

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

dhcp_config

словарь

Созданные, привязанные или обнаруженные параметры DHCP в формате boto2.

Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2026-12-01. Вместо него используйте dhcp_options.

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

domain-name

список / элементы=строка

Имя домена для хостов в наборах параметров DHCP.

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

Пример: ["my.example.com"]

domain-name-servers

список / элементы=строка

IP-адреса не более четырёх серверов доменных имён или AmazonProvidedDNS.

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

Пример: ["10.0.0.1", "10.0.1.1"]

netbios-name-servers

список / элементы=строка

IP-адреса не более четырёх серверов имён NetBIOS.

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

Пример: ["10.0.0.1", "10.0.1.1"]

netbios-node-type

строка

Тип узла NetBIOS (1, 2, 4 или 8).

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

Пример: "2"

ntp-servers

список / элементы=строка

IP-адреса не более четырёх серверов сетевого протокола времени (NTP).

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

Пример: ["10.0.0.1", "10.0.1.1"]

dhcp_options

словарь

Созданные, привязанные или обнаруженные параметры DHCP

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

dhcp_configurations

список / элементы=строка

Конфигурация DHCP для набора параметров

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

Пример: ["{\"key\": \"ntp-servers\", \"values\": [{\"value\": \"10.0.0.2\" , \"value\": \"10.0.1.2\"}]}", "{\"key\": \"netbios-name-servers\", \"values\": [{value\": \"10.0.0.1\"}, {\"value\": \"10.0.1.1\" }]}"]

dhcp_options_id

строка

Идентификатор ресурса AWS для созданного или обнаруженного основного набора параметров DHCP

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

Пример: "dopt-0955331de6a20dd07"

owner_id

строка

Идентификатор аккаунта AWS, которому принадлежит набор параметров DHCP.

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

Пример: "012345678912"

tags

список / элементы=строка

Теги, применяемые к набору параметров DHCP

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

Пример: ["{\"Key\": \"CreatedBy\", \"Value\": \"ansible-test\"}", "{\"Key\": \"Collection\", \"Value\": \"amazon.aws\"}"]

dhcp_options_id

строка

Идентификатор ресурса AWS для созданного, обнаруженного или удалённого основного набора параметров DHCP

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

Авторы

  • Joel Thompson (@joelthompson)

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

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

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

Spec-Zone.ru

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