Spec-Zone.ru › Ansible 2.10

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: of amazon.aws

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Этот модуль удаляет или создаёт наборы параметров DHCP и может связывать их с VPC. Дополнительно, можно создать новый набор параметров DHCP, который объединяет существующий набор параметров DHCP VPC со значениями, предоставленными в параметрах. Если параметр dhcp_options_id задан, модуль будет: 1. удалять (со state=’absent’) 2. применять теги (если state=’present’ и заданы теги) 3. присоединять к VPC (если state=’present’ и задан vpc_id). Если отсутствуют какие-либо дополнительные параметры, они будут обрабатываться как бездействие (т.е., унаследовать то, что уже существует для 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
путь
Расположение файла с корневыми сертификатами для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: Файл с корневыми сертификатами читается модулем и может потребоваться явное копирование его с контроллера, если модуль не выполняется локально.
aws_config
словарь
Словарь для модификации конфигурации botocore.
Параметры можно найти на https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации 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-вызовов «ресурс:действие», выполненных во время задачи, выводящих набор в ключ task_results в результатах задачи. Используйте обратный вызов 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. Рекомендуется использовать 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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
state
строка
    Варианты:
  • absent
  • present ←
создание/назначение или удаление параметров DHCP. Если state установлен в absent, то набор параметров DHCP, соответствующий по id или тегам и параметрам, будет удалён, если это возможно.
tags
словарь
Теги, которые необходимо применить к набору параметров VPC, если создаётся новый, или если указан ресурсный id. (параметры должны совпадать)

псевдонимы: resource_tags
validate_certs
логический
    Варианты:
  • нет
  • да ←
Если установлено в «нет», SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
vpc_id
строка
ID VPC для ассоциации с набором параметров DHCP. Если vpc_id не указан и набор параметров не найден, создаётся новый набор параметров 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 ресурса набора основных параметров DCHP, созданного, найденного или удалённого

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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/ec2_vpc_dhcp_option_module.html

Spec-Zone.ru

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