community.aws.aws_sgw_info – Получение информации об AWS Storage Gateway
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.aws_sgw_info.
Новое в версии 1.0.0: of community.aws
Обзор
- Получение информации об AWS Storage Gateway
- Этот модуль назывался
aws_sgw_factsдо Ansible 2.9. Использование не изменилось.
Требования
Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и будет сделана взаимно исключающей после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла с пакетом сертификатов CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: пакет CA считывается со стороны модуля и, возможно, потребует явного копирования с контроллера, если он не выполняется локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для boto-модулей используется только ключ 'user_agent'. Дополнительную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и будет сделана взаимно исключающей после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический |
| Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводящих набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| gather_file_shares логический |
| Сбор информации о файловых разделах для шлюзов хранения в режиме s3. |
| gather_local_disks логический |
| Сбор информации о локальных дисках, подключенных к шлюзу хранения. |
| gather_tapes логический |
| Сбор информации о лентах для шлюзов хранения в режиме ленточного хранения. |
| gather_volumes логический |
| Сбор информации о томах для шлюзов хранения в режимах iSCSI (кэшированных и хранимых). |
| profile строка | Использование профиля boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, а поддержка их передачи вместе с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимно исключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | Регион AWS. Если не задан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и будет сделана взаимно исключающей после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| validate_certs логический |
| Если установлено в "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION,AWS_CA_BUNDLE - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: "Get AWS storage gateway information"
community.aws.aws_sgw_info:
- name: "Get AWS storage gateway information for region eu-west-3"
community.aws.aws_sgw_info:
region: eu-west-3
Значения возврата
Общие значения возврата описаны в этом месте, ниже приведены поля, уникальные для этого модуля:
| Краткое описание полей | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| шлюзы сложный | всегда | список объектов шлюзов | ||
| file_shares сложный | когда gateway_type == "FILE_S3" | Файловые общие ресурсы шлюза хранения | ||
| file_share_arn строка | всегда | ARN файлового общего ресурса Пример: arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88 | ||
| file_share_id строка | всегда | Идентификатор файлового общего ресурса Пример: share-AF999C88 | ||
| file_share_status строка | всегда | Статус файлового общего ресурса Пример: ДОСТУПНО | ||
| gateway_arn строка | всегда | ARN шлюза хранения Пример: arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888 | ||
| gateway_id строка | всегда | Идентификатор шлюза хранения Пример: sgw-9999F888 | ||
| gateway_name строка | всегда | Наименование шлюза хранения Пример: my-sgw-01 | ||
| gateway_operational_state строка | всегда | Операционное состояние шлюза хранения Пример: АКТИВНО | ||
| gateway_type строка | всегда | Тип шлюза хранения Пример: FILE_S3 | ||
| local_disks сложный | всегда | Локальные диски шлюза хранения | ||
| disk_allocation_type строка | всегда | Тип выделения диска Пример: КЭШ ХРАНЕНИЯ | ||
| disk_id строка | всегда | Идентификатор диска в системе Пример: pci-0000:00:1f.0 | ||
| disk_node строка | всегда | Родительский блок-устройство диска Пример: /dev/sdb | ||
| disk_path строка | всегда | Путь к диску, используемый для кэша Пример: /dev/nvme1n1 | ||
| disk_size_in_bytes целое число | всегда | Размер диска в байтах Пример: 107374182400 | ||
| disk_status строка | всегда | Статус диска Пример: present | ||
| ленты сложный | когда gateway_type == "VTL" | Ленты шлюза хранения | ||
| tape_arn строка | всегда | ARN ленты Пример: arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88 | ||
| tape_barcode строка | всегда | ARN ленты Пример: tape-AF999C88 | ||
| tape_size_in_bytes целое число | всегда | ARN ленты Пример: 555887569 | ||
| tape_status строка | всегда | ARN ленты Пример: ДОСТУПНО | ||
Авторы
- Лоик Бло (@nerzhul) <loic.blot@unix-experience.fr>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_sgw_info_module.html
