Spec-Zone.ru › Ansible 2.9

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

Новый в версии 2.6.

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

Обзор

  • Этот модуль управляет ключами 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"
  scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"

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

- name: "Add SSH key with explicit token"
  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....'}]}


Статус

  • Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Remy Leone (@sieben)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/scaleway_sshkey_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API