Модуль amazon.aws.ec2_vpc_dhcp_option_info — сбор информации о наборах параметров DHCP в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_vpc_dhcp_option_info.
Добавлено в amazon.aws 1.0.0
Краткое описание
- Сбор информации о наборах параметров DHCP в AWS.
Требования
Перечисленные ниже компоненты должны быть установлены на узле, на котором выполняется этот модуль.
- 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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore. |
aws_ca_bundle путь | Расположение пакета сертификатов CA, используемого для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную среды Варианты:
|
dhcp_options_ids список / элементы=строка | Получить подробные сведения об указанных идентификаторах параметров DHCP. |
dry_run логическое значение | Проверяет, есть ли у вас необходимые разрешения для просмотра параметров DHCP. Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо используемых по умолчанию конечных точек AWS. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
filters словарь | Словарь фильтров. Каждый элемент словаря состоит из ключа фильтра и его значения. Возможные фильтры см. в документации: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeDhcpOptions.html. По умолчанию: |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
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. Также можно использовать переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore. |
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. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
# # Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all DHCP Option sets for an account or profile
amazon.aws.ec2_vpc_dhcp_option_info:
region: ap-southeast-2
profile: production
register: dhcp_info
- name: Gather information about a filtered list of DHCP Option sets
amazon.aws.ec2_vpc_dhcp_option_info:
region: ap-southeast-2
profile: production
filters:
"tag:Name": "abc-123"
register: dhcp_info
- name: Gather information about a specific DHCP Option set by DhcpOptionId
amazon.aws.ec2_vpc_dhcp_option_info:
region: ap-southeast-2
profile: production
dhcp_options_ids: dopt-123fece2
register: dhcp_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
changed логическое значение | Значение True, если получение списка параметров DHCP выполнено успешно. Возвращается: всегда |
dhcp_config список / элементы=словарь | Параметры DHCP в формате boto2, созданные, связанные или найденные. Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2026-12-01. Вместо него используйте Возвращается: всегда |
|
domain-name список / элементы=строка |
Доменное имя для узлов в наборах параметров DHCP. Возвращается: если доступно Пример: |
|
domain-name-servers список / элементы=строка |
IP-адреса до четырех серверов доменных имен или AmazonProvidedDNS. Возвращается: если доступно Пример: |
|
netbios-name-servers список / элементы=строка |
IP-адреса до четырех серверов имен NetBIOS. Возвращается: если доступно Пример: |
|
netbios-node-type строка |
Тип узла NetBIOS (1, 2, 4 или 8). Возвращается: если доступно Пример: |
|
ntp-servers список / элементы=строка |
IP-адреса до четырех серверов Network Time Protocol (NTP). Возвращается: если доступно Пример: |
dhcp_options список / элементы=словарь | Параметры DHCP, созданные, связанные или найденные. Возвращается: всегда |
|
dhcp_configurations список / элементы=словарь |
Конфигурация DHCP для набора параметров. Возвращается: при успехе Пример: |
|
dhcp_options_id строка |
Идентификатор ресурса AWS для основного созданного или найденного набора параметров DHCP. Возвращается: при успехе Пример: |
|
owner_id строка |
Идентификатор учетной записи AWS, которой принадлежит набор параметров DHCP. Возвращается: при успехе Пример: |
|
tags список / элементы=словарь |
Теги, назначенные набору параметров DHCP. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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/ec2_vpc_dhcp_option_info_module.html