diff --git a/XX.-Модуль-decort_disk.md b/XX.-Модуль-decort_disk.md index 44bedc8..d036a32 100644 --- a/XX.-Модуль-decort_disk.md +++ b/XX.-Модуль-decort_disk.md @@ -14,17 +14,17 @@ | Параметр | Тип, допустимые значения | Описание | | --- | --- | --- | -| account_id | (int) | Уникальный целочисленный идентификатор учётной записи (_account_), которой принадлежит данный диск.
При идентификации диска по имени (см. параметр`disk_name`) должно быть задан либо идентификатор, либо имя учётной записи (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | -| account_name | (string) | Имя учётной записи (_account_), которой принадлежит данный диск.
При идентификации диска по имени (см. параметр `disk_name`) должно быть задано либо имя, либо идентификатор учётной записи (см. параметр `account_id`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +| account_id | (int) | Уникальный целочисленный идентификатор учётной записи (_account_), которой принадлежит данный диск.
При идентификации диска по имени (см. параметр`name`) должно быть задан либо идентификатор, либо имя учётной записи (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +| account_name | (string) | Имя учётной записи (_account_), которой принадлежит данный диск.
При идентификации диска по имени (см. параметр `name`) должно быть задано либо имя, либо идентификатор учётной записи (см. параметр `account_id`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | | annotation | (string) | Текстовое описание диска. Данный аргумент является опциональным и учитывается только при создании диска, а при всех прочих операциях игнорируется. | | app_id | (string) | Идентификатор приложения, использующийся для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECORT_APP_ID_. | | app_secret | (string) | Секретный ключ приложения, который используется для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима. Так как он содержит секретную информацию, то его не рекомендуется задавать непосредственно в _playbook_.
Если параметр не задан в _playbook_, то модуль будет использовать значение переменной окружения _DECORT_APP_SECRET_. | | authenticator | Значения:
`legacy`
`oauth2`
`jwt` <- default | Режим аутентификации при подключении к контроллеру облачной платформы DECORT. | | controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECORT, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.
Данный параметр является обязательным. | -| disk_id | (int) | Уникальный целочисленный идентификатор диска. Соответствующий диск должен существовать (таким образом, с помощью `disk_id` нельзя создать новый диск, а только управлять уже имеющимися).
Если задан данный параметр, то параметры `disk_name`, `account_name` и `account_id` игнорируются.| -| disk_name | (string) | Имя диска.
Для идентификации диска требуется либо его имя `disk_name` и информация об учётной записи (`account_id` или `account_name`), которой принадлежит диск, либо его `disk_id`. | +| id | (int) | Уникальный целочисленный идентификатор диска. Соответствующий диск должен существовать (таким образом, с помощью `id` нельзя создать новый диск, а только управлять уже имеющимися).
Если задан данный параметр, то параметры `name`, `account_name` и `account_id` игнорируются.| | force_detach | (bool)
`True`
`False` <- default | Задаёт поведение платформы при попытке удалить диск, подключённый к экземпляру _compute_.
По умолчанию, удаление подключённых дисков не разрешается, и попытка удалить такой диск приведёт к аварийному завершению модуля. Чтобы изменить это поведение, явно установите `force_detach: True`. | | jwt | (string) | JSON Web Token (JWT), который будет использоваться для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: jwt`
Данный параметр является обязательным для указанного режима.
Так как он содержит потенциально секретную информацию, а сам JWT, как правило, имеет ограниченное время жизни, то его не рекомендуется задавать непосредственно в _playbook_.
Если этот параметр не определен в _playbook_, то модуль будет использовать значение переменной окружения _DECORT_JWT_. | +| name | (string) | Имя диска.
Для идентификации диска требуется либо его имя `name` и информация об учётной записи (`account_id` или `account_name`), которой принадлежит диск, либо его `id`. | | oauth2_url | (string) | URL авторизационного сервера, работающего по протоколу _Oauth2_, который должен использоваться в режиме `authenticator: oauth2`.
Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECORT_OAUTH2_URL_. | | place_with | (int) | Идентификатор образа ОС, из которого следует взять параметр `sep_id`, чтобы разместить данный диск на той же системе хранения данных, что и указанный образ ОС.
Данный параметр является опциональным и используется только на стадии создания диска. Если задан `place_with`, то `sep_id` игнорируется. | | pool | (string) | Название пула на системе хранения данных, в рамках которой следует создать данный диск. Этот параметр используется только на стадии создания диска и игнорируется при операциях над уже существующими дисками. Параметр является опциональным, значение по умолчанию `default`. |