community.aws.aws_sgw_facts – Получение информации об AWS Storage Gateway
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для установки используйте: ansible-galaxy collection install community.aws
Для использования в книге задач, укажите: community.aws.aws_sgw_facts
Новое в версии 1.0.0: из 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:action", выполненных во время задачи, выводя список в ключ 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 строка | всегда | ID файла Пример: share-AF999C88 | ||
| file_share_status строка | всегда | Статус файла Пример: AVAILABLE | ||
| gateway_arn строка | всегда | ARN шлюза Пример: arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888 | ||
| gateway_id строка | всегда | ID шлюза Пример: sgw-9999F888 | ||
| gateway_name строка | всегда | Название шлюза Пример: my-sgw-01 | ||
| gateway_operational_state строка | всегда | Рабочее состояние шлюза Пример: ACTIVE | ||
| gateway_type строка | всегда | Тип шлюза Пример: FILE_S3 | ||
| local_disks сложный | всегда | Локальные диски шлюза | ||
| disk_allocation_type строка | всегда | Тип выделения диска Пример: CACHE STORAGE | ||
| disk_id строка | всегда | 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 ленты Пример: AVAILABLE | ||
Авторы
- Лоик Блот (@nerzhul) <loic.blot@unix-experience.fr>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/aws_sgw_facts_module.html
