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 | |
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводя список в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения плейбука. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать EC2-эндпоинты). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть. | |
| gather_file_shares логический тип |
| Сбор информации о файловых ресурсах для шлюзов хранения в режиме S3. |
| gather_local_disks логический тип |
| Сбор информации о локальных дисках, подключенных к шлюзу хранения. |
| gather_tapes логический тип |
| Сбор информации о лентах для шлюзов хранения в режиме ленточных накопителей. |
| gather_volumes логический тип |
| Сбор информации о томах для шлюзов хранения в режимах iSCSI (кэшированные и хранимые). |
| profile строка | Использует профиль 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 строка | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| validate_certs логический тип |
| При установке в «нет», сертификаты 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), если учетные данные не предоставлены. См. 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 facts"
aws_sgw_facts:
- name: "Get AWS storage gateway facts for region eu-west-3"
aws_sgw_facts:
region: eu-west-3
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключевые слова | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| gateways сложный | всегда | список объектов шлюзов | ||
| 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 строка | всегда | Состояние файлового ресурса Пример: AVAILABLE | ||
| 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 строка | всегда | Операционное состояние шлюза хранения Пример: ACTIVE | ||
| gateway_type строка | всегда | Тип шлюза хранения Пример: FILE_S3 | ||
| local_disks сложный | всегда | Локальные диски шлюза хранения | ||
| 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 | ||
| tapes сложный | если 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 | ||
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Loic Blot (@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.8/modules/aws_sgw_facts_module.html