Модуль community.general.scaleway_sshkey — управление SSH-ключами Scaleway

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.

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

Обзор
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль управляет SSH-ключами в учётной записи Scaleway (https://developer.scaleway.com).

Требования

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

PyYAML (если используется profile)

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка	Токен OAuth Scaleway. Этот параметр обязателен, если не указан `profile`.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://account.scaleway.com"`
profile псевдонимы: scw_profile строка добавлено в community.general 12.2.0	Профиль конфигурации из файла конфигурации, из которого загружается токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
query_parameters словарь	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
ssh_pub_key строка / обязательный	Открытый SSH-ключ в виде строки, которую нужно добавить.
state строка	Желаемое состояние SSH-ключа. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Проверять сертификаты SSL API Scaleway. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения изменений возвращает сведения о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примечания

Примечание

Также см. документацию API по адресу https://developer.scaleway.com/.
Если api_token не задан в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета: SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Чтобы использовать другой api_url, можно также задать переменную окружения SCW_API_URL.

Примеры

- name: "Add SSH key"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"

- name: "Delete SSH key"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "absent"

- name: "Add SSH key with explicit token"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"
    oauth_token: "6ecd2c9b-6f4f-44d4-a187-61a92078d08c"

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

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

Ключ	Описание
data словарь	Присутствует только при `state=present`. Возвращается: если `state=present` Пример: `{"ssh_public_keys": [{"key": "ssh-rsa AAAA...."}]}`

Авторы

Remy Leone (@remyleone)

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

© 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/general/scaleway_sshkey_module.html