Spec-Zone.ru › Ansible

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

Примечание

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

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

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

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

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

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

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

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

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

Варианты:

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

delete_old

boolean

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

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

Варианты:

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

dhcp_options_id

string

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

dns_servers

list / elements=string

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

domain_name

string

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Переменные окружения AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

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

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

inherit_existing

boolean

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

Варианты:

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

netbios_name_servers

list / elements=string

Список хостов для объявления в качестве серверов NetBIOS.

netbios_node_type

integer

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

ntp_servers

list / elements=string

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

profile

aliases: 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 и security_token.

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

aliases: aws_region, ec2_region

string

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

aliases: aws_secret_access_key, aws_secret_key, ec2_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, или 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

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.

state

string

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

Варианты:

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

tags

aliases: resource_tags

dictionary

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

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

validate_certs

boolean

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

Установление validate_certs=false категорически не рекомендуется, как альтернативу, следует установить aws_ca_bundle.

Варианты:

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

vpc_id

string

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

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

Примечания

Примечание

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

boolean

Изменились ли параметры DHCP

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

dhcp_config

словарь

Созданные, связанные или найденные параметры DHCP в формате boto2

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

domain-name

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

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

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

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

domain-name-servers

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

IP-адреса до четырёх DNS-серверов или 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-адреса до четырёх серверов Network Time Protocol (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-ресурса основного набора параметров DCHP, созданного или найденного

Возвращается: успех

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

owner_id

строка

Идентификатор учётной записи AWS, владеющей набором параметров DHCP.

Возвращается: успех

Пример: "012345678912"

tags

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

Теги, которые должны быть применены к набору параметров DHCP

Возвращается: успех

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

dhcp_options_id

строка

Идентификатор aws-ресурса основного набора параметров DCHP, созданного, найденного или удалённого

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

Авторы

  • Joel Thompson (@joelthompson)

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

  • Трекер проблем
  • Репозиторий (источники)
  • Связь

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

Spec-Zone.ru

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