Spec-Zone.ru › Ansible 2.5

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

Псевдонимы: ec2_vpc_dhcp_options

Требования

Нижеперечисленные требования необходимы на хосте, на котором выполняется этот модуль.

  • boto
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key По умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key По умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
delete_old По умолчанию:
yes
Удалять ли старый набор параметров DHCP VPC при ассоциации нового. В основном полезно для отладки/разработки, когда вы хотите быстро вернуться к старому набору параметров. Обратите внимание, что это значение будет проигнорировано, и старый набор параметров DHCP будет сохранён, если он используется любой другой VPC. (В противном случае AWS вернёт ошибку.)
dhcp_options_id
(добавлено в 2.1)
 По умолчанию:
None
Идентификатор ресурса существующего набора параметров DHCP. Если он задан, он переопределит другие параметры, за исключением тегов (которые будут обновлены для соответствия)
dns_servers По умолчанию:
None
Список хостов для установки серверов DNS для VPC. (Должен быть списком IP-адресов, а не имён хостов.)
domain_name По умолчанию:
None
Имя домена для установки в наборах параметров DHCP
ec2_url По умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
inherit_existing По умолчанию:
no
Для любых параметров 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)
 По умолчанию:
None
Использует профиль 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)
 По умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

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

Псевдонимы: resource_tags
validate_certs
(добавлено в 1.5)
    Варианты:
  • no
  • yes ←
Если установлено в "no", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_id По умолчанию:
None
ID VPC для ассоциации с запрошенным набором параметров DHCP. Если vpc_id не предоставлен, и соответствующий набор параметров не найден, создаётся новый набор параметров 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
string
 при доступности
Идентификатор ресурса AWS основного набора параметров DCHP, созданного, найденного или удалённого
new_options
dict
 при необходимости
Созданные, связанные или найденные параметры 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}


Статус

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

Автор

  • 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.5/modules/ec2_vpc_dhcp_option_module.html

Spec-Zone.ru

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