Spec-Zone.ru › Ansible 2.7

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). Большинство параметров должны быть самодокументируемыми.

Псевдонимы: 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
boolean
    Варианты:
  • нет
  • да ←
Удалить ли старый набор параметров 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
boolean
    Варианты:
  • нет ←
  • да
Для любых параметров 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
    Варианты:
  • absent
  • present ←
Создать/назначить или удалить параметры DHCP. Если state установлен в absent, то набор параметров DHCP, соответствующий либо по идентификатору, либо по тегам и параметрам, будет удален, если это возможно.
tags
-
добавлено в 2.1
Теги, которые будут применены к набору параметров VPC, если он создается, или если указан идентификатор ресурса. (параметры должны соответствовать)

Псевдонимы: resource_tags
validate_certs
boolean
добавлено в 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), если учетные данные не предоставлены. См. 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.
- 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
boolean
всегда
Изменились ли параметры 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. [certified]

Авторы

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

Spec-Zone.ru

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