Spec-Zone.ru › Ansible 2.11

community.aws.route53_info – Получение данных Route53 с использованием методов AWS

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.route53_info.

Новое в версии 1.0.0: из community.aws

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

Описание

  • Получает различные данные, связанные с зоной Route53, набором записей или данными проверки работоспособности.
  • Этот модуль назывался route53_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и после 2022-06-01 эти параметры будут взаимоисключающими.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла сертификата корневого центра для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: Файл сертификата корневого центра считывается на стороне модуля и, возможно, требует явного копирования с контроллера, если он не выполняется локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Дополнительные конфигурации boto см. в http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и после 2022-06-01 эти параметры будут взаимоисключающими.

псевдонимы: ec2_secret_key, secret_key
change_id
строка
Идентификатор запроса пакетного изменения.
Указываемое значение — это значение, которое ChangeResourceRecordSets вернул в элементе Id при отправке запроса.
Требуется, если query=change.
debug_botocore_endpoint_logs
логическая переменная
    Варианты:
  • нет ←
  • да
Используйте логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводия набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
delegation_set_id
строка
Идентификатор набора делегирования DNS-зоны.
dns_name
строка
Первое имя в лексикографическом порядке доменных имён, с которого команда list_command должна начать перечисление.
ec2_url
строка
URL, используемый для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, для которых требуется область. Должен быть указан для всех остальных модулей, если область не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.

псевдонимы: aws_endpoint_url, endpoint_url
health_check_id
строка
Идентификатор проверки работоспособности.
Требуется, если query установлено в health_check и health_check_method установлено в details или status или failure_reason.
health_check_method
строка
    Варианты:
  • список ←
  • детали
  • статус
  • причина_ошибки
  • количество
  • метки
Используется совместно с параметром query: health_check. Позволяет перечислять детали, количество или метки различных данных о проверке работоспособности.
hosted_zone_id
строка
Идентификатор зоны размещения DNS-зоны.
Требуется, если query установлено в hosted_zone и hosted_zone_method установлено в details.
Требуется, если query установлено в record_sets.
hosted_zone_method
строка
    Варианты:
  • детали
  • список ←
  • перечисление_по_имени
  • количество
  • метки
Используется совместно с параметром query: hosted_zone. Позволяет перечислять детали, количество или метки различных данных о зоне размещения.
max_items
строка
Максимальное количество элементов для возврата при различных запросах get/list.
next_marker
строка
Некоторые запросы, такие как list_command: hosted_zones, возвращают максимальное количество записей (например, 100 или число, указанное в max_items). Если количество записей превышает это максимальное значение, можно отправить другой запрос, используя запись NextMarker из первого ответа, чтобы получить следующую страницу результатов.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, а поддержка их одновременного указания с profile устарела.
aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
query
строка / обязательный
    Варианты:
  • изменение
  • диапазон_ip_проверителя
  • проверка_работоспособности
  • зона_размещения
  • наборы_записей
  • переиспользуемый_набор_делегирования
Указывает действие запроса.
region
строка
Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
resource_id
список / элементы=строка
Идентификатор/ы указанного/ых ресурса/ов.
Требуется, если query=health_check и health_check_method=tags.
Требуется, если query=hosted_zone и hosted_zone_method=tags.

псевдонимы: resource_ids
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и после 2022-06-01 эти параметры будут взаимоисключающими.

псевдонимы: aws_security_token, access_token
start_record_name
строка
Первое имя в лексикографическом порядке доменных имен, с которого команда list_command: record_sets должна начать перечисление.
type
строка
    Варианты:
  • A
  • CNAME
  • MX
  • AAAA
  • TXT
  • PTR
  • SRV
  • SPF
  • CAA
  • NS
Тип DNS-записи.
validate_certs
логическая переменная
    Варианты:
  • нет
  • да ←
Если установлено значение "нет", SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используется для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

# Simple example of listing all hosted zones
- name: List all hosted zones
  community.aws.route53_info:
    query: hosted_zone
  register: hosted_zones

# Getting a count of hosted zones
- name: Return a count of all hosted zones
  community.aws.route53_info:
    query: hosted_zone
    hosted_zone_method: count
  register: hosted_zone_count

- name: List the first 20 resource record sets in a given hosted zone
  community.aws.route53_info:
    profile: account_name
    query: record_sets
    hosted_zone_id: ZZZ1111112222
    max_items: 20
  register: record_sets

- name: List first 20 health checks
  community.aws.route53_info:
    query: health_check
    health_check_method: list
    max_items: 20
  register: health_checks

- name: Get health check last failure_reason
  community.aws.route53_info:
    query: health_check
    health_check_method: failure_reason
    health_check_id: 00000000-1111-2222-3333-12345678abcd
  register: health_check_failure_reason

- name: Retrieve reusable delegation set details
  community.aws.route53_info:
    query: reusable_delegation_set
    delegation_set_id: delegation id
  register: delegation_sets

- name: setup of example for using next_marker
  community.aws.route53_info:
    query: hosted_zone
    max_items: 1
  register: first_info

- name: example for using next_marker
  community.aws.route53_info:
    query: hosted_zone
    next_marker: "{{ first_info.NextMarker }}"
    max_items: 1
  when: "{{ 'NextMarker' in first_info }}"

- name: retrieve host entries starting with host1.workshop.test.io
  block:
    - name: grab zone id
      community.aws.route53_zone:
        zone: "test.io"
      register: AWSINFO

    - name: grab Route53 record information
      community.aws.route53_info:
        type: A
        query: record_sets
        hosted_zone_id: "{{ AWSINFO.zone_id }}"
        start_record_name: "host1.workshop.test.io"
      register: RECORDS

Авторы

  • Karen Cheng (@Etherdaemon)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/route53_info_module.html

Spec-Zone.ru

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