Модуль community.aws.storagegateway_info – получение информации об AWS Storage Gateway

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.storagegateway_info.

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получение информации об AWS Storage Gateway
До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_sgw_info. Использование не изменилось.

Псевдонимы: aws_sgw_info

Требования

Следующие требования необходимо выполнить на узле, где выполняется этот модуль.

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, который используется при проверке SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Список параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для подсчета уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в рамках плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо стандартных конечных точек AWS. Это можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
gather_file_shares логическое значение	Собирать сведения об общих папках шлюзов хранения, работающих в режиме s3. Варианты: `false` `true` ← (по умолчанию)
gather_local_disks логическое значение	Собирать сведения о локальных дисках, подключенных к шлюзу хранения. Варианты: `false` `true` ← (по умолчанию)
gather_tapes логическое значение	Собирать сведения о лентах шлюзов хранения, работающих в ленточном режиме. Варианты: `false` `true` ← (по умолчанию)
gather_volumes логическое значение	Собирать сведения о томах шлюзов хранения в режимах iSCSI (кэшируемом и хранимом). Варианты: `false` `true` ← (по умолчанию)
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для временных учетных данных. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
validate_certs логическое значение	Если установлено значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: "Get AWS storage gateway information"
  community.aws.storagegateway_info:

- name: "Get AWS storage gateway information for region eu-west-3"
  community.aws.storagegateway_info:
    region: eu-west-3

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

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

Ключ	Описание
gateways сложный тип	список объектов шлюзов Возвращается: всегда
file_shares сложный тип	Общие папки шлюза хранения Возвращается: если gateway_type == “FILE_S3”
file_share_arn строка	ARN общей папки Возвращается: всегда Пример: `"arn:aws:storagegateway:eu-west-1:123456789012:share/share-AF999C88"`
file_share_id строка	Идентификатор общей папки Возвращается: всегда Пример: `"share-AF999C88"`
file_share_status строка	Состояние общей папки Возвращается: всегда Пример: `"AVAILABLE"`
gateway_arn строка	ARN шлюза хранения Возвращается: всегда Пример: `"arn:aws:storagegateway:eu-west-1:123456789012: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 сложный тип	Ленты Storage Gateway Возвращается: если gateway_type == “VTL”
tape_arn строка	ARN ленты Возвращается: всегда Пример: `"arn:aws:storagegateway:eu-west-1:123456789012:tape/tape-AF999C88"`
tape_barcode строка	ARN ленты Возвращается: всегда Пример: `"tape-AF999C88"`
tape_size_in_bytes целое число	ARN ленты Возвращается: всегда Пример: `555887569`
tape_status строка	ARN ленты Возвращается: всегда Пример: `"AVAILABLE"`

Авторы

Loic Blot (@nerzhul)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/storagegateway_info_module.html