Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_vpc_dhcp_option_info — Сбор информации о наборах DHCP-опций в AWS

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

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

строка

ID ключа доступа 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 или EC2_ACCESS_KEY в порядке убывания приоритета.

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

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

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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.

debug_botocore_endpoint_logs

булево

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

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

Варианты:

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

dhcp_options_ids

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

Получить подробности о конкретных идентификаторах DHCP-опций.

dry_run

булево

Проверяет, имеете ли вы необходимые разрешения для просмотра опций DHCP.

Варианты:

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

endpoint_url

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

строка

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

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

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной окружения EC2_URL устарела и будет удалена в релизе после 2024-12-01.

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.

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

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

region

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

строка

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

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

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

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

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной окружения EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

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.

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

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

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

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.
END_OF_DOCUMENT_MARKER

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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

См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в значение false, сертификаты SSL не будут проверяться при общении с API AWS.

Установку validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите установку aws_ca_bundle вместо этого.

Варианты:

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

Примечания

Примечание

  • Предупреждение: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

boolean

Истина, если список DHCP-опций успешно завершен.

Возвращаемое значение: всегда

dhcp_config

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

Созданные, связанные или найденные DHCP-опции в формате boto2. Предоставлено для согласованности с ec2_vpc_dhcp_option’s dhcp_config.

Возвращаемое значение: всегда

domain-name

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

Имя домена для хостов в наборах DHCP-опций.

Возвращаемое значение: при доступности

Пример: ["my.example.com"]

domain-name-servers

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

IP-адреса до четырех серверов доменных имен или AmazonProvidedDNS.

Возвращаемое значение: при доступности

Пример: ["10.0.0.1", "10.0.1.1"]

netbios-name-servers

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

IP-адреса до четырех серверов имен NetBIOS.

Возвращаемое значение: при доступности

Пример: ["10.0.0.1", "10.0.1.1"]

netbios-node-type

строка

Тип узла NetBIOS (1, 2, 4 или 8).

Возвращаемое значение: при доступности

Пример: "2"

ntp-servers

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

IP-адреса до четырех серверов протокола NTP (Network Time Protocol).

Возвращаемое значение: при доступности

Пример: ["10.0.0.1", "10.0.1.1"]

dhcp_options

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

Созданные, связанные или найденные DHCP-опции.

Возвращаемое значение: всегда

dhcp_configurations

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

Настройка DHCP для набора опций.

Возвращаемое значение: успех

Пример: [{"key": "ntp-servers", "values": [{"value": "10.0.1.2"}]}, "{\"key\": \"netbios-name-servers\", \"values\": [{value\": \"10.0.0.1\"}, {\"value\": \"10.0.1.1\" }]}"]

key

строка

Имя DHCP-опции.

Возвращаемое значение: всегда

values

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

Список значений для DHCP-опции.

Возвращаемое значение: всегда

value

строка

Значение атрибута. Это значение чувствительно к регистру.

Возвращаемое значение: всегда

dhcp_options_id

строка

Идентификатор aws ресурса основного набора DHCP-опций, созданного или найденного.

Возвращаемое значение: успех

Пример: "dopt-0955331de6a20dd07"

owner_id

строка

Идентификатор AWS учётной записи, владеющей набором DHCP-опций.

Возвращаемое значение: успех

Пример: "012345678912"

tags

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

Теги, применяемые к набору DHCP-опций.

Возвращаемое значение: успех

Пример: [{"Key": "CreatedBy", "Value": "ansible-test"}, {"Key": "Collection", "Value": "amazon.aws"}]

Авторы

  • Nick Aslanidis (@naslanidis)

Ссылки на сборку

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

© 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/ec2_vpc_dhcp_option_info_module.html

Spec-Zone.ru

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