ec2_vpc_dhcp_option - Управляет параметрами DHCP и может гарантировать, что параметры DHCP для заданной VPC соответствуют запрошенным
Новая версия 2.1.
Обзор
- Этот модуль удаляет или создаёт наборы параметров DHCP и может ассоциировать их с VPC. При необходимости создаётся новый набор параметров DHCP, который объединяет существующий набор параметров DHCP VPC с предоставленными значениями. Если dhcp_options_id указан, модуль будет 1. удалять (со state=«absent») 2. гарантировать применение тегов (если state=«present» и теги указаны 3. присоединять его к VPC (если state=«present» и указан vpc_id). Если любые необязательные значения отсутствуют, они будут либо обрабатываться как no-op (т. е. наследуются из уже существующих для VPC), либо будут пустыми. Для удаления существующих параметров при наследовании следует использовать пустое значение (например, установите ntp_servers в [], если вы хотите удалить их из параметров VPC). Большинство параметров должны быть понятны сами по себе.
Псевдонимы: ec2_vpc_dhcp_options
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Ключ доступа AWS. Если не указан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | |
| aws_secret_key | Секретный ключ AWS. Если не указан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | |
| delete_old bool |
| Удалить старый набор параметров DHCP VPC при ассоциации нового. Это в первую очередь полезно для отладки/разработки, когда вы хотите быстро вернуться к старому набору параметров. Обратите внимание, что это значение будет проигнорировано, и старый набор параметров DHCP будет сохранён, если он используется какой-либо другой VPC. (В противном случае AWS вернёт ошибку.) |
| dhcp_options_id (добавлено в 2.1) | Идентификатор ресурса существующего набора параметров DHCP. Если указан, он переопределяет другие настройки, за исключением тегов (которые будут обновлены в соответствии). | |
| dns_servers | Список хостов для настройки DNS-серверов для VPC. (Должен быть списком IP-адресов, а не имён хостов.) | |
| domain_name | Имя домена, которое нужно установить в наборах параметров DHCP | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое имеется. | |
| inherit_existing bool |
| Для параметров DHCP, не указанных в этих параметрах, следует наследовать их из набора параметров, уже применённых к vpc_id, или сбросить их на пустые значения. |
| netbios_name_servers | Список хостов для рекламы в качестве серверов NetBIOS. | |
| netbios_node_type | Тип узла NetBIOS для рекламы в параметрах DHCP. Рекомендуемая практика AWS — использовать 2 (при использовании служб имён NetBIOS) http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html | |
| ntp_servers | Список хостов для рекламы в качестве NTP-серверов для VPC. | |
| profile (добавлено в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region | Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token (добавлено в 1.6) | Токен безопасности AWS STS. Если не указан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state (добавлено в 2.1) |
| Создание/назначение или удаление параметров DHCP. Если state установлен в absent, набор параметров DHCP, соответствующий либо id, либо тегам и параметрам, будет удалён, если это возможно. |
| tags (добавлено в 2.1) | Теги, которые нужно применить к набору параметров VPC, если создаётся новый, или если указан resource_id. (параметры должны соответствовать) Псевдонимы: resource_tags | |
| validate_certs bool (добавлено в 1.5) |
| Если установлено в "нет", сертификаты SSL для версий boto >= 2.6.0 не будут проверяться. |
| vpc_id | Идентификатор VPC, который нужно связать с запрошенным набором параметров DHCP. Если идентификатор VPC не указан и соответствующий набор параметров не найден, создаётся новый набор параметров DHCP. |
Примечания
Примечание
- Если параметры не установлены в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если не указаны данные учетных данных. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно обычно использовать для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto
Примеры
# 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.
- 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.
- 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
- 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
- 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
- ec2_vpc_dhcp_option:
region: us-east-1
dhcp_options_id: dopt-12345678
vpc_id: vpc-123456
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed bool | всегда | Изменились ли параметры dhcp |
| dhcp_options_id строка | при наличии | Идентификатор AWS ресурса основного набора параметров DCHP, созданного, найденного или удалённого |
| new_options словарь | при необходимости | Созданные, связанные или найденные параметры DHCP Пример: {'domain-name-servers': ['10.0.0.1', '10.0.1.1'], 'netbois-name-servers': ['10.0.0.1', '10.0.1.1'], 'netbios-node-type': 2, 'domain-name': 'my.example.com'} |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Техническое обслуживание
Этот модуль помечен как сертифицированный, что означает, что он поддерживается партнёром Ansible. См. Поддержка модулей и техническое обслуживание для получения дополнительной информации.
Список других модулей, также поддерживаемых партнёром Ansible, см. здесь.
Автор
- Joel Thompson (@joelthompson)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ec2_vpc_dhcp_option_module.html