Spec-Zone.ru › Ansible

Модуль amazon.aws.route53_info — получает сведения о Route 53 с помощью методов AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.route53_info.

Добавлено в amazon.aws 5.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Получает различные сведения о зоне Route 53, наборе записей или проверке работоспособности.
  • Этот модуль впервые появился в community.aws в выпуске 1.0.0.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

aws_ca_bundle

путь

Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Список параметров приведён в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

change_id

строка

Идентификатор запроса на пакетное изменение.

Указанное здесь значение — это значение, которое ChangeResourceRecordSets вернул в элементе Id после отправки запроса.

Обязателен, если query=change.

debug_botocore_endpoint_logs

логический

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

delegation_set_id

строка

Идентификатор набора делегирования зоны DNS.

dns_name

строка

Первое имя в лексикографическом порядке доменных имён, с которого команда list_command начнёт вывод списка.

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

health_check_id

строка

Идентификатор проверки работоспособности.

Обязателен, если query имеет значение health_check, а health_check_method имеет значение details, status или failure_reason.

health_check_method

строка

Используется совместно с query: health_check. Позволяет выводить подробные сведения, количество или теги для различных проверок работоспособности.

Варианты:

  • "list" ← (по умолчанию)
  • "details"
  • "status"
  • "failure_reason"
  • "count"
  • "tags"

hosted_zone_id

строка

Идентификатор размещённой зоны DNS.

Обязателен, если query имеет значение hosted_zone, а hosted_zone_method имеет значение details.

Обязателен, если query имеет значение record_sets.

hosted_zone_method

строка

Используется совместно с query: hosted_zone. Позволяет выводить подробные сведения, количество или теги для различных размещённых зон.

Варианты:

  • "details"
  • "list" ← (по умолчанию)
  • "list_by_name"
  • "count"
  • "tags"

max_items

целое число

Максимальное количество элементов, возвращаемых различными запросами get/list.

next_marker

строка

Некоторые запросы, например list_command: hosted_zones, возвращают ограниченное число записей — например, 100 или количество, указанное в max_items. Если число записей превышает этот предел, можно отправить ещё один запрос, используя значение NextMarker из первого ответа, чтобы получить следующую страницу результатов.

profile

псевдонимы: aws_profile

строка

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

query

строка / обязательный

Задаёт действие запроса.

Варианты:

  • "change"
  • "checker_ip_range"
  • "health_check"
  • "hosted_zone"
  • "record_sets"
  • "reusable_delegation_set"

region

псевдонимы: aws_region

строка

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

resource_id

псевдонимы: resource_ids

список / элементы=строка

Идентификатор(ы) указанного(ых) ресурса(ов).

Обязателен для query=health_check и health_check_method=tags.

Обязателен для query=hosted_zone и hosted_zone_method=tags.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

session_token

псевдонимы: aws_session_token

строка

Токен сеанса AWS STS для использования с временными учётными данными.

Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную среды AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

start_record_name

строка

Первое имя в лексикографическом порядке доменных имён, с которого команда list_command: record_sets начнёт вывод списка.

type

строка

Тип записи DNS.

Варианты:

  • "A"
  • "CNAME"
  • "MX"
  • "AAAA"
  • "TXT"
  • "PTR"
  • "SRV"
  • "SPF"
  • "CAA"
  • "NS"
  • "NAPTR"
  • "SOA"
  • "DS"

validate_certs

логический

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

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

# Getting a count of hosted zones
- name: Return a count of all hosted zones
  amazon.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
  amazon.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
  amazon.aws.route53_info:
    query: health_check
    health_check_method: list
    max_items: 20
  register: health_checks

- name: Get health check last failure_reason
  amazon.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
  amazon.aws.route53_info:
    query: reusable_delegation_set
    delegation_set_id: delegation id
  register: delegation_sets

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

- name: example for using next_marker
  amazon.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
      amazon.aws.route53_zone:
        zone: "test.io"
      register: AWSINFO

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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

checker_ip_ranges

list / elements=string

добавлено в community.aws 4.1.0

Список диапазонов IP-адресов в формате CIDR для средств проверки работоспособности Amazon Route 53.

Возвращается: когда query=checker_ip_range

delegation_sets

list / elements=dictionary

добавлено в community.aws 4.1.0

Список словарей с информацией о повторно используемом наборе делегирования.

Возвращается: когда query=reusable_delegation_set

health_check

dictionary

добавлено в community.aws 4.1.0

Словарь с подробной информацией о проверке работоспособности Route53, возвращаемой методом get_health_check в boto3.

Возвращается: когда query=health_check и health_check_method=details

caller_reference

string

Уникальная строка, указанная при создании проверки работоспособности.

Возвращается: при успехе

Пример: "01d0db12-x0x9-12a3-1234-0z000z00zz0z"

health_check_config

dictionary

Словарь с подробной информацией об одной проверке работоспособности.

Возвращается: при успехе

disabled

boolean

Следует ли Route53 прекратить выполнение проверок работоспособности конечной точки.

Возвращается: при успехе

Пример: false

enable_sni

boolean

Следует ли Route53 передавать значение FullyQualifiedDomainName конечной точке в сообщении client_hello во время согласования TLS.

Возвращается: при успехе

Пример: true

failure_threshold

integer

Количество последовательных проверок работоспособности, которые конечная точка должна пройти или не пройти, чтобы Route53 изменил её текущий статус.

Возвращается: при успехе

Пример: 3

fully_qualified_domain_name

string

Полное DNS-имя конечной точки, работоспособность которой проверяет Route53.

Возвращается: при успехе

Пример: "hello"

inverted

boolean

Следует ли Route53 инвертировать статус проверки работоспособности.

Возвращается: при успехе

Пример: false

ip_address

string

IPv4- или IPv6-адрес конечной точки, работоспособность которой должен проверять Route53.

Возвращается: при успехе

Пример: "192.0.2.44"

measure_latency

boolean

Следует ли Route53 измерять задержку между средствами проверки работоспособности в нескольких регионах AWS и конечной точкой.

Возвращается: при успехе

Пример: false

port

integer

Порт конечной точки, работоспособность которой должен проверять Route53.

Возвращается: при успехе

Пример: 80

request_interval

integer

Количество секунд между получением Route53 ответа от конечной точки и отправкой следующего запроса на проверку работоспособности.

Возвращается: при успехе

Пример: 30

resource_path

string

Путь, по которому Route53 обращается при проверке работоспособности.

Возвращается: при успехе

Пример: "/welcome.html"

search_string

string

Строка, которую Route53 ищет в теле ответа указанного ресурса.

Возвращается: при успехе

Пример: "test-string-to-match"

type

string

Тип проверки работоспособности.

Возвращается: при успехе

Пример: "HTTPS"

health_check_version

string

Версия проверки работоспособности.

Возвращается: при успехе

Пример: "1"

id

string

Идентификатор, присвоенный проверке работоспособности службой Amazon Route 53 при её создании.

Возвращается: при успехе

Пример: "12345cdc-2cc4-1234-bed2-123456abc1a2"

health_check_observations

list / elements=dictionary

добавлено в amazon.aws 5.4.0

Словарь с подробной информацией о проверке работоспособности Route53, возвращаемой методами get_health_check_status и get_health_check_last_failure_reason в boto3.

Возвращается: когда query=health_check и health_check_method=status или health_check_method=failure_reason

ip_address

string

IP-адрес средства проверки работоспособности Amazon Route 53, указавшего причину сбоя в StatusReport.

Возвращается: при успехе

Пример: "12.345.67.89"

region

string

Регион средства проверки работоспособности Amazon Route 53, предоставившего статус в StatusReport.

Возвращается: при успехе

Пример: "us-west-1"

status_report

dictionary

Составной тип данных, содержащий причину последнего сбоя и время неудачной проверки работоспособности.

Возвращается: при успехе

checked_time

string

Дата и время выполнения проверки средством проверки работоспособности в формате ISO 8601 и по всемирному координированному времени (UTC).

Возвращается: при успехе

Пример: "2023-03-08T23:10:08.452000+00:00"

status

string

Описание статуса конечной точки, работоспособность которой проверяет одно из средств проверки Amazon Route 53.

Возвращается: при успехе

Пример: "Failure: Resolved IP: 12.345.67.89. The connection was closed by the endpoint."

health_checks

list / elements=dictionary

добавлено в community.aws 4.0.0

Список проверок работоспособности Route 53, возвращаемый методом list_health_checks в boto3.

Возвращается: когда query=health_check

caller_reference

string

Уникальная строка, указанная при создании проверки работоспособности.

Возвращается: при успехе

Пример: "01d0db12-x0x9-12a3-1234-0z000z00zz0z"

health_check_config

dictionary

Словарь с подробной информацией об одной проверке работоспособности.

Возвращается: при успехе

disabled

boolean

Следует ли Route53 прекратить выполнение проверок работоспособности конечной точки.

Возвращается: при успехе

Пример: false

enable_sni

boolean

Следует ли Route53 передавать значение FullyQualifiedDomainName конечной точке в сообщении client_hello во время согласования TLS.

Возвращается: при успехе

Пример: true

failure_threshold

integer

Количество последовательных проверок работоспособности, которые конечная точка должна пройти или не пройти, чтобы Route 53 изменил её текущий статус.

Возвращается: при успехе

Пример: 3

fully_qualified_domain_name

string

Полное DNS-имя конечной точки, работоспособность которой проверяет Route53.

Возвращается: при успехе

Пример: "hello"

inverted

boolean

Следует ли Route53 инвертировать статус проверки работоспособности.

Возвращается: при успехе

Пример: false

ip_address

string

IPv4- или IPv6-адрес конечной точки, работоспособность которой должен проверять Route53.

Возвращается: при успехе

Пример: "192.0.2.44"

measure_latency

boolean

Следует ли Route53 измерять задержку между средствами проверки работоспособности в нескольких регионах AWS и конечной точкой.

Возвращается: при успехе

Пример: false

port

integer

Порт конечной точки, работоспособность которой должен проверять Route53.

Возвращается: при успехе

Пример: 80

request_interval

integer

Количество секунд между получением Route53 ответа от конечной точки и отправкой следующего запроса на проверку работоспособности.

Возвращается: при успехе

Пример: 30

resource_path

string

Путь, по которому Route53 обращается при проверке работоспособности.

Возвращается: при успехе

Пример: "/welcome.html"

search_string

string

Строка, которую Route 53 ищет в теле ответа указанного ресурса.

Возвращается: при успехе

Пример: "test-string-to-match"

type

string

Тип проверки работоспособности.

Возвращается: при успехе

Пример: "HTTPS"

health_check_version

string

Версия проверки работоспособности.

Возвращается: при успехе

Пример: "1"

id

string

Идентификатор, присвоенный проверке работоспособности службой Amazon Route53 при её создании.

Возвращается: при успехе

Пример: "12345cdc-2cc4-1234-bed2-123456abc1a2"

hosted_zones

list / elements=dictionary

добавлено в community.aws 4.0.0

Список размещённых зон, возвращаемый методом list_hosted_zones в boto3.

Возвращается: когда query=hosted_zone

caller_reference

string

Значение, указанное для CallerReference при создании размещённой зоны.

Возвращается: при успехе

Пример: "01d0db12-x0x9-12a3-1234-0z000z00zz0z"

config

dictionary

Словарь, содержащий элементы Comment и PrivateZone.

Возвращается: при успехе

comment

string

Любые комментарии, включенные в сведения о размещенной зоне.

Возвращается: при успехе

Пример: "HostedZone created by Route53 Registrar"

private_zone

boolean

Значение, указывающее, является ли эта зона частной размещенной зоной.

Возвращается: при успехе

Пример: false

id

string

Идентификатор размещенной зоны, присвоенный Amazon Route53 при ее создании.

Возвращается: при успехе

Пример: "/hostedzone/Z01234567AB1234567890"

name

string

Имя домена.

Возвращается: при успехе

Пример: "example.io"

resource_record_set_count

integer

Количество наборов ресурсных записей в размещенной зоне.

Возвращается: при успехе

Пример: 3

resource_record_sets

list / elements=dictionary

добавлено в community.aws 4.0.0

Список наборов ресурсных записей, возвращенных методом list_resource_record_sets в boto3.

Возвращается: когда query=record_sets

geo_location

dictionary

Указанное географическое местоположение, на основе которого Route53 выбирает ответ.

Возвращается: при успехе

continent_code

string

Двухбуквенный код континента.

Возвращается: при успехе

Пример: "NA"

country_code

string

Двухбуквенный код страны.

Возвращается: при успехе

Пример: "US"

subdivision_code

string

Двухбуквенный код штата США

Возвращается: при успехе

Пример: "NY"

name

string

Имя записи в указанной размещенной зоне.

Возвращается: при успехе

Пример: "www.example.com"

resource_records

list / elements=dictionary

Сведения о ресурсных записях.

Возвращается: при успехе

value

string

Текущее или новое значение DNS-записи.

Возвращается: при успехе

Пример: "ns-12.awsdns-34.com."

set_identifier

string

Идентификатор, позволяющий различать несколько наборов ресурсных записей с одинаковой комбинацией имени и типа.

Возвращается: при успехе

Пример: "abcd"

ttl

integer

Время жизни (TTL) ресурса в кэше, в секундах.

Возвращается: при успехе

Пример: 60

type

string

Тип DNS-записи.

Возвращается: при успехе

Пример: "A"

Авторы

  • Karen Cheng (@Etherdaemon)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

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