aws_sgw_facts - Получение фактов о хранилище AWS Storage Gateway
Новое в версии 2.6.
Обзор
- Получение фактов о хранилище AWS Storage Gateway
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | |
| aws_secret_key | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если таковое есть. | |
| gather_file_shares bool |
| Сбор информации о файловых ресурсах для хранилищ gateway в режиме s3. |
| gather_local_disks bool |
| Сбор информации о локальных дисках, подключенных к хранилищу gateway. |
| gather_tapes bool |
| Сбор информации о лентах для хранилищ gateway в режиме ленточных накопителей. |
| gather_volumes bool |
| Сбор информации о томах для хранилищ gateway в режимах iSCSI (кешированных и постоянных). |
| profile (добавлено в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region | AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token (добавлено в 1.6) | AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| validate_certs bool (добавлено в 1.5) |
| При значении "no", сертификаты SSL не будут проверятся для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не установлены в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 facts"
aws_sgw_facts:
- name: "Get AWS storage gateway facts for region eu-west-3"
aws_sgw_facts:
region: eu-west-3
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключевые значения | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| шлюзы сложный | всегда | список объектов шлюза | ||
| gateway_arn строка | всегда | ARN шлюза Storage Gateway Пример: arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888 | ||
| gateway_id строка | всегда | Идентификатор шлюза Storage Gateway Пример: sgw-9999F888 | ||
| gateway_name строка | всегда | Дружественное имя шлюза Storage Gateway Пример: my-sgw-01 | ||
| gateway_operational_state строка | всегда | Рабочее состояние шлюза Storage Gateway Пример: ACTIVE | ||
| gateway_type строка | всегда | Тип шлюза Storage Gateway Пример: FILE_S3 | ||
| file_shares сложный | если gateway_type == "FILE_S3" | Файловые ресурсы шлюза Storage Gateway | ||
| file_share_arn строка | всегда | ARN ресурса совместного использования файлов Пример: arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88 | ||
| file_share_id строка | всегда | Идентификатор ресурса совместного использования файлов Пример: share-AF999C88 | ||
| file_share_status строка | всегда | Статус ресурса совместного использования файлов Пример: AVAILABLE | ||
| tapes сложный | если gateway_type == "VTL" | Ленты шлюза Storage Gateway | ||
| tape_arn строка | всегда | ARN ленты Пример: arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88 | ||
| tape_barcode строка | всегда | ARN ленты Пример: tape-AF999C88 | ||
| tape_size_in_bytes целое число | всегда | Размер ленты в байтах Пример: 555887569 | ||
| tape_status строка | всегда | Статус ленты Пример: AVAILABLE | ||
| local_disks сложный | всегда | Локальные диски шлюза Storage Gateway | ||
| disk_allocation_type строка | всегда | Тип выделения диска Пример: CACHE STORAGE | ||
| disk_id строка | всегда | Идентификатор диска в системе Пример: pci-0000:00:1f.0 | ||
| disk_node строка | всегда | Родительский блок-устройство диска Пример: /dev/sdb | ||
| disk_path строка | всегда | Путь к диску, используемому для кэша Пример: /dev/nvme1n1 | ||
| disk_size_in_bytes целое число | всегда | Размер диска в байтах Пример: 107374182400 | ||
| disk_status строка | всегда | Статус диска Пример: present | ||
Состояние
Этот модуль помечен как превью, что означает, что гарантия обратной совместимости не предоставляется.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробности см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. в разделе здесь.
Автор
- Лоик Бло <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.6/modules/aws_sgw_facts_module.html
