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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

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

Обзор

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/scaleway_sshkey_module.html