Модуль dellemc.enterprise_sonic.sonic_ssh — управление конфигурациями 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.

Новая возможность в dellemc.enterprise_sonic 3.0.0

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

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

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

Параметры

Параметр	Комментарии
config dictionary	SSH-клиенты и серверы используют следующие конфигурации для SSH-подключений.
client dictionary	Конфигурация SSH-клиента
cipher string	Алгоритм шифрования, используемый в SSH-подключении. Если задано значение, его используют SSH-клиенты, взаимодействующие с сервером. Укажите список значений, разделённых запятыми. Возможные значения: aes128-ctr, aes192-ctr, aes256-ctr chacha20-poly1305@openssh.com, aes128-gcm@openssh.com и aes256-gcm@openssh.com
kex string	Алгоритм обмена ключами (KEX), используемый в SSH-подключении. Если задано значение, его используют SSH-клиенты, взаимодействующие с сервером. Укажите список значений, разделённых запятыми. Возможные значения: 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
mac string	Алгоритм MAC, используемый в SSH-подключении для создания и проверки кодов аутентификации сообщений. Если задано значение, его используют 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
state string	Параметр state определяет тип обновления конфигурации, выполняемого на устройстве. Если state имеет значение «merged», указанные атрибуты объединяются с уже настроенными. Если state имеет значение «deleted», указанные атрибуты удаляются из существующей конфигурации. Если state имеет значение «replaced», конфигурация SSH на устройстве заменяется указанной конфигурацией. Если state имеет значение «overridden», конфигурации SSH на устройстве переопределяются указанной конфигурацией. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

Проверено на Enterprise SONiC Distribution от Dell Technologies.
Поддерживает check_mode.

Примеры

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

- name: Delete specified SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
      client:
        cipher: 'aes192-ctr,chacha20-poly1305@openssh.com'
        mac: 'umac-128-etm@openssh.com,hmac-sha2-256-etm@openssh.com'
    state: deleted

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


# Using "deleted" 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: Delete all SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip ssh client"
# (No "ip ssh client" configuration present)
# sonic#


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep "ip ssh client"
# sonic
# (No "ip ssh client" configuration present)

- name: Modify SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
      client:
        cipher: 'aes192-ctr,chacha20-poly1305@openssh.com'
        mac: 'umac-128-etm@openssh.com,hmac-sha2-256-etm@openssh.com'
        kex: 'curve25519-sha256,diffie-hellman-group16-sha512'
    state: merged

# After 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#


# 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: Modify SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
      client:
        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 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: Modify SSH configurations
  dellemc.enterprise_sonic.sonic_ssh:
    config:
      client:
        cipher: 'aes256-ctr'
        mac: 'umac-128-etm@openssh.com,hmac-sha2-256-etm@openssh.com'
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration | grep "ip ssh client"
# ip ssh client ciphers aes256-ctr
# ip ssh client macs umac-128-etm@openssh.com,hmac-sha2-256-etm@openssh.com
# sonic#

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

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

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

Авторы

Balasubramaniam Koundappa(@balasubramaniam-k)

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

© 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_module.html