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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.scaleway_sshkey.

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

Обзор

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

Параметры

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

Примечания

Примечание

Также см. документацию 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 (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_sshkey_module.html