Spec-Zone.ru › Ansible

Модуль amazon.aws.elb_classic_lb_info — сбор информации об эластичных балансировщиках нагрузки EC2 Classic в AWS

Примечание

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

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

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

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

Добавлено в community.aws 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Сбор информации об эластичных балансировщиках нагрузки EC2 Classic в 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_ID или AWS_ACCESS_KEY, в порядке убывания приоритета.

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

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

aws_ca_bundle

путь

Путь к пакету центров сертификации, используемому для проверки 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 для разбора уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и записывать их список в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести общий список вызовов, выполненных во время плейбука.

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

Варианты:

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

endpoint_url

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

строка

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

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

names

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

Список имён ELB, о которых нужно собрать информацию. Укажите этот параметр, чтобы получить сведения о выбранных ELB; в противном случае будут возвращены сведения обо всех ELB.

По умолчанию: []

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.

region

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

строка

Используемый регион AWS.

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

Также может использоваться переменная среды AWS_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.

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

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

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с SDK AWS 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.

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

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

validate_certs

логическое значение

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

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

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible SDK AWS (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.
# Output format tries to match amazon.aws.elb_classic_lb module input parameters

- name: Gather information about all ELBs
  amazon.aws.elb_classic_lb_info:
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

- name: Gather information about a particular ELB
  amazon.aws.elb_classic_lb_info:
    names: frontend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ elb_info.elbs.0.dns_name }}"

- name: Gather information about a set of ELBs
  amazon.aws.elb_classic_lb_info:
    names:
      - frontend-prod-elb
      - backend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

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

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

Ключ

Описание

elbs

list / elements=dictionary

Список балансировщиков нагрузки.

Возвращается: всегда

attributes

dictionary

Сведения об атрибутах балансировщика нагрузки.

Возвращается: всегда

access_log

dictionary

Сведения о том, включены ли журналы доступа.

Возвращается: при успешном выполнении

Пример: {"enabled": false}

additional_attributes

list / elements=dictionary

Сведения о дополнительных атрибутах балансировщика нагрузки.

Возвращается: при успешном выполнении

Пример: [{"key": "elb.http.desyncmitigationmode", "value": "defensive"}]

connection_draining

dictionary

Сведения о настройке завершения существующих соединений эластичного балансировщика нагрузки.

Возвращается: при успешном выполнении

Пример: {"enabled": true, "timeout": 300}

enabled

boolean

Указывает, включено ли завершение существующих соединений.

Возвращается: всегда

timeout

integer

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

Возвращается: всегда

connection_settings

dictionary

Сведения о настройках соединения.

Возвращается: при успешном выполнении

Пример: {"idle_timeout": 60}

cross_zone_load_balancing

dictionary

Сведения о том, включена ли межзональная балансировка нагрузки.

Возвращается: при успешном выполнении

Пример: {"enabled": true}

availability_zones

list / elements=string

Зоны доступности балансировщика нагрузки.

Возвращается: всегда

Пример: ["us-west-2a"]

backend_server_descriptions

list / elements=dictionary

Сведения об экземплярах EC2.

Возвращается: всегда

Пример: [{"instance_port": 8085, "policy_names": ["MyPolicy1"]}]

canonical_hosted_zone_name

string

DNS-имя балансировщика нагрузки.

Возвращается: всегда

Пример: "test-123456789.us-west-2.elb.amazonaws.com"

canonical_hosted_zone_name_id

string

Идентификатор размещённой зоны Amazon Route 53 для балансировщика нагрузки.

Возвращается: всегда

Пример: "Z1Z1ZZ5HABSF5"

created_time

string

Дата и время создания балансировщика нагрузки.

Возвращается: всегда

Пример: "2024-09-04T17:52:22.270000+00:00"

dns_name

string

DNS-имя балансировщика нагрузки.

Возвращается: всегда

Пример: "test-123456789.us-west-2.elb.amazonaws.com"

health_check

dictionary

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

Возвращается: всегда

Пример: {"healthy_threshold": 10, "interval": 5, "target": "HTTP:80/index.html", "timeout": 2, "unhealthy_threshold": 2}

healthy_threshold

integer

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

Возвращается: всегда

interval

integer

Приблизительный интервал в секундах между проверками работоспособности отдельного экземпляра.

Возвращается: всегда

target

string

Проверяемый экземпляр. Используемый протокол: TCP, HTTP, HTTPS или SSL. Допустимый диапазон портов — от 1 до 65535.

Возвращается: всегда

timeout

integer

Время в секундах, в течение которого отсутствие ответа означает неудачную проверку работоспособности.

Возвращается: всегда

unhealthy_threshold

integer

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

Возвращается: всегда

instances

list / elements=dictionary

Идентификаторы экземпляров балансировщика нагрузки.

Возвращается: всегда

Пример: [{"instance_id": "i-11d1f111ea111111b"}]

instances_inservice

list / elements=string

Сведения об экземплярах балансировщика нагрузки в состоянии «InService».

Возвращается: всегда

Пример: ["i-11d1f111ea111111b"]

instances_inservice_count

integer

Общее количество экземпляров балансировщика нагрузки в состоянии «InService».

Возвращается: всегда

Пример: 1

instances_outofservice

list / elements=string

Сведения об экземплярах балансировщика нагрузки в состоянии «OutOfService».

Возвращается: всегда

Пример: ["i-11d1f111ea111111b"]

instances_outofservice_count

integer

Общее количество экземпляров балансировщика нагрузки в состоянии «OutOfService».

Возвращается: всегда

Пример: 0

instances_unknownservice

list / elements=string

Сведения об экземплярах балансировщика нагрузки в состоянии «Unknown».

Возвращается: всегда

Пример: ["i-11d1f111ea111111b"]

instances_unknownservice_count

integer

Общее количество экземпляров балансировщика нагрузки в состоянии «Unknown».

Возвращается: всегда

Пример: 1

listener_descriptions

list / elements=dictionary

Сведения о слушателях балансировщика нагрузки.

Возвращается: всегда

Пример: [{"listener": {"instance_port": 80, "instance_protocol": "HTTP", "load_balancer_port": 80, "protocol": "HTTP"}, "policy_names": []}]

load_balancer_name

string

Имя эластичного балансировщика нагрузки.

Возвращается: всегда

Пример: "MyLoadBalancer"

policies

dictionary

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

Возвращается: всегда

Пример: {"app_cookie_stickiness_policies": [], "lb_cookie_stickiness_policies": [], "other_policies": []}

app_cookie_stickiness_policies

list / elements=string

Политики закрепления сеанса, созданные с помощью CreateAppCookieStickinessPolicy.

Возвращается: всегда

lb_cookie_stickiness_policies

list / elements=string

Политики закрепления сеанса, созданные с помощью CreateLBCookieStickinessPolicy.

Возвращается: всегда

other_policies

list / elements=string

Политики, не относящиеся к политикам закрепления сеанса.

Возвращается: всегда

scheme

string

Тип балансировщика нагрузки.

Возвращается: всегда

Пример: "internet-facing"

security_groups

list / elements=string

Группы безопасности балансировщика нагрузки.

Возвращается: всегда

Пример: ["sg-111111af1111cb111"]

source_security_group

dictionary

Группа безопасности балансировщика нагрузки, используемая в качестве части правил входящего трафика для зарегистрированных экземпляров.

Возвращается: всегда

Пример: {"group_name": "default", "owner_alias": "721111111111"}

group_name

string

Имя группы безопасности.

Возвращается: всегда

owner_alias

string

Владелец группы безопасности.

Возвращается: всегда

subnets

list / elements=string

Идентификаторы подсетей балансировщика нагрузки.

Возвращается: всегда

Пример: ["subnet-111111af1111cb111"]

tags

dictionary

Теги, связанные с балансировщиком нагрузки.

Возвращается: всегда

Пример: {"Env": "Dev", "Owner": "Dev001"}

vpc_id

string

Идентификатор VPC балансировщика нагрузки.

Возвращается: всегда

Пример: "vpc-0cc28c9e20d111111"

Авторы

  • Michael Schultz (@mjschultz)
  • Fernando Jose Pando (@nand0p)

Ссылки коллекции

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

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

Spec-Zone.ru

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