ssh_key_info

Query information on SSH keys

Collection: community.hrobot

Full Name: community.hrobot.ssh_key_info

Synopsis

Query information on SSH keys

Parameters

Name	Type	Required	Default	Description
hetzner_user	str	yes		The username for the Robot web-service user.
hetzner_password	str	yes		The password for the Robot web-service user.
rate_limit_retry_timeout	int		`-1`	Timeout (in seconds) for waiting when rate limit exceeded errors are returned. Set to V(0) to not retry. Set to a negative value like V(-1) to retry forever.

Example

yaml

# Requirements: one localhost inventory host and the supported Linux amd64 native profile.
# Run with --forks 1, Go 1.25.12 and a CGO-disabled native target; Go FIPS mode is disabled.
# Use a supported C/POSIX/C.UTF-8 locale, inherited trust/network/provider configuration
# and valid Robot credentials. The reference compatibility model needs no Python install.
# Unsupported runtime, TLS/provider, codec or resource profiles fail closed.
# Use 1-16 source tasks with literal no_log: true and the same valid literal register r.
# Loops, delegation, roles, handlers, pre/post tasks, task/play environments and multiple
# hosts/SSH are outside this profile. Ordinary debug cannot read the opaque register.
# Replace these placeholder primitive values through protected inventory or variables.
- name: Read private Robot SSH key information locally
  hosts: localhost
  connection: local
  gather_facts: false
  vars:
    robot_user: YOUR_ROBOT_USERNAME
    robot_password: YOUR_ROBOT_PASSWORD
  tasks:
    - name: Query private Robot SSH key information
      community.hrobot.ssh_key_info:
        hetzner_user: '{{ robot_user }}'
        hetzner_password: '{{ robot_password }}'
        rate_limit_retry_timeout: 0
      no_log: true
      register: r