REFERENCE.md

Reference

Table of Contents

Classes

• wifi: Manage Wi-Fi configuration

Defined types

• wifi::infrastructure: This define configure a Wi-Fi connection to a network

Functions

• wifi::wpa_passphrase: Generate the 256-bit pre-shared WPA key for a Wi-Fi network

Classes

wifi

Manage Wi-Fi configuration

Defined types

wifi::infrastructure

This define configure a Wi-Fi connection to a network

Parameters

The following parameters are available in the wifi::infrastructure defined type:

• dns
• mac
• psk
• ssid
• uuid
• priority
• bssid
• ensure

dns

Data type: Array[String]

DNS servers to use with this connection

Default value: []

mac

Data type: Optional[String]

MAC address of the Access Point

Default value: undef

psk

Data type: Optional[String[8,64]]

Pre-Shared Key to use for authentication

Default value: undef

ssid

Data type: Optional[String]

Service Set IDentifier (SSID) of the network

Default value: $name

uuid

Data type: Optional[String]

UUID of the network

Default value: undef

priority

Data type: Optional[Integer]

Priority of this AP

Default value: undef

bssid

Data type: Optional[String[1]]

Network BSSID (typically the MAC address of the access point)

Default value: undef

ensure

Data type: Enum['present', 'absent']

Default value: 'present'

Functions

wifi::wpa_passphrase

Type: Ruby 4.x API

Generate the 256-bit pre-shared WPA key for a Wi-Fi network

wifi::wpa_passphrase(String $ssid, String[8,63] $passphrase)

The wifi::wpa_passphrase function.

Returns: String The hashed passphrase

ssid

Data type: String

SSID of the network

passphrase

Data type: String[8,63]

Passphrase used for authentication on the network

wifi::wpa_passphrase(String $ssid, Undef $passphrase)

The wifi::wpa_passphrase function.

Returns: Undef

ssid

Data type: String

passphrase

Data type: Undef