Spec-Zone.ru › Ansible 2.9

ec2_vpc_dhcp_option – Управляет параметрами DHCP и может гарантировать, что параметры DHCP для данного VPC соответствуют запрошенным

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

Описание

  • Этот модуль удаляет или создаёт наборы параметров 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
debug_botocore_endpoint_logs
логический
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook. Также может использоваться переменная окружения 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, если она есть.
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
-
    Варианты:
  • отсутствует
  • есть ←
создать/назначить или удалить параметры DHCP. Если состояние установлено в «отсутствует», набор параметров DHCP, соответствующий по идентификатору или тегам и параметрам, будет удалён, если возможно.
tags
-
Теги, которые будут применены к набору параметров VPC, если создан новый, или если указан идентификатор ресурса. (Параметры должны совпадать)

алиасы: resource_tags
validate_certs
логический
    Варианты:
  • нет
  • да ←
Если установлено в «нет», сертификаты 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
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.9/modules/ec2_vpc_dhcp_option_module.html

Spec-Zone.ru

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