модуль dellemc.enterprise_sonic.sonic_ssh_server — управление конфигурациями SSH-сервера в SONiC

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

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

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

Для использования в плейбуке укажите: dellemc.enterprise_sonic.sonic_ssh_server.

Добавлено в dellemc.enterprise_sonic 3.1.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Этот модуль управляет конфигурацией SSH-сервера, задавая алгоритмы для SSH-подключений на устройствах под управлением SONiC.

Параметры

Параметр	Комментарии
config dictionary	SSH-серверы используют следующие конфигурации для SSH-подключений.
server_globals dictionary	Глобальная конфигурация SSH-сервера. При удалении параметров типа ‘str’ восстанавливаются их значения по умолчанию.
ciphers string	Настройка шифров на SSH-сервере. По умолчанию используются aes128-ctr,aes192-ctr,aes256-ctr,chacha20-poly1305@openssh.com, aes128-gcm@openssh.com,aes256-gcm@openssh.com.
disable_forwarding boolean	Настройка отключения перенаправления на SSH-сервере. Значение по умолчанию — False. Варианты: `false` `true`
hostkeyalgorithms string	Настройка алгоритмов ключей хоста на SSH-сервере. По умолчанию используются ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa.
kexalgorithms string	Настройка алгоритмов обмена ключами. По умолчанию используются curve25519-sha256,curve25519-sha256@libssh.org,ecdh-sha2-nistp256, ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha256, diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,diffie-hellman-group14-sha256,
macs string	Настройка MAC-алгоритмов на SSH-сервере. По умолчанию используются umac-128-etm@openssh.com,hmac-sha2-256-etm@openssh.com, hmac-sha2-512-etm@openssh.com,umac-128@openssh.com,hmac-sha2-256,hmac-sha2-512.
max_auth_retries integer	Количество попыток аутентификации, разрешённых до завершения сеанса. Диапазон: 0–10. Значение по умолчанию — 6.
password_authentication boolean	Настройка аутентификации по паролю на SSH-сервере. По умолчанию она включена. Значение по умолчанию — True. Варианты: `false` `true`
permit_root_login boolean	Настройка разрешения входа root на SSH-сервере. Значение по умолчанию — False. Варианты: `false` `true`
permit_user_environment boolean	Настройка разрешения использования пользовательского окружения на SSH-сервере. Значение по умолчанию — False. Варианты: `false` `true`
permit_user_rc boolean	Настройка разрешения выполнения пользовательского rc-файла на SSH-сервере. Значение по умолчанию — True. Варианты: `false` `true`
publickey_authentication boolean	Настройка аутентификации с открытым ключом на SSH-сервере. Значение по умолчанию — True. Варианты: `false` `true`
x11_forwarding boolean	Настройка перенаправления X11 на SSH-сервере. Значение по умолчанию — False. Варианты: `false` `true`
state string	Состояние конфигурации после выполнения модуля. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip ssh"
# ip ssh disable-publickey-authentication true
# sonic#

- name: Delete specified SSH configurations
  dellemc.enterprise_sonic.sonic_ssh_server:
    config:
      server_globals:
        publickey_authentication: false
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip ssh"
# ip ssh disable-publickey-authentication false
# sonic#


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip ssh"
# ip ssh disable-publickey-authentication false
# sonic#

- name: Modify SSH configurations
  dellemc.enterprise_sonic.sonic_ssh_server:
    config:
      server_globals:
        publickey_authentication: false
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip ssh"
# ip ssh disable-publickey-authentication true
# sonic#


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip ssh client"
# ip ssh client ciphers aes192-ctr,chacha20-poly1305@openssh.com
# ip ssh client kexalgorithms curve25519-sha256,diffie-hellman-group16-sha512
# ip ssh client macs umac-128-etm@openssh.com,hmac-sha2-256-etm@openssh.com
# sonic#

- name: Replace SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
      server_globals:
        cipher: 'aes256-ctr'
        kex: 'curve25519-sha256,diffie-hellman-group16-sha512'
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip ssh client"
# ip ssh client ciphers aes256-ctr
# ip ssh client kexalgorithms curve25519-sha256,diffie-hellman-group16-sha512
# sonic#


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip ssh"
# ip ssh disable-publickey-authentication false
# sonic#

- name: Override SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
      server_globals:
        publickey_authentication: false
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip ssh"
# ip ssh disable-publickey-authentication true
# sonic#

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

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

Ключ	Описание
after dictionary	Конфигурация, полученная в результате вызова модуля. Возвращается: при изменении Пример: `"The configuration returned will always be in the same format\n of the parameters above.\n"`
after(generated) dictionary	Конфигурация, которая была бы создана при вызове модуля не в режиме проверки. Возвращается: когда `check_mode` Пример: `"The configuration returned will always be in the same format as the parameters above.\n"`
before dictionary	Конфигурация до вызова модуля. Возвращается: всегда Пример: `"The configuration returned will always be in the same format\n of the parameters above.\n"`
commands list / elements=string	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Bhavesh (@bhaveshdell)

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

© 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/dellemc/enterprise_sonic/sonic_ssh_server_module.html