Spec-Zone.ru › Ansible 2.10

community.aws.aws_sgw_info – Получение информации об AWS Storage Gateway

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в playbook, укажите: community.aws.aws_sgw_info.

Введено в версии 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 Bundle читается со стороны модуля и, возможно, потребует явного копирования с контроллера, если он не выполняется локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной информации о конфигурации 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 для вывода общего списка, выполненного во время выполнения playbook. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Краткое описание полей Возвращаемое значение Описание
gateways
complex
всегда
список объектов шлюзов
file_shares
complex
если gateway_type == "FILE_S3"
Файловые ресурсы шлюза хранилища
file_share_arn
string
всегда
ARN файлового ресурса

Пример:
arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88
file_share_id
string
всегда
Идентификатор файлового ресурса

Пример:
share-AF999C88
file_share_status
string
всегда
Статус файлового ресурса

Пример:
ДОСТУПНО
gateway_arn
string
всегда
ARN шлюза хранилища

Пример:
arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888
gateway_id
string
всегда
Идентификатор шлюза хранилища

Пример:
sgw-9999F888
gateway_name
string
всегда
Наименование шлюза хранилища

Пример:
my-sgw-01
gateway_operational_state
string
всегда
Оперативное состояние шлюза хранилища

Пример:
АКТИВНО
gateway_type
string
всегда
Тип шлюза хранилища

Пример:
FILE_S3
local_disks
complex
всегда
Локальные диски шлюза хранилища
disk_allocation_type
string
всегда
Тип выделения диска

Пример:
CACHE STORAGE
disk_id
string
всегда
Идентификатор диска в системе

Пример:
pci-0000:00:1f.0
disk_node
string
всегда
Родительский блок-устройство диска

Пример:
/dev/sdb
disk_path
string
всегда
Путь к диску, используемому для кэширования

Пример:
/dev/nvme1n1
disk_size_in_bytes
integer
всегда
Размер диска в байтах

Пример:
107374182400
disk_status
string
всегда
Статус диска

Пример:
present
tapes
complex
если gateway_type == "VTL"
Ленты шлюза хранилища
tape_arn
string
всегда
ARN ленты

Пример:
arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88
tape_barcode
string
всегда
ARN ленты

Пример:
tape-AF999C88
tape_size_in_bytes
integer
всегда
ARN ленты

Пример:
555887569
tape_status
string
всегда
ARN ленты

Пример:
ДОСТУПНО


Авторы

  • Лоик Бло (@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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API