Spec-Zone.ru › Ansible 2.8

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), либо будут рассматриваться как нет необходимости в выполнении (т. е. унаследуют то, что уже существует для 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
debug_botocore_endpoint_logs
булево
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать логирователь botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выведя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, созданный во время выполнения плана. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
delete_old
булево
    Варианты:
  • нет
  • да ←
Удалить устаревшее наборы параметров 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
булево
    Варианты:
  • нет ←
  • да
Для всех параметров 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.
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.

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

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

new_options
dictionary
при необходимости
Созданные, связанные или найденные параметры 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. [community]

Авторы

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

Spec-Zone.ru

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