authenticate Method

Authenticates the user.

Syntax

def authenticate() -> None: ...

Remarks

This method authenticates the user against the ssh_host. If authentication succeeds this method returns without error. If authentication fails, or an error is encountered, the class fails with an error.

The following common properties are applicable when calling this method:

• user (required)
• password (required for password authentication)
• ssh_cert (required for public key authentication)
• ssh_host (required)
• ssh_port
• auth_mode
• ssh_encryption_algorithms

Keyboard interactive authentication is handled through the on_ssh_keyboard_interactive event.