amazon.aws.ec2_vpc_dhcp_option – Управляет параметрами DHCP и может гарантировать соответствие параметров DHCP для данной VPC запрошенным значениям
Примечание
Этот плагин входит в коллекцию amazon.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install amazon.aws.
Для использования в плейбуке укажите: amazon.aws.ec2_vpc_dhcp_option.
Добавлен в версии 1.0.0: из amazon.aws
Обзор
- Этот модуль удаляет или создает наборы параметров 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). Большинство параметров должны быть понятны.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- boto
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не указан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и станет недопустимым после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл CA Bundle читается со стороны модуля и может потребоваться явно скопировать его с контроллера, если модуль не выполняется локально. | |
| aws_config словарь | Словарь для модификации конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные параметры конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не указан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и станет недопустимым после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs булево |
| Использование логгера botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, вывода набора в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время плейбука. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| delete_old булево |
| Удалить старый набор параметров DHCP VPC при ассоциации нового. Это преимущественно полезно для отладки/разработки, когда нужно быстро откатиться к старому набору параметров. Обратите внимание, что этот параметр будет проигнорирован, и старый набор параметров DHCP сохранится, если он используется любой другой VPC (иначе AWS вернёт ошибку). |
| dhcp_options_id строка | Идентификатор существующего набора параметров DHCP. Если указан, он переопределяет другие параметры, за исключением тегов (которые будут обновлены в соответствии). | |
| dns_servers список / элементы=строка | Список хостов для установки DNS-серверов для VPC (должны быть IP-адресами, а не именами хостов). | |
| domain_name строка | Имя домена для установки в наборе параметров DHCP | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует EC2-эндпоинты). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL. псевдонимы: aws_endpoint_url, endpoint_url | |
| inherit_existing булево |
| Для параметров DHCP, не указанных в этих параметрах, наследоваться ли они от уже применённых к vpc_id или сбросить их на пустые значения. |
| 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 строка | Использование профиля boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка одновременного указания их с profile устарела. aws_access_key, aws_secret_key и security_token станут взаимно исключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS security token. Если не указан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и станет недопустимым после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка |
| создание/присвоение или удаление параметров DHCP. Если state установлен в «отсутствует», набор параметров DHCP, соответствующий либо ID, либо тегам и параметрам, будет удалён, если это возможно. |
| tags словарь | Теги, которые будут применены к набору параметров VPC, если создаётся новый, или если указан resource_id. (параметры должны совпадать) псевдонимы: resource_tags | |
| validate_certs булево |
| При значении «нет» SSL-сертификаты не будут проверены для boto-версий >= 2.6.0. |
| vpc_id строка | ID VPC для ассоциации с запрошенным набором параметров DHCP. Если ID VPC не указан и соответствующий набор параметров не найден, создается новый набор параметров DHCP. |
Примечания
Примечание
- Если параметры не указаны в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - Ansible использует файл конфигурации boto (обычно ~/.boto), если данные аутентификации не предоставлены. См. https://boto.readthedocs.io/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.
- 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_options_id string | при наличии | Идентификатор AWS ресурса набора основных параметров DHCP, созданного, найденного или удалённого |
| new_options dictionary | при необходимости | Созданные, связанные или найденные параметры DHCP Пример: {'domain-name': 'my.example.com', 'domain-name-servers': ['10.0.0.1', '10.0.1.1'], 'netbios-node-type': 2, 'netbois-name-servers': ['10.0.0.1', '10.0.1.1']} |
Авторы
- Joel Thompson (@joelthompson)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/amazon/aws/ec2_vpc_dhcp_option_module.html