Skip to content
Snippets Groups Projects
Commit 28357fd8 authored by Kamil Andoniadis's avatar Kamil Andoniadis
Browse files

Update README.md

parent 407ee695
No related branches found
No related tags found
No related merge requests found
...@@ -18,30 +18,30 @@ This role serves for network interface configuration on debian-based systems. ...@@ -18,30 +18,30 @@ This role serves for network interface configuration on debian-based systems.
Mandatory parameters. Mandatory parameters.
* `interface_interfaces` - The list of network interface parameters. Each interface may consists of following attributes. * `kypo_interface_interfaces` - The list of network interface parameters. Each interface may consists of following attributes.
* `interface_mac` (mandatory) - The MAC address of interface to configure. * `kypo_interface_mac` (mandatory) - The MAC address of interface to configure.
* `interface_default_gateway` (optional) - The IPv4 address of default gateway. * `kypo_interface_default_gateway` (optional) - The IPv4 address of default gateway.
* `interface_routes` (optional) - The list of route parameters. Each route must consist of following attributes. * `kypo_interface_routes` (optional) - The list of route parameters. Each route must consist of following attributes.
* `gateway` (mandatory) - The IPv4 address of default gateway for this route. * `gateway` (mandatory) - The IPv4 address of default gateway for this route.
* `network` (mandatory) - The IP address of network from which pakets will be routed. * `network` (mandatory) - The IP address of network from which pakets will be routed.
* `mask` (mandatory) - The subnet mask in address format or prefix number. * `mask` (mandatory) - The subnet mask in address format or prefix number.
Optional parameters. Optional parameters.
* `interface_clean` - Boolean value (**True**/**False**) that means whether to clean all interface configuration before applying role or not. * `kypo_interface_clean` - Boolean value (**True**/**False**) that means whether to clean all interface configuration before applying role or not (default: True).
* `interface_mtu` - The number of maximum transmission unit. * `kypo_interface_mtu` - The number of maximum transmission unit (default: 1442).
* `interface_file_name` - The file name for your configuration located in `/etc/network/interfaces.d/` directory. * `kypo_interface_file_name` - The file name for your configuration located in `/etc/network/interfaces.d/` directory (by default the file `/etc/network/interface` is used).
## Example ## Example
Example of the simplest network interface configuration that just set MTU of specified interface. Example of the simplest network interface configuration that just sets MTU of the specified interface.
```yml ```yml
roles: roles:
- role: interface - role: kypo-interface
interface_interfaces: kypo_interface_interfaces:
- interface_mac: 01:23:45:67:89:ab - kypo_interface_mac: 01:23:45:67:89:ab
interface_mtu: 1442 kypo_interface_mtu: 1442
``` ```
## Maintainer notes ## Maintainer notes
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment