ssh_config

Collection: community.general

Full Name: parallax.community.general.ssh_config

Aliases: community.general.ssh_config, ssh_config

Synopsis

Manage host entries in an SSH client config file

Parameters

Name	Type	Required	Default	Description
host	string	yes		The host alias for the SSH config entry
hostname	string			The actual hostname to connect to
user	string			The username to use for the connection
identity_file	string			The path to the SSH identity file (private key)
port	string			The SSH port to connect to
state	string		`present`	Whether the host entry should be present or absent Choices: `present`, `absent`
ssh_config_file	string		`~/.ssh/config`	Path to the SSH config file
strict_host_key_checking	string			StrictHostKeyChecking option Choices: `yes`, `no`, `ask`
proxycommand	string			ProxyCommand to use for the connection
remote_user	string			The remote user (alias for user parameter)

Example

- name: Add a jump host entry for the deploy user
  ssh_config:
    host: bastion
    hostname: bastion.example.com
    user: deploy
    port: "2222"
    identity_file: /home/deploy/.ssh/id_ed25519
    state: present