amazon.aws.route53_info модуль – Получает данные Route 53 с использованием методов AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.
Чтобы использовать его в playbook, укажите: amazon.aws.route53_info.
Добавлен в amazon.aws 5.0.0
Обзор
- Получает различные данные, связанные с зоной Route 53, набором записей или данными проверки работоспособности.
- Этот модуль был первоначально добавлен в
community.awsв релизе 1.0.0.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
change_id string | Идентификатор запроса пакета изменений. Значение, указанное здесь, — это значение, которое ChangeResourceRecordSets вернул в элементе Id при отправке запроса. Требуется, если |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
delegation_set_id string | Идентификатор набора делегирования зоны DNS. |
dns_name string | Первое имя в лексикографическом порядке доменных имен, с которого команда list_command должна начать перечисление. |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
health_check_id string | Идентификатор проверки работоспособности. Требуется, если |
health_check_method string | Используется вместе с query: health_check. Позволяет отображать детали, подсчеты или теги различных деталей проверки работоспособности. Варианты:
|
hosted_zone_id string | Идентификатор зоны размещения зоны DNS. Требуется, если Требуется, если |
hosted_zone_method string | Используется вместе с query: hosted_zone. Позволяет отображать детали, подсчеты или теги различных деталей зоны размещения. Варианты:
|
max_items integer | Максимальное количество элементов для возврата для различных запросов get/list. |
next_marker string | Некоторые запросы, такие как list_command: hosted_zones, вернут максимальное количество записей — например, 100 или число, указанное |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
query строка / обязательно | Определяет действие запроса. Варианты:
|
region псевдонимы: aws_region, ec2_region строка | AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут использоваться переменные окружения Дополнительную информацию см. в документации Amazon AWS по адресу http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной окружения |
resource_id псевдонимы: resource_ids список / элементы=строка | Идентификатор/ы указанного/ых ресурса/ов. Требуется, если Требуется, если |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа к AWS. Дополнительную информацию о маркерах доступа см. в документации AWS по адресу https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные окружения Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной окружения |
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию о маркерах доступа см. в документации AWS по адресу https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные окружения Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных окружения |
start_record_name строка | Первое имя в лексикографическом порядке имён доменов, с которого вы хотите начать перечисление с помощью команды list_command: record_sets. |
type строка | Тип DNS записи. Варианты:
|
validate_certs логический | Если установлено в Установление validate_certs=false настоятельно не рекомендуется; вместо этого рассмотрите возможность установки aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста Ansible «контроллер», а не из контекста «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из файлов конфигурации в контексте 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 список / элементы=строка добавлен в community.aws 4.1.0 | Список диапазонов IP-адресов в формате CIDR для контроллеров работоспособности Amazon Route 53. Возвращается: когда |
CheckerIpRanges список / элементы=строка | Устаревший список диапазонов IP-адресов в формате CIDR (с использованием CamelCase) для контроллеров работоспособности Amazon Route 53. \ Этот список содержит те же элементы/параметры, что и его версия со строчными буквами (snake_case), упомянутая выше. \ Это поле устарело и будет удалено в релизе версии 6.0.0. Возвращается: когда |
delegation_sets список / элементы=словарь добавлен в community.aws 4.1.0 | Список словарей, содержащих информацию о наборах делегирования, которые можно использовать повторно. Возвращается: когда |
DelegationSets список / элементы=словарь | Устаревший список словарей (с использованием CamelCase), содержащих информацию о наборах делегирования, которые можно использовать повторно. \ Этот список содержит те же элементы/параметры, что и его версия со строчными буквами (snake_case), упомянутая выше. \ Это поле устарело и будет удалено в релизе версии 6.0.0. Возвращается: когда |
health_check словарь добавлен в community.aws 4.1.0 | Словарь с деталями проверки работоспособности Route53, возвращённый методом get_health_check в boto3. Возвращается: когда |
|
caller_reference строка |
Уникальная строка, которую вы указали при создании проверки работоспособности. Возвращается: успешно Пример: |
|
health_check_config словарь |
Словарь, содержащий подробную информацию о проверке работоспособности. Возвращается: успешно |
|
disabled булево |
Указывает, следует ли Route53 прекратить выполнение проверок работоспособности на целевом узле. Возвращается: успешно Пример: |
|
enable_sni булево |
Указывает, следует ли Route53 отправлять значение FullyQualifiedDomainName на целевой узел в сообщении client_hello во время согласования TLS. Возвращается: успешно Пример: |
|
failure_threshold целое число |
Количество последовательных проверок работоспособности, которые должен пройти/не пройти целевой узел, чтобы Route53 изменил текущий статус целевого узла. Возвращается: успешно Пример: |
|
fully_qualified_domain_name строка |
Полное доменное имя целевого узла, на котором Route53 выполняет проверки работоспособности. Возвращается: успешно Пример: |
|
inverted булево |
Указывает, следует ли Route53 инвертировать статус проверки работоспособности. Возвращается: успешно Пример: |
|
ip_address строка |
IP-адрес (IPv4/IPv6) целевого узла, на котором Route53 должна выполнять проверки работоспособности. Возвращается: успешно Пример: |
|
measure_latency булево |
Указывает, следует ли Route53 измерять задержку между контроллерами работоспособности в нескольких регионах AWS и целевым узлом. Возвращается: успешно Пример: |
|
port целое число |
Порт целевого узла, на котором Route53 должна выполнять проверки работоспособности. Возвращается: успешно Пример: |
|
request_interval целое число |
Количество секунд между моментом, когда Route53 получает ответ от целевого узла, и отправкой следующего запроса на проверку работоспособности. Возвращается: успешно Пример: |
|
resource_path string |
Путь, который Route53 запрашивает при выполнении проверок работоспособности. Возвращается: успех Пример: |
|
search_string string |
Строка, которую Route53 использует для поиска в теле ответа от указанного ресурса. Возвращается: успех Пример: |
|
type string |
Тип проверки работоспособности. Возвращается: успех Пример: |
|
health_check_version string |
Версия проверки работоспособности. Возвращается: успех Пример: |
|
id string |
Идентификатор, назначенный Amazon Route 53 проверке работоспособности при создании. Возвращается: успех Пример: |
health_check_observations list / elements=dictionary added in amazon.aws 5.4.0 | Словарь данных о проверке работоспособности Route53, возвращаемый get_health_check_status и get_health_check_last_failure_reason в boto3. Возвращается: при |
|
ip_address string |
IP-адрес проверяющего работоспособности Amazon Route 53, который предоставил причину ошибки в StatusReport. Возвращается: успех Пример: |
|
region string |
Регион проверяющего работоспособности Amazon Route 53, который предоставил статус в StatusReport. Возвращается: успех Пример: |
|
status_report dictionary |
Сложный тип, содержащий последнюю причину ошибки и время неудачной проверки работоспособности. Возвращается: успех |
|
checked_time string |
Дата и время выполнения проверки работоспособности проверяющим работоспособности в формате ISO 8601 и по Гринвичу (UTC). Возвращается: успех Пример: |
|
status string |
Описание состояния конечной точки проверки работоспособности, как сообщает один из проверяющих работоспособности Amazon Route 53. Возвращается: успех Пример: |
health_checks list / elements=dictionary added in community.aws 4.0.0 | Список проверок работоспособности Route 53, возвращаемый list_health_checks в boto3. Возвращается: при |
|
caller_reference string |
Уникальная строка, указанная при создании проверки работоспособности. Возвращается: успех Пример: |
|
health_check_config dictionary |
Словарь, содержащий подробную информацию об одной проверке работоспособности. Возвращается: успех |
|
disabled boolean |
Указывает, должна ли Route53 прекратить выполнение проверок работоспособности конечной точки. Возвращается: успех Пример: |
|
enable_sni boolean |
Указывает, должна ли Route53 отправлять значение FullyQualifiedDomainName на конечную точку в сообщении client_hello во время TLS-переговоров. Возвращается: успех Пример: |
|
failure_threshold integer |
Количество последовательных проверок работоспособности, которые конечная точка должна пройти/не пройти, чтобы Route 53 изменил текущий статус конечной точки. Returned: success Sample: |
|
fully_qualified_domain_name string |
Полностью квалифицированное доменное имя DNS конечной точки, на которой Route53 выполняет проверки работоспособности. Returned: success Sample: |
|
inverted boolean |
Должен ли Route53 инвертировать статус проверки работоспособности. Returned: success Sample: |
|
ip_address string |
IP-адрес IPv4/IPv6 конечной точки, на которой Route53 должен выполнять проверки работоспособности. Returned: success Sample: |
|
measure_latency boolean |
Должен ли Route53 измерять задержку между контроллерами работоспособности в нескольких регионах AWS и конечной точкой. Returned: success Sample: |
|
port integer |
Порт конечной точки, на которой Route53 должен выполнять проверки работоспособности. Returned: success Sample: |
|
request_interval integer |
Количество секунд между моментом получения Route53 ответа от конечной точки и следующим запросом проверки работоспособности. Returned: success Sample: |
|
resource_path string |
Путь, который запрашивает Route53 при выполнении проверок работоспособности. Returned: success Sample: |
|
search_string string |
Строка, которую Route 53 использует для поиска в ответе от указанного ресурса. Returned: success Sample: |
|
type string |
Тип проверки работоспособности. Returned: success Sample: |
|
health_check_version string |
Версия проверки работоспособности. Returned: success Sample: |
|
id string |
Идентификатор, назначенный Amazon Route53 проверке работоспособности во время создания. Returned: success Sample: |
HealthCheck dictionary | Устаревший словарь Route53 сведений о проверке работоспособности, возвращаемый get_health_check в boto3. \ Этот словарь содержит те же элементы/параметры, что и его версия со snake_case, упомянутая выше. \ Это поле устарело и будет удалено в версии 6.0.0. Returned: when |
HealthChecks list / elements=dictionary | Устаревший список проверок работоспособности Route53, возвращаемый list_health_checks в boto3. \ Этот список содержит те же элементы/параметры, что и его версия со snake_case, упомянутая выше. \ Это поле устарело и будет удалено в версии 6.0.0. Returned: when |
hosted_zones list / elements=dictionary added in community.aws 4.0.0 | Список зон размещения, возвращаемый list_hosted_zones в boto3. Returned: when |
|
caller_reference string |
Значение, указанное для CallerReference во время создания зоны размещения. Returned: success Sample: |
|
config словарь |
Словарь, содержащий элементы Comment и PrivateZone. Возвращаемое значение: успех |
|
comment строка |
Комментарии, включённые в зону размещения. Возвращаемое значение: успех Пример: |
|
private_zone логическое значение |
Значение, указывающее, является ли это частной зоной размещения или нет. Возвращаемое значение: успех Пример: |
|
id строка |
Идентификатор зоны размещения, назначенный Amazon Route53 при создании зоны размещения. Возвращаемое значение: успех Пример: |
|
name строка |
Имя домена. Возвращаемое значение: успех Пример: |
|
resource_record_set_count целое число |
Количество записей набора ресурсов в зоне размещения. Возвращаемое значение: успех Пример: |
HostedZones список / элементы=словарь | Устаревший список зон размещения с использованием CamelCase, возвращаемый функцией list_hosted_zones в boto3. \ Этот список содержит те же элементы/параметры, что и его версия со snake_case, упомянутая выше. \ Это поле устарело и будет удалено в версии 6.0.0. Возвращаемое значение: когда |
resource_record_sets список / элементы=словарь добавлен в community.aws 4.0.0 | Список записей набора ресурсов, возвращаемых функцией list_resource_record_sets в boto3. Возвращаемое значение: когда |
|
geo_location словарь |
Указанное географическое местоположение, на которое Route53 реагирует на основе местоположения. Возвращаемое значение: успех |
|
continent_code строка |
Двухбуквенный код континента. Возвращаемое значение: успех Пример: |
|
country_code строка |
Двухбуквенный код страны. Возвращаемое значение: успех Пример: |
|
subdivision_code строка |
Двухбуквенный код штата США Возвращаемое значение: успех Пример: |
|
name строка |
Имя записи в указанной зоне размещения. Возвращаемое значение: успех Пример: |
|
resource_records список / элементы=словарь |
Информация о записях ресурсов. Возвращаемое значение: успех |
|
value строка |
Текущее или новое значение записи DNS. Возвращаемое значение: успех Пример: |
|
set_identifier строка |
Идентификатор, который отличает несколько записей набора ресурсов, имеющих одинаковую комбинацию имени и типа. Возвращаемое значение: успех Пример: |
|
ttl целое число |
Время жизни кэша записи ресурса (TTL) в секундах. Возвращаемое значение: успех Пример: |
|
тип строка |
Тип DNS-записи. Возвращается: при успехе Пример: |
ResourceRecordSets список / элементы=словарь | Устаревший список записей ресурса с использованием CamelCase, возвращаемый функцией list_resource_record_sets в boto3. \ Этот список содержит те же элементы/параметры, что и его версия со snake_case, упомянутая выше. \ Это поле устарело и будет удалено в версии 6.0.0. Возвращается: когда |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/route53_info_module.html