Resource Type: opnsense_device

Defined in:

lib/puppet/type/opnsense_device.rb

Summary

Manage an OPNsense device access.

Overview

This type provides Puppet with the capabilities to manage OPNSense device access data.

Examples:

opnsense_device { 'opnsense.example.com':
  url        => 'https://opnsense.example.com/api',
  api_key    => 'your_api_key',
  api_secret => Sensitive('your_api_secret'),
  timeout    => 60,
  ssl_verify => true,
  ca         => '/path/to/ca.pem',
  ensure     => 'present',
}

Properties

• api_key

  The api key from the generated key/secret pair.

• api_secret

  The api secret from the generated key/secret pair.

• ca

  The path to the ca bundle file for ssl verification.

• ensure (defaults to: present)

  Whether this resource should be present or absent on the target system.

• ssl_verify (defaults to: true)

  The timeout for API calls in seconds.

• timeout (defaults to: 60)

  The timeout for API calls in seconds.

• url

  The api url of the OPNsense device.

Parameters

• name (namevar)

  The name of the OPNsense device you want to manage.