community.aws.elb_target модуль — Управление целевым сервером в группе целевых серверов
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля потребуются дополнительные зависимости, см. Требования для получения подробной информации.
Для использования в плейбуке укажите: community.aws.elb_target.
Добавлен в community.aws 1.0.0
Описание
- Используется для регистрации или дерегистрации целевого сервера в группе целевых серверов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
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 логический | Использование логгера Также может использоваться переменная среды Выбор:
|
deregister_unused логический | По умолчанию неиспользуемые целевые элементы остаются зарегистрированными. Чтобы удалить их, установите deregister_unused=true. Выбор:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут использоваться переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_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, 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 AWS botocore. Псевдоним 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. Поддержка переменных среды |
состояние строка / обязательно | Зарегистрировать или отменить регистрацию целевого узла. Выбор:
|
target_az строка | Доступная зона или |
target_group_arn строка | Amazon Resource Name (ARN) целевой группы. Взаимоисключающее с target_group_name. |
target_group_name строка | Имя целевой группы. Взаимоисключающее с target_group_arn. |
target_id строка / обязательно | Идентификатор целевого узла. |
target_port целое число | Порт, на котором прослушивает целевой узел. Можно указать переопределение порта. Если целевой узел уже зарегистрирован, его можно снова зарегистрировать с использованием другого порта. По умолчанию порт целевого узла — это порт целевой группы. |
target_status строка | Блокирует и ожидает, пока статус целевого узла будет равен заданному значению. Подробнее о статусе целевого узла см. https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#target-health-states Выбор:
|
target_status_timeout целое число | Максимальное время в секундах ожидания изменения target_status. По умолчанию: |
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.
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Register an IP address target to a target group
community.aws.elb_target:
target_group_name: myiptargetgroup
target_id: i-1234567
state: present
- name: Register an instance target to a target group
community.aws.elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
state: present
- name: Deregister a target from a target group
community.aws.elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
state: absent
# Modify a target to use a different port
- name: Register a target to a target group
community.aws.elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
target_port: 8080
state: present
Ссылки на коллекции
© 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/community/aws/elb_target_module.html
