mirror of
https://github.com/linux-system-roles/network.git
synced 2026-07-21 02:11:23 +00:00
ci: Add markdownlint, test_html_build, and build_docs workflows
- markdownlint runs against README.md to avoid any issues with converting it to HTML - test_converting_readme converts README.md > HTML and uploads this test artifact to ensure that conversion works fine - build_docs converts README.md > HTML and pushes the result to the docs branch to publish dosc to GitHub pages site. - Fix markdown issues in README.md Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
This commit is contained in:
Sergei Petrosian
Richard Megginson
parent
666f9cb333
commit
4dd282e0c5
8 changed files with 822 additions and 235 deletions
|
|
@ -21,6 +21,7 @@ skip_list:
|
|||
exclude_paths:
|
||||
- tests/roles/
|
||||
- .github/
|
||||
- .markdownlint.yaml
|
||||
- examples/roles/
|
||||
mock_roles:
|
||||
- linux-system-roles.network
|
||||
|
|
|
|||
2
.github/workflows/ansible-test.yml
vendored
2
.github/workflows/ansible-test.yml
vendored
|
|
@ -38,6 +38,8 @@ jobs:
|
|||
- name: Convert role to collection format
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
# Remove to avoid running ansible-test on unrelated file
|
||||
rm -f .pandoc_template.html5
|
||||
TOXENV=collection lsr_ci_runtox
|
||||
# copy the ignore files
|
||||
coll_dir=".tox/ansible_collections/$LSR_ROLE2COLL_NAMESPACE/$LSR_ROLE2COLL_NAME"
|
||||
|
|
|
|||
101
.github/workflows/build_docs.yml
vendored
Normal file
101
.github/workflows/build_docs.yml
vendored
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
---
|
||||
# yamllint disable rule:line-length
|
||||
name: Convert README.md to HTML and push to docs branch
|
||||
on: # yamllint disable-line rule:truthy
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- README.md
|
||||
release:
|
||||
types:
|
||||
- published
|
||||
permissions:
|
||||
contents: read
|
||||
jobs:
|
||||
build_docs:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Update pip, git
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
sudo apt update
|
||||
sudo apt install -y git
|
||||
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Ensure the docs branch
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
branch=docs
|
||||
existed_in_remote=$(git ls-remote --heads origin $branch)
|
||||
|
||||
if [ -z "${existed_in_remote}" ]; then
|
||||
echo "Creating $branch branch"
|
||||
git config --global user.name "${{ github.actor }}"
|
||||
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
|
||||
git checkout --orphan $branch
|
||||
git reset --hard
|
||||
git commit --allow-empty -m "Initializing $branch branch"
|
||||
git push origin $branch
|
||||
echo "Created $branch branch"
|
||||
else
|
||||
echo "Branch $branch already exists"
|
||||
fi
|
||||
|
||||
- name: Checkout the docs branch
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
ref: docs
|
||||
|
||||
- name: Fetch README.md and .pandoc_template.html5 template from the workflow branch
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
sparse-checkout: |
|
||||
README.md
|
||||
.pandoc_template.html5
|
||||
sparse-checkout-cone-mode: false
|
||||
path: ref_branch
|
||||
- name: Set RELEASE_VERSION based on whether run on release or on push
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
if [ ${{ github.event_name }} = release ]; then
|
||||
echo "RELEASE_VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
|
||||
elif [ ${{ github.event_name }} = push ]; then
|
||||
echo "RELEASE_VERSION=latest" >> $GITHUB_ENV
|
||||
else
|
||||
echo Unsupported event
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Ensure that version and docs directories exist
|
||||
run: mkdir -p ${{ env.RELEASE_VERSION }} docs
|
||||
|
||||
- name: Convert README.md to HTML and save to the version directory
|
||||
uses: docker://pandoc/core:latest
|
||||
with:
|
||||
args: >-
|
||||
--from gfm --to html5 --toc --shift-heading-level-by=-1
|
||||
--template ref_branch/.pandoc_template.html5
|
||||
--output ${{ env.RELEASE_VERSION }}/README.html ref_branch/README.md
|
||||
|
||||
- name: Copy latest README.html to docs/index.html for GitHub pages
|
||||
if: env.RELEASE_VERSION == 'latest'
|
||||
run: cp ${{ env.RELEASE_VERSION }}/README.html docs/index.html
|
||||
|
||||
- name: Commit changes
|
||||
run: |
|
||||
git config --global user.name "${{ github.actor }}"
|
||||
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
|
||||
git add ${{ env.RELEASE_VERSION }}/README.html docs/index.html
|
||||
git commit -m "Update README.html for ${{ env.RELEASE_VERSION }}"
|
||||
|
||||
- name: Push changes
|
||||
uses: ad-m/github-push-action@master
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
branch: docs
|
||||
33
.github/workflows/markdownlint.yml
vendored
33
.github/workflows/markdownlint.yml
vendored
|
|
@ -1,11 +1,34 @@
|
|||
---
|
||||
name: markdownlint
|
||||
on: [push, pull_request]
|
||||
# yamllint disable rule:line-length
|
||||
name: Markdown Lint
|
||||
on: # yamllint disable-line rule:truthy
|
||||
pull_request:
|
||||
merge_group:
|
||||
branches:
|
||||
- main
|
||||
types:
|
||||
- checks_requested
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
permissions:
|
||||
contents: read
|
||||
jobs:
|
||||
markdownlint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Update pip, git
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
sudo apt update
|
||||
sudo apt install -y git
|
||||
|
||||
- name: Check out code
|
||||
uses: actions/checkout@main
|
||||
- name: Run mdl
|
||||
uses: actionshub/markdownlint@main
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Lint README.md
|
||||
uses: docker://avtodev/markdown-lint:master
|
||||
with:
|
||||
args: README.md
|
||||
config: .markdownlint.yaml
|
||||
|
|
|
|||
43
.github/workflows/test_converting_readme.yml
vendored
Normal file
43
.github/workflows/test_converting_readme.yml
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
# yamllint disable rule:line-length
|
||||
name: Test converting README.md to README.html
|
||||
on: # yamllint disable-line rule:truthy
|
||||
pull_request:
|
||||
merge_group:
|
||||
branches:
|
||||
- main
|
||||
types:
|
||||
- checks_requested
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
permissions:
|
||||
contents: read
|
||||
jobs:
|
||||
test_converting_readme:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Update pip, git
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
sudo apt update
|
||||
sudo apt install -y git
|
||||
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Convert README.md to HTML and save to the version directory
|
||||
uses: docker://pandoc/core:latest
|
||||
with:
|
||||
args: >-
|
||||
--from gfm --to html5 --toc --shift-heading-level-by=-1
|
||||
--template .pandoc_template.html5
|
||||
--output README.html README.md
|
||||
|
||||
- name: Upload README.html as an artifact
|
||||
uses: actions/upload-artifact@master
|
||||
with:
|
||||
name: README.html
|
||||
path: README.html
|
||||
260
.markdownlint.yaml
Normal file
260
.markdownlint.yaml
Normal file
|
|
@ -0,0 +1,260 @@
|
|||
# Default state for all rules
|
||||
default: true
|
||||
|
||||
# Path to configuration file to extend
|
||||
extends: null
|
||||
|
||||
# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
|
||||
MD001: true
|
||||
|
||||
# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
|
||||
MD002:
|
||||
# Heading level
|
||||
level: 1
|
||||
|
||||
# MD003/heading-style/header-style - Heading style
|
||||
MD003:
|
||||
# Heading style
|
||||
style: "consistent"
|
||||
|
||||
# MD004/ul-style - Unordered list style
|
||||
MD004:
|
||||
# List style
|
||||
style: "consistent"
|
||||
|
||||
# MD005/list-indent - Inconsistent indentation for list items at the same level
|
||||
MD005: true
|
||||
|
||||
# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line
|
||||
MD006: true
|
||||
|
||||
# MD007/ul-indent - Unordered list indentation
|
||||
MD007:
|
||||
# Spaces for indent
|
||||
indent: 2
|
||||
# Whether to indent the first level of the list
|
||||
start_indented: false
|
||||
# Spaces for first level indent (when start_indented is set)
|
||||
start_indent: 2
|
||||
|
||||
# MD009/no-trailing-spaces - Trailing spaces
|
||||
MD009:
|
||||
# Spaces for line break
|
||||
br_spaces: 2
|
||||
# Allow spaces for empty lines in list items
|
||||
list_item_empty_lines: false
|
||||
# Include unnecessary breaks
|
||||
strict: false
|
||||
|
||||
# MD010/no-hard-tabs - Hard tabs
|
||||
MD010:
|
||||
# Include code blocks
|
||||
code_blocks: true
|
||||
# Fenced code languages to ignore
|
||||
ignore_code_languages: []
|
||||
# Number of spaces for each hard tab
|
||||
spaces_per_tab: 1
|
||||
|
||||
# MD011/no-reversed-links - Reversed link syntax
|
||||
MD011: true
|
||||
|
||||
# MD012/no-multiple-blanks - Multiple consecutive blank lines
|
||||
MD012:
|
||||
# Consecutive blank lines
|
||||
maximum: 1
|
||||
|
||||
# Modified for LSR
|
||||
# GFM does not limit line length
|
||||
# MD013/line-length - Line length
|
||||
MD013: false
|
||||
# # Number of characters
|
||||
# # line_length: 80
|
||||
# line_length: 999
|
||||
# # Number of characters for headings
|
||||
# heading_line_length: 80
|
||||
# # Number of characters for code blocks
|
||||
# code_block_line_length: 80
|
||||
# # Include code blocks
|
||||
# code_blocks: true
|
||||
# # Include tables
|
||||
# tables: true
|
||||
# # Include headings
|
||||
# headings: true
|
||||
# # Include headings
|
||||
# headers: true
|
||||
# # Strict length checking
|
||||
# strict: false
|
||||
# # Stern length checking
|
||||
# stern: false
|
||||
|
||||
# MD014/commands-show-output - Dollar signs used before commands without showing output
|
||||
MD014: true
|
||||
|
||||
# MD018/no-missing-space-atx - No space after hash on atx style heading
|
||||
MD018: true
|
||||
|
||||
# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
|
||||
MD019: true
|
||||
|
||||
# MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading
|
||||
MD020: true
|
||||
|
||||
# MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading
|
||||
MD021: true
|
||||
|
||||
# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
|
||||
MD022:
|
||||
# Blank lines above heading
|
||||
lines_above: 1
|
||||
# Blank lines below heading
|
||||
lines_below: 1
|
||||
|
||||
# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
|
||||
MD023: true
|
||||
|
||||
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
|
||||
MD024: true
|
||||
|
||||
# MD025/single-title/single-h1 - Multiple top-level headings in the same document
|
||||
MD025:
|
||||
# Heading level
|
||||
level: 1
|
||||
# RegExp for matching title in front matter
|
||||
front_matter_title: "^\\s*title\\s*[:=]"
|
||||
|
||||
# MD026/no-trailing-punctuation - Trailing punctuation in heading
|
||||
MD026:
|
||||
# Punctuation characters not allowed at end of headings
|
||||
punctuation: ".,;:!。，；：！"
|
||||
|
||||
# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
|
||||
MD027: true
|
||||
|
||||
# MD028/no-blanks-blockquote - Blank line inside blockquote
|
||||
MD028: true
|
||||
|
||||
# MD029/ol-prefix - Ordered list item prefix
|
||||
MD029:
|
||||
# List style
|
||||
style: "one_or_ordered"
|
||||
|
||||
# MD030/list-marker-space - Spaces after list markers
|
||||
MD030:
|
||||
# Spaces for single-line unordered list items
|
||||
ul_single: 1
|
||||
# Spaces for single-line ordered list items
|
||||
ol_single: 1
|
||||
# Spaces for multi-line unordered list items
|
||||
ul_multi: 1
|
||||
# Spaces for multi-line ordered list items
|
||||
ol_multi: 1
|
||||
|
||||
# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
|
||||
MD031:
|
||||
# Include list items
|
||||
list_items: true
|
||||
|
||||
# MD032/blanks-around-lists - Lists should be surrounded by blank lines
|
||||
MD032: true
|
||||
|
||||
# MD033/no-inline-html - Inline HTML
|
||||
MD033:
|
||||
# Allowed elements
|
||||
allowed_elements: []
|
||||
|
||||
# MD034/no-bare-urls - Bare URL used
|
||||
MD034: true
|
||||
|
||||
# MD035/hr-style - Horizontal rule style
|
||||
MD035:
|
||||
# Horizontal rule style
|
||||
style: "consistent"
|
||||
|
||||
# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
|
||||
MD036:
|
||||
# Punctuation characters
|
||||
punctuation: ".,;:!?。，；：！？"
|
||||
|
||||
# MD037/no-space-in-emphasis - Spaces inside emphasis markers
|
||||
MD037: true
|
||||
|
||||
# MD038/no-space-in-code - Spaces inside code span elements
|
||||
MD038: true
|
||||
|
||||
# MD039/no-space-in-links - Spaces inside link text
|
||||
MD039: true
|
||||
|
||||
# MD040/fenced-code-language - Fenced code blocks should have a language specified
|
||||
MD040:
|
||||
# List of languages
|
||||
allowed_languages: []
|
||||
# Require language only
|
||||
language_only: false
|
||||
|
||||
# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
|
||||
MD041:
|
||||
# Heading level
|
||||
level: 1
|
||||
# RegExp for matching title in front matter
|
||||
front_matter_title: "^\\s*title\\s*[:=]"
|
||||
|
||||
# MD042/no-empty-links - No empty links
|
||||
MD042: true
|
||||
|
||||
# Modified for LSR
|
||||
# Disabling, we do not need this
|
||||
# MD043/required-headings/required-headers - Required heading structure
|
||||
MD043: false
|
||||
# # List of headings
|
||||
# headings: []
|
||||
# # List of headings
|
||||
# headers: []
|
||||
# # Match case of headings
|
||||
# match_case: false
|
||||
|
||||
# MD044/proper-names - Proper names should have the correct capitalization
|
||||
MD044:
|
||||
# List of proper names
|
||||
names: []
|
||||
# Include code blocks
|
||||
code_blocks: true
|
||||
# Include HTML elements
|
||||
html_elements: true
|
||||
|
||||
# MD045/no-alt-text - Images should have alternate text (alt text)
|
||||
MD045: true
|
||||
|
||||
# MD046/code-block-style - Code block style
|
||||
MD046:
|
||||
# Block style
|
||||
style: "consistent"
|
||||
|
||||
# MD047/single-trailing-newline - Files should end with a single newline character
|
||||
MD047: true
|
||||
|
||||
# MD048/code-fence-style - Code fence style
|
||||
MD048:
|
||||
# Code fence style
|
||||
style: "consistent"
|
||||
|
||||
# MD049/emphasis-style - Emphasis style should be consistent
|
||||
MD049:
|
||||
# Emphasis style should be consistent
|
||||
style: "consistent"
|
||||
|
||||
# MD050/strong-style - Strong style should be consistent
|
||||
MD050:
|
||||
# Strong style should be consistent
|
||||
style: "consistent"
|
||||
|
||||
# MD051/link-fragments - Link fragments should be valid
|
||||
MD051: true
|
||||
|
||||
# MD052/reference-links-images - Reference links and images should use a label that is defined
|
||||
MD052: true
|
||||
|
||||
# MD053/link-image-reference-definitions - Link and image reference definitions should be needed
|
||||
MD053:
|
||||
# Ignored definitions
|
||||
ignored_definitions:
|
||||
- "//"
|
||||
166
.pandoc_template.html5
Normal file
166
.pandoc_template.html5
Normal file
File diff suppressed because one or more lines are too long
451
README.md
451
README.md
|
|
@ -1,13 +1,11 @@
|
|||
linux-system-roles/network
|
||||
==========================
|
||||
# linux-system-roles/network
|
||||
|
||||
[](https://coveralls.io/github/linux-system-roles/network)
|
||||
|
||||
[](https://github.com/ambv/black)
|
||||
[](https://lgtm.com/projects/g/linux-system-roles/network/context:python)
|
||||
|
||||
Overview
|
||||
--------
|
||||
## Overview
|
||||
|
||||
The `network` role enables users to configure network on the target machines.
|
||||
This role can be used to configure:
|
||||
|
|
@ -22,12 +20,11 @@ This role can be used to configure:
|
|||
- IP configuration
|
||||
- 802.1x authentication
|
||||
|
||||
Introduction
|
||||
------------
|
||||
## Introduction
|
||||
|
||||
The `network` role supports two providers: `nm` and `initscripts`. `nm` is
|
||||
used by default in RHEL7 and `initscripts` in RHEL6. These providers can be
|
||||
configured per host via the [`network_provider`](#provider) variable. In
|
||||
configured per host via the [`network_provider`](#variables) variable. In
|
||||
absence of explicit configuration, it is autodetected based on the
|
||||
distribution. However, note that either `nm` or `initscripts` is not tied to a certain
|
||||
distribution. The `network` role works everywhere the required API is available.
|
||||
|
|
@ -63,8 +60,7 @@ Exceptions are mentioned below. However, the partial networking configuration ca
|
|||
achieved via specifying the network state configuration in the `network_state`
|
||||
variable.
|
||||
|
||||
Variables
|
||||
---------
|
||||
## Variables
|
||||
|
||||
The `network` role is configured via variables starting with `network_` as
|
||||
the name prefix. List of variables:
|
||||
|
|
@ -88,8 +84,7 @@ the name prefix. List of variables:
|
|||
host, and the format and the syntax of the configuration should be consistent
|
||||
with the [nmstate state examples](https://nmstate.io/examples.html) (YAML).
|
||||
|
||||
Examples of Variables
|
||||
---------------------
|
||||
## Examples of Variables
|
||||
|
||||
Setting the variables
|
||||
|
||||
|
|
@ -115,8 +110,7 @@ network_state:
|
|||
#...
|
||||
```
|
||||
|
||||
Options
|
||||
-------
|
||||
## network_connections Options
|
||||
|
||||
The `network_connections` variable is a list of dictionaries that include the
|
||||
following options. List of options:
|
||||
|
|
@ -326,18 +320,19 @@ authentication, WPA3-Personal SAE (password) authentication and Enhanced Open (O
|
|||
`nm` (NetworkManager) is the only supported `network_provider` for this type.
|
||||
|
||||
If WPA-EAP is used, ieee802_1x settings must be defined in the
|
||||
[ieee802_1x](#-`ieee802_1x`) option.
|
||||
[ieee802_1x](#ieee802_1x) option.
|
||||
|
||||
The following options are supported:
|
||||
|
||||
- `ssid`: the SSID of the wireless network (required)
|
||||
- `key_mgmt` (required)
|
||||
|
||||
Any key from following key list:
|
||||
- `owe`
|
||||
- `sae`
|
||||
- `wpa-eap`
|
||||
- `wpa-psk`
|
||||
Any key from following key list:
|
||||
|
||||
- `owe`
|
||||
- `sae`
|
||||
- `wpa-eap`
|
||||
- `wpa-psk`
|
||||
|
||||
- `password`: password for the network (required if `wpa-psk` or `sae` is used)
|
||||
|
||||
|
|
@ -433,7 +428,7 @@ In general these work like shell globs.
|
|||
- `[fo]` - matches any single `f` or `o` character - also supports ranges - `[0-9]`
|
||||
will match any single digit character
|
||||
|
||||
#### `path`
|
||||
### `path`
|
||||
|
||||
The `path` setting is a list of patterns to match against the `ID_PATH` udev property
|
||||
of devices. The `ID_PATH` udev property represents the persistent path of a device. It
|
||||
|
|
@ -456,193 +451,193 @@ Ports to the bridge, bond or team devices cannot specify a zone.
|
|||
The IP configuration supports the following options:
|
||||
|
||||
- `address`
|
||||
|
||||
Manual addressing can be specified via a list of addresses under the `address` option.
|
||||
Manual addressing can be specified via a list of addresses under the `address` option.
|
||||
|
||||
- `auto_gateway`
|
||||
|
||||
If enabled, a default route will be configured using the default gateway. If disabled,
|
||||
the default route will be removed.
|
||||
If enabled, a default route will be configured using the default gateway. If disabled,
|
||||
the default route will be removed.
|
||||
|
||||
If this variable is not specified, the role will use the default behavior of the
|
||||
`network_provider` selected.
|
||||
If this variable is not specified, the role will use the default behavior of the
|
||||
`network_provider` selected.
|
||||
|
||||
Setting this option to `false` is equivalent to:
|
||||
- `DEFROUTE = no` in initscripts, or
|
||||
- `ipv4.never-default/ipv6.never-default yes` in nmcli
|
||||
Setting this option to `false` is equivalent to:
|
||||
|
||||
- `DEFROUTE = no` in initscripts, or
|
||||
- `ipv4.never-default/ipv6.never-default yes` in nmcli
|
||||
|
||||
- `dhcp4`, `auto6`, and `ipv6_disabled`
|
||||
|
||||
Also, manual addressing can be specified by setting either `dhcp4` or `auto6`.
|
||||
The `dhcp4` key is for DHCPv4 and `auto6` for StateLess Address Auto Configuration
|
||||
(SLAAC). Note that the `dhcp4` and `auto6` keys can be omitted and the default key
|
||||
depends on the presence of manual addresses. `ipv6_disabled` can be set to disable
|
||||
ipv6 for the connection.
|
||||
Also, manual addressing can be specified by setting either `dhcp4` or `auto6`.
|
||||
The `dhcp4` key is for DHCPv4 and `auto6` for StateLess Address Auto Configuration
|
||||
(SLAAC). Note that the `dhcp4` and `auto6` keys can be omitted and the default key
|
||||
depends on the presence of manual addresses. `ipv6_disabled` can be set to disable
|
||||
ipv6 for the connection.
|
||||
|
||||
- `dhcp4_send_hostname`
|
||||
|
||||
If `dhcp4` is enabled, it can be configured whether the DHCPv4 request includes
|
||||
the hostname via the `dhcp4_send_hostname` option. Note that `dhcp4_send_hostname`
|
||||
is only supported by the `nm` provider and corresponds to
|
||||
[`ipv4.dhcp-send-hostname`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.dhcp-send-hostname)
|
||||
property.
|
||||
If `dhcp4` is enabled, it can be configured whether the DHCPv4 request includes
|
||||
the hostname via the `dhcp4_send_hostname` option. Note that `dhcp4_send_hostname`
|
||||
is only supported by the `nm` provider and corresponds to
|
||||
[`ipv4.dhcp-send-hostname`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.dhcp-send-hostname)
|
||||
property.
|
||||
|
||||
- `dns`
|
||||
|
||||
Manual DNS configuration can be specified via a list of addresses given in the
|
||||
`dns` option.
|
||||
Manual DNS configuration can be specified via a list of addresses given in the
|
||||
`dns` option.
|
||||
|
||||
- `dns_search`
|
||||
|
||||
Manual DNS configuration can be specified via a list of domains to search given in
|
||||
the `dns_search` option.
|
||||
Manual DNS configuration can be specified via a list of domains to search given in
|
||||
the `dns_search` option.
|
||||
|
||||
- `dns_options`
|
||||
|
||||
`dns_options` is only supported for the NetworkManager provider. Manual DNS
|
||||
configuration via a list of DNS options can be given in the `dns_options`. The list
|
||||
of supported DNS options for IPv4 nameservers is described in
|
||||
[man 5 resolv.conf](https://man7.org/linux/man-pages/man5/resolv.conf.5.html).
|
||||
Currently, the list of supported DNS options is:
|
||||
- `attempts:n`
|
||||
- `debug`
|
||||
- `edns0`
|
||||
- `inet6`
|
||||
- `ip6-bytestring`
|
||||
- `ip6-dotint`
|
||||
- `ndots:n`
|
||||
- `no-aaaa`
|
||||
- `no-check-names`
|
||||
- `no-ip6-dotint`
|
||||
- `no-reload`
|
||||
- `no-tld-query`
|
||||
- `rotate`
|
||||
- `single-request`
|
||||
- `single-request-reopen`
|
||||
- `timeout:n`
|
||||
- `trust-ad`
|
||||
- `use-vc`
|
||||
`dns_options` is only supported for the NetworkManager provider. Manual DNS
|
||||
configuration via a list of DNS options can be given in the `dns_options`. The list
|
||||
of supported DNS options for IPv4 nameservers is described in
|
||||
[man 5 resolv.conf](https://man7.org/linux/man-pages/man5/resolv.conf.5.html).
|
||||
Currently, the list of supported DNS options is:
|
||||
- `attempts:n`
|
||||
- `debug`
|
||||
- `edns0`
|
||||
- `inet6`
|
||||
- `ip6-bytestring`
|
||||
- `ip6-dotint`
|
||||
- `ndots:n`
|
||||
- `no-aaaa`
|
||||
- `no-check-names`
|
||||
- `no-ip6-dotint`
|
||||
- `no-reload`
|
||||
- `no-tld-query`
|
||||
- `rotate`
|
||||
- `single-request`
|
||||
- `single-request-reopen`
|
||||
- `timeout:n`
|
||||
- `trust-ad`
|
||||
- `use-vc`
|
||||
|
||||
**Note:** The "trust-ad" setting is only honored if the profile contributes name
|
||||
servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.
|
||||
When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf)
|
||||
then "edns0" and "trust-ad" are automatically added.
|
||||
**Note:** The "trust-ad" setting is only honored if the profile contributes name
|
||||
servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.
|
||||
When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf)
|
||||
then "edns0" and "trust-ad" are automatically added.
|
||||
|
||||
- `dns_priority`
|
||||
|
||||
DNS servers priority. The relative priority for DNS servers specified by this
|
||||
setting. The default value is 0, a lower numerical value has higher priority.
|
||||
The valid value of `dns_priority` ranges from -2147483648 to 2147483647. Negative
|
||||
values have the special effect of excluding other configurations with a greater
|
||||
numerical priority value; so in presence of at least one negative priority, only
|
||||
DNS servers from connections with the lowest priority value will be used.
|
||||
DNS servers priority. The relative priority for DNS servers specified by this
|
||||
setting. The default value is 0, a lower numerical value has higher priority.
|
||||
The valid value of `dns_priority` ranges from -2147483648 to 2147483647. Negative
|
||||
values have the special effect of excluding other configurations with a greater
|
||||
numerical priority value; so in presence of at least one negative priority, only
|
||||
DNS servers from connections with the lowest priority value will be used.
|
||||
|
||||
- `gateway4` and `gateway6`
|
||||
|
||||
The default gateway for IPv4 (`gateway4`) or IPv6 (`gateway6`) packets.
|
||||
The default gateway for IPv4 (`gateway4`) or IPv6 (`gateway6`) packets.
|
||||
|
||||
- `ipv4_ignore_auto_dns` and `ipv6_ignore_auto_dns`
|
||||
|
||||
If enabled, the automatically configured name servers and search domains (via
|
||||
DHCPv4, DHCPv6, modem etc) for IPv4 or IPv6 are ignored, only the name servers and
|
||||
search domains specified in `dns` and `dns_search` properties are used. The
|
||||
settings are distinguished by the address families. The variables are not supported
|
||||
by initscripts provider.
|
||||
If enabled, the automatically configured name servers and search domains (via
|
||||
DHCPv4, DHCPv6, modem etc) for IPv4 or IPv6 are ignored, only the name servers and
|
||||
search domains specified in `dns` and `dns_search` properties are used. The
|
||||
settings are distinguished by the address families. The variables are not supported
|
||||
by initscripts provider.
|
||||
|
||||
If the variables are not specified, the role will use the default behavior of nm
|
||||
provider.
|
||||
If the variables are not specified, the role will use the default behavior of nm
|
||||
provider.
|
||||
|
||||
- `route_metric4` and `route_metric6`
|
||||
|
||||
For `NetworkManager`, `route_metric4` and `route_metric6` corresponds to the
|
||||
[`ipv4.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.route-metric)
|
||||
and
|
||||
[`ipv6.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv6.route-metric)
|
||||
properties, respectively. If specified, it determines the route metric for DHCP
|
||||
assigned routes and the default route, and thus the priority for multiple
|
||||
interfaces. For `initscripts`, `route_metric4` sets the metric for the default
|
||||
route and `route_metric6` is not supported.
|
||||
For `NetworkManager`, `route_metric4` and `route_metric6` corresponds to the
|
||||
[`ipv4.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.route-metric)
|
||||
and
|
||||
[`ipv6.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv6.route-metric)
|
||||
properties, respectively. If specified, it determines the route metric for DHCP
|
||||
assigned routes and the default route, and thus the priority for multiple
|
||||
interfaces. For `initscripts`, `route_metric4` sets the metric for the default
|
||||
route and `route_metric6` is not supported.
|
||||
|
||||
- `route`
|
||||
|
||||
Static route configuration can be specified via a list of routes given in the
|
||||
`route` option. The default value is an empty list. Each route is a dictionary with
|
||||
the following entries: `network`, `prefix`, `gateway`, `metric` and `table`.
|
||||
`network` and `prefix` specify the destination network. `table` supports both the
|
||||
numeric table and named table. In order to specify the named table, the users have
|
||||
to ensure the named table is properly defined in `/etc/iproute2/rt_tables` or
|
||||
`/etc/iproute2/rt_tables.d/*.conf`.
|
||||
Note that Classless inter-domain routing (CIDR) notation or network mask notation
|
||||
are not supported yet.
|
||||
Static route configuration can be specified via a list of routes given in the
|
||||
`route` option. The default value is an empty list. Each route is a dictionary with
|
||||
the following entries: `network`, `prefix`, `gateway`, `metric` and `table`.
|
||||
`network` and `prefix` specify the destination network. `table` supports both the
|
||||
numeric table and named table. In order to specify the named table, the users have
|
||||
to ensure the named table is properly defined in `/etc/iproute2/rt_tables` or
|
||||
`/etc/iproute2/rt_tables.d/*.conf`.
|
||||
Note that Classless inter-domain routing (CIDR) notation or network mask notation
|
||||
are not supported yet.
|
||||
|
||||
- `routing_rule`
|
||||
|
||||
The policy routing rules can be specified via a list of rules given in the
|
||||
`routing_rule` option, which allow routing the packets on other packet fields
|
||||
except for destination address. The default value is a an empty list. Each rule is
|
||||
a dictionary with the following entries:
|
||||
- `priority` -
|
||||
The policy routing rules can be specified via a list of rules given in the
|
||||
`routing_rule` option, which allow routing the packets on other packet fields
|
||||
except for destination address. The default value is a an empty list. Each rule is
|
||||
a dictionary with the following entries:
|
||||
- `priority` -
|
||||
The priority of the rule. A valid priority ranges from 0 to 4294967295. Higher
|
||||
number means lower priority.
|
||||
- `action` -
|
||||
- `action` -
|
||||
The action of the rule. The possible values are `to-table` (default),
|
||||
`blackhole`, `prohibit`, `unreachable`.
|
||||
- `dport`-
|
||||
- `dport`-
|
||||
The range of the destination port (e.g. `1000 - 2000`). A valid dport value for
|
||||
both start and end ranges from 0 to 65534. And the start cannot be greater than
|
||||
the end.
|
||||
- `family` -
|
||||
- `family` -
|
||||
The IP family of the rule. The possible values are `ipv4` and `ipv6`.
|
||||
- `from` -
|
||||
- `from` -
|
||||
The source address of the packet to match (e.g. `192.168.100.58/24`).
|
||||
- `fwmark` -
|
||||
- `fwmark` -
|
||||
The fwmark value of the packet to match.
|
||||
- `fwmask` -
|
||||
- `fwmask` -
|
||||
The fwmask value of the packet to match.
|
||||
- `iif` -
|
||||
- `iif` -
|
||||
Select the incoming interface name to match.
|
||||
- `invert` -
|
||||
- `invert` -
|
||||
Invert the selected match of the rule. The possible values are boolean values
|
||||
`true` and `false` (default). If the value is `true`, this is equivalent to match
|
||||
any packet that not satisfying selected match of the rule.
|
||||
- `ipproto` -
|
||||
- `ipproto` -
|
||||
Select the IP protocol value to match, the valid value ranges from 1 to 255.
|
||||
- `oif` -
|
||||
- `oif` -
|
||||
Select the outgoing interface name to match.
|
||||
- `sport` -
|
||||
- `sport` -
|
||||
The range of the source port (e.g. `1000 - 2000`). A valid sport value for both
|
||||
start and end ranges from 0 to 65534. And the start cannot be greater than the
|
||||
end.
|
||||
- `suppress_prefixlength` -
|
||||
- `suppress_prefixlength` -
|
||||
Reject routing decisions that have a prefix length of the specified or less.
|
||||
- `table` -
|
||||
- `table` -
|
||||
The route table to look up for the `to-table` action. `table` supports both the
|
||||
numeric table and named table. In order to specify the named table, the users
|
||||
have to ensure the named table is properly defined in `/etc/iproute2/rt_tables`
|
||||
or `/etc/iproute2/rt_tables.d/*.conf`.
|
||||
- `to` -
|
||||
- `to` -
|
||||
The destination address of the packet to match (e.g. `192.168.100.58/24`).
|
||||
- `tos` -
|
||||
- `tos` -
|
||||
Select the tos value to match.
|
||||
- `uid` -
|
||||
- `uid` -
|
||||
The range of the uid to match (e.g. `1000 - 2000`). A valid uid value for both
|
||||
start and end ranges from 0 to 4294967295. And the start cannot be greater than
|
||||
the end.
|
||||
|
||||
- `route_append_only`
|
||||
|
||||
The `route_append_only` option allows only to add new routes to the
|
||||
existing routes on the system.
|
||||
The `route_append_only` option allows only to add new routes to the
|
||||
existing routes on the system.
|
||||
|
||||
If the `route_append_only` boolean option is set to `true`, the specified routes are
|
||||
appended to the existing routes. If `route_append_only` is set to `false` (default),
|
||||
the current routes are replaced. Note that setting `route_append_only` to `true`
|
||||
without setting `route` has the effect of preserving the current static routes.
|
||||
If the `route_append_only` boolean option is set to `true`, the specified routes are
|
||||
appended to the existing routes. If `route_append_only` is set to `false` (default),
|
||||
the current routes are replaced. Note that setting `route_append_only` to `true`
|
||||
without setting `route` has the effect of preserving the current static routes.
|
||||
|
||||
- `rule_append_only`
|
||||
|
||||
The `rule_append_only` boolean option allows to preserve the current routing rules.
|
||||
Note that specifying routing rules is not supported yet.
|
||||
The `rule_append_only` boolean option allows to preserve the current routing rules.
|
||||
Note that specifying routing rules is not supported yet.
|
||||
|
||||
**Note:** When `route_append_only` or `rule_append_only` is not specified, the network
|
||||
role deletes the current routes or routing rules.
|
||||
|
|
@ -659,12 +654,12 @@ The ethtool configuration supports the following options:
|
|||
|
||||
- `ring`
|
||||
|
||||
Changes the `rx`/`tx` `ring` parameters of the specified network device. The list
|
||||
of supported `ring` parameters is:
|
||||
- `rx` - Changes the number of ring entries for the Rx ring.
|
||||
- `rx-jumbo` - Changes the number of ring entries for the Rx Jumbo ring.
|
||||
- `rx-mini` - Changes the number of ring entries for the Rx Mini ring.
|
||||
- `tx` - Changes the number of ring entries for the Tx ring.
|
||||
Changes the `rx`/`tx` `ring` parameters of the specified network device. The list
|
||||
of supported `ring` parameters is:
|
||||
- `rx` - Changes the number of ring entries for the Rx ring.
|
||||
- `rx-jumbo` - Changes the number of ring entries for the Rx Jumbo ring.
|
||||
- `rx-mini` - Changes the number of ring entries for the Rx Mini ring.
|
||||
- `tx` - Changes the number of ring entries for the Tx ring.
|
||||
|
||||
```yaml
|
||||
ethtool:
|
||||
|
|
@ -762,63 +757,63 @@ SSL certificates and keys must be deployed on the host prior to running the role
|
|||
|
||||
- `eap`
|
||||
|
||||
The allowed EAP method to be used when authenticating to the network with 802.1x.
|
||||
The allowed EAP method to be used when authenticating to the network with 802.1x.
|
||||
|
||||
Currently, `tls` is the default and the only accepted value.
|
||||
Currently, `tls` is the default and the only accepted value.
|
||||
|
||||
- `identity` (required)
|
||||
|
||||
Identity string for EAP authentication methods.
|
||||
Identity string for EAP authentication methods.
|
||||
|
||||
- `private_key` (required)
|
||||
|
||||
Absolute path to the client's PEM or PKCS#12 encoded private key used for 802.1x
|
||||
authentication.
|
||||
Absolute path to the client's PEM or PKCS#12 encoded private key used for 802.1x
|
||||
authentication.
|
||||
|
||||
- `private_key_password`
|
||||
|
||||
Password to the private key specified in `private_key`.
|
||||
Password to the private key specified in `private_key`.
|
||||
|
||||
- `private_key_password_flags`
|
||||
|
||||
List of flags to configure how the private key password is managed.
|
||||
List of flags to configure how the private key password is managed.
|
||||
|
||||
Multiple flags may be specified.
|
||||
Multiple flags may be specified.
|
||||
|
||||
Valid flags are:
|
||||
- `none`
|
||||
- `agent-owned`
|
||||
- `not-saved`
|
||||
- `not-required`
|
||||
Valid flags are:
|
||||
- `none`
|
||||
- `agent-owned`
|
||||
- `not-saved`
|
||||
- `not-required`
|
||||
|
||||
See NetworkManager documentation on "Secret flag types" more details (`man 5
|
||||
nm-settings`).
|
||||
See NetworkManager documentation on "Secret flag types" more details (`man 5
|
||||
nm-settings`).
|
||||
|
||||
- `client_cert` (required)
|
||||
|
||||
Absolute path to the client's PEM encoded certificate used for 802.1x
|
||||
authentication.
|
||||
Absolute path to the client's PEM encoded certificate used for 802.1x
|
||||
authentication.
|
||||
|
||||
- `ca_cert`
|
||||
|
||||
Absolute path to the PEM encoded certificate authority used to verify the EAP
|
||||
server.
|
||||
Absolute path to the PEM encoded certificate authority used to verify the EAP
|
||||
server.
|
||||
|
||||
- `ca_path`
|
||||
|
||||
Absolute path to directory containing additional pem encoded ca certificates used to
|
||||
verify the EAP server. Can be used instead of or in addition to ca_cert. Cannot be
|
||||
used if system_ca_certs is enabled.
|
||||
Absolute path to directory containing additional pem encoded ca certificates used to
|
||||
verify the EAP server. Can be used instead of or in addition to ca_cert. Cannot be
|
||||
used if system_ca_certs is enabled.
|
||||
|
||||
- `system_ca_certs`
|
||||
|
||||
If set to `true`, NetworkManager will use the system's trusted ca
|
||||
certificates to verify the EAP server.
|
||||
If set to `true`, NetworkManager will use the system's trusted ca
|
||||
certificates to verify the EAP server.
|
||||
|
||||
- `domain_suffix_match`
|
||||
|
||||
If set, NetworkManager will ensure the domain name of the EAP server certificate
|
||||
matches this string.
|
||||
If set, NetworkManager will ensure the domain name of the EAP server certificate
|
||||
matches this string.
|
||||
|
||||
### `bond`
|
||||
|
||||
|
|
@ -830,144 +825,143 @@ following options:
|
|||
|
||||
- `mode`
|
||||
|
||||
Bonding mode. The possible values are `balance-rr` (default), `active-backup`,
|
||||
`balance-xor`, `broadcast`, `802.3ad`, `balance-tlb`, or `balance-alb`.
|
||||
Bonding mode. The possible values are `balance-rr` (default), `active-backup`,
|
||||
`balance-xor`, `broadcast`, `802.3ad`, `balance-tlb`, or `balance-alb`.
|
||||
|
||||
- `ad_actor_sys_prio`
|
||||
|
||||
In `802.3ad` bonding mode, this specifies the system priority. The valid range is
|
||||
1 - 65535.
|
||||
In `802.3ad` bonding mode, this specifies the system priority. The valid range is
|
||||
1 - 65535.
|
||||
|
||||
- `ad_actor_system`
|
||||
|
||||
In `802.3ad` bonding mode, this specifies the system mac-address for the actor in
|
||||
protocol packet exchanges (LACPDUs).
|
||||
In `802.3ad` bonding mode, this specifies the system mac-address for the actor in
|
||||
protocol packet exchanges (LACPDUs).
|
||||
|
||||
- `ad_select`
|
||||
|
||||
This option specifies the 802.3ad aggregation selection logic to use. The possible
|
||||
values are: `stable`, `bandwidth`, `count`.
|
||||
This option specifies the 802.3ad aggregation selection logic to use. The possible
|
||||
values are: `stable`, `bandwidth`, `count`.
|
||||
|
||||
- `ad_user_port_key`
|
||||
|
||||
In `802.3ad` bonding mode, this defines the upper 10 bits of the port key. The
|
||||
allowed range for the value is 0 - 1023.
|
||||
In `802.3ad` bonding mode, this defines the upper 10 bits of the port key. The
|
||||
allowed range for the value is 0 - 1023.
|
||||
|
||||
- `all_ports_active`
|
||||
|
||||
`all_slaves_active` <!--- wokeignore:rule=slave ---> in kernel and NetworkManager.
|
||||
The boolean value `false` drops the duplicate frames (received on inactive ports)
|
||||
and the boolean value `true` delivers the duplicate frames.
|
||||
`all_slaves_active` <!--- wokeignore:rule=slave ---> in kernel and NetworkManager.
|
||||
The boolean value `false` drops the duplicate frames (received on inactive ports)
|
||||
and the boolean value `true` delivers the duplicate frames.
|
||||
|
||||
- `arp_all_targets`
|
||||
|
||||
This option specifies the quantity of arp_ip_targets that must be reachable in
|
||||
order for the ARP monitor to consider a port as being up. The possible values are
|
||||
`any` or `all`.
|
||||
This option specifies the quantity of arp_ip_targets that must be reachable in
|
||||
order for the ARP monitor to consider a port as being up. The possible values are
|
||||
`any` or `all`.
|
||||
|
||||
- `arp_interval`
|
||||
|
||||
This option specifies the ARP link monitoring frequency in milliseconds. A value of
|
||||
0 disables ARP monitoring.
|
||||
This option specifies the ARP link monitoring frequency in milliseconds. A value of
|
||||
0 disables ARP monitoring.
|
||||
|
||||
- `arp_validate`
|
||||
|
||||
In any mode that supports arp monitoring, this option specifies whether or not ARP
|
||||
probes and replies should be validated. Or for link monitoring purposes, whether
|
||||
non-ARP traffic should be filtered (disregarded). The possible values are: `none`,
|
||||
`active`, `backup`, `all`, `filter`, `filter_active`, `filter_backup`.
|
||||
In any mode that supports arp monitoring, this option specifies whether or not ARP
|
||||
probes and replies should be validated. Or for link monitoring purposes, whether
|
||||
non-ARP traffic should be filtered (disregarded). The possible values are: `none`,
|
||||
`active`, `backup`, `all`, `filter`, `filter_active`, `filter_backup`.
|
||||
|
||||
- `arp_ip_target`
|
||||
|
||||
When `arp_interval` is enabled, this option specifies the IP addresses to use as
|
||||
ARP monitoring peers.
|
||||
When `arp_interval` is enabled, this option specifies the IP addresses to use as
|
||||
ARP monitoring peers.
|
||||
|
||||
- `downdelay`
|
||||
|
||||
The time to wait (in milliseconds) before disabling a port after a link failure
|
||||
has been detected.
|
||||
The time to wait (in milliseconds) before disabling a port after a link failure
|
||||
has been detected.
|
||||
|
||||
- `fail_over_mac`
|
||||
|
||||
This option specifies the policy to select the MAC address for the bond interface
|
||||
in active-backup mode. The possible values are: `none` (default), `active`,
|
||||
`follow`.
|
||||
This option specifies the policy to select the MAC address for the bond interface
|
||||
in active-backup mode. The possible values are: `none` (default), `active`,
|
||||
`follow`.
|
||||
|
||||
- `lacp_rate`
|
||||
|
||||
In `802.3ad` bonding mode, this option defines the rate in which we requst link
|
||||
partner to transmit LACPDU packets. The possible values are: `slow`, `fast`.
|
||||
In `802.3ad` bonding mode, this option defines the rate in which we requst link
|
||||
partner to transmit LACPDU packets. The possible values are: `slow`, `fast`.
|
||||
|
||||
- `lp_interval`
|
||||
|
||||
This option specifies the number of seconds between instances where the bonding
|
||||
driver sends learning packets to each ports peer switch.
|
||||
This option specifies the number of seconds between instances where the bonding
|
||||
driver sends learning packets to each ports peer switch.
|
||||
|
||||
- `miimon`
|
||||
|
||||
Sets the MII link monitoring interval (in milliseconds).
|
||||
Sets the MII link monitoring interval (in milliseconds).
|
||||
|
||||
- `min_links`
|
||||
|
||||
This option specifies the minimum number of links that must be active before
|
||||
asserting the carrier.
|
||||
This option specifies the minimum number of links that must be active before
|
||||
asserting the carrier.
|
||||
|
||||
- `num_grat_arp`
|
||||
|
||||
This option specify the number of peer notifications (gratuitious ARPs) to be
|
||||
issued after a failover event. The allowed range for the value is 0 - 255.
|
||||
This option specify the number of peer notifications (gratuitious ARPs) to be
|
||||
issued after a failover event. The allowed range for the value is 0 - 255.
|
||||
|
||||
- `packets_per_port`
|
||||
|
||||
In `balance-rr` bonding mode, this option specifies the number of packets allowed
|
||||
for a port in network transmission before moving to the next one. The allowed
|
||||
range for the value is 0 - 65535.
|
||||
In `balance-rr` bonding mode, this option specifies the number of packets allowed
|
||||
for a port in network transmission before moving to the next one. The allowed
|
||||
range for the value is 0 - 65535.
|
||||
|
||||
- `peer_notif_delay`
|
||||
|
||||
This option specifies the delay (in milliseconds) between each peer notification
|
||||
when they are issued after a failover event.
|
||||
This option specifies the delay (in milliseconds) between each peer notification
|
||||
when they are issued after a failover event.
|
||||
|
||||
- `primary`
|
||||
|
||||
This option defines the primary device.
|
||||
This option defines the primary device.
|
||||
|
||||
- `primary_reselect`
|
||||
|
||||
This option specifies the reselection policy for the primary port. The possible
|
||||
values are: `always`, `better`, `failure`.
|
||||
This option specifies the reselection policy for the primary port. The possible
|
||||
values are: `always`, `better`, `failure`.
|
||||
|
||||
- `resend_igmp`
|
||||
|
||||
This option specifies the number of IGMP membership reports to be issued after a
|
||||
failover event. The allowed range for the value is 0 - 255.
|
||||
This option specifies the number of IGMP membership reports to be issued after a
|
||||
failover event. The allowed range for the value is 0 - 255.
|
||||
|
||||
- `tlb_dynamic_lb`
|
||||
|
||||
This option specifies if dynamic shuffling of flows is enabled in tlb mode. The
|
||||
boolean value `true` enables the flow shuffling while the boolean value `false`
|
||||
disables it.
|
||||
This option specifies if dynamic shuffling of flows is enabled in tlb mode. The
|
||||
boolean value `true` enables the flow shuffling while the boolean value `false`
|
||||
disables it.
|
||||
|
||||
- `updelay`
|
||||
|
||||
This option specifies the time (in milliseconds) to wait before enabling a port
|
||||
after a link recovery has been detected.
|
||||
This option specifies the time (in milliseconds) to wait before enabling a port
|
||||
after a link recovery has been detected.
|
||||
|
||||
- `use_carrier`
|
||||
|
||||
This options specifies whether or not miimon should use MII or ETHTOOL ioctls
|
||||
versus netif_carrier_ok() to determine the link sattus. The boolean value `true`
|
||||
enables the use of netif_carrier_ok() while the boolean value `false` uses MII or
|
||||
ETHTOOL ioctls instead.
|
||||
This options specifies whether or not miimon should use MII or ETHTOOL ioctls
|
||||
versus netif_carrier_ok() to determine the link sattus. The boolean value `true`
|
||||
enables the use of netif_carrier_ok() while the boolean value `false` uses MII or
|
||||
ETHTOOL ioctls instead.
|
||||
|
||||
- `xmit_hash_policy`
|
||||
|
||||
This option specifies the transmit hash policy to use for port selection, the
|
||||
possible values are: `layer2`, `layer3+4`, `layer2+3`, `encap2+3`, `encap3+4`,
|
||||
`vlan+srcmac`.
|
||||
This option specifies the transmit hash policy to use for port selection, the
|
||||
possible values are: `layer2`, `layer3+4`, `layer2+3`, `encap2+3`, `encap3+4`,
|
||||
`vlan+srcmac`.
|
||||
|
||||
Examples of Options
|
||||
-------------------
|
||||
## Examples of Options
|
||||
|
||||
Setting the same connection profile multiple times:
|
||||
|
||||
|
|
@ -1235,8 +1229,7 @@ network_connections:
|
|||
key_mgmt: "owe"
|
||||
```
|
||||
|
||||
Examples of Applying the Network State Configuration
|
||||
-------------------
|
||||
## Examples of Applying the Network State Configuration
|
||||
|
||||
Configuring the IP addresses:
|
||||
|
||||
|
|
@ -1322,8 +1315,7 @@ The `network` role rejects invalid configurations. It is recommended to test the
|
|||
with `--check` first. There is no protection against wrong (but valid) configuration.
|
||||
Double-check your configuration before applying it.
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
## Compatibility
|
||||
|
||||
The `network` role supports the same configuration scheme for both providers (`nm`
|
||||
and `initscripts`). That means, you can use the same playbook with NetworkManager
|
||||
|
|
@ -1344,8 +1336,7 @@ Depending on NetworkManager's configuration, connections may be stored as ifcfg
|
|||
as well, but it is not guaranteed that plain initscripts can handle these ifcfg files
|
||||
after disabling the NetworkManager service.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
## Limitations
|
||||
|
||||
As Ansible usually works via the network, for example via SSH, there are some
|
||||
limitations to be considered:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue