Модуль community.hrobot.storagebox_info — получение сведений об одном или нескольких хранилищах

full_info

логическое значение

Предоставлять ли полные сведения о каждом хранилище.

Если установить значение true, для каждого хранилища будет выполняться отдельный вызов REST, что занимает много времени и уменьшает доступный лимит запросов. Используйте с осторожностью.

Если указан storagebox_id, этот параметр всегда рассматривается как имеющий значение true.

Примечание: этот параметр не действует, если указан hetzner_token.

Возможные значения:

• false ← (по умолчанию)
• true

hetzner_password

строка

Пароль пользователя веб-службы Robot.

Если указан hetzner_password, необходимо также указать hetzner_user, а hetzner_token указывать нельзя.

Этот параметр устарел в данном модуле; его поддержка будет удалена в community.hrobot 3.0.0.

hetzner_token

строка

добавлено в community.hrobot 2.5.0

Токен API пользователя веб-службы Robot.

Необходимо указать один из параметров: hetzner_token или hetzner_user.

Начиная с community.hrobot 3.0.0 этот параметр станет обязательным.

hetzner_user

строка

Имя пользователя веб-службы Robot.

Необходимо указать один из параметров: hetzner_token или hetzner_user.

Если указан hetzner_user, необходимо также указать hetzner_password, а hetzner_token указывать нельзя.

Этот параметр устарел в данном модуле; его поддержка будет удалена в community.hrobot 3.0.0.

linked_server_number

целое число

Ограничить список результатов хранилищами, связанными с сервером с указанным номером.

Игнорируется, если указан storagebox_id или hetzner_token.

rate_limit_retry_timeout

целое число

добавлено в community.hrobot 2.1.0

Время ожидания (в секундах) при получении ошибок превышения лимита запросов.

Установите значение 0, чтобы отключить повторные попытки.

Установите отрицательное значение, например -1, чтобы повторять попытки бесконечно.

По умолчанию: -1

storagebox_id

целое число

Ограничить список результатов хранилищами с указанным идентификатором.

action_group

Группы действий: community.hrobot.api, community.hrobot.robot

Используйте group/community.hrobot.robot или group/community.hrobot.api в module_defaults, чтобы задать значения по умолчанию для этого модуля.

Группа group/community.hrobot.robot устарела для этого модуля; модуль будет исключён из неё в community.hrobot 3.0.0.

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Может выполняться в check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: не применимо

Это действие не изменяет состояние.

В режиме сравнения будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в check_mode).

idempotent

Поддержка: полная

Это действие не изменяет состояние.

При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений.

Предполагается, что система, управляемая или запрашиваемая модулем, не изменилась существенным образом.

storageboxes

list / elements=dictionary

Список хранилищ, соответствующих указанным параметрам.

Возвращается: при успешном выполнении

access_settings

dictionary

добавлено в community.hrobot 2.5.0

Настройки доступа к хранилищу.

Возвращается: если указан hetzner_token

reachable_externally

boolean

Доступно ли хранилище извне сети Hetzner.

Возвращается: при успешном выполнении

Пример: false

samba_enabled

boolean

Включена ли SAMBA.

Возвращается: при успешном выполнении

Пример: false

ssh_enabled

boolean

Включён ли SSH.

Возвращается: при успешном выполнении

Пример: false

webdav_enabled

boolean

Включён ли WebDAV.

Возвращается: при успешном выполнении

Пример: false

zfs_enabled

boolean

Включён ли ZFS.

Возвращается: при успешном выполнении

Пример: false

cancelled

boolean

Была ли отменена услуга хранилища.

Отмену ещё можно отменить, пока не истёк срок storageboxes[].paid_until.

Возвращается: при успешном выполнении и если указан hetzner_user

Пример: false

created

string

добавлено в community.hrobot 2.5.0

Временная метка создания в формате ISO 8601.

Возвращается: если указан hetzner_token

Пример: "2016-01-30T23:55:00+00:00"

disk_quota

integer

Общий доступный объём в МБ.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].storage_box_type.size.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: 10240000

disk_usage

integer

Используемый объём в МБ.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].stats.size.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: 900

disk_usage_data

integer

Объём в МБ, используемый файлами.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].stats.size_data.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: 500

disk_usage_snapshots

integer

Объём в МБ, используемый снимками.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].stats.size_snapshots.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: 400

external_reachability

boolean

Доступно ли хранилище извне.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].access_settings.reachable_externally.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: true

host_system

string

Идентификатор хоста хранилища.

Возвращается: если указаны full_info=true и hetzner_user

Пример: "FSN1-BX355"

id

integer

Идентификатор хранилища.

Возвращается: при успешном выполнении

Пример: 123456

labels

dictionary

добавлено в community.hrobot 2.5.0

Пользовательские метки хранилища.

Возвращается: если указан hetzner_token

linked_server

integer

Идентификатор (номер сервера) подключённого сервера, если он доступен. В противном случае — null.

Возвращается: при успешном выполнении и если указан hetzner_user

Пример: 123456

location

any

Расположение хранилища.

Строка, если указан hetzner_user, и словарь, если указан hetzner_token.

Возвращается: при успешном выполнении

Пример: "FSN1"

locked

boolean

Заблокирован ли IP-адрес.

Возвращается: при успешном выполнении и если указан hetzner_user

Пример: false

login

string

Имя пользователя для входа в хранилище.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].username.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: при успешном выполнении

Пример: "u12345"

name

string

Имя хранилища.

Возвращается: при успешном выполнении и если указан hetzner_user

Пример: "Backup Server 1"

paid_until

string

Дата, до которой оплачено использование хранилища.

Возвращается: при успешном выполнении и если указан hetzner_user

Пример: "2015-10-23"

product

string

Название продукта.

Возвращается: при успешном выполнении и если указан hetzner_user

Пример: "BX60"

protection

dictionary

добавлено в community.hrobot 2.5.0

Настройки защиты хранилища.

Возвращается: если указан hetzner_token

delete

boolean

Отключено ли удаление хранилища.

Возвращается: при успешном выполнении

Пример: false

samba

boolean

Активна ли SAMBA.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].access_settings.samba_enabled.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: true

server

string

Имя хоста хранилища.

Возвращается: если указан full_info=true; либо если указан hetzner_token и storageboxes[].status не является initializing

Пример: "u12345.your-storagebox.de"

snapshot_plan

dictionary

добавлено в community.hrobot 2.5.0

План создания снимков для хранилища.

Если план не активен, будет none (JSON null).

Возвращается: если указан hetzner_token и storageboxes[].status не является initializing

day_of_month

integer

День месяца, в который выполняется план создания снимков.

Если это ограничение не задано, будет none (JSON null); то есть снимок создаётся ежедневно, если не указан день недели.

Возвращается: при успешном выполнении

day_of_week

integer

День недели, в который выполняется план создания снимков.

Если это ограничение не задано, будет none (JSON null); то есть снимок создаётся ежедневно, если не указан день месяца.

Возвращается: при успешном выполнении

hour

integer

Час выполнения плана создания снимков (UTC).

Возвращается: при успешном выполнении

max_snapshots

integer

Максимальное количество автоматических снимков, которые будут сохранены.

Возвращается: при успешном выполнении

Пример: 10

minute

integer

Минута выполнения плана создания снимков (UTC).

Возвращается: при успешном выполнении

ssh

boolean

Активен ли SSH.

Обратите внимание: если указан hetzner_token, это значение копируется из storageboxes[].access_settings.ssh_enabled.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с hetzner_token появится сообщение об устаревании.

Возвращается: если указан full_info=true или hetzner_token

Пример: true

stats

dictionary

добавлено в community.hrobot 2.5.0

Сведения об использовании дискового пространства.

Возвращается: если указан hetzner_token и storageboxes[].status не является initializing

size

integer

Текущее использование диска в байтах.

Возвращается: при успешном выполнении

Пример: 0

size_data

integer

Текущее использование диска данными в байтах.

Возвращается: при успешном выполнении

Пример: 0

size_snapshots

integer

Текущее использование диска снимками в байтах.

Возвращается: при успешном выполнении

Пример: 0

status

string

добавлено в community.hrobot 2.5.0

Статус хранилища.

Возвращается: если указан hetzner_token

Возможные значения:

• "active"
• "initializing"
• "locked"

Пример: "active"

storage_box_type

dictionary

добавлено в community.hrobot 2.5.0

Сведения о типе хранилища.

Возвращается: если указан hetzner_token

automatic_snapshot_limit

integer

Максимальное количество снимков, автоматически создаваемых планом создания снимков.

Возвращается: success

Пример: 10

deprecation

dictionary

Установлено значение none (JSON null), если тип хранилища не объявлен устаревшим.

Если установлено значение в виде словаря, тип этого хранилища объявлен устаревшим.

Возвращается: success

announced

string

Временная метка в формате ISO 8601, указывающая, когда было объявлено об устаревании.

Возвращается: success

Пример: "2023-06-01T00:00:00+00:00"

unavailable_after

string

Временная метка в формате ISO 8601, указывающая, когда ресурс будет удалён.

Возвращается: success

Пример: "2023-09-01T00:00:00+00:00"

description

string

Описание типа хранилища.

Возвращается: success

Пример: "BX11"

name

string

Идентификатор типа хранилища.

Возвращается: success

Пример: "bx11"

prices

list / elements=dictionary

Стоимость для каждого местоположения.

Возвращается: success

location

string

Название местоположения.

Возвращается: success

Пример: "fsn1"

price_hourly

dictionary

Почасовая ставка.

Возвращается: success

gross

string

Почасовая стоимость (с НДС).

Возвращается: success

Пример: "1.1900"

net

string

Почасовая стоимость (без НДС).

Возвращается: success

Пример: "1.0000"

price_monthly

dictionary

Месячная ставка.

Возвращается: success

gross

string

Месячная стоимость (с НДС).

Возвращается: success

Пример: "1.1900"

net

string

Месячная стоимость (без НДС).

Возвращается: success

Пример: "1.0000"

setup_fee

dictionary

Плата за настройку.

Возвращается: success

gross

string

Плата за настройку (с НДС).

Возвращается: success

Пример: "1.1900"

net

string

Плата за настройку (без НДС).

Возвращается: success

Пример: "1.0000"

size

integer

Доступный объём хранилища в байтах.

Возвращается: success

Пример: 1073741824

snapshot_limit

integer

Максимальное количество разрешённых снимков, созданных вручную.

Возвращается: success

Пример: 10

subaccounts_limit

integer

Максимальное количество разрешённых субаккаунтов.

Возвращается: success

Пример: 200

system

string

добавлено в community.hrobot 2.5.0

Идентификатор хоста хранилища.

Возвращается: если указано hetzner_token и storageboxes[].status не равно initializing

Пример: "FSN1-BX355"

username

string

добавлено в community.hrobot 2.5.0

Имя пользователя для входа в хранилище.

Возвращается: success, если указано hetzner_token.

Пример: "u12345"

webdav

boolean

Указывает, активен ли WebDAV.

Обратите внимание, что это значение копируется из storageboxes[].access_settings.webdav_enabled, если указано hetzner_token.

Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core версии 2.19 или новее при использовании этого возвращаемого значения с hetzner_token будет отображаться сообщение об устаревании.

Возвращается: если указано full_info=true или hetzner_token

Пример: true

zfs

boolean

Указывает, виден ли каталог ZFS.

Обратите внимание, что это значение копируется из storageboxes[].access_settings.zfs_enabled, если указано hetzner_token.

Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core версии 2.19 или новее при использовании этого возвращаемого значения с hetzner_token будет отображаться сообщение об устаревании.

Возвращается: если указано full_info=true или hetzner_token

Пример: false