VyOS icon

VyOS

Interact with VyOS router via HTTP API

Overview

This node interacts with a VyOS router via its HTTP API, specifically providing functionality to generate cryptographic materials such as SSH key pairs. The "Generate" resource with the "SSH Key Pair" operation allows users to create SSH keys of various types and sizes directly within an n8n workflow. This is useful for automating secure access setup, managing credentials, or integrating key generation into deployment pipelines.

Practical examples include:

  • Automatically generating SSH keys for new server instances.
  • Creating keys for secure communication between services.
  • Integrating key creation into infrastructure-as-code workflows.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the key generation:
- Key Type Type of SSH key to generate. Options: RSA, DSA, ECDSA, Ed25519 (default: RSA).
- Key Size Size of the key in bits. Options: 1024, 2048 (default), 4096.
- Format Output Whether to format the output for better readability (boolean, default: true).

Output

The node outputs JSON data containing the generated SSH key pair. Typically, this includes:

  • The private key material.
  • The public key material.

If the "Format Output" option is enabled, the keys are formatted for readability, making them easier to use or store. There is no indication that binary data is output by this node.

Dependencies

  • Requires connection to a VyOS router's HTTP API.
  • Needs an API authentication token or API key credential configured in n8n to authenticate requests.
  • The base URL and SSL validation settings are derived from the provided credentials.

Troubleshooting

  • Common issues:

    • Authentication failures due to incorrect or missing API credentials.
    • Network connectivity problems preventing access to the VyOS API endpoint.
    • Unsupported key type or size values leading to errors in key generation.
  • Error messages:

    • Errors related to invalid credentials typically indicate misconfiguration of the API key or host URL.
    • Timeouts or connection refused errors suggest network or firewall issues.
    • Validation errors on input properties may occur if unsupported key types or sizes are selected; ensure options conform to supported values.

Links and References

Discussion