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

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
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` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, выполненных во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте `aws_resource_action` обратный вызов для вывода полного списка, выполненного во время выполнения книги. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также можно использовать переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
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 и security_token.
region псевдонимы: aws_region, ec2_region строка	Используемая область AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.

secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для обеспечения соответствия с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Токен сессии 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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
validate_certs boolean	При установке в `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка validate_certs=false категорически не рекомендуется. Вместо этого рассмотрите возможность установки aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллера». Поэтому, возможно, потребуется явно скопировать файлы на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

Значения возврата

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

Ключ	Описание
шлюзы сложный	список объектов шлюза Возвращается: всегда
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"`
ленты сложный	Ленты шлюза хранилища Возвращается: при gateway_type == “VTL”

tape_arn string	ARN ленты Возвращается: всегда Пример: `"arn:aws:storagegateway:eu-west-1:123456789012:tape/tape-AF999C88"`
tape_barcode string	Код штрих-кода ленты Возвращается: всегда Пример: `"tape-AF999C88"`
tape_size_in_bytes integer	Размер ленты в байтах Возвращается: всегда Пример: `555887569`
tape_status string	Статус ленты Возвращается: всегда Пример: `"AVAILABLE"`

Авторы

Loic Blot (@nerzhul)

Ссылки на сборку

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