Spec-Zone.ru › Ansible 2.4

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`). Если отсутствуют любые из дополнительных значений, они либо будут игнорироваться (то есть унаследуют существующие значения для VPC), либо будут считаться пустыми. Для удаления существующих параметров при одновременном наследовании нужно указать пустое значение (например, установите `ntp_servers` в `[]`, если хотите удалить их из параметров VPC). Большинство параметров должны быть понятны сами по себе.

Требования (к хосту, выполняющему модуль)

  • 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
нет True
Удалять ли старый набор параметров DHCP VPC при привязке нового. Это в основном полезно для отладки/разработки, когда нужно быстро вернуться к старому набору параметров. Обратите внимание, что это значение будет проигнорировано и старый набор параметров DHCP сохранится, если он используется каким-либо другим VPC (в противном случае AWS вернёт ошибку).
dhcp_options_id
(добавлен в 2.1)
нет None
Идентификатор ресурса существующего набора параметров DHCP. Если это значение указано, оно переопределяет другие настройки, за исключением меток (которые будут обновлены).
dns_servers
нет None
Список хостов для настройки DNS-серверов VPC. (Должен быть списком IP-адресов, а не имён хостов.)
domain_name
нет None
Имя домена для установки в наборах параметров DHCP
ec2_url
нет
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
inherit_existing
нет
Для параметров DHCP, не указанных в этих параметрах, унаследовать их из набора параметров, уже применённых к `vpc_id`, или установить их в пустые значения.
netbios_name_servers
нет None
Список хостов, которые будут рекламироваться как серверы NetBIOS.
netbios_node_type
нет None
Тип узла NetBIOS, который нужно рекламировать в параметрах DHCP. Рекомендуется использовать 2 (при использовании NetBIOS-сервисов): http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html
ntp_servers
нет None
Список хостов, которые будут рекламироваться как NTP-серверы для VPC.
profile
(добавлен в 1.6)
нет
Использует профиль boto. Работает только с boto >= 2.24.0.
security_token
(добавлен в 1.6)
нет
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
state
(добавлен в 2.1)
нет present
  • absent
  • present
создаёт/присваивает или удаляет параметры DHCP. Если `state` установлен в `absent`, набор параметров DHCP, соответствующий либо `id`, либо меткам и параметрам, будет удалён, если это возможно.
tags
(добавлен в 2.1)
нет None
Метки, которые будут применены к набору параметров VPC, если создаётся новый, или если указан `resource_id`. (параметры должны совпадать)
псевдонимы: resource_tags
validate_certs
(добавлен в 1.5)
нет yes
  • yes
  • no
Если установлено в "no", сертификаты SSL не будут проверятся для версий boto >= 2.6.0.
vpc_id
нет None
ID VPC, который необходимо связать с запрошенным набором параметров DHCP. Если `vpc_id` не указан и соответствующий набор параметров не найден, создаётся новый набор параметров DHCP.

Примеры

# 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
Изменились ли параметры dhcp?
всегда bool
dhcp_options_id
Идентификатор ресурса AWS основного набора параметров DHCP, созданного, найденного или удалённого
при наличии строка
new_options
Созданные, привязанные или найденные параметры DHCP
при необходимости словарь {'domain-name': 'my.example.com', '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}

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут внесены несовместимые с предыдущими версиями изменения в интерфейс.

Для получения помощи в разработке модулей, если вы захотите, пожалуйста, прочитайте Документация сообщества и вклад, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_vpc_dhcp_option_module.html

Spec-Zone.ru

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